# AntlrTask

API Documentation: | `AntlrTask`

Generates parsers from Antlr grammars.

### Properties

Property | Description
`antlrClasspath` | The classpath containing the Ant ANTLR task implementation.
`arguments` | List of command-line arguments passed to the antlr process
`excludes` | The set of exclude patterns.
`includes` | The set of include patterns.
`maxHeapSize` | The maximum heap size for the forked antlr process (ex: '1g').
`outputDirectory` | The directory to generate the parser source files into.
`source` | The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.
`trace` | Specifies that all rules call `traceIn`/`traceOut`.
`traceLexer` | Specifies that all lexer rules call `traceIn`/`traceOut`.
`traceParser` | Specifies that all parser rules call `traceIn`/`traceOut`.
`traceTreeWalker` | Specifies that all tree walker rules call `traceIn`/`traceOut`.

### Methods

Method | Description
`exclude(excludeSpec)` | Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a `FileTreeElement` as its parameter. The closure should return true or false. Example:
`exclude(excludes)` | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
`exclude(excludes)` | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
`exclude(excludeSpec)` | Adds an exclude spec. This method may be called multiple times to append new specs. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
`include(includeSpec)` | Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a `FileTreeElement` as its parameter. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.
`include(includes)` | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.
`include(includes)` | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.
`include(includeSpec)` | Adds an include spec. This method may be called multiple times to append new specs. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.
`source(sources)` | Adds some source to this task. The given source objects will be evaluated as per `Project.files(java.lang.Object[])`.

### Script blocks

No script blocks

### Property details

#### `FileCollection` `antlrClasspath`

The classpath containing the Ant ANTLR task implementation.

Default with `antlr` plugin:
  `project.configurations.antlr`

#### ``List`<`String`>` `arguments`

List of command-line arguments passed to the antlr process

#### ``Set`<`String`>` `excludes`

The set of exclude patterns.

#### ``Set`<`String`>` `includes`

The set of include patterns.

#### `String` `maxHeapSize`

The maximum heap size for the forked antlr process (ex: '1g').

Default with `antlr` plugin:
  `null`

#### `File` `outputDirectory`

The directory to generate the parser source files into.

Default with `antlr` plugin:
  ``${project.buildDir}`/generated-src/antlr/`${sourceSet.name}``

#### `FileTree` `source`

The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.

The `PathSensitivity` for the sources is configured to be `PathSensitivity.ABSOLUTE`. If your sources are less strict, please change it accordingly by overriding this method in your subclass.

Default with `antlr` plugin:
  ``sourceSet`.antlr`

#### `boolean` `trace`

Specifies that all rules call `traceIn`/`traceOut`.

Default with `antlr` plugin:
  `false`

#### `boolean` `traceLexer`

Specifies that all lexer rules call `traceIn`/`traceOut`.

Default with `antlr` plugin:
  `false`

#### `boolean` `traceParser`

Specifies that all parser rules call `traceIn`/`traceOut`.

Default with `antlr` plugin:
  `false`

#### `boolean` `traceTreeWalker`

Specifies that all tree walker rules call `traceIn`/`traceOut`.

Default with `antlr` plugin:
  `false`

### Method details

#### `SourceTask` `exclude`(`Closure` excludeSpec)

Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a `FileTreeElement` as its parameter. The closure should return true or false. Example:

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

If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.

#### `SourceTask` `exclude`(``Iterable`<`String`>` excludes)

Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.

#### `SourceTask` `exclude`(``String`...` excludes)

Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.

#### `SourceTask` `exclude`(``Spec`<`FileTreeElement`>` excludeSpec)

Adds an exclude spec. This method may be called multiple times to append new specs. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.

#### `SourceTask` `include`(`Closure` includeSpec)

Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a `FileTreeElement` as its parameter. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.

#### `SourceTask` `include`(``Iterable`<`String`>` includes)

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.

#### `SourceTask` `include`(``String`...` includes)

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.

#### `SourceTask` `include`(``Spec`<`FileTreeElement`>` includeSpec)

Adds an include spec. This method may be called multiple times to append new specs. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.

#### `SourceTask` `source`(``Object`...` sources)

Adds some source to this task. The given source objects will be evaluated as per `Project.files(java.lang.Object[])`.