- Qbs Manual
- How-tos
- Qbs 2.2.1

Custom Modules and Items ◦ Reference

# How-tos

This page provides concrete instructions for common scenarios.

- How do I build a Qt-based project?
- How do I make my app build against my library?
- How do I build release with debug information?
- How do I separate and install debugging symbols?
- How do I use precompiled headers?
- How do I make use of rpaths?
- How do I make sure my generated sources are getting compiled?
- How do I run my autotests?
- How do I use ccache?
- How do I create a module for a third-party library?
- How do I build against libraries that provide pkg-config files?
- How do I create application bundles and frameworks on iOS, macOS, tvOS, and watchOS?
- How do I apply C/C++ preprocessor macros to only a subset of the files in my product?
- How do I disable a compiler warning?
- How do I make the state of my Git repository available to my source files?
- How do I limit the number of concurrent jobs for the linker only?
- How do I add QML files to a project?
- How do I define a reusable Group of files that can be included in other Qbs files?
- How do I access properties of a base type?
- How do I print the value of a property?
- How do I debug Qbs scripts?
- How do I sign an application for an Apple platform?

## How do I build a Qt-based project?

First of all, your project files need to declare dependencies on Qt modules.

To build the project, you need a matching profile. The following commands set up and use a Qt-specific profile:

     $ qbs setup-qt /usr/bin/qmake qt
     $ cd my_project
     $ qbs profile:qt

If you plan to use this profile a lot, consider making it the default one:

     $ qbs config defaultProfile qt
     $ cd my_project
     $ qbs

See Managing Qt Versions for more details.

Note: These instructions are only relevant for building from the command line. If you use Qt Creator, profiles are set up automatically from the information in the Kit.

## How do I make my app build against my library?

This is achieved by introducing a dependency between the two products using the Depends item. Here is a simple, but complete example:

     Project {
         CppApplication {
             name : "the-app"
             files : [ "main.cpp" ]
             Depends { name: "the-lib" }
         }
         DynamicLibrary {
             name: "the-lib"
             Depends { name: "cpp" }
             files: [
                 "lib.cpp",
                 "lib.h",
             ]
             Export {
                 Depends { name: "cpp" }
                 cpp.includePaths: [exportingProduct.sourceDirectory]
            }
         }
     }

The product `the-lib` is a dynamic library. It expects other products to build against it, and for that purpose, it exports an include path (via an Export item), so that the source files in these products can include the library's header file.

The product `the-app` is an application that expresses its intent to link against `the-lib` by declaring a dependency on it. Now `main.cpp` can include `lib.h` (because of the exported include path) and the application binary will link against the library (because the linker rule in the cpp module considers library dependencies as inputs).

Note: In a non-trivial project, the two products would not be defined in the same file. Instead, you would put them into files of their own and use the Project.references property to pull them into the project. The product definitions would stay exactly the same. In particular, their location in the project tree is irrelevant to the relationship between them.

### Choosing Between Dynamic and Statically-built Qt Projects

To build `"the-lib"` as either a dynamic or static library, depending on how Qt was built, you can use the following code:

     Product {
         name: "the-lib"
         type: Qt.core.staticBuild ? "staticlibrary" : "dynamiclibrary"

         Depends { name: "Qt.core" }
         // ...
     }

## How do I build release with debug information?

You can simply use the `"profiling"` qbs.buildVariant:

     qbs build qbs.buildVariant:profiling

## How do I separate and install debugging symbols?

First, you need to set the cpp.debugInformation and cpp.separateDebugInformation properties to `true` or use some conditional expression in your product:

     CppApplication {
         // ...
         cpp.debugInformation: qbs.buildVariant !== "release"
         cpp.separateDebugInformation: true
     }

Now, you can install your application, dynamic library or loadable module among with its debugging symbols as follows:

     CppApplication {
         // ...
         install: true
         installDir: "bin"
         installDebugInformation: true
         debugInformationInstallDir: "bin"
     }

