Use maven antlr4 plugin to generate grammars from other artifacts

Question

I want to use antlr4 to generate a java parser api for a grammar. I realize other people maybe be interested in the grammar part so I want to keep the parser artifact in maven separate from the grammar artifact.

I have almost got everything working the problem seems to be that it generates the *.java files with the right package but puts them in a directory representing a different package.

I have a multi module maven project with a parent and two modules; grammar and parser. grammar produces a simple jar with this contents:

META-INF/
META-INF/MANIFEST.MF
org/
org/boazglean/
org/boazglean/dabar/
org/boazglean/dabar/grammer/
org/boazglean/dabar/grammer/DabarLexer.g4
org/boazglean/dabar/grammer/DabarParser.g4
META-INF/maven/
META-INF/maven/org.boazglean.dabar/
META-INF/maven/org.boazglean.dabar/grammer/
META-INF/maven/org.boazglean.dabar/grammer/pom.xml
META-INF/maven/org.boazglean.dabar/grammer/pom.properties

Now I want to produce a parser jar, with a bunch of parser classes in the package org.boazglean.dabar.parser. Here is the pom configuration I use:

<plugin>
    <groupId>org.antlr</groupId>
    <artifactId>antlr4-maven-plugin</artifactId>
    <version>4.0</version>
    <executions>
        <execution>
            <goals>
                <goal>antlr4</goal>
            </goals>
            <configuration>
                <sourceDirectory>${antlr.dir}</sourceDirectory>
                <listener>true</listener>
                <visitor>true</visitor>
                <arguments>
                    <argument>-package</argument>
                    <argument>org.boazglean.dabar.parser</argument>
                </arguments>
            </configuration>
        </execution>
    </executions>
</plugin>
<plugin>
    <artifactId>maven-dependency-plugin</artifactId>
    <executions>
        <execution>
            <id>extract-grammer</id>
            <phase>initialize</phase>
            <goals>
                <goal>unpack-dependencies</goal>
            </goals>
            <configuration>
                <includeArtifactIds>grammer</includeArtifactIds>
                <outputDirectory>${antlr.dir}</outputDirectory>
            </configuration>
        </execution>
    </executions>
</plugin>

Now the problem is that the generated sources come out in the wrong directory (but they do have the right package).

head -n 2 parser/target/generated-sources/antlr4/org/boazglean/dabar/grammer/DabarLexer.java 

// Generated from org/boazglean/dabar/grammer/DabarLexer.g4 by ANTLR 4.0
package org.boazglean.dabar.parser;

Am I missing some command I should be configuring antlr4 with?

keyiss keyiss · Accepted Answer · 2013-10-31T03:27:35

Make the grammar folder structure /src/main/antlr4/org/nimy/antlr4/xml/xxxx.g4
in pom.xml

<plugin>
    <groupId>org.antlr</groupId>
    <artifactId>antlr4-maven-plugin</artifactId>
    <version>4.1</version>
    <configuration>
        <listener>true</listener>
        <visitor>true</visitor>
        <arguments>
            <argument>-package</argument>
        </arguments>
    </configuration>
    <executions>
        <execution>
            <id>antlr-generate</id>
            <phase>generate-sources</phase>
            <goals>
                <goal>antlr4</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Java code is generated in package： package org.nimy.antlr4.xml

antlt4 maven plugin source code on github. Try to read it and get the way to configure the project. antlr4 source code

Use maven antlr4 plugin to generate grammars from other artifacts

3 Answers