forked from TriBITSPub/TriBITS
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Moved arg parsing helper functions into new modules (TriBITSPub#483)
This makes the module TribitsGeneralMacros.cmake smaller and better aggregates these commands. I also added a new macro tribits_assert_parse_arg_one_value() which I just tested manually. It is a very simple macro so I am not too worried about not unit testing it yet.
- Loading branch information
1 parent
3845cc7
commit 799287a
Showing
3 changed files
with
151 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| # @HEADER | ||
| # ************************************************************************ | ||
| # | ||
| # TriBITS: Tribal Build, Integrate, and Test System | ||
| # Copyright 2013 Sandia Corporation | ||
| # | ||
| # Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, | ||
| # the U.S. Government retains certain rights in this software. | ||
| # | ||
| # Redistribution and use in source and binary forms, with or without | ||
| # modification, are permitted provided that the following conditions are | ||
| # met: | ||
| # | ||
| # 1. Redistributions of source code must retain the above copyright | ||
| # notice, this list of conditions and the following disclaimer. | ||
| # | ||
| # 2. Redistributions in binary form must reproduce the above copyright | ||
| # notice, this list of conditions and the following disclaimer in the | ||
| # documentation and/or other materials provided with the distribution. | ||
| # | ||
| # 3. Neither the name of the Corporation nor the names of the | ||
| # contributors may be used to endorse or promote products derived from | ||
| # this software without specific prior written permission. | ||
| # | ||
| # THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY | ||
| # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
| # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE | ||
| # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, | ||
| # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, | ||
| # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR | ||
| # PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF | ||
| # LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING | ||
| # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
| # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| # | ||
| # ************************************************************************ | ||
| # @HEADER | ||
|
|
||
|
|
||
| ################################################################################ | ||
| # | ||
| # This module contains function to aid with the usage of | ||
| # cmake_parse_arguments(). | ||
| # | ||
| ################################################################################ | ||
|
|
||
|
|
||
| # @FUNCTION: tribits_check_for_unparsed_arguments() | ||
| # | ||
| # Check to see if there are unparsed arguments after calling | ||
| # ``cmake_parse_arguments()`` or ``tribits_parse_arguments_from_list()`` | ||
| # | ||
| # Usage:: | ||
| # | ||
| # tribits_check_for_unparsed_arguments([<prefix>]) | ||
| # | ||
| # If `<prefix>` is not given, it is assumed to be `PARSE`. | ||
| # | ||
| function(tribits_check_for_unparsed_arguments) | ||
|
|
||
| if ("${ARGC}" GREATER 1) | ||
| message(FATAL_ERROR | ||
| "ERROR tribits_check_for_unparsed_arguments() passed arguments '${ARGV}' but only accepts 0 or 1 arguments (for <prefix>)") | ||
| endif() | ||
|
|
||
| set(prefix "PARSE") | ||
| foreach(arg ${ARGV}) | ||
| set(prefix "${arg}") | ||
| endforeach() | ||
|
|
||
| if( NOT "${${prefix}_UNPARSED_ARGUMENTS}" STREQUAL "") | ||
| message_wrapper( | ||
| ${${PROJECT_NAME}_CHECK_FOR_UNPARSED_ARGUMENTS} | ||
| "Arguments passed in unrecognized. ${prefix}_UNPARSED_ARGUMENTS = '${${prefix}_UNPARSED_ARGUMENTS}'" | ||
| ) | ||
| endif() | ||
|
|
||
| endfunction() | ||
|
|
||
|
|
||
| # @FUNCTION: tribits_assert_parse_arg_one_or_more_values() | ||
| # | ||
| # Assert that a parase argument has at least one value | ||
| # | ||
| # Usage:: | ||
| # | ||
| # tribits_assert_parse_arg_one_or_more_values(<prefix> <argname>) | ||
| # | ||
| macro(tribits_assert_parse_arg_one_or_more_values PREFIX ARGNAME) | ||
| set(PREFIX_ARGNAME "${PREFIX}_${ARGNAME}") | ||
| list( LENGTH ${PREFIX_ARGNAME} ARG_NUM_VALS ) | ||
| if (ARG_NUM_VALS LESS 1) | ||
| message_wrapper(FATAL_ERROR | ||
| "ERROR: ${ARGNAME} must have at least one value!" ) | ||
| return() | ||
| # NOTE: The return() is needed in unit testing mode | ||
| endif() | ||
| endmacro() | ||
|
|
||
|
|
||
| # @FUNCTION: tribits_assert_parse_arg_zero_or_one_value() | ||
| # | ||
| # Assert that a parase argument has zero or one value | ||
| # | ||
| # Usage:: | ||
| # | ||
| # tribits_assert_parse_arg_zero_or_one_value(<prefix> <argname>) | ||
| # | ||
| macro(tribits_assert_parse_arg_zero_or_one_value PREFIX ARGNAME) | ||
| set(PREFIX_ARGNAME "${PREFIX}_${ARGNAME}") | ||
| if (NOT "${${PREFIX_ARGNAME}}" STREQUAL "") | ||
| list( LENGTH ${PREFIX_ARGNAME} ARG_NUM_VALS ) | ||
| if (ARG_NUM_VALS GREATER 1) | ||
| message_wrapper(FATAL_ERROR | ||
| "ERROR: ${ARGNAME}='${${PREFIX_ARGNAME}}' can not have more than one value!" ) | ||
| return() | ||
| # NOTE: The macro return() is needed in unit testing mode | ||
| endif() | ||
| endif() | ||
| endmacro() | ||
|
|
||
|
|
||
| # @FUNCTION: tribits_assert_parse_arg_one_value() | ||
| # | ||
| # Assert that a parse argument has exactly one value | ||
| # | ||
| # Usage:: | ||
| # | ||
| # tribits_assert_parse_arg_one_value(<prefix> <argname>) | ||
| # | ||
| macro(tribits_assert_parse_arg_one_value PREFIX ARGNAME) | ||
| set(PREFIX_ARGNAME "${PREFIX}_${ARGNAME}") | ||
| if (NOT "${${PREFIX_ARGNAME}}" STREQUAL "") | ||
| list( LENGTH ${PREFIX_ARGNAME} ARG_NUM_VALS ) | ||
| if (NOT ARG_NUM_VALS EQUAL 1) | ||
| message_wrapper(FATAL_ERROR | ||
| "ERROR: ${ARGNAME}='${${PREFIX_ARGNAME}}' Must have exactly one value!" ) | ||
| return() | ||
| # NOTE: The macro return() is needed in unit testing mode | ||
| endif() | ||
| endif() | ||
| endmacro() | ||
|
|
||
|
|
||
| # NOTE: Above, we use macros for the assert functions with returns in unit | ||
| # test mode so that it will abort the calling function these are called from! |