Manual de Referencia: bishop

Bishop — Visualizador Pedagógico de Memoria Stack & Heap en ASCII y Mermaid¶

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

La herramienta bishop 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 bishop¶

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

2.3 Autocompletado en la Shell¶

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

# Configuración automática en Bash / Zsh / Fish
bishop --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:

bishop 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 bishop:

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
13
14
15
#include <stdlib.h>

void f(int a) {
    int *dinamico = malloc(sizeof(int) * 2);
    dinamico[0] = a;
    dinamico[1] = a * 2;
    // Inspección en este punto
    free(dinamico);
}

int main(void) {
    int x = 42;
    f(x);
    return 0;
}

Ejecución de la Herramienta¶

Ejecutá el análisis desde tu terminal:

bishop trace -- ./bin/programa

Salida Obtenida en Consola¶

┌────────────────────────────────────────────────────────┐
│ STACK FRAME: f (ret 0x00401180)                        │
│ ├─ a: [ 42 ] @ 0x7fffffffe340                          │
│ └─ dinamico: [ 0x0055555556b2a0 ] @ 0x7fffffffe348    │
└───────────────────────┬────────────────────────────────┘
                        │
                        ▼ (Heap Allocation: 8 bytes)
┌────────────────────────────────────────────────────────┐
│ HEAP CHUNK @ 0x0055555556b2a0                          │
│ [ 0 ]: 42  |  [ 1 ]: 84                                │
└────────────────────────────────────────────────────────┘

5. Ejercicios Prácticos y Desafíos¶

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

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

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

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

.PHONY: check-bishop

Ejecutá make check-bishop 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 bishop implementa un motor de alta precisión basado en:

• Tecnología Núcleo: GDB/MI Machine Interface + DWARF Symbol Parser + Rich Terminal Tables + Mermaid JS Engine.

• 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 (diagramas para enunciados)

• myst-tools (apuntes) | Informes Markdown, diagnósticos Rich, JSON, actas | | Sincronización | sebastian, brett, hal | Validación cruzada, flags compartidos y autofix |

Pipeline de Integración Recomendado¶

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

# Pipeline de integración típico
daedalus compile src/main.c -g3 -o bin/app && bishop trace --format mermaid -o memoria.md -- ./bin/app

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

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

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