CMake学习-01 综述

CLion是一款流行的跨平台IDE,它使用CMake作为构建系统。本章开始简单了解下CMake相关知识

1 CMake

CMake是一个跨平台的安装(编译)工具,可以用简单的语句来描述所有平台的安装(编译过程)。他能够输出各种各样的makefile或者project文件,能测试编译器所支持的“C++”特性,类似UNIX下的automake。只是CMake的组态档取名为 CMakeLists.txt。Cmake并不直接建构出最终的软件,而是产生标准的建构档(如 Unix 的 Makefile 或 Windows Visual (视觉) C++ 的 projects/workspaces),然后再依一般的建构方式使用。这使得熟悉某个集成开发环境(IDE)的开发者可以用标准的方式建构他的软件,这种可以使用各平台的原生建构系统的能力是CMake和SCons等其他类似系统的区别之处。

1.1 CMake生成makefile并编译的流程

  • 在Linux平台下使用CMake生成Makefile并编译的流程如下:
    1. 编写CMake配置文件CMakeLists.txt 。
    2. 执行命令cmake PATH或者ccmake PATH生成Makefile。ccmakecmake的区别在于前者提供了一个交互式的界面,其中,PATH是CMakeLists.txt所在的目录。
    3. 使用make命令进行编译。

2 CMakeLists.txt

CMakeLists.txt文件是CMake的配置文件,它描述了如何构建你的项目。

2.1 Demo讲解

在CLion中创建新项目时,它会自动生成一个包含基本配置的CMakeLists.txt文件。其内容如下:

# CMake最低版本号要求
cmake_minimum_required(VERSION 3.17)
# 项目信息
project(demo_codes C)
# 使用C90标准
set(CMAKE_C_STANDARD 90)
# 指定生成目标
add_executable(demo_codes main.c)

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

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

  1. cmake_minimum_required:指定运行此程序所需要的CMake的最低版本。
  2. project:参数为:demo_codes,表示该项目名称是:demo_codes
  3. set:参数为:CMAKE_C_STANDARD 90,表示:设置C标准为C90
  4. add_executable:参数为:demo_codesmain.c,表示:将名为main.c的文件编译为名为demo_codes的可执行文件

2.2 常用命令

2.2.1 指定CMAKE的最低版本

这行命令是可选的,可以不写这句话,但在有些情况下,如果CMakeLists.txt文件中使用了一些高版本cmake特有的一些命令的时候,就需要加上这样一行,提醒用户升级到该版本之后再执行cmake

cmake_minimum_required(VERSION 3.17)

2.2.2 设置项目名称

这个命令不是强制性的,但最好都加上。它会引入两个变量demo_BINARY_DIRdemo_SOURCE_DIR,同时,cmake 自动定义了两个等价的变量PROJECT_BINARY_DIRPROJECT_SOURCE_DIR

project(demo_codes C)

2.2.3 设置变量

set(变量名 值)可以使用${变量名}引用set定义的变量 例:${CMAKE_CXX_STANDARD}。变量名和值之间以空格隔开。

set(CMAKE_C_STANDARD 90)
  • set直接设置变量的值
set(SRC_LIST main.cpp test.cpp)
add_executable(demo ${SRC_LIST})
  • set追加设置变量的值
set(SRC_LIST main.cpp)
set(SRC_LIST ${SRC_LIST} test.cpp)
add_executable(demo ${SRC_LIST})
  • list追加或者删除变量的值
set(SRC_LIST main.cpp)
list(APPEND SRC_LIST test.cpp)
list(REMOVE_ITEM SRC_LIST main.cpp)
add_executable(demo ${SRC_LIST})

2.2.4 设置编译类型

  • 生成可执行文件,如果是需要生成多个可执行文件,则可以配置多个。Linux下生成:demo_codes可执行程序,Windows下生成:demo_code.exe可执行程序
add_executable(demo_codes main.c)
add_executable(demo_codes_lear_c learn_c/chap01/list0101.c)
  • 生成静态库,add_library如果不加STATIC,默认生成的就是静态库。Linux下生成libdemo_codes_common.a的静态库。Windows下生成libdemo_codes_common.lib静态库
# 注意这里的demo_codes_common不能重复
add_library(demo_codes_common STATIC learn_c/chap01/list0101.c)
  • 生成动态库或共享库。。Linux下生成demo_codes_common_a.so的共享库。Windows下生成libdemo_codes_common.dll共享库
# 注意这里的demo_codes_common_a不能重复
add_library(demo_codes_common_a SHARED learn_c/chap01/list0101.c)

2.2.5 指定编译包含的源文件

  • 明确指定包含哪些源文件
add_library(demo demo.cpp test.cpp util.cpp)
  • 搜索所有的cpp文件,aux_source_directory(dir VAR)发现一个目录下所有的源代码文件并将列表存储在一个变量中
aux_source_directory(. SRC_LIST) # 搜索当前目录下的所有.cpp文件
add_library(demo ${SRC_LIST})
  • 自定义搜索规则
file(GLOB SRC_LIST "*.cpp" "protocol/*.cpp")
add_library(demo ${SRC_LIST})
# 或者
file(GLOB SRC_LIST "*.cpp")
file(GLOB SRC_PROTOCOL_LIST "protocol/*.cpp")
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})
# 或者
aux_source_directory(. SRC_LIST)
aux_source_directory(protocol SRC_PROTOCOL_LIST)
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})

