# laufari/pushwap architecture

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

- Interactive diagram: https://gitdiagram.com/laufari/pushwap
- Repository: https://github.com/laufari/pushwap

## Overview

Para dibujar un diagrama de la arquitectura de Push_swap y capturar todos sus componentes clave, sigue estos pasos:

##### Identifica el tipo de proyecto y su propósito
- Push_swap es una herramienta de línea de comandos en C que ordena una lista de enteros usando dos pilas (stack A y stack B) y un conjunto limitado de instrucciones.
- Se enfoca en generar la secuencia de operaciones más corta para lograr el orden ascendente.

##### Componentes principales del sistema
a. Entrada (CLI)
- Módulo: push_swap.c
- Función: parseo de argumentos, detección de errores.
b. Validación de entradas
- Módulos: validations.c, validations_1.c
- Función: comprueba duplicados, rango de enteros, formato de los argumentos.
c. Estructuras de datos
- Módulo: push_swap.h (definición de structs para stacks y nodos)
- Uso general por todos los subsistemas.
d. Núcleo del algoritmo de ordenamiento
- Módulos:
- r_sort.c, sort_2_y_3.c, sort_4.c, sort_5.c, sort_stack.c, smallest_on_top.c
- push_swap.c (orquesta la selección de la rutina adecuada según el tamaño del stack)
- Función: decide y aplica la estrategia óptima de ordenamiento.
e. Operaciones sobre pilas
- Módulos: movements_sa.c, movements_sb.c, push_swap.c (instrucciones de push, swap, rotate, reverse-rotate)
- Función: implementan cada instrucción permitida.
f. Utilidades auxiliares
- Módulos: utils.c, utils_1.c
- Función: funciones de ayuda para manipular nodos, contar elementos, etc.
g. Generación y presentación de la secuencia de instrucciones
- Módulo: print_stack.c
- Función: imprime por stdout las instrucciones generadas, una por línea.
h. Makefile
- Función: define el flujo de compilación, limpieza y ejecución.

##### Relaciones e interacciones
- El flujo de datos parte de la CLI → validación → construcción de las pilas internas → motor de ordenamiento
- El motor de ordenamiento invoca las operaciones (movements_*), las cuales usan utilidades (utils_*).
- Cada operación modifica el estado de las pilas y registra la instrucción en un buffer.
- Al finalizar, print_stack.c saca la secuencia resultante.
- En caso de error en validación, se emite “Error” a stderr y el programa aborta.

##### Patrones y principios arquitecturales
- Módulo de validación separado del núcleo del algoritmo
- Separación clara de responsabilidades: parsing, validación, lógica de negocio, impresión
- Sin variables globales: comunicación entre módulos mediante paso de punteros y estructuras
- Cada archivo .c agrupa funciones coherentes (SRP: Single Responsibility Principle)

##### Guías para el diagrama
- Usa rectángulos para cada módulo o componente lógico (p.ej., “CLI Parser”, “Validator”, “Sort Engine”, “Stack Ops”, “Utils”, “Printer”).
- Dibuja flechas direccionales para mostrar el flujo de datos:
- CLI Parser → Validator
- Validator → Sort Engine
- Sort Engine ↔ Stack Ops
- Stack Ops → Utils
- Sort Engine → Printer
- Emplea colores o formas distintas para diferenciar:
- Entrada/Salida (por ejemplo, azul)
- Lógica de negocio/core (verde)
- Utilitarios y soporte (gris)
- Etiqueta cada enlace con el tipo de datos o llamada (p.ej., “args[]”, “t_stack *”, “instrucción”).
- Agrega un elemento aparte para el Makefile, indicando su rol en compilar y limpiar (puede ser un hexágono o nube “DevOps”).

##### Elementos mínimos en el diagrama final
- Componentes con nombre y forma coherente
- Flechas de datos y control con dirección clara
- Leyenda de colores/formas
- Notas breves en cada componente (por ejemplo, “Valida formato y duplicados”)

Con este esquema, obtendrás un diagrama que refleja fielmente la arquitectura de Push_swap: desde la ingestión de los números hasta la emisión de las instrucciones de ordenamiento más óptimas, pasando por cada capa modular.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Components
    CLI["CLI Parser"]:::io
    subgraph "Validator"
        VAL1["validations.c"]:::core
        VAL2["validations_1.c"]:::core
    end
    DS["Data Structures\n(push_swap.h)"]:::support
    subgraph "Sort Engine"
        RS["r_sort.c"]:::core
        S23["sort_2_y_3.c"]:::core
        S4["sort_4.c"]:::core
        S5["sort_5.c"]:::core
        SS["smallest_on_top.c"]:::core
        SS2["sort_stack.c"]:::core
    end
    subgraph "Stack Operations"
        SA["movements_sa.c"]:::core
        SB["movements_sb.c"]:::core
    end
    subgraph "Utilities"
        U1["utils.c"]:::support
        U2["utils_1.c"]:::support
    end
    PR["Instruction Printer\n(print_stack.c)"]:::io
    MF["Makefile"]:::devops

    %% Connections
    CLI -->|"args[]"| VAL1
    CLI --> VAL2
    VAL2 -->|"t_stack *"| DS
    DS --> VAL1
    VAL1 -->|"validated data"| RS
    RS --> S23
    RS --> S4
    RS --> S5
    RS --> SS
    RS --> SS2
    RS <-->|"modify stacks"| SA
    RS <--> SB
    SA -->|"helpers"| U1
    SB --> U2
    RS -->|"instructions"| PR

    %% Click Events
    click CLI "https://github.com/laufari/pushwap/blob/master/push_swap.c"
    click VAL1 "https://github.com/laufari/pushwap/blob/master/validations.c"
    click VAL2 "https://github.com/laufari/pushwap/blob/master/validations_1.c"
    click DS "https://github.com/laufari/pushwap/blob/master/push_swap.h"
    click RS "https://github.com/laufari/pushwap/blob/master/r_sort.c"
    click S23 "https://github.com/laufari/pushwap/blob/master/sort_2_y_3.c"
    click S4 "https://github.com/laufari/pushwap/blob/master/sort_4.c"
    click S5 "https://github.com/laufari/pushwap/blob/master/sort_5.c"
    click SS "https://github.com/laufari/pushwap/blob/master/smallest_on_top.c"
    click SS2 "https://github.com/laufari/pushwap/blob/master/sort_stack.c"
    click SA "https://github.com/laufari/pushwap/blob/master/movements_sa.c"
    click SB "https://github.com/laufari/pushwap/blob/master/movements_sb.c"
    click U1 "https://github.com/laufari/pushwap/blob/master/utils.c"
    click U2 "https://github.com/laufari/pushwap/blob/master/utils_1.c"
    click PR "https://github.com/laufari/pushwap/blob/master/print_stack.c"
    click MF "https://github.com/laufari/pushwap/tree/master/Makefile"

    %% Styles
    classDef io fill:#a6cee3,stroke:#1f78b4,color:#000;
    classDef core fill:#b2df8a,stroke:#33a02c,color:#000;
    classDef support fill:#cccccc,stroke:#666666,color:#000;
    classDef devops fill:#fdbf6f,stroke:#ff7f00,color:#000;
```
