un-compilers/lang

lang

Aquí vamos a registrar nuestro proyecto de crear un lenguaje de programación. Esto incluye el diseño de lenguaje y la implementación de un compilador.

Uso

Tenemos un Makefile con varios comandos:

• make build-docker construye la imagen Docker para el sistema,
• make run-docker ejecuta la imagen,
• make run-tests ejecuta las pruebas unitarias.

Los siguientes comandos se deberían ejecutar en la terminal del contenedor, tras haber hecho make run-docker:

• make install-dependencies instala las dependencias de Go,
• make run-tests-ci ejecuta las pruebas que se van a hacer en la CI de GitHub,
• make generate-parsing-files genera el código de ANTLR para el sistema. Se debería ejecutar si la gramática del lenguaje fue modificada o los archivos no existen. El código generado por ANTLR no es rastreado en este repositorio.

lang's Issues

Paso de CST a AST

Necesitamos, a partir del CST que nos da ANTLR4, obtener un AST que podamos caminar.

Diseño del lenguaje

Tenemos que establecer una forma de describir el lenguaje. No necesariamente debe ser una gramática, pero debe estar en algún lado. Luego usaremos ese medio para construirlo.

Assert

Necesitamos una forma de detener la ejecución del programa si una condición no se cumple. Esto sería una función así:

assert(cond, msg)

donde cond es un booleano y msg es un mensaje que se quiera desplegar cuando el booleano sea falso y la ejecución se detenga.

Sintaxis para ciclos infinitos

Decidir la sintaxis para ciclos infinitos en reemplazo de las intrucciones tipo while. Un ejemplo propuesto es:

loop:
    int a := 5
    if a = 5:
        break

Implementación de lexer y parser en ANTLR4

Implementar lexer y parser por medio de ANTLR4 con target a Go

Creación del ambiente Docker

Crear el ambiente virtual en un contenedor de Docker que incluya:

• Instalaciones de Java
• Instalaciones de ANTLR4
• Instalaciones de Go

Operadores

Hay que añadir operadores para el lenguaje. Esta es una lista inicial:

• Prefijos/Posfijos
  • - Inverso aditivo
  • ~ Negación bitwise
  • ! Negación lógica
• Infijos
  • + Suma/Concatenación
  • - Resta
  • * Multiplicación
  • / División
  • % Residuo
  • ** Potenciación
  • ^ Bitwise XOR
  • | Bitwise OR
  • & Bitwise AND
  • >> Desplazamiento a la dereche
  • << Desplazamiento a la izquierda
  • <= Menor o igual
  • >= Mayor o igual
  • == Igual
  • != No igual
  • || OR lógico
  • && AND lógico

Implementación

Hay que decidir que vamos a usar para implementar el lenguaje. En principio, queremos decidir entre Rust y Go.

Utilidades para pruebas unitarias

Se necesita que la biblioteca estándar tenga utilidades para hacer pruebas unitarias. No pensamos en este lenguaje como uno dinámico, así que no estoy seguro de que la fórmula describe/it funcione bien.

Objetivo de compilación

En principio queremos que el lenguaje sea compilado. No hemos establecido cual será nuestro primer objetivo de compilación. La idea de compilar a WASM ha resonado y creo que nos agrada a muchos.

Estilo de comentarios

Decidir el estilo de los comentarios de una linea, multilinea y strings de documentación. Algunos ejemplos

Estilos de comentario una linea

• Python #
• Java //
• Lean --
• Ocaml (* *)

Estilos de comentarion multilinea

• Python """ """
• Java /* */

Strings de documentación

• Python docstring
• Java Javadoc
• Rust Doctests

Utilidades I/O

Necesitamos utilidades para obtener texto de stdin y enviar a stdout. podríamos empezar con funciones simples como println y getln. Luego añadiríamos soporte más granular para manipular los buffers.

Mutabilidad de valores

La idea es incluir la mutabilidad de valores para todos los tipos con una sintaxis como:
let int a := 5
mut int a := 5

Diseño de la estructura if

Decidir sobre la implementación de else obligatorio

Criterios de aceptación

¿Qué debe poder hacer nuestro MVP?

Análisis estático

Se debe poder verificar la congruencia de las operaciones del lenguaje. En particular, se debería verificar:

• Existencia de valores que son invocados
• Congruencia entre parámetros y argumentos de funciones
• Existencia de código muerto:
  • Valores sin usar
  • Sentencias a las que nunca se llega

Implementación pattern matching

Investigar la viabilidad de la implementación de pattern matching dentro del lenguaje

Investigación ANTLR4

Preparar un reporte sobre la funcionalidad de ANTLR4 para las tareas de crear el lexer y parser

Implementación del interprete

Escribir el interprete para el lenguaje basado en el output de ANTLR4 para el lexer y parser