CMake学习3 - 渐入佳境

一、内容概述

本篇文章主要以实际案例为主。
语法细节参考《CMake学习1 - 初出茅庐》,构建方法参考《CMake学习2 - 小试牛刀》。

通过四个案例讲解静态库和共享库的创建及调用方法。

  • 单个共享库工程
  • 单个静态库工程
  • 使用共享库与静态库
  • 使用 pkg-config 库

二、单个共享库工程

2.1 工程说明

  • 构建一个名为 “Math” 的共享库
  • 构建产物为 "libMath.so"
  • 通过 add_library 指令指定 “SHARED” 关键字,表明构建共享库
  • 支持通过 make install 指令安装库至标准库

2.2 工程结构

    .
    ├── CMakeLists.txt
    ├── include
    │   └── math
    │       └── math.h
    └── math.cpp

2.3 文件内容

  • CMakeLists.txt

    # 构建该工程所需cmake的最低版本
    cmake_minimum_required(VERSION 3.1)
    
    # 指定工程名称(输出 libMath.so)
    project(Math)
    
    # 创建静态库(需包含所有cpp文件)
    add_library(${PROJECT_NAME} SHARED math.cpp)
    
    # 包含工程所需头文件所在目录
    target_include_directories(${PROJECT_NAME} PUBLIC ${PROJECT_SOURCE_DIR}/include)
    
    # 安装头文件
    install(DIRECTORY "${PROJECT_SOURCE_DIR}/include/" DESTINATION "/usr/local/include")
    
    # 安装库文件
    install(TARGETS ${PROJECT_NAME} DESTINATION /usr/local/lib)
  • math.h

    #pragma once
    
    double add(double a, double b);
    double sub(double a, double b);
    double mul(double a, double b);
    double div(double a, double b);
  • math.c

    #include <math/math.h>
    
    double add(double a, double b)
    {
        return a + b;
    }
    
    double sub(double a, double b)
    {
        return a - b;
    }
    
    double mul(double a, double b)
    {
        return  a * b;
    }
    
    double div(double a, double b)
    {
        return a / b;
    }

三、单个静态库工程

3.1 工程说明

  • 构建一个名为 “Ui” 的静态库
  • 构建产物为 “libUi.a”
  • 通过 add_library 指令指定 “STATIC” 关键字,表明构建静态库
  • 支持通过 make install 指令安装库至标准库
  • 注意 include 文件夹的头文件组织格式,这里采用了标准用法。

3.2 工程结构

    .
    ├── button.cpp
    ├── CMakeLists.txt
    ├── edit.cpp
    └── include
        └── ui
            ├── button.h
            ├── edit.h
            └── element.hpp

3.3 文件内容

  • CMakeLists.txt

    # 构建工程所需cmake的最低版本
    cmake_minimum_required(VERSION 3.1)
    
    # 指定工程名称(输出 libUi.so)
    project(Ui)
    
    # 创建共享库(需包含所有cpp文件)
    add_library(${PROJECT_NAME} STATIC button.cpp edit.cpp)
    
    # 包含工程所需头文件所在目录
    target_include_directories(${PROJECT_NAME} PUBLIC ${PROJECT_SOURCE_DIR}/include)
    
    # 安装头文件
    install(DIRECTORY "${PROJECT_SOURCE_DIR}/include/" DESTINATION "/usr/local/include")
    
    # 安装库文件
    install(TARGETS ${PROJECT_NAME} DESTINATION /usr/local/lib)
  • element.hpp

    #pragma once
    #include <iostream>
    using namespace std;
    
    class UiElement
    {
    public:
        virtual void show() = 0;
        virtual void click() = 0;
    };
  • button.h

    #include "element.hpp"
    
    class Button : public UiElement
    {
    public:
        virtual void show()  override final;
        virtual void click() override final;
    };
  • edit.h

    #include "element.hpp"
    
    class Edit : public UiElement
    {
    public:
        virtual void show()  override final;
        virtual void click() override final;
    };
  • button.cpp

    #include <ui/button.h>
    
    void Button::show()
    {
        cout << "Button::show() called." << endl;
    }
    
    void Button::click()
    {
        cout << "Button::click() called." << endl;
    }
  • edit.cpp

    #include <ui/edit.h>
    
    void Edit::show()
    {
        cout << "Edit::show() called." << endl;
    }
    
    void Edit::click()
    {
        cout << "Edit::click() called." << endl;
    }

四、使用共享库与静态库

