# ikebastuz/wiper architecture

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

- Interactive diagram: https://gitdiagram.com/ikebastuz/wiper
- Repository: https://github.com/ikebastuz/wiper

## Overview

##### Main Components

a) Core Components:
- File System Scanner (src/fs)
- User Interface Layer (src/ui)
- Event Handler System (src/events)
- Task Manager (src/task_manager)
- Configuration Manager (src/config)

b) Supporting Components:
- Logger System (src/logger)
- FPS Counter (src/fps_counter)
- Spinner Animation (src/spinner)

##### Component Relationships

**┌─ User Interface Layer ─────────────────────┐**
- Chart Display                           │
- Content View                            │
- Footer Controls                         │
- Title Bar                               │
- ┬───────────────────────┬─┘

**┌─────────────────▼───────────────────┐   │**
- Event Handler                       │   │
- User Input Processing             │   │
- Command Routing                   │   │
- ┬───────────────────┘   │

**┌─────────────────▼───────────────────┐   │**
- Task Manager                        │   │
- File Operations                   │   │
- Directory Navigation             ◄├───┘
- ┬───────────────────┘

**┌─────────────────▼───────────────────┐**
- File System Layer                   │
- Directory Scanner                 │
- File Store (HashMap)             │
- Folder Entry Management          │
- ┬─┘
- ▲                 │

**┌─────────────────┴─────────────────▼─┐**
- Operating System File System        │
- ┬─┘

##### Important Details

a) Component Responsibilities:
- UI Layer: Handles user interface rendering and updates
- Event Handler: Processes user inputs (keybindings)
- Task Manager: Manages file operations and navigation
- File System Layer: Handles file scanning and storage

b) Cross-cutting Concerns:
- Logger: System-wide logging
- Configuration: Global settings management
- FPS Counter: Performance monitoring
- Spinner: Loading state indication

##### Technical Details

- Rust-specific implementations
- Integration with system file operations
- Cross-platform compatibility points
- Performance-critical paths

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph UI["User Interface Layer"]
        Chart["Chart Display"]
        Content["Content View"]
        Footer["Footer Controls"]
        Title["Title Bar"]
    end

    subgraph EH["Event Handler System"]
        InputProc["Input Processing"]
        CmdRoute["Command Routing"]
    end

    subgraph TM["Task Manager"]
        FileOps["File Operations"]
        DirNav["Directory Navigation"]
    end

    subgraph FS["File System Layer"]
        DirScan["Directory Scanner"]
        FileStore["File Store (HashMap)"]
        FolderMgmt["Folder Entry Management"]
    end

    subgraph Support["Supporting Components"]
        Logger["Logger System"]
        FPSCounter["FPS Counter"]
        Spinner["Spinner Animation"]
        Config["Configuration Manager"]
    end

    subgraph OS["Operating System"]
        FSys["File System"]
    end

    UI --> EH
    UI --> TM
    EH --> TM
    TM --> FS
    FS <--> FSys
    Support --> UI
    Support --> FS
    Support --> TM

    %% Component Mappings
    click Chart "https://github.com/ikebastuz/wiper/blob/master/src/ui/chart.rs"
    click Content "https://github.com/ikebastuz/wiper/blob/master/src/ui/content.rs"
    click Footer "https://github.com/ikebastuz/wiper/blob/master/src/ui/footer.rs"
    click Title "https://github.com/ikebastuz/wiper/blob/master/src/ui/title.rs"
    click UI "https://github.com/ikebastuz/wiper/blob/master/src/ui/mod.rs"
    click InputProc "https://github.com/ikebastuz/wiper/blob/master/src/events/handler.rs"
    click EH "https://github.com/ikebastuz/wiper/blob/master/src/events/mod.rs"
    click TM "https://github.com/ikebastuz/wiper/blob/master/src/task_manager/mod.rs"
    click FileOps "https://github.com/ikebastuz/wiper/blob/master/src/task_manager/legacy.rs"
    click DirScan "https://github.com/ikebastuz/wiper/blob/master/src/fs/folder.rs"
    click FileStore "https://github.com/ikebastuz/wiper/blob/master/src/fs/store/ds_hashmap.rs"
    click FolderMgmt "https://github.com/ikebastuz/wiper/blob/master/src/fs/folder_entry.rs"
    click FS "https://github.com/ikebastuz/wiper/blob/master/src/fs/mod.rs"
    click Logger "https://github.com/ikebastuz/wiper/blob/master/src/logger/mod.rs"
    click FPSCounter "https://github.com/ikebastuz/wiper/blob/master/src/fps_counter/mod.rs"
    click Spinner "https://github.com/ikebastuz/wiper/blob/master/src/spinner/mod.rs"
    click Config "https://github.com/ikebastuz/wiper/blob/master/src/config/mod.rs"

    classDef ui fill:#3498db,stroke:#2980b9,color:white
    classDef core fill:#2ecc71,stroke:#27ae60,color:white
    classDef fs fill:#e67e22,stroke:#d35400,color:white
    classDef support fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef os fill:#34495e,stroke:#2c3e50,color:white

    class Chart,Content,Footer,Title,UI ui
    class InputProc,CmdRoute,EH,TM,FileOps,DirNav core
    class DirScan,FileStore,FolderMgmt,FS fs
    class Logger,FPSCounter,Spinner,Config support
    class FSys,OS os
```
