CMakelist 最基本
set(module_name "ring")
# 设置头文件包含目录、库目录、库
set(COMMON_INCLUDE_DIRS ${CMAKE_CURRENT_SOURCE_DIR}/common/include)
if(CMAKE_BUILD_TYPE STREQUAL "Debug")
set(COMMON_LIBRARY_DIRS "D:/Desktop/Third-Lib/cmake/out/build/x64-Debug/lib" )
elseif(CMAKE_BUILD_TYPE STREQUAL "Release")
set(COMMON_LIBRARY_DIRS "D:/Desktop/Third-Lib/cmake/out/build/x64-Release/lib" )
endif()
set(COMMON_LIBRARIES libaaa libbbb libccc)
# 产生可执行程序 并指定链接
add_executable(${module_name} "go.cpp" "go.hpp")
target_include_directories(${module_name} PRIVATE ${COMMON_INCLUDE_DIRS})
target_link_directories(${module_name} PRIVATE ${COMMON_LIBRARY_DIRS})
target_link_libraries(${module_name} PRIVATE ${COMMON_LIBRARIES})
# ------------------------------- 可选 -----------------------------------
if(CMAKE_BUILD_TYPE STREQUAL "Debug")
set(COMMON_DLL_DIRS "D:/Desktop/Third-Lib/cmake/out/build/x64-Debug/bin")
elseif(CMAKE_BUILD_TYPE STREQUAL "Release")
set(COMMON_DLL_DIRS "D:/Desktop/Third-Lib/cmake/out/build/x64-Release/bin")
endif()
# find all need dll
foreach(library_name ${COMMON_LIBRARIES})
if(EXISTS "${COMMON_DLL_DIRS}/${library_name}.dll")
list(APPEND COMMON_DLLS "${COMMON_DLL_DIRS}/${library_name}.dll")
endif()
endforeach()
# 拷贝所有dll至可执行文件目录
add_custom_command(TARGET ${module_name} #目标项目
POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy_if_different
${COMMON_DLLS}
$<TARGET_FILE_DIR:${module_name}>) #项目路径
CMakelist 核心手册（可解决万难）
1. 常用的变量及规则
① 预定义变量
- PROJECT_NAME：项目名称
- PROJECT_SOURCE_DIR：工程的根目录
- PROJECT_BINARY_DIR ：执行cmake命令的目录，通常是 ${PROJECT_SOURCE_DIR}/build
- CMAKE_CURRENT_SOURCE_DIR：当前CMakeLists.txt文件所在目录
- CMAKE_CURRENT_BINARY_DIR：target 编译目录
- CMAKE_CURRENT_LIST_DIR：CMakeLists.txt 的完整路径
- CMAKE_CURRENT_LIST_LINE：当前所在的行
- CMAKE_INSTALL_PREFIX：工程安装目录，所有生成和调用所需的可执行程序，库文件，头文件都会安装到该路径下，Unix/Linux下默认为/usr/local，windows下默认为C:\Program Files
- CMAKE_MODULE_PATH：设置搜索CMakeModules模块(.cmake)的额外路径，用来定义自己的 cmake 模块所在的路径，SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)，然后可以用INCLUDE命令来调用自己的模块
- CMAKE_C_FLAGS：设置C编译选项
- CMAKE_CXX_FLAGS：设置C++编译选项
- CMAKE_C_COMPILER：设置C编译器
- CMAKE_CXX_COMPILER：设置C++编译器
- CMAKE_BUILD_TYPE：build类型(Debug,Release,…)，CMAKE_BUILD_TYPE=Debug;
- CMAKE_COMMAND：也就是CMake可执行文件本身的全路径
- CMAKE_DEBUG_POSTFIX：Debug版本生成目标的后缀，通常可以设置为"d"字符
- CMAKE_GENERATOR：编译器名称，例如”UnixMakefiles”, “Visual Studio 7”等
- BUILD_SHARED_LIBS：指定编译成静态库还是动态库
- EXECUTABLE_OUTPUT_PATH：设置编译后可执行文件目录
- LIBRARY_OUTPUT_PATH：设置生成的库文件目录
- CMAKE_INCLUDE_CURRENT_DIR：自动添加CMAKE_CURRENT_BINARY_DIR和
- CMAKE_CURRENT_SOURCE_DIR到当前处理的CMakeLists.txt，set (CMAKE_INCLUDE_CURRENT_DIR ON)
② 系统信息
- CMAKE_MAJOR_VERSION：cmake 主版本号，比如 3.4.1 中的 3
- CMAKE_MINOR_VERSION：cmake 次版本号，比如 3.4.1 中的 4
- CMAKE_PATCH_VERSION：cmake 补丁等级，比如 3.4.1 中的 1
- CMAKE_SYSTEM：系统名称，比如 Linux-2.6.22
- CMAKE_SYSTEM_NAME：不包含版本的系统名，比如 Linux
- CMAKE_SYSTEM_VERSION：系统版本，比如 2.6.22
- CMAKE_SYSTEM_PROCESSOR：处理器名称，比如 i686
- UNIX：在所有的类 UNIX 平台下该值为 TRUE，包括 OS X 和 cygwin
- WIN32：在所有的 win32 平台下该值为 TRUE，包括 cygwin
③ 主要开关选项
- BUILD_SHARED_LIBS：这个开关用来控制默认的库编译方式，如果不进行设置，使用 add_library
又没有指定库类型的情况下，默认编译生成的库都是静态库。如果 set(BUILD_SHARED_LIBS ON)后，默认生成的为动态库 - CMAKE_C_FLAGS：设置 C 编译选项，也可以通过指令 add_definitions() 添加
- CMAKE_CXX_FLAGS：设置 C++ 编译选项，也可以通过指令 add_definitions() 添加
add_definitions(-DENABLE_DEBUG -DABC) # 参数之间用空格分隔
④ 环境变量
# 使用环境变量
$ENV{Name}
# 写入环境变量
set(ENV{Name} value) # 这里没有“$”符号
例子：
# 判断 CUDA_PATH 变量是否定义
if(DEFINED ENV{CUDA_PATH})
message("CUDA_PATH: $ENV{CUDA_PATH}")
else()
message("NOT DEFINED CUDA_PATHVARIABLES")
endif()
# 定义环境变量
set(ENV{CMAKE_PATH} "D:/cmake")
# 判断CMAKE_PATH环境变量是否定义
if(DEFINED ENV{CMAKE_PATH})
message("CMAKE_PATH: $ENV{CMAKE_PATH}")
else()
message("NOT DEFINED CMAKE_PATH VARIABLES")
endif()
⑤ 常用规则
-
cmake_minimum_required(VERSION 3.16) ：指令cmake 版本
-
project(hello_world) ：设置工程名
-
add_compile_options()： 添加编译选项，如add_compile_options(-std=c++11 -Wall)
-
include_directories(${PROJECT_SOURCE_DIR}/include) ：添加头文件路径
include_directories (${HELLO_SOURCE_DIR}/Hello) #增加Hello为include目录
-
add_subdirectory(module)：添加 module 子目录, 此目录下也要有CMakeLists.txt文件
-
add_executable(project1 main.c)：产生一个.exe的target，指定编译的可执行文件
add_executable (helloDemo demo.cxx demo_b.cxx) #将cxx编译成可执行文件
-
add_library(lib1 SHARED library.c library.h)：产生一library的target，指定生成的库文件，SHARED为生成动态库，STATIC为生成静态库
add_library(Hello hello.cxx) #将hello.cxx编译成静态库如libHello.a
-
add_definitions：添加编译参数
add_definitions(-DDEBUG)将在gcc命令行添加DEBUG宏定义；
add_definitions( “-Wall -ansi –pedantic –g”) -
link_directories(${PROJECT_SOURCE_DIR}/lib) ：添加链接库的路径
link_directories (${HELLO_BINARY_DIR}/Hello) #增加Hello为link目录
-
target_link_libraries()：将目标文件与库文件进行链接
add_executable(myProject main.cpp) target_link_libraries(myProject eng mx) #equals to below # target_link_libraries(myProject -leng -lmx) # target_link_libraries(myProject libeng.so libmx.so) -
link_libraries( lib1 lib2 …): 此定义后的所有的目标文件都与库文件进行链接
#directly link to the libraries. LINK_LIBRARIES("/xxx/libeng.so") LINK_LIBRARIES("/xxx/libmx.so") #equals to below #LINK_LIBRARIES("/opt/MATLAB/R2012a/bin/glnxa64/libeng.so" "/opt/MATLAB/R2012a/bin/glnxa64/libmx.so") add_executable(myProject main.cpp) -
link_libraries() 和 target_link_libraries 的区别：
target_link_libraries是在目的文件已经编译后才进行的，如果目的文件没有编译，则不进行。link_libraries则是在他下面的所有add_executable，不管是否需要链接库，都会进行，除非将其他不需要链接库的add_executable放在其前面，那就没有影响了
-
set(XXXX YYYYYY)：用于设置和修改变量，例如
set(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib) set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin) set( SRC_LIST ./main.c ./testFunc1.c ./testFunc.c) # 设置追加变量 set(SRC_LIST main.cpp) set(SRC_LIST ${SRC_LIST} test.cpp) add_executable(demo ${SRC_LIST}) -
${XXXX} ：使用变量
-
list()：追加或删除变量的值
set(SRC_LIST main.cpp) list(APPEND SRC_LIST test.cpp) list(REMOVE_ITEM SRC_LIST main.cpp) add_executable(demo ${SRC_LIST}) -
file()：
-
find_library：在指定目录下查找指定库，并把库的绝对路径存放到变量里，其第一个参数是变量名称，第二个参数是库名称，第三个参数是HINTS，第4个参数是路径，其它用法可以参考cmake文档，类似的还有 find_file()、find_path()、find_program()、find_package()等命令。注意CMAKE_PREFIX_PATH 是它找的基本。
find_library(VAR lib_name path)if(CMAKE_BUILD_TYPE AND (CMAKE_BUILD_TYPE STREQUAL "Debug")) list(APPEND CMAKE_PREFIX_PATH "D:/lib/libtorch-win-shared-with-deps-debug-1.9.0+cu111/libtorch/share/cmake") elseif(CMAKE_BUILD_TYPE AND (CMAKE_BUILD_TYPE STREQUAL "Release")) list(APPEND CMAKE_PREFIX_PATH "D:/lib/libtorch-win-shared-with-deps-1.9.0+cu111/libtorch/share/cmake") endif() find_package(Torch REQUIRED) -
option：设置条件编译
option(DEBUG_mode "ON for debug or OFF for release" ON) IF(DEBUG_mode) add_definitions(-DDEBUG) ENDIF() -
set_target_properties( … )：
-
get_target_property( … )：
-
install()：指定make install的目录
SET (LIBHELLO_SRC hello.cpp) # SET (LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib) # 添加动态库，关键词为shared，不需要写全称libhello.so， # 只需要填写hello即可，cmake系统会自动为你生成 libhello.X ADD_LIBRARY (hello SHARED ${LIBHELLO_SRC}) # 添加静态库，关键词为static，ADD_LIBRARY (hello STATIC ${LIBHELLO_SRC}) # 仍然用hello作为target名时，是不能成功创建所需的静态库的， # 因为hello作为一个target是不能重名的， 故把上面的hello修改为hello_static # 同理，你不需要写全libhello_static.a # 只需要填写hello即可，cmake系统会自动为你生成 libhello_static.X ADD_LIBRARY (hello_static STATIC ${LIBHELLO_SRC}) # 按照一般的习惯，静态库名字跟动态库名字应该是一致的，只是扩展名不同； # 即：静态库名为 libhello.a； 动态库名为libhello.so ； # 所以，希望 "hello_static" 在输出时，不是"hello_static"，而是以"hello"的名字显示，故设置如下： SET_TARGET_PROPERTIES (hello_static PROPERTIES OUTPUT_NAME "hello") GET_TARGET_PROPERTY (OUTPUT_VALUE hello_static OUTPUT_NAME) MESSAGE (STATUS "This is the hello_static OUTPUT_NAME: " ${OUTPUT_VALUE}) # cmake在构建一个新的target时，会尝试清理掉其他使用这个名字的库， # 因此，在构建libhello.a时，就会清理掉libhello.so. # 为了回避这个问题，比如再次使用SET_TARGET_PROPERTIES定义 CLEAN_DIRECT_OUTPUT属性。 SET_TARGET_PROPERTIES (hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1) SET_TARGET_PROPERTIES (hello PROPERTIES CLEAN_DIRECT_OUTPUT 1) # 按照规则，动态库是应该包含一个版本号的， # VERSION指代动态库版本，SOVERSION指代API版本。 SET_TARGET_PROPERTIES (hello PROPERTIES VERSION 1.2 SOVERSION 1) # 我们需要将libhello.a, libhello.so.x以及hello.h安装到系统目录，才能真正让其他人开发使用， # 在本例中我们将hello的共享库安装到<prefix>/lib目录； # 将hello.h安装<prefix>/include/hello目录。 INSTALL (TARGETS hello hello_static LIBRARY DESTINATION lib ARCHIVE DESTINATION lib) INSTALL (FILES hello.h DESTINATION include/hello) -
add_custom_target：
CMake中一切都是基于target的，如add_library会产生一个library的target，add_executable会产生一个exe的target…，而add_custom_target会根据命令的参数生成一个target，这个target相对的可以更定制化一点。
参考：https://blog.csdn.net/MacKendy/article/details/122693478
-
add_custom_command：
首先add_custom_command有两种用法，我觉得这两种用法的差距之大甚至都不该塞进这一个名字里。
1.执行有输出文件的自定义操作
2.执行没有输出的自定义操作参考：https://blog.csdn.net/qq_38410730/article/details/102797448
参考：https://zhuanlan.zhihu.com/p/397394950
参考：https://www.csdn.net/tags/MtjaUgysODU5NDQtYmxvZwO0O0OO0O0O.html -
add_custom_command 和 add_custom_target 总结
add_custom_command命令输出的OUTPUT文件，就像是一个看不见的文件，这个文件和命令里的command之间的关系是：每当这个文件被重新生成，都会执行这段command。而这个文件会不会被生成，取决于你构建的target到底depends这个output文件没。而这个文件会不会重新生成，取决于这个output文件depends的东西变了没。。。
使用cmake一定要时时刻刻以模块化为宗旨。模块化的最终构建单位就是一个一个的 target，也就是 add_library/ add_executable/ add_custom_target 构建出的东西。这也是cmake现代化发展的方向。
用通俗的语言来描述过程就是，我要cmake构建一个target，名字叫 a_target_used_todo_some_commands，那么他会检查他的 depends（add_custom_command里的output文件）和相应的缓存文件，来决定需不需要重新构建此target。而这个output的文件（看不见的文件）是否需要重新生成，取决于它自己的depends，就像一个链条连接起来一样，最终的效果就是这条链的最末端（add_custom_command命令里output的文件的depends的东西）一旦变化，或者根本不存在，或者连倒数第二级（也就是output文件）都不存在，那么这个output文件一定会被生成或者叫重新生成。而一旦生成或重新生成，那么那些command就一定会执行。理解这种依赖关系非常重要，重要的原因不是要你自己维护依赖关系（cmake会帮你维护依赖保保证重新生成/构建的最小粒度），而是如果不理解这种依赖的关系，就很难写cmake了。。。
cmake说简单点就是一个一个的target，target下面是一个个文件，然后就是再保存相互之间的依赖关系了。
2. 项目组织结构
- bin
- build
- include
- src
- lib
3. 自定义搜索规则
```bash
file(GLOB SRC_LIST "*.cpp" "protocol/*.cpp")
add_library(demo ${SRC_LIST})
#或者
file(GLOB SRC_LIST "*.cpp")
file(GLOB SRC_PROTOCOL_LIST "protocol/*.cpp")
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})
#或者
aux_source_directory(. SRC_LIST)
aux_source_directory(protocol SRC_PROTOCOL_LIST)
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})
```
4. 条件控制
if…elseif…else…endif
逻辑判断和比较：
- if (expression)：expression 不为空（0,N,NO,OFF,FALSE,NOTFOUND）时为真
- if (not exp)：与上面相反
- if (var1 AND var2)
- if (var1 OR var2)
- if (COMMAND cmd)：如果 cmd 确实是命令并可调用为真
- if (EXISTS dir)
- if (EXISTS file)：如果目录或文件存在为真
- if (file1 IS_NEWER_THAN file2)：当 file1 比 file2 新，或 file1/file2 中有一个不存在时为真，文件名需使用全路径
- if (IS_DIRECTORY dir)：当 dir 是目录时为真
- if (DEFINED var)：如果变量被定义为真
- if (var MATCHES regex)：给定的变量或者字符串能够匹配正则表达式 regex 时为真，此处 var 可以用 var 名，也可以用 ${var}
- if (string MATCHES regex)
数字比较：
- if (variable LESS number)：LESS 小于
- if (string LESS number)
- if (variable GREATER number)：GREATER 大于
- if (string GREATER number)
- if (variable EQUAL number)：EQUAL 等于
- if (string EQUAL number)
字母表顺序比较：
-
if (variable STRLESS string)
-
if (string STRLESS string)
-
if (variable STRGREATER string)
-
if (string STRGREATER string)
-
if (variable STREQUAL string)
-
if (string STREQUAL string)
if(MSVC) set(LINK_LIBS common) else() set(boost_thread boost_log.a boost_system.a) endif() target_link_libraries(demo ${LINK_LIBS}) #或者 if(UNIX) set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -fpermissive -g") else() add_definitions(-D_SCL_SECURE_NO_WARNINGS D_CRT_SECURE_NO_WARNINGS -D_WIN32_WINNT=0x601 -D_WINSOCK_DEPRECATED_NO_WARNINGS) endif() if(${CMAKE_BUILD_TYPE} MATCHES "Debug") # Deb、bug、Debug 能匹配，deb、Db 则不能匹配 ... else() ... endif()while…endwhile
while(condition) ... endwhile()foreach…endforeach
foreach(loop_var RANGE start stop [step]) ... endforeach(loop_var)start 表示起始数，stop 表示终止数，step 表示步长，示例：
foreach(i RANGE 1 9 2) message(${i}) endforeach(i) #输出：13579
5. 打印信息
message(${PROJECT_SOURCE_DIR})
message("build with debug mode")
message(WARNING "this is warnning message")
message(FATAL_ERROR "this build has many error") # FATAL_ERROR 会导致编译失败
6. 包含其他cmake文件
include(./common.cmake) # 指定包含文件的全路径
include(def) # 在搜索路径中搜索def.cmake文件
set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake) # 设置include的搜索路径
################################################################
#CMakeLists.txt
cmake_minimum_required(VERSION 2.8)
include (Project.txt)
#Project.txt
project (Project)
add_executable(Project project.c)
补充
① list
list(LENGTH )
list(GET [ …])
list(APPEND [ …])
list(FIND )
list(INSERT <element_index> [ …])
list(REMOVE_ITEM [ …])
list(REMOVE_AT [ …])
list(REMOVE_DUPLICATES )
list(REVERSE )
list(SORT )
LENGTH 返回list的长度
GET 返回list中index的element到value中
APPEND 添加新element到list中
FIND 返回list中element的index，没有找到返回-1
INSERT 将新element插入到list中index的位置
REMOVE_ITEM 从list中删除某个element
REMOVE_AT 从list中删除指定index的element
REMOVE_DUPLICATES 从list中删除重复的element
REVERSE 将list的内容反转
SORT 将list按字母顺序排序
应用：
- 找不到 xxxConfig.cmake 时
list(APPEND CMAKE_PREFIX_PATH xxxConfig.cmake文件的目录路径)
- 找到一个或多个多重定义的符号时
list(REMOVE_ITEM TORCH_LIBRARIES “…/…/torch.lib”)
list(REMOVE_AT TORCH_LIBRARIES 1)
② add_definitions()
这种可以在我们更改别人代码做实验时使用，既不对其源码进行破坏，又可以添加自己的功能。之前都是在程序中进行#define，有了这个后可以直接在编译的时候进行选择。具体的，在工程CMakeLists.txt 中，使用add_definitions()函数控制代码的开启和关闭：
option(TEST_DEBUG "option for debug" OFF)
if (TEST_DEBUG)
add_definitions(-DTEST_DEBUG)
endif(TEST_DEBUG)
运行构建项目的时候可以添加参数控制宏的开启和关闭．
cmake -DTEST_DEBUG=1 .. #打开
cmake -DTEST_DEBUG=0 .. #关闭
在源码中就可以使用：
#ifdef TEST_DEBUG
...
...
#else
...
#endif
来对程序进行控制。
③ 通过 add_custom_command 生成 .exe 时，拷贝 dll
add_custom_command(TARGET ${module_name} #目标项目
POST_BUILD # exe生成后
COMMAND ${CMAKE_COMMAND} -E copy_if_different
${COMMON_DLLS} # 需要拷贝的动态库（如 opencv.dll）
$<TARGET_FILE_DIR:${module_name}>) #项目路径
6276
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
