# greyvoidbloom/rle-compression architecture

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

- Interactive diagram: https://gitdiagram.com/greyvoidbloom/rle-compression
- Repository: https://github.com/greyvoidbloom/rle-compression

## Overview

##### Main Components

a. Input Layer:
- CLI Interface (represented by cli_handling.c/h)
- Command argument parsing
- Option handling (-c, -d, --h, --version)

b. Processing Layer:
- Compression Module (rle_compress.c/h)
- Decompression Module (rle_decompress.c/h)

c. Main Controller:
- Program flow coordination (main.c)

**┌─────────────────┐**
- User Input    │
- ┬────────┘
- ↓
**┌─────────────────┐**
- CLI Handler    │
- ┬────────┘
- ↓
**┌─────────────────┐**
- Main        │
- Controller    │
- ┬────────┘
- ↓
- ┌────┴────┐
- ↓         ↓
**┌─────────┐ ┌─────────┐**
- Compress │ │Decompress│
- Module  │ │ Module  │
- ┘ └─────────┘

##### Component Details

a. CLI Handler:
- Option parsing (-c, -d, --h, --version)
- Input validation
- Help message display

b. Main Controller:
- Program flow control
- Module selection based on options
- Error handling

c. Compression Module:
- RLE compression algorithm
- Input string processing
- Output format: character + count

d. Decompression Module:
- RLE decompression algorithm
- Input format parsing
- Output string generation

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef input fill:#a8d1f0,stroke:#000
    classDef processing fill:#90EE90,stroke:#000
    classDef control fill:#FFB347,stroke:#000
    classDef module fill:#98FB98,stroke:#000

    %% Input Layer
    UserInput[User Input]:::input
    CLI["CLI Handler"]:::input
    click CLI "https://github.com/greyvoidbloom/rle-compression/blob/main/src/cli_handling.c"

    %% Main Controller
    MainController["Main Controller"]:::control
    click MainController "https://github.com/greyvoidbloom/rle-compression/blob/main/src/main.c"

    %% Processing Modules
    subgraph ProcessingLayer["Processing Layer"]
        CompressModule["Compression Module"]:::module
        DecompressModule["Decompression Module"]:::module
    end
    click CompressModule "https://github.com/greyvoidbloom/rle-compression/blob/main/src/rle_compress.c"
    click DecompressModule "https://github.com/greyvoidbloom/rle-compression/blob/main/src/rle_decompress.c"

    %% Flow
    UserInput --> CLI
    CLI --> MainController
    MainController --> CompressModule
    MainController --> DecompressModule

    %% Data Flow Labels
    UserInput -- "Input String & Flags" --> CLI
    CLI -- "Validated Input & Options" --> MainController
    MainController -- "-c option" --> CompressModule
    MainController -- "-d option" --> DecompressModule

    %% Legend
    subgraph Legend
        L1[User Interface]:::input
        L2[Control Flow]:::control
        L3[Processing Module]:::module
    end
```
