Skip to content

Latest commit

 

History

History
76 lines (55 loc) · 3.89 KB

ReadMe.md

File metadata and controls

76 lines (55 loc) · 3.89 KB

JavaCC LOG3210 - TP1

This projet is an adaptation of the Nic007's template which integrate correctly JavaCC to an IDE. You can now finally work in Intellij and simply press the Compile/Run buttons and enjoy. To make it works, an Ant step has been added before the compilation. Finally, the support for the visitors is present by default and a test-suite using JUnit is present and make it easy to test your parser.

Getting Started

The easiest way to get started is to simply open this project in Intellij Idea and the project should be ready to run.

To open the project for the first time:

  • Open Intellij Idea
  • At the top-left corner of your screen, click on File -> Open
  • In the opened file browser, search and select the folder of the project (which contains this ReadMe file)
  • Open the project, you should now see a notification at the bottom right of your screen for a missing plugin, follow the procedures to install it
  • You are now ready to work!

If you don't have Intellij installed, you will still need to install the correct version of JUnit and hamcrest. Intellij should notify you of those missing libraries and invite you to install them. Simply do so.

Prerequisites

What things you need to install the software and how to install them

JavaCC 1.7 (Included in the libs folder)
Intellij Idea
JUnit 4.12 (Included in Intellij)
Hamcrest 1.3 (Included in Intellij)

Project structure

  • .idea/ : Contains specifics files for the intellij project. Do not touch this.
  • gen-src/ : Contains java files that are generated. Every time you compile, this folder is rewritten. If you want to edit theses files, copy them to /src/analyzer/ast/ and they will no longer be generated.
  • libs/ : Contains the javacc lib. Check this folder if you want to see documentations. You could move out this library of your project if you have multiples projects.
  • out/ : Contains the compiled program. out/production/ contains the main program and out/test/ contains the test suite.
  • src/ : Contains the source code for the java files.
  • test/ : Contains the source code for the tests. Read the description of BaseTest for more details.
  • test-suite/ : Contains the test cases for the tests.
  • .gitignore : The files to ignore if you use git
  • build.xml : The ant build file, if you use intellij, it will be helpful to generate the JavaCC files at the pre-compile step. And if you use the command line this file is helpful for everything.
  • Makefile : Simply redirect to the build.xml file.
  • LICENSE.txt : The MIT License of this project
  • ReadMe.md : Hmmm, what is the use of this file? Nobody read this.
  • LOG3210_TP1.iml : The idea project file
  • Grammaire.jjt : Important ! This file is the JavaCC grammar file which generate everything in the gen-src/ folder!

Running the tests

To test your program in Intellij, simply run the LOG3210 - TP1 run configuration. It should, by itself, run ant pre-compile then run the junit tests.

If you don't want to use Intellij, you can still execute the tests with the command make test. WARNING, if you want to use ant to run the tests, you need to supply build.xml with the path to your junit and hamcrest library.

Built With

  • JavaCC - The Parser
  • Ant - The pre-compile steps
  • JUnit - The test library

Authors

  • Nicolas Cloutier - Initial work - Nic007
  • Raphaël Tremblay - Adaptation for LOG3210 and better intellij IDEA integration - Tursh

License

This project is licensed under the MIT License - see the LICENSE.txt file for details

Acknowledgments

  • Thanks for Polytechnique Montréal for investing in this project for the course LOG3210.
  • Ettore Merlo for the theory behind this project.