Mac/linux环境下 如何使用 CMakeLists.txt 编译c++工程2019-10-01

本文主要目的是记录 利用CMakeLists.txt编译C++。

1 创建C++工程

1.1 创建工程目录及CMakeLists.txt文件

$ mkdir hello_world
$ cd hello_world
$ mkdir bin
$ mkdir lib
$ mkdir src
$ mkdir include
$ mkdir build
$ touch CMakeLists.txt

在这里插入图片描述

1.2 编写源文件

$ cd src
$ touch main.cpp
$ touch hello_world.cpp

$ cd ../include/
$ touch hello_world.h

//main.cpp
#include 
int main(int argc ,char ** argv)
{
helloword obt;
obt.outputWord();
return 0;
}

//hello_world.h
#ifndef HELLO_WORLD_H_
#define HELLO_WORLD_H_

#include 

class helloword
{
public:
    void outputWord();
};
#endif

//hello_world.cpp
#include "hello_world.h"
void helloword::outputWord()
{
    std::cout<<"hello world" <

2 编写CMakeLists.txt

编写CMakeLists.txt文件。

cmake_minimum_required(VERSION 2.8) #cmake最低版本
project(hello_world)  #项目名称

SET(CMAKE_BUILD_TYPE Release) #将编译方式设置为Release。 debug系统运行会慢很多。

set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin) #设置可执行文件保存的路径
set(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)  #设置链接库保存的路径

include_directories(${PROJECT_SOURCE_DIR}/include) #设置头文件目录使得系统可以找到对应的头文件

add_executable(hello_world src/hello_world.cpp src/main.cpp)#然后选择需要编译的源文件，凡是要编译的源文件都需要列举出来。

3 编译工程

$ cd build  #build文件夹 存放编译生成的中间文件。
$ cmake .. #生成makefile文件
$ make  #编译项目

编译通过以后就会在对应的bin文件夹中生成名为hello_world的可执行文件。

4 运行

#input
$ cd bin/
$ ./hello_world #运行可执行文件

#output
hello world

编译后的工程文件结构如下。为了避免文件混乱，所以一般会创建build文件夹来存放编译生成了很多中间文件。

在这里插入图片描述

5、CMake常用命令介绍

5.1 CMake中生成动态库和静态库

• add_library(target [shared | static] SRC_LIST): 生成静态库文件或共享库文件
• target_link_libraries(target libother): 链接需要的库文件
• link_directories: 指定要链接的库文件的路径
• set_target_properties(target PROPERTIES [OUTPUT_NAME | VERSION ...] value): 设置target属性值

5.1.1 add_library

该指令的主要作用就是将指定的源文件生成链接文件，然后添加到工程中去。该指令常用的语法如下：

add_library( [STATIC | SHARED | MODULE]
            [EXCLUDE_FROM_ALL]
            [source1] [source2] [...])
//name:库文件名称
//[STATIC | SHARED | MODULE]的作用是指定生成的库文件的类型
    //STATIC库是目标文件的归档文件，在链接其它目标的时候使用。
    //SHARED库会被动态链接（动态链接库），在运行时会被加载。
    //MODULE库是一种不会被链接到其它目标中的插件，但是可能会在运行时使用dlopen-系列的函数。
    //默认状态下，库文件将会在于源文件目录树的构建目录树的位置被创建，该命令也会在这里被调用。
//[source1] [source2] [...])分别表示各个源文件

example

add_library(${PROJECT_NAME} SHARED src/track/Tracking.cpp)

5.1.2 link_directories

该指令的作用主要是指定要链接的库文件的路径，该指令有时候不一定需要。因为find_package和find_library指令可以得到库文件的绝对路径。不过你自己写的动态库文件放在自己新建的目录下时，可以用该指令指定该目录的路径以便工程能够找到。
example

link_directories(lib)

5.1.3 target_link_libraries

该指令的作用为将目标文件与库文件进行链接。该指令的语法如下：

target_link_libraries( [item1] [item2] [...]
                      [[debug|optimized|general] ] ...)

//是指通过add_executable()和add_library()指令生成已经创建的目标文件
//[item1] [item2] [...]表示库文件没有后缀的名字。默认情况下，库依赖项是传递的。当这个目标链接到另一个目标时，链接到这个目标的库也会出现在另一个目标的连接线上。这个传递的接口存储在interface_link_libraries的目标属性中，可以通过设置该属性直接重写传递接口。

example:

include_directories(
    ${catkin_INCLUDE_DIRS}
    ${svo_SOURCE_DIR}/include/svo
    ${svo_SOURCE_DIR}/include/svo/track
)

add_library(${PROJECT_NAME} SHARED 
src/track/Tracking.cpp
)

add_executable(${PROJECT_NAME}_node src/svo_node.cpp src/system.cpp)

target_link_libraries(${PROJECT_NAME}_node
    ${catkin_LIBRARIES}
    ${PROJECT_NAME}
) 

5.1.4 set_target_properties

set_target_properties(target PROPERTIES [OUTPUT_NAME | VERSION ...] value): 设置target属性值

example:
按照一般的习惯，静态库名字跟动态库名字应该是一致的，只是扩展名不同；即：静态库名为 libhello.a； 动态库名为libhello.so ；所以，希望 "hello_static" 在输出时，不是"hello_static"，而是以"hello"的名字显示，故设置如下：

SET_TARGET_PROPERTIES (hello_static PROPERTIES OUTPUT_NAME "hello")

5.2

more...

6、 Reference:

• Linux下CMake简明教程
• Linux下CMakeLists.txt编译C++程序笔记