sigildocs

(sigil build native)

Native Package Support

This module provides functions for detecting and building native packages (packages with C code) during the bundling process.

When an app depends on packages with native code (c-sources in their library definitions), we need to:

  1. Detect which packages have native code
  2. Generate an entrypoint that initializes all native modules
  3. Compile the native code
  4. Link a custom runtime

Exports

package-has-native-code?procedure

Check if a package has native code (C sources with native-init).

A package has native code if it has a libraries: field with at least one library that has c-sources and native-init.

find-native-packagesprocedure

Find all native packages from a list of loaded packages.

Returns a list of packages that have native code.

collect-native-init-functionsprocedure

Collect all native-init function names from packages.

Returns a list of strings (C function names) in dependency order.

collect-native-include-dirsprocedure

Collect all C include directories from native packages.

Returns an alist of (package-path . include-dirs).

collect-native-sourcesprocedure

Collect all C source files from native packages.

Returns an alist of (package-name . source-patterns).

generate-native-entrypointprocedure

Generate the C code for a custom runtime entrypoint.

This creates a main.c that:

  1. Includes sigil.h and necessary headers
  2. Declares extern for each native init function
  3. Creates the VM and calls native init functions
  4. Reads manifest from bundled archive (if available)
  5. For scripts: loads the script with (load)
  6. For programs: imports entry module and calls (main)

init-functions: list of C function name strings entry-module: string like "(my-app main)" - fallback if no manifest

Returns the generated C code as a string.

entrypoint-headersprocedure

Generate common C headers for entrypoints.

entrypoint-native-declarationsprocedure

Generate native module forward declarations.

entrypoint-helper-functionsprocedure

Generate getexedir and path_join helper functions.

entrypoint-main-prologueprocedure

Generate main function prologue: exe_dir detection and VM creation.

entrypoint-native-initprocedure

Generate native module initialization calls.

entrypoint-lib-path-setupprocedure

Generate library path setup (adds ../lib relative to binary).

entrypoint-main-epilogueprocedure

Generate main function epilogue: cleanup and return.

generate-dev-entrypointprocedure

Generate a dev build entrypoint with native module support.

This is similar to generate-native-entrypoint but includes DEV_BUILD features like boot-eval command and dev library path setup.

init-functions: list of C function name strings entry-module: string like "(sigil cli)"

Returns the generated C code as a string.

generate-test-entrypointprocedure

Generate a test harness entrypoint with native module support.

This generates a standalone test runner that initializes native modules and then calls (sigil test cli) test-main with command-line arguments.

init-functions: list of C function names to call for native init

Returns the generated C code as a string.