Manual de Referencia: corbel

Corbel — Generador de Documentación de APIs, TDAs y Verificación de Snippets C¶

1. Propósito y Filosofía Pedagógica¶

La herramienta corbel forma parte del ecosistema oficial de software de la cátedra. Su diseño sigue principios pedagógicos rigurosos:

1. Evidencia Técnica Directa: Todo diagnóstico se fundamenta en la norma ISO C (C11/C23), en el modelo de memoria del sistema o en convenciones arquitectónicas formales.

2. Acción Correctiva Concreta: Cada advertencia incluye la prescripción técnica inmediata para resolver el defecto sin recurrir a conjeturas.

3. Autonomía del Estudiante: Facilita la autoevaluación local antes de la entrega final del trabajo práctico.

4. Objetividad Docente: Estandariza la corrección automática removiendo discrepancias subjetivas en la evaluación.

2. Instalación y Verificación del Entorno¶

2.1 Requisitos Previos del Sistema¶

Instalá los paquetes del sistema requeridos según tu distribución o entorno:

2.2 Métodos de Instalación de corbel¶

Podés instalar corbel mediante cualquiera de los siguientes métodos estándar:

2.3 Autocompletado en la Shell¶

La interfaz CLI de corbel cuenta con autocompletado nativo para comandos, flags y archivos. Para configurarlo permanentemente en tu shell:

# Configuración automática en Bash / Zsh / Fish
corbel --install-completion

# Para cargar el autocompletado en la sesión actual de inmediato:
source ./install_tools.sh

2.4 Verificación del Entorno con doctor¶

Toda herramienta del ecosistema cuenta con el subcomando unificado doctor. Ejecutalo para auditar el estado del entorno:

corbel doctor

Comprobaciones Ejecutadas por el Diagnóstico:¶

• Compilador C: Verifica disponibilidad de gcc o clang con soporte de estándares C11 y C23.

• Depurador y Core Dumps: Comprueba que gdb esté instalado y que ulimit -c permita generación de core dumps.

• Herramientas de Memoria: Valida la presencia de valgrind y librerías libasan/libubsan.

• Formateo y Estilo: Verifica el binario clang-format (versión 16+).

• Sandboxing de Kernel: Audita permisos no privilegiados de bwrap (Bubblewrap namespaces).

• Generador de Tipografía y Documentos: Comprueba typst ($\ge 0.11$) y dot (Graphviz).

Matriz de Resolución de Problemas:¶

3. Referencia Completa de Comandos CLI¶

A continuación se detallan los subcomandos principales disponibles en corbel:

4. Tutorial Paso a Paso con Ejemplos Reales¶

Caso de Estudio¶

Considerá el siguiente fragmento de código representativo:

1
2
3
4
5
6
7
8
9
10
11
12
/**
 * @brief Inserta un elemento al inicio de la lista enlazada.
 * @param lista Puntero a la estructura TDA Lista.
 * @param dato Puntero genérico al dato a almacenar.
 * @return true si se insertó con éxito, false ante fallo de memoria.
 * @code
 * t_lista *l = lista_crear();
 * int x = 42;
 * assert(lista_insertar_inicio(l, &x) == true);
 * @endcode
 */
bool lista_insertar_inicio(t_lista *lista, void *dato);

Ejecución de la Herramienta¶

Ejecutá el análisis desde tu terminal:

corbel build include/ -o docs/

Salida Obtenida en Consola¶

[✓] 14 funciones parseadas en include/lista.h (Cobertura: 100%)
[✓] 6 snippets de código extraídos de la documentación.
[✓] Compilación de snippets: 6/6 PASS (GCC -std=c11 -Werror)
[✓] Documentación generada exitosamente en docs/index.html

5. Ejercicios Prácticos y Desafíos¶

Practicá el uso avanzado de corbel resolviendo los siguientes ejercicios:

6. Integración en el Flujo de Trabajo y Makefile¶

Para incorporar corbel de forma automática a tu flujo de desarrollo, agregá la siguiente regla en el Makefile de tu proyecto:

check-corbel:
	@echo "=== Ejecutando verificación con corbel ==="
	corbel check src/ include/

.PHONY: check-corbel

Ejecutá make check-corbel antes de cada commit para mantener que tu código conserve el estado de aprobación.

7. Arquitectura Interna y Mecanismo Técnico¶

La herramienta corbel implementa un motor de alta precisión basado en:

• Tecnología Núcleo: Tree-Sitter C / Doxygen Parser + GCC Test Runner + MyST Markdown Exporter.

• Aislamiento y Determinismo: Diseñada para operar sin efectos colaterales en entornos de integración continua (CI), terminales de estudiantes y servidores docentes headless.

• Manejo de Errores Pedagógico: Todo fallo de sintaxis, memoria o lógica se traduce en una acción prescriptiva concreta con su respectiva justificación técnica.

8. Integración y Conexión con el Ecosistema¶

Diagrama de Flujo e Interoperabilidad¶

Matriz de Intercambio de Datos¶

• deckard (documentación de consignas) | Informes Markdown, diagnósticos Rich, JSON, actas | | Sincronización | motoko, parker, myst-tools | Validación cruzada, flags compartidos y autofix |

Pipeline de Integración Recomendado¶

Podés encadenar corbel con otras herramientas del ecosistema en una única línea de comando:

# Pipeline de integración típico
corbel build include/ -o docs/ && corbel test-snippets docs/ && myst-tools fmt docs/

9. Extensión, Desarrollo de Plugins y API Python¶

Para crear tus propias reglas, conectores de evaluación o integrar corbel programáticamente en pipelines de CI/CD:

• 👉 Consultá la guía completa: Guía de Extensión y Creación de Plugins