assemblyscript/std/assembly/gc.ts

/** Garbage collector interface. */
export namespace gc {

  /** Whether the garbage collector interface is implemented. */
  @lazy export const implemented: bool = isDefined(__gc_register);

  /** Gets the computed unique class id of a class type. */
  @unsafe @builtin export declare function classId<T>(): u32;

  /** Iterates reference root objects. */
  @unsafe @builtin export declare function iterateRoots(fn: (ref: usize) => void): void;

  /** Registers a managed object to be tracked by the garbage collector. */
  @unsafe export function register(ref: usize): void {
    if (isDefined(__gc_register)) __gc_register(ref);
    else ERROR("missing implementation: gc.register");
  }

  /** Links a registered object with the registered object now referencing it. */
  @unsafe export function link(ref: usize, parentRef: usize): void {
    if (isDefined(__gc_link)) __gc_link(ref, parentRef);
    else ERROR("missing implementation: gc.link");
  }

  /** Marks an object as being reachable. */
  @unsafe export function mark(ref: usize): void {
    if (isDefined(__gc_mark)) __gc_mark(ref);
    else ERROR("missing implementation: gc.mark");
  }

  /** Performs a full garbage collection cycle. */
  export function collect(): void {
    if (isDefined(__gc_collect)) __gc_collect();
    else WARNING("missing implementation: gc.collect");
  }
}

// TODO: move marking into userspace using builtins like iterateFields?