Setting up ANTLR4 on Windows

| microsoft | programming | java |

I am using ANTLR for a Compilers course, and working on a windows box. Getting ANTLR to work is not difficult since it is just a Java jar file. The quick start instructions on the ANTLR website seem really straightforward, and they probably are if you know what you are doing. However, I had a bit of trouble getting the handy antlr4 and gruncommands to work properly in my environment. This is likely due to my Unix/Linux background and because I am not used to messing with environment variables and batch files on windows. Adding things to the PATH and creating bash aliases in Linux is a piece of cake. This is a bit trickier on Windows so I figured I would make a short tutorial to help anyone else who does not know what they are doing like me.

Download Antlr

You can get the latest ANTLR from here. Save this file to C:\Javalib

Add ANTLR to the CLASSPATH

CLASSPATH is an environmental variable. In order to set an environmental variable in Windows you will need to do the following.
  1. Open Up File Explorer
  2. Right Click on This PC
  3. Select Properties
  4. On the left hand side of the new window select Advanced system settings
  5. On the bottom of this screen select Environment Variables…
  6. This is a new computer with no CLASSPATH variable so I had to add a new one. If you have used other Java Libraries it is possible that you may already have CLASSPATH defined. If you see CLASSPATH under System Variables append it with C:\Javalib\antlr-4.5.3-complete.jar; If you do not have a CLASSPATH variable defined, select **New…* and then enter CLASSPATH for the Variable Name, andC:\Javalib\antlr-4.5.3-complete.jar for the Variable value.

Create batch commands for ANTLR Tool and TestRig

In order to make ANTLR easier to run from the command line we will need to add two simple batch files somewhere in the PATH. I decided to put these in C:\Javalib in order to keep them organized and together. C:\Javalib is not in the PATH by default so we must append the existing PATH variable just like we did in the previous step.
  1. Open Up File Explorer
  2. Right Click on This PC
  3. Select Properties
  4. On the left hand side of the new window select Advanced system settings
  5. On the bottom of this screen select Environment Variables…
  6. Find the PATH variable
  7. Append ;C:\Javalib\; to the existing PATH variable
Now we need to create the batch files.
  1. Create a new file in C:\Javalib called antlr4.bat
  2. In this file enter java org.antlr.v4.Tool %*
  3. Save this file
  4. Create a new file in C:\Javalib called grun.bat
  5. In this file enter java org.antlr.v4.runtime.misc.TestRig %*
  6. Save this file
This will now allow us to enter antrl4 and grun into a command prompt and launch ANTLR or the Testing Suite respectively.

Make Sure Everything Works

To make sure that all of this worked;
  1. Open up a Command Prompt or Powershell
  2. Enter the command antlr4
  3. You should see something like this:
[caption id="attachment_87" align="alignnone" width="660"]Output of antlr4 command Output of antlr4 command[/caption]
  1. Enter the command grun
  2. You should see somethign like this:
[caption id="attachment_88" align="alignnone" width="660"]Output of grun command Output of grun command[/caption]

Congrats, you are ready to hack on compilers now. Next, check out The Definitive ANTLR Reference book to learn everything there is to know about ANTLR.

Thank you for reading! Share your thoughts with me on mastodon or via email.

Check out some more stuff to read down below.

Most popular posts this month

Recent Favorite Blog Posts

This is a collection of the last 8 posts that I bookmarked.

Articles from blogs I follow around the net

MetaWin casino hacked for $4 million

Hot wallets used by the MetaWin crypto casino were drained of around $4 million. According to the company's CEO, the attacker "t[ook] advantage of our frictionless withdrawal system". The attacker then moved the stolen fu…

via Web3 is Going Just Great November 9, 2024

Echoes of Time

Wong, et al Light near a black hole can travel different paths to create echoes of a single flash. The most amazing thing about light is that it takes time to travel through space. Because of that one simple fact, when we look up at the Universe we see not …

via Brian Koberlein November 9, 2024

New microblog with TILs

I added a new section to this site a couple weeks ago called TIL (“today I learned”). the goal: save interesting tools & facts I posted on social media One kind of thing I like to post on Mastodon/Bluesky is “hey, here’s a cool thing”, like the great SQLi…

via Julia Evans November 9, 2024

Generated by openring