README.md

Bld extension to generate ANTLR4 parsers

A bld extension for generating Java sources from ANTLR4 parsers.

The complete documentation of Antrl4Operation can be found in its javadocs.

This is an example usage where your ANTLR4 sources would be located at src/main/antlr and the parsers generated into build/generated. The compile command then uses an adapted CompileOperation to include the generated sources into the main source directories.

private final Antlr4Operation antlr4Operation = new Antlr4Operation();
private final CompileOperation compileOperation = new CompileOperation();

@BuildCommand(summary = "Generates the grammar Java sources")
public void generateGrammar()
throws Exception {
    antlr4Operation.executeOnce(() -> antlr4Operation
        .sourceDirectories(List.of(new File(srcMainDirectory(), "antlr")))
        .outputDirectory(new File(buildDirectory(), "generated"))
        // these options are specific to ANTLR4, please refer to the extension
        // documentation to learn more about these and others
        .visitor()
        .longMessages());
}

public void compile()
throws Exception {
    // always generate the latest grammar before compiling the sources
    generateGrammar();

    // include the generated grammar with the main sources
    compileOperation.executeOnce(() -> compileOperation
        .fromProject(this)
        .mainSourceDirectories(List.of(antlr4Operation.outputDirectory())));
}