Expand description
§ferrocad
The base FerroCAD application. The binary (cargo install ferrocad) boots an
embedded CPython interpreter and opens the bite-gpui shell; the engine is
ferrocad_core and the shell library
is ferrocad_gpui.
§The payload
The app is useless without its Python facade and workbenches. A development
checkout has them in the workspace; cargo install does not, so the payload
is embedded into the binary and unpacked on first run. See payload for the
resolution order and the packaging story in docs/architecture/distribution.md.
§Editions
run_as is the entry point an edition (a thin binary that links extra
workbench modules and brands the window) calls. An edition registers its own
built-in modules first, then delegates here; see docs/architecture/repackaging.md.
Modules§
- payload
- Locating (and, when needed, unpacking) the app’s Python payload.
Structs§
- Contributions
- The workbench contributions an edition registers (its manipulators). The manipulators an edition contributes, in registration order.
- Edition
Args - The flags an edition accepts in both its windowed and headless modes.
- Render
Report - What a headless run produced, for the caller to print.
Functions§
- base_
contributions - The general edition’s contributions: the generic transform handle.
- check_
init - Boot the interpreter and the payload, then exit without opening a window.
- edition_
args - Parse
--render,--size,--scriptand--openfrom the process arguments. - register_
core_ module - Register the core
ferrocadPyO3 extension as a built-in module, soimport ferrocadresolves without a separateferrocad.abi3.soon disk.#[pymodule]expandsferrocad_py::ferrocadinto a hidden module, which the macro needs in scope by name. - render_
edition_ headless - Render an edition’s sample document headlessly to
out. - run
- Boot the embedded interpreter and open the shell window (the base app).
- run_as
- Like
run, but with an edition’sapp_name(the window title) and its Python entry module. - run_
edition run_aswith an explicit entry module (the edition’s app script).- run_
edition_ with run_editionwith the workbench contributions the edition registers.- run_
edition_ with_ document run_edition_withwith a document to open at boot (--open).