Proyecto base para el compilador de 4to año en Ciencia de la Computación.

La evaluación de la asignatura Complementos de Compilación, inscrita en el programa del 4to año de la Licenciatura en Ciencia de la Computación de la Facultad de Matemática y Computación de la Universidad de La Habana, consiste este curso en la implementación de un compilador completamente funcional para el lenguaje COOL.

COOL (Classroom Object-Oriented Language) es un pequeño lenguaje que puede ser implementado con un esfuerzo razonable en un semestre del curso. Aun así, COOL mantiene muchas de las características de los lenguajes de programación modernos, incluyendo orientación a objetos, tipado estático y manejo automático de memoria.

El proyecto de Compilación será recogido y evaluado únicamente a través de Github. Es imprescindible tener una cuenta de Github para cada participante, y que su proyecto esté correctamente hosteado en esta plataforma. A continuación le damos las instrucciones mínimas necesarias para ello:

Opcionalmente pueden crear una organización y copiar el proyecto en el perfil de la misma.

Revise que el repositorio de su equipo está en su perfil. En este ejemplo se ha copiado a la cuenta de github.com/apiad.

Debe indicar bajo el nombre del repositorio: "forked from matcom/cool-compiler-2020".

Busque la URL de su proyecto en la interfaz web de Github.

Asegúrese de clonar su copia y no el proyecto original en matcom/cool-compiler-2020.

$ git clone [email protected]:<usuario>/cool-compiler-2020.git

Donde <usuario> es posiblemente el nombre de su equipo o del miembro donde se hizo el fork.

A partir de este punto debe tener un proyecto cool-compiler-2020 local. El siguiente paso depende de si usted ya tiene su código versionado con git o no.

$ cd cool-compiler-2020
$ git pull --allow-unrelated-histories <my-old-compiler-project> master

$ mv <my-old-code> src/
$ git add .
$ git commit -a -m "Mezclado con el proyecto base"

$ git push origin master

$ mv <my-old-code> src/
$ git commit -a -m "Hello Git!"

Si necesita saber más sobre git, todo lo imprescindible está en esta guía.

$ git push origin master

En este proyecto se realizarán entregas parciales a lo largo del curso. Para realizar una entrega, siga los siguientes pasos.

• base repository: matcom/cool-compiler-2020 (repositorio original)
  • branch: entrega-final
• head repository: <usuario>/cool-compiler-2020 (repositorio propio)
  • branch: master (o la que corresponda)

Asegúrese que se indica Able to merge. De lo contrario, existen cambios en el repositorio original que usted no tiene, y debe actualizarlos.

NOTA: Asegúrese que el pull request se hace a la rama entrega-final.

Verá la indicación Some checks haven't completed yet.

Es posible que tenga que actualizar los cambios que se hayan hecho en el repositorio original, por ejemplo, si se han agregado nuevos tests. En este caso obtendrá el siguiente mensaje:

This branch is out-of-date with base branch

Haga click en Update branch y siga las instrucciones.

Si ve el mensaje All checks have failed, significa que su código no pasó las pruebas.

Para ver los resultados de las pruebas haga click en el link Details junto al ícono de continuous-integration/travis-ci/pr, o visite este link y busque su pull request.

Haciendo click en el título de su pull request (ej. PR #1) podrá ver los detalles de ejecución de todas las pruebas, así como las excepciones lanzadas.

Para cualquier modificación que haga a su proyecto, haga commit y push para su repositorio personal y automáticamente se actualizará el estado del pull request y se volverán a ejecutar las pruebas. No es necesario abrir un pull request nuevo por cada entrega, sino actualizar el anterior.

Por favor asegúrese de mantener un solo pull request activo por equipo. En caso de abrir uno nuevo, cerrar el anterior.

Ponga todo su código e instrucciones necesarias en la carpeta src. Más información en src/Readme.md.

Usted debe presentar un reporte escrito documentando el proceso de construcción de su compilador y los detalles más importantes de su funcionamiento. Más información en doc/Readme.md.

Para desarrollar el compilador del lenguaje COOL se trabajará en equipos de 2 o 3 integrantes.

La carpeta tests contiene todos los casos de prueba que son obligatorios de pasar para que su proyecto tenga derecho a ser evaluado.

Estos tests se ejecutan automáticamente cada vez que hace un pull request al repositorio matcom/cool-compiler-2020. Solo aquellos proyectos que pasen todas las pruebas con éxito serán evaluados.

Para ejecutar las pruebas localmente, debe tener instalado Python 3.7, pip y make (normalmente viene con Linux). Ejecute:

$ pip install -r requirements.txt
$ cd src
$ make test

Si desea configurar su repositorio en Github para que ejecute automáticamente las pruebas en cada commit, siga las instrucciones en travis-ci.org para registrarse y activar su repositorio. El archivo .travis.yml que se encuentra en este repositorio ya contiene todas las instrucciones necesarias para que funcione la integracion con Travis-CI.