# dark-codex/openutils architecture

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

- Interactive diagram: https://gitdiagram.com/dark-codex/openutils
- Repository: https://github.com/dark-codex/openutils

## Overview

##### Main Components

Core Utility Modules:
- Array Module
- ChunkIO Module
- DateTime Module
- HeapPair Module
- Module
- Optional Module
- Vector Module
- SString Module (This is the most complex module)

##### Specific Component Details

SString Module (Detailed Subcomponent):
- SString components into logical categories:
- Core functionality (class, ctor, memory)
- Operations (operators, manipulation, find)
- Utilities (formatting, crypto, conversion)
- I/O operations (io)
- String processing (lexer_split, metrics)

##### Relationships and Dependencies

**┌─────────────┐**
- Module     │  -> For main components
- ┘

**┌ ─ ─ ─ ─ ─ ─ ┐**
- Submodule    │ -> For subcomponents
- ┘

**━━━━> For direct dependencies**
- > For optional dependencies

##### Additional Elements

Include:
- A title block: "OpenUtils C++ Library Architecture"
- Version information
- License indicator (GPL v3)
- Notes about header-only nature of the library

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Legend
        L1[Module]:::module
        L2[Core Component]:::core
        L3[Utility Component]:::utility
        L4[I/O Component]:::io
        L5[Data Structure]:::data
    end

    subgraph "Core Modules"
        Array["Array Module"]:::core
        Vector["Vector Module"]:::core
        Map["Map Module"]:::core
    end

    subgraph "Data Structure Modules"
        HeapPair["HeapPair Module"]:::data
        Optional["Optional Module"]:::data
    end

    subgraph "I/O and Time Modules"
        ChunkIO["ChunkIO Module"]:::io
        DateTime["DateTime Module"]:::utility
        
        subgraph "ChunkIO Components"
            BytesReader["Bytes Reader"]:::io
            LinesReader["Lines Reader"]:::io
            Writer["Writer"]:::io
        end

        subgraph "DateTime Components"
            Date["Date Component"]:::utility
            Time["Time Component"]:::utility
        end
    end

    subgraph "SString Module"
        Core["Core Functionality"]:::core
        Operations["Operations"]:::core
        Utils["Utilities"]:::utility
        IOOps["I/O Operations"]:::io
        StrProc["String Processing"]:::utility

        subgraph "Core Components"
            ClassDef["Class Definition"]:::core
            Ctor["Constructor"]:::core
            Memory["Memory Management"]:::core
        end

        subgraph "Operation Components"
            Operators["Operators"]:::core
            Manipulation["Manipulation"]:::core
            Find["Find Operations"]:::core
            Remove["Remove Operations"]:::core
            Replace["Replace Operations"]:::core
        end

        subgraph "Utility Components"
            Formatting["Formatting"]:::utility
            Crypto["Crypto"]:::utility
            Conversion["Conversion"]:::utility
            Boolean["Boolean Operations"]:::utility
        end

        subgraph "String Processing Components"
            LexerSplit["Lexer/Split"]:::utility
            Metrics["Metrics"]:::utility
        end
    end

    %% Relationships
    ChunkIO --> BytesReader & LinesReader & Writer
    DateTime --> Date & Time
    Core --> ClassDef & Ctor & Memory
    Operations --> Operators & Manipulation & Find & Remove & Replace
    Utils --> Formatting & Crypto & Conversion & Boolean
    StrProc --> LexerSplit & Metrics

    %% Styling
    classDef module fill:#f9f,stroke:#333,stroke-width:2px
    classDef core fill:#dfd,stroke:#333,stroke-width:2px
    classDef utility fill:#ddf,stroke:#333,stroke-width:2px
    classDef io fill:#fdd,stroke:#333,stroke-width:2px
    classDef data fill:#ffd,stroke:#333,stroke-width:2px

    %% Click events
    click Array "https://github.com/Dark-CodeX/openutils/blob/main/array/array.hh"
    click BytesReader "https://github.com/Dark-CodeX/openutils/blob/main/chunkio/chunkio_bytes_reader.hh"
    click LinesReader "https://github.com/Dark-CodeX/openutils/blob/main/chunkio/chunkio_lines_reader.hh"
    click Writer "https://github.com/Dark-CodeX/openutils/blob/main/chunkio/chunkio_writer.hh"
    click Date "https://github.com/Dark-CodeX/openutils/blob/main/date-time/date.hh"
    click Time "https://github.com/Dark-CodeX/openutils/blob/main/date-time/time.hh"
    click HeapPair "https://github.com/Dark-CodeX/openutils/blob/main/heap-pair/heap-pair.hh"
    click Map "https://github.com/Dark-CodeX/openutils/blob/main/map/map.hh"
    click Optional "https://github.com/Dark-CodeX/openutils/blob/main/optional/optional.hh"
    click Vector "https://github.com/Dark-CodeX/openutils/blob/main/vector/vector.hh"
    click ClassDef "https://github.com/Dark-CodeX/openutils/blob/main/sstring/sstring_class.hh"
    click Ctor "https://github.com/Dark-CodeX/openutils/blob/main/sstring/sstring_ctor.hh"
    click Memory "https://github.com/Dark-CodeX/openutils/blob/main/sstring/sstring_memory.hh"
    click Operators "https://github.com/Dark-CodeX/openutils/blob/main/sstring/sstring_operators.hh"
    click Manipulation "https://github.com/Dark-CodeX/openutils/blob/main/sstring/sstring_manipulation.hh"
    click Find "https://github.com/Dark-CodeX/openutils/blob/main/sstring/sstring_find.hh"
    click Remove "https://github.com/Dark-CodeX/openutils/blob/main/sstring/sstring_remove.hh"
    click Replace "https://github.com/Dark-CodeX/openutils/blob/main/sstring/sstring_replace.hh"
    click Formatting "https://github.com/Dark-CodeX/openutils/blob/main/sstring/sstring_formatting.hh"
    click Crypto "https://github.com/Dark-CodeX/openutils/blob/main/sstring/sstring_crypto.hh"
    click Conversion "https://github.com/Dark-CodeX/openutils/blob/main/sstring/sstring_conversion.hh"
    click Boolean "https://github.com/Dark-CodeX/openutils/blob/main/sstring/sstring_boolean.hh"
    click IOOps "https://github.com/Dark-CodeX/openutils/blob/main/sstring/sstring_io.hh"
    click LexerSplit "https://github.com/Dark-CodeX/openutils/blob/main/sstring/sstring_lexer_split.hh"
    click Metrics "https://github.com/Dark-CodeX/openutils/blob/main/sstring/sstring_metrics.hh"
```
