CMake入门教程【核心篇】宏模板(macro)

😈「CSDN主页」：传送门
😈「Bilibil首页」：传送门
😈「本文的内容」：CMake入门教程
😈「动动你的小手」：点赞👍收藏??评论📝

---

在本文中，我们将深入探讨CMake中宏的使用方法及其技巧，以简化CMakeLists.txt文件的编写和维护。

1. 定义宏

在CMake中，使用macro关键字定义宏。宏可以包含一系列的CMake指令，用于执行重复的任务。

1.1 基本语法

macro(<macro_name> [arg1 [arg2 ...]])
    # 宏的内容
endmacro()

1.2 示例

定义一个名为print_message的宏，用于打印一条消息：

macro(print_message message)
    message(STATUS "Message: ${message}")
endmacro()

2. 调用宏

调用宏时，使用宏的名称并传入相应的参数。

2.1 调用语法

在CMake中，调用宏的语法如下：

<macro_name>([arg1 [arg2 ...]])

2.2 示例

调用print_message宏：

print_message("Hello, CMake!")

3. 参数传递

宏支持参数传递。在宏定义时指定参数名，在调用时传递相应的实际参数值。

3.1 示例

定义一个名为print_sum的宏，计算两个数的和：

macro(print_sum a b)
    math(EXPR sum "${a} + ${b}")
    message(STATUS "Sum: ${sum}")
endmacro()

调用print_sum宏：

print_sum(3 5)

4. 模拟宏的返回值

虽然CMake宏没有返回值的概念，但可以通过设置变量来模拟返回值。

4.1 示例

定义add_numbers宏，计算两个数的和，并将结果保存在变量中：

macro(add_numbers a b result_var)
    math(EXPR sum "${a} + ${b}")
    set(${result_var} ${sum} PARENT_SCOPE)
endmacro()

调用add_numbers宏：

set(my_result)
add_numbers(3 5 my_result)
message(STATUS "Result: ${my_result}")

5. 宏的作用域

宏内部定义的变量默认是局部的。使用PARENT_SCOPE选项可以将变量提升到父级作用域。

5.1 示例

定义set_global_variable宏，设置一个全局变量：

macro(set_global_variable var_name var_value)
    set(${var_name} ${var_value} PARENT_SCOPE)
endmacro()

调用set_global_variable宏：

set_global_variable(my_var "Hello, CMake!")
message(STATUS "Global variable: ${my_var}")

6.macro使用技巧

结论

CMake宏是一种强大的工具，可以有效地简化和重用CMake代码。通过理解宏的基本用法、参数传递、返回值模拟以及作用域管理，你可以提高CMakeLists.txt文件的可维护性和可读性。正确使用宏将有助于提高项目构建过程的效率和灵活性。