addressToReference (address modelValue -- reconstructedValue)

Builtins

Name introduction, declaration modifiers, and module binding: NAME: ...;, codeRef, def, exportFunction, importFunction, importVariable, overload, private, static, use, and virtual.
Struct construction forms: (...), {...}, and array.
Selection forms: source-text selection with NAME and .NAME, read-only source-text selection with @NAME and .@NAME, and ordinal or known-name data-input selection with @, callField, and fieldRead.
Writing forms: source-text selection with !NAME and .!NAME, ordinal selection with ! and fieldWrite, and already-selected destination replacement with set.
Calling and control flow: call, if, loop, ucall, and uif.
Text operations: &, LF, attribute, textSize, and textSplit.
Condition constants, value comparison, and logical operators: <, =, >, DEBUG, FALSE, TRUE, and, is, lshift, or, rshift, xor, and ~.
Arithmetic and numeric transforms: *, +, -, /, ^, cast, ceil, cos, floor, log, log10, mod, neg, sin, and sqrt.
Reference, creation, and value-state operations: const, dynamic, isConst, isDirty, isDynamic, isRef, isStatic, known?, new, newVarOfTheSameType, stable?, unconst, and unknownStable?.
Schema and struct introspection: code?, codeRef?, fieldCount, fieldIndex, fieldIsRef, fieldIsVirtual, fieldName, has, isCombined, managed?, same, schemaName, and virtual?.
Storage and manual lifetime operations: addressToReference, alignment, manuallyDestroyVariable, manuallyInitVariable, storageAddress, and storageSize.
Diagnostics and compile-time failure: failCompilation, getCallTrace, printCompilerMessage, printStack, printStackTrace, and raiseStaticError.

addressToReference (address modelValue -- reconstructedValue)

Inputs

address: Numeric storage address to interpret.

modelValue: Value that supplies the result schema case. When it is Ref-like, it also supplies the result mutability.

Outputs

reconstructedValue: Value reconstructed from the address and model value schema.

addressToReference reconstructs a typed result from a numeric storage address and a model value.

The model value is used only to choose the result schema case and, for Ref-like model values, the result mutability. It is not dereferenced and it is not read from the supplied address.

If the model value is already Ref-like, the result has that same schema. Otherwise, a non-Meta non-Ref-like model produces a Ref to the model schema. For an In-place local or field, NAME or .NAME supplies the immutable Ref model case, while @NAME or .@NAME supplies the mutable case.

Behavior

A direct non-Meta non-Ref-like model value produces a Ref to the model schema at the supplied address.

A Ref, Code, or Text model value produces a result of that same schema reconstructed from the supplied address.

For Text model values, the supplied address is interpreted as the address of UTF-8 storage.

If the address is known to be zero, the builtin produces the known nil result of the implied schema. For direct non-Ref-like model values, that implied schema is the corresponding Ref schema.

If the address is nonzero or unknown, the builtin produces an unknown value or Ref tied to that address.

A Ref model value preserves its own Ref schema, including mutability. A direct non-Ref-like model value produces a mutable Ref result to the same schema.

Meta targets are invalid.

Example

{} () {} [ value: 7; text: "hello"; code: {} () {} codeRef; "-- Ref model value --" printCompilerMessage @value storageAddress @value addressToReference printStack _:; 0nx @value addressToReference printStack _:; "-- In-place model value --" printCompilerMessage @value storageAddress value addressToReference printStack _:; 0nx value addressToReference printStack _:; "-- text and code targets --" printCompilerMessage text storageAddress text addressToReference printStack _:; 0nx text addressToReference printStack _:; 0nx @code addressToReference printStack _:; ] "main" exportFunction

Expected Output During Compilation

-- Ref model value -- Int32 Ref Int32 NIL -- In-place model value -- Int32 Cref Int32 CNIL -- text and code targets -- Text Text CNIL {} () {} codeRef CNIL