CMakeLists.txt

最新推荐文章于 2025-10-06 12:09:57 发布
转载 最新推荐文章于 2025-10-06 12:09:57 发布 · 5.4k 阅读 · 3

本文详细介绍 CMake 的安装、基本使用、概念、语法等，并解答常见问题，帮助读者掌握跨平台构建系统的配置与应用。

转载自：http://www.cnblogs.com/lidabo/p/3974305.html

一、      基本使用

安装：下载二进制包后可直接解压使用

从源码安装则执行命令：./bootstrap; make; make install——尝试执行bootstrap失败

使用：cmake dir_path，生成工程文件或makefile文件

二、      概念

out-of-source build，与in-source build相对，即将编译输出文件与源文件放到不同目录中；

三、      基本结构

1，依赖CMakeLists.txt文件，项目主目标一个，主目录中可指定包含的子目录；

2，在项目CMakeLists.txt中使用project指定项目名称，add_subdirectory添加子目录

3，子目录CMakeLists.txt将从父目录CMakeLists.txt继承设置（TBD，待检验）

四、      语法

1.       #注释

2.       变量：使用set命令显式定义及赋值，在非if语句中，使用${}引用，if中直接使用变量名引用；后续的set命令会清理变量原来的值；

3.       command (args ...)  #命令不分大小写，参数使用空格分隔，使用双引号引起参数中空格

4.       set(var a;b;c) <=> set(var a b c)  #定义变量var并赋值为a;b;c这样一个string list

5.       Add_executable(${var}) <=> Add_executable(a b c)   #变量使用${xxx}引用

6.       条件语句：

if(var) #var 非empty 0 N No OFF FALSE... #非运算使用NOT

       …

else()/elseif() … endif(var)

7.       循环语句

Set(VAR a b c)

Foreach(f ${VAR})       …Endforeach(f)

8.       循环语句

WHILE() … ENDWHILE()

五、      内部变量

CMAKE_C_COMPILER：指定C编译器

CMAKE_CXX_COMPILER：

CMAKE_C_FLAGS：编译C文件时的选项，如-g；也可以通过add_definitions添加编译选项

EXECUTABLE_OUTPUT_PATH：可执行文件的存放路径

LIBRARY_OUTPUT_PATH：库文件路径

CMAKE_BUILD_TYPE:：build 类型(Debug, Release, ...)，CMAKE_BUILD_TYPE=Debug

BUILD_SHARED_LIBS：Switch between shared and static libraries

内置变量的使用：

>> 在CMakeLists.txt中指定，使用set

>> cmake命令中使用，如cmake -DBUILD_SHARED_LIBS=OFF

六、      命令

project (HELLO)   #指定项目名称，生成的VC项目的名称；

>>使用${HELLO_SOURCE_DIR}表示项目根目录

include_directories：指定头文件的搜索路径，相当于指定gcc的-I参数

>> include_directories (${HELLO_SOURCE_DIR}/Hello)  #增加Hello为include目录

link_directories：动态链接库或静态链接库的搜索路径，相当于gcc的-L参数

       >> link_directories (${HELLO_BINARY_DIR}/Hello)     #增加Hello为link目录

add_subdirectory：包含子目录

       >> add_subdirectory (Hello)

add_executable：编译可执行程序，指定编译，好像也可以添加.o文件

       >> add_executable (helloDemo demo.cxx demo_b.cxx)   #将cxx编译成可执行文件——

add_definitions：添加编译参数

>> add_definitions(-DDEBUG)将在gcc命令行添加DEBUG宏定义；

>> add_definitions( “-Wall -ansi –pedantic –g”)

target_link_libraries：添加链接库,相同于指定-l参数

>> target_link_libraries(demo Hello) #将可执行文件与Hello连接成最终文件demo

add_library:

>> add_library(Hello hello.cxx)  #将hello.cxx编译成静态库如libHello.a

add_custom_target:

message( status|fatal_error, “message”):

set_target_properties( ... ): lots of properties... OUTPUT_NAME, VERSION, ....

link_libraries( lib1 lib2 ...): All targets link with the same set of libs

七、      说明

1，CMAKE生成的makefile能够处理好.h文件更改时只编译需要的cpp文件；

八、      FAQ

1）  怎样获得一个目录下的所有源文件

>> aux_source_directory(<dir> <variable>)

>> 将dir中所有源文件（不包括头文件）保存到变量variable中，然后可以add_executable (ss7gw ${variable})这样使用。

2）  怎样指定项目编译目标

>>  project命令指定

3）  怎样添加动态库和静态库

>> target_link_libraries命令添加即可

4）  怎样在执行CMAKE时打印消息

>> message([SEND_ERROR | STATUS | FATAL_ERROR] "message to display" ...)

