more

Author: dcodeIO

std/assembly/rt.ts

@@ -25,11 +25,11 @@ export function __typeinfo(id: u32): TypeinfoFlags {
 
 // @ts-ignore: decorator
 @unsafe
-export function __instanceof(ref: usize, superId: u32): bool { // keyword
-  var id = changetype<OBJECT>(ref - TOTAL_OVERHEAD).rtId;
+export function __instanceof(ptr: usize, classId: u32): bool { // keyword
+  var id = changetype<OBJECT>(ptr - TOTAL_OVERHEAD).rtId;
   var ptr = __rtti_base;
   if (id <= load<u32>(ptr)) {
-    do if (id == superId) return true;
+    do if (id == classId) return true;
     while (id = changetype<Typeinfo>(ptr + sizeof<u32>() + id * offsetof<Typeinfo>()).base);
   }
   return false;

std/assembly/rt/README.md

@@ -6,56 +6,54 @@ The runtime provides the functionality necessary to dynamically allocate and dea
 Interface
 ---------
 
-### Memory manager
-
-* **__alloc**(size: `usize`): `usize`<br />
-  Dynamically allocates a chunk of memory of at least the specified size and returns its address.
-  Alignment is guaranteed to be 16 bytes to fit up to v128 values naturally.
-
-* **__realloc**(ref: `usize`, size: `usize`): `usize`<br />
-  Dynamically changes the size of a chunk of memory, possibly moving it to a new address.
-
-* **__free**(ref: `usize`): `void`<br />
-  Frees a dynamically allocated chunk of memory by its address.
-
 ### Garbage collector / `--exportRuntime`
 
 * **__new**(size: `usize`, id: `u32` = 0): `usize`<br />
   Dynamically allocates a GC object of at least the specified size and returns its address.
   Alignment is guaranteed to be 16 bytes to fit up to v128 values naturally.
   GC-allocated objects cannot be used with `__realloc` and `__free`.
 
+* **__pin**(ptr: `usize`): `usize`<br />
+  Pins the object pointed to by `ptr` externally so it and its directly reachable members and indirectly reachable objects do not become garbage collected.
+
+* **__unpin**(ptr: `usize`): `void`<br />
+  Unpins the object pointed to by `ptr` externally so it can become garbage collected.
+
 * **__collect**(): `void`<br />
-  Performs a full garbage collection cycle.
+  Performs a full garbage collection.
 
 ### Internals
 
+* **__alloc**(size: `usize`): `usize`<br />
+  Dynamically allocates a chunk of memory of at least the specified size and returns its address.
+  Alignment is guaranteed to be 16 bytes to fit up to v128 values naturally.
+
+* **__realloc**(ptr: `usize`, size: `usize`): `usize`<br />
+  Dynamically changes the size of a chunk of memory, possibly moving it to a new address.
+
+* **__free**(ptr: `usize`): `void`<br />
+  Frees a dynamically allocated chunk of memory by its address.
+
 * **__renew**(ptr: `usize`, size: `usize`): `usize`<br />
   Like `__realloc`, but for `__new`ed GC objects.
 
 * **__link**(parentPtr: `usize`, childPtr: `usize`, expectMultiple: `bool`): `void`<br />
   Introduces a link from a parent object to a child object, i.e. upon `parent.field = child`.
 
-* **__visit**(ref: `usize`, cookie: `u32`): `void`<br />
+* **__visit**(ptr: `usize`, cookie: `u32`): `void`<br />
   Concrete visitor implementation called during traversal. Cookie can be used to indicate one of multiple operations.
 
-### Built-ins
-
-* **__typeinfo**(id: `u32`): `RTTIFlags`<br />
-  Obtains the runtime type information for objects with the specified runtime id. Runtime type information is a set of flags indicating whether a type is managed, an array or similar, and what the relevant alignments when creating an instance externally are etc.
-
-* **__instanceof**
-
 * **__visit_globals**(cookie: `u32`): `void`<br />
   Calls `__visit` on each global that is of a managed type.
 
-* **__visit_members**(ref: `usize`, cookie: `u32`): `void`<br />
-  Calls `__visit` on each member of the object pointed to by `ref`.
+* **__visit_members**(ptr: `usize`, cookie: `u32`): `void`<br />
+  Calls `__visit` on each member of the object pointed to by `ptr`.
 
-### Related
+* **__typeinfo**(id: `u32`): `RTTIFlags`<br />
+  Obtains the runtime type information for objects with the specified runtime id. Runtime type information is a set of flags indicating whether a type is managed, an array or similar, and what the relevant alignments when creating an instance externally are etc.
 
-* **idof**<`T`>(): `u32`<br />
-  Obtains the unique internal class id of a managed type.
+* **__instanceof**(ptr: `usize`, classId: `u32`): `bool`<br />
+  Tests if the object pointed to by `ptr` is an instance of the specified class id.
 
 ITCMS / `--runtime incremental`
 -----
@@ -84,3 +82,5 @@ STUB / `--runtime stub`
 ----
 
 The stub is a maximally minimal runtime substitute, consisting of a simple and fast bump allocator with no means of freeing up memory again, except when freeing the respective most recently allocated object on top of the bump. Useful where memory is not a concern, and/or where it is sufficient to destroy the whole module including any potential garbage after execution.
+
+See also: [Garbage collection](https://www.assemblyscript.org/garbage-collection.html)