org.gradle.language.cpp.CppLibrary Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation

Gradle 6.9.1 API redistribution.

There is a newer version: 8.11.1

/*
 * Copyright 2017 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.gradle.language.cpp;

import org.gradle.api.Action;
import org.gradle.api.Incubating;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.file.ConfigurableFileCollection;
import org.gradle.api.file.FileCollection;
import org.gradle.api.file.FileTree;
import org.gradle.api.provider.SetProperty;
import org.gradle.language.LibraryDependencies;
import org.gradle.nativeplatform.Linkage;

/**
 * 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
 */
@Incubating
public interface CppLibrary extends ProductionCppComponent {
    /**
     * Defines the public header file directories of this library.
     *
     * When this collection is empty, the directory {@code src/main/public} is used by default.
     */
    ConfigurableFileCollection getPublicHeaders();

    /**
     * Configures the public header directories for this component.
     */
    void publicHeaders(Action action);

    /**
     * Returns the public header file directories of this component, as defined in {@link #getPublicHeaders()}.
     */
    FileCollection getPublicHeaderDirs();

    /**
     * Returns public header files of this component.
     *
     * @since 4.3
     */
    FileTree getPublicHeaderFiles();

    /**
     * Returns the dependencies of this library.
     *
     * @since 4.6
     */
    @Override
    LibraryDependencies getDependencies();

    /**
     * Returns the API dependencies of this library.
     */
    Configuration getApiDependencies();

    /**
     * Returns the list of linkage of this library.
     *
     * @since 4.5
     */
    SetProperty getLinkage();
}