0%

C++ - CMake指令

命令

指定cmake最小版本

1
cmake_minimum_required(VERSION 3.4.1)

设置项目名称

1
2
project(demo)

编译类型(可执行文件,.a , .so)

1
2
3
4
5
6
7
8
#add_executable(sample-four
# include/common.h
...)

add_library(sample-four STATIC | SHARED
include/common.h
...)

编译

1
2
3
4
5
6
7
# -B 指定目录
# -D 键值对
cmake CMakeLists.txt -B debug -DCMAKE_BUILD_TYPE=Debug

cd debug

make

搜索当前目录下的所有.cpp文件

1
2
aux_source_directory(src  SRC_LIST)
add_executable(sample-four ${SRC_LIST} )

自定义搜索规则

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
#1
file(GLOB SRC_LIST "*.cpp" "protocol/*.cpp")
add_library(demo ${SRC_LIST})

#2
file(GLOB SRC_LIST "*.cpp")
file(GLOB SRC_PROTOCOL_LIST "protocol/*.cpp")
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})

#3
file(GLOB_RECURSE SRC_LIST "*.cpp") #递归搜索
FILE(GLOB SRC_PROTOCOL_LIST RELATIVE "protocol" "*.cpp") # 相对protocol目录下搜索
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})

#4
aux_source_directory(. SRC_LIST)
aux_source_directory(protocol SRC_PROTOCOL_LIST)
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})

查找指定的库文件

1
2
3
find_library(
log-lib
log)

类似的命令还有 find_file()、find_path()、find_program()、find_package()。

设置包含的目录

1
2
3
include_directories(.)
include_directories(include)
include_directories(/usr/local/Cellar/libevent/2.1.12/include)

设置链接库搜索目录

1
2
link_directories(/usr/local/Cellar/libevent/2.1.12/lib)

设置 target 需要链接的库

1
2
target_link_libraries(sample-four event)

指定链接动态库或者静态库

1
2
target_link_libraries(demo libface.a) # 链接libface.a
target_link_libraries(demo libface.so) # 链接libface.so

指定全路径

1
2
target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a)
target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.so)

指定链接多个库

1
2
3
4
5
target_link_libraries(demo
${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a
boost_system.a
boost_thread
pthread)

set

1
2
set(SRC_LIST src/main.c src/get.c src/sum.c src/val.c)
add_executable(sample-four ${SRC_LIST} )

追加

1
2
3
set(SRC_LIST src/main.c src/get.c src/sum.c )
set(SRC_LIST ${SRC_LIST} src/val.c)
add_executable(sample-four ${SRC_LIST} )

list 追加或者删除

1
2
3
4
5
6
7
8
9
10
11
set(SRC_LIST src/main.c src/get.c src/sum.c)
message(src : ${SRC_LIST})
list(APPEND ${SRC_LIST} src/val.c include/val.h)
message(src append : ${SRC_LIST})
list(REMOVE_ITEM ${SRC_LIST} include/val.h)
message(src3 remove : ${SRC_LIST})


# src:src/main.csrc/get.csrc/sum.c
# src:src/main.csrc/get.csrc/sum.csrc/val.cinclude/val.h
# src3:src/main.csrc/get.csrc/sum.csrc/val.c

条件控制

逻辑判断和比较:

  • if (expression):expression 不为空(0,N,NO,OFF,FALSE,NOTFOUND)时为真
  • if (not exp):与上面相反
  • if (var1 AND var2)
  • if (var1 OR var2)
  • if (COMMAND cmd):如果 cmd 确实是命令并可调用为真
  • if (EXISTS dir) if (EXISTS file):如果目录或文件存在为真
  • if (file1 IS_NEWER_THAN file2):当 file1 比 file2 新,或 file1/file2 中有一个不存在时为真,文件名需使用全路径
  • if (IS_DIRECTORY dir):当 dir 是目录时为真
  • if (DEFINED var):如果变量被定义为真
  • if (var MATCHES regex):给定的变量或者字符串能够匹配正则表达式 regex 时为真,此处 var 可以用 var 名,也可以用 ${var}
  • if (string MATCHES regex)

数字比较:

  • if (variable LESS number):LESS 小于
  • if (string LESS number)
  • if (variable GREATER number):GREATER 大于
  • if (string GREATER number)
  • if (variable EQUAL number):EQUAL 等于
  • if (string EQUAL number)
    字母表顺序比较:
  • if (variable STRLESS string)
  • if (string STRLESS string)
  • if (variable STRGREATER string)
  • if (string STRGREATER string)
  • if (variable STREQUAL string)
  • if (string STREQUAL string)
    1
    2
    3
    4
    5
    6
    if(0)
    set(CMAKE_CUSTOM_VALUE 1)
    else()
    set(CMAKE_CUSTOM_VALUE 0)
    endif()
    message(value:${CMAKE_CUSTOM_VALUE})

while…endwhile

foreach…endforeach

message

1
message(songpegnfei)

包含其它 cmake 文件

1
2
3
include(./common.cmake) # 指定包含文件的全路径
include(def) # 在搜索路径中搜索def.cmake文件
set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake) # 设置include的搜索路径

