Skip to content

Latest commit

 

History

History
132 lines (100 loc) · 6.66 KB

README.md

File metadata and controls

132 lines (100 loc) · 6.66 KB
Raw

Build Status Download

ANTLR 4 IDE

ANTLR 4 IDE

Features

  • ANTLR 4.x
  • Advanced Syntax Highlighting (even for target language)
  • Automatic Code Generation (on save)
  • Manual Code Generation (through External Tools menu)
  • Code Formatter (Ctrl+Shift+F)
  • Syntax Diagrams as HTML
  • Live Parse Tree evaluation
  • Advanced Rule Navigation between files (F3 or Ctrl+Click over a rule)
  • Quick fixes

Welcome

This is brand new version of the old ANTLR IDE. The new IDE supports ANTLR 4.x and it was created to run on Eclipse 4.x

The old ANTLR IDE isn't supported anymore. When I wrote it, I was young and didn't know what was doing ;)

Don't get me wrong, the old version did a very good work from user point of view, it just I'm not proud of the code base because is kind of complex and had a poor quality.

The main reason of complexity of the old IDE was in Dynamic Language ToolKit (DLTK) dependency. The DLTK project didn't evolve so much over the last few years and doing something in DLTK is very very complex and require a lot of work.

Now, the new IDE was built on XText. XText is great for building DSL with Eclipse IDE support, so if you are not familiar with XText go and see it.

Requirements

  • Eclipse 4.3 (Kepler)
  • XText 2.5.x/2.6

Installation

ANTLR 4 IDE isn't available in the Eclipse Market Place yet, so you MUST installed in the old way. Please follow these instructions:

  • Open Eclipse Kepler (4.3)
  • Go to: Help > Install New Software...
  • You need to Install XText 2.5.x/2.6
  • Copy and paste this url: http://download.eclipse.org/modeling/tmf/xtext/updates/composite/releases/ in the Work with text field
  • Hit Enter
  • Choose XText 2.5.4. NOTE: DON'T confuse with Xtend, you must choose Xtext
  • Now, copy and paste this url: http://dl.bintray.com/jknack/antlr4ide in the Work with text field
  • Choose: ANTLR 4 SDK IDE. NOTE: If you don't see it, please unmark the Group items by category option
  • Click: Next and follow the normal Eclipse installation procedure

Manual Installation

You can download the plugin and the save it in the dropins directory of your Eclipse installation.

Usage

The new IDE is very simple to use all the files with a *.g4 extension will be opened by the ANTLR 4 Editor. So, just open a *.g4 file and play with it

Code Generation

Code is automatically generated on save if the grammar is valid. You can turn off this feature by going to: Window > Preferences > ANTLR 4 > Tool and uncheck the "Tool is activated" option. From there you can configure a couple more of options.

You can find the generated code in the target/generated-sources/antlr4 (same directory as antlr4-maven-plugin)

Manual Code Generation

You can fire a code generation action by selecting a *.g4 file from the Package Explorer, right click: Run As > ANTLR 4.

A default ANTLR 4 launch configuration will be created. You can modify the generated launch configuration by going to: Run > External Tools > External Tools Configurations... from there you will see the launch configuration and how to set or override code generation options

Syntax Diagrams

To open the Syntax Diagram view go to: Window > Show View > Other search and select: Syntax Diagram

Build with Maven 3.x

  1. Fork and clone the repository from github
  2. Download and install Maven 3.x
  3. Open a shell console and type: cd antlr4ide
  4. Build the project with: mvn clean package
  5. It takes a while to download and configure Eclipse dependencies, so be patient
  6. Wait for a: BUILD SUCCESS message

Eclipse setup

  1. Make sure you built the project first.
  2. Open Eclipse Kepler (4.3)
  3. Install Xtext 2.5.3
  4. Copy and paste this url: http://download.eclipse.org/modeling/tmf/xtext/updates/composite/releases/ in the Work with text field
  5. Hit Enter
  6. Choose XText 2.5.3. NOTE: DON'T confuse with Xtend, you must choose Xtext
  7. Restart Eclipse after installing Xtext
  8. Import the project into Eclipse
  9. Go to: File > Import... then General > Existing Projects into Workspace
  10. Choose project root antlr4ide
  11. Enabled: Search for nested projects
  12. Finish

You don't need any extra Eclipse plugin (like m2e or similar). Project metadata is on git so all you need to do is: mvn clean package and then import the projects into Eclipse.

Want to contribute?

  • Fork the project on Github.
  • Wandering what to work on? See task/bug list and pick up something you would like to work on.
  • Create an issue or fix one from issues list.
  • If you know the answer to a question posted to our mailing list - don't hesitate to write a reply.
  • Share your ideas or ask questions on mailing list - don't hesitate to write a reply - that helps us improve javadocs/FAQ.
  • If you miss a particular feature - browse or ask on the mailing list - don't hesitate to write a reply, show us a sample code and describe the problem.
  • Write a blog post about how you use or extend ANTLR 4 IDE.
  • Please suggest changes to javadoc/exception messages when you find something unclear.
  • If you have problems with documentation, find it non intuitive or hard to follow - let us know about it, we'll try to make it better according to your suggestions. Any constructive critique is greatly appreciated. Don't forget that this is an open source project developed and documented in spare time.

Help and Support

Help and discussion

Bugs, Issues and Features

Author

[Edgar Espina] (https://twitter.com/edgarespina)

License

EPL