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/localwindows下默认为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_DIRCMAKE_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) # 这里没有“$”符号

⑤ 常用规则

  • cmake_minimum_required(VERSION 3.16) :指令cmake 版本

  • project(hello_world) :设置工程名

  • include_directories(${PROJECT_SOURCE_DIR}/include) :添加头文件路径

  • link_directories(${PROJECT_SOURCE_DIR}/lib) :添加链接库的路径

  • add_subdirectory(module):添加 module 子目录, 此目录下也要有CMakeLists.txt文件

  • add_executable(project1 main.c):指定编译的可执行文件

  • add_library(lib1 SHARED library.c library.h):指定生成的库文件,SHARED为生成动态库,STATIC为生成静态库

  • add_compile_options(): 添加编译选项,如add_compile_options(-std=c++11 -Wall)

  • target_link_libraries():将目标文件与库文件进行链接

  • install():指定make install的目录

  • 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})
    
  • find_library: 在指定目录下查找指定库,并把库的绝对路径存放到变量里,其第一个参数是变量名称,第二个参数是库名称,第三个参数是HINTS,第4个参数是路径,其它用法可以参考cmake文档,类似的还有 find_file()find_path()find_program()find_package()等命令。

    find_library(
         VAR lib_name path
    )
    

2. 项目组织结构

  • bin
  • build
  • include
  • src
  • lib

3. 自定义搜索规则

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")
    ...
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)

参考文献:

  • https://www.jianshu.com/p/2b6cbf53ba95
  • https://blog.csdn.net/afei__/article/details/81201039
  • https://blog.csdn.net/whahu1989/article/details/82078563
  • https://www.jb51.cc/c/110763.html
  • blog.csdn.net/fengbingchun/article/details/46685413
  • 4
    点赞
  • 16
    收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
©️2022 CSDN 皮肤主题:点我我会动 设计师:我叫白小胖 返回首页
评论

打赏作者

罗伯特祥

你的鼓励将是我创作的最大动力

¥2 ¥4 ¥6 ¥10 ¥20
输入1-500的整数
余额支付 (余额:-- )
扫码支付
扫码支付:¥2
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值