If you are not using convenience items, you can install debug symbols manually using the Group item. If the cpp.separateDebugInformation property is set to `true`, Qbs will create debugging symbols with the corresponding file tags `"debuginfo_app"` (for an application), `"debuginfo_dll"` (for a dynamic library), or `"debuginfo_loadablemodule"` (for a macOS plugin).

     Product {
         type: "application"
         Depends { name: "cpp" }
         cpp.debugInformation: qbs.buildVariant !== "release"
         cpp.separateDebugInformation: true
         Group {
             fileTagsFilter: cpp.separateDebugInformation ? ["debuginfo_app"] : []
             qbs.install: true
             qbs.installDir: "bin"
             qbs.installSourceBase: buildDirectory
         }
     }

If you're building a shared library, you need to use the `"debuginfo_dll"` tag instead:

     Product {
         type: "dynamic_library"
         // ...
         Group {
             fileTagsFilter: cpp.separateDebugInformation ? ["debuginfo_dll"] : []
             qbs.install: true
             qbs.installDir: "lib"
             qbs.installSourceBase: buildDirectory
         }
     }

If you're building a macOS plugin, you need to use the `"debuginfo_loadablemodule"` tag instead:

     Product {
         type: "loadablemodule"
         // ...
         Group {
             fileTagsFilter: cpp.separateDebugInformation ? ["debuginfo_loadablemodule"] : []
             qbs.install: true
             qbs.installDir: "PlugIns"
             qbs.installSourceBase: buildDirectory
         }
     }

## How do I use precompiled headers?

If you use a Group item to add a precompiled header file to a product and mark it with the relevant file tag (`c_pch_src`, `cpp_pch_src`, `objc_pch_src`, or `objcpp_pch_src`), it is used automatically.

Only one precompiled header is allowed per product and language.

For example:

     CppApplication {
         name: "the-app"
         files: ["main.cpp"]

         Group {
             files: ["precompiled-header.pch"]
             fileTags: ["cpp_pch_src"]
         }
     }

## How do I make use of rpaths?

rpath designates the run-time search path used by the dynamic linker when loading libraries on UNIX platforms. This concept does not apply to Windows.

Suppose you have a project with two dynamic library products `LibraryA` and `LibraryB` and one dependent application product. Also, `LibraryB` depends on `LibraryA`. The application is installed to the `bin` folder and the libraries are installed to the `lib` folder next to the `bin` folder. You want the application to be able to find the dependent libraries relative to its own location. This can be achieved by usage of the cpp.rpaths property.

First, you need to set cpp.rpaths in your libraries so they can find dependent libraries in the same folder where they are located. This can be done as follows:

     DynamicLibrary {
         Depends { name: "cpp" }
         Depends { name: "bundle" }
         name: "LibraryA"
         bundle.isBundle: false
         cpp.sonamePrefix: qbs.targetOS.contains("macos") ? "@rpath" : undefined
         cpp.rpaths: cpp.rpathOrigin
         cpp.cxxLanguageVersion: "c++11"
         cpp.minimumMacosVersion: "10.8"
         files: [
             "objecta.cpp",
             "objecta.h",
         ]
         install: true
         installDir: "examples/lib"
     }

We are setting cpp.rpaths to cpp.rpathOrigin which expands to `"$ORIGIN"` on Linux and to `"@loader_path"` on macOS.

On macOS you also need to set cpp.sonamePrefix to `"@rpath"` to tell the dynamic linker to use RPATHs when loading this library.

`LibraryB` looks exactly the same:

     DynamicLibrary {
         Depends { name: "cpp" }
         Depends { name: "bundle" }
         Depends { name: "LibraryA" }
         name: "LibraryB"
         bundle.isBundle: false
         cpp.cxxLanguageVersion: "c++11"
         cpp.minimumMacosVersion: "10.8"
         cpp.sonamePrefix: qbs.targetOS.contains("macos") ? "@rpath" : undefined
         cpp.rpaths: cpp.rpathOrigin
         files: [
             "objectb.cpp",
             "objectb.h",
         ]
         install: true
         installDir: "examples/lib"
     }

