codeRef (inputsSchema output options -- code)

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.

codeRef (inputsSchema output options -- code)

Inputs

inputsSchema: Descriptor of the Code input stack.

output: Descriptor of the Code output stack.

options: Descriptor of the Code calling options.

Outputs

code: Constructed Code value.

codeRef is a Code schema constructor. A callable signature is formed from an input descriptor, an output descriptor, an options descriptor, and codeRef.

codeRef does not compile a body and does not create locals from the names written inside inputsSchema. Those names only describe the callable signature; they do not become locals in the surrounding scope. The result is a known NIL Code value of that signature.

Behavior

inputsSchema supplies the input schema as a Dict or the empty Tuple ().

output supplies the output schema.

options supplies signature options as a Dict or the empty Tuple (). See Options descriptor below for the recognized fields.

If the signature is valid, the builtin pushes a known NIL Code value of that schema.

The pushed value is a known NIL Code value, not a compiled function body.

codeRef? reports TRUE for the result, while code? reports FALSE.

The pushed value is not directly callable by call, because call rejects known NIL Code values.

isConst reports TRUE for the result, while known? reports FALSE because the value is still NIL.

Usable non-NIL code comes from exportFunction, importFunction, or assignment of a matching Block to a Code destination.

If the signature is invalid, the builtin fails instead of pushing a result.

Options descriptor

The options input is a Dict whose fields configure the resulting Code schema, or the empty Tuple () when no options are needed. The empty Dict {} is also valid and equivalent to (). Every option field must be non-static and known. Unrecognized field names are invalid.

Two option fields are recognized:

Name	Schema	Default	Meaning
`convention`	Text	absent = LLVM default	LLVM calling-convention keyword applied to the function declaration or definition. An empty Text `""` also selects the LLVM default. Typical values include `"ccc"` (C calling convention) and `"x86_stdcallcc"`. The Standard Library module `conventions` exports portable names `cdecl` and `stdcall` that resolve to the correct string for the current target.
`variadic`	Cond	absent = `FALSE`	When `TRUE`, the function accepts additional arguments after its declared inputs. At call sites the additional arguments are passed as a List or Tuple placed on the data stack below the declared inputs. Each item of that Struct must be non-Meta.

Name

Schema

Default

Meaning

convention

Text

absent = LLVM default

LLVM calling-convention keyword applied to the function declaration or definition. An empty Text "" also selects the LLVM default. Typical values include "ccc" (C calling convention) and "x86_stdcallcc". The Standard Library module conventions exports portable names cdecl and stdcall that resolve to the correct string for the current target.

variadic

Cond

absent = FALSE

When TRUE, the function accepts additional arguments after its declared inputs. At call sites the additional arguments are passed as a List or Tuple placed on the data stack below the declared inputs. Each item of that Struct must be non-Meta.

Example

{} 0 {} [ "-- empty signature --" printCompilerMessage {} () {} codeRef printStack _:; "-- non-empty signature is still only a signature value --" printCompilerMessage { value: 0; } 0 {} codeRef printStack _:; "-- family checks --" printCompilerMessage { value: 0; } 0 {} codeRef codeRef? printStack _:; { value: 0; } 0 {} codeRef code? printStack _:; { value: 0; } 0 {} codeRef known? printStack _:; { value: 0; } 0 {} codeRef isConst printStack _:; "-- convention option --" printCompilerMessage {} () {convention: "ccc";} codeRef printStack _:; "-- variadic option --" printCompilerMessage {format: 0nx;} 0 {convention: "ccc"; variadic: TRUE;} codeRef printStack _:; 0 ] "main" exportFunction

Expected Output During Compilation

-- empty signature -- {} () {} codeRef CNIL -- non-empty signature is still only a signature value -- {value: Int32;} Int32 {} codeRef CNIL -- family checks -- TRUE FALSE FALSE TRUE -- convention option -- {} () {convention: "ccc";} codeRef CNIL -- variadic option -- {format: Natx;} Int32 {convention: "ccc"; variadic: TRUE;} codeRef CNIL