CMake解析參數用法示例

cmake_parse_arguments 是 CMake 中用于解析函數或宏參數的工具，特別適合處理帶有選項（OPTIONS）、單值參數（SINGLE_ARGS）和多值參數（MULTI_ARGS）的復雜參數列表。以下是用法說明和一個示例：

基本語法

cmake_parse_arguments(<PREFIX>          # 解析后變量的前綴"<OPTIONS>"       # 選項列表（如 --enable-foo）"<SINGLE_ARGS>"   # 單值參數列表（如 --key VALUE）"<MULTI_ARGS>"    # 多值參數列表（如 --files a.txt b.txt）${ARGN}           # 需要解析的參數（通常用 ${ARGN}）
)

解析后，可以通過以下變量訪問參數：

選項: ${<PREFIX>_<OPTION_NAME>}（值為 TRUE/FALSE）
單值參數: ${<PREFIX>_<SINGLE_ARG_NAME>}
多值參數: ${<PREFIX>_<MULTI_ARG_NAME>}

示例

假設我們需要定義一個宏 setup_project，支持以下參數：

選項: ENABLE_TEST（是否啟用測試）
單值參數: VERSION（項目版本號）
多值參數: SOURCES（源文件列表）

代碼實現

# 定義宏
macro(setup_project)# 解析參數set(OPTIONS "ENABLE_TEST")        # 選項列表set(SINGLE_ARGS "VERSION")        # 單值參數列表set(MULTI_ARGS "SOURCES")         # 多值參數列表cmake_parse_arguments("ARG"                         # 前綴為 ARG"${OPTIONS}""${SINGLE_ARGS}""${MULTI_ARGS}"${ARGN}                       # 傳入宏的參數)# 檢查是否有未解析的參數（可選）if(ARG_UNPARSED_ARGUMENTS)message(WARNING "Unknown arguments: ${ARG_UNPARSED_ARGUMENTS}")endif()# 處理選項if(ARG_ENABLE_TEST)message(STATUS "Testing enabled")# 添加測試相關邏輯...endif()# 處理單值參數if(ARG_VERSION)message(STATUS "Project version: ${ARG_VERSION}")else()message(FATAL_ERROR "VERSION must be specified!")endif()# 處理多值參數if(ARG_SOURCES)message(STATUS "Source files: ${ARG_SOURCES}")# 添加編譯目標...add_executable(my_app ${ARG_SOURCES})else()message(FATAL_ERROR "SOURCES must be specified!")endif()
endmacro()# 調用示例
setup_project(ENABLE_TESTVERSION 1.0.0SOURCES src/main.cpp src/utils.cpp
)

輸出結果

-- Testing enabled
-- Project version: 1.0.0
-- Source files: src/main.cpp;src/utils.cpp

注意事項

變量作用域：如果使用 macro 而非 function，解析后的變量會影響父作用域。建議在函數中使用 function + PARENT_SCOPE 控制作用域。
參數順序：CMake 不關心參數順序，但需要確保參數名和值正確匹配。
未解析參數：通過 ${<PREFIX>_UNPARSED_ARGUMENTS} 可以捕獲未知參數。

通過 cmake_parse_arguments，你可以更靈活地處理 CMake 函數/宏的復雜參數！

你提到的這一點非常重要！在 CMake 中，宏（macro）和函數（function）的行為有本質區別（尤其是作用域規則不同）。以下我會詳細解釋它們的差異，并給出一個函數的例子，同時說明為何在之前的回答中選擇了宏。

為什么先用了宏（macro）的例子？

簡化示例：
在簡單的示例中，宏的變量作用域規則（直接修改父作用域）可以讓代碼更簡潔，不需要額外處理變量傳遞。對于新手來說，這可能更容易理解。
歷史原因：
早期 CMake 版本中，cmake_parse_arguments 在函數中的行為需要更謹慎的作用域處理，而宏的行為更“直接”。

但實際項目中，**函數（function）**通常是更安全的選擇，因為它能隔離作用域，避免變量污染。

函數（function）的示例

以下是將之前的 setup_project 從宏改為函數的實現，并修復作用域問題：

代碼實現

# 定義函數
function(setup_project)# 解析參數set(OPTIONS "ENABLE_TEST")        # 選項列表set(SINGLE_ARGS "VERSION")        # 值參數列表set(MULTI_ARGS "SOURCES")         # 多值參數列表cmake_parse_arguments("ARG"                         # 前綴為 ARG"${OPTIONS}""${SINGLE_ARGS}""${MULTI_ARGS}"${ARGN}                       # 傳入函數的參數)# 檢查未解析的參數（可選）if(ARG_UNPARSED_ARGUMENTS)message(WARNING "Unknown arguments: ${ARG_UNPARSED_ARGUMENTS}")endif()# 處理選項if(ARG_ENABLE_TEST)message(STATUS "Testing enabled")# 啟用測試邏輯（例如 include(CTest)）endif()# 處理單值參數if(NOT ARG_VERSION)message(FATAL_ERROR "VERSION must be specified!")endif()message(STATUS "Project version: ${ARG_VERSION}")# 處理多值參數if(NOT ARG_SOURCES)message(FATAL_ERROR "SOURCES must be specified!")endif()message(STATUS "Source files: ${ARG_SOURCES}")# 關鍵點：將變量傳遞到父作用域（如果需要影響外部）# 例如，將源文件列表傳遞給父作用域：set(SOURCES ${ARG_SOURCES} PARENT_SCOPE)# 在函數內創建目標（變量直接可見）add_executable(my_app ${ARG_SOURCES})
endfunction()# 調用示例
setup_project(ENABLE_TESTVERSION 1.0.0SOURCES src/main.cpp src/utils.cpp
)

宏（macro） vs 函數（function）的關鍵區別

特性	宏（macro）	函數（function）
作用域	直接修改父作用域的變量	默認只在函數內部作用域有效
變量傳遞	自動“泄漏”到父作用域	需顯式使用 `set(... PARENT_SCOPE)`
性能	類似代碼替換，可能更高效	有獨立作用域，稍復雜
安全性	容易污染父作用域變量	隔離作用域，更安全

為什么推薦使用函數？

避免變量污染：
函數不會意外覆蓋父作用域的變量（例如，如果父作用域中已經有一個 VERSION 變量，宏可能會直接修改它，而函數不會）。
邏輯隔離：
函數內部的操作（如 add_executable）默認只在函數作用域內生效，除非顯式傳遞變量到父作用域。
可維護性：
函數的隔離性使得代碼行為更可預測，適合復雜項目。

何時使用宏？

需要直接修改父作用域：
例如，在頂層腳本中快速操作變量。
簡單代碼替換：
當邏輯非常簡單且不需要隔離作用域時。

總結

如果你的目標是封裝一個可復用的邏輯模塊，優先使用函數。
如果示例中使用了宏，可以補充一個函數的版本，明確說明作用域處理的差異。這樣用戶可以根據實際需求選擇。

這段代碼的目的是通過兩次調用 cmake_parse_arguments 實現一種嵌套參數解析的機制。它的核心思路是：先解析外層的“元參數”（定義如何解析內層參數），再用這些元參數去解析實際傳遞的參數。以下是對代碼的詳細解釋，以及這種設計的優缺點分析。

代碼解釋

function(nuttx_parse_function_args)cmake_parse_arguments(IN "" "FUNC""OPTIONS;ONE_VALUE;MULTI_VALUE;REQUIRED;ARGN" "${ARGN}")cmake_parse_arguments(OUT "${IN_OPTIONS}" "${IN_ONE_VALUE}""${IN_MULTI_VALUE}" "${IN_ARGN}")if(OUT_UNPARSED_ARGUMENTS)message(FATAL_ERROR "${IN_NAME}: unparsed ${OUT_UNPARSED_ARGUMENTS}")endif()foreach(arg ${IN_OPTIONS} ${IN_ONE_VALUE} ${IN_MULTI_VALUE})set(${arg}${OUT_${arg}}PARENT_SCOPE)endforeach()endfunction()

1. 函數定義

function(nuttx_parse_function_args)

定義了一個名為 nuttx_parse_function_args 的函數，目的是封裝一個通用的參數解析工具。

2. 第一次解析：`cmake_parse_arguments(IN ...)`

cmake_parse_arguments(IN ""                   # 外層無選項（OPTIONS）"FUNC"               # 外層單值參數（SINGLE_ARGS）"OPTIONS;ONE_VALUE;MULTI_VALUE;REQUIRED;ARGN"  # 外層多值參數（MULTI_ARGS）"${ARGN}"            # 輸入的參數列表
)

目的：解析外層的“元參數”，這些參數定義了如何解析內層的實際參數。
解析結果：
- IN_FUNC: 單值參數，表示實際要解析的函數名（可能用于錯誤提示）。
- IN_OPTIONS: 多值參數，定義內層參數的選項（OPTIONS）。
- IN_ONE_VALUE: 多值參數，定義內層參數的單值參數（SINGLE_ARGS）。
- IN_MULTI_VALUE: 多值參數，定義內層參數的多值參數（MULTI_ARGS）。
- IN_ARGN: 多值參數，保存實際需要解析的內層參數列表。

3. 第二次解析：`cmake_parse_arguments(OUT ...)`

cmake_parse_arguments(OUT "${IN_OPTIONS}"      # 內層選項（來自第一次解析的 IN_OPTIONS）"${IN_ONE_VALUE}"    # 內層單值參數（來自第一次解析的 IN_ONE_VALUE）"${IN_MULTI_VALUE}"  # 內層多值參數（來自第一次解析的 IN_MULTI_VALUE）"${IN_ARGN}"         # 實際需要解析的參數（來自第一次解析的 IN_ARGN）
)

目的：用第一次解析得到的元參數（IN_OPTIONS, IN_ONE_VALUE, IN_MULTI_VALUE）去解析實際的內層參數（IN_ARGN）。
解析結果：
- OUT_<OPTION>: 內層選項的值（TRUE/FALSE）。
- OUT_<SINGLE_ARG>: 內層單值參數的值。
- OUT_<MULTI_ARG>: 內層多值參數的值。

4. 錯誤檢查

if(OUT_UNPARSED_ARGUMENTS)message(FATAL_ERROR "${IN_NAME}: unparsed ${OUT_UNPARSED_ARGUMENTS}")
endif()

檢查是否有未解析的參數，如果有則報錯。

5. 將解析結果傳遞到父作用域

foreach(arg ${IN_OPTIONS} ${IN_ONE_VALUE} ${IN_MULTI_VALUE})set(${arg}${OUT_${arg}}PARENT_SCOPE)
endforeach()

將內層解析得到的參數值（OUT_<arg>）傳遞到父作用域，使得調用者可以訪問這些參數。

為什么使用兩次解析？

這種設計的關鍵在于動態定義參數解析規則：

外層解析：定義內層參數的解析規則（哪些是選項、單值參數、多值參數）。
內層解析：根據外層解析得到的規則，解析實際的參數列表。

例如，假設調用代碼如下：

nuttx_parse_function_args(FUNC my_functionOPTIONS ENABLE_FOOONE_VALUE VERSIONMULTI_VALUE SOURCESARGN ENABLE_FOO VERSION 1.0.0 SOURCES a.cpp b.cpp
)

外層解析會提取 OPTIONS ENABLE_FOO, ONE_VALUE VERSION, MULTI_VALUE SOURCES，并將 ENABLE_FOO VERSION 1.0.0 SOURCES a.cpp b.cpp 保存到 IN_ARGN。
內層解析會根據外層解析的規則，將 ENABLE_FOO 解析為選項，VERSION 解析為單值參數，SOURCES 解析為多值參數。