gradle/org.gradle.language.cpp/CppSourceSet

CppSourceSet

interface ~~CppSourceSet~~ : HeaderExportingSourceSet, LanguageSourceSet, DependentSourceSet(source)

Deprecated

The Gradle software model is deprecated and will be removed in Gradle 10. Use the new component model (e.g. cpp-application, cpp-library, swift-application, swift-library, xctest) instead.

A set of C++ source files.

A C++ source set contains a set of source files, together with an optional set of exported header files.

plugins {
    id 'cpp'
}

model {
    components {
        main(NativeLibrarySpec) {
            sources {
                cpp {
                    source {
                        srcDirs "src/main/cpp", "src/shared/c++"
                        include "**/*.cpp"
                    }
                    exportedHeaders {
                        srcDirs "src/main/include", "src/shared/include"
                    }
                }
            }
        }
    }
}

Since

1.9

Functions

abstract fun builtBy(tasks: Array<Any>)

Adds tasks required to build this component.

abstract fun generatedBy(generatorTask: Task)

Generated.

getBuildDependencies

abstract fun getBuildDependencies(): TaskDependency

Returns a dependency which contains the tasks which build this artifact.

@Nullable

abstract fun getBuildTask(): @Nullable Task

Returns the task responsible for building this component.

abstract fun getDisplayName(): String

Returns a human-consumable display name for this element.

getExportedHeaders

abstract fun getExportedHeaders(): SourceDirectorySet

The headers as a directory set.

getImplicitHeaders

abstract fun getImplicitHeaders(): SourceDirectorySet

The headers that are private to this source set and implicitly available.

abstract fun getLibs(): Collection<out Any>

The libraries that this source set requires.

abstract fun getName(): String

Returns the name of this element.

@Nullable

abstract fun getParentName(): @Nullable String

Returns the parent name.

getPreCompiledHeader

abstract fun getPreCompiledHeader(): String

Returns the pre-compiled header configured for this source set.

abstract fun getProjectPath(): String

The path to the project containing this component.

abstract fun getSource(): SourceDirectorySet

The source files.

hasBuildDependencies

abstract fun hasBuildDependencies(): Boolean

Returns whether build dependencies.

abstract fun lib(library: Any)

Adds a library that this source set requires.

abstract fun setBuildTask(@Nullable buildTask: @Nullable Task)

Specifies the task responsible for building this component.

setPreCompiledHeader

abstract fun setPreCompiledHeader(header: String)

Sets the pre-compiled header to be used when compiling sources in this source set.