4.1 工程说明

  • 此工程演示如何使用上述两个示例创建的动态库及静态库。
  • 上面的两个示例工程编译成功后需执行 sudo make install 操作,安装至标准库路径。
  • 此工程引用的头文件目录位于 “/usr/local/include”
  • 此工程引用的库文件目录位于 “/usr/local/lib”
  • 此工程安装的可执行文件位于 “/usr/local/bin”
  • 如果已安装静态库和共享库(且文件的确存在),运行可执行程序提示找不到共享库时,请执行 ldconfig 指令,更新共享库缓存。

4.2 工程结构

    .
    ├── CMakeLists.txt
    └── main.cpp

4.3 文件内容

  • CMakeLists.txt

    # 所需 cmake 工具的最低版本
    cmake_minimum_required(VERSION 3.1)
    
    # 工程名称
    project(AppProject)
    
    # 生成可执行程序
    add_executable(${PROJECT_NAME} main.cpp)
    
    # 链接依赖动态库
    target_link_libraries(${PROJECT_NAME} Math Ui)
    
    # 安装可执行程序
    install(TARGETS ${PROJECT_NAME} DESTINATION "/usr/local/bin")
  • main.cpp

    #include <iostream>
    #include <ui/edit.h>
    #include <ui/button.h>
    #include <math/math.h>
    
    int main(int argc, char* argv[])
    {
        std::cout << "Demonstrate how to use the math library:" << std::endl;
        std::cout << "6.0 + 3.0 = " << add(6.0, 3.0) << std::endl;
        std::cout << "6.0 - 3.0 = " << sub(6.0, 3.0) << std::endl;
        std::cout << "6.0 * 3.0 = " << mul(6.0, 3.0) << std::endl;
        std::cout << "6.0 / 3.0 = " << div(6.0, 3.0) << std::endl;
    
        std::cout << "Demonstrate how to use the ui library:" << std::endl;
        Button button;
        button.show();
        button.click();
    
        Edit edit;
        edit.show();
        edit.click();
    }

5.4 运行效果

    Demonstrate how to use the math library:
    6.0 + 3.0 = 9
    6.0 - 3.0 = 3
    6.0 * 3.0 = 18
    6.0 / 3.0 = 2
    Demonstrate how to use the ui library:
    Button::show() called.
    Button::click() called.
    Edit::show() called.
    Edit::click() called.

五、使用 pkg-config 库

5.1 工程说明

  • 工程通过 find_package 和 pkg_check_modules 指令访问 pkg-config 类型库
  • GST 是一个自定义变量,检查成功返回有效的对象引用。
  • GST_INCLUDE_DIRS 表示 gstreamer 相关库的头文件目录集合
  • GST_LIBRARIES 表示 gstreamer 相关库的库文件目录集合
  • 工程中编译链接时需包含GST相关库的头文件及库文件。

5.2 工程结构

    .
    ├── CMakeLists.txt
    └── player.c

5.3 文件内容

  • CMakeLists.txt

    # 所需 cmake 工具的最低版本
    cmake_minimum_required(VERSION 3.1)
    
    # 工程名称
    project(player)
    
    # 生成可执行程序
    add_executable(${PROJECT_NAME} player.c)
    
    # 查找pkg-config依赖库
    find_package(PkgConfig)
    pkg_check_modules(GST REQUIRED gstreamer-1.0>=1.8 gstreamer-app-1.0>=1.8)
    
    # 引用 gstreamer 头文件
    target_include_directories(${PROJECT_NAME} PUBLIC ${GST_INCLUDE_DIRS})
    
    # 链接 gstreamer 库文件
    target_link_libraries(${PROJECT_NAME} ${GST_LIBRARIES})
  • player.c

    #include <gst/gst.h>
    
    int
    main (int argc, char *argv[])
    {
      GstElement *pipeline;
      GstBus *bus;
      GstMessage *msg;
    
      /* Initialize GStreamer */
      gst_init (&argc, &argv);
    
      /* Build the pipeline */
      pipeline =
          gst_parse_launch
          ("playbin uri=https://www.freedesktop.org/software/gstreamer-sdk/data/media/sintel_trailer-480p.webm",
          NULL);
    
      /* Start playing */
      gst_element_set_state (pipeline, GST_STATE_PLAYING);
    
      /* Wait until error or EOS */
      bus = gst_element_get_bus (pipeline);
      msg =
          gst_bus_timed_pop_filtered (bus, GST_CLOCK_TIME_NONE,
          GST_MESSAGE_ERROR | GST_MESSAGE_EOS);
    
      /* Free resources */
      if (msg != NULL)
        gst_message_unref (msg);
      gst_object_unref (bus);
      gst_element_set_state (pipeline, GST_STATE_NULL);
      gst_object_unref (pipeline);
      return 0;
    }

六、参考链接

  • GStreamer Basic tutorial 1: Hello world!

评论

暂无评论