cmake/gmxOptionUtilities.cmake

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2013, by the GROMACS development team, led by
   5 # David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6 # others, as listed in the AUTHORS file in the top-level source
   7 # directory and at http://www.gromacs.org.
   8 #
   9 # GROMACS is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU Lesser General Public License
  11 # as published by the Free Software Foundation; either version 2.1
  12 # of the License, or (at your option) any later version.
  13 #
  14 # GROMACS is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 # Lesser General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU Lesser General Public
  20 # License along with GROMACS; if not, see
  21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23 #
  24 # If you want to redistribute modifications to GROMACS, please
  25 # consider that scientific software is very special. Version
  26 # control is crucial - bugs must be traceable. We will be happy to
  27 # consider code for inclusion in the official distribution, but
  28 # derived work must not be called official GROMACS. Details are found
  29 # in the README & COPYING files - if they are missing, get the
  30 # official version at http://www.gromacs.org.
  31 #
  32 # To help us fund GROMACS development, we humbly ask that you cite
  33 # the research papers on the package. Check out http://www.gromacs.org.
  34
  35 #
  36 # Helper functions for managing more complex options
  37 #
  38
  39 # Creates a string cache variable with multiple choices
  40 #
  41 # Usage:
  42 #   gmx_option_multichoice(VAR "Description" DEFAULT_VALUE
  43 #                          Value1 Value2 ... ValueN)
  44 # Output:
  45 #   VAR is set in the cache and in the caller's scope. The caller can assume
  46 #   that it is always one of the provided values, converted to uppercase.
  47 #
  48 # Main benefit is that the list of allowed values only needs to be provided
  49 # once, and gets used in multiple contexts:
  50 #   1. It is automatically added to the description.
  51 #   2. It is set as the STRINGS property of the created cache variable for use
  52 #      with CMake GUIs.
  53 #   3. The user-provided value is checked against the list, and a fatal error
  54 #      is produced if the value is not known.  The caller does not need to
  55 #      produce good error messages in cases where it may be necessary to check
  56 #      for the validity again.
  57 # As a special case, any "[built-in]" string in the allowed values is ignored
  58 # when checking the user-provided value, but is added to all user-visible
  59 # messages.
  60 #
  61 # It appears that ccmake does not use the STRINGS property, but perhaps some
  62 # day...
  63 #
  64 function(GMX_OPTION_MULTICHOICE NAME DESCRIPTION DEFAULT)
  65     # Some processing of the input values
  66     string(REPLACE ";" ", " _allowed_comma_separated "${ARGN}")
  67     set(_description "${DESCRIPTION}. Pick one of: ${_allowed_comma_separated}")
  68     string(REPLACE "[built-in]" "" _allowed "${ARGN}")
  69
  70     # Set the cache properties
  71     set(${NAME} ${DEFAULT} CACHE STRING ${_description})
  72     set_property(CACHE ${NAME} PROPERTY STRINGS ${_allowed})
  73
  74     # Check that the value is one of the allowed
  75     set(_org_value "${${NAME}}")
  76     string(TOUPPER "${${NAME}}" ${NAME})
  77     string(TOUPPER "${_allowed}" _allowed_as_upper)
  78     list(FIND _allowed_as_upper "${${NAME}}" _found_index)
  79     if (_found_index EQUAL -1)
  80         message(FATAL_ERROR "Invalid value for ${NAME}: ${_org_value}.  "
  81                             "Pick one of: ${_allowed_comma_separated}")
  82     endif ()
  83     # Always provide the upper-case value to the caller
  84     set(${NAME} "${${NAME}}" PARENT_SCOPE)
  85 endfunction()
  86
  87 # Convenience function for reporting a fatal error for an invalid input value
  88 function(GMX_INVALID_OPTION_VALUE NAME)
  89     message(FATAL_ERROR "Invalid value for ${NAME}: ${${NAME}}")
  90 endfunction()