IntelliJPlatformGradlePlugin/org.jetbrains.intellij.platform.gradle.tasks/GenerateParserTask

GenerateParserTask

@CacheableTask

abstract class GenerateParserTask : JavaExec

Task to generate a parser for the IntelliJ Platform Grammar Kit.

This task runs a Java process to generate parser and PSI files using a provided BNF file. It supports purging old files before generation, as well as specifying paths for outputs relative to a root output directory.

This task is part of the IntelliJ Platform plugin development process and integrates with Gradle for task registration and execution.

Constructors

GenerateParserTask

constructor()

Types

Companion

object Companion : Registrable

Properties

actions

open var actions: List<Action<in Task?>?>?

allJvmArgs

open var allJvmArgs: List<String?>?

ant

open val ant: AntBuilder?

args

open var args: List<String?>?

argumentProviders

open val argumentProviders: List<CommandLineArgumentProvider?>?

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

bootstrapClasspath

open var bootstrapClasspath: FileCollection?

classpath

open var classpath: FileCollection?

commandLine

@get:Internal

open val commandLine: List<String?>?

conventionMapping

@get:Internal

open val conventionMapping: ConventionMapping?

debug

open var debug: Boolean

debugOptions

open val debugOptions: JavaDebugOptions?

defaultCharacterEncoding

open var defaultCharacterEncoding: @Nullable String?

dependsOn

open val dependsOn: Set<Any?>?

description

open var description: @Nullable String?

destroyables

open val destroyables: TaskDestroyables?

didWork

open var didWork: Boolean

enableAssertions

open var enableAssertions: Boolean

enabled

open var enabled: Boolean

environment

@get:Internal

open var environment: Map<String?, Any?>?

errorOutput

@get:Internal

open var errorOutput: OutputStream?

executable

@get:Internal(value = "covered by getJavaVersion")

open var executable: @Nullable String?

executionResult

@get:Internal

open val executionResult: Provider<ExecResult?>?

extensions

open val extensions: ExtensionContainer?

finalizedBy

open val finalizedBy: TaskDependency?

group

open var group: @Nullable String?

identityPath

open val identityPath: Path?

impliesSubProjects

open var impliesSubProjects: Boolean

inputs

open val inputs: TaskInputsInternal?

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

isEnabled

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

isIgnoreExitValue

@get:Input

open var isIgnoreExitValue: Boolean

javaLauncher

abstract val javaLauncher: Property<JavaLauncher?>?

javaVersion

@get:Internal(value = "covered by getJavaLauncher().getMetadata().getLanguageVersion()")

open val javaVersion: JavaVersion?

jvmArgs

open var jvmArgs: List<String?>?

jvmArgumentProviders

open val jvmArgumentProviders: List<CommandLineArgumentProvider?>?

jvmArguments

open val jvmArguments: ListProperty<String?>?

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal?

localState

open val localState: TaskLocalState?

logger

open val logger: Logger?

logging

open val logging: LoggingManager?

mainClass

abstract val mainClass: Property<String?>?

mainModule

abstract val mainModule: Property<String?>?

maxHeapSize

open var maxHeapSize: @Nullable String?

minHeapSize

open var minHeapSize: @Nullable String?

modularity

open val modularity: ModularitySpec?

mustRunAfter

open val mustRunAfter: TaskDependency?

name

open val name: String?

onlyIf

open val onlyIf: Spec<in TaskInternal?>?

outputs

open val outputs: TaskOutputsInternal?

path

open val path: String?

pathToParser

@get:Input

@get:Optional

abstract val pathToParser: Property<String>

The location of the generated parser class, relative to the targetRootOutputDir. Stale files are purged only from this path and pathToPsiRoot.

pathToPsiRoot

@get:Input

@get:Optional

abstract val pathToPsiRoot: Property<String>

The location of the generated PSI files, relative to the targetRootOutputDir. Stale files are purged only from this path and pathToParser.

project

open val project: Project?

purgeOldFiles

@get:Input

@get:Optional

abstract val purgeOldFiles: Property<Boolean>

Purge old parser and PSI files before generating the parser. Purging requires pathToParser and pathToPsiRoot to be set, so that only generated outputs are removed.