alive developer documentation

This section documents the implementation of the alive language and copilot. It is relevant to everyone who is looking to modify, improve or extend alive with new modules, language or interpreter features.

If you are looking for the language reference for users, head over to the reference section of the documentation.

modules

• base: Base definitions for extensions.
• base.match: Pattern capturing for Op argument parsing.
• builtins: Builtin Builtins and Ops.
• init: alive public API.
• invoke: Builtins for invoking Ops and FnDefs.
• module: Per-file execution context.
• parsing: Lpeg Grammar for parsing alive code.
• result: Result interface and implementations.
• type: Type definitions (type.Type and implementations).
• util: General utilities
• version: alive source code version information.

classes

• AST: AST Node Interface.
• Builtin: Builtin / Special Form evaluation Strategy (builtin).
• FnDef: User-function definition (fndef).
• Input: Update scheduling policy for Op arguments.
• Op: Persistent expression Operator.
• PureOp: Stateless Operator base for pure functions.
• Cell: S-Expression Cell, implements the AST interface.
• Copilot: File watcher and runtime entrypoint.
• CLICopilot: CLI Copilot entrypoint.
• FLTKCopilot: fltk4lua Copilot GUI.
• LoveCopilot: löve Copilot entrypoint.
• UDPServer: Editor Integration UDP Server
• WXCopilot: wxLua Copilot GUI.
• Dummy: Dummy AST Node.
• Error: Language error and traceback.
• Logger: Logger implementation.
• Registry: Tag Registry.
• Result: base Result interface.
• Constant: Constant Value.
• EvtStream: Stream of momentary events.
• SigStream: Continuous stream of values.
• RTNode: RTNode of evaluating an expression.
• Scope: Mapping from syms to RTNodes.
• Tag: Identity provider for Cells and Builtins.
• TemplateString: A string with substitutions, partially implements the AST interface.

topics

• writing_extensions.md