failCompilation (--)

Inputs

• None.

Outputs

• None.

This builtin has no inputs and no outputs. As soon as it is reached during compilation, compilation fails unconditionally.

The reported error text is always the single generic line failCompilation. The message cannot be customized.

Behavior

• The builtin always fails.
• No result is pushed onto the data stack.
• The language-level error text is the fixed name failCompilation.
• It does not accept a caller-supplied message.
• Extra context is printed separately before calling failCompilation.

Example

{} 0 {} [
  "about to stop" printCompilerMessage
  failCompilation
  0
] "main" exportFunction

Expected Output During Compilation

about to stop

Expected Compilation Error Text

failCompilation

See also

• getCallTrace builtin (-- callTrace) Returns a Ref to the current call trace, or NIL when unavailable.
• printCompilerMessage builtin (message --) Prints a known Text message during compilation and appends one line-feed character.
• printStack builtin (--) Prints the current data stack in canonical formatter form; it does not itself pop stack values.
• printStackTrace builtin (--) Prints the current scope stack as file path, line, column, and node source text information.
• raiseStaticError builtin (message --) Raises a compile-time error with the given known Text message.