> 文章列表 > CMake教程

CMake教程

CMake教程

CMake教程

      • 什么是CMake
      • 单个源文件
      • 多个源文件
        • 同一目录,多个源文件
        • 多个目录,多个源文件(添加库)
        • 头文件和源代码分开
      • 优化CMakeLists.txt
        • set 与 PROJECT_NAME
      • END

什么是CMake

允许开发者编写一种平台无关的 CMakeList.txt 文件来定制整个编译流程,然后再根据目标用户的平台进一步生成所需的本地化 Makefile 和工程文件,如 Unix 的 Makefile 或 Windows 的 Visual Studio 工程。从而做到“Write once, run everywhere”。

单个源文件

假设项目中只有一个源文件main.cc
编写 CMakeLists.txt 文件,并保存在与main.cc 源文件同个目录下:

# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项目信息
project (Demo1)
# 指定生成目标
add_executable(Demo main.cc)

CMakeLists.txt 的语法比较简单,由命令、注释和空格组成,其中命令是不区分大小写的。符号 # 后面的内容被认为是注释。命令由命令名称、小括号和参数组成,参数之间使用空格进行间隔。

对于上面的 CMakeLists.txt 文件,依次出现了几个命令:

  1. cmake_minimum_required:指定运行此配置文件所需的 CMake 的最低版本;
  2. project:参数值是 Demo1,该命令表示项目的名称是 Demo1 ;
  3. add_executable:将名为 main.cc 的源文件编译成一个名称为 Demo 的可执行文件。
    之后,在当前目录执行 cmake . ,得到 Makefile 后再使用 make 命令编译得到 Demo1 可执行文件。

多个源文件

同一目录,多个源文件

文件目录结构如下:

./Demo2|+--- main.cc|+--- MathFunctions.cc|+--- MathFunctions.h

CMakeLists.txt 可以改成如下的形式:

cmake_minimum_required(VERSION 2.8)
project(Demo2)
add_execuatable(Demo main.cc MathFunctions.cc)

唯一的改动只是在 add_executable 命令中增加了一个 MathFunctions.cc 源文件.但是如果源文件很多,把所有源文件的名字都加进去将是一件烦人的工作。更省事的方法是使用 aux_source_directory 命令,该命令会查找指定目录下的所有源文件,然后将结果存进指定变量名:

aux_source_directory(<dir> <variable>)

可以修改 CMakeLists.txt 如下:

cmake_minimum_required(VERSION 2.8)
project(Demo2)
# 查找当前目录下的所有源文件
# 并将名称保存到 DIR_SRCS 变量
aux_source_directory(. DIR_SRCS)
add_execuatable(Demo ${DIR_SRCS})

这样,CMake 会将当前目录所有源文件的文件名赋值给变量 DIR_SRCS ,再指示变量DIR_SRCS中的源文件需要编译成一个名称为 Demo 的可执行文件。

多个目录,多个源文件(添加库)

文件目录结构如下:

./Demo3|+--- main.cc|+--- math/|+--- MathFunctions.cc|+--- MathFunctions.h

这种情况,需要分别在项目根目录 Demo3 和 math 目录里各编写一个 CMakeLists.txt 文件。为了方便,可以先将 math 目录里的文件编译成静态库再由 main 函数调用。
根目录中的 CMakeLists.txt :

cmake_minimum_required(VERSION 2.8)
project(Demo3)
aux_source_directory(. DIR_SRCS)
# 添加math子目录
add_subdirectory(math)
add_execuable(Demo main.cc)
# 添加链接库
target_link_libraries(Demo MathFunctions)

add_subdirectory指明本项目包含一个子目录 math,这样 math 目录下的 CMakeLists.txt 文件和源代码也会被处理 。
target_link_libraries 指明可执行文件 main 需要连接一个名为 MathFunctions 的链接库。
子目录中的CMakeLists.txt :

# 查找当前目录下的所有源文件
# 并将名称保存到 DIR_LIB_SRCS 变量
aux_source_directory(. DIR_LIB_SRCS)
add_library(MathFunctions ${DIR_LIB_SRCS})

在该文件中使用命令add_library 将 src 目录中的源文件编译为静态链接库。

头文件和源代码分开

文件目录结构如下:

./Demo4|+--- include/|+--- a.h|+--- b.h+--- src/|+--- a.cc|+--- b.cc

CMakeLists.txt 如下:

cmake_minimum_required(VERSION 3.5)
project(Demo4)
find_package(OpenCV REQUIRED)
include_directories(./include)
SET(STATION src/a.cc src/b.cc)
add_executable(station ${STATION})
target_link_libraries(station ${OpenCV_LIBS})

优化CMakeLists.txt

set 与 PROJECT_NAME

以单个源文件为例,可以使用 PROJECT_NAME 来表示项目名(这样如果有多个地方用到这个项目名,改动比较小)

add_executable(${PROJECT_NAME} main.cc)

可以用一个变量来表示多个源文件:

set(SRC_LIST a.cc b.cc c.cc)
add_executable(${PROJECT_NAME} ${SRC_LIST})

于是原来的源文件可以写成:

# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项目信息
project (Demo1)
set(SRC_LIST main.cc)
# 指定生成目标
add_executable(${PROJECT_NAME} ${SRC_LIST})

END

目前开发过程中用到的就这些,后面视情况补充。。。

网赚资料