How simulton/qschematic works
Project Type and Purpose
• This is an open-source C++23 library (QSchematic) built on Qt6’s Graphics View Framework.
• A demo application lives in the demo/ folder to showcase usage.
File-Structure Analysis
• Top-level modules:
• qschematic/ – core library (commands, items, wire_system, scene, netlist generation, settings, utils)
• demo/ – demo client application using the library (custom items, UI, netlist viewer)
• CMakeLists.txt and related build files – configure library and demo targets
• Key patterns:
• Command pattern (qschematic/commands) for undo/redo
• Factory pattern (itemfactory) for item creation
• Separation of rendering (scene/view) and data (netlist generator, model classes)
• External integration:
• Qt6 (GraphicsView, Widgets)
• GPDS for serialization (XML/YAML)
README Insights
• Confirms core components: Item base class, specialized Nodes/Wires, WireSystem, CommandStack, NetlistGenerator, Serialization modules.
Main Components
a. Components:
1. Client Application (e.g., demo executable)
2. QSchematic Library Modules:
– Scene & View (QGraphicsScene/QGraphicsView wrappers)
– Items (Item, NodeItem, WireItem, Connector, WidgetItem)
– Command Stack & Commands (add/move/remove/resize/rotate)
– WireSystem (connectable, net, manager, line/wire)
– Netlist Generator & Writers (in-memory, JSON, custom)
– Serialization (GPDS integration)
– Utilities & Settings
3. External Dependencies:
– Qt6 Framework
– GPDS (serialization)
b. Relationships & Interactions:
– Client calls Library API → creates Items via ItemFactory → adds to Scene
– User operations → Commands pushed to Command Stack → mutate Items in Scene → update WireSystem
– WireSystem Manager tracks nets and maintains connectivity
– NetlistGenerator traverses WireSystem & Items → produces netlist → hands off to JSONWriter or custom writer
– Serialization module uses GPDS to load/save scene + netlist templates
c. Architectural Patterns & Principles:
– Command Pattern for undo/redo
– Factory Pattern for extensibility of new Item types
– MVC-like separation: Scene/View (visual) vs. Model (netlist, items data)
– Plugin-style extensibility: subclass Item and Writer interfaces
d. Technologies & Frameworks:
– C++23, Qt6 Graphics View, Qt Widgets
– CMake build system with FetchContent / find_package integration
– GPDS for serialization; JSON writers
Essential Details to Capture
• The Command stack’s central role for undo/redo.
• The two‐way interaction between Items and WireSystem (items report connector changes).
• How netlist generation is decoupled via writer interfaces.
• Serialization plug-in capability via GPDS.
• CMake targets: static/shared library, demo executable.