开源项目学习(6)---- CMake 可执行文件生成

CMake 基础DEMO

可执行文件的生成

最简单的可执行文件实例

cmake_minimum_required(VERSION 3.22)
project(tonydemoproject)

add_executable(testdemo main.cpp)

如果要添加多个文件到可执行文件中：

cmake_minimum_required(VERSION 3.22)
project(tonydemoproject)

add_executable(testdemo main.cpp basicStringDemo.cpp basicStringDemo.h)

使用变量定义生成目标

也可以使用变量的方法定义：

file( GLOB APP_SOURCES RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.cpp )
message(Info "CMAKE_CURRENT_SOURCE_DIR is ${CMAKE_CURRENT_SOURCE_DIR}")
message(Info "APP_SOURCES is ${APP_SOURCES}")
add_executable(testdemo ${APP_SOURCES})

输出结果如下:

InfoCMAKE_CURRENT_SOURCE_DIR is /home/tonychen/Documents/visualstudiocode_demo
InfoAPP_SOURCES is basicStringDemo.cpp;cplusCastDemo.cpp;main.cpp
-- Configuring done
-- Generating done
-- Build files have been written to: /home/tonychen/Documents/visualstudiocode_demo/cmake_build

上面的 message 用于打印出信息，第一个参数的含义如下：

(无) = 重要消息；
 STATUS = 非重要消息；
 WARNING = CMake 警告, 会继续执行；
 AUTHOR_WARNING = CMake 警告 (dev), 会继续执行；
 SEND_ERROR = CMake 错误, 继续执行，但是会跳过生成的步骤；
 FATAL_ERROR = CMake 错误, 终止所有处理过程；

添加宏定义

......
add_definitions(-DTDEBUG)
add_executable(testdemo ${APP_SOURCES})

上面的 CMakeLists.txt 中就会自动添加 TDEBUG的宏

设置可执行文件的路径

设置可执行文件输出目录的方法如下：

.....

set (EXECUTABLE_OUTPUT_PATH ./bin/)
add_definitions(-DTDEBUG)
add_executable(testdemo ${APP_SOURCES})

编译时就会看到可执行文件的路径变化：
Consolidate compiler generated dependencies of target testdemo
[ 25%] Building CXX object CMakeFiles/testdemo.dir/main.cpp.o
[ 50%] Linking CXX executable bin/testdemo
[100%] Built target testdemo

自动寻找依赖库

cmake 提供了一个通过 类unix 系统都有的 pkg-config 命令自动查找依赖的库和对应头文件的操作，看实例如下：

cmake_minimum_required(VERSION 3.21)
project(basicc_demo C)

set(CMAKE_C_STANDARD 11)

find_package(PkgConfig REQUIRED)
pkg_search_module(EGL REQUIRED egl)
pkg_search_module(GLESv2 REQUIRED glesv2)

# 假设EGL_FOUND 打印出具体的 EGL 和 GLESv2 的信息
if(EGL_FOUND)
MESSAGE(WARNING "Found Packages EGL")
MESSAGE(WARNING "print ${EGL_INCLUDE_DIRS}")
MESSAGE(WARNING "print ${GLESv2_LIBRARIES}")
endif()

add_executable(basicc_demo main.c
        testbasicCOperator.h
        testbasicCOperator.c
        testbasicPointer.c
        testbasicPointer.h
        ccommon.h
        basicCVector.c
        basicCVector.h)

pkg_search_module( REQUIRED|QUIET [ ])
pkg_search_module 这个函数中，参数意义如下:

<prefix>: 这是一个变量前缀，CMake 会创建一些变量来表示找到模块的信息，这些信息会以这个前缀作为开头，
比如前缀是 FOO,那么可能会创建变量 FOO_FOUND,FOO_INCLUDE_DIRS 和 FOO_LIBRARIES
REQUIRED 或 QUIET:
REQUIRED 表示这个模块是必须找到的，如果找不到，CMake 将会停止配置过程并报错。
QUIET 表示如果找不到模块，CMake 不会发出警告或错误，配置过程会继续。
<name>: 这是你要查找的模块的名称，通常是 pkg-config 的模块名称。

打印信息

在 CMake 中，message() 函数用于在构建过程中输出信息性、警告性或错误性的消息，基本的使用方法如下：

message([<mode>] "message to display" ...)

mode 是可选参数，如果不提供，默认是 STATUS 类型，mode 的可选参数如下：
STATUS: 表示一条状态消息，这是默认模式
SEND_ERROR: 表示一条错误消息，这会导致 CMake 继续处理，但最终配置步骤会失败
FATAL_ERROR: 表示一条致命错误消息，CMake 会立即停止处
WARNING: 表示一条警告消息，CMake 会继续处理
AUTHOR_WARNING: 表示一条仅对项目作者可见的警告消息，类似于 WARNING，但不会警告最终用户

CMake 常见编译选项

下面是一些常用的 CMake 编译选项，以及经过验证：

1. -DCMAKE_BUILD_TYPE: 设置构建类型，如 Debug、Release、RelWithDebInfo 或 MinSizeRel

2. -DVAR=value: 定义一个变量及其值，可以在 CMakeLists.txt 中使用该变量

3. -H -S: 指定源代码目录，两者的含义相同

4. -B: 指定生成构建系统文件的目录，与 -S 选项结合使用 比如：
   cmake -S /xxxx/src -B ./cmake_build_dir

5. -D<CMAKE_VARIABLE>=<value>: 设置 CMake 内置变量的值，如 CMAKE_C_COMPILER、CMAKE_CXX_COMPILER 等

6. --build pathtobuild 在生成编译系统文件的基础上进行编译，路径和 -B 选项生成的一致，此命令会进行编译操作

tonychen@tonychen-PC:~/CLionProjects/basicc_demo$ cmake --build ./cmake-build-debug/
Consolidate compiler generated dependencies of target basicc_demo
[100%] Built target basicc_demo

7. --target xxx 制定生成的目标，通常和 --build 选项配合使用，注意这里的目标要和 CMakeLists.txt 中的保持一致，此命令用于 CMakeLists.txt 包含多目标的情形

8. -DCMAKE_INSTALL_PREFIX 设置安装的路径前缀
   cmake -DCMAKE_INSTALL_PREFIX=/path/to/install

9.-DBUILD_SHARED_LIBS=ON: 默认构建共享库（动态库）

10. -DBUILD_STATIC_LIBS=ON: 构建静态库
    cmake -DBUILD_STATIC_LIBS=ON