[cmake]cmake构建自己的库

本小节将讲述如果构建自己的库,在开始之前先对目录做一些调整。原先的目录没有划分,三方库、本工程的源文件、构建过程文件和构建结果都在一个文件夹下,看起来比较凌乱,因此在开始构建自己的库之前,先来重构一下文件夹。

重构目录

源码放入到src文件夹下,自己的库放入lib文件夹下,三方库(gtest)放入opensrc文件夹下,构建过程放入到build文件夹下,所有的构建目标都放入到output文件夹下。调整后的目录如下:

example/
├── build
├── CMakeLists.txt
├── lib
│   └── CMakeLists.txt
├── output
└── src
    ├── CMakeLists.txt
    └── main.cpp

example/CMakeLists.txt文件内容,指定了可执行文件的输出目录是output:

cmake_minimum_required(VERSION 3.22)
project(example)

SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/output) #设置可执行目标文件的输出目录
add_subdirectory(src)
add_subdirectory(lib)

example/src/CMakeLists.txt文件内容:

FIND_PACKAGE(GTest 
                CONFIG REQUIRED
                PATHS /home/gtest/lib/cmake/GTest)

if (GTest_FOUND)
    GET_PROPERTY(include_def TARGET GTest::gtest PROPERTY INTERFACE_INCLUDE_DIRECTORIES)
    GET_PROPERTY(library_def TARGET GTest::gtest PROPERTY INTERFACE_LINK_LIBRARIES)
    MESSAGE("Found gtest libs, include: ${include_def}, library: ${library_def}")
    ADD_EXECUTABLE(main main.cpp)
    TARGET_LINK_LIBRARIES(main GTest::gtest)
endif()

example/src/main.cpp文件内容:

#include "gtest/gtest.h"

TEST(FirstTest, testcase1)
{
    ASSERT_EQ(1, 1);
}

int main(int argc, char** argv)
{
    ::testing::InitGoogleTest(&argc, argv);
    return RUN_ALL_TESTS();
}

example/lib/CMakeLists.txt暂时没用到,后续构建我们自己的库使用,当前文件内容是空的。

进入example/build目录执行cmake ..(<font color='red'>注意是两个点</font>)和make之后,运行../output/main输出如下:

[==========] Running 1 test from 1 test suite.
[----------] Global test environment set-up.
[----------] 1 test from FirstTest
[ RUN      ] FirstTest.testcase1
[       OK ] FirstTest.testcase1 (0 ms)
[----------] 1 test from FirstTest (0 ms total)

[----------] Global test environment tear-down
[==========] 1 test from 1 test suite ran. (0 ms total)
[  PASSED  ] 1 test.

编写自己的库

现在来构建一个我们自己的库,假设我们库提供的功能是提供两个整数相加返回结果的的函数int add(int a, int b)

example/lib/mylib.cpp文件内容:

#include "mylib.h"

namespace mylib {

int add(int a, int b)
{
    int sum = a + b;
    return sum;
}


};

example/lib/mylib.h文件内容:

#pragma once
namespace mylib {

int add(int a, int b);

};

example/CMakeLists.txt文件内容:

cmake_minimum_required(VERSION 3.22)
project(example)

set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/output) # 设置可执行目标文件的输出目录
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/output) # 设置静态库文件的输出目录

add_subdirectory(src)
add_subdirectory(lib)

target_link_libraries(main mylib)

example/lib/CMakeLists.txt文件内容:

add_library(mylib mylib.cpp)
target_include_directories(mylib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})

example/src/main.cpp文件内容:

#include "gtest/gtest.h"
#include "mylib.h"

TEST(FirstTest, testcase1)
{
    ASSERT_EQ(2, mylib::add(1, 1));
}

int main(int argc, char** argv)
{
    ::testing::InitGoogleTest(&argc, argv);
    return RUN_ALL_TESTS();
}

如何传编译开关

如果现在想要加一个功能,在调用add的时候打印具体相加的两个整数信息,作为调试的信息,如何只在构建的时候指定对应编译开关的时候才编译这个功能呢?

可以通过cmake -DXXX来将XXX变量传递给CMake,而CMake中可以通过target_add_definitions增加宏定义YYY,在库代码中通过判断宏定义YYY是否存在,来实现打印信息的添加。

首先是库代码,example/lib/mylib.cpp文件内容,判定DEBUG_INFO宏是否存在,存在则打印一行信息:

#include "mylib.h"

#ifdef DEBUG_INFO
#include <iostream>
#endif

namespace mylib {

int add(int a, int b)
{
    int sum = a + b;
#ifdef DEBUG_INFO
    std::cout << "Add " << a << " and " << b << " is " << sum << std::endl;
#endif
    return sum;
}


};

然后,在CMake中通过判断是否有DEBUG变量开关来添加宏定义,example/CMakeLists.txt文件内容:

cmake_minimum_required(VERSION 3.22)
project(example)

set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/output) # 设置可执行目标文件的输出目录
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/output) # 设置静态库文件的输出目录

add_subdirectory(src)
add_subdirectory(lib)

target_link_libraries(main mylib)

if (DEBUG)
    target_compile_definitions(mylib PRIVATE DEBUG_INFO)
endif()

进入example/build目录执行cmake .. -DDEBUG=ON(<font color='red'>注意是DEBUG=ON的形式</font>)和make之后,运行../output/main输出如下:

[==========] Running 1 test from 1 test suite.
[----------] Global test environment set-up.
[----------] 1 test from FirstTest
[ RUN      ] FirstTest.testcase1
Add 1 and 1 is 2
[       OK ] FirstTest.testcase1 (0 ms)
[----------] 1 test from FirstTest (0 ms total)

[----------] Global test environment tear-down
[==========] 1 test from 1 test suite ran. (0 ms total)
[  PASSED  ] 1 test.
  • 4
    点赞
  • 10
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

FL1768317420

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值