api / org.gradle.language.nativeplatform / ComponentWithExecutable

ComponentWithExecutable

@Incubating interface ComponentWithExecutable : ComponentWithNativeRuntime

Represents a native component that produces an executable.

Since
4.5

Functions

getExecutableFile

abstract fun getExecutableFile(): Provider<RegularFile>

Returns the executable file to produce.

getLinkLibraries

abstract fun getLinkLibraries(): FileCollection

Returns the link libraries to use to link the executable. Includes the link libraries of the component's dependencies.

getLinkTask

abstract fun getLinkTask(): Provider<out LinkExecutable>

Returns the link task for the executable.

Inherited Functions

getBaseName

abstract fun getBaseName(): Provider<String>

Returns the base name of this component. This is used to calculate output file names.

getTargetPlatform

abstract fun getTargetPlatform(): NativePlatform

Returns the target platform for this component.

getToolChain

abstract fun getToolChain(): NativeToolChain

Returns the tool chain for this component.

isDebuggable

abstract fun isDebuggable(): Boolean

Returns true if this component has debugging enabled.

isOptimized

abstract fun isOptimized(): Boolean

Returns true if this component is optimized.

Inheritors

CppExecutable

interface CppExecutable : CppBinary, ComponentWithExecutable, ComponentWithInstallation, ComponentWithOutputs, ComponentWithRuntimeUsage, PublishableComponent

An executable built from C++ source.

CppTestExecutable

interface CppTestExecutable : CppBinary, ComponentWithExecutable, ComponentWithInstallation, TestComponent

A test executable with tests implemented in C++.

SwiftExecutable

interface SwiftExecutable : SwiftBinary, ComponentWithExecutable, ComponentWithInstallation, ComponentWithOutputs

An executable built from Swift source.

SwiftXCTestExecutable

interface SwiftXCTestExecutable : SwiftXCTestBinary, ComponentWithExecutable, ComponentWithInstallation

An XCTest executable for tests implemented in Swift.