Export

Exports dependencies and properties to other products. More...

• List of all members, including inherited members
• Export is part of List of All Items.

Properties

• prefixMapping : var (since 1.12)

Detailed Description

An Export item can appear inside a Product item. It defines a Module with the product's name that can be depended on by other products. The properties attached to the Export item will take effect in all products that depend on the product inside which the Export item is defined. As an example, consider these two products:

Product {
    name: "A"
    Export {
        Depends { name: "cpp" }
        cpp.includePaths: exportingProduct.sourceDirectory
        cpp.defines: ["USING_" + exportingProduct.name.toUpperCase()]
    }
}

Product {
    name: "B"
    Depends { name: "A" }
}

The sources in product B will be able to use headers from product A without specifying the full path to them, because the include path has been made known to the compiler via A's Export item. Additionally, product B will be compiled with the define USING_A.

The dependent Product's modules are not exported unless explicitly specified within the Export item:

Product {
    name: "B-Exporting-A"
    Depends { name: "A" }
    Export {
        Depends { name: "A" }
    }
}

The relationship of the exported dependencies is transitive. A product C depending on a product B-Exporting-A will also get a direct dependency on A and thus inherit include paths and preprocessor macros exported by A.

Product {
    name: "C"
    Depends { name: "B-Exporting-A" }
}

Within an Export item, you can use the exportingProduct variable to refer to the product which defines the Export item. Use the importingProduct variable to refer to the product that pulls in the resulting module:

Product {
    name: "D"
    Export {
        Depends { name: "cpp" }
        cpp.includePaths: [exportingProduct.sourceDirectory, importingProduct.buildDirectory]
    }
}

Property Documentation

Export {
    Depends { name: "cpp" }
    cpp.includePaths: [exportingProduct.sourceDirectory]
    prefixMapping: [{
            prefix: exportingProduct.sourceDirectory,
            replacement: FileInfo.joinPaths(qbs.installPrefix, "include")
    }]
}

Depends FileTagger