CMake使用方法以及CMakeLists.txt 学习总结(1)

1、CMake 的使用过程

1.1、编译多个文件的普通方法

在一个目录下有多个cpp文件，和头文件

main.cpp

#include "head.h"
int main(){

    float a=4,b=7;
    add(a,b);
    sub(a,b);
    mult(a,b);
    div(a,b);
    return 0;
}

head.h

#ifndef __HEAD_H_
#define __HEAD_H_

#include<iostream>
#include<cmath>
using namespace std;

void add(float a,float b);
void sub(float a,float b);
void mult(float a,float b);
void div(float a,float b);

#endif

• 编译运行

1.2、使用 CMake 进行编译

1.2.1 首先创建并编写 CMakeLists.txt 文件

1.2.2、创建一个 build 目录。用来放 cmake 生成的文件及文件夹，在 build 下使用 cmake 命令

• cmake ..是因为CMakeLists.txt在上一级目录下，使用cmake命令时，其后面跟的路径永远和CMakeLists.txt的路径保持一致
  
• 使用cmake命令会生成上面这些文件和文件夹，其中Makefile就是编译所需要的
• 下面只需要使用命令make即可完成编译
  

2. CMakeLists.txt 文件的编写

2.1 注释

• 注释行

CMake使用#进行行注释，可以放在任何位置

• 块注释

CMake使用#[[这里是注释]]进行块注释

2.2 CMakeLists.txt 文件中的三个命令

cmake_minmum_required()
project()
add_executable()

• cmake_minimum_required(VERSION 3.15):指定使用cmake的最低版本
• project:定义工程名称，并可以指定工程的版本、工程描述、web主页地址、支持的语言（默认情况支持所有语言），如果不需要这些都是可以忽略的，只需要指定工程名就行了 (project(test))
• add_executable(math.o add.cpp sub.cpp mult.cpp div.cpp main.cpp):定义工程生成一个可执行程序math.o

2.3 CMake 中的 set 的使用

2.3.1 使用set定义变量

在上面的例子中一共有5个源文件，每次都把它写出来很麻烦，可以用set命令定义一个变量，用这个变量表示这5个源文件的名称

set (SRC_LIST add.c div.c main.c mult.c sub.c)

这样 SRC_LIST 就可以表示 add.c div.c mian.c mult.c sub.c 了
由set设置的变量在使用时，需要用$[]符号
所以在 add_executable中就可以这样写：add_executable(math.o $[SRC_LIST])

2.3.2 set 设置生成的文件输出路径

EXECUTABLE_OUTPUT_PATH 关键字用来设置二进制文件输出路径，不存在的路径会被创建

set(EXECUTABLE_OUTPUT_PATH /home/ltr/workSpace/cMake_learn/outputPath)

2.3.3 set 设置C++支持的版本

CMAKE_CXX_STANDARD 关键字用来设置支持的C++新标准

set(CMAKE_CXX_STANDARD 11)

2.4 搜索文件

如果一个项目里面的源文件很多，在编写CMakeLists.txt 文件的时候将项目目录的各个文件一一罗列出来太过麻烦，可以使用aux_source_directory命令或者file命令

2.4.1 方式一:aux_source_directory

使用aux_source_directory命令可以查找某个路径下的所有源文件，命令格式为：

aux_source_directory(<dir> <variable>)

//@param1:要搜索的文件路径
//@param2:变量名，将从dir目录下搜索到的源文件列表存储到该变量中

aux_source_directory(${PROJECT_SOURCE_DIR} src)

PROJECT_SOURCE_DIR: 宏，代表当前项目的根目录路径

2.4.2 方式二：file

file(GLOB/GLOB_RECURSE 变量名 要搜索的文件路径和文件类型）

• GLOB 将指定目录下搜索到满足条件的所有文件名生成一个列表，并将其存储到变量中
• GLOB_RECURSE:递归搜索指定目录，将搜索到的满足条件的文件名生成一个列表，并将其存储到变量中。

file(GLOB src ${CMAKE_CURRENT_SOURCE_DIR}/*.cpp)

CMAKE_CURRENT_SOURCE_DIR:宏，代表CMakeLists.txt所在路径

2.5 指定头文件路径

有时候，一个项目中头文件和源文件并不在同一个目录

这时，将路径加上src

如果直接make就会出现找不到头文件的错误

原因在于src下的源文件中include的头文件都是在同一路径下的，现在头文件被转移到了include路径下，因此现在有两种解决方案：

• 将源文件中的include “head.h”路径修改为include"…/include/head.h"
• 在CMakeLists.txt文件中加上头文件路径，如下所示：

include_directories(${PROJECT_SOURCE_DIR}/include)

当项目比较大时，第一种方法显然太过繁琐，因此使用第二种方法成为不二之选

2.6 通过CMake制作库文件

2.6.1 静态库

在linux中，静态库后缀为 .a, 动态库后缀为 .so
在window中，静态库后缀为 .lib,动态库后缀为 .dll

在cmake中，如果需要制作静态库，需要使用的命令如下：

add_library(库名称 ， STATIC 源文件1  源文件2 ······)

• 参数1：要制作的库名称
• 参数2：STATIC 表明要制作静态库、SHARED表明要制作动态库

在linux中，静态库名字分为三部分 lib+库名字+.a ，此处只需要指定库名字就可以了，另外两部分在生成该文件的时候会自动填写。

链接静态库
`link_libraries( […])

• 参数1：指定出要连接的静态库的名字
  • 可以是全名libxxx.a
  • 也可以是掐头去尾之后的名字xxx
• 参数2-N:要链接的其他静态库的名字

如果该静态库不是系统提供的，（自己制作或者是使用第三方提供的静态库）可能出现静态库找不到的情况，此时可以将静态库的路径也指定出来：
link_directories(<lib path>)

• 链接动态库

target_link_libraries(
	<target>
	<PRIVATE | PUBLIC | INTERFACE> <item>...
	[<PRIVATE | PUBLIC | INTERFACE> <item>...)

• target:指定要加载动态库的文件的名字

  • 该文件可能是一个源文件
  • 该文件可能是一个可执行动态库文件
  • 该文件可能是一个可执行文件

• PRIVATE|PUBLIC|INTERFACE：动态库访问权限 默认为 public

  • 如果各个动态库之间没有依赖关系，无需做任何设置，三者没有区别，一般无需指定，使用默认的public即可