cmodule

cmodule - non-intrusive CMake dependency management.

Normally CMake’s find_package looks for packages installed on host system (and compiled for host system). When using cmodule, find_package downloads packages and compiles them for each target independently, using current CMake toolchain. This, among other things, allows using C/C++ libraries (like boost) when cross-compiling for Android, iOS, WebAssembly (Emscripten), etc. Downloaded and unpacked sources are shared between targets, while binaries are compiled for each target independently.

CMake integration

After initializing cmodule, regular find_package calls will work in top level CMake project and all subprojects:

include(FetchContent)
FetchContent_Declare(
  cmodule
  URL "https://github.com/scapix-com/cmodule/archive/v1.0.13.tar.gz"
  URL_HASH SHA256=0dd63350e809f3be736a62f33f89f92ac0780a0f051e5fb90ae5a3bf51070b48
)
FetchContent_MakeAvailable(cmodule)

find_package(Boost REQUIRED COMPONENTS filesystem iostreams)
target_link_libraries(${target} PUBLIC Boost::filesystem Boost::iostreams)

find_package(ZLIB REQUIRED)
target_link_libraries(${target} PRIVATE ZLIB::ZLIB)

find_package(BZip2 REQUIRED)
target_link_libraries(${target} PRIVATE BZip2::BZip2)

Releases

To insure reproducible builds, always use specific cmodule release. This insures your project always uses the same version of all cmodule libraries. Upgrade to the next cmodule version when you are ready to rebuild using new versions of libraries.

Parameters

  • CMODULE_CACHE_SOURCE_DIR - Directory to store package sources downloaded by cmodule. Default is <USER_HOME_DIR>/.cmodule. Specify empty string to disable source cache (sources will be downloaded/unpacked independently for each target).
  • CMODULE_SHARED_LIBS - Prefer to build shared libs instead of static libs. Default: NO.
  • CMODULE_DISABLE_WARNINGS - Disable all compiler warnings for libs built by cmodule. Default: YES.

You can override default values before including cmodule:

set(CMODULE_CACHE_SOURCE_DIR ${CMAKE_SOURCE_DIR}/.cmodule CACHE PATH "")
set(CMODULE_SHARED_LIBS NO CACHE BOOL "")
set(CMODULE_DISABLE_WARNINGS YES CACHE BOOL "")

How cmodule differs from other package managers?

Other package managers (like hunter), share binaries compiled for a particular target platform, but do not share download/unpack/store of library sources. This is designed to save build time and disk space for situations when you have multiple independently built projects which use a lot of the same libraries.

cmodule does the opposite: it shares download/unpack/store of library sources, but does not share binaries compiled for a particular platform (they are still shared between different targets in the same CMake build, but not between independently built CMake projects). If your projects are built together (as part of the same CMake build), and you cross-compile for multiple platforms (just building all Android ABIs is 4 different platforms), cmodule is a better choice: it shares download/unpack/store of library sources, while building libraries with EXACTLY the same CMake platform toolchain as the rest of the project.