cmake 总结
一、cmake
- CMake是一个跨平台的安装编译工具,可以用简单的语句来描述所有平台的安装(编译过程)。
- CMake可以说已经成为大部分C++开源项目标配
二、为什么使用cmake
假设你有一个跨平台的项目,c++代码在不同的地方共享
平台/ ide。假设你在Windows上使用Visual Studio,在OSX上使用Xcode,在Makefile上使用
Linux,如果你想添加新的bar.cpp源文件,你会怎么做?你必须把它添加到你的每一个工具中
使用:
不同的平台和工具都得添加进去,为了保持环境的一致性,你必须多次进行类似的更新。和
最重要的是,你必须手动做(箭头标记的红色上本例中的图表)。当然,这种方法很容易出错,而且不够灵活。
CMake通过在开发过程中增加额外的步骤来解决这个设计缺陷。你可以描述你的
在CMakeLists.txt文件中创建一个项目,并使用CMake生成当前感兴趣的工具
跨平台CMake代码:
如果你需要添加bat.cpp文件,则只需要修改对应的cmakelist文件即可,在各个平台中编译,也就是说你可以继续使用你喜欢的工具或者平台,维护更加便捷。
三、cmake语法以及重要指令
-
基本语法格式:指令(参数 1 参数 2…)
参数使用括弧括起
参数之间使用空格或分号分开 -
指令是大小写无关的,参数和变量是大小写相关的
-
变量使用${}方式取值,但是在 IF 控制语中直接使用变量名
-
cmake_minimum_required - 指定CMake的最小版本要求
语法: cmake_minimum_required(VERSION versionNumber [FATAL_ERROR])
# CMake最小版本要求为2.8.3 cmake_minimum_required(VERSION 2.8.3)
-
project - 定义工程名称,并可指定工程支持的语言
语法: project(projectname [CXX] [C] [Java])# 指定工程名为HELLOWORLD project(HELLOWORLD)
-
set - 显式的定义变量
语法:set(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])# 定义SRC变量,其值为sayhello.cpp hello.cpp set(SRC sayhello.cpp hello.cpp)
-
include_directories - 向工程添加多个特定的头文件搜索路径 —>相当于指定g++编译器的-I参数
语法: include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 …)# 将/usr/include/myincludefolder 和 ./include 添加到头文件搜索路径 include_directories(/usr/include/myincludefolder ./include)
-
link_directories - 向工程添加多个特定的库文件搜索路径 —>相当于指定g++编译器的-L参数
语法: link_directories(dir1 dir2 …)# 将/usr/lib/mylibfolder 和 ./lib 添加到库文件搜索路径 link_directories(/usr/lib/mylibfolder ./lib)
-
add_library - 生成库文件
语法: add_library(libname [SHARED|STATIC|MODULE] [EXCLUDE_FROM_ALL]
source1 source2 … sourceN)添加一个从source列表列出的文件构建而来的目标名为name的库。
name必须全局唯一
构建库的源文件可以直接指定,也可以后续使用target_sources()指定
STATIC(静态库) SHARED(动态库) MODULE(模块库)用来指定库的类型。
-使用STATIC构建生成静态库(name.a),使用SHARED构建生成动态库(name.so)# 通过变量 SRC 生成 libhello.so 共享库 add_library(hello SHARED ${SRC})
-
add_compile_options - 添加编译参数
# 添加编译参数 -Wall -std=c++11 -O2 add_compile_options(-Wall -std=c++11 -02)
-
add_executable - 生成可执行文件
语法:add_executable(exename source0 source1 sourceN)# 编译main.cpp生成可执行文件main add_executable(main main.cpp)
-
target_link_libraries - 为 target 添加需要链接的共享库 —>相同于指定g++编译器-l参数
语法: target_link_libraries(target library1<debug | optimized> library2…)# 将hello动态库文件链接到可执行文件main target_link_libraries(main hello)
-
add_subdirectory - 向当前工程添加存放源文件的子目录,并可以指定中间二进制和目标二进制
存放的位置
语法: add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])# 添加src子目录,src中需有一个CMakeLists.txt add_subdirectory(src)
-
aux_source_directory - 发现一个目录下所有的源代码文件并将列表存储在一个变量中,这个指
令临时被用来自动构建源文件列表
语法: aux_source_directory(dir VARIABLE)# 定义SRC变量,其值为当前目录下所有的源代码文件 aux_source_directory(. SRC) # 编译SRC变量所代表的源代码文件,生成main可执行文件 add_executable(main ${SRC})
-
include - include 指令用来载入并运行来自于文件或模块的 CMake 代码。可以导入.cmake 文件,当作函数类执行
test.cmake
function(print_string str) message("str == ${str}") endfunction(print_string)
# 导入test.cmake文件,使用绝对路径 include(${PROJECT_SOURCE_DIR}/test.cmake) # 调用test.cmake文件中函数 print_string("hello")
-
option
语法:option( “<help_text>” [value])使用场景 : 编译脚本传递参数 -> CMake脚本接收option -> 源代码宏
编译脚本传入参数
传入一个cmake option BUILD_TESTS#!/bin/sh cmake -DBUILD_TESTS=ON . cmake --build .
option(BUILD_TESTS "Set to ON to build tests" ON) # add test if (BUILD_TESTS) add_subdirectory(extern/googletest) add_subdirectory(test) endif()
-
编译选项
CMAKE_C_FLAGS gcc编译选项
CMAKE_CXX_FLAGS g++编译选项# 在CMAKE_CXX_FLAGS编译选项后追加-std=c++11 set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
-
CMAKE_BUILD_TYPE 编译类型(Debug, Release)
# 设定编译类型为debug,调试时需要选择debug set(CMAKE_BUILD_TYPE Debug) # 设定编译类型为release,发布时需要选择release set(CMAKE_BUILD_TYPE Release)
-
工程目录
CMAKE_SOURCE_DIR
PROJECT_SOURCE_DIR
SOURCE_DIR- 这三个变量指代的内容是一致的,不论采用何种编译方式,都是工程顶层目录。
- 也就是在 in source build时,他跟 CMAKE_BINARY_DIR 等变量一致。
- PROJECT_SOURCE_DIR 跟其他指令稍有区别,现在,你可以理解为他们是一致的。
CMAKE_C_COMPILER:指定C编译器
CMAKE_CXX_COMPILER:指定C++编译器
EXECUTABLE_OUTPUT_PATH:可执行文件输出的存放路径
LIBRARY_OUTPUT_PATH:库文件输出的存放路径
示例:
示例项目结构
Cmakelist.txt
cmake_minimum_required(VERSION 3.17)
project(xusanduo)
set(CMAKE_CXX_STANDARD 14)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -O2 -Wall")
include_directories(${PROJECT_SOURCE_DIR}/include)
# 将src中的源文件添加到SRC这个变量中去
aux_source_directory(${PROJECT_SOURCE_DIR}/src SRC)
# 将源文件一一加入可执行文件
add_executable(Demo main.cpp ${SRC})
四、g++编译参数
-
-g 编译带调试信息的可执行文件
# -g 选项告诉 GCC 产生能被 GNU 调试器GDB使用的调试信息,以调试程序。 # 产生带调试信息的可执行文件test g++ -g test.cpp
-
-O[n] 优化源代码
## 所谓优化,例如省略掉代码中从未使用过的变量、直接将常量表达式用结果值代替等等,这些操作 会缩减目标文件所包含的代码量,提高最终生成的可执行文件的运行效率。 # -O 选项告诉 g++ 对源代码进行基本优化。这些优化在大多数情况下都会使程序执行的更快。 -O2 选项告诉 g++ 产生尽可能小和尽可能快的代码。 如-O2,-O3,-On(n 常为0–3) # -O 同时减小代码的长度和执行时间,其效果等价于-O1 # -O0 表示不做优化 # -O1 为默认优化 # -O2 除了完成-O1的优化之外,还进行一些额外的调整工作,如指令调整等。 # -O3 则包括循环展开和其他一些与处理特性相关的优化工作。 # 选项将使编译的速度比使用 -O 时慢, 但通常产生的代码执行速度会更快。 # 使用 -O2优化源代码,并输出可执行文件 g++ -O2 test.cpp
-
-l 和 -L 指定库文件 | 指定库文件路径
# -l参数(小写)就是用来指定程序要链接的库,-l参数紧接着就是库名 # 在/lib和/usr/lib和/usr/local/lib里的库直接用-l参数就能链接 # 链接glog库 g++ -lglog test.cpp # 如果库文件没放在上面三个目录里,需要使用-L参数(大写)指定库文件所在目录 # -L参数跟着的是库文件所在的目录名 # 链接mytest库,libmytest.so在/home/bing/mytestlibfolder目录下 g++ -L/home/bing/mytestlibfolder -lmytest test.cpp
-
-I 指定头文件搜索目录
# -I # /usr/include目录一般是不用指定的,gcc知道去那里找,但 是如果头文件不在/usr/icnclude 里我们就要用-I参数指定了,比如头文件放在/myinclude目录里,那编译命令行就要加上- I/myinclude 参数了,如果不加你会得到一个”xxxx.h: No such file or directory”的错 误。-I参数可以用相对路径,比如头文件在当前 目录,可以用-I.来指定。上面我们提到的–cflags参 数就是用来生成-I参数的。 g++ -I/myinclude test.cpp
-
-Wall 打印警告信息
# 打印出gcc提供的警告信息 g++ -Wall test.cpp
-
-std=c++11 设置编译标准
# 使用 c++11 标准编译 test.cpp g++ -std=c++11 test.cpp
-
-o 指定输出文件名
# 指定即将产生的文件名 # 指定输出可执行文件名为test g++ test.cpp -o test
-
-D 定义宏
# 在使用gcc/g++编译的时候定义宏 # 常用场景: # -DDEBUG 定义DEBUG宏,可能文件中有DEBUG宏部分的相关信息,用个DDEBUG来选择开启或关闭 DEBUG