cmake的基本使用

前言

公司当前使用的都是cmake，之前没怎么用过，趁着项目间歇期专门学习一下，以此为记；
这次是有针对性的学习，所以都是通过各种例子来实现的；

cmake具体使用

一个cpp文件编译出一个可执行文件

文件目录

其中build是目录，是为了把cmake编译过程中产生的文件与源文件隔离而建立的，这就是cmake推荐使用的外部构建模式；

文件内容

main.cpp

#include <stdlib.h>
#include <stdio.h>int main() {printf("cmake test\n");return 1;
}

CMakeLists.txt

cmake_minimum_required(VERSION 3.5) #设置CMake最小版本
project (cmake_test) #设置工程名
add_executable(${PROJECT_NAME} main.cpp) #生成可执行文件   add_executable(cmake_test main.cpp)

编译

在build目录下先执行 cmake3 …（表示从build的上层目录去寻找CMakeLists.txt）去生成MakeFile文件，执行命令后的文件目录如下：

再在build目录下执行make命令，来进行真正的编译：

make执行后，可以在build目录下看到有 cmake_test 可执行文件的生成，至此完成该目标；
在后面的例子里，默认都是在工程目录下建立build目录并在该目录下生成MakeFile文件并生成可执行文件的——除非后面出现复杂情况，比如说在指定目录下生成时；

多级目录+多个cpp文件生成可执行文件

文件目录

可以看到，有2个cpp文件（main.cpp + src/my_class_1.cpp）和1个h文件(include/my_class_1.h)

文件内容

include/my_class_1.h

#ifndef _MY_CLASS_1_H_
#define _MY_CLASS_1_H_class My_Class_1 {public:My_Class_1();~My_Class_1();void class1_func();
};#endif

src/my_class_1.cpp

#include <iostream>
#include "my_class_1.h"My_Class_1::My_Class_1() {std::cout << "My_Class_1::My_Class_1" << std::endl;
}My_Class_1::~My_Class_1() {std::cout << "My_Class_1::~My_Class_1" << std::endl;
}void My_Class_1::class1_func() {std::cout << "My_Class_1::class1_func==> " << std::endl;
}

main.cpp

#include <stdlib.h>
#include <stdio.h>#include "my_class_1.h"int main() {printf("cmake test\n");My_Class_1 my_class_1_obj;my_class_1_obj.class1_func();return 1;
}

CMakeLists.txt

cmake_minimum_required(VERSION 3.5) #设置CMake最小版本project (cmake_test) #设置工程名set(SOURCES main.cpp src/my_class_1.cpp) #创建一个变量，名字叫SOURCE。它包含了所有的cpp文件。
#如果想把当前目录下的所有的cpp文件统一编译，可以使用： aux_source_directory(. SOURCES)
add_executable(${PROJECT_NAME} ${SOURCES}) #用所有的源文件生成一个可执行文件，因为这里定义了SOURCE变量，所以就不需要罗列cpp文件了target_include_directories(${PROJECT_NAME} PRIVATE ${PROJECT_SOURCE_DIR}/include) #设置生成这个可执行文件需要包含的头文件目录

多级目录+多个cpp文件分别生成动态库文件和可执行文件

文件目录

与上一个例子相比，文件目录未变；

文件内容

与上一个例子相比，仅有 CMakeLists.txt 的内容发生了变化，其他未变的不做说明；
CMakeLists.txt

cmake_minimum_required(VERSION 3.5) #设置CMake最小版本project (cmake_test) #设置工程名#Create a library 把my_class_1.cpp编译成一个动态库(名字是：libmyclass.so)
add_library(myclass SHARED src/my_class_1.cpp)#为这个动态库添加其编译所需的头文件目录
target_include_directories(myclass PUBLIC ${PROJECT_SOURCE_DIR}/include)#生成可执行文件
add_executable(${PROJECT_NAME} main.cpp)#链接库和可执行文件
target_link_libraries(${PROJECT_NAME} PRIVATE myclass)

编译

重新生成MakeFile并编译后，可以看到在build目录下生成了 libmyclass.so 动态库；

在指定目录生成动态库文件和可执行文件

文件目录

与上一个例子相比，文件目录未变；

文件内容

与上一个例子相比，仅有 CMakeLists.txt 的内容发生了变化，其他未变的不做说明；
CMakeLists.txt

cmake_minimum_required(VERSION 3.5) #设置CMake最小版本#设置工程名
project (cmake_test) #设置可执行文件的输出目录
SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)#设置库文件的输出目录
SET(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)# Create a library 把my_class_1.cpp编译成一个动态库(名字是：libmyclass.so)
add_library(myclass SHARED src/my_class_1.cpp)#为这个动态库添加其编译所需的头文件目录
target_include_directories(myclass PUBLIC ${PROJECT_SOURCE_DIR}/include)#生成可执行文件
add_executable(${PROJECT_NAME} main.cpp)#设置动态链接库目录
link_libraries(${PROJECT_SOURCE_DIR}/lib)#链接库和可执行文件
target_link_libraries(${PROJECT_NAME} PRIVATE myclass)

相比较于上个例子，只是指定了生成动态库和可执行文件的目录：动态库是在工程目录的lib目录下，可执行文件在工程目录的bin目录下；是通过下面两句话来实现设置的：

#设置可执行文件的输出目录
SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)#设置库文件的输出目录
SET(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)

参考

RoboMaster视觉教程CMake