Auto-generated API doc: doxygen → custom Python emitter → doc/api/.

`cmake --build build --target doc` runs Doxygen to produce XML, then
`doc/gen_api_md.py` (~330 lines, stdlib-only) emits a Markdown tree
under `doc/api/` that gitea renders directly in its file browser.

- 24 class/struct pages + 51 source-file pages + indices, with source
  links of the form `../../../../src/...#L42` that gitea turns into
  clickable line-anchored links.
- Doxyfile.in templated by CMake (XML-only output to build/doc/xml/).
- Pure Python emitter, zero external deps — no doxybook2 (not packaged
  on Arch) and no moxygen (avoids Node).
- Target gracefully disabled if Doxygen or Python 3 is missing at
  configure time; regular build target unaffected.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

doc/api/classes/Connection.md

@@ -0,0 +1,45 @@
+# Connection
+
+`class Connection` — inherits [SystemElement](../classes/SystemElement.md)
+
+Defined in [connect.hpp:13](../../../../src/system/connect.hpp#L13)
+
+## Public Attributes
+
+### `Module * m1`
+
+📍 [connect.hpp:16](../../../../src/system/connect.hpp#L16)
+
+### `Part * p1`
+
+📍 [connect.hpp:17](../../../../src/system/connect.hpp#L17)
+
+### `Module * m2`
+
+📍 [connect.hpp:18](../../../../src/system/connect.hpp#L18)
+
+### `Part * p2`
+
+📍 [connect.hpp:19](../../../../src/system/connect.hpp#L19)
+
+### `std::string transform_name`
+
+📍 [connect.hpp:20](../../../../src/system/connect.hpp#L20)
+
+### `std::vector< std::pair< Pin *, Pin * > > pin_map`
+
+📍 [connect.hpp:21](../../../../src/system/connect.hpp#L21)
+
+## Public Functions
+
+### `Connection(std::string name)`
+
+📍 [connect.hpp:23](../../../../src/system/connect.hpp#L23)
+
+### `Connection(std::string name, Module *m1, Part *p1, Module *m2, Part *p2)`
+
+📍 [connect.hpp:24](../../../../src/system/connect.hpp#L24)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/Connections.md

@@ -0,0 +1,19 @@
+# Connections
+
+`class Connections` — inherits [SystemElementContainer< Connection >](../classes/SystemElementContainer.md)
+
+Defined in [connect.hpp:27](../../../../src/system/connect.hpp#L27)
+
+## Public Functions
+
+### `Connections(void)`
+
+📍 [connect.hpp:30](../../../../src/system/connect.hpp#L30)
+
+### `Connections(std::vector< Connection * > connections)`
+
+📍 [connect.hpp:31](../../../../src/system/connect.hpp#L31)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/IdentityTransform.md

@@ -0,0 +1,19 @@
+# IdentityTransform
+
+`class IdentityTransform` — inherits [Transform](../classes/Transform.md)
+
+Defined in [transform.hpp:42](../../../../src/system/transform.hpp#L42)
+
+## Public Functions
+
+### `IdentityTransform()`
+
+📍 [transform.hpp:45](../../../../src/system/transform.hpp#L45)
+
+### `std::vector< std::pair< Pin *, Pin * > > apply(Part *a, Part *b) const override`
+
+📍 [transform.hpp:46](../../../../src/system/transform.hpp#L46)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/ImportAltium.md

@@ -0,0 +1,27 @@
+# ImportAltium
+
+`class ImportAltium` — inherits [ImportBase](../classes/ImportBase.md)
+
+Defined in [import_altium.hpp:8](../../../../src/imports/import_altium.hpp#L8)
+
+## Public Functions
+
+### `ImportAltium(std::string filename)`
+
+📍 [import_altium.hpp:10](../../../../src/imports/import_altium.hpp#L10)
+
+### `void parse(Signals *signals) override`
+
+📍 [import_altium.hpp:11](../../../../src/imports/import_altium.hpp#L11)
+
+Pure virtual method for parsing the file.
+
+Derived classes must implement this method to define how the file is parsed.
+
+**Parameters**
+
+- `signals` — Pointer to the signals object to be completed.
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/ImportBase.md

@@ -0,0 +1,69 @@
+# ImportBase
+
+`class ImportBase`
+
+Defined in [import_base.hpp:16](../../../../src/imports/import_base.hpp#L16)
+
+Base class for importing data from a file.
+
+This class provides a foundation for parsing files and managing system parts and signals. Derived classes must implement the ``parse`` method. method.
+
+## Protected Attributes
+
+### `Parts * prts`
+
+📍 [import_base.hpp:19](../../../../src/imports/import_base.hpp#L19)
+
+Pointer to the [Parts](../classes/Parts.md) object. object.
+
+### `std::fstream file_lines`
+
+📍 [import_base.hpp:20](../../../../src/imports/import_base.hpp#L20)
+
+File stream for reading the input file.
+
+## Public Functions
+
+### `ImportBase(std::string file_name)`
+
+📍 [import_base.hpp:30](../../../../src/imports/import_base.hpp#L30)
+
+Constructor for [ImportBase](../classes/ImportBase.md)..
+
+Initializes the file stream and creates new [Parts](../classes/Parts.md) and and [Signals](../classes/Signals.md) objects. objects.
+
+**Parameters**
+
+- `file_name` — Name of the file to be imported.
+
+### `void parse(Signals *signals)=0`
+
+📍 [import_base.hpp:42](../../../../src/imports/import_base.hpp#L42)
+
+Pure virtual method for parsing the file.
+
+Derived classes must implement this method to define how the file is parsed.
+
+**Parameters**
+
+- `signals` — Pointer to the signals object to be completed.
+
+### `Parts * parts()`
+
+📍 [import_base.hpp:48](../../../../src/imports/import_base.hpp#L48)
+
+Retrieves the [Parts](../classes/Parts.md) object. object.
+
+**Returns** Pointer to the [Parts](../classes/Parts.md) object.
+
+### `~ImportBase()=default`
+
+📍 [import_base.hpp:58](../../../../src/imports/import_base.hpp#L58)
+
+Virtual destructor for [ImportBase](../classes/ImportBase.md)..
+
+Ensures proper cleanup of derived classes.
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/ImportMentor.md

@@ -0,0 +1,43 @@
+# ImportMentor
+
+`class ImportMentor` — inherits [ImportBase](../classes/ImportBase.md)
+
+Defined in [import_mentor.hpp:8](../../../../src/imports/import_mentor.hpp#L8)
+
+## Public Functions
+
+### `ImportMentor(std::string filename)`
+
+📍 [import_mentor.hpp:11](../../../../src/imports/import_mentor.hpp#L11)
+
+Constructor for [ImportMentor](../classes/ImportMentor.md)..
+
+Initializes the base class with the provided filename.
+
+**Parameters**
+
+- `filename` — Name of the file to be imported.
+
+### `void parse(Signals *signals) override`
+
+📍 [import_mentor.hpp:12](../../../../src/imports/import_mentor.hpp#L12)
+
+Parses the file to extract parts, pins, and signals.
+
+This method reads the file line by line, identifies parts and pins using regular expressions, and associates them with signals.
+
+**Parameters**
+
+- `signals` — Pointer to the [Signals](../classes/Signals.md) object used for managing signal connections.
+
+### `~ImportMentor()`
+
+📍 [import_mentor.hpp:13](../../../../src/imports/import_mentor.hpp#L13)
+
+Destructor for [ImportMentor](../classes/ImportMentor.md)..
+
+Ensures proper cleanup by calling the base class destructor.
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/ImportOds.md

@@ -0,0 +1,33 @@
+# ImportOds
+
+`class ImportOds` — inherits [ImportBase](../classes/ImportBase.md)
+
+Defined in [import_ods.hpp:6](../../../../src/imports/import_ods.hpp#L6)
+
+## Private Attributes
+
+### `std::string filename_`
+
+📍 [import_ods.hpp:8](../../../../src/imports/import_ods.hpp#L8)
+
+## Public Functions
+
+### `ImportOds(std::string filename)`
+
+📍 [import_ods.hpp:11](../../../../src/imports/import_ods.hpp#L11)
+
+### `void parse(Signals *signals) override`
+
+📍 [import_ods.hpp:12](../../../../src/imports/import_ods.hpp#L12)
+
+Pure virtual method for parsing the file.
+
+Derived classes must implement this method to define how the file is parsed.
+
+**Parameters**
+
+- `signals` — Pointer to the signals object to be completed.
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/Module.md

@@ -0,0 +1,35 @@
+# Module
+
+`class Module` — inherits [SystemElementContainer< Part >](../classes/SystemElementContainer.md)
+
+Defined in [modules.hpp:12](../../../../src/system/modules.hpp#L12)
+
+Forward declaration of the [Signals](../classes/Signals.md) class. class.
+
+## Public Attributes
+
+### `Signals * signals`
+
+📍 [modules.hpp:15](../../../../src/system/modules.hpp#L15)
+
+### `Modules * prnt`
+
+📍 [modules.hpp:16](../../../../src/system/modules.hpp#L16)
+
+## Public Functions
+
+### `Module(std::string name)`
+
+📍 [modules.hpp:17](../../../../src/system/modules.hpp#L17)
+
+### `~Module()`
+
+📍 [modules.hpp:18](../../../../src/system/modules.hpp#L18)
+
+### `void add(Part *part) override`
+
+📍 [modules.hpp:20](../../../../src/system/modules.hpp#L20)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/Modules.md

@@ -0,0 +1,27 @@
+# Modules
+
+`class Modules` — inherits [SystemElementContainer< Module >](../classes/SystemElementContainer.md)
+
+Defined in [modules.hpp:23](../../../../src/system/modules.hpp#L23)
+
+## Public Functions
+
+### `Modules(void)`
+
+📍 [modules.hpp:26](../../../../src/system/modules.hpp#L26)
+
+### `Modules(std::vector< Module * > parts)`
+
+📍 [modules.hpp:27](../../../../src/system/modules.hpp#L27)
+
+### `void add(Module *module)`
+
+📍 [modules.hpp:28](../../../../src/system/modules.hpp#L28)
+
+### `~Modules()`
+
+📍 [modules.hpp:29](../../../../src/system/modules.hpp#L29)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/Net.md

@@ -0,0 +1,15 @@
+# Net
+
+`struct Net`
+
+Defined in [nets.hpp:16](../../../../src/system/nets.hpp#L16)
+
+## Public Attributes
+
+### `std::vector< std::pair< Module *, Signal * > > members`
+
+📍 [nets.hpp:17](../../../../src/system/nets.hpp#L17)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/Part.md

@@ -0,0 +1,45 @@
+# Part
+
+`class Part` — inherits [SystemElementContainer< Pin >](../classes/SystemElementContainer.md)
+
+Defined in [parts.hpp:11](../../../../src/system/parts.hpp#L11)
+
+Forward declaration of the [Module](../classes/Module.md) class. class.
+
+## Public Attributes
+
+### `Module * prnt`
+
+📍 [parts.hpp:16](../../../../src/system/parts.hpp#L16)
+
+Pointer to the parent module.
+
+### `std::string connector_type`
+
+📍 [parts.hpp:17](../../../../src/system/parts.hpp#L17)
+
+Tag used by the transform registry; empty = untyped.
+
+### `ComponentKind kind`
+
+📍 [parts.hpp:18](../../../../src/system/parts.hpp#L18)
+
+Inferred from the part name's reference-designator prefix.
+
+## Public Functions
+
+### `Part(std::string name)`
+
+📍 [parts.hpp:14](../../../../src/system/parts.hpp#L14)
+
+### `~Part()`
+
+📍 [parts.hpp:15](../../../../src/system/parts.hpp#L15)
+
+### `void add(Pin *pin) override`
+
+📍 [parts.hpp:19](../../../../src/system/parts.hpp#L19)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/Parts.md

@@ -0,0 +1,19 @@
+# Parts
+
+`class Parts` — inherits [SystemElementContainer< Part >](../classes/SystemElementContainer.md)
+
+Defined in [parts.hpp:22](../../../../src/system/parts.hpp#L22)
+
+## Public Functions
+
+### `Parts(void)`
+
+📍 [parts.hpp:25](../../../../src/system/parts.hpp#L25)
+
+### `Parts(std::vector< Part * > parts)`
+
+📍 [parts.hpp:26](../../../../src/system/parts.hpp#L26)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/Signal.md

@@ -0,0 +1,31 @@
+# Signal
+
+`class Signal` — inherits [SystemElementContainer< Pin >](../classes/SystemElementContainer.md)
+
+Defined in [signals.hpp:11](../../../../src/system/signals.hpp#L11)
+
+## Public Attributes
+
+### `Signals * prnt`
+
+📍 [signals.hpp:14](../../../../src/system/signals.hpp#L14)
+
+Pointer to the parent signals object.
+
+### `SignalType type`
+
+📍 [signals.hpp:15](../../../../src/system/signals.hpp#L15)
+
+## Public Functions
+
+### `Signal(std::string name)`
+
+📍 [signals.hpp:16](../../../../src/system/signals.hpp#L16)
+
+### `void add(Pin *pin) override`
+
+📍 [signals.hpp:17](../../../../src/system/signals.hpp#L17)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/Signals.md

@@ -0,0 +1,27 @@
+# Signals
+
+`class Signals` — inherits [SystemElementContainer< Signal >](../classes/SystemElementContainer.md)
+
+Defined in [signals.hpp:20](../../../../src/system/signals.hpp#L20)
+
+## Public Functions
+
+### `Signals(void)`
+
+📍 [signals.hpp:23](../../../../src/system/signals.hpp#L23)
+
+### `Signals(std::vector< Signal * > signals)`
+
+📍 [signals.hpp:24](../../../../src/system/signals.hpp#L24)
+
+### `void add(Signal *signal) override`
+
+📍 [signals.hpp:25](../../../../src/system/signals.hpp#L25)
+
+### `~Signals()`
+
+📍 [signals.hpp:26](../../../../src/system/signals.hpp#L26)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/System.md

@@ -0,0 +1,41 @@
+# System
+
+`class System`
+
+Defined in [system.hpp:17](../../../../src/system/system.hpp#L17)
+
+## Private Attributes
+
+### `Modules * mods`
+
+📍 [system.hpp:19](../../../../src/system/system.hpp#L19)
+
+### `Connections * conns`
+
+📍 [system.hpp:20](../../../../src/system/system.hpp#L20)
+
+## Public Functions
+
+### `System()`
+
+📍 [system.hpp:23](../../../../src/system/system.hpp#L23)
+
+### `void Load(std::string module_name, std::string filename, ImportType type)`
+
+📍 [system.hpp:24](../../../../src/system/system.hpp#L24)
+
+### `Modules * modules() const`
+
+📍 [system.hpp:25](../../../../src/system/system.hpp#L25)
+
+### `Connections * connections() const`
+
+📍 [system.hpp:26](../../../../src/system/system.hpp#L26)
+
+### `~System()`
+
+📍 [system.hpp:27](../../../../src/system/system.hpp#L27)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/SystemElement.md

@@ -0,0 +1,29 @@
+# SystemElement
+
+`class SystemElement`
+
+Defined in [syselmts.hpp:14](../../../../src/system/syselmts.hpp#L14)
+
+Represents a basic system element with a name.
+
+## Public Attributes
+
+### `string name`
+
+📍 [syselmts.hpp:17](../../../../src/system/syselmts.hpp#L17)
+
+## Public Functions
+
+### `SystemElement(string name)`
+
+📍 [syselmts.hpp:23](../../../../src/system/syselmts.hpp#L23)
+
+Constructor for [SystemElement](../classes/SystemElement.md)..
+
+**Parameters**
+
+- `` — Name of the element.
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/SystemElementContainer.md

@@ -0,0 +1,195 @@
+# SystemElementContainer
+
+`class SystemElementContainer` — inherits [SystemElement](../classes/SystemElement.md)
+
+Defined in [syselmts.hpp:32](../../../../src/system/syselmts.hpp#L32)
+
+A container for managing system elements of type T.
+
+## Public Types
+
+### `using SystemElementContainer< T >::MapType = unordered_map<string, T *>`
+
+📍 [syselmts.hpp:35](../../../../src/system/syselmts.hpp#L35)
+
+### `using SystemElementContainer< T >::iterator = typename MapType::iterator`
+
+📍 [syselmts.hpp:36](../../../../src/system/syselmts.hpp#L36)
+
+### `using SystemElementContainer< T >::const_iterator = typename MapType::const_iterator`
+
+📍 [syselmts.hpp:37](../../../../src/system/syselmts.hpp#L37)
+
+## Protected Attributes
+
+### `unsigned int iter_count`
+
+📍 [syselmts.hpp:40](../../../../src/system/syselmts.hpp#L40)
+
+### `MapType content`
+
+📍 [syselmts.hpp:41](../../../../src/system/syselmts.hpp#L41)
+
+## Protected Functions
+
+### `void add(MapType el_content)`
+
+📍 [syselmts.hpp:47](../../../../src/system/syselmts.hpp#L47)
+
+Adds elements from a map to the container.
+
+**Parameters**
+
+- `el_content` — Map of elements to add.
+
+## Public Functions
+
+### `SystemElementContainer(string name)`
+
+📍 [syselmts.hpp:60](../../../../src/system/syselmts.hpp#L60)
+
+Constructor for an empty container.
+
+**Parameters**
+
+- `` — Name of the container.
+
+### `SystemElementContainer(string name, vector< T * > elements)`
+
+📍 [syselmts.hpp:67](../../../../src/system/syselmts.hpp#L67)
+
+Constructor with initial elements.
+
+**Parameters**
+
+- `` — Name of the container.
+- `elements` — Vector of elements to add.
+
+### `void add(string name, T *element)`
+
+📍 [syselmts.hpp:78](../../../../src/system/syselmts.hpp#L78)
+
+Adds a single element to the container with a given name.
+
+**Parameters**
+
+- `` — Name of the element to add.
+- `element` — Pointer to the element to add.
+
+**Throws**
+
+- `runtime_error` — If the element's name is empty or already exists.
+
+### `void add(T *element)`
+
+📍 [syselmts.hpp:96](../../../../src/system/syselmts.hpp#L96)
+
+Adds a single element to the container.
+
+**Parameters**
+
+- `element` — Pointer to the element to add.
+
+**Throws**
+
+- `runtime_error` — If the element's name is empty or already exists.
+
+### `bool exists(string name)`
+
+📍 [syselmts.hpp:106](../../../../src/system/syselmts.hpp#L106)
+
+Checks if an element exists in the container.
+
+**Parameters**
+
+- `` — Name of the element to check.
+
+**Returns** True if the element exists, false otherwise.
+
+### `void add(SystemElementContainer< T > *elements)`
+
+📍 [syselmts.hpp:123](../../../../src/system/syselmts.hpp#L123)
+
+Adds elements from another container.
+
+**Parameters**
+
+- `elements` — Pointer to another container.
+
+### `void add(vector< T * > elements)`
+
+📍 [syselmts.hpp:132](../../../../src/system/syselmts.hpp#L132)
+
+Adds multiple elements from a vector.
+
+**Parameters**
+
+- `elements` — Vector of elements to add.
+
+### `T * get(string name)`
+
+📍 [syselmts.hpp:146](../../../../src/system/syselmts.hpp#L146)
+
+Retrieves an element by its name.
+
+**Parameters**
+
+- `` — Name of the element to retrieve.
+
+**Returns** Pointer to the element.
+
+**Throws**
+
+- `runtime_error` — If the element is not found.
+
+### `T * merge(string name)`
+
+📍 [syselmts.hpp:164](../../../../src/system/syselmts.hpp#L164)
+
+Merges an element by retrieving it or creating a new one if it doesn't exist.
+
+**Parameters**
+
+- `` — Name of the element.
+
+**Returns** Pointer to the merged or newly created element.
+
+### `size_t size() const`
+
+📍 [syselmts.hpp:178](../../../../src/system/syselmts.hpp#L178)
+
+### `iterator begin()`
+
+📍 [syselmts.hpp:184](../../../../src/system/syselmts.hpp#L184)
+
+Returns an iterator to the beginning of the container.
+
+**Returns** Iterator to the beginning.
+
+### `iterator end()`
+
+📍 [syselmts.hpp:190](../../../../src/system/syselmts.hpp#L190)
+
+Returns an iterator to the end of the container.
+
+**Returns** Iterator to the end.
+
+### `const_iterator begin() const`
+
+📍 [syselmts.hpp:196](../../../../src/system/syselmts.hpp#L196)
+
+Returns a constant iterator to the beginning of the container.
+
+**Returns** Constant iterator to the beginning.
+
+### `const_iterator end() const`
+
+📍 [syselmts.hpp:202](../../../../src/system/syselmts.hpp#L202)
+
+Returns a constant iterator to the end of the container.
+
+**Returns** Constant iterator to the end.
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/Transform.md

@@ -0,0 +1,29 @@
+# Transform
+
+`class Transform`
+
+Defined in [transform.hpp:31](../../../../src/system/transform.hpp#L31)
+
+## Public Attributes
+
+### `std::string name`
+
+📍 [transform.hpp:34](../../../../src/system/transform.hpp#L34)
+
+## Public Functions
+
+### `Transform(std::string name)`
+
+📍 [transform.hpp:35](../../../../src/system/transform.hpp#L35)
+
+### `~Transform()=default`
+
+📍 [transform.hpp:36](../../../../src/system/transform.hpp#L36)
+
+### `std::vector< std::pair< Pin *, Pin * > > apply(Part *a, Part *b) const =0`
+
+📍 [transform.hpp:37](../../../../src/system/transform.hpp#L37)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/TransformRegistry.md

@@ -0,0 +1,57 @@
+# TransformRegistry
+
+`class TransformRegistry`
+
+Defined in [transform.hpp:49](../../../../src/system/transform.hpp#L49)
+
+## Private Attributes
+
+### `std::map< std::pair< std::string, std::string >, Transform * > entries`
+
+📍 [transform.hpp:51](../../../../src/system/transform.hpp#L51)
+
+### `Transform * identity_`
+
+📍 [transform.hpp:52](../../../../src/system/transform.hpp#L52)
+
+## Private Functions
+
+### `TransformRegistry()`
+
+📍 [transform.hpp:53](../../../../src/system/transform.hpp#L53)
+
+### `~TransformRegistry()`
+
+📍 [transform.hpp:54](../../../../src/system/transform.hpp#L54)
+
+## Public Static Functions
+
+### `TransformRegistry & get()`
+
+📍 [transform.hpp:57](../../../../src/system/transform.hpp#L57)
+
+## Public Functions
+
+### `void add(const std::string &kindA, const std::string &kindB, Transform *t)`
+
+📍 [transform.hpp:58](../../../../src/system/transform.hpp#L58)
+
+### `Transform * lookup(const std::string &kindA, const std::string &kindB) const`
+
+📍 [transform.hpp:61](../../../../src/system/transform.hpp#L61)
+
+### `Transform * identity() const`
+
+📍 [transform.hpp:62](../../../../src/system/transform.hpp#L62)
+
+### `TransformRegistry(const TransformRegistry &)=delete`
+
+📍 [transform.hpp:64](../../../../src/system/transform.hpp#L64)
+
+### `TransformRegistry & operator=(const TransformRegistry &)=delete`
+
+📍 [transform.hpp:65](../../../../src/system/transform.hpp#L65)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/Tui.md

@@ -0,0 +1,397 @@
+# Tui
+
+`class Tui`
+
+Defined in [tui.hpp:17](../../../../src/tui/tui.hpp#L17)
+
+## Private type
+
+### `enum Completion`
+
+📍 [tui.hpp:18](../../../../src/tui/tui.hpp#L18)
+
+## Private Attributes
+
+### `std::vector< std::string > history`
+
+📍 [tui.hpp:40](../../../../src/tui/tui.hpp#L40)
+
+### `std::vector< std::string > recorded`
+
+📍 [tui.hpp:41](../../../../src/tui/tui.hpp#L41)
+
+### `std::vector< std::string > output`
+
+📍 [tui.hpp:42](../../../../src/tui/tui.hpp#L42)
+
+### `std::string input`
+
+📍 [tui.hpp:43](../../../../src/tui/tui.hpp#L43)
+
+### `int cursor_pos`
+
+📍 [tui.hpp:44](../../../../src/tui/tui.hpp#L44)
+
+### `int history_idx`
+
+📍 [tui.hpp:45](../../../../src/tui/tui.hpp#L45)
+
+### `int scroll_offset`
+
+📍 [tui.hpp:46](../../../../src/tui/tui.hpp#L46)
+
+Lines scrolled up from the tail; 0 = follow newest output.
+
+### `bool quit`
+
+📍 [tui.hpp:47](../../../../src/tui/tui.hpp#L47)
+
+### `bool in_source`
+
+📍 [tui.hpp:48](../../../../src/tui/tui.hpp#L48)
+
+### `std::unique_ptr< System > sys`
+
+📍 [tui.hpp:50](../../../../src/tui/tui.hpp#L50)
+
+### `std::deque< Prompt > pending`
+
+📍 [tui.hpp:51](../../../../src/tui/tui.hpp#L51)
+
+### `std::map< std::string, CommandSpec > commands`
+
+📍 [tui.hpp:52](../../../../src/tui/tui.hpp#L52)
+
+### `std::map< std::string, std::string > vars`
+
+📍 [tui.hpp:53](../../../../src/tui/tui.hpp#L53)
+
+$var-style substitution table.
+
+### `int screen_idx`
+
+📍 [tui.hpp:56](../../../../src/tui/tui.hpp#L56)
+
+### `std::vector< std::string > search_modules`
+
+📍 [tui.hpp:59](../../../../src/tui/tui.hpp#L59)
+
+### `std::vector< std::string > search_types`
+
+📍 [tui.hpp:60](../../../../src/tui/tui.hpp#L60)
+
+### `int search_module_idx`
+
+📍 [tui.hpp:61](../../../../src/tui/tui.hpp#L61)
+
+### `int search_type_idx`
+
+📍 [tui.hpp:62](../../../../src/tui/tui.hpp#L62)
+
+### `int search_focus_idx`
+
+📍 [tui.hpp:63](../../../../src/tui/tui.hpp#L63)
+
+### `std::string search_query`
+
+📍 [tui.hpp:64](../../../../src/tui/tui.hpp#L64)
+
+### `std::vector< std::string > connect_modules`
+
+📍 [tui.hpp:67](../../../../src/tui/tui.hpp#L67)
+
+### `int connect_m1_idx`
+
+📍 [tui.hpp:68](../../../../src/tui/tui.hpp#L68)
+
+### `int connect_m2_idx`
+
+📍 [tui.hpp:69](../../../../src/tui/tui.hpp#L69)
+
+### `std::string connect_p1_filter`
+
+📍 [tui.hpp:70](../../../../src/tui/tui.hpp#L70)
+
+### `std::string connect_p2_filter`
+
+📍 [tui.hpp:71](../../../../src/tui/tui.hpp#L71)
+
+### `std::vector< std::string > connect_p1_list`
+
+📍 [tui.hpp:72](../../../../src/tui/tui.hpp#L72)
+
+### `std::vector< std::string > connect_p2_list`
+
+📍 [tui.hpp:73](../../../../src/tui/tui.hpp#L73)
+
+### `int connect_p1_idx`
+
+📍 [tui.hpp:74](../../../../src/tui/tui.hpp#L74)
+
+### `int connect_p2_idx`
+
+📍 [tui.hpp:75](../../../../src/tui/tui.hpp#L75)
+
+### `int connect_focus_idx`
+
+📍 [tui.hpp:76](../../../../src/tui/tui.hpp#L76)
+
+### `std::vector< std::string > explore_modules`
+
+📍 [tui.hpp:79](../../../../src/tui/tui.hpp#L79)
+
+### `int explore_module_idx`
+
+📍 [tui.hpp:80](../../../../src/tui/tui.hpp#L80)
+
+### `std::vector< std::string > explore_types`
+
+📍 [tui.hpp:81](../../../../src/tui/tui.hpp#L81)
+
+### `int explore_type_idx`
+
+📍 [tui.hpp:82](../../../../src/tui/tui.hpp#L82)
+
+### `std::vector< std::string > explore_children`
+
+📍 [tui.hpp:83](../../../../src/tui/tui.hpp#L83)
+
+### `int explore_child_idx`
+
+📍 [tui.hpp:84](../../../../src/tui/tui.hpp#L84)
+
+### `std::string explore_child_filter`
+
+📍 [tui.hpp:85](../../../../src/tui/tui.hpp#L85)
+
+### `std::string explore_detail_filter`
+
+📍 [tui.hpp:86](../../../../src/tui/tui.hpp#L86)
+
+### `std::vector< std::string > explore_detail`
+
+📍 [tui.hpp:87](../../../../src/tui/tui.hpp#L87)
+
+### `int explore_detail_idx`
+
+📍 [tui.hpp:88](../../../../src/tui/tui.hpp#L88)
+
+### `std::string explore_header`
+
+📍 [tui.hpp:89](../../../../src/tui/tui.hpp#L89)
+
+### `int explore_focus_idx`
+
+📍 [tui.hpp:90](../../../../src/tui/tui.hpp#L90)
+
+### `std::atomic< bool > loading`
+
+📍 [tui.hpp:93](../../../../src/tui/tui.hpp#L93)
+
+true while a script is being processed; read by tick thread.
+
+### `std::atomic< bool > tick_in_flight`
+
+📍 [tui.hpp:94](../../../../src/tui/tui.hpp#L94)
+
+main thread acks each tick by clearing this; ticker waits.
+
+### `std::string loading_filename`
+
+📍 [tui.hpp:95](../../../../src/tui/tui.hpp#L95)
+
+### `std::vector< std::string > loading_lines`
+
+📍 [tui.hpp:96](../../../../src/tui/tui.hpp#L96)
+
+### `size_t loading_idx`
+
+📍 [tui.hpp:97](../../../../src/tui/tui.hpp#L97)
+
+### `int loading_executed`
+
+📍 [tui.hpp:98](../../../../src/tui/tui.hpp#L98)
+
+### `int loading_lineno`
+
+📍 [tui.hpp:99](../../../../src/tui/tui.hpp#L99)
+
+### `bool loading_prev_in_source`
+
+📍 [tui.hpp:100](../../../../src/tui/tui.hpp#L100)
+
+### `ftxui::ScreenInteractive * screen_ptr`
+
+📍 [tui.hpp:101](../../../../src/tui/tui.hpp#L101)
+
+set in `Run()` so Source() can post events. so Source() can post events.
+
+### `std::vector< std::string > net_modules`
+
+📍 [tui.hpp:104](../../../../src/tui/tui.hpp#L104)
+
+### `int net_module_idx`
+
+📍 [tui.hpp:105](../../../../src/tui/tui.hpp#L105)
+
+### `std::string net_sig_filter`
+
+📍 [tui.hpp:106](../../../../src/tui/tui.hpp#L106)
+
+### `std::vector< std::string > net_sigs`
+
+📍 [tui.hpp:107](../../../../src/tui/tui.hpp#L107)
+
+rebuilt every frame from filter
+
+### `int net_sig_idx`
+
+📍 [tui.hpp:108](../../../../src/tui/tui.hpp#L108)
+
+### `int net_focus_idx`
+
+📍 [tui.hpp:109](../../../../src/tui/tui.hpp#L109)
+
+### `std::vector< std::string > settype_modules`
+
+📍 [tui.hpp:112](../../../../src/tui/tui.hpp#L112)
+
+### `int settype_m_idx`
+
+📍 [tui.hpp:113](../../../../src/tui/tui.hpp#L113)
+
+### `std::string settype_p_filter`
+
+📍 [tui.hpp:114](../../../../src/tui/tui.hpp#L114)
+
+### `std::vector< std::string > settype_p_list`
+
+📍 [tui.hpp:115](../../../../src/tui/tui.hpp#L115)
+
+### `int settype_p_idx`
+
+📍 [tui.hpp:116](../../../../src/tui/tui.hpp#L116)
+
+### `std::string settype_type`
+
+📍 [tui.hpp:117](../../../../src/tui/tui.hpp#L117)
+
+### `std::string settype_status`
+
+📍 [tui.hpp:118](../../../../src/tui/tui.hpp#L118)
+
+### `int settype_focus_idx`
+
+📍 [tui.hpp:119](../../../../src/tui/tui.hpp#L119)
+
+## Public Functions
+
+### `Tui()`
+
+📍 [tui.hpp:122](../../../../src/tui/tui.hpp#L122)
+
+### `~Tui()`
+
+📍 [tui.hpp:123](../../../../src/tui/tui.hpp#L123)
+
+### `void Run()`
+
+📍 [tui.hpp:124](../../../../src/tui/tui.hpp#L124)
+
+## Private Functions
+
+### `void RegisterCommands()`
+
+📍 [tui.hpp:128](../../../../src/tui/tui.hpp#L128)
+
+### `void Print(const std::string &line)`
+
+📍 [tui.hpp:131](../../../../src/tui/tui.hpp#L131)
+
+### `void Submit()`
+
+📍 [tui.hpp:132](../../../../src/tui/tui.hpp#L132)
+
+### `void Dispatch(const std::string &raw)`
+
+📍 [tui.hpp:133](../../../../src/tui/tui.hpp#L133)
+
+### `void Finalize(const std::string &name, const CommandSpec &spec, const std::vector< std::string > &args)`
+
+📍 [tui.hpp:134](../../../../src/tui/tui.hpp#L134)
+
+### `void HistoryUp()`
+
+📍 [tui.hpp:137](../../../../src/tui/tui.hpp#L137)
+
+### `void HistoryDown()`
+
+📍 [tui.hpp:138](../../../../src/tui/tui.hpp#L138)
+
+### `void CancelPending()`
+
+📍 [tui.hpp:139](../../../../src/tui/tui.hpp#L139)
+
+### `void LoadHistory()`
+
+📍 [tui.hpp:140](../../../../src/tui/tui.hpp#L140)
+
+### `void AppendHistory(const std::string &cmd)`
+
+📍 [tui.hpp:141](../../../../src/tui/tui.hpp#L141)
+
+### `void Source(const std::string &filename)`
+
+📍 [tui.hpp:142](../../../../src/tui/tui.hpp#L142)
+
+### `void ProcessNextSourceLine()`
+
+📍 [tui.hpp:143](../../../../src/tui/tui.hpp#L143)
+
+### `std::string ExpandVars(const std::string &s) const`
+
+📍 [tui.hpp:144](../../../../src/tui/tui.hpp#L144)
+
+### `void CompleteCommand(size_t start=0)`
+
+📍 [tui.hpp:147](../../../../src/tui/tui.hpp#L147)
+
+### `void CompletePath(size_t start=0)`
+
+📍 [tui.hpp:148](../../../../src/tui/tui.hpp#L148)
+
+### `void CompleteInline()`
+
+📍 [tui.hpp:149](../../../../src/tui/tui.hpp#L149)
+
+### `void RefreshFilteredPartList(const std::vector< std::string > &modules, int m_idx, const std::string &filter, std::vector< std::string > &out, int &sel_idx)`
+
+📍 [tui.hpp:152](../../../../src/tui/tui.hpp#L152)
+
+### `ftxui::Component BuildMainScreen(ftxui::ScreenInteractive &screen)`
+
+📍 [tui.hpp:159](../../../../src/tui/tui.hpp#L159)
+
+### `ftxui::Component BuildSearchScreen()`
+
+📍 [tui.hpp:160](../../../../src/tui/tui.hpp#L160)
+
+### `ftxui::Component BuildConnectScreen()`
+
+📍 [tui.hpp:161](../../../../src/tui/tui.hpp#L161)
+
+### `ftxui::Component BuildSettypeScreen()`
+
+📍 [tui.hpp:162](../../../../src/tui/tui.hpp#L162)
+
+### `ftxui::Component BuildExploreScreen()`
+
+📍 [tui.hpp:163](../../../../src/tui/tui.hpp#L163)
+
+### `ftxui::Component BuildNetScreen()`
+
+📍 [tui.hpp:164](../../../../src/tui/tui.hpp#L164)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/Tui_1_1CommandSpec.md

@@ -0,0 +1,37 @@
+# Tui::CommandSpec
+
+`struct Tui::CommandSpec`
+
+Defined in [tui.hpp:26](../../../../src/tui/tui.hpp#L26)
+
+## Public Attributes
+
+### `std::vector< Param > params`
+
+📍 [tui.hpp:31](../../../../src/tui/tui.hpp#L31)
+
+### `std::function< void(const std::vector< std::string > &)> action`
+
+📍 [tui.hpp:32](../../../../src/tui/tui.hpp#L32)
+
+### `bool prompt_for_missing`
+
+📍 [tui.hpp:33](../../../../src/tui/tui.hpp#L33)
+
+### `std::string description`
+
+📍 [tui.hpp:34](../../../../src/tui/tui.hpp#L34)
+
+### `bool scriptable`
+
+📍 [tui.hpp:35](../../../../src/tui/tui.hpp#L35)
+
+### `bool interactive`
+
+📍 [tui.hpp:36](../../../../src/tui/tui.hpp#L36)
+
+opens a full-screen mode when called bare
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/Tui_1_1CommandSpec_1_1Param.md

@@ -0,0 +1,19 @@
+# Tui::CommandSpec::Param
+
+`struct Tui::CommandSpec::Param`
+
+Defined in [tui.hpp:27](../../../../src/tui/tui.hpp#L27)
+
+## Public Attributes
+
+### `std::string name`
+
+📍 [tui.hpp:28](../../../../src/tui/tui.hpp#L28)
+
+### `Completion completion`
+
+📍 [tui.hpp:29](../../../../src/tui/tui.hpp#L29)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/Tui_1_1Prompt.md

@@ -0,0 +1,23 @@
+# Tui::Prompt
+
+`struct Tui::Prompt`
+
+Defined in [tui.hpp:20](../../../../src/tui/tui.hpp#L20)
+
+## Public Attributes
+
+### `std::string question`
+
+📍 [tui.hpp:21](../../../../src/tui/tui.hpp#L21)
+
+### `std::function< void(const std::string &)> on_answer`
+
+📍 [tui.hpp:22](../../../../src/tui/tui.hpp#L22)
+
+### `Completion completion`
+
+📍 [tui.hpp:23](../../../../src/tui/tui.hpp#L23)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/VpxTransform.md

@@ -0,0 +1,43 @@
+# VpxTransform
+
+`class VpxTransform` — inherits [Transform](../classes/Transform.md)
+
+Defined in [transform_vpx.hpp:23](../../../../src/system/transform_vpx.hpp#L23)
+
+## Public Types
+
+### `using VpxTransform::ColTable = std::map<char, char>`
+
+📍 [transform_vpx.hpp:26](../../../../src/system/transform_vpx.hpp#L26)
+
+## Private Attributes
+
+### `std::string bkp_kind_`
+
+📍 [transform_vpx.hpp:36](../../../../src/system/transform_vpx.hpp#L36)
+
+### `std::string payload_kind_`
+
+📍 [transform_vpx.hpp:37](../../../../src/system/transform_vpx.hpp#L37)
+
+### `std::vector< ColTable > bkp_to_payload_`
+
+📍 [transform_vpx.hpp:38](../../../../src/system/transform_vpx.hpp#L38)
+
+### `std::vector< ColTable > payload_to_bkp_`
+
+📍 [transform_vpx.hpp:39](../../../../src/system/transform_vpx.hpp#L39)
+
+## Public Functions
+
+### `VpxTransform(std::string name, std::string bkp_kind, std::string payload_kind, std::vector< ColTable > bkp_to_payload, std::vector< ColTable > payload_to_bkp)`
+
+📍 [transform_vpx.hpp:28](../../../../src/system/transform_vpx.hpp#L28)
+
+### `std::vector< std::pair< Pin *, Pin * > > apply(Part *a, Part *b) const override`
+
+📍 [transform_vpx.hpp:33](../../../../src/system/transform_vpx.hpp#L33)
+
+---
+
+← [Back to classes](index.md) · [Top](../index.md)

doc/api/classes/index.md

@@ -0,0 +1,30 @@
+# Classes & Structs
+
+| Name | Brief |
+|---|---|
+| [`Connection`](Connection.md) | — |
+| [`Connections`](Connections.md) | — |
+| [`IdentityTransform`](IdentityTransform.md) | — |
+| [`ImportAltium`](ImportAltium.md) | — |
+| [`ImportBase`](ImportBase.md) | Base class for importing data from a file. |
+| [`ImportMentor`](ImportMentor.md) | — |
+| [`ImportOds`](ImportOds.md) | — |
+| [`Module`](Module.md) | Forward declaration of the [Signals](../classes/Signals.md) class. class. |
+| [`Modules`](Modules.md) | — |
+| [`Net`](Net.md) | — |
+| [`Part`](Part.md) | Forward declaration of the [Module](../classes/Module.md) class. class. |
+| [`Parts`](Parts.md) | — |
+| [`Signal`](Signal.md) | — |
+| [`Signals`](Signals.md) | — |
+| [`System`](System.md) | — |
+| [`SystemElement`](SystemElement.md) | Represents a basic system element with a name. |
+| [`SystemElementContainer`](SystemElementContainer.md) | A container for managing system elements of type T. |
+| [`Transform`](Transform.md) | — |
+| [`TransformRegistry`](TransformRegistry.md) | — |
+| [`Tui`](Tui.md) | — |
+| [`Tui::CommandSpec`](Tui_1_1CommandSpec.md) | — |
+| [`Tui::CommandSpec::Param`](Tui_1_1CommandSpec_1_1Param.md) | — |
+| [`Tui::Prompt`](Tui_1_1Prompt.md) | — |
+| [`VpxTransform`](VpxTransform.md) | — |
+
+← [Top](../index.md)