Martchus
/
cpp-utilities
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
cpp-utilities/doc/buildvariables.md

15 KiB
Raw Blame History

Build system

\brief Documents variables to control the build system and provided CMake modules

Variables passable as CMake arguments

Useful variables provided by CMake itself

  • CMAKE_INSTALL_PREFIX=path: specifies the final install prefix (temporary install prefix is set via make argument DESTDIR=path)
  • CMAKE_BUILD_TYPE=Release/Debug: specifies whether to do a debug or a release build
  • CMAKE_SKIP_BUILD_RPATH=OFF: ensures the rpath is set in the build tree
  • CMAKE_INSTALL_RPATH=rpath: sets the rpath used when installing
  • CMAKE_CXX_FLAGS: sets flags to be passed to the C++ compiler

Custom variables

The following variables are read by the CMake modules provided by c++utilities and qtutilities.

None of these are enabled or set by default, unless stated otherwise.

  • LIB_SUFFIX=suffix: suffix for library install directory
  • LIB_SUFFIX_32=suffix: suffix for library install directory
    • used when building for 32-bit platforms
    • overrides general LIB_SUFFIX when building for 32-bit platforms
  • LIB_SUFFIX_64=suffix: suffix for library install directory
    • used when building for 64-bit platforms
    • overrides general LIB_SUFFIX when building for 64-bit platforms
  • ENABLE_STATIC_LIBS=ON/OFF: enables building static libs
  • DISABLE_SHARED_LIBS=ON/OFF: disables building shared libs
  • STATIC_LINKAGE=ON/OFF: enables linking applications preferably against static libraries
    • by default dynamic libraries are preferred
    • only affect building applications
  • STATIC_LIBRARY_LINKAGE=ON/OFF: enables linking dynamic libraries preferably against static libraries
    • by default linking against dynamic libraries is preferred
    • only affects building dynamic libraries (static libraries are just archives of objects and hence not linked against their dependencies when being built)
    • note that static libraries are always preferred to provide the dependency of another static library
      • eg. linking against static c++utilities requires also linking against its dependency iconv; the static version of iconv is preferred
      • this behaviour has actually nothing to do with STATIC_LIBRARY_LINKAGE and can currently not be controlled
  • SHELL_COMPLETION_ENABLED=ON/OFF: enables shell completion in general (enabled by default)
  • BASH_COMPLETION_ENABLED=ON/OFF: enables Bash completion (enabled by default)
  • LOGGING_ENABLED=ON/OFF: enables further loggin in some applications
  • FORCE_OLD_ABI=ON/OFF: forces use of old C++ ABI
    • sets _GLIBCXX_USE_CXX11_ABI=0
    • only relevant when using libstdc++
  • EXCLUDE_TESTS_FROM_ALL=ON/OFF: excludes tests from the all target (enabled by default)
  • APPEND_GIT_REVISION=ON/OFF: whether the build script should attempt to append the Git revision and the latest commit ID to the version
    • displayed via --help
    • enabled by default but has no effect when the source directory is no Git checkout or Git is not installed
  • CLANG_FORMAT_ENABLED=ON/OFF: enables tidy target for code formatting via clang-format
    • can be made unavailable by setting META_NO_TIDY in the project file
    • only available if format rules are available
    • also enables tidy check executed via check target
  • CLANG_TIDY_ENABLED=ON/OFF: enables target static-check for static code analysis with clang-tidy
    • can be made unavailable by setting META_NO_STATIC_ANALYSIS in the project file
  • CLANG_SOURCE_BASED_COVERAGE_ENABLED=ON/OFF: enables coverage target to determine source-based test coverage using Clang/llvm
    • only available when building with Clang under UNIX
    • coverage report is stored in build directory
  • ENABLE_INSTALL_TARGETS=ON/OFF: enables creation of install targets (enabled by default)
  • ENABLE_ESCAPE_CODES_BY_DEAULT: enables use of escape codes for formatted output by default
    • enabled by default
    • see ApplicationUtilities::NoColorArgument and EscapeCodes::enabled
    • has to be set when building c++utilities; projects using that build of c++utilities will then use this default
  • USE_NATIVE_FILE_BUFFER=ON/OFF: use native functions to open file streams
    • Allows opening files which have non-ASCII in the path under Windows.
    • Allows to use native file descriptors which is required to open files from URLs provided by Android's Storage Access Framework.
    • Changing this option alters the ABI of c++utilities and other libraries exposing that ABI (eg. tagparser and passwordfile).
    • This feature is implemented in c++utilities, so the option must be specified when building c++utilities. Specifying it only when building eg. tagparser has no effect.

Variables for specifying location of 3rd party dependencies

The build script tries to find the required dependencies at standard loctions using the CMake functions find_library and find_package. The behaviour of those functions can be controlled by setting some variables, eg. using a toolchain file. Checkout the CMake documentation for this.

If the detection does not work as expected or a library from a non-standard location should be used, the following variables can be used to specify the location of libraries and include directories directly:

  • dependency_DYNAMIC_LIB: specifies the locations of the dynamic libraries for dependency
  • dependency_STATIC_LIB: specifies the locations of the static libraries for dependency
  • dependency_DYNAMIC_INCLUDE_DIR: specifies the locations of the additional include directories required for using the dynamic version of the dependency
  • dependency_STATIC_INCLUDE_DIR: specifies the locations of the additional include directories required for using the static version of the dependency

Note about Qt: Qt modules are always configured using the CMake packages via find_package. So using the variables described above to specify a custom location does not work. Instead, the variables CMAKE_FIND_ROOT_PATH or CMAKE_PREFIX_PATH can be used to specify the install prefix of the Qt build to use. Set QT_LINKAGE to STATIC if it is a static build of Qt.

Examples

Example of passing location of dynamic iconv and zlib to CMake:

/opt/osxcross/bin/x86_64-apple-darwin15-cmake \
    -Diconv_DYNAMIC_LIB:FILEPATH=/opt/osxcross/SDK/MacOSX10.11.sdk/usr/lib/libiconv.2.tbd \
    -Diconv_DYNAMIC_INCLUDE_DIR:PATH=/opt/osxcross/SDK/MacOSX10.11.sdk/usr/include \
    -Dz_DYNAMIC_LIB:FILEPATH=/opt/osxcross/SDK/MacOSX10.11.sdk/usr/lib/libz.1.tbd \
    -Dz_DYNAMIC_INCLUDE_DIR:PATH=/opt/osxcross/SDK/MacOSX10.11.sdk/usr/include \
    ...

Here's an example of passing the location of the Android SDK/NDK to compile for Android. This time the iconv library is located by specifying its install prefix via CMAKE_FIND_ROOT_PATH. The include directories are not automatically added for that library, so this must still be done manually:

_android_arch=arm64-v8a
cmake \
    -DCMAKE_SYSTEM_NAME=Android \
    -DCMAKE_SYSTEM_VERSION=21 \
    -DCMAKE_ANDROID_ARCH_ABI=$_android_arch \
    -DCMAKE_ANDROID_NDK=/opt/android-ndk \
    -DCMAKE_ANDROID_SDK=/opt/android-sdk \
    -DCMAKE_ANDROID_STL_TYPE=gnustl_shared \
    -DCMAKE_INSTALL_PREFIX=/opt/android-libs/$_android_arch \
    -DCMAKE_FIND_ROOT_PATH="/opt/android-ndk/sysroot;/opt/android-libs/$_android_arch" \
    -Diconv_DYNAMIC_INCLUDE_DIR="/opt/android-libs/$_android_arch/include" \
    -Diconv_STATIC_INCLUDE_DIR="/opt/android-libs/$_android_arch/include" \
    ...

Windows specific

  • FORCE_UTF8_CODEPAGE=ON/OFF: forces use of UTF-8 codepage in terminal
  • WINDOWS_RESOURCES_ENABLED=ON/OFF: enables creating resources for application meta data and icon (enabled by default)

MacOS specific

  • BUNDLE_INSTALL_DESTINATION=/some/path: specifies the install destination for application bundles; if not specified, the default bin directory is used

Qt specific

  • WIDGETS_GUI=ON/OFF: enables Qt Widgets GUI for projects where it is available and optional
  • QUICK_GUI=ON/OFF: enables Qt Quick GUI for projects where it is available and optional
  • BUILTIN_TRANSLATIONS=ON/OFF: enables built-in translations in applications
  • BUILTIN_ICON_THEMES=breeze;breeze-dark;...: specifies icon themes to built-in
  • BUILTIN_ICON_THEMES_IN_LIBRARIES=breeze;breeze-dark;...: same as above but also affects libraries
  • SVG_SUPPORT=ON/OFF: enables linking against the static SVG image format plugin
    • enabled by default
    • requires the Qt Svg module
    • only relevant when using static Qt
  • SVG_ICON_SUPPORT=ON/OFF: enables linking against the static SVG icon engine plugin provided by the Qt Svg module
    • enabled by default
    • requires the Qt Svg module
    • only relevant when using static Qt
    • required to use Breeze icon theme (or any other SVG icon theme)
  • IMAGE_FORMAT_SUPPORT: enables linking against the specified static image format plugins
    • comma-separated list
    • by default set to "Gif;ICO;Jpeg", so support for Gif, ICO and Jpeg is enabled by default
    • note that PNG support is not provided via a plugin, so it should be always available and not be affected by this option
    • further image formats require building the plugins contained by the additional qtimageformats repository
    • only relevant when using static Qt
  • WEBVIEW_PROVIDER=auto/webkit/webengine/none: specifies the Qt module to use for the web view
  • JS_PROVIDER=auto/script/qml/none: specifies the Qt module to use for the JavaScript engine
  • QT_LINKAGE=AUTO_LINKAGE/STATIC/SHARED: specifies whether to use static or shared version of Qt (only works with Qt packages provided in the AUR)
  • ADDITIONAL_QT_MODULES=Network;Concurrent;...: specifies additional Qt modules to link against (only use for modules which can not be added automatically)

Variables to be set in project file

The following variables are read by the CMake modules provided by c++utilities and qtutilities.

Meta-data and overall project configuration

  • META_PROJECT_NAME=name: specifies the project name which is used as the application/library name, mustn't contain spaces
  • META_APP_NAME=The Name: specifies a more readible version of the project name used for instance in about dialog and desktop file
  • META_APP_AUTHOR: specifies the author shown in for instance in about dialog
  • META_APP_DESCRIPTION: specifies a description shown for instance in about dialog and desktop file
  • META_GENERIC_NAME: specifies a generic name for the desktop file
  • META_VERSION_MAJOR/MINOR/PATCH=number: specifies the application/library version, default is 0
  • META_PROJECT_TYPE=application/library/plugin/qtplugin: specifies whether to build an application, a library or a plugin
  • META_CXX_STANDARD=11/14/..: specifies the C++ version, default is 14
  • META_NO_TIDY: disables availability of enabling formatting via CLANG_FORMAT_ENABLED for this project
  • META_NO_INSTALL_TARGETS: the project is not meant to be installed, eg. private test helper; prevents creation of install targets
  • META_ADD_DEFAULT_CPP_UNIT_TEST_APPLICATION: implicitely add a source file with a main()-entry point to test target for running CppUnit test cases

Files

  • HEADER_FILES/SRC_FILES: specifies C++ header/source files
  • TEST_HEADER_FILES/TEST_SRC_FILES: specifies C++ header/source files of the tests
  • TS_FILES: specifies Qt translations
  • RES_FILES: specifies Qt resource files
  • DBUS_FILES: specifies files for Qt DBus
  • WIDGETS_HEADER_FILES/WIDGETS_SRC_FILES: specifies C++ header/source files only required for Qt Widgets GUI
  • QML_HEADER_FILES/QML_SRC_FILES/QML_RES_FILES: specifies C++ header/source files and Qt resouce files only required for Qt Quick GUI
  • DOC_FILES: additional markdown files to be inlcuded in the documentation created via Doxygen; the first file is used as the main page
  • DOC_ONLY_FILES: specifies documentation-only files
  • REQUIRED_ICONS: names of the icons required by the application and the used libraries (can be generated with findicons)
  • CMAKE_MODULE_FILES/CMAKE_TEMPLATE_FILES: specifies CMake modules/templates provides by the project; those files are installed so they can be used by other projects

Additional build variables

  • META_PRIVATE/PUBLIC_COMPILE_DEFINITIONS: specifies private/public compile definitions
  • LIBRARIES: specifies libraries to link against
  • META_PUBLIC_QT_MODULES: specifies Qt modules used in the public library interface
  • META_PUBLIC_SHARED_LIB_DEPENDS: specifies shared libraries used in the public library interface
  • META_PUBLIC_STATIC_LIB_DEPENDS: specifies static libraries used in the public library interface

Provided modules

c++utilities and qtutilities provide CMake modules to reduce boilerplate code in the CMake files of my projects. Those modules implement the functionality controlled by the variables documented above. Most important modules are:

  • BaseConfig: does basic configuration, reads most of the META-variables
  • QtConfig: does basic Qt-related configuration, reads most of the Qt-specific variables documented above
  • QtGuiConfig: does Qt-related configuration for building a Qt Widgets or Qt Quick based GUI application/library
    • must be included before QtConfig
  • WebViewProviderConfig: configures the webview provider
    • used by Tag Editor and Syncthing Tray to select between Qt WebEngine, Qt WebKit or disabling the built-in webview
  • LibraryTarget: does further configuration for building dynamic and static libraries and plugins; META_PROJECT_TYPE can be left empty or set explicitely to library
  • AppTarget: does further configuration for building an application; META_PROJECT_TYPE must be set to application
  • ShellCompletion: enables shell completion
    • only works when using the argument parser provided by the ApplicationUtilities::ArgumentParser class of course
  • TestTarget: adds the test target check
    • check target is not required by target all
    • test target uses files specified in TEST_HEADER_FILES/TEST_SRC_FILES variables
    • test target will automatically link against cppunit which is the test framework used by all my projects; set META_NO_CPP_UNIT=OFF in the project file to prevent this
  • AndroidApk: adds a target to create an APK package for Android using androiddeployqt
  • Doxygen: adds a target to generate documentation using Doxygen
  • WindowsResources: handles creation of Windows resources to set application meta data and icon, ignored on other platforms
  • ConfigHeader: generates resources/config.h, must be included as the last module (when all configuration is done)

Since those modules make use of the variables explained above, the modules must be included after setting those variables. The inclusion order of the modules matters as well.

For an example, checkout the project file of c++utilities itself. The project files of Syncthing Tray should cover everything (library, plugin, application, tests, desktop file, Qt resources and translations, ...).