All You Need for CMake系列03——Static Library

准备代码

代码结构如下：

.
├── CMakeLists.txt
├── include
│   └── static
│       └── Hello.h
└── src
    ├── Hello.cpp
    └── main.cpp

这是一个经典结构，moveit里面单独的包都是用这种方式写的。

Hello.h里内容如下：

#ifndef __HELLO_H__
#define __HELLO_H__

class Hello
{
public:
    void print();
};

#endif

Hello.cpp里内容如下：

#include <iostream>

#include "static/Hello.h"

void Hello::print()
{
    std::cout << "Hello Static Library!" << std::endl;
}

main.cpp

#include "static/Hello.h"

int main(int argc, char *argv[])
{
    Hello hi;
    hi.print();
    return 0;
}

CMakeLists.txt

cmake_minimum_required(VERSION 3.5)

project(hello_library)

############################################################
# Create a library
############################################################

#Generate the static library from the library sources
add_library(hello_library STATIC 
    src/Hello.cpp
)

target_include_directories(hello_library
    PUBLIC 
        ${PROJECT_SOURCE_DIR}/include
)


############################################################
# Create an executable
############################################################

# Add an executable with the above sources
add_executable(hello_binary 
    src/main.cpp
)

# link the new hello_library target with the hello_binary target
target_link_libraries( hello_binary
    PRIVATE 
        hello_library
)

要点

在本教程中演示了如何在CMakeLists.txt中添加对静态lib的支持，基本操作是
- 用PUBLIC的方式将header添加到target，add_library()把相关文件打包成一个lib，在这个例子中，会得到一个libhello_library.a的中间结果，这就是静态lib。
- 编译可执行文件时，因为需要lib，所以要对它进行连接。直接访问这个lib的方式是在src/main.cpp后面接着写src/Hello.cpp，现在Hello.cpp变成了一个lib，所以我们用link的方式去找Hello.cpp的代码。
关于PRIVATE，PUBLIC和INTERFACE标识符
- 如果大家看过上一章给出的连接，知道target_include_directories有三个标识符选项，这里另一个函数target_link_libraries也出现了PRIVATE。
- PRIVATE：PRIVATE后面的目录添加到target的include目录
- PUBLIC：目录被添加到lib，以及任何一个link到这个lib的target
- INTERFACE：目录被添加到任何一个link了这个lib的include目录
target_link_libraries里，hello_binary试图link到hello_library上，而hello_library和Hello.cpp以及其对应的头文件是用public的方式打包到一起的。所以根据上面的PUBLIC的功能，Hello.cpp对应的头文件路径会同时被添加到“任何一个link到这个lib的target”，在这里也就是hello_binary.

编译流程

mkdir build
cd build
cmake ..
make