>> 注意大小写

5）  怎样指定头文件与库文件路径

>> include_directories与link_directories

>>可以多次调用以设置多个路径

>> link_directories仅对其后面的targets起作用

6）  怎样区分debug、release版本

>>建立debug/release两目录，分别在其中执行cmake -DCMAKE_BUILD_TYPE=Debug（或Release），需要编译不同版本时进入不同目录执行make即可；

Debug版会使用参数-g；Release版使用-O3 –DNDEBUG

>> 另一种设置方法——例如DEBUG版设置编译参数DDEBUG

IF(DEBUG_mode)

    add_definitions(-DDEBUG)

ENDIF()

在执行cmake时增加参数即可，例如cmake -D DEBUG_mode=ON

7）  怎样设置条件编译

例如debug版设置编译选项DEBUG，并且更改不应改变CMakelist.txt

>> 使用option command，eg：

option(DEBUG_mode "ON for debug or OFF for release" ON)

IF(DEBUG_mode)

    add_definitions(-DDEBUG)

ENDIF()

>> 使其生效的方法：首先cmake生成makefile，然后make edit_cache编辑编译选项；Linux下会打开一个文本框，可以更改，该完后再make生成目标文件——emacs不支持make edit_cache；

>> 局限：这种方法不能直接设置生成的makefile，而是必须使用命令在make前设置参数；对于debug、release版本，相当于需要两个目录，分别先cmake一次，然后分别make edit_cache一次；

>> 期望的效果：在执行cmake时直接通过参数指定一个开关项，生成相应的makefile——可以这样做，例如cmake –DDEBUGVERSION=ON

8）  怎样添加编译宏定义

>> 使用add_definitions命令，见命令部分说明

9）  怎样添加编译依赖项

用于确保编译目标项目前依赖项必须先构建好

>>add_dependencies

10）        怎样指定目标文件目录

>> 建立一个新的目录，在该目录中执行cmake生成Makefile文件，这样编译结果会保存在该目录——类似

>> SET_TARGET_PROPERTIES(ss7gw PROPERTIES

                      RUNTIME_OUTPUT_DIRECTORY "${BIN_DIR}")

11）        很多文件夹，难道需要把每个文件夹编译成一个库文件？

>> 可以不在子目录中使用CMakeList.txt，直接在上层目录中指定子目录

12）        怎样设定依赖的cmake版本

>>cmake_minimum_required(VERSION 2.6)

13）        相对路径怎么指定

>> ${projectname_SOURCE_DIR}表示根源文件目录，${ projectname _BINARY_DIR}表示根二进制文件目录？

14）        怎样设置编译中间文件的目录

>> TBD

15）        怎样在IF语句中使用字串或数字比较

>>数字比较LESS、GREATER、EQUAL，字串比STRLESS、STRGREATER、STREQUAL，

>> Eg：

set(CMAKE_ALLOW_LOOSE_LOOP_CONSTRUCTS ON)

set(AAA abc)

IF(AAA STREQUAL abc)

    message(STATUS "true")   #应该打印true

ENDIF()

16）        更改h文件时是否只编译必须的cpp文件

>> 是

17）        机器上安装了VC7和VC8，CMAKE会自动搜索编译器，但是怎样指定某个版本？

>> TBD

18）        怎样根据OS指定编译选项

>> IF( APPLE ); IF( UNIX ); IF( WIN32 )

19）        能否自动执行某些编译前、后命令？

>> 可以，TBD

20）        怎样打印make的输出

make VERBOSE=1

参考文献：

[1] CMake_Tutorial.pdf

[2] CMake使用总结，http://blog.youkuaiyun.com/keensword007/archive/2008/07/16/2663235.aspx

[3] http://www.cmake.org/

[4] 安装包中文档

[5] Andrej Cedilnik，HOWTO: Cross-Platform Software Development Using CMake，October, 2003

[6] Cjacker，CMake实践.PDF