常用变量

  • PROJECT_SOURCE_DIR:工程的根目录
  • PROJECT_BINARY_DIR:运行 cmake 命令的目录,通常是 ${PROJECT_SOURCE_DIR}/build
  • PROJECT_NAME:返回通过 project 命令定义的项目名称
  • CMAKE_CURRENT_SOURCE_DIR:当前处理的 CMakeLists.txt 所在的路径
  • CMAKE_CURRENT_BINARY_DIR:target 编译目录
  • CMAKE_CURRENT_LIST_DIR:CMakeLists.txt 的完整路径
  • CMAKE_CURRENT_LIST_LINE:当前所在的行
  • CMAKE_MODULE_PATH:定义自己的 cmake 模块所在的路径,SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake),然后可以用INCLUDE命令来调用自己的模块
  • EXECUTABLE_OUTPUT_PATH:重新定义目标二进制可执行文件的存放位置
  • LIBRARY_OUTPUT_PATH:重新定义目标链接库文件的存放位置
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    PROJECT_SOURCE_DIR: /Users/juneleo/demo/autotools-demo/sample-four
    PROJECT_BINARY_DIR: /Users/juneleo/demo/autotools-demo/sample-four/debug
    PROJECT_NAME: sample-four
    CMAKE_CURRENT_SOURCE_DIR: /Users/juneleo/demo/autotools-demo/sample-four
    CMAKE_CURRENT_BINARY_DIR: /Users/juneleo/demo/autotools-demo/sample-four/debug
    CMAKE_CURRENT_LIST_DIR: /Users/juneleo/demo/autotools-demo/sample-four
    CMAKE_CURRENT_LIST_LINE:18
    CMAKE_MODULE_PATH:
    EXECUTABLE_OUTPUT_PATH:
    LIBRARY_OUTPUT_PATH:

环境变量

1
2
3
4
5
6
7
8
9
10
11
# GET
message(ANDROID_NDK: $ENV{ANDROID_NDK})
message(JAVA_HOME: $ENV{JAVA_HOME})
message(ANDROID_HOME: $ENV{ANDROID_HOME})

# ANDROID_NDK:/Users/juneleo/Library/Android/sdk/android-ndk-r21e
# JAVA_HOME:/Library/Java/JavaVirtualMachines/jdk1.8.0_291.jdk/Contents/Home
# ANDROID_HOME:/Users/juneleo/Library/Android/sdk

# SET
set(ENV{Name} value) # 这里没有“$”符号

系统信息

  • CMAKE_MAJOR_VERSION:cmake 主版本号,比如 3.4.1 中的 3
  • ­CMAKE_MINOR_VERSION:cmake 次版本号,比如 3.4.1 中的 4
  • CMAKE_PATCH_VERSION:cmake 补丁等级,比如 3.4.1 中的 1
  • CMAKE_SYSTEM:系统名称,比如 Linux-­2.6.22
  • ­CMAKE_SYSTEM_NAME:不包含版本的系统名,比如 Linux
  • ­CMAKE_SYSTEM_VERSION:系统版本,比如 2.6.22
  • ­CMAKE_SYSTEM_PROCESSOR:处理器名称,比如 i686
  • UNIX:在所有的类 UNIX 平台下该值为 TRUE,包括 OS X 和 cygwin
  • ­WIN32:在所有的 win32 平台下该值为 TRUE,包括 cygwin

主要开关选项

  • BUILD_SHARED_LIBS:这个开关用来控制默认的库编译方式,如果不进行设置,使用 add_library 又没有指定库类型的情况下,默认编译生成的库都是静态库。如果 set(BUILD_SHARED_LIBS ON) 后,默认生成的为动态库
  • CMAKE_C_FLAGS:设置 C 编译选项,也可以通过指令 add_definitions() 添加
  • CMAKE_CXX_FLAGS:设置 C++ 编译选项,也可以通过指令 add_definitions() 添加