Is it better to specify source files with GLOB or each file individually in CMake?

by

Full disclosure: I originally preferred the globbing approach for its simplicity, but over the years I have come to recognise that explicitly listing the files is less error-prone for large, multi-developer projects.

Original answer:

The advantages to globbing are:

  • It’s easy to add new files as they
    are only listed in one place: on
    disk. Not globbing creates
    duplication.

  • Your CMakeLists.txt file will be
    shorter. This is a big plus if you
    have lots of files. Not globbing
    causes you to lose the CMake logic
    amongst huge lists of files.

The advantages of using hardcoded file lists are:

  • CMake will track the dependencies of a new file on disk correctly – if we use
    glob then files not globbed first time round when you ran CMake will not get
    picked up

  • You ensure that only files you want are added. Globbing may pick up stray
    files that you do not want.

In order to work around the first issue, you can simply “touch” the CMakeLists.txt that does the glob, either by using the touch command or by writing the file with no changes. This will force CMake to re-run and pick up the new file.

To fix the second problem you can organize your code carefully into directories, which is what you probably do anyway. In the worst case, you can use the list(REMOVE_ITEM) command to clean up the globbed list of files:

file(GLOB to_remove file_to_remove.cpp)
list(REMOVE_ITEM list ${to_remove})

The only real situation where this can bite you is if you are using something like git-bisect to try older versions of your code in the same build directory. In that case, you may have to clean and compile more than necessary to ensure you get the right files in the list. This is such a corner case, and one where you already are on your toes, that it isn’t really an issue.

More Related Contents:

  1. What is the proper way to use `pkg-config` from `cmake`?
  2. Using CMake with GNU Make: How can I see the exact commands?
  3. CMake: In which order are files parsed (cache, toolchain, etc.)?
  4. Why is cmake file GLOB evil?
  5. Looking for a ‘cmake clean’ command to clear up CMake output
  6. How to modify environment variables passed to custom CMake target?
  7. Compile with /MT instead of /MD using CMake
  8. Copy file from source directory to binary directory using CMake
  9. Find package Eigen3 for CMake
  10. Listing include_directories in CMake
  11. Recursive list of LINK_LIBRARIES in CMake
  12. CMake – linking to library downloaded from ExternalProject_add()
  13. Building a tool immediately so it can be used later in same CMake run
  14. How to instruct CMake to use the build architecture compiler
  15. What is a CMake generator?
  16. Add Source in a subdirectory to a cmake project
  17. Correct way to use third-party libraries in cmake project
  18. CMake compare to empty string with STREQUAL failed
  19. How to detect if current scope has a parent in CMake?
  20. CMake how to set the build directory to be different than source directory
  21. How to always run command when building regardless of any dependency?
  22. how to add prebuilt object files to executable in cmake
  23. How to run ctest after building my project with cmake
  24. How to use CMake to find and link to a library using install-export and find_package?
  25. How do I include a literal double quote in a custom CMake command?
  26. Postpone making custom target until install
  27. CMake : Changing name of Visual Studio and Xcode exectuables depending on configuration in a project generated by CMake
  28. Why add header files into the add_library/add_executable commands in CMake?
  29. CMake and finding other projects and their dependencies
  30. How to add a custom build type to CMake? (targeting make)

Leave a Comment