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

GenerateLexerTask

@CacheableTask

abstract class GenerateLexerTask : JavaExec

A Gradle task for generating a lexer using JFlex for the IntelliJ Platform. This task takes a Flex definition file as an input, generates the lexer, and saves it in the specified output directory. It also optionally purges old files and allows specifying a custom skeleton file.

Constructors

GenerateLexerTask

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?

packageName

@get:Input

@get:Optional

abstract val packageName: Property<String>

The name of the package where the lexer shall be created. By default, the task tries to detect the package from the content of sourceFile. You may set the value to the empty string (""), if no subdirectory shall be created. The empty string represents the unnamed package.

path

open val path: String?

pathToClass

@get:Input

@get:Optional

abstract val pathToClass: Property<String>

The location of the generated lexer class, relative to targetRootOutputDir. When targetOutputDir is used, this path is resolved relative to targetOutputDir instead. Stale files are purged only from this path.

project

open val project: Project?

purgeOldFiles

@get:Input

@get:Optional

abstract val purgeOldFiles: Property<Boolean>

Purge the generated lexer class before generating the lexer. Purging requires pathToClass to be set, so that only the generated file is removed.

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String?>?

reasonsNotToTrackState

open val reasonsNotToTrackState: Set<String?>?

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String?>?

requiredServices

open val requiredServices: TaskRequiredServices?

sharedResources

open val sharedResources: List<ResourceLock?>?

shouldRunAfter

open val shouldRunAfter: TaskDependency?

skeleton

@get:InputFile

@get:PathSensitive(value = PathSensitivity.RELATIVE)

@get:Optional

abstract val skeleton: RegularFileProperty

An optional path to the skeleton file to use for the generated lexer. The path will be provided as --skel option. By default, it uses the idea-flex.skeleton skeleton file.

sourceFile

@get:InputFile

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val sourceFile: RegularFileProperty

Required. The source Flex file to generate the lexer from.

standardInput

@get:Internal

open var standardInput: InputStream?

standardOutput

@get:Internal

open var standardOutput: OutputStream?

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture?

state

open val state: TaskStateInternal?

systemProperties

open var systemProperties: Map<String?, @Nullable Any?>?

targetOutputDir

@get:Internal

abstract val ~~targetOutputDir~~: DirectoryProperty

The output directory for the generated lexer. The Java file is created directly below the given directory. The value of packageName is ignored. Stale files in the given directory are not deleted during task execution, unless purgeOldFiles is explicitly set to true.

targetRootOutputDir

@get:Internal

abstract val targetRootOutputDir: DirectoryProperty

The output root directory for the generated lexer. The Java file for the lexer is created in a subdirectory matching the packageName.

taskActions

open val taskActions: List<InputChangesAwareTaskAction?>?

taskDependencies

open val taskDependencies: TaskDependencyInternal?

taskIdentity

open val taskIdentity: TaskIdentity<*>?

temporaryDir

open val temporaryDir: File?

temporaryDirFactory

open val temporaryDirFactory: Factory<File?>?

timeout

open val timeout: Property<Duration?>?

workingDir

@get:Internal

open var workingDir: File?

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec?>?)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task?>?)

args

open fun args(args: Iterable<*>?): JavaExecSpec?

open fun args(vararg args: Any?): JavaExec?

bootstrapClasspath

open fun bootstrapClasspath(vararg classpath: @Nullable Any?): JavaExec?

classpath

open fun classpath(vararg paths: @Nullable Any?): JavaExec?

compareTo

open operator fun compareTo(otherTask: Task?): Int

configure

open fun configure(closure: Closure<*>?): Task?

conventionMapping

open fun conventionMapping(property: String?, mapping: Closure<*>?): Task?

open fun conventionMapping(property: String?, mapping: Callable<*>?): Task?

copyTo

open fun copyTo(options: JavaForkOptions?): JavaExec?

open fun copyTo(target: ProcessForkOptions?): JavaExec?

debugOptions

open fun debugOptions(action: Action<JavaDebugOptions?>?)

dependsOn

open fun dependsOn(vararg paths: Any?): Task?

doFirst

open fun doFirst(action: Closure<*>?): Task?

open fun doFirst(action: Action<in Task?>?): Task?

open fun doFirst(actionName: String?, action: Action<in Task?>?): Task?

doLast

open fun doLast(action: Closure<*>?): Task?

open fun doLast(action: Action<in Task?>?): Task?

open fun doLast(actionName: String?, action: Action<in Task?>?): Task?

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String?)

doNotTrackStateIf

open fun doNotTrackStateIf(reason: String?, spec: Spec<in TaskInternal?>?)

environment

open fun environment(environmentVariables: Map<String?, *>?): JavaExec?

open fun environment(name: String?, value: Any?): JavaExec?

exec

open override fun exec()

executable

open fun executable(executable: Any?): JavaExec?

finalizedBy

open fun finalizedBy(vararg paths: Any?): Task?

hasProperty

open fun hasProperty(propertyName: String?): Boolean

hasTaskActions

open fun hasTaskActions(): Boolean

jvmArgs

open fun jvmArgs(arguments: Iterable<*>?): JavaExec?

open fun jvmArgs(vararg arguments: Any?): JavaExec?

mustRunAfter

open fun mustRunAfter(vararg paths: Any?): Task?

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String?)

onlyIf

open fun onlyIf(onlyIfClosure: Closure<*>?)

open fun onlyIf(spec: Spec<in Task?>?)

open fun onlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task?>?)

property

open fun property(propertyName: String?): Any?

restoreOnlyIf

open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal?>?)

restoreTaskActions

open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction?>?)

setArgsString

open fun setArgsString(args: String?): JavaExec?

setDependsOn

open fun setDependsOn(dependsOn: Iterable<*>?)

setFinalizedBy

open fun setFinalizedBy(finalizedByTasks: Iterable<*>?)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>?)

setOnlyIf

open fun setOnlyIf(onlyIfClosure: Closure<*>?)

open fun setOnlyIf(spec: Spec<in Task?>?)

open fun setOnlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

setProperty

open fun setProperty(name: String?, value: Any?)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>?)

shouldRunAfter

open fun shouldRunAfter(vararg paths: Any?): TaskDependency?

systemProperties

open fun systemProperties(properties: Map<String?, out @Nullable Any?>?): JavaExec?

systemProperty

open fun systemProperty(name: String?, value: @Nullable Any?): JavaExec?

targetFile

fun ~~targetFile~~(lexerClass: String): Provider<RegularFile>

fun ~~targetFile~~(lexerClass: Provider<String>): Provider<RegularFile>

The location of the lexer class computed from the targetOutputDir. Because the lexer class is defined in the flex file, it needs to be passed here too.

usesService

open fun usesService(service: Provider<out BuildService<*>?>?)

workingDir

open fun workingDir(dir: Any?): JavaExec?