In a real project, it might be a good idea to move common properties to some base item and inherit it in library items.

The application item is a bit different. It sets cpp.rpaths to the `"lib"` folder which is located one level up from the `bin` folder:

     CppApplication {
         Depends { name: "bundle" }
         Depends { name: "LibraryA" }
         Depends { name: "LibraryB" }
         name: "rpaths-app"
         files: "main.cpp"
         consoleApplication: true
         bundle.isBundle: false
         cpp.rpaths: FileInfo.joinPaths(cpp.rpathOrigin, "..", "lib")
         cpp.cxxLanguageVersion: "c++11"
         cpp.minimumMacosVersion: "10.8"
         install: true
         installDir: "examples/bin"
     }

## How do I make sure my generated sources are getting compiled?

The rules in a Qbs project do not care whether its inputs are actual source files listed on the right-hand side of a files property or artifacts that were generated by another rule. For instance, the C++ compiler rule considers all input files of type "cpp", no matter how they got into the product. The following example project demonstrates this. One of its source files exists in the repository, the other one is generated at build time. Both are getting compiled the same way.

Note: Do not try to add the generated files to a `files` property. Declaring them as rule outputs is all that is needed to make Qbs know about them.

     import qbs.TextFile
     CppApplication {
         files: ["impl.cpp", "impl.h"]
         cpp.includePaths: sourceDirectory
         Rule {
             multiplex: true
             Artifact { filePath: "main.cpp"; fileTags: "cpp" }
             prepare: {
                 var cmd = new JavaScriptCommand();
                 cmd.description = "generating " + output.fileName;
                 cmd.sourceCode = function() {
                     var f = new TextFile(output.filePath, TextFile.WriteOnly);
                     f.writeLine("#include <impl.h>");
                     f.writeLine("int main()");
                     f.writeLine("{");
                     f.writeLine("    return functionFromImpl();");
                     f.writeLine("}");
                     f.close();
                 };
                 return cmd;
             }
         }
     }

## How do I run my autotests?

There are two simple things you need to do in your project. Firstly, you mark your test executables as such. This is done by adding the tag `"autotest"` to the product type:

     CppApplication {
         name: "test1"
         type: base.concat("autotest")
         // ...
     }

The second step is to instantiate an AutotestRunner product in your project:

     Project {
         // ...
         AutotestRunner { name: "run_my_tests" }
     }

Building an AutotestRunner product does not produce artifacts, but triggers execution of all applications whose products are tagged as autotests:

     $ qbs -p run_my_tests
     test1: PASS
     test2: PASS
     test3: FAIL
     ...

See the AutotestRunner documentation for how to fine-tune the behavior.

## How do I use ccache?

ccache is a popular C/C++ compiler cache on Unix to speed up compiling the same content multiple times.

Qbs excels at tracking dependencies and avoiding needless recompilations, so for linear development of one project and configuration using ccache has little benefit. But if you switch between revisions of a project, or build the same project with different configurations, a global cache like ccache can speed up compilations significantly.

ccache can be used by setting up symbolic links to compiler executables (such as `g++`, `gcc`) in the file system. In this setup, the use of ccache is transparent to Qbs. If you prefer to call ccache explicitly, you should set cpp.compilerWrapper to `ccache`.

Note: Using precompiled headers might prevent ccache from actually using cached results. To work around this, you can set `sloppiness=pch_defines,time_macros` in your local ccache options. See the ccache documentation about precompiled headers for further details.

## How do I create a module for a third-party library?

If you have pre-built binary files in your source tree, you can create modules for them and then introduce dependencies between your project and the modules to pull in the functionality of a third-party library.

Create the following folder structure to store the module files:

     $projectroot/modules/ThirdParty