2.2.6 查找指定的库文件

find_library(VAR name path)查找到指定的预编译库,并将它的路径存储在变量中。默认的搜索路径为cmake 包含的系统库,因此如果是NDK的公共库只需要指定库的name即可。

find_library( # Sets the name of the path variable.
              log-lib

              # Specifies the name of the NDK library that
              # you want CMake to locate.
              log )

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

2.2.7 设置包含的目录

include_directories(
    ${CMAKE_CURRENT_SOURCE_DIR}
    ${CMAKE_CURRENT_BINARY_DIR}
    ${CMAKE_CURRENT_SOURCE_DIR}/include
)

Linux下还可以通过如下方式设置包含的目录

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -I${CMAKE_CURRENT_SOURCE_DIR}")

2.2.8 设置链接库搜索目录

link_directories(
    ${CMAKE_CURRENT_SOURCE_DIR}/libs
)
0

Linux 下还可以通过如下方式设置包含的目录

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -L${CMAKE_CURRENT_SOURCE_DIR}/libs")

2.2.9 设置TARGET需要链接的库

target_link_libraries( # 目标库
                       demo

                       # 目标库需要链接的库
                       # log-lib是上面find_library指定的变量名
                       ${log-lib} )

在Windows下,系统会根据链接库目录,搜索xxx.lib文件,Linux下会搜索xxx.so或者xxx.a文件,如果都存在会优先链接动态库(so后缀)。

  • 指定链接动态库或静态库
target_link_libraries(demo libface.a) # 链接libface.a
target_link_libraries(demo libface.so) # 链接libface.so
  • 指定全路径
target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a)
target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.so)
  • 指定链接多个库
target_link_libraries(demo
    ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a
    boost_system.a
    boost_thread
    pthread)

2.2.10 条件控制

  • if…elseif…else…endif

逻辑判断和比较:

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)

示例:

if(MSVC)
    set(LINK_LIBS common)
else()
    set(boost_thread boost_log.a boost_system.a)
endif()
target_link_libraries(demo ${LINK_LIBS})
# 或者
if(UNIX)
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -fpermissive -g")
else()
    add_definitions(-D_SCL_SECURE_NO_WARNINGS
    D_CRT_SECURE_NO_WARNINGS
    -D_WIN32_WINNT=0x601
    -D_WINSOCK_DEPRECATED_NO_WARNINGS)
endif()

if(${CMAKE_BUILD_TYPE} MATCHES "debug")
    ...
else()
    ...
endif()
  • while…endwhile
while(condition)
    ...
endwhile()
  • foreach…endforeach
foreach(loop_var RANGE start stop [step])
    ...
endforeach(loop_var)

start表示起始数,stop表示终止数,step表示步长,示例:

foreach(i RANGE 1 9 2)
    message(${i})
endforeach(i)
# 输出:13579

2.2.11 打印信息

message(${PROJECT_SOURCE_DIR})
message("build with debug mode")
message(WARNING "this is warnning message")
message(FATAL_ERROR "this build has many error") # FATAL_ERROR 会导致编译失败

2.2.12 包含其它CMAKE文件

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

2.3 常用变量

2.3.1 预定义变量

  • 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:重新定义目标链接库文件的存放位置

2.3.2 环境变量

  • 使用环境变量
$ENV{Name}
  • 写入环境变量
set(ENV{Name} value) # 这里没有“$”符号

2.3.3 系统信息

  • 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

2.3.4 主要开关选项

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

3 示例

这是自己写的demo项目

├── cmake-build-debug
├── cmake-build-release
├── CMakeLists.txt
├── learn_c
│   ├── chap01
│   │   ├── list0101.c
│   │   ├── list0101.h
│   │   ├── list0102.c
└── main.c

main.c的源码如下:

#include "learn_c/chap01/list0101.h"
#include "learn_c/chap01/list0102.c"

int main() {
    hello_world();
    hello_world_0102();
    return 0;
}

list0101.h源码:

#ifndef DEMO_CODES_LIST0101_H
#define DEMO_CODES_LIST0101_H

void hello_world();

#endif //DEMO_CODES_LIST0101_H

list0101.c源码:

#include <stdio.h>
#include "list0101.h"

void hello_world()
{
	printf("%d\n", 15 + 37);
}

list0102.c源码:

#include <stdio.h>

void hello_world_0102()
{
	printf("%d\n", 15 - 37);	/* 用十进制数显示整数15减去37的值 */
}

CMakeLists.txt的内容:

# 支持的最低CMake版本
cmake_minimum_required(VERSION 3.17)

# 设置了项目的名字
project(demo_codes C)

set(CMAKE_C_STANDARD 90)
# set指令创建了一个变量,第一个参数为变量名SOURCES,用SOURCES代替要编译的资源文件
set(SOURCES main.c
        learn_c/chap01/list0101.c
        )

add_executable(demo_codes ${SOURCES})

# 添加编译需要用到的头文件
target_include_directories(demo_codes
        PRIVATE
        ${PROJECT_SOURCE_DIR}/learn_c/chap01/
        )

这里经测试后结果分析如下:

  • list0101.h是通过头文件引入时,需要将list0101.c指明要编译。而list0102.c直接引用,则可以不用写明。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值