guoguoshizhuo
关注
CMake详解
顺其自然~专栏
01-07 7463
CMake（cross platform make）是一个跨平台的安装（编译）工具，可以用简单的语句来描述所有平台的安装(编译过程)。他能够输出各种各样的makefile或者project文件，能测试编译器所支持的C++特性,类似UNIX下的automake。只是 CMake 的组态档取名为 CMakeLists.txt。Cmake 并不直接建构出最终的软件，而是产生标准的建构档（如 Unix 的 Makefile 或 Windows Visual C++ 的 projects/workspaces），然后
CMake I 条件控制编译
该用户还没想到好的昵称的博客
01-10 8725
基于上篇文章，我们可以通过条件结构 if-else-endif来控制cmake编译的行为。本文的例子用来实现： 将 Message.h 和 Message.cpp 构建成一个静态库，然后将生成库链接到 helloworld 可执行文件中。 将 Message.h、Message.cpp 和 helloworld.cpp 构建成一个可执行文件，但不生成任何一个库。 一、CMakeLists.txt 1.源文件 cmake_minimum_required(VERSION 3.5 FA...
CMake用法详解 使用方法说明
08-13
CMake 用法详解，简单描述了CMake 的使用方法，通过简单的例子
CMake学习篇[3]---CMake进阶+嵌套CMakeLists+多层级关系
最新发布
Edwinwzy的博客
10-06 1250
本文介绍了使用CMake进行大型项目模块化构建的方法。作者首先解释了模块的概念，指出模块在实际开发中通常以库文件形式承载，并对比了静态库、动态库与模块库的区别。 文章通过一个志愿服务活动管理系统的示例项目，展示了如何采用嵌套CMakeLists结构组织代码：根节点CMakeLists负责全局变量定义和子目录管理，子节点分别处理静态库、动态库的生成和可执行文件的链接。这种分层管理方式解决了单一CMakeLists文件过大、难以维护的问题。
CMake Introduction 1
comedate的专栏
11-23 1590
一、      基本使用 安装：下载二进制包后可直接解压使用 从源码安装则执行命令：./bootstrap; make; make install——尝试执行bootstrap失败 使用：cmake dir_path，生成工程文件或makefile文件 二、      概念 out-of-source build，与in-source build相对，即将编译输出文件与源文件放到不同目录
cmake的使用
梦心之魂的博客
06-02 8210
一、基本使用 安装：下载二进制包后可直接解压使用。 从源码安装则执行命令： ./bootstrap; ——尝试执行bootstrap失败 make; make install 使用：cmake dir_path，生成工程文件或makefile文件 二、概念 out-of-sourcebuild，与in-source build...
精选资源
zbar0.10源码包括CMakeLists.txt
05-08
标题为“zbar0.10源码包括CMakeLists.txt”的文件，表明这是一个软件开发项目中使用的源代码包，其中包含了软件库zbar的版本0.10的源代码，以及一个名为CMakeLists.txt的文件。CMakeLists.txt是一个配置文件，用于...
精选资源
兼容ros1 ros2自定义消息的cmakelists.txt文件与package.xml文件
04-14
在ROS（Robot Operating System）开发中，`cmakelists.txt`和`package.xml`是两个至关重要的文件，它们定义了ROS包的构建规则和元数据。当我们需要在ROS1和ROS2之间实现兼容性，特别是在处理自定义消息时，这两个...
C++版本使用CMakeLists.txt编译（同目录多个源文件）可执行文件
07-12
C++版本使用CMakeLists.txt编译（同目录多个源文件）可执行文件-C++版本使用CMakeLists.txt编译（同目录多个源文件）可执行文件-C++版本使用CMakeLists.txt编译（同目录多个源文件）可执行文件
精选资源
CMakeLists.txt生成.so ndk开发
01-03
ndk开发 由于需调用底层代码申请系统内存就开发了调用底层的so 申请内存主要两个 申请内存 释放内存 创建对应的java调取接口jni ...public class MemOpJni { static { System.loadLibrary(memory_malloc);...
CMAKE - AN INTRODUCTION
10-02
CMake is a build-process management tool • Platform independent • Supports various output formats • Dependencies • Libraries
cmake使用方法（详细）
杰特JET的博客
11-27 2993
cmake使用方法（详细） cmake 帮助文档 技巧 命令行选项 -D 编译选项 add_compile_options add_compile_definition option & add_definition 使用方法 语法说明 列表和字符串 变量 控制流 引号，字符串和转义 正则表达式...
cmake使用方法详解
Coder_MrLee的博客
02-08 5739
cmake 简介 CMake是一个跨平台的安装(编译)工具,可以用简单的语句来描述所有平台的安装(编译过程)。他能够输出各种各样的makefile或者project文件,能测试编译器所支持的C++特性,类似UNIX下的automake。 CMake 使用方法 CMake的所有的语句都写在一个叫:CMakeLists.txt的文件中。当CMakeLists.txt文件确定后,可以用ccmake命令对相关 的变量值进行配置。这个命令必须指向CMakeLists.txt所在的目录。配置完成之后,应用cmake命令
cmake使用方法详解【经典】
qq_41034175的博客
12-12 844
https://www.cnblogs.com/lidabo/p/7359422.html
cmake使用详细教程（日常使用这一篇就足够了）
热门推荐
iuu77的博客
02-27 19万+
此时可以使用cmake中的函数存储这些源文件。只需要在CMakeLists.txt中添加所依赖的.cpp文件，编译步骤和上面相同。有时编译程序时想添加一些编译选项，如-Wall，-std=c++11等，可以使用。此时在当前目录新增两个依赖，并mian函数的执行需要依赖这两个文件。1、在官网下载cmake的安装包，这里我下载的是v3.26。4、此时已经安装完成，可以在shell中使用cmake命令。2、找到下载的sh文件，并使用bash来执行sh脚本。对于集中的头文件，CMake提供了一个很方便的函数。
Cmake使用教程
QQVQQ的博客
04-20 2070
CMake是个一个开源的跨平台自动化建构系统，用来管理软件建置的程序，并不依赖于某特定编译器，并可支持多层目录、多个应用程序与多个库。
CMake用法详解(转)
Z.X的博客
12-20 641
2020年12月20日13:26:16 原文是pdf，我转成TXT了 CMake 相关 一.第一次尝试结果： 我将源码目录建为 src，编译目录建为 build. 然后在 src 下建立 main，用于放 main 相关的文件，再在 src 下建立 lib1，用于放一个小库。 Magic Happens like this: (1)main 和 lib1 中的 CMakeLists.txt，只需...
CMakelists.txt
08-09
### CMakeLists.txt 配置指南与问题解决方法 CMakeLists.txt 是一个由 CMake 使用的配置文件，用于定义软件构建的过程。它能够指导 CMake 如何编译源代码、链接库文件以及生成可执行文件等。该文件使用 CMake 自己的脚本语言编写，具有高度的可移植性和灵活性，适用于跨平台的项目构建管理[^2]。 #### CMakeLists.txt 基本框架 CMakeLists.txt 文件通常包括以下几个部分： 1. **项目定义**：指定项目名称、版本等基本信息。 ```cmake cmake_minimum_required(VERSION 3.10) project(MyProject VERSION 1.0) ``` 2. **设置编译器选项**：根据项目需求设置编译器标志。 ```cmake set(CMAKE_CXX_STANDARD 17) set(CMAKE_CXX_STANDARD_REQUIRED True) ``` 3. **查找依赖库**：使用 `find_package` 查找项目所需的第三方库。 ```cmake find_package(OpenCV REQUIRED) include_directories(${OpenCV_INCLUDE_DIRS}) ``` 4. **定义目标**：指定要构建的目标（如可执行文件或库）。 ```cmake add_executable(myapp main.cpp) target_link_libraries(myapp ${OpenCV_LIBS}) ``` 5. **安装规则**：定义安装时的行为。 ```cmake install(TARGETS myapp DESTINATION bin) ``` #### CMakeLists.txt 常见问题及解决方法 1. **文件通配符使用错误** 在使用 `file(GLOB ...)` 或 `add_executable(... *.cpp)` 时，如果路径不正确或文件不存在，会导致构建失败。建议显式列出所有源文件，以提高可维护性。 ```cmake file(GLOB SOURCES "src/*.cpp") add_executable(myapp ${SOURCES}) ``` 如果使用通配符时出现错误，提示“无法识别该规则”，应检查路径是否正确，或尝试显式列出文件名[^1]。 2. **变量未定义** 如果在 `target_link_libraries` 中引用了未定义的变量（如 `${OpenCV_LIBS}`），则会导致链接失败。应确保 `find_package` 成功执行，并检查是否启用了必要的组件。 3. **语法错误** CMake 对语法要求严格，常见的错误包括括号不匹配、命令拼写错误等。例如： ```cmake if(NOT EXISTS ${CMAKE_SOURCE_DIR}/CMakeLists.txt) message(FATAL_ERROR "CMakeLists.txt not found") endif() ``` 若 `endif()` 缺失或拼写错误，会导致整个条件判断逻辑中断[^3]。 4. **路径问题** 使用相对路径时，若当前工作目录与预期不符，可能导致找不到文件。建议使用 `${CMAKE_SOURCE_DIR}` 或 `${PROJECT_SOURCE_DIR}` 来构建绝对路径。 5. **缓存问题** CMake 会缓存变量值，若修改了某些配置但未清除缓存，可能导致构建行为异常。可使用 `ccmake` 或删除 `CMakeCache.txt` 来重置配置。 #### 示例：CMakeLists.txt 报错急救 当出现 `CMake Error at CMakeLists.txt` 错误时，首先应关注错误信息中的具体行号和上下文。例如： ``` CMake Error at CMakeLists.txt:15 (add_executable): Cannot find source file: main.cpp ``` 这表明 `main.cpp` 文件不存在或路径错误。此时应检查文件是否存在，并确认 `add_executable` 中的路径是否正确[^4]。 此外，某些错误可能与平台相关，例如在 Windows 上使用 Linux 特定的路径格式。建议使用 `CMAKE_CURRENT_SOURCE_DIR` 等内置变量来确保路径的跨平台兼容性。 ###
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值