【CMake系列】03-cmake 注释、常用指令 message、set、file、for_each、if

本文给出了 cmake 中的 一些常用的 指令，可以快速了解，为后面的内容深入 打点基础。

本专栏的详细实践代码全部放在 github 上，欢迎 star !!!

如有问题，欢迎留言、或加群【392784757】交流

注释

# 行注释

#[[
多行注释
]]

message(" " #[[这里也可以注释]] "")

message

在学习时 可以多用message() 来输出 想要查看的变量

message([<mode>] "message text" ...)

一般使用
message(“msg1” “msg2” “msg3”)

进阶使用-指定日志级别
message([] "message … ")
–log-level

标准输出 stdout
错误输出 stderr

日志级别

1. FATAL_ERROR 停止cmake运行和生成 printed to stderr
2. SEND_ERROR cmake继续运行，生成跳过 printed to stderr
3. WARNING printed to stderr
4. none printed to stderr
5. STATUS 项目用户可能感兴趣的信息 stdout
6. VERBOSE 针对项目用户的详细信息 stdout
7. DEBUG 项目本身的开发人员使用的信息
8. TRACE 非常低级实现细节的细粒度消息

set

set 主要是涉及变量的创建、和修改
cmake 变量，包括两个部分，内置变量、自定义变量

内置变量 可进一步细分

• 信息变量 project_name
• 行为变量 BUILD_SHARED_LIBS
• 描述系统的变量 MSVC、WIN32、CMAKE_SYSTEM_NAME
• 控制构建的变量
• …

自定义变量，常为了更好控制 CMakeLists.txt 结构 ，逻辑流程，来定义一些变量，更好地辅助我们编写

如，

set(package_dir "") # 安装后的位置

set(package_root "") # 源码的位置

unset() 取消定义的变量

file

cmake fille 命令页面 ：https://cmake.org/cmake/help/latest/command/file.html#file

常用的file 可分为是三个方面【其他的还有 Locking、 Path Conversion、Transfer、 archiving】

• reading
• writing
• filesystem

下面给出了一些常用的 file 指令

1. 创建与删除 文件/文件夹

file(MAKE_DIRECTORY files)
file(TOUCH files/4.txt)
file(TOUCH files/5.txt)

file(REMOVE 1.txt)
file(REMOVE_RECURSE files/4.txt)

2. 创建写入\追加 文件

file(WRITE main.cpp [=[

#include<iostream>
using namespace std;
int main()
{
cout<<"hello file create"<<endl;
return 0;
}

]=])

file(WRITE output.txt "hello cmake,1,你好 cmake\n")
file(APPEND output.txt "this is additional content.")

3. file 检索文件保存到 list ，然后进行遍历

file(GLOB_RECURSE all_files *.txt)

math(EXPR cnt "0")
foreach(file ${all_files})
  message("file_${cnt}: ${file}")
  math(EXPR cnt "${cnt}+1")
endforeach(file ${all_files})

4. file 拷贝文件、安装文件等

file(COPY_FILE 2.txt 2_copy.txt)
file(COPY 2.txt DESTINATION files/2.txt)

file(INSTALL 2.txt DESTINATION ${CMAKE_PREFIX_PATH}/)

github上给出了更多详细的实践教程

foreach

cmake 中的 for 循环，相关指令签名如下

foreach(<loop_var> <items>)
  <commands>
endforeach()
# 
foreach(<loop_var> RANGE <stop>)

foreach(<loop_var> RANGE <start> <stop> [<step>])

foreach(<loop_var> IN [LISTS [<lists>]] [ITEMS [<items>]])

主要是用来遍历 list ，

下面的CMakeLists.txt 给出了相关例子

cmake_minimum_required(VERSION 3.5 FATAL_ERROR)

project(foreach_argument LANGUAGES CXX)

list(APPEND files a.cpp b.cpp)

math(EXPR cnt "0")
foreach(file ${files})
  # message(STATUS "file_${cnt} ${file}")
  math(EXPR cnt "${cnt}+1")
endforeach()

foreach(i RANGE 10)
  # message(STATUS "${i}")
endforeach(i RANGE 10)

foreach(i RANGE 0 10 2)
  message(STATUS "${i}")
endforeach(i RANGE 10)

if

if()

elseif()

else()

endif()