api / org.gradle.language.cpp / CppExecutable

CppExecutable

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

An executable built from C++ source.

Since
4.2

Inherited Properties

DEBUGGABLE_ATTRIBUTE

static val DEBUGGABLE_ATTRIBUTE: Attribute<Boolean>

The dependency resolution attribute use to indicate whether a binary is debuggable or not.

LINKAGE_ATTRIBUTE

static val LINKAGE_ATTRIBUTE: Attribute<Linkage>

The dependency resolution attribute use to indicate which linkage a binary uses.

OPTIMIZED_ATTRIBUTE

static val OPTIMIZED_ATTRIBUTE: Attribute<Boolean>

The dependency resolution attribute use to indicate whether a binary is optimized or not.

Functions

getDebuggerExecutableFile

abstract fun getDebuggerExecutableFile(): Provider<RegularFile>

Returns the executable file to use with a debugger for this executable.

Inherited Functions

getCompileIncludePath

abstract fun getCompileIncludePath(): FileCollection

Returns the header directories to use to compile this binary. Includes the header directories of this binary plus those of its dependencies.

getCompileTask

abstract fun getCompileTask(): Provider<CppCompile>

Returns the compile task for this binary.

getCppSource

abstract fun getCppSource(): FileCollection

Returns the C++ source files of this binary.

getExecutableFile

abstract fun getExecutableFile(): Provider<RegularFile>

Returns the executable file to produce.

getInstallDirectory

abstract fun getInstallDirectory(): Provider<Directory>

Returns the installation directory.

getInstallTask

abstract fun getInstallTask(): Provider<out InstallExecutable>

Returns the install task.

getLinkLibraries

abstract fun getLinkLibraries(): FileCollection

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

getLinkTask

abstract fun getLinkTask(): Provider<out LinkExecutable>

Returns the link task for the executable.

getOutputs

abstract fun getOutputs(): FileCollection

Returns the outputs produced for this component.

getRuntimeElements

abstract fun getRuntimeElements(): Provider<Configuration>

Returns the outgoing runtime elements of this component.

getRuntimeLibraries

abstract fun getRuntimeLibraries(): FileCollection

Returns the runtime libraries required by this binary. Includes the runtime libraries of the component's dependencies.

getTargetPlatform

abstract fun getTargetPlatform(): CppPlatform

{@inheritDoc}