Package org.gradle.api.plugins.antlr

Class AntlrTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.SourceTask
org.gradle.api.plugins.antlr.AntlrTask
All Implemented Interfaces:
Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, PatternFilterable, Configurable<Task>
@NullMarked @CacheableTask public abstract class AntlrTask extends SourceTask
Generates parsers from Antlr grammars.

  • Constructor Details

    • AntlrTask

      public AntlrTask()

  • Method Details

    • isTrace

      @Input public boolean isTrace()
      Specifies that all rules call traceIn/traceOut.

    • setTrace

      public void setTrace(boolean trace)

    • isTraceLexer

      @Input public boolean isTraceLexer()
      Specifies that all lexer rules call traceIn/traceOut.

    • setTraceLexer

      public void setTraceLexer(boolean traceLexer)

    • isTraceParser

      @Input public boolean isTraceParser()
      Specifies that all parser rules call traceIn/traceOut.

    • setTraceParser

      public void setTraceParser(boolean traceParser)

    • isTraceTreeWalker

      @Input public boolean isTraceTreeWalker()
      Specifies that all tree walker rules call traceIn/traceOut.

    • setTraceTreeWalker

      public void setTraceTreeWalker(boolean traceTreeWalker)

    • getMaxHeapSize

      @Internal public String getMaxHeapSize()
      The maximum heap size for the forked antlr process (ex: '1g').

    • setMaxHeapSize

      public void setMaxHeapSize(String maxHeapSize)

    • setArguments

      public void setArguments(List<String> arguments)

    • getArguments

      @Input public List<String> getArguments()
      List of command-line arguments passed to the antlr process
      Returns:
      The antlr command-line arguments

    • getOutputDirectory

      @OutputDirectory public File getOutputDirectory()
      Returns the directory to generate the parser source files into.
      Returns:
      The output directory.

    • setOutputDirectory

      public void setOutputDirectory(File outputDirectory)
      Specifies the directory to generate the parser source files into.
      Parameters:
      outputDirectory - The output directory. Must not be null.

    • getAntlrClasspath

      @Classpath public FileCollection getAntlrClasspath()
      Returns the classpath containing the Ant ANTLR task implementation.
      Returns:
      The Ant task implementation classpath.

    • setAntlrClasspath

      protected void setAntlrClasspath(FileCollection antlrClasspath)
      Specifies the classpath containing the Ant ANTLR task implementation.
      Parameters:
      antlrClasspath - The Ant task implementation classpath. Must not be null.

    • getWorkerProcessBuilderFactory

      @Inject protected abstract org.gradle.process.internal.worker.WorkerProcessFactory getWorkerProcessBuilderFactory()

    • getProjectLayout

      @Inject protected abstract ProjectLayout getProjectLayout()

    • execute

      public void execute(InputChanges inputChanges)
      Generate the parsers.
      Since:
      6.0

    • setSource

      public void setSource(FileTree source)
      Sets the source for this task. Delegates to setSource(Object). If the source is of type SourceDirectorySet, then the relative path of each source grammar files is used to determine the relative output path of the generated source If the source is not of type SourceDirectorySet, then the generated source files end up flattened in the specified output directory.
      Overrides:
      setSource in class SourceTask
      Parameters:
      source - The source.
      Since:
      4.0

    • setSource

      public void setSource(Object source)
      Sets the source for this task. Delegates to SourceTask.setSource(Object). If the source is of type SourceDirectorySet, then the relative path of each source grammar files is used to determine the relative output path of the generated source If the source is not of type SourceDirectorySet, then the generated source files end up flattened in the specified output directory.
      Overrides:
      setSource in class SourceTask
      Parameters:
      source - The source.

    • getSource

      @Internal("tracked via stableSources") public FileTree getSource()
      Returns 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.

      Overrides:
      getSource in class SourceTask
      Returns:
      The source.

    • getStableSources

      @SkipWhenEmpty @IgnoreEmptyDirectories @PathSensitive(RELATIVE) @InputFiles protected FileCollection getStableSources()
      The sources for incremental change detection.
      Since:
      6.0

    • getDeleter

      @Inject protected abstract org.gradle.internal.file.Deleter getDeleter()

    • getPackageName

      @Input @Optional @Incubating public abstract Property<String> getPackageName()
      Sets the package to be used when generating the parser source files. Supported only when using Antlr 4. This will add a "-package" argument to the ANTLR command line as well as adjust the target directory to generate sources into a package-specific subdirectory of getOutputDirectory(). For example, if the package name is set to "com.foo.bar" and the output directory is set to "path/to/output", the sources will be generated into "path/to/output/com/foo/bar".
      Since:
      9.1.0