Displaying CMake variables

Cmake

Cmake Problem Overview


Suppose I have a package called Foo. If I run CMake on a CMakeLists.txt file that contains find_package(Foo), then I can print out the values of variables such as ${Foo_LIBRARIES} and ${Foo_INCLUDES}.

Is there an easy way to display these variables without having to run CMake on a CMakeLists.txt file, and without having to manually inspect the config.cmake file?

Cmake Solutions


Solution 1 - Cmake

You asked: (1) Is there an easy way to display these variables without having to run cmake on a CMakeLists.txt file, and (2) without having to manually inspect the config.cmake file?

I can give you a yes answer to (2) but it does require that you (re)run cmake. But since you can re-run your cmake configure step by simply executing cmake . in the build directory, re-running cmake should not keep you from trying this approach. My answer is given in this SO answer and uses the get_cmake_property command. Here is that code encapsulated into a cmake macro, print_all_variables, so I can use it when debugging my cmake scripts.

macro(print_all_variables)
    message(STATUS "print_all_variables------------------------------------------{")
    get_cmake_property(_variableNames VARIABLES)
    foreach (_variableName ${_variableNames})
        message(STATUS "${_variableName}=${${_variableName}}")
    endforeach()
    message(STATUS "print_all_variables------------------------------------------}")
endmacro()

The macros are invoked with same syntax as cmake functions:

print_all_variables()

Solution 2 - Cmake

To simply print a value, you could do something like this:

message(STATUS "foo include dir: ${foo_INCLUDE}")

where ${foo_INCLUDE} is the value you desire to print.

Note: I'm using cmake > 3.14

Solution 3 - Cmake

Run CMake and have a look at the cache with the ccmake GUI tool. Then you'll get all the variables.

Or run CMake with -LH then you will get all variables printed after configuration.

So I think it is not possible to get the variables without running CMake.

Solution 4 - Cmake

Run cmake in find-package mode. Example to display a package`s include directories:

cmake -DNAME=ZLIB -DCOMPILER_ID=GNU -DLANGUAGE=C -DMODE=COMPILE --find-package

Example to display the libraries:

cmake -DNAME=ZLIB -DCOMPILER_ID=GNU -DLANGUAGE=C -DMODE=LINK --find-package

The NAME must be set to the package name. You can obtain your COMPILER_ID on this page. LANGUAGE can be C, CXX or Fortran.

Solution 5 - Cmake

These variables are generally hardcoded into FindFoo.cmake so that it is not possible to extract them without running the function first. Note that sometimes the value of Foo_LIBRARIES depends on the system configuration, which is unknown until find_package(Foo) is run.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionKarnivaurusView Question on Stackoverflow
Solution 1 - CmakePhilView Answer on Stackoverflow
Solution 2 - CmakeAaron B.View Answer on Stackoverflow
Solution 3 - Cmakeusr1234567View Answer on Stackoverflow
Solution 4 - Cmaketamas.kenezView Answer on Stackoverflow
Solution 5 - CmakeRaul LaasnerView Answer on Stackoverflow