cmake入门
单个源文件
- 我们编写如下文件
#include <stdio.h>
#include <stdlib.h>
int main(int argc, char *argv[])
{
printf("hello world\n");
return 0;
}
- 我们编写如下CMakeLists.txt
# CMake 指定运行此配置文件所需的 CMake 的最低版本
cmake_minimum_required (VERSION 2.8)
# 该命令表示项目的名称是singleFile
project (singleFile)
# 将名为 main.cc 的源文件编译成一个名称为 Demo 的可执行文件
add_executable(singleFile main.cpp)
- 使用cmake命令进行配置编译并编译
- mkdir debug
- cd debug
- cmake …/
- make
多个源文件
同级目录
- 我们在同一文件夹下创建如下文件
./sameDirMultSrc | +---------tool.h | +---------tool.cpp | +---------main.cpp
- 我们在同级目录下编写如下CMakeLists.txt
# CMake 最低版本号要求 cmake_minimum_required (VERSION 2.8) # 项目信息 project (sameDirMultSrc) # 指定生成目标 add_executable(sameDirMultSrc main.cpp tool.cpp)
- 与上面的CMakeLists.txt比较,我们只是在add_executable命令中多添加了一个源文件
- 当源文件很多是这样写不利于管理,cmake中有如下命令来简化这种写法
aux_source_directory
该命令会查找指定目录下的所有源文件,然后将结果存进指定变量名。其语法如下:
aux_source_directory(<dir> <variable>)
- 最终形式的CMakeLists.txt为:
# CMake 最低版本号要求 cmake_minimum_required (VERSION 2.8) # 项目信息 project (sameDirMultSrc) # 查找当前目录下的所有源文件 # 并将名称保存到 SRC 变量 aux_source_directory(. SRC) # 指定生成目标 #add_executable(sameDirMultSrc main.cpp tool.cpp) add_executable(sameDirMultSrc ${SRC})
多级目录
-
我们创建如下目录结构,并在各目录下创建对应文件
./sameDir | +-----main.cpp | +-----./tool | +-----tool.h | +-----tool.cpp
-
为了方便,我们将tool目录里的文件编译为动态库,并在main中调用
# CMake 最低版本号要求 cmake_minimum_required (VERSION 2.8) # 项目信息 project (sameDir) #导入头文件所在路径 #PROJECT_SOURCE_DIR为cmake宏 include_directories("${PROJECT_SOURCE_DIR}/tool") # 查找当前目录下的所有源文件 # 并将名称保存到 SRC 变量 aux_source_directory(. SRC) # 指定生成目标 add_executable(sameDir ${SRC}) # 添加 math 子目录 add_subdirectory(tool) # 添加链接库 #该命令要在add_executable命令下方,否则报错 target_link_libraries(sameDir Tool)
- add_subdirectory 指明本项目包含一个子目录 tool,这样 tool 目录下的 CMakeLists.txt 文件和源代码也会被处理
- 使用命令 target_link_libraries 指明可执行文件 main 需要连接一个名为 Tool 的链接库
- 子目录中的CMakeLists.txt文件为
# 查找当前目录下的所有源文件 # 并将名称保存到 LIB_SRC 变量 aux_source_directory(. LIB_SRC) #生成链接库 add_library(Tool ${LIB_SRC})
- add_library将源文件编译为静态库,详情请参考该链接
自定义编译选项
当我们需要在代码中做预编译处理时,我们如何通过cmake来指定相关的预处理宏呢?
现在我们将tool库设为一个可选库,如果该选项是ON,我们就使用其中的Message函数,否则我们使用系统printf函数。
- 为了实现这个功能我们需要在CMakeLists.txt文件中这样写
# CMake 最低版本号要求 cmake_minimum_required (VERSION 2.8) # 项目信息 project (compileOption) #通过cmake处理预定义头文件 configure_file ( "${PROJECT_SOURCE_DIR}/config.h.in" "${PROJECT_BINARY_DIR}/config.h" ) # 是否使用自己的 Tool 库 option (USE_TOOL "Use tool" on) if(USE_TOOL) #导入头文件所在路径 #PROJECT_SOURCE_DIR为cmake宏 include_directories( ${PROJECT_SOURCE_DIR}/tool ${PROJECT_BINARY_DIR} ) # 添加 math 子目录 add_subdirectory(tool) set (EXTRA_LIBS Tool) endif(USE_TOOL) # 查找当前目录下的所有源文件 # 并将名称保存到 SRC 变量 aux_source_directory(. SRC) # 指定生成目标 add_executable(compileOption ${SRC}) # 添加链接库 #该命令要在add_executable命令下方,否则报错 target_link_libraries(compileOption ${EXTRA_LIBS})
- configure_file 命令用于加入一个配置头文件 config.h ,这个文件由 CMake 从 config.h.in 生成,通过这样的机制,将可以通过预定义一些参数和变量来控制代码的生成
- option 命令添加了一个 USE_TOOL 选项,并且默认值为 ON,该选项可以在cmake时指定为OFF
- if(USE_TOOL)可以根据变量的值来确定是否使用TOOL库
- PROJECT_SOURCE_DIR为cmake预先定义好的变量,可以参考cmake文档
- EXTRA_LIBS 为自定义变量,用于保存静态库名称方便可执行文件链接链接
- set的用法请查看该链接
-
我们编写一个config.h.in文件放在工程目录下
//config.h.in#cmakedefine USE_MYMATH
-
我们的源文件这样写
//main.cpp#include "config.h" #include <stdio.h> #include <stdlib.h> #ifdef USE_TOOL #include "tool.h" #endif //USE_TOOL int main(int argc, char *argv[]) { #ifdef USE_TOOL Message(string("hello world!")); #else printf("%s %d %s",__FILE__, __LINE__, "hello world!\n"); #endif //USE_TOOL return 0; }
-
运行cmake
- mkdir build
- cd build
- cmake … (等价与cmake … -DUSE_TOOL=1) 或者 cmake … -DUSE_TOOL=0
- make
- ./compileOption
编译不同版本
#编译Debug
set(CMAKE_BUILD_TYPE "Debug")
#编译Release
set(CMAKE_BUILD_TYPE "Release")
#支持gdb
set(CMAKE_CXX_FLAGS_DEBUG "$ENV{CXXFLAGS} -O0 -Wall -g -ggdb")=
set(CMAKE_CXX_FLAGS_RELEASE "$ENV{CXXFLAGS} -O3 -Wall")
添加版本号
我们为项目添加版本号,并在源码中使用它
- 在CMakeLists.txt文件中project命令后添加如下命令
# CMake 指定运行此配置文件所需的 CMake 的最低版本 cmake_minimum_required (VERSION 2.8) # 该命令表示项目的名称是singleFile project (version) set(VERSION_MAJOR 1) set(VERSION_MINOR 0) configure_file ( "${PROJECT_SOURCE_DIR}/config.h.in" "${PROJECT_BINARY_DIR}/config.h" ) include_directories( ${PROJECT_BINARY_DIR} ) # 将名为 main.cc 的源文件编译成一个名称为 Demo 的可执行文件 add_executable(version main.cpp)
- 在config.h.in文件中写如下语句
#define VERSION_MAJOR @VERSION_MAJOR@ #define VERSION_MINOR @VERSION_MINOR@
- 我们在代码中这样使有它
#include <stdio.h> #include <stdlib.h> #include "config.h" int main(int argc, char *argv[]) { printf("%s Version %d.%d\n", argv[0], VERSION_MAJOR, VERSION_MINOR); return 0; }