gradle/org.gradle.language.cpp/CppSharedLibrary

CppSharedLibrary

interface CppSharedLibrary : CppBinary, ComponentWithSharedLibrary, ComponentWithLinkUsage, ComponentWithRuntimeUsage, ComponentWithOutputs, PublishableComponent(source)

A shared library built from C++ source.

Since

4.2

Properties

DEBUGGABLE_ATTRIBUTE

val DEBUGGABLE_ATTRIBUTE: Attribute<Boolean>

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

LINKAGE_ATTRIBUTE

val LINKAGE_ATTRIBUTE: Attribute<Linkage>

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

OPTIMIZED_ATTRIBUTE

val OPTIMIZED_ATTRIBUTE: Attribute<Boolean>

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

Functions

getBaseName

abstract fun getBaseName(): Provider<String>

Returns the base name of this component.

getCompileIncludePath

abstract fun getCompileIncludePath(): FileCollection

Returns the header directories to use to compile this binary.

getCompileTask

abstract fun getCompileTask(): Provider<CppCompile>

Returns the compile task for this binary.

getCoordinates

abstract fun getCoordinates(): ModuleVersionIdentifier

The publication coordinates for this component.

getCppSource

abstract fun getCppSource(): FileCollection

Returns the C++ source files of this binary.

getDependencies

abstract fun getDependencies(): ComponentDependencies

Returns the dependencies of this component.

getLinkElements

abstract fun getLinkElements(): Provider<Configuration>

Returns the outgoing link elements of this component.

getLinkFile

abstract fun getLinkFile(): Provider<RegularFile>

Returns the link file of this component.

getLinkFileProducer

abstract fun getLinkFileProducer(): Provider<out Task>

Returns the task that should be run to produce the link file of this component.

getLinkLibraries

abstract fun getLinkLibraries(): FileCollection

Returns the link libraries to use to link this binary.

getLinkTask

abstract fun getLinkTask(): Provider<out LinkSharedLibrary>

Returns the link task for the shared library.

getName

abstract fun getName(): String

The object's name.

getObjects

abstract fun getObjects(): FileCollection

Returns the object files created for this component.

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.

getRuntimeFile

abstract fun getRuntimeFile(): Provider<RegularFile>

Returns the runtime file of this component.

getRuntimeLibraries

abstract fun getRuntimeLibraries(): FileCollection

Returns the runtime libraries required by this binary.

getTargetMachine

abstract fun getTargetMachine(): TargetMachine

Returns the target machine for this component.

getTargetPlatform

abstract fun getTargetPlatform(): CppPlatform

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.