library_builder library

Public extension surface for registering LuaLike libraries from Dart.

This library exposes the same registration types that LuaLike uses for its built-in libraries. Import it when you want to add reusable namespaced libraries, builder-style objects with metatables, or native functions that participate in runtime services such as cached primitive values and lazy library loading.

A minimal library implementation extends Library, defines functions inside registerFunctions(), and registers an instance through LibraryRegistry:

import 'package:lualike/library_builder.dart';
import 'package:lualike/lualike.dart';

class GreetingLibrary extends Library {
  @override
  String get name => 'greeting';

  @override
  void registerFunctions(LibraryRegistrationContext context) {
    final builder = BuiltinFunctionBuilder(context);

    context.define('hello', builder.create((args) {
      final who = args.isEmpty ? 'world' : Value.wrap(args.first).unwrap();
      return Value('hello, $who');
    }));
  }
}

Classes

BuiltinFunction

Abstract base class representing a built-in function in the interpreter.

BuiltinFunctionBuilder

Builds BuiltinFunction instances bound to a registration context.

BuiltinFunctionGcRefs

Optional interface for builtins that need to keep GC-visible references.

DocParam

Describes a single parameter accepted by a library function.

Environment

Represents a scope for variable bindings in the interpreter.

FunctionDoc