Then create a file in the directory that specifies the module properties for each supported toolchain. The filename must have the `.qbs` extension. The module will be pulled in if a product declares a dependency on it.

In the following example, `lib1.dylib` is a multi-architecture library containing both 32-bit and 64-bit code.

     ---ThirdParty.qbs---

     Module {
         Depends { name: "cpp" }
         cpp.includePaths: ["/somewhere/include"]
         Properties {
             condition: qbs.targetOS.includes("android")
             cpp.dynamicLibraries: ["/somewhere/android/" + Android.ndk.abi + "/lib1.so"]
         }
         Properties {
             condition: qbs.targetOS.includes("macos")
             cpp.dynamicLibraries: ["/somewhere/macos/lib1.dylib"]
         }
         Properties {
             condition: qbs.targetOS.includes("windows") && qbs.architecture === "x86"
             cpp.dynamicLibraries: ["/somewhere/windows_x86/lib1.lib"]
         }
         Properties {
             condition: qbs.targetOS.includes("windows") && qbs.architecture === "x86_64"
             cpp.dynamicLibraries: ["/somewhere/windows_x86_64/lib1.lib"]
         }
     }

Finally, declare dependencies on `ThirdParty` in your project:

     CppApplication {
         name: "the-app"
         files: ["main.cpp"]
         Depends { name: "ThirdParty" }
     }

## How do I create application bundles and frameworks on iOS, macOS, tvOS, and watchOS?

Creating an application bundle or framework is achieved by introducing a dependency on the bundle module and setting the bundle.isBundle property to `true`.

Here is a simple example for an application:

     Application {
         Depends { name: "cpp" }
         Depends { name: "bundle" }
         bundle.isBundle: true
         name: "the-app"
         files: ["main.cpp"]
     }

and for a framework:

     DynamicLibrary {
         Depends { name: "cpp" }
         Depends { name: "bundle" }
         bundle.isBundle: true
         name: "the-lib"
         files: ["lib.cpp", "lib.h"]
     }

Qbs also supports building static frameworks. You can create one by replacing the DynamicLibrary item with a StaticLibrary item in the example above.

Note: When using the Application item (or convenience items, such as CppApplication, DynamicLibrary, and StaticLibrary), your products will be built as bundles on Apple platforms by default (this behavior is subject to change in a future release).

To explicitly control whether your product is built as a bundle, set the `bundle.isBundle` property. Setting the consoleApplication property of your product will also influence whether your product is built as a bundle.

Building your application against your framework is the same as linking a normal dynamic or static library; see the How do I make my app build against my library? section for an example.

## How do I build against libraries that provide pkg-config files?

Just add a Depends item that matches the name of the pkg-config module, and Qbs will automatically employ pkg-config to find the headers and libraries if no matching Qbs module can be found. For instance, to build against the OpenSSL library, you would write this:

     Depends { name: "openssl" }

That's it. The pkg-config behavior can be fine-tuned via the pkgconfig module, but normally you will not need to pull it in explicitly.

Internally, this functionality is implemented via Module Providers

## How do I apply C/C++ preprocessor macros to only a subset of the files in my product?

Use a Group item to define a subset of project files. To add macros within the group, you need to use the `outer.concat` property, because you are adding macros to those specified in the outer scope.

In the following example, `MACRO_EVERYWHERE` is defined for all files in the Product unless a Group overrides the macro, whereas `MACRO_GROUP` is only defined for `groupFile.cpp`.

     Product {
         Depends { name: "cpp" }
         cpp.defines: ["MACRO_EVERYWHERE"]
         Group {
             cpp.defines: outer.concat("MACRO_GROUP")
             files: "groupFile.cpp"
         }
     }

The `cpp.defines` statements inside a `Group` only apply to the files in that `Group`, and therefore you cannot use a `Group` to include a bunch of files and globally visible macros. The macros must be specified in a Properties item at the same level as the `Group` if they need to be visible to files outside the `Group`:

     Product {
         Depends { name: "cpp" }
         Group {
             condition: project.supportMyFeature
             files: "myFile.cpp"
         }

         property stringList commonDefines: ["ONE", "TWO"]

         Properties {
             condition: project.supportMyFeature
             cpp.defines: commonDefines.concat("MYFEATURE_SUPPORTED")
         }
     }

## How do I disable a compiler warning?

You can use the cpp.commonCompilerFlags property to pass flags to the compiler. For example, to disable deprecation warnings:

     CppApplication {
         // ...

         readonly property bool isMsvc: qbs.toolchain.includes("msvc")

         cpp.commonCompilerFlags: isMsvc ? "/wd4996" : "-Wno-deprecated-declarations"
     }

It is also possible to disable all warnings at once by setting the cpp.warningLevel property to `"none"`. Usually this approach is discouraged, but it can be useful in some cases, such as when compiling third party code:

     Group {
         cpp.warningLevel: "none"

         files: [
             "3rdparty.h",
             "3rdparty.cpp"
         ]
     }

## How do I make the state of my Git repository available to my source files?

Add a dependency to the vcs module to your product:

     CppApplication {
         // ...
         Depends { name: "vcs" }
         // ...
     }

Your source files will now have access to a macro whose value is a string representing the current Git or Subversion HEAD:

     #include <vcs-repo-state.h>
     #include <iostream>

     int main()
     {
         std::cout << "I was built from " << VCS_REPO_STATE << std::endl;
     }

This value is also available via the vcs.repoState property.

## How do I limit the number of concurrent jobs for the linker only?

While it is usually desirable to run as many compiler jobs as there are CPU cores, the same is not true for linker jobs. The reason is that linkers are typically I/O bound rather than CPU bound. When building large libraries, they also tend to use up enormous amounts of memory. Therefore, we'd like to make sure that only a few linkers are running at the same time without limiting other types of jobs. In Qbs, this is achieved via job pools. There are several ways to make use of them.

Firstly, you can provide a limit via the command line:

     $ qbs --job-limits linker:4

The above call instructs Qbs to run at most four linker instances at the same time, while leaving the general number of concurrent jobs at the default value, which is derived from the number of CPU cores. The `linker` string on the command line refers to the job pool of the same name, which the cpp module assigns to all its commands that invoke a linker.

Secondly, you can set a limit via the settings, either generally or for a specific profile:

     $ qbs config preferences.jobLimit.linker 4
     $ qbs config profiles.myprofile.preferences.jobLimit.linker 2

And finally, you can also set the limit per project or per product, using a JobLimit item:

     Product {
         name: "my_huge_library"
         JobLimit {
             jobPool: "linker"
             jobCount: 1
         }
         // ...
     }

The above construct ensures that this specific library is never linked at the same time as any other binary in the project.

Job limits set on the command line override those from the settings, which in turn override the ones defined within a project. Use the `--enforce-project-job-limits` option to give the job limits defined via `JobLimit` items maximum precedence.

## How do I add QML files to a project?

The simplest way to add QML files to a project is to add them to a Qt resource file:

     QtGuiApplication {
         // ...

         files: "main.cpp"

         Group {
             prefix: "qml/"
             files: ["main.qml", "HomePage.qml"]
             fileTags: ["qt.qml.qml", "qt.core.resource_data"]
         }
     }

In the example above, we declare each QML file as having the "qt.core.resource_data" file tag. This ensures that it is added to a generated resource file.

## How do I define a reusable Group of files that can be included in other Qbs files?

Suppose you have an application and tests for that application, and that the project is structured in the following way:

     ├── app
     │   ├── app.qbs
     │   ├── ...
     │   └── qml
     │       └── ui
     │           ├── AboutPopup.qml
     │           └── ...
     ├── my-project.qbs
     └── tests
         ├── tst_app.cpp
         ├── ...
         └── tests.qbs

