gradle/org.gradle.language.cpp/CppLibrary

CppLibrary

interface CppLibrary : ProductionCppComponent(source)

Configuration for a C++ library, defining the source files and header directories that make up the library plus other settings.

An instance of this type is added as a project extension by the C++ library plugin.

Since

4.2

Functions

getApiDependencies

abstract fun getApiDependencies(): Configuration

Returns the API dependencies of this library.

getBaseName

abstract fun getBaseName(): Property<String>

Specifies the base name for this component.

getBinaries

abstract fun getBinaries(): BinaryCollection<out SoftwareComponent>

Returns the binaries of this component.

abstract fun getBinaries(): BinaryCollection<out CppBinary>

Returns the binaries for this library.

getCppSource

abstract fun getCppSource(): FileCollection

Returns the C++ source files of this component, as defined in getSource.

getDependencies

abstract fun getDependencies(): LibraryDependencies

Returns the dependencies of this library.

getDevelopmentBinary

abstract fun getDevelopmentBinary(): Provider<out SoftwareComponent>

abstract fun getDevelopmentBinary(): Provider<out CppBinary>

Returns the binary of the component to use as the default for development.

getHeaderFiles

abstract fun getHeaderFiles(): FileTree

Returns all header files of this component.

getImplementationDependencies

abstract fun getImplementationDependencies(): Configuration

Returns the implementation dependencies of this component.

getLinkage

abstract fun getLinkage(): SetProperty<Linkage>

Returns the list of linkage of this library.

getName

abstract fun getName(): String

The object's name.

getPrivateHeaderDirs

abstract fun getPrivateHeaderDirs(): FileCollection

Returns the private header include directories of this component, as defined in getPrivateHeaders.

getPrivateHeaders

abstract fun getPrivateHeaders(): ConfigurableFileCollection

Defines the private header file directories of this library.

getPublicHeaderDirs

abstract fun getPublicHeaderDirs(): FileCollection

Returns the public header file directories of this component, as defined in getPublicHeaders.

getPublicHeaderFiles

abstract fun getPublicHeaderFiles(): FileTree

Returns public header files of this component.

getPublicHeaders

abstract fun getPublicHeaders(): ConfigurableFileCollection

Defines the public header file directories of this library.

getSource

abstract fun getSource(): ConfigurableFileCollection

Defines the source files or directories of this component.

getTargetMachines

abstract fun getTargetMachines(): SetProperty<TargetMachine>

Specifies the target machines this component should be built for.

privateHeaders

abstract fun privateHeaders(action: Action<in ConfigurableFileCollection>)

Configures the private header directories for this component.

publicHeaders

abstract fun publicHeaders(action: Action<in ConfigurableFileCollection>)

Configures the public header directories for this component.

source

abstract fun source(action: Action<in ConfigurableFileCollection>)

Configures the source files or directories for this component.