CMake
第一章 CMake基础
一、前戏
cmake的定义是什么?--- 高级编译配置工具
当多个人用不同的语言或者编译器开发一个项目,最终要输出一个可执行文件或者共享库(l,so等等)这时候神器就出现了---CMak!
所有操作都是通过编译CMakeLists.txt来完成的一简单
官方网站是www.cmake.org,可以通过访问官方网站获得更多关于cmake的信息
学习CMake的目的,为将来处理大型的C/C++/JAVA项目做准备
二、CMake 安装
- 绝大多数的inux系统已经安装了CMake
- Windows或某些没有安装过的linux系统,去 http://www.cmake.org/HTML/Download.html 可以下载安装
三、CMake Hello World
-
步骤一,创建一个 main.cpp
#include <iostream> using namespace std; int main() { cout << "Hello World" << endl; system("pause"); return 0; }
-
步骤二,创建 CMakeLists.txt
PROJECT (HELLO) SET(SRC_LIST main.cpp) MESSAGE(STATUS "This is BINARY dir" ${HELLO_BINARY_DIR}) MESSAGE(STATUS "This is SOURCE dir" ${HELLO_SOURCE_DIR}) ADD_EXECUTABLE(hello ${SRC_LIST})
-
步骤三,使用cmake,生成makefile文件
# linux cmake . # windows cmake . -G "Unix Makefiles"
-
步骤四,使用 make 命令编译
make
-
步骤五,执行生成的可执行文件
hello
四、CMake 语法介绍
1、PROJECT
可以用来指定工程的名字和支持的语言,默认支持所有语言
PROJECT (HELLO)
:指定了工程的名字,并且支持所有语言一建议PROJECT (HELLO CXX)
:指定了工程的名字,并且支持语言是C++PROJECT (HELLO C CXX)
:指定了工程的名字,并且支持语言是C和C++
该指定隐式定义了两个CMAKE的变量
<projectname>_BINARY_DIR
, 本例中是HELLO_BINARY_DIR
<projectname>_SOURCE_DIR
, 本例中是HELLO SOURCE DIR
- MESSAGE 关键字就可以直接使用者两个变量,当前都指向当前的工作目录,后面会讲外部编译
问题:如果改了工程名,这两个变量名也会改变
解决:又定义两个预定义变量:PROJECT_BINARY_DIR
和 PROJECT_SOURCE_DIR
, 这两个变量和 HELLO_BINARY_DIR
, HELLO_SOURCE_DIR
是一致的。
2、SET
用来显示的指定变量的
SET(SRC_LIST main.cpp)
, SRC_LIST 变量就包含了main.cpp
也可以 SET(SRC_LIST main.cpp t1.cpp t2.cpp)
3、MESSAGE
向终端输出用户自定义的信息
主要包含三种信息:
- SEND_ERROR:产生错误,生成过程被跳过。
- SATUS:输出前缀为
--
的信息。 - FATAL_ERROR:立即终止所有cmake过程
4、ADD_EXECUTABLE
生成可执行文件
ADD_EXECUTABLE(hello $(SRC_LIST))
:生成的可执行文件名是hello, 源文件读取变量SRC_LIST中的内容
也可以直接写 ADD_EXECUTABLE(hello main.cpp)
上述例子可以简化的写成
PROJECT(HELLO)
ADD_EXECUTABLE(hello main.cpp)
注意:工程名的HELLO和生成的可执行文件hello是没有任何关系的
5、ADD_SUBDIRECTORY
ADD_SUBDIRECTORY(source_dir [binary_dir][EXCLUDE_FROM_ALL])
- 这个指令用于向当前工程添加存放源文件的子目录,并可以指定中间二进制和目标二进制存放的位置
- EXCLUDE_FROM_ALL 函数是将写的目录从编译中排除,如程序中的 example
ADD_SUBDIRECTORY(src bin)
- 将src子目录加入工程并指定编译输出(包含编译中间结果)路径为bin目录
- 如果不进行bin目录的指定,那么编译结果(包括中间结果)都将存放在build/src目录
6、ADD_LIBRARY
ADD_LIBRARY(hello SHARED $(LIBHELLO_SRC))
- hello:就是正常的库名,生成的名字前面会加上Iib, 最终产生的文件是 libhello.so
- SHARED:动态库;STATIC:静态库
- ${LIBHELLO_SRC}:源文件
五、语法的基本原则
- 变量使用 ${} 方式取值,但是在F控制语句中是直接使用变量名
- 指令(参数1 参数2…)参数使用括弧括起,参数之间使用空格或分号分开。以上面的 ADD_EXECUTABLE 指令为例,如果存在另外一个 func.cpp 源文件就要写成:
ADD_EXECUTABLE(hello main.cpp func.cpp)
或者ADD_EXECUTABLE(hello main.cpp;func.cpp)
- 指令是大小写无关的,参数和变量是大小写相关的。但,推荐你全部使用大写指令
注意:
SET(SRC_LIST main.cpp)
可以写成SET(SRC_LIST "main.cpp")
,如果源文件名中含有空格,就必须要加双引号ADD_EXECUTABLE(hello main)
后缀可以不写,他会自动去找.c
和.cpp
,最好不要这样写,可能会有这两个文件main.cpp
和main
六、内部构建和外部构建
- 上述例子就是内部构建,他生产的临时文件特别多,不方便清理
- 外部构建,就会把生成的临时文件放在 bulid 目录下,不会对源文件有任何影响,强烈建议使用外部构建方式
1、外部构建方式举例
步骤:
- 建立一个build目录,可以在任何地方,建议在当前目录下
- 进入build, 运行cmake, 当然.表示上一级目录,你可以写 CMakeLists.txt 所在的绝对路径,生产的文件都在build目录下了
- 在build目录下,运行make来构建工程
注意外部构建的两个变量
- HELLO_SOURCE_DIR 还是工程路径
- HELLO_BINARY_DIR 编译路径也就是 F:/projects/C++/CMakeProjects/demo/build
七、让 Hello World 看起来更像一个工程
- 为工程添加一个子目录
src
,用来放置工程源代码 - 添加一个子目录
doc
, 用来放置这个工程的文档hello.txt
- 在工程目录添加文本文件
COPYRIGHT
,README
- 在工程目录添加一个
runhello.sh
脚本,用来调用hello二进制 - 将构建后的目标文件放入构建目录的
bin
子目录 - 将doc目录的内容以及
COPYRIGHT/README
安装到 /usr/share/doc/cmake/
1、将目标文件放入构建目录的 bin 子目录
(1) 目录结构
每个目录下都要有一个 CMakeList.txt
>>> tree
>>> -- build
>>> -- CMakeList.txt
>>> -- src
>>> -- CMakeList.txt
>>> -- main.cpp
-
外层 CMakeList.txt
PROJECT (HELLO) ADD_SUBDIRECTORY(src bin)
-
src/CMakeList.txt
ADD_EXECUTABLE(hell0 main.cpp)
-
src/main.cpp
#include <iostream> using namespace std; int main() { cout << "Hello World" << endl; system("pause"); return 0; }
-
编译运行
(2) 更改二进制的保存路径
SET 指令重新定义 EXECUTABLE_OUTPUT_PATH
和 LIBRARY_OUTPUT_PATH
变量来指定最终的目标二进制的位置
-
SET(EXECUTABLE_OUTPUT_PATH $(PROJECT_BINARY_DIR)/bin)
-
``SET(LIBRARY_OUTPUT_PATH $(PROJECT_BINARY_DIR)/lib)`
思考:加在哪个CMakeLists.txt当中
哪里要改变目标存放路径,就在哪里加入上述的定义,所以应该在src下的CMakeLists.txt下写
八、安装
- 一种是从代码编译后直镰make insta安装
- 一种是打包时的指定目录安装。
- 简单的可以这样指定目录:make install DESTDIR=/tmp/test
- 稍微复杂一点可以这样指定目录:./configure-prefix:=usr
1、如何安装 HelloWorld
使用CMAKE一个新的指令:INSTALL
INSTALL的安装可以包括:
- 二进制
- 动态库
- 静态库以及文件
- 目录
- 脚本等
使用CMAKE一个新的变量:CMAKE_INSTALL_PREFIX
>>> tree
>>> -- build
>>> -- CMakeList.txt
>>> -- COPYRIGHT
>>> -- doc
>>> -- hello.txt
>>> -- README
>>> -- runhello.sh
>>> -- src
>>> -- CMakeList.txt
>>> -- main.cpp
2、安装文件 COPYRIGHT 和 README
INSTALL(FILES COPYRIGHT README DESTINATION share/doc/cmake/)
-
FILES:文件
-
DESTINATION:
- 写绝对路径
- 可以写相对路径,相对路径实际路径是:${CMAKE_INSTALL_PREFIX/<DESTINATION定义的路径>
- CMAKE_INSTALL_PREFIX 默认是在usr/local/
- cmake-DCMAKE_INSTALL_PREFIX=/usr在cmake的时候指定CMAKE_INSTALL_PREFIX:变量的路径
3、安装脚本 runhello.sh
PROGRAMS:非目标文件的可执行程序安装(比如脚本之类)
INSTALL(PROGRAMS runhello.sh DESTINATION bin)
说明:实际安装到的是 usr/bin
4、安装 doc 中的 hello.txt
一、是通过在doc目录建立CMakeLists.txt,通过install下的file
二、是直接在工程目录通过
INSTALL(DIRECTORY doc/ DESTINATION share/doc/cmake)
DIRECTORY后面连接的是所在Source目录的相对路径
注意:abc
和 abc/
有很大的区别
目录名不以/结尾:这个目录将被安装为目标路径下的bc
目录名以/结尾:将这个目录中的内容安装到目标路径
5、重新编译
-
CMakeList.txt
PROJECT (HELLO) ADD_SUBDIRECTORY(src bin) # 安装文件 COPYRIGHT 和 README INSTALL(FILES COPYRIGHT README DESTINATION C:/Users/Admin/Documents/cmake/) # 安装脚本 runhello.sh INSTALL(PROGRAMS runhello.sh DESTINATION F:/projects/C++/CMakeProjects/bin) # 安装 doc 中的 hello.txt INSTALL(DIRECTORY doc/ DESTINATION C:/Users/Admin/Documents/cmake/)
-
src/CMakeList.txt
ADD_EXECUTABLE(hello main.cpp)
-
src/main.cpp
#include <iostream> using namespace std; int main() { cout << "Hello World" << endl; system("pause"); return 0; }
-
执行编译命令(在build目录下执行)
>>> cmake .. -G "Unix Makefiles" >>> make >>> make install
-
执行结果
九、静态库和动态库的构建
需求:
- 建立一个静态库和动态库,提供 HelloFunc 函数供其他程序编程使用,HelloFunc 向终端输出 Hello World 字符串。
- 安装头文件与共享库。
静态库和动态库的区别
- 静态库的扩展名一般为
.a
或.lib
;动态库的扩展名一般为.so
或.dll
。 - 静态库在编译时会直接整合到目标程序中,编译成功的可执行文件可独立运?
- 动态库在编译时不会放到连接的目标程序中,即可执行文件无法单独运行。
1、构建实例
-
目录结构
>>> tree >>> -- build >>> -- CMakeList.txt >>> -- lib >>> -- CMakeList.txt >>> -- hello.cpp >>> -- hello.h
-
hello.h
#include <iostream> #include "hello.h" using namespace std; void helloFunc() { cout << "Hello World" << endl; }
-
CMakeList.txt
PROJECT(HELLO) ADD_SUBDIRECTORY(lib bin)
-
lib/CMakeList.txt
SET(LIBHELLO_SRC hello.cpp) ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})
-
执行编译命令(在build目录下执行)
>>> cmake .. -G "Unix Makefiles" >>> make
-
编译结果
-
在 linux 上生成的就是 .so 文件
2、同时构建静态和动态库
# 如果用这种方式,只会构建一个动态库,不会构建出静态库,虽然静态库的后缀是 .a
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})
ADD_LIBRARY(hello STATIC ${LIBHELLO_SRC})
# 修改静态库的名字,这样是可以的,但是我们往往希望他们的名字是相同的,只是后缀不同而已
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})
ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})
3、SET_TARGET_PROPERTIES
这条指令可以用来设置输出的名称,对于动态库,还可以用来指定动态库版本和AP!版本
同时构建静态和动态库
# lib/CMakeList.txt
SET(LIBHELLO_SRC hello.cpp)
# ------------------------------ 静态库 ------------------------------
ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})
# 对 hello_static 的重名为 hello
SET_TARGET_PROPERTIES(hello_static PROPERTIES OUTPUT_NAME "hello")
# cmake在构建一个新的target时,会尝试清理掉其他使用这个名字的库,因为,在构建 libhello.so 时就会清理掉 libhello.a
SET_TARGET_PROPERTIES(hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1)
# ------------------------------ 动态库 ------------------------------
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})
SET_TARGET_PROPERTIES(hello PROPERTIES OUTPUT_NAME "hello")
SET_TARGET_PROPERTIES(hello PROPERTIES CLEAN_DIRECT_OUTPUT 1)
4、动态库的版本号
一般动态库都有一个版本号的关联
libhello.so.1.2
libhello.so -> libhello.so.1
libhello.so.1 -> libhello.so.1.2
CMakeList.txt 插入如下:
SET_TARGET_PROPERTIES(hello PROPERTIES VERSION 1.2 SOVERSION 1)
VERSION:指代动态库版本
SOVERSION:指代 API 版本
5、安装共享库和头文件
本例中我们将hello的共享库安装到 <prefix>:Iib目录
将hello.h安装到 <prefix>/include/hello目录
# 文件放到该目录下
INSTALL(FILES hello.h DESTINATION include/hello)
# 二进制,静态库,动态库都用 TARGETS
# ARCHIVE 特指静态库,LIBRARY 特指动态库,RUNTIME 特指可执行目标二进制
INSTALL(TARGETS hello hello_static LIBRARY DESTINATION lib ARCHIVE DESTINATION lib)
注意:
- 安装的时候,指定一下路径,放到系统下
- cmake -DCMAKE_INSTALL_PREFIX=/usr...
-
CMakeList.txt
PROJECT(HELLO) ADD_SUBDIRECTORY(lib bin)
-
lib/CMakeList.txt
SET(LIBHELLO_SRC hello.cpp) # ------------------------------ 静态库 ------------------------------ ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC}) # 对 hello_static 的重名为 hello SET_TARGET_PROPERTIES(hello_static PROPERTIES OUTPUT_NAME "hello") # cmake在构建一个新的target时,会尝试清理掉其他使用这个名字的库,因为,在构建 libhello.so 时就会清理掉 libhello.a SET_TARGET_PROPERTIES(hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1) # ------------------------------ 动态库 ------------------------------ ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC}) SET_TARGET_PROPERTIES(hello PROPERTIES OUTPUT_NAME "hello") SET_TARGET_PROPERTIES(hello PROPERTIES CLEAN_DIRECT_OUTPUT 1) # 安装头文件 INSTALL(FILES hello.h DESTINATION include/hello) # 安装二进制,静态库,动态库 INSTALL(TARGETS hello hello_static LIBRARY DESTINATION lib ARCHIVE DESTINATION lib)
-
lib/hello.h
#ifndef HELLO_H #define HELLO_H void helloFunc(); #endif
-
lib/hello.cpp
#include <iostream> #include "hello.h" using namespace std; void helloFunc() { cout << "Hello World" << endl; }
-
编译
>>> cmake -D CMAKE_INSTALL_PREFIX=F:/projects/C++/CMakeProjects/bin .. -G "Unix Makefiles" >>> make >>> make install
6、使用外部共享库和头文件
准备工作,新建一个目录来使用共享库和头文件
>>> tree
>>> -- build
>>> -- CMakeList.txt
>>> -- src
>>> -- CMakeList.txt
>>> -- main.cpp
-
CMakeList.txt
PROJEC(HELLO) ADD_SUBDIRECTORY(src bin)
-
src/CMakeList.txt
# 加入头文件搜索路径 # INCLUDE_DIRECTORIES(/usr/include/hello) INCLUDE_DIRECTORIES(F:/projects/C++/CMakeProjects/bin/include/hello) ADD_EXECUTABLE(hello main.cpp) # 链接共享库 # TARGET_LINK_LIBRARIES(hello libhello.so) LINK_DIRECTORIES(hello F:/projects/C++/CMakeProjects/bin/lib/libhello.lib)
-
main.cpp
#include <hello.h> int main() { helloFunc(); system("pause"); return 0; }
-
问题:
-
make 后头文件找不到的问题
- PS:
include<hello/hello.h>
这样 include 是可以的 - 关键字:INCLUDE_DIRECTORIES:这条指可以想多个工程添加多个特定的头文件搜索路径,路径之间用空格分隔
- 在 CMakeList.txt 中加入头文件搜索路径
INCLUDE_DIRECTORIES(/usr/include/hello)
- PS:
-
找不到函数的问题
- 报错信息:undefined reference to 'helloFunc()'
- 关键字:LINK_DIRECTORIES:添加非标准的共享库搜索路径(自定义的路径)
- 关键字:TARGET_LINK_LIBRARIES:添加需要链接的共享库
- 在 CMakeList.txt 中插入链接共享库,注意要插在 ADD_EXECUTABLE 之后
TARGET_LINK_LIBRARIES(hello libhello.so)
-
-
链接静态库
TARGET_LINK_LIBRARIES(main libhello.a)
特殊的环境变量 CMAKE_INCLUDE_PATH 和 CMAKE_LIBRARY_PATH
注意:这两个是环境变量而不是cmake变量,可以在linux的bash中进行设置
我们上面例子中使用了绝对路径 INCLUDE_DIRECTORIES(/usr/include/hello)
来指明include路径的位置
我们还可以使用另外一种方式,使用环境变量 export CMAKE_INCLUDE_PATH=usr/include/hello
补充:生产debug版本的方法:
cmake .. -D CMAKE_BUILD_TYPE=debug
十、CMake 中常用变量和和常用环境变量
第二章 C++动态链接库
一、创建项目
二、编写文件
-
mydll.h
#pragma once #include <iostream> #ifdef BUILD_MYDLL #define API_SYMBOL __declspec(dllexport) #else #define API_SYMBOL __declspec(dllimport) #endif extern "C" API_SYMBOL int convert_array(int* data, int len);
-
mydll.cpp
#include "pch.h" #define BUILD_MYDLL #include "mydll.h" #include <iostream> using namespace std; int convert_array(int* data, int len) { for (int i = 0; i < len; i++) { cout << data[i] << " "; } cout << endl; int nTotal = 0; for (int i = 0; i < len; i++) { nTotal += data[i]; --data[i]; } return nTotal; }
三、生成
四、调用动态库
1、隐式调用
隐式调用 需要三个文件:
- .h 头文件
- .lib 符号文件
- .dll 动态库文件
(1) 创建一个应用程序
(2) 配置
(3) 引入 lib 符号文件
(4) 修改 DemoInvokeDll.cpp
// 隐式调用动态链接库
#include <iostream>
#include "mydll.h"
int main()
{
int arr[] = { 3,6,7,8 };
int len = sizeof(arr) / sizeof(int);
int total = convert_array(arr, len);
std::cout << "数组元素求和结果: " << total << std::endl;
std::cout << "数组元素新值: " << std::endl;
for (int i = 0; i < len; i++)
{
std::cout << arr[i] << " ";
}
std::cout << std::endl;
}
(5) 测试
2、显式调用
显式调用 只需要一个文件
- .dll 动态库文件
(1) 新建项目
(2) 编写代码
// xsInvokeDll.cpp : 此文件包含 "main" 函数。程序执行将在此处开始并结束。
// 显式调用动态链接库
#include <iostream>
#include <Windows.h>
// 第一步, 创建一个别名, 它引用的函数类型需要和dll中的导出函数一致
typedef int (*LPDO_ARRAY)(int* pArr, int nlen);
int main()
{
// 定义一个示例句柄,引用动态库
HINSTANCE hDll;
// 定义一个函数指针,用来指向导出函数
LPDO_ARRAY lpDo_array;
// 第二步,加载 DemoDll.dll 动态库文件
hDll = LoadLibrary(L"DemoDll.dll");
if (hDll != NULL)
{
// 第三步获取 dll 中的函数地址
lpDo_array = (LPDO_ARRAY)GetProcAddress(hDll, "convert_array");
if (lpDo_array != NULL)
{
// 第四步,通过函数指针 lpDo_array 调用函数
int arr[] = { 1,2,4,6 };
int len = sizeof(arr) / sizeof(int);
int ret = lpDo_array(arr, len);
std::cout << "函数返回值: " << ret << std::endl;
std::cout << "数组元素新值: " << std::endl;
for (int i = 0; i < len; i++)
{
std::cout << arr[i] << " ";
}
std::cout << std::endl;
}
// 第五步,释放动态库句柄
FreeLibrary(hDll);
}
}
// 运行程序: Ctrl + F5 或调试 >“开始执行(不调试)”菜单
// 调试程序: F5 或调试 >“开始调试”菜单
// 入门使用技巧:
// 1. 使用解决方案资源管理器窗口添加/管理文件
// 2. 使用团队资源管理器窗口连接到源代码管理
// 3. 使用输出窗口查看生成输出和其他消息
// 4. 使用错误列表窗口查看错误
// 5. 转到“项目”>“添加新项”以创建新的代码文件,或转到“项目”>“添加现有项”以将现有代码文件添加到项目
// 6. 将来,若要再次打开此项目,请转到“文件”>“打开”>“项目”并选择 .sln 文件
(3) 测试
(4) 扩展
-
将 F:/projects/C++/DLLProjects/DemoDll/Debug/DemoDll.dll 和 F:/projects/C++/DLLProjects/DemoDll/Debug/xsInvokeDll.exe 复制到 F:\projects\C++\DLLProjects\test
-
进入命令行输入 xsInvokeDll.exe
3、Python 调用
(1) 目录结构
(2) 编写代码
# demo01.py
import ctypes, ctypes.util
def find_dll(dll_name):
return ctypes.util.find_library(dll_name)
def load_dll(dll_path):
try:
# 加载动态库,若失败则抛出异常
vc_dll = ctypes.CDLL(dll_path)
print(f'DEBUG - 动态链接库加载成功')
# 取动态库函数
vc_func = vc_dll.convert_array
# C++ <-> ctypes <-> python 数据类型适配
# 函数参数类型适配
vc_func.argtypes = [ctypes.POINTER(ctypes.c_int), ctypes.c_int]
# 函数返回值类型适配
vc_func.restype = ctypes.c_int
# 定义 python 变量
my_list = [3, 1, 6, 8, 5]
array_len = len(my_list)
# 把列表转换成C++动态库函数所需要的参数数组,my_array不是数组, 当成数组去理解
my_array = (ctypes.c_int * array_len)(*my_list)
# 调用函数
total = vc_func(my_array, array_len)
print(f'DEBUG - 函数返回值: {total}')
my_array_list = []
for i in range(my_array._length_):
# 将 my_array 的元素追加到列表里
my_array_list.append(my_array[i])
print(f'DEBUG - 新数组的值: {my_array_list}')
except OSError as e:
print(f'ERROR - 动态链接库加载失败: {e}')
if __name__ == '__main__':
dll_path = find_dll('./dlls/DemoDll.dll')
if dll_path:
load_dll(dll_path)
else:
print(f'WARNING - 动态链接库未找到')
(3) 异常处理
[WinError 193] %1 不是有效的 Win32 应用程序。
![]()
![]()
会在 F:\projects\C++\DLLProjects\DemoDll\x64\Debug\DemoDll.dll 生成 64位 动态链接库
重新替换 DemoDll.dll 目标文件