Exporter.cmake

Provides support for generating CMake packages from dynamic, static and header library products. More...

• List of all members, including inherited members

Properties

• configFileName : string
• packageName : string
• versionFileName : string

Detailed Description

The Exporter.cmake module contains the properties and rules to create a CMake config files from the Export item of a Product.

For instance, suppose you are creating a library. To allow exporting to CMake, you would write something like the following:

DynamicLibrary {
    name: "mylibrary"
    qbs.installPrefix: "/opt/mylibrary"
    Depends { name: "Exporter.cmake" }
    Exporter.cmake.packageName: "MyLibrary"
    property string headersInstallDir: "include"
    // ...
    Group {
        name: "API headers"
        files: ["mylib.h"]
        qbs.install: true
        qbs.installDir: headersInstallDir
    }
    Group {
        fileTagsFilter: ["Exporter.cmake.package"]
        qbs.installDir: "lib/cmake/MyLibrary"
    }
    Export {
        Depends { name: "cpp" }
        cpp.includePaths: FileInfo.joinPaths(
            exportingProduct.qbs.installRoot,
            exportingProduct.qbs.installPrefix,
            exportingProduct.headersInstallDir)
    }
}

To build against this library, from within your CMake project, you simply use find_package:

find_package(MyLibrary PATHS REQUIRED)
add_executable(Consumer main.cpp)
target_link_libraries(Consumer MyLibrary)

Relevant File Tags

Property Documentation