AntlrTask

目录

属性
方法
脚本块
属性详情
方法详情
API 文档AntlrTask

从 Antlr 语法生成解析器。

属性

属性描述
antlrClasspath

包含 Ant ANTLR 任务实现的类路径。

arguments

传递给 antlr 进程的命令行参数列表

excludes

排除模式的集合。

includes

包含模式的集合。

maxHeapSize

分叉的 antlr 进程的最大堆大小（例如：'1g'）。

outputDirectory

生成解析器源文件的目录。

source

应用包含和排除模式后，此任务的源。忽略不存在的源文件。

trace

指定所有规则调用 traceIn/traceOut。

traceLexer

指定所有词法分析器规则调用 traceIn/traceOut。

traceParser

指定所有解析器规则调用 traceIn/traceOut。

traceTreeWalker

指定所有树walker规则调用 traceIn/traceOut。

方法

方法描述
exclude(排除规范)

添加排除规范。此方法可以多次调用以追加新的规范。给定的闭包会传递 FileTreeElement 作为其参数。闭包应返回 true 或 false。例如

exclude(排除项)

添加 ANT 风格的排除模式。此方法可以多次调用以追加新模式，并且可以在单个调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。

exclude(排除项)

添加 ANT 风格的排除模式。此方法可以多次调用以追加新模式，并且可以在单个调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。

exclude(排除规范)

添加排除规范。此方法可以多次调用以追加新的规范。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。

include(包含规范)

添加包含规范。此方法可以多次调用以追加新的规范。给定的闭包会传递 FileTreeElement 作为其参数。如果未提供包含项，则将包含此容器中的所有文件。如果提供了包含项，则文件必须至少匹配一个包含模式或规范才能被包含。

include(包含项)

添加 ANT 风格的包含模式。此方法可以多次调用以追加新模式，并且可以在单个调用中指定多个模式。如果未提供包含项，则将包含此容器中的所有文件。如果提供了包含项，则文件必须至少匹配一个包含模式才能被处理。

include(包含项)

添加 ANT 风格的包含模式。此方法可以多次调用以追加新模式，并且可以在单个调用中指定多个模式。如果未提供包含项，则将包含此容器中的所有文件。如果提供了包含项，则文件必须至少匹配一个包含模式才能被处理。

include(包含规范)

添加包含规范。此方法可以多次调用以追加新的规范。如果未提供包含项，则将包含此容器中的所有文件。如果提供了包含项，则文件必须至少匹配一个包含模式或规范才能被包含。

source(源)

为此任务添加一些源。给定的源对象将按照 Project.files(java.lang.Object[]) 进行评估。

脚本块

无脚本块

属性详情

FileCollection antlrClasspath

包含 Ant ANTLR 任务实现的类路径。

使用 antlr 插件时的默认值
project.configurations.antlr

List<String> arguments

传递给 antlr 进程的命令行参数列表

Set<String> excludes

排除模式的集合。

Set<String> includes

包含模式的集合。

String maxHeapSize

分叉的 antlr 进程的最大堆大小（例如：'1g'）。

使用 antlr 插件时的默认值
null

File outputDirectory

生成解析器源文件的目录。

使用 antlr 插件时的默认值
${project.layout.buildDirectory}/generated-src/antlr/${sourceSet.name}

FileTree source

应用包含和排除模式后，此任务的源。忽略不存在的源文件。

源的 PathSensitivity 配置为 PathSensitivity.ABSOLUTE。如果您的源要求不那么严格，请在子类中重写此方法以进行相应更改。

使用 antlr 插件时的默认值
sourceSet.antlr

boolean trace

指定所有规则调用 traceIn/traceOut。

使用 antlr 插件时的默认值
false

boolean traceLexer

指定所有词法分析器规则调用 traceIn/traceOut。

使用 antlr 插件时的默认值
false

boolean traceParser

指定所有解析器规则调用 traceIn/traceOut。

使用 antlr 插件时的默认值
false

boolean traceTreeWalker

指定所有树walker规则调用 traceIn/traceOut。

使用 antlr 插件时的默认值
false

方法详情

SourceTask exclude(Closure 排除规范)

添加排除规范。此方法可以多次调用以追加新的规范。给定的闭包会传递 FileTreeElement 作为其参数。闭包应返回 true 或 false。例如

copySpec {
  from 'source'
  into 'destination'
  //an example of excluding files from certain configuration:
  exclude { it.file in configurations.someConf.files }
}

如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。

SourceTask exclude(Iterable<String> 排除项)

添加 ANT 风格的排除模式。此方法可以多次调用以追加新模式，并且可以在单个调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。

SourceTask exclude(String... 排除项)

添加 ANT 风格的排除模式。此方法可以多次调用以追加新模式，并且可以在单个调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。

SourceTask exclude(Spec<FileTreeElement> 排除规范)

添加排除规范。此方法可以多次调用以追加新的规范。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。

SourceTask include(Closure 包含规范)

添加包含规范。此方法可以多次调用以追加新的规范。给定的闭包会传递 FileTreeElement 作为其参数。如果未提供包含项，则将包含此容器中的所有文件。如果提供了包含项，则文件必须至少匹配一个包含模式或规范才能被包含。

SourceTask include(Iterable<String> 包含项)

添加 ANT 风格的包含模式。此方法可以多次调用以追加新模式，并且可以在单个调用中指定多个模式。如果未提供包含项，则将包含此容器中的所有文件。如果提供了包含项，则文件必须至少匹配一个包含模式才能被处理。

SourceTask include(String... 包含项)

添加 ANT 风格的包含模式。此方法可以多次调用以追加新模式，并且可以在单个调用中指定多个模式。如果未提供包含项，则将包含此容器中的所有文件。如果提供了包含项，则文件必须至少匹配一个包含模式才能被处理。

SourceTask include(Spec<FileTreeElement> 包含规范)

添加包含规范。此方法可以多次调用以追加新的规范。如果未提供包含项，则将包含此容器中的所有文件。如果提供了包含项，则文件必须至少匹配一个包含模式或规范才能被包含。

SourceTask source(Object... 源)

为此任务添加一些源。给定的源对象将按照 Project.files(java.lang.Object[]) 进行评估。