Manual de Referencia: motoko

Motoko — Verificador de Encapsulamiento Estricto, Opacidad de Structs e Invariantes de TDA¶

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

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

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

2.3 Autocompletado en la Shell¶

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

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

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

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
// include/lista.h (Encapsulado estricto con Motoko)
typedef struct lista t_lista; // Tipo opaco: cliente NO ve los campos

t_lista* lista_crear(void);
void lista_destruir(t_lista *lista);

// src/lista.c (Implementación privada)
struct lista {
    struct nodo *primero;
    size_t cantidad;
};

Ejecución de la Herramienta¶

Ejecutá el análisis desde tu terminal:

motoko check include/ src/

Salida Obtenida en Consola¶

[!] MOTOKO ENCAPSULATION VIOLATION en src/main.c:15:10:
    Acceso prohibido al miembro privado 'lista->cantidad'.
    Los campos internos de 'struct lista' son opacos para el código cliente.
    Sugerencia: Utilizá la función pública 'size_t lista_cantidad(const t_lista *l);'.

5. Ejercicios Prácticos y Desafíos¶

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

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

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

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

.PHONY: check-motoko

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

• Tecnología Núcleo: Tree-Sitter C AST + Incomplete Types Visibility Checker + Invariant Contract Validator.

• 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¶

• corbel (verificación de opacidad) | Informes Markdown, diagnósticos Rich, JSON, actas | | Sincronización | corbel, parker, ripley | Validación cruzada, flags compartidos y autofix |

Pipeline de Integración Recomendado¶

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

# Pipeline de integración típico
motoko check include/ src/ && ripley check src/

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

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

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