如何使用 Gradle 2.10 将 ANTLR 词法分析器语法导入到另一个语法中

Question

我一直在通过Terence Parr的The Definitive ANTLR 4参考来学习ANTLR 4，到目前为止我一直在使用Gradle 2.10及其内置的ANTLR插件来关注它。但是，我在获取一些代码时遇到了一些麻烦，这些代码是从第 4 章第 38-41 页改编的，以便与我的 Gradle 构建脚本正常工作。（我之所以直接使用 Gradle，而不是直接使用 ANTLR，是因为我想最终将 ANTLR 集成到我为论文制作的 Java Web 应用程序中，我非常愿意为此使用构建工具，这样我就可以自动化 ANTLR 到 Java 代码生成过程并轻松管理我的依赖项。

我创建了两个ANTLR 4语法（我已经粘贴到这个问题的末尾）：src/main/antlr/org/jbduncan/Expr.g4（

标准语法）和src/main/antlr/org/jbduncan/CommonLexerRules.g4（一个词法分析语法），其中Expr.g4通过import CommonLexerRules语句依赖于CommonLexerRules.g4。但是当我尝试使用我的build.gradle在命令行运行gradlew generateGrammarSource时（也与我的gradle.properties一起粘贴到这个问题的末尾），我收到以下错误：

12:45:21: Executing external task 'generateGrammarSource'...
:generateGrammarSource
error(110): orgjbduncanExpr.g4:3:7: can't find or load grammar CommonLexerRules
warning(125): orgjbduncanExpr.g4:12:11: implicit definition of token NEWLINE in parser
warning(125): orgjbduncanExpr.g4:13:6: implicit definition of token ID in parser
warning(125): orgjbduncanExpr.g4:19:6: implicit definition of token INT in parser
:generateGrammarSource FAILED
FAILURE: Build failed with an exception.
* What went wrong:
Execution failed for task ':generateGrammarSource'.
> There was 1 error during grammar generation
* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output.
BUILD FAILED
Total time: 3.166 secs
There was 1 error during grammar generation
12:45:24: External task execution finished 'generateGrammarSource'.

看着这个错误消息，在我看来，Gradle的ANTLR插件能够找到Expr.g4，但不知何故无法找到CommonLexerRules.g4。

我尝试使用几个外部 Gradle 插件（https://github.com/melix/antlr4-gradle-plugin 和 https://github.com/Abnaxos/gradle-antlr4-plugin）而不是内置插件来解决此错误，但是当我尝试每个插件时，它们引入了我无法解决的问题。

使用直接从 ANTLR 网站下载的 ANTLR 4.5.2 jar 确实让我可以毫无问题地编译我的两个语法，但正如我之前讨论的那样，这对我来说是一个非常不受欢迎的选择，因为我必须手动编译我的语法，而我相信 Gradle 可以自动为我完成。

我的问题是：如何解决上述错误并让 Gradle 将我的词法分析器语法导入我的其他语法？

---

build.gradle

apply plugin: 'java'
apply plugin: 'application'
apply plugin: 'antlr'
sourceCompatibility = 1.8
targetCompatibility = 1.8
[compileJava, compileTestJava]*.options*.encoding = 'UTF-8'
group = 'org.jbduncan'
version = '1.0-SNAPSHOT'
mainClassName = 'org.jbduncan.Application'
repositories {
    jcenter()
}
dependencies {
    antlr "org.antlr:antlr4:$antlrVersion"
    compile "com.google.guava:guava:$guavaVersion"
    testCompile "com.google.guava:guava-testlib:$guavaVersion"
    testCompile "com.google.truth:truth:$truthVersion"
    testCompile "junit:junit:$junitVersion"
}
// Send all generated source code to a directory other than build/, to workaround an issue in
// IntelliJ IDEA where it fails to recognise source files in build/.
def generatedJavaSourcesDir = 'src/generated/java'
generateGrammarSource {
    arguments += ['-visitor']
    outputDirectory = file(generatedJavaSourcesDir)
}
sourceSets {
    main {
        java {
            srcDir generatedJavaSourcesDir
        }
    }
}
clean {
    delete generatedJavaSourcesDir
}
task wrapper(type: Wrapper) {
    distributionUrl = "http://services.gradle.org/distributions/gradle-$gradleVersion-bin.zip"
}

gradle.properties

gradleVersion=2.10
# Dependency versions
antlrVersion=4.5
guavaVersion=19.0
junitVersion=4.12
truthVersion=0.28

src/main/antlr/org/jbduncan/Expr.g4

grammar Expr;
import CommonLexerRules; // includes all rules from CommonLexerRules.g4
@header {
    package org.jbduncan;
}
/** The start rule; begin parsing here. */
prog: stat+;
stat: expr NEWLINE # printExpr
    | ID '=' expr NEWLINE # assign
    | NEWLINE # blank
    ;
expr: expr op=('*'|'/') expr # MulDiv
    | expr op=('+'|'-') expr # AddSub
    | INT # int
    | ID # id
    | '(' expr ')' # parens
    ;
MUL: '*'; // assigns token name to '*' used above in grammar
DIV: '/';
ADD: '+';
SUB: '-';

src/main/antlr/org/jbduncan/CommonLexerRules.g4

lexer grammar CommonLexerRules; // note "lexer grammar"
ID: [a-zA-Z]+ ; // match identifiers
INT: [0-9]+ ; // match integers
NEWLINE: 'r'? 'n' ; // return newlines to parser (is end-statement signal)
WS: [ t] -> skip ; // toss out whitespace

src/main/java/org/jbduncan/Application.java

package org.jbduncan;
import org.antlr.v4.runtime.ANTLRInputStream;
import org.antlr.v4.runtime.CommonTokenStream;
import org.antlr.v4.runtime.tree.ParseTree;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
public final class Application {
  public static void main(String[] args) throws IOException {
    String inputFile = (args.length > 0) ? args[0] : null;
    InputStream inputStream = (inputFile == null) ? System.in : new FileInputStream(inputFile);
    ANTLRInputStream input = new ANTLRInputStream(inputStream);
    ExprLexer lexer = new ExprLexer(input);
    CommonTokenStream tokens = new CommonTokenStream(lexer);
    ExprParser parser = new ExprParser(tokens);
    ParseTree tree = parser.prog(); // parse; start at prog
    System.out.println(tree.toStringTree(parser)); // print tree as text
  }
}

Answer 1

在

Gradle 论坛上发布后，我设法找到了问题的答案：

generateGrammarSource {
  arguments << "-lib" << "src/main/antlr/org/jbduncan" 
}

其中"src/main/antlr/org/jbduncan"是包含 ANTLR .g4库的路径。