[Linux]cmake工具的使用

本文主要介绍CMake工具的使用，主要是在linux系统下结合OpenCV的一些使用例程。

Cmake简介

CMake 是一个跨平台的自动化建构系统,它使用一个名为 CMakeLists.txt 的文件来描述构建过程,可以产生标准的构建文件,如 Unix 的 Makefile 或Windows Visual C++ 的 projects/workspaces 。文件 CMakeLists.txt 需要手工编写,也可以通过编写脚本进行半自动的生成。在 linux 平台下使用 CMake 生成 Makefile 并编译的流程如下：

1. 编写CmakeLists.list

2. 执行“cmake Path”命令

3. 使用make命令进行编译

第一个工程

现假设我们的项目中只有一个源文件 main.cpp

清单1 main.cpp

#include
int main()
{
std::cout

cmake [options] <path-to-source>

为了构建该项目，我们需要编写文件CMakeList.txt 并将其与main.cpp放在同一个目录下：

清单2 CMakeList.txt

PROJECT(main)        #项目名称是main
CMAKE_MINIMUM_REQUIRED(VERSION 2.6)        #cmake版本
AUX_SOURCE_DIRECTORY(. DIR_SRCS)        #将当前目录中的源文件名称赋给变量DIR_SRCS
ADD_EXECUTABLE(main ${DIR_SRCS})        #将变量ADD_EXECUTABLE指示变量DIR_SRCS中的源文件需要编译成一个main的可执行文件。

语法比较简单，由命令、注释和空格组成，其中命令是不区分大小写的，符号“#”后面的内容被认为是注释。

完成了CMakeLists.txt的编写后需要使用cmake或ccmake命令生成Makefile。ccmake会提供一个图形化的操作界面。

处理多源文件目录的方法

CMake处理代码在不同目录中的情况也非常简单。先假设我们的代码分布情况如下：



其中src目录下的文件要编译成一个链接库。

第一步，项目主目录中的CMakeLists.txt

清单 3. 目录step2 中的 Cmakelists.txt

PROJECT(main)        #项目名称是main
CMAKE_MINIMUM_REQUIRED(VERSION 2.6)        #cmake版本
ADD_SUBDIRECTORY( src)              #指明本项目包含一个子目录src
AUX_SOURCE_DIRECTORY(. DIR_SRCS)        #将当前目录中的源文件名称赋给变量DIR_SRCS
ADD_EXECUTABLE(main ${DIR_SRCS})        #将变量ADD_EXECUTABLE指示变量DIR_SRCS中的源文件需要编译成一个main的可执行文件。
TARGET_LINK_LIBRARIES( mian Test ）

第二步，子目录中的Cmakelists.txt

在子目录中src中创建CmakeLists.txt。文件内容如下：

清单 4. 目录src中的Cmakelists.txt

AUX_SOURCE_DIRECTROY(. DIR_TEST1_SRCS)
ADD_LIBRARY(Test ${DIR_TEST1_SRCS})

在该文件中使用命令ADD_LIBRARY将src目录中的源文件编译为共享库。

第三步， 执行cmake

至此我们完成了项目中所有Cmakelists.txt文件的编写，进入目录step2中 依次执行命令“cmake”和“make：得到如下结果。

在工程中查找并使用其他程序库的方法

在开发软件的时候我们会用到一些库，这些函数库在不同的系统中安装的位置可能不同。编译的时候需要首先找到这些软件包的头文件以及链接库所在的目录以便生成编译选项。例如一个需要Berkeley数据库项目db_cxx.h和链接库libdb_cxx.so,现在该项目中有一个源代码main.cpp，放在项目的根目录中。

第一步，程序库说明文件

在项目的根目录中创建目录cmake/modules/,在cmake/modules/下创建Findlibdb_cxx.cmake，内容如下：

清单 5. 文件Findlibdb_cxx.cmake

MESSAGE(STATUS "Using bundled Findlibdb.cmke...")
FIND_PATH(
LIBDB_CXX_INCLUDE_DIR
db_cxx.h
/usr/include/
/usr/local/include/
)

FIND_LIBRARY(
LIBDB_CXX_LIBRARIES NAMES db_cxx
PATH /usr/lib/ /usr/local/lib/

)

文件 Findlibdb_cxx.cmake 的命名要符合规范: FindlibNAME.cmake ,其中NAME 是函数库的名称。Findlibdb_cxx.cmake 的语法与 CMakeLists.txt 相同。这里使用了三个命令： MESSAGE ， FIND_PATH 和 FIND_LIBRARY 。

命令MESSAGE会将参数的内容输出到终端。

命令FIND_PATH指明头文件查找的路径，原型如下：

find_path( name1 [ path1 path2 …])该命令在参数path*指示的目录中查找文件name1并将查找到的路径保存在变量VAR中。清单5第3-8行的意思是在/usr/include/和/usr/local/include/中查找db_cxx.h，并将db_cxx.h所在的路径保存在LIBDB_CXX_INCLUDE_DIR中

命令FIND_LIBRARY 同 FIND_PATH 类似,用于查找链接库并将结果保存在变量中。清单5第10－13行的意思是在目录 /usr/lib/ 和 /usr/local/lib/ 中寻找名称为 db_cxx 的链接库,并将结果保存在 LIBDB_CXX_LIBRARIES。

第二步， 项目的根目录中的Cmakelists.txt

在项目的根目录中创建Cmakelists.txt

清单 6. 可以查找链接库的Cmakelists.txt

PROJECT(main)
CMAKE_MINIMUM_REQUIRED(VERSION 2.6)
SET(CMAKE_SOURCE_DIR .)
SET(CMAKE_MODULE_PATH ${CMAKE_ROOT}/modules ${CMAKE_SOURCE_DIR}/cmake/modules)
AUX_SOURCE_DIRECTORY(. DIR_SRCS)
ADD_EXECUTABLE(main ${DIR_SRCS})
FIND_PACKAGE( libdb_cxx REQUIRED)
MARK_AS_ADVANCED(
LIBDB_CXX_INCLUDE_DIR
LIBDB_CXX_LIBRARIES
)
IF (LIBDB_CXX_INCLUDE_DIR AND LIBDB_CXX_LIBRARIES)
MESSAGE(STATUS "Found libdb libraries")
INCLUDE_DIRECTORIES(${LIBDB_CXX_INCLUDE_DIR})
MESSAGE( ${LIBDB_CXX_LIBRARIES} )
TARGET_LINK_LIBRARIES(main ${LIBDB_CXX_LIBRARIES}18 )
ENDIF (LIBDB_CXX_INCLUDE_DIR AND LIBDB_CXX_LIBRARIES)

第8行使用命令 FIND_PACKAGE 进行查找,这条命令执行后 CMake 会到变量 CMAKE_MODULE_PATH 指示的目录中查找文件 Findlibdb_cxx.cmake 并执行。第13-19行是条件判断语句,表示如果 LIBDB_CXX_INCLUDE_DIR 和 LIBDB_CXX_LIBRARIES 都已经被赋值,则设置编译时到 LIBDB_CXX_INCLUDE_DIR 寻找头文件并且设置可执行文件 main 需要与链接库 LIBDB_CXX_LIBRARIES 进行连接。

第三步， 执行cmake

完成Findlibdb_cxx.cmake和CMakelists.txt的编写后在项目的根目录依次执行”cmake . “和“make”进行 编译，结果如下图

使用cmake生成debug和release版的程序

debug 版的项目生成的可执行文件需要有调试信息并且不需要进行优化,而 release 版的不需要调试信息但需要优化。这些特性在 gcc/g++ 中是通过编译时的参数来决定的,如果将优化程度调到最高需要设置参数-O3,最低是 -O0 即不做优化;添加调试信息的参数是 -g -ggdb ,如果不添加这个参数,调试信息就不会被包含在生成的二进制文件中。

CMake 中有一个变量 CMAKE_BUILD_TYPE ,可以的取值是 Debug Release RelWithDebInfo 和 MinSizeRel。当这个变量值为 Debug 的时候,CMake 会使用变量 CMAKE_CXX_FLAGS_DEBUG 和 CMAKE_C_FLAGS_DEBUG 中的字符串作为编译选项生成 Makefile ,当这个变量值为 Release 的时候,工程会使用变量 CMAKE_CXX_FLAGS_RELEASE 和 CMAKE_C_FLAGS_RELEASE 选项生成 Makefile。

现假设项目中只有一个main.cpp，下面是一个可以选择生成debug和release版的程序的CMakelists.txt

清单 7

PROJECT（main）
CMAKE_MINIMUM_REQUIRED(VERSION 2.6)
SET(CMAKE_SOURCE .)
SET(CMAKE_CXX_FLAGS_DEBUG "$ENV{CXXFLAGS} -O0 -Wall -g -ggdb")
SET(CMAKE_CXX_FLAGS_RELEASE "$ENV{CXXFLAGS} -O3 -Wall")
AUX_SOURCE_DIRECTORY(. DIR_SRCS)
ADD_EXECUTABLE(main ${DIR_SRCS})

第 5 和 6 行设置了两个变量 CMAKE_CXX_FLAGS_DEBUG 和 CMAKE_CXX_FLAGS_RELEASE, 这两个变量是分别用于 debug 和 release 的编译选项。 编辑 CMakeList.txt 后需要执行 ccmake 命令生成 Makefile 。在进入项目的根目录,输入 “ccmake .” 进入一个图形化界面,如下图所示：



这里写链接内容