# santizabe/mini-s-hell architecture

> Architecture diagram of the GitHub repository santizabe/mini-s-hell, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/santizabe/mini-s-hell
- Repository: https://github.com/santizabe/mini-s-hell

## Overview

##### Project type and purpose
- This is a C-based UNIX shell (“Minishell”) implementing core shell features: command parsing, pipelines, redirections, built-in commands, environment variable handling, and signal handling.
- The code is organized into:
- gnl/ folder: get_next_line implementation (input reader)
- libft/ folder: utility functions (string, memory, list helpers)
- src/ folder: main shell logic (parsing, expansion, execution, builtins, signals, etc.)

##### File structure
- Top‐level:
- Makefile, README.md, .gitignore
- gnl/: custom line‐reader module
- libft/: generic utility library
- /: shared headers (minishell.h)
- src/: core engine split into parsing, expansion, execution, builtins, signal handling
- Key patterns:
- Modular layering: input reader → parser/expander → execution engine
- Separation of concerns: builtins vs external commands, utilities vs core logic
- Configuration:
- Makefile drives compilation and links against readline library
- README documents dependencies (GCC, Make, libreadline)

##### Extract architectural insights from README
- Shell phases: read command → parse (tokenize, syntax tree) → expand variables/quotes → build pipeline with redirections → fork + exec or call builtin → wait and report exit status
- Uses readline (via get_next_line or directly) for history and line editing
- Handles signals (SIGINT, SIGQUIT) at multiple layers

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Input Layer
    subgraph "Input Layer"
        IL1["readline()"]:::io
        IL2["get_next_line()"]:::io
        IL3["main.c"]:::core
    end

    %% Parser & Expander
    subgraph "Parser & Expander"
        P1["Tokenization\n(src/parsing.c)"]:::core
        P2["Parse Utils\n(src/parse_utils.c)"]:::core
        E1["Expand Manager\n(src/expand_manager.c)"]:::core
        E2["ft_expand\n(src/ft_expand.c)"]:::core
        E3["Quote Removal\n(src/quote_removal.c)"]:::core
    end

    %% Execution Engine
    subgraph "Execution Engine"
        EX0["Core Execution\n(src/execution.c)"]:::core
        EX1["Simple Exec\n(src/exec_simple.c)"]:::core
        EX2["Advanced Exec\n(src/exec_2.c)"]:::core
        EX3["Exec Utils\n(src/exec_utils.c)"]:::core
        RED["Redirection Handler\n(src/redir_handler.c)"]:::core
        CS["Command Search\n(src/cmd_search.c)"]:::core
        PATH["Path Resolver\n(src/path.c)"]:::core
    end

    %% Built-in Manager
    subgraph "Built-in Manager"
        B1["builtins.c"]:::builtin
        B2["builtins2.c"]:::builtin
        B3["cd_builtins.c"]:::builtin
        B4["aux_builtins.c"]:::builtin
        B5["builtin_utils.c"]:::builtin
    end

    %% Environment Manager
    subgraph "Environment Manager"
        ENV_LIST[(ENV List)]:::env
        M1["misc.c"]:::env
        M2["utils.c"]:::env
    end

    %% System/OS Calls
    SC["System Calls\n(open, pipe, fork, execve, wait)"]:::sys

    %% Signal Handler
    SIG["Signal Handler\n(src/signals.c)"]:::signal

    %% Utility Library
    LIB["Libft"]:::util

    %% Data & Control Flow
    IL1 -->|"command line"| P1
    IL2 -->|"fallback input"| P1
    IL3 -->|"initializes shell"| IL1
    P1 -->|"tokens"| P2
    P2 -->|"parsed tree"| E1
    E1 -->|"expanded tokens"| EX0
    E2 -->|"variable expansion"| EX0
    E3 -->|"quote removal"| EX0
    EX0 -->|"fork+exec"| EX1
    EX0 -->|"fork+exec"| EX2
    EX1 -->|"helpers"| EX3
    EX2 -->|"helpers"| EX3
    EX0 -->|"setup redir"| RED
    EX0 -->|"search cmd"| CS
    CS -->|"resolve path"| PATH
    EX0 -->|"builtin?"| B1
    B1 --> B2
    B2 --> B3
    B3 --> B4
    B4 --> B5
    EX0 -->|"external cmd"| SC
    EX0 <-->|"env lookup"| ENV_LIST
    ENV_LIST --> M1
    ENV_LIST --> M2
    SIG --> IL1
    SIG --> EX0

    %% Utility usage
    IL1 --> LIB
    P1 --> LIB
    P2 --> LIB
    E1 --> LIB
    E2 --> LIB
    E3 --> LIB
    EX0 --> LIB
    RED --> LIB
    CS --> LIB
    PATH --> LIB
    B1 --> LIB
    M1 --> LIB
    SIG --> LIB

    %% Click Events
    click IL2 "https://github.com/santizabe/mini-s-hell/tree/master/gnl/"
    click IL3 "https://github.com/santizabe/mini-s-hell/blob/master/src/main.c"
    click P1 "https://github.com/santizabe/mini-s-hell/blob/master/src/parsing.c"
    click P2 "https://github.com/santizabe/mini-s-hell/blob/master/src/parse_utils.c"
    click E1 "https://github.com/santizabe/mini-s-hell/blob/master/src/expand_manager.c"
    click E2 "https://github.com/santizabe/mini-s-hell/blob/master/src/ft_expand.c"
    click E3 "https://github.com/santizabe/mini-s-hell/blob/master/src/quote_removal.c"
    click EX0 "https://github.com/santizabe/mini-s-hell/blob/master/src/execution.c"
    click EX1 "https://github.com/santizabe/mini-s-hell/blob/master/src/exec_simple.c"
    click EX2 "https://github.com/santizabe/mini-s-hell/blob/master/src/exec_2.c"
    click EX3 "https://github.com/santizabe/mini-s-hell/blob/master/src/exec_utils.c"
    click RED "https://github.com/santizabe/mini-s-hell/blob/master/src/redir_handler.c"
    click CS "https://github.com/santizabe/mini-s-hell/blob/master/src/cmd_search.c"
    click PATH "https://github.com/santizabe/mini-s-hell/blob/master/src/path.c"
    click B1 "https://github.com/santizabe/mini-s-hell/blob/master/src/builtins.c"
    click B2 "https://github.com/santizabe/mini-s-hell/blob/master/src/builtins2.c"
    click B3 "https://github.com/santizabe/mini-s-hell/blob/master/src/cd_builtins.c"
    click B4 "https://github.com/santizabe/mini-s-hell/blob/master/src/aux_builtins.c"
    click B5 "https://github.com/santizabe/mini-s-hell/blob/master/src/builtin_utils.c"
    click M1 "https://github.com/santizabe/mini-s-hell/blob/master/src/misc.c"
    click M2 "https://github.com/santizabe/mini-s-hell/blob/master/src/utils.c"
    click LIB "https://github.com/santizabe/mini-s-hell/tree/master/libft/"

    %% Styles
    classDef io fill:#cce5ff,stroke:#004085,color:#004085;
    classDef core fill:#d4edda,stroke:#155724,color:#155724;
    classDef builtin fill:#fff3cd,stroke:#856404,color:#856404;
    classDef env fill:#ffe5b4,stroke:#cc7a00,color:#cc7a00;
    classDef sys fill:#b8daff,stroke:#004085,color:#004085;
    classDef signal fill:#f5c6cb,stroke:#721c24,color:#721c24;
    classDef util fill:#e2e3e5,stroke:#6c757d,color:#6c757d;
```
