7.4 用指定参数定义函数或宏
前面的示例中,我们研究了函数和宏,并使用了位置参数。这个示例中,我们将定义一个带有命名参数的函数。我们将复用第1节中的示例,使用函数和宏重用代码,而不是使用以下代码定义测试:。
我们将这样调用函数:
我们使用第1节中的示例,使用函数和宏重用代码,并保持C++源代码不变,文件树保持不变:
.
├── cmake
│ └── testing.cmake
├── CMakeLists.txt
├── src
│ ├── CMakeLists.txt
│ ├── main.cpp
│ ├── sum_integers.cpp
│ └── sum_integers.hpp
└── tests
├── catch.hpp
├── CMakeLists.txt
└── test.cpp
我们对CMake代码进行一些修改,如下所示:
保持
src/CMakeLists.txt
。tests/CMakeLists.txt
中,将add_catch_test
函数定义移动到cmake/testing.cmake
,并且定义两个测试:add_executable(cpp_test test.cpp)
target_link_libraries(cpp_test sum_integers)
include(testing)
add_catch_test(
short
LABELS
short
cpp_test
1.5
)
add_catch_test(
NAME
long
LABELS
long
cpp_test
COST
2.5
)
add_catch_test
在cmake/testing.cmake
中定义:测试输出:
$ mkdir -p build
$ cd build
$ cmake ..
-- ...
-- defining a test ...
-- NAME: short
-- COST: 1.5
-- REFERENCE_FILES:
-- defining a test ...
-- NAME: long
-- LABELS: long;cpp_test
-- COST: 2.5
-- REFERENCE_FILES:
-- ...
示例的特点是其命名参数,因此我们可以将重点放在模块上。CMake提供cmake_parse_arguments
命令,我们使用函数名(add_catch_test
)选项(我们的例子中是none
)、单值参数(NAME
和COST
)和多值参数(LABELS
、DEPENDS
和REFERENCE_FILES
)调用该命令:
function(add_catch_test)
set(options)
set(oneValueArgs NAME COST)
set(multiValueArgs LABELS DEPENDS REFERENCE_FILES)
cmake_parse_arguments(add_catch_test
"${options}"
"${oneValueArgs}"
"${multiValueArgs}"
${ARGN}
)
...
endfunction()
cmake_parse_arguments
命令解析选项和参数,并在例子中定义如下:
- add_catch_test_NAME
- add_catch_test_COST
- add_catch_test_LABELS
- add_catch_test_DEPENDS
- add_catch_test_REFERENCE_FILES
可以查询,并在函数中使用这些变量。这种方法使我们有机会用更健壮的接口和更具有可读的函数/宏调用,来实现函数和宏。
选项关键字(本例中我们没有使用)由cmake_parse_arguments
定义为TRUE
或FALSE
。add_catch_test
函数,还提供test
命令作为一个命名参数,为了更简洁的演示,我们省略了这个参数。