# nicolasserranogarcia/nsbaci architecture

> Architecture diagram of the GitHub repository nicolasserranogarcia/nsbaci, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nicolasserranogarcia/nsbaci
- Repository: https://github.com/nicolasserranogarcia/nsbaci

## Overview

NSBACI is a desktop environment for learning concurrency by editing BACI source, compiling it to p-code, and stepping or running the resulting program while inspecting runtime state. The documented architecture places a Controller between the Qt interface and file, compiler, and runtime services. The runtime combines an interpreter, scheduler, and program state; the UI also includes preferences, error, guide, and drawing views. Source excerpts establish the main wiring, but several implementation files were not sampled, so uncertain internal links are omitted.

Main entry points: [`source/ui/mainwindow/mainwindow.cpp`](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/ui/mainwindow/mainwindow.cpp) (Main window), [`source/controller/controller.cpp`](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/controller/controller.cpp) (Controller), [`source/main.cpp`](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/main.cpp) (Application setup), [`source/services/runtimeService/runtimeService.cpp`](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/runtimeService/runtimeService.cpp) (Runtime service)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ui["Desktop interface"]
  node_window["Main window<br/>[mainwindow.cpp]"]
  node_editor["Code editor<br/>[codeeditor.cpp]"]
  node_preferences["Preferences"]
  node_runtimeview["Runtime view<br/>[runtimeView.cpp]"]
  node_guide["User guide"]
  node_errors["Error dialogs"]
  node_drawing_widget["Drawing widget<br/>[drawingWidget.cpp]"]
end

subgraph group_coordination["Application coordination"]
  node_main["Application setup<br/>[main.cpp]"]
  node_controller["Controller<br/>[controller.cpp]"]
end

subgraph group_language["Source and compilation"]
  node_files["File service<br/>[fileService.cpp]"]
  node_compiler_service["Compiler service"]
  node_compiler["NSBACI compiler<br/>[nsbaciCompiler.cpp]"]
  node_instructions["P-code instructions<br/>[instruction.cpp]"]
end

subgraph group_execution["Program execution"]
  node_runtime_service["Runtime service<br/>[runtimeService.cpp]"]
  node_program["Program state<br/>[program.cpp]"]
  node_interpreter["NSBACI interpreter"]
  node_scheduler["NSBACI scheduler"]
  node_thread["Thread state<br/>[thread.cpp]"]
  node_semaphore["Semaphore state<br/>[semaphore.cpp]"]
end

subgraph group_graphics["Drawing"]
  node_drawing_service["Drawing service<br/>[drawingService.cpp]"]
end

node_user(("Learner"))

node_user -.->|"uses"| node_window
node_window -->|"sends actions"| node_controller
node_controller -->|"sends results"| node_window
node_window -.->|"hosts editor"| node_editor
node_window -.->|"opens"| node_preferences
node_window -->|"updates"| node_runtimeview
node_window -.->|"opens"| node_guide
node_window -.->|"shows errors"| node_errors
node_main -->|"creates"| node_window
node_main -->|"creates"| node_controller
node_controller -.->|"delegates file I/O"| node_files
node_controller -.->|"delegates compilation"| node_compiler_service
node_controller -.->|"controls execution"| node_runtime_service
node_compiler_service -->|"invokes compiler"| node_compiler
node_compiler -.->|"produces p-code"| node_instructions
node_runtime_service -->|"executes instructions"| node_interpreter
node_runtime_service -->|"selects threads"| node_scheduler
node_runtime_service -->|"loads program"| node_program
node_program -->|"stores instructions"| node_instructions
node_interpreter -->|"uses program state"| node_program
node_interpreter -->|"uses thread state"| node_thread
node_program -->|"manages semaphores"| node_semaphore
node_controller -.->|"coordinates drawing"| node_drawing_service
node_drawing_service -.->|"updates canvas"| node_drawing_widget
node_main -->|"creates service"| node_files
node_main -->|"creates service"| node_compiler_service
node_main -->|"creates service"| node_runtime_service
node_main -->|"creates service"| node_drawing_service

click node_main "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/main.cpp"
click node_window "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/ui/mainwindow/mainwindow.cpp"
click node_editor "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/ui/mainwindow/codeeditor.cpp"
click node_preferences "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/ui/preferencesDialog/preferencesDialog.cpp"
click node_runtimeview "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/ui/runtimeView/runtimeView.cpp"
click node_guide "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/ui/userGuideDialog/userGuideDialog.cpp"
click node_errors "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/ui/errorDialogFactory/errorDialogFactory.cpp"
click node_controller "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/controller/controller.cpp"
click node_files "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/fileService/fileService.cpp"
click node_compiler_service "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/compilerService/compilerService.cpp"
click node_compiler "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/compilerService/compiler/nsbaci/nsbaciCompiler.cpp"
click node_instructions "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/compilerService/compiler/instruction/instruction.cpp"
click node_runtime_service "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/runtimeService/runtimeService.cpp"
click node_program "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/runtimeService/program/program.cpp"
click node_interpreter "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/runtimeService/interpreter/nsbaci/nsbaciInterpreter.cpp"
click node_scheduler "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/runtimeService/scheduler/nsbaci/nsbaciScheduler.cpp"
click node_thread "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/runtimeService/thread/thread.cpp"
click node_semaphore "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/runtimeService/semaphore/semaphore.cpp"
click node_drawing_service "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/drawingService/drawingService.cpp"
click node_drawing_widget "https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/ui/drawingWidget/drawingWidget.cpp"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_window,node_editor,node_preferences,node_runtimeview,node_guide,node_errors,node_drawing_widget toneBlue
class node_main,node_controller toneAmber
class node_files,node_compiler_service,node_compiler,node_instructions toneMint
class node_runtime_service,node_program,node_interpreter,node_scheduler,node_thread,node_semaphore toneRose
class node_drawing_service,node_user toneIndigo
```

## Components

### Desktop interface

- [Main window](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/ui/mainwindow/mainwindow.cpp): `source/ui/mainwindow/mainwindow.cpp`
- [Code editor](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/ui/mainwindow/codeeditor.cpp): `source/ui/mainwindow/codeeditor.cpp`
- [Preferences](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/ui/preferencesDialog/preferencesDialog.cpp): `source/ui/preferencesDialog/preferencesDialog.cpp`
- [Runtime view](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/ui/runtimeView/runtimeView.cpp): `source/ui/runtimeView/runtimeView.cpp`
- [User guide](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/ui/userGuideDialog/userGuideDialog.cpp): `source/ui/userGuideDialog/userGuideDialog.cpp`
- [Error dialogs](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/ui/errorDialogFactory/errorDialogFactory.cpp): `source/ui/errorDialogFactory/errorDialogFactory.cpp`
- [Drawing widget](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/ui/drawingWidget/drawingWidget.cpp): `source/ui/drawingWidget/drawingWidget.cpp`

### Application coordination

- [Application setup](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/main.cpp): `source/main.cpp`
- [Controller](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/controller/controller.cpp): `source/controller/controller.cpp`

### Source and compilation

- [File service](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/fileService/fileService.cpp): `source/services/fileService/fileService.cpp`
- [Compiler service](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/compilerService/compilerService.cpp): `source/services/compilerService/compilerService.cpp`
- [NSBACI compiler](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/compilerService/compiler/nsbaci/nsbaciCompiler.cpp): `source/services/compilerService/compiler/nsbaci/nsbaciCompiler.cpp`
- [P-code instructions](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/compilerService/compiler/instruction/instruction.cpp): `source/services/compilerService/compiler/instruction/instruction.cpp`

### Program execution

- [Runtime service](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/runtimeService/runtimeService.cpp): `source/services/runtimeService/runtimeService.cpp`
- [Program state](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/runtimeService/program/program.cpp): `source/services/runtimeService/program/program.cpp`
- [NSBACI interpreter](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/runtimeService/interpreter/nsbaci/nsbaciInterpreter.cpp): `source/services/runtimeService/interpreter/nsbaci/nsbaciInterpreter.cpp`
- [NSBACI scheduler](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/runtimeService/scheduler/nsbaci/nsbaciScheduler.cpp): `source/services/runtimeService/scheduler/nsbaci/nsbaciScheduler.cpp`
- [Thread state](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/runtimeService/thread/thread.cpp): `source/services/runtimeService/thread/thread.cpp`
- [Semaphore state](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/runtimeService/semaphore/semaphore.cpp): `source/services/runtimeService/semaphore/semaphore.cpp`

### Drawing

- [Drawing service](https://github.com/nicolasserranogarcia/nsbaci/blob/main/source/services/drawingService/drawingService.cpp): `source/services/drawingService/drawingService.cpp`

### Other components

- **Learner**

## Connections

- Learner → Main window: uses
- Main window → Controller: sends actions
- Controller → Main window: sends results
- Main window → Code editor: hosts editor
- Main window → Preferences: opens
- Main window → Runtime view: updates
- Main window → User guide: opens
- Main window → Error dialogs: shows errors
- Application setup → Main window: creates (evidence: `source/main.cpp`)
- Application setup → Controller: creates (evidence: `source/main.cpp`)
- Controller → File service: delegates file I/O
- Controller → Compiler service: delegates compilation
- Controller → Runtime service: controls execution
- Compiler service → NSBACI compiler: invokes compiler
- NSBACI compiler → P-code instructions: produces p-code
- Runtime service → NSBACI interpreter: executes instructions
- Runtime service → NSBACI scheduler: selects threads
- Runtime service → Program state: loads program
- Program state → P-code instructions: stores instructions
- NSBACI interpreter → Program state: uses program state
- NSBACI interpreter → Thread state: uses thread state
- Program state → Semaphore state: manages semaphores
- Controller → Drawing service: coordinates drawing
- Drawing service → Drawing widget: updates canvas
- Application setup → File service: creates service (evidence: `source/main.cpp`)
- Application setup → Compiler service: creates service (evidence: `source/main.cpp`)
- Application setup → Runtime service: creates service (evidence: `source/main.cpp`)
- Application setup → Drawing service: creates service (evidence: `source/main.cpp`)