Both projects need access to the QML files used by the application. To demonstrate how this can be done, we'll create a file named `qml-ui.qbs` and put it in the `app/qml/ui` directory:

     Group {
         prefix: path + "/"
         fileTags: ["qt.qml.qml", "qt.core.resource_data"]
         files: [
             "AboutPopup.qml",
             // ...
         ]
     }

This Group is a variation of the one in the section above.

If no prefix is specified, the file names listed in the `files` property are resolved relative to the importing product's (e.g. `app.qbs`) directory. For that reason, we set the prefix to inform Qbs that the file names should be resolved relative to the imported item instead: `qml-ui.qbs`. Conveniently, this also means that we don't need to specify the path prefix for each file.

The application can then import the file like so:

     import "qml/ui/qml-ui.qbs" as QmlUiFiles

     QtGuiApplication {
         // ...

         files: "main.cpp"

         QmlUiFiles {}
     }

The tests can use a relative path to import the file:

     import "../app/qml/ui/qml-ui.qbs" as QmlUiFiles

     QtGuiApplication {
         // ...

         files: "tst_app.cpp"

         QmlUiFiles {}
     }

## How do I access properties of a base type?

You can use the base property. For example, to append to a list of files that come from the base type, you can use `base.concat()`:

     // TestBase.qbs

     QtGuiApplication {
         files: [
             "TestCaseBase.h",
             "TestCaseBase.cpp"
         ]
     }

     // tst_stuff.qbs
     TestBase {
         files: base.concat(["tst_stuff.cpp"])
     }

See Special Property Values for more details.

## How do I print the value of a property?

Use the console API. For example, suppose your project is not built the way you expect it to be, and you suspect that `qbs.targetOS` has the wrong value:

     readonly property bool unix: qbs.targetOS.includes("unix")

To find out the value of `qbs.targetOS`, use `console.info()`:

     readonly property bool unix: {
         console.info("qbs.targetOS: " + qbs.targetOS)
         return qbs.targetOS.includes("unix")
     }

It is also possible to throw an exception with the text saying what is wrong - this might be useful if the property contains invalid or unsupported value:

     readonly property bool unix: {
         if (qbs.targetOS.includes("darwin"))
             throw "Apple platforms are not supported";
         return qbs.targetOS.includes("unix")
     }

## How do I debug Qbs scripts?

To debug the value of a specific property, see the How do I print the value of a property section.

Similar debugging techniques could be used within Rules or `.js` files.

It is also possible to increase Qbs' logging level using the `--more-verbose` (`-v`) option of the `qbs build` command:

     qbs build -v config:release

Qbs uses the Qt Categorized Logging system which allows to configure logging categories in multiple ways. For example, to enable debug logging for the `moduleloader` category, use the following command:

     QT_LOGGING_RULES="qbs.moduleloader.debug=true" qbs resolve

To list all the files in the project directory and show whether they are known to qbs in the respective configuration, use the `qbs status` command:

     qbs status config:release

## How do I sign an application for an Apple platform?

To sign an application for an Apple platform, you need to use the codesign module.

     Depends { name: "codesign" }

Several properties should be set to do signing as shown below.

Make sure that bundle and team indentifiers match the one used for signing:

     bundle.identifierPrefix: "com.johndoe"
     codesign.teamIdentifier: "John Doe"

It is also possible to use an ID of the team identifier instead of a name:

     codesign.teamIdentifier: "1234ABCDEF"

Qbs will then try to find the matching signing identity and provisioning profile based on codesign.signingType.

It is also possible to specify codesign.signingIdentity manually:

     codesign.signingIdentity: "Apple Development: johndoe@apple.com (ABCDEF1234)"

It is also possible to use an ID of the signing identity instead of a name:

     codesign.signingIdentity: "ABCDEF1234567890ABCDEF1234567890ABCDEF12"

If Qbs cannot find the suitable provisioning profile, you can specify it manually as well:

     codesign.provisioningProfile: "abcdef12-1234-5678-1111-abcdef123456"

Custom Modules and Items ◦ Reference