0%

cmake使用

Posted on Edited on In
Symbols count in article: 5.5k Reading time ≈ 5 mins.

A Basic Starting Point (Step1)

CMakeLists.txt文件：

cmake_minimum_required (VERSION 2.6)
project (Tutorial)
add_executable(Tutorial tutorial.cxx)

cmake_minimum_required：是判断需要cmake的最小版本号。所有程序都需要这个。

project:用于指定工程的名字。

add_executable命令用于指定程序从哪些源文件生成。此例中 程序 Tutorial则是tutorial.cxx 源文件生成。

添加版本号和配置头文件：

cmake_minimum_required (VERSION 2.6)
project (Tutorial)
# The version number.
set (Tutorial_VERSION_MAJOR 1)
set (Tutorial_VERSION_MINOR 0)

# configure a header file to pass some of the CMake settings
# to the source code
configure_file (
        "${PROJECT_SOURCE_DIR}/TutorialConfig.h.in"
        "${PROJECT_BINARY_DIR}/TutorialConfig.h"
        )

# add the binary tree to the search path for include files
# so that we will find TutorialConfig.h
include_directories("${PROJECT_BINARY_DIR}")

# add the executable
add_executable(Tutorial tutorial.cxx)

因为配置文件会被生成到二进制目录中，所以我们需要把二进制目录加入到头文件搜索路径中
(include），然后我们在源码目录中建立如下 ‘TutorialConfig.h.in’：

    // the configured options and settings for Tutorial
    #define Tutorial_VERSION_MAJOR @Tutorial_VERSION_MAJOR@
    #define Tutorial_VERSION_MINOR @Tutorial_VERSION_MINOR@

执行cmake时，配置文件头文件中@Tutorial_VERSION_MAJOR@ 和 @Tutorial_VERSION_MINOR@的值将会被
CMakeLists.txt文件中指定的值所替换。然后我们可以在源文件tutorial.cxx引用这个所定义的宏：

fprintf(stdout,"%s Version %d.%d\n",
    argv[0],
    Tutorial_VERSION_MAJOR,
    Tutorial_VERSION_MINOR);
fprintf(stdout,"Usage: %s number\n",argv[0]);

Adding a Library (Step 2)

添加一个库到工程中：

add_library(MathFunctions mysqrt.cxx)

将mysqrt.cxx源文件打包为库文件MathFunctions，
使用add_subdirectory命令指示这个目录需要进行编译。
用include_directories命令添加MathFunctions目录，
是为了能让编译程序找到 mysqrt.h 头文件。
然后用target_link_libraries命令把生成的库链接到执行文件中：

#增加头文件搜索目录
include_directories ("${PROJECT_SOURCE_DIR}/MathFunctions")
#增加子目录
add_subdirectory (MathFunctions) 
# 生成执行文件
add_executable (Tutorial tutorial.cxx)
#链接库
target_link_libraries (Tutorial MathFunctions)

Installing and Testing (Step 3)

在工程中增加一个安装规则和测试支持。我们需要把库安装到bin目录下，把头文件安装到include下：

install (TARGETS MathFunctions DESTINATION bin)
install (FILES MathFunctions.h DESTINATION include)

对于这个向导程序，需要在顶层CMakeList.txt文件中增加下面行，安装执行文件和头文件。

# 安装程序 Tutorial到安装目录的bin子目录中
install (TARGETS Tutorial DESTINATION bin)
#安装头文件到安装目录中的include目录中
install (FILES "${PROJECT_BINARY_DIR}/TutorialConfig.h" DESTINATION include)

CMake用变量CMAKE_INSTALL_PREFIX决定安装的根目录。

常用cmake命令

检查CMake版本

cmake版本至少为2.8

cmake_minimum_required(VERSION 2.8)

定义工程名称

工程名为helloworld

project(helloworld)

查找源文件

查找当前目录下所有的源文件并保存到SRC_LIST变量里

aux_source_directory(. SRC_LIST)

查找src目录下所有以cmake开头的文件并保存到CMAKE_FILES变量里

file(GLOB CMAKE_FILES "src/cmake*")

file命令同时支持目录递归查找

file(GLOB_RECURSE CMAKE_FILES "src/cmake*")

按照官方文档的说法，不建议使用file的GLOB指令来收集工程的源文件，原文解释如下：

We do not recommend using GLOB to collect a list of source files from your source tree.
If no CMakeLists.txt file changes when a source is added or removed
then the generated build system cannot know when to ask CMake to regenerate.
大意就是，GLOB收集的源文件增加或删除，而CMakeLists.txt没有发生修改时，CMake不能识别这些文件。
其实，当CMakeLists.txt使用aux_source_directory和file glob查找工程源文件时，如果添加或删除源文件，都需要重新运行CMake。

set命令

经常配合set命令使用的CMake变量，使用set(variable value)进行设置。

  • CMAKE_VERBOSE_MAKEFILE on 输出详细的编译和链接信息
  • CMAKE_CXX_COMPILER “g++” c++编译器
  • CMAKE_CXX_FLAGS “-Wall” c++编译器参数
    • CMAKE_CXX_FLAGS_DEBUG debug版本对应的编译器参数
    • CMAKE_CXX_FLAGS_RELEASE release版本对应的编译器参数
  • EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin 可执行文件的输出目录
  • LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib 链接库的输出目录

set命令还可以设置自定义变量，比如

set(MY_GREETINGS "hello world")

包含目录和链接目录

将./include和./abc加入包含目录列表

include_directories(
        ./include
        ./abc
        )

将./lib加入编译器链接阶段的搜索目录列表

link_directories(
        ./lib
        )

添加生成目标

使用SRC_LIST源文件列表里的文件生成一个可执行文件hello

add_executable(hello ${SRC_LIST})

使用SRC_LIST源文件列表里的文件生成一个静态链接库libhello.a

add_library(hello STATIC ${SRC_LIST})

使用SRC_LIST源文件列表里的文件生成一个动态链接库libhello.so

add_library(hello SHARED ${SRC_LIST})

将若干库文件链接到生成的目标hello(libhello.a或libhello.so)

target_link_libraries(hello A B.a C.so)

需要注意的是，target_link_libraries里库文件的顺序符合gcc链接顺序的规则，
即被依赖的库放在依赖它的库的后面，比如上面的命令里，
libA.so可能依赖于libB.a和libC.so，
如果顺序有错，链接时会报错。
还有一点，B.a会告诉CMake优先使用静态链接库libB.a，
C.so会告诉CMake优先使用动态链接库libC.so，也可直接使用库文件的相对路径或绝对路径。

自定义链接选项

有时候需要自定义链接选项，比如需要单独对B.a使用–whole-archive选项，可以

target_link_libraryies(hello A -Wl,--whole-archive B.a -Wl,--no-whole-archive C.so)

自定义Makefile目标

运行下面的whatever目标make whatever，会先创建一个目录./hello，然后将当前目录的a.txt拷贝到新建的./hello目录里。

add_custom_command(
        OUTPUT ./hello/a.txt
        COMMAND mkdir -p ./hello 
        cp a.txt ./hello
        DEPENDS a.txt
        )
add_custom_target(whatever DEPENDS ./hello/a.txt)

自定义目标还可以使用add_dependencies命令加入到其他目标的依赖列表里，当执行make demo时，whatever目标会被自动调用。

add_executable(demo ${SRC_LIST})
add_dependencies(demo whatever)

其他常用命令

包含其他目录的CMakeLists.txt

include(/path/to/another/CMakeLists.txt)

if命令

if(${MY_BUILD_TYPE} MATCHES "debug")
    ...
else()
    ...
endif()

list命令

list(APPEND SRC_LIST 
        a.cpp
        b.cpp
    )

list(REMOVE_ITEM SRC_LIST
        a.cpp
    )

示例

CMAKE_MINIMUM_REQUIRED(VERSION 2.8)
PROJECT(demo)

# add include dir
INCLUDE_DIRECTORIES(.)
INCLUDE_DIRECTORIES(lua/src)

# add source dir
AUX_SOURCE_DIRECTORY(lua/src/           SRCS)
AUX_SOURCE_DIRECTORY(lua/lua-cjson-xml/ SRCS)

ADD_LIBRARY(demo ${SRCS})

SET(CMAKE_BUILD_TYPE "Release")

ADD_DEFINITIONS(-D_FILE_OFFSET_BITS=64 -D_LARGEFILE64_SOURCE -Wno-deprecated-declarations )

SET(CMAKE_EXE_LINKER_FLAGS "--static")
ADD_EXECUTABLE(test main.cpp)
TARGET_LINK_LIBRARIES(A demo jansson dl pthread curl z)

INSTALL(FILES demo.hpp http.hpp DESTINATION include)

Ref

引用文档：

  1. cmake syntax
  2. cmake tutorial
  3. CMake常用变量列表
  4. CMake文档列表
  5. cmake modules
  6. CMake 使用总结
  7. CMake 用法导览