# benaisc/picross architecture

> Architecture diagram of the GitHub repository benaisc/picross, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-31). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/benaisc/picross
- Repository: https://github.com/benaisc/picross

## Overview

##### Main Components

a) GUI Layer:
- Using Fenetre class (Fenetre.cpp/hpp)
- GTKmm dependency
- User interaction components

b) Core Game Logic:
- Picross class (picross.cpp/h) as the main controller
- Cell class (cell.cpp/h) for individual puzzle cells
- Matrix class (matrice.cpp/h) for grid management
- Liste and TabListe classes for puzzle constraint handling

c) File System Interface:
- Grilles directory containing puzzle definitions
- Different puzzle categories (normal and backtrack)

##### Component Relationships

**[User Interface Layer]**
- ↑↓
**[Game Logic Layer]**
- ↑↓
**[Data Structure Layer]**
- ↑↓
**[File System Layer]**

##### Specific Elements

a) User Interface Components:
- Main window container
- Grid display area
- Control buttons/inputs
- GTKmm framework integration

b) Core Logic Components:
- Puzzle solver engine
- Backtracking algorithm
- Solution validator
- Grid state manager

c) Data Structures:
- Cell matrix representation
- Management systems
- Constraint handlers

##### Important Relationships to Highlight

- How the Fenetre class communicates with Picross class
- Relationship between Matrice and Cell classes
- Demonstrate how puzzle files are loaded and processed
- Backtracking solution path

##### Technical Details

- GTKmm dependency version (3.0)
- File format specifications for puzzle definitions
- Class inheritance relationships
- Key method calls between components

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph UI["User Interface Layer"]
        GTK["GTKmm Framework"]
        MainWindow["Main Window"]:::ui
        GridDisplay["Grid Display"]:::ui
        Controls["Control Buttons"]:::ui
        Fenetre["Fenetre Class"]:::ui
    end

    subgraph Logic["Game Logic Layer"]
        Picross["Picross Controller"]:::logic
        Solver["Puzzle Solver"]:::logic
        Validator["Solution Validator"]:::logic
        BackTrack["Backtracking Algorithm"]:::logic
    end

    subgraph Data["Data Structure Layer"]
        Matrix["Matrix Class"]:::data
        Cell["Cell Class"]:::data
        Liste["Liste Class"]:::data
        TabListe["TabListe Class"]:::data
    end

    subgraph Storage["File System Layer"]
        NormalPuzzles["Standard Puzzles"]:::storage
        BackPuzzles["Backtrack Puzzles"]:::storage
    end

    subgraph Testing["Testing Framework"]
        CellTest["Cell Tests"]:::test
        MatrixTest["Matrix Tests"]:::test
        PicrossTest["Picross Tests"]:::test
        ListeTest["Liste Tests"]:::test
        TabListeTest["TabListe Tests"]:::test
    end

    subgraph Docs["Documentation"]
        APIDoc["API Documentation"]:::doc
        ProjectDoc["Project Documentation"]:::doc
        DesignDoc["System Design Documentation"]:::doc
    end

    %% Relationships
    GTK --> MainWindow
    MainWindow --> Fenetre
    GridDisplay --> Fenetre
    Controls --> Fenetre
    
    Fenetre --> Picross
    Picross --> Solver
    Picross --> Validator
    Solver --> BackTrack
    
    Picross --> Matrix
    Matrix --> Cell
    Picross --> Liste
    Picross --> TabListe
    
    Matrix --> NormalPuzzles
    BackTrack --> BackPuzzles
    
    Cell --> CellTest
    Matrix --> MatrixTest
    Picross --> PicrossTest
    Liste --> ListeTest
    TabListe --> TabListeTest

    %% Click Events
    click Fenetre "https://github.com/benaisc/Picross/blob/master/Fenetre.cpp"
    click Picross "https://github.com/benaisc/Picross/blob/master/picross.cpp"
    click Cell "https://github.com/benaisc/Picross/blob/master/cell.cpp"
    click Matrix "https://github.com/benaisc/Picross/blob/master/matrice.cpp"
    click Liste "https://github.com/benaisc/Picross/blob/master/liste.cpp"
    click TabListe "https://github.com/benaisc/Picross/blob/master/tabListe.cpp"
    click NormalPuzzles "https://github.com/benaisc/Picross/tree/master/Grilles"
    click BackPuzzles "https://github.com/benaisc/Picross/tree/master/Grilles/backtrack"
    click CellTest "https://github.com/benaisc/Picross/blob/master/Fichiers Test/testCell.cpp"
    click MatrixTest "https://github.com/benaisc/Picross/blob/master/Fichiers Test/testMatrice.cpp"
    click PicrossTest "https://github.com/benaisc/Picross/blob/master/Fichiers Test/testPicross.cpp"
    click ListeTest "https://github.com/benaisc/Picross/blob/master/Fichiers Test/testListe.cpp"
    click TabListeTest "https://github.com/benaisc/Picross/blob/master/Fichiers Test/testTabListe.cpp"
    click APIDoc "https://github.com/benaisc/Picross/tree/master/html"
    click ProjectDoc "https://github.com/benaisc/Picross/blob/master/Rapport/RapportPicross.pdf"
    click DesignDoc "https://github.com/benaisc/Picross/blob/master/Rapport/Picross schema.pdf"

    %% Styles
    classDef ui fill:#3498db,stroke:#2980b9,color:white
    classDef logic fill:#2ecc71,stroke:#27ae60,color:white
    classDef data fill:#f1c40f,stroke:#f39c12,color:black
    classDef storage fill:#e74c3c,stroke:#c0392b,color:white
    classDef test fill:#9b59b6,stroke:#8e44ad,color:white
    classDef doc fill:#95a5a6,stroke:#7f8c8d,color:white
```
