Mirrors/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-10-01 10:40:47 +03:00
Code Issues Packages Projects Releases Wiki Activity

feat(cmakev2/utilities): add __get_default_value helper

Browse Source 
Helper for obtaining the default value of a variable. It returns the
value of the specified variable based on the following order of
precedence, with the highest precedence first:

1. Environmental variable
2. CMake cache variable
3. Provided default value

This can be used to retrieve the value of variables that might also be
set in the environment or cache, such as PYTHON or SDKCONFIG.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
This commit is contained in:
Frantisek Hrbata
2025-11-04 07:48:12 +01:00
parent 0ffb07df1e
commit 04a91f68cd
1 changed files with 47 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tools/cmakev2/utilities.cmake
+47
View File
@@ -163,3 +163,50 @@ function(__get_absolute_paths)
set(${ARG_OUTPUT} "${absolute_paths}" PARENT_SCOPE)
endfunction()
#[[
__get_default_value(VARIABLE <variable>
DEFAULT <value>)
OUTPUT <result>)
:VARIABLE[in]: The name of the variable for which to obtain its default
value.
:DEFAULT[in]: Default variable value.
:OUTPUT[out]: Variable to store the default value of ``<variable>``.
Set the ``<result>`` to the value of ``<variable>`` based on the following
order of precedence, with the first having the highest precedence.
1. environmental variable
2. CMake cache variable
3. ``<value>`` as specified with the ``DEFAULT`` option
#]]
function(__get_default_value)
set(options)
set(one_value VARIABLE DEFAULT OUTPUT)
set(multi_value)
cmake_parse_arguments(ARG "${options}" "${one_value}" "${multi_value}" ${ARGN})
if(NOT DEFINED ARG_VARIABLE)
idf_die("VARIABLE option is required")
endif()
if(NOT DEFINED ARG_OUTPUT)
idf_die("OUTPUT option is required")
endif()
if(NOT DEFINED ARG_DEFAULT)
set(ARG_DEFAULT "")
endif()
if(DEFINED ENV{${ARG_VARIABLE}})
set(value "$ENV{${ARG_VARIABLE}}")
elseif(DEFINED CACHE{${ARG_VARIABLE}})
set(value "$CACHE{${ARG_VARIABLE}}")
else()
set(value "${ARG_DEFAULT}")
endif()
set(${ARG_OUTPUT} "${value}" PARENT_SCOPE)
endfunction()