mirror of
https://github.com/microsoft/vcpkg.git
synced 2024-12-12 02:49:02 +08:00
d369df7ecf
* [rollup:2021-07-06 1/8] PR #18272 (@strega-nil) [scripts-audit] vcpkg_from_* * [rollup:2021-07-06 2/8] PR #18319 (@strega-nil) [scripts-audit] add guidelines for cmake * [rollup 2021-07-06 3/8] PR #18410 (@mheyman) [vcpkg-cmake-config] documentation fix * [rollup:2021-07-06 4/8] PR #18488 (@strega-nil) [scripts-audit] vcpkg_execute_* * [rollup:2021-07-06 5/8] PR #18517 (@strega-nil) [scripts-audit] vcpkg_extract_source_archive * [rollup:2021-07-06 6/8] PR #18674 (@NancyLi1013) [vcpkg doc] Update examples * [rollup:2021-07-06 7/8] PR #18695 (@JackBoosY) [vcpkg] Update the minimum version of vcpkg * [rollup:2021-07-06 8/8] PR #18758 (@ras0219-msft) [vcpkg_from_git] Fix error if downloads folder does not exist * build docs! * fix bond:*-windows * fix nmap Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: Michael Heyman <Michael.Heyman@jhuapl.edu> Co-authored-by: NancyLi1013 <lirui09@beyondsoft.com> Co-authored-by: JackBoosY <yuzaiyang@beyondsoft.com> Co-authored-by: Robert Schumacher <ras0219@outlook.com>
49 lines
1.5 KiB
CMake
49 lines
1.5 KiB
CMake
#[===[.md:
|
|
# z_vcpkg_forward_output_variable
|
|
|
|
This macro helps with forwarding values from inner function calls,
|
|
through a local function scope, into pointer out parameters.
|
|
|
|
```cmake
|
|
z_vcpkg_forward_output_variable(ptr_to_parent_var var_to_forward)
|
|
```
|
|
|
|
is equivalent to
|
|
|
|
```cmake
|
|
if(DEFINED ptr_to_parent_var)
|
|
if(DEFINED value_var)
|
|
set("${ptr_to_parent_var}" "${value_var}" PARENT_SCOPE)
|
|
else()
|
|
unset("${ptr_to_parent_var}" PARENT_SCOPE)
|
|
endif()
|
|
endif()
|
|
```
|
|
|
|
Take note that the first argument should be a local variable that has a value of the parent variable name.
|
|
Most commonly, this local is the result of a pointer-out parameter to a function.
|
|
If the variable in the first parameter is not defined, this function does nothing,
|
|
simplifying functions with optional out parameters.
|
|
Most commonly, this should be used in cases like:
|
|
|
|
```cmake
|
|
function(my_function out_var)
|
|
file(SHA512 "somefile.txt" local_var)
|
|
z_vcpkg_forward_output_variable(out_var local_var)
|
|
endfunction()
|
|
```
|
|
#]===]
|
|
|
|
macro(z_vcpkg_forward_output_variable ptr_to_parent_var var_to_forward)
|
|
if("${ARGC}" GREATER "2")
|
|
message(FATAL_ERROR "z_vcpkg_forward_output_variable was passed extra arguments: ${ARGN}")
|
|
endif()
|
|
if(DEFINED "${ptr_to_parent_var}")
|
|
if(DEFINED "${var_to_forward}")
|
|
set("${${ptr_to_parent_var}}" "${${var_to_forward}}" PARENT_SCOPE)
|
|
else()
|
|
unset("${${ptr_to_parent_var}}" PARENT_SCOPE)
|
|
endif()
|
|
endif()
|
|
endmacro()
|