Instrucciones antiguas de instalación
Existen varias alternativas para utilizar ANTLR4. En este tutorial nos enfocaremos en utilizar Eclipse y Maven. A pesar de ello, este tutorial debería servir con cambios mínimos para cualquiera de las demás herramientas disponibles.
Se asume que el lector tiene las siguientes competencias:
-
JDK
- Instalar JDK
-
Eclipse
- Instalar Eclipse
- Instalar plugins
- Importar proyectos
- Desarrollar en Java con Eclipse
-
Maven
- Crear un proyecto Maven
- Manejo de archivos
pom.xml
- Configurar repositorios
- Configurar dependencias
- Configurar proceso de construcción (build)
Todo el software requiere instalar JDK 11, ya sea la versión de Oracle u OpenJDK, el cual debe ser habilitado como el JDK por defecto del sistema operativo. Habrán problemas si se utiliza una versión posterior.
El repositorio de este tutorial contiene muchos archivos útiles para la instalación. La forma más simple de descargar el repositorio es:
- Descargar el archivo
antlr4-tutorial-master.zip
desde este enlace. - Descomprimir el archivo
antlr4-tutorial-master.zip
en la carpeta que desee.
Hay dos formas de configurar Eclipse como ambiente de desarrollo.
Alternativamente, todos los plugins anteriores (m2e) pueden instalarse en forma automática utilizando el archivo de instalación P2F que se encuentra en antlr4-tutorial-master/install_files/antlr-maven.p2f
.
- Instalar Eclipse IDE for Java and DSL Developers (2019-12). Es importante que la versión de Eclipse sea 2019-12. Cualquier otra versión podría no funcionar
- Abrir menú
File->Import->Install->Install Software Items from File
- Hacer click en
Browse
- Buscar y seleccionar el archivo
antlr4-tutorial-master/install_files/antlr-maven.p2f
- Seleccionar todos los plugins que aparezcan en la lista
- Deseleccionar la opción
Install latest version of selected software
.
- Instalar Eclipse IDE for Java and DSL Developers (2019-12)
- Instalar el plugin ANTLR 4 IDE
Es necesario desactivar una opción del plugin ANTLR 4 IDE.
- Abrir las preferencias de Eclipse.
- Abrir ANTLR4 -> Tool
- Desactivar la opción
Tool is activated
. Las opciones deben quedar como en la siguiente imagen:
Las instrucciones para instalar maven se encuentran aquí
El repositorio también provee un arquetipo de maven, llamado antlr4-archetype
, para crear proyectos ANTLR4 y una librería, llamada ast-visualizer
para desplegar árboles semánticos. Los proyectos creados a partir del arquetipo están preconfigurados para comenzar a desarrollar sin mayores inconvenientes (asumiendo que todos los pasos de la instalación hayan sido ejecutados correctamente).
Los siguientes pasos sólo hay que ejecutarlos una vez:
- Abrir la línea de comandos e ingresar a la carpeta
antlr4-tutorial-master
. - Instalar el arquetipo
antlr4-archetype
que se encuentra eninstall_files/antlr4-archetype
.
cd install_files/antlr4-archetype
mvn clean install
cd ../..
- Instalar la librería
ast-visualizer
que se encuentra enlibs/astvisualizer
cd libs/astvisualizer
mvn clean install
El siguiente paso hay que ejecutarlo cada vez que se desee crear un nuevo proyecto:
- Crear un nuevo proyecto basado en el arquetipo
antlr4-archetype
. En el siguiente comando, reemplacemy-app
por el nombre del proyecto que desea crear ycom.mycompany.app
por el nombre del paquete donde quedarán todos los archivos fuentes de su aplicación.
mvn archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-app -DarchetypeArtifactId=antlr4-archetype -DinteractiveMode=false
Por ejemplo, para crear una aplicación que se llame MiLenguaje
y que el código fuente quede en el paquete com.milenguaje
, debe escribir lo siguiente:
mvn archetype:generate -DgroupId=com.milenguaje -DartifactId=MiLenguaje -DarchetypeArtifactId=antlr4-archetype -DinteractiveMode=false
Luego de ello, podrá importar el proyecto generado en Eclipse, utilizando la opción File->Import->Existing Maven Projects
.