总结CMake的常用命令,并介绍有用的CMake资源。

CMake意为cross-platform make,可用于管理c/c++工程。CMake解析配置文件CMakeLists.txt生成Makefile,相比直接用Makefile管理工程,CMake更灵活和简单。

简单的例子?

一个完整的Demo可参考这里

假设当前目录的结构为

./a.cpp
./b.cpp ./include/common.h
./include/defines.h ./other/c.cpp
./other/d.cpp ./lib/libB.a
./lib/libBd.a
./lib/libA.so
./lib/libAd.so
./lib/libB.so
./lib/libBd.so
./lib/libC.so
./lib/libCd.so

使用下面的CMakeLists.txt文件,目标是编译当前目录和./other目录下的所有源文件,并链接./lib目录下的相应库文件到最终的可执行文件./bin/hello(或./bin/hellod)。

cmake_minimum_required(VERSION 2.8)
project(helloworld) set(CMAKE_VERBOSE_MAKEFILE on)
set(CMAKE_CXX_COMPILER "g++")
set(CMAKE_CXX_FLAGS "")
set(CMAKE_CXX_FLAGS_DEBUG "-g3 -Wall")
set(CMAKE_CXX_FLAGS_RELEASE "-O2 -Wall")
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin) aux_source_directory(./ SRC_LIST)
aux_source_directory(./other OTHER_SRC_LIST)
list(APPEND SRC_LIST ${OTHER_SRC_LIST}) include_directories(${PROJECT_SOURCE_DIR}/include)
link_directories(${PROJECT_SOURCE_DIR}/lib) if(${MY_BUILD_TYPE} MATCHES "debug")
add_executable(hellod ${SRC_LIST})
target_link_libraries(hellod Ad Bd.a Cd.so)
else()
add_executable(hello ${SRC_LIST})
target_link_libraries(hello A B.a C.so)
endif()

执行命令cmake -DMY_BUILD_TYPE=debug .生成Makefile,make之后生成./bin/hellod(调试版本),或执行cmake .最后生成./bin/hello。

常用的CMake变量?

详细内容请参考CMake Useful Variables

  • PROJECT_SOURCE_DIR 工程的源文件目录,通常是包含CMakeLists.txt(有Project命令的)的目录。

自定义变量?

可在命令行下向CMake传递自定义变量

cmake -DMY_VAR=hello .

然后在CMakeLists.txt中使用,注意大小写。

message(${MY_VAR})

构建类型?

cmake默认支持多种构建类型(build type),每种构建类型都有专门的编译参数变量,详情见下表1:

CMAKE_BUILD_TYPE 对应的c编译选项变量 对应的c++编译选项变量
None CMAKE_C_FLAGS CMAKE_CXX_FLAGS
Debug CMAKE_C_FLAGS_DEBUG CMAKE_CXX_FLAGS_DEBUG
Release CMAKE_C_FLAGS_RELEASE CMAKE_CXX_FLAGS_RELEASE
RelWithDebInfo CMAKE_C_FLAGS_RELWITHDEBINFO CMAKE_CXX_FLAGS_RELWITHDEBINFO
MinSizeRel CMAKE_C_FLAGS_MINSIZEREL CMAKE_CXX_FLAGS_MINSIZEREL

在CMakeLists.txt中可以自定义编译选项变量

set(CMAKE_CXX_FLAGS_RELEASE "-Wall -O2")

然后运行cmake的时候,传入相应的构建类型即可

cmake -DCMAKE_BUILD_TYPE=Release

常用命令?

详情可参考对应版本的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
)

更多的例子?

自定义Makefile目标的完整例子?

下面的CMakeLists.txt添加一个自定义目标proto,该目标在编译工程前,会先调用protobuf程序编译先生成Google Protocol Buffers的消息解析器。

cmake_minimum_required(VERSION 2.6)
project(protobuf-demo) # compile proto files
set(PROTO_IN news.proto)
set(PROTO_SRC news.pb.cc)
set(PROTO_OUT news.pb.h news.pb.cc proto/) add_custom_command(
OUTPUT ${PROTO_OUT}
COMMAND protoc --cpp_out . --java_out . ${PROTO_IN}
DEPENDS ${PROTO_IN}
)
add_custom_target(proto DEPENDS ${PROTO_OUT}) aux_source_directory(. SRC_LIST)
list(APPEND SRC_LIST
${PROTO_SRC}
) set(CMAKE_CXX_COMPILER "g++")
set(CMAKE_CXX_FLAGS "-Wall")
set(CMAKE_VERBOSE_MAKEFILE on) add_executable(demo ${SRC_LIST})
add_dependencies(demo proto)
target_link_libraries(demo protobuf)

阅读资料?

  1. CMake文档列表
  2. CMake常用变量列表
  3. CMake入门教程

脚注?

CMake使用总结的更多相关文章

  1. 使用cmake自动构建工程

    公司引擎是用cmake根据目标平台来构建工程的,刚接触的时候深深体会到cmake的方便:如果目标平台是windows,它可以帮你自动构建出vs工程:如果是安卓,自动构建出eclipse工程,如果是IO ...

  2. CMake

    使用CMake编译跨平台静态库 http://www.tuicool.com/articles/3uu2Yj cmake命令 安装.用法简介 https://fukun.org/archives/04 ...

  3. CMake学习笔记

    C++开发者必备技能CMake  先简单介绍一下,CMake是一个跨平台的编译工具,它可以根据不用的平台,不同的编译环境,生成不同的MakeFile,从而控制编译的过程. 使用CMake的步骤: 1. ...

  4. VS 2013编译64位版本QT 4.8.6及使用cmake为依赖QT生成VS项目时Could NOT find Qt4

    对于一些已经解决的问题,本博客不再讨论.只将本人遇到的问题做简单的说明. 一.VS 2013编译64位版本QT 4.8.6 QT项目官网中,对于QT4,其只提供了windows X86的版本,并且支持 ...

  5. cmake cannot find package

    cmake 找不到package,如 find_package (OpenMesh REQUIRED) 出现错误 在项目的文件夹中找到 FindOpenMesh.cmake 文件,将其所在路径添加到 ...

  6. Cmake的交叉编译

    http://www.cmake.org/Wiki/CMake_Cross_Compiling

  7. CMake命令/函数汇总(翻译自官方手册)

    查看官方文档 cmake命令 选项 CMake变量 CMake命令汇总 / add_custom_command add_custom_target/add_definitions/add_depen ...

  8. 《CMake实践》笔记一:PROJECT/MESSAGE/ADD_EXECUTABLE

    <CMake实践>笔记一:PROJECT/MESSAGE/ADD_EXECUTABLE <CMake实践>笔记二:INSTALL/CMAKE_INSTALL_PREFIX &l ...

  9. 《CMake实践》笔记二:INSTALL/CMAKE_INSTALL_PREFIX

    <CMake实践>笔记一:PROJECT/MESSAGE/ADD_EXECUTABLE <CMake实践>笔记二:INSTALL/CMAKE_INSTALL_PREFIX &l ...

  10. 《CMake实践》笔记三:构建静态库(.a) 与 动态库(.so) 及 如何使用外部共享库和头文件

    <CMake实践>笔记一:PROJECT/MESSAGE/ADD_EXECUTABLE <CMake实践>笔记二:INSTALL/CMAKE_INSTALL_PREFIX &l ...

随机推荐

  1. Python之布尔

    Python之布尔(bool) 在计算机中的所用判断,都是用布尔的True和False来判断的. 条件成立:True ( 1 ) 条件不成立:False ( 0 ) 以下情况是False: [ ]:空 ...

  2. Python之FTP实现

    Python之FTP实现 上传下载: import socket import struct import json import subprocess import os class MYTCPSe ...

  3. 转载,Django组件

    知识预览 一 Django的form组件 二 Django的model form组件 三 Django的缓存机制 四 Django的信号 五 Django的序列化 回到顶部 一 Django的form ...

  4. 11-看图理解数据结构与算法系列(B树的删除)

    删除操作 删除操作比较复杂,主要是因为删除的项可能在叶子节点上也可能在非叶子节点上,而且删除后可能导致不符合B树的规定,这里暂且称之为导致B树不平衡,于是要进行一些合并.左旋.右旋等操作,使之符合B树 ...

  5. FPGA学习笔记(六)—— 时序逻辑电路设计

    用always@(posedge clk)描述        时序逻辑电路的基础——计数器(在每个时钟的上升沿递增1) 例1.四位计数器(同步使能.异步复位) // Module Name: coun ...

  6. node学习的一些网站

    Node.js 包教不包会 篇幅比较少 node express 入门教程 nodejs定时任务 一个nodejs博客 [NodeJS 学习笔记04]新闻发布系统 过年7天乐,学nodejs 也快乐 ...

  7. idea 修改Git密码和账号方法

    IDEA修改git账号及密码的方法: 1.file->settings->passwords 2.重启IDEA 3.执行一次提交或更新 当执行提交或更新之后,idea会自动提示输入账号.密 ...

  8. python用模块zlib压缩与解压字符串和文件的方法

    摘自:http://www.jb51.net/article/100218.htm Python标准模块中,有多个模块用于数据的压缩与解压缩,如zipfile,gzip, bz2等等. python中 ...

  9. bzoj 1413 [ZJOI2009]取石子游戏

    1413: [ZJOI2009]取石子游戏 Time Limit: 10 Sec  Memory Limit: 162 MBSubmit: 747  Solved: 490[Submit][Statu ...

  10. JDK源码解析(一)ArrayList源码解析

    这里为了方便写注释,我是把ArrayList的源码复制下来放到自己创建的类里面的 这个变量则指向具体存放数据的数组 看下构造函数吧 点进去看下LinkedList是怎么数组化的 很弱智吧,就是创建一个 ...