Cmake file write example

Source Code. Stack Overflow for Teams — Collaborate and share knowledge with a private group. Create a free Team What is Teams? Collectives on Stack Overflow. Learn more. Most simple but complete CMake example Ask Question. Asked 7 years, 11 months ago. Active 12 months ago. Viewed k times. Improve this question. Peter Mortensen Arne Arne 7, 5 5 gold badges 44 44 silver badges 64 64 bronze badges. For example I don't want to update my CMakeList. When I add a new file or folder, I do it within the ide, and the project is updated.

A build system on the other side does not notice when I change some files, so it is a desired behavior that it collects all source files automatically — Arne.

Add a comment. Active Oldest Votes. Improve this answer. SteveLorimer I just disagree, that file globbing is a bad style, I think manually copying the file tree into the CMakeLists. But I know that people do disagree on this topic, therefore I left a comment in the code, where you can replace the globbing with a list that contain all source files explicitly. SteveLorimer yes often did I have to invoke cmake again. Every time I add something in the directory tree, I need to reinvoke cmake manually, so that the globbing get's reevaluated.

If you put the files in the CMakeLists. It's also a bit team friendlier, because then the teammembers also can't forget to execute cmake.

But I think a makefile should not need to be touched, just because someone added a file. Write it once, and nobody should need to think about it ever again. That doesn't mean there can't be subdirectories with their own CMakeLists.

Assuming "VCS" is short for "version control system" , then that is irrelevant. The issue is not, that artifacts won't get added to source control. The issue is, that CMake will fail to re-evaluate added source files. It will not re-generate build system input files. We will test this function with the help of Boost. As our project gets more complicated, the root CMakeLists. To avoid this, and to build a transparent project structure, we will extract the tests into a subproject.

In the Project tree, right-click on the root directory and select New Directory. Call the new directory test. It will appear in the tree under the project root. Right-click the test directory once again and select New CMakeLists. We can start filling it up by inserting a live template for Boost with libs.

After reloading the changes in both CMakeLists. However, to be able to use the built-in test runner, let's create another configuration out of the Boost.

Test template:. Now we can run this configuration and get test results. Test runner shows the tree of tests in the suite, their output, status, and duration:. This chapter gives a simple example of how to use CTest , a framework for compiling and running tests as part of the CMake build process. Find general description of the framework in CTest support.

Create a subdirectory inside test and call it ctest. The first line states the minimum supported version of CTest, which corresponds to the version of CMake, 3. If we run this configuration, the results will be shown in the Test Runner window, similarly to other supported testing frameworks :.

Let's check the All CTest configuration. Click the pen icon next to the Test list to run field. To learn more about various build actions available in CLion, see Build actions. CLion prompts to add the file to an existing target:.

Since our goal is to create a new target, we clear the Add to targets checkbox. Accordingly, CLion notifies us that the new file currently does not belong to any target:. Now let's declare a new target manually in the CMakeLists. Note that CLion treats CMake scripts as regular code files, so we can use code assistance features like syntax highlighting, auto-completion, and navigation: When we make changes in CMakeLists.

We can either reload the project once Reload changes or enable automatic reload to let CLion silently apply all the changes in CMakeLists. As an example, let's create a static library from the calc.

However, this is a non-executable configuration, so if we attempt to run or debug it, we will get the Executable not specified error message. CMake profile is a set of options for the project build. It specifies the toolchain, build type, CMake flags, path for storing build artifacts, make build options, and environment variables. Notice the Build directory field that specifies the location of build results.

The default folders are cmake-build-debug for Debug profiles and cmake-build-release for Release profiles. You can always set other locations of your choice. Switching configurations or CMake profiles may affect preprocessor definitions used while resolving the code.

For example, when there are separate flags for Debug and Release builds, or when there are some variables that take different values depending on the build type. This is called resolve context. Resolve context defines how CLion performs syntax highlighting and other code insights like Find Usages, refactorings, and code completion. When you switch between configurations, the resolve context for the current file is changed automatically. In order to use additional headers located in separate directories, we need to add them either to all the targets or to some specific ones.

These two commands make the headers located in general and math available for including from the sources of all targets. Headers and sources that you add to the project will be resolved correctly only if you include them explicitly in CMakeLists.

We will test this function with the help of Boost. Test framework. As our project gets more complicated, the root CMakeLists. To avoid this, and to build a transparent project structure, we will extract the tests into a subproject. Let's add a directory called test and create a source file tests. Also, we need to provide this directory with its own CMakeLists. We can start filling it up by inserting a live template for Boost with libs.

This command, when placed in the root CMake script, declares a subproject test that has its own CMakeLists. After reloading the changes in both CMakeLists.