From: maier Date: Mon, 22 Oct 2012 12:40:25 +0000 (+0000) Subject: Rename local variables to _, Part 3 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=047fff6cb90ae1928dd5c4bbef153cb01e874b6c;p=dealii-svn.git Rename local variables to _, Part 3 git-svn-id: https://svn.dealii.org/branches/branch_cmake@27158 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/cmake/macros/macro_configure_feature.cmake b/deal.II/cmake/macros/macro_configure_feature.cmake index b52158f33e..75972b66b6 100644 --- a/deal.II/cmake/macros/macro_configure_feature.cmake +++ b/deal.II/cmake/macros/macro_configure_feature.cmake @@ -19,48 +19,48 @@ # CONFIGURE_FEATURE(feature) # # -# For a feature ${feature} (written in all caps) the following options, +# For a feature ${_feature} (written in all caps) the following options, # variables and macros have to be defined (except marked as optional): # -# DEAL_II_WITH_${feature} (bool, mandatory) +# DEAL_II_WITH_${_feature} (bool, mandatory) # If DEAL_II_FEATURE_AUTODETECTION is OFF, this boolean determines # whether the feature will be configured. # If DEAL_II_FEATURE_AUTODETECTION is ON, this boolean will # automatically be set if configuring the feature was successful. # -# FEATURE_${feature}_DEPENDS (variable, optional) +# FEATURE_${_feature}_DEPENDS (variable, optional) # a variable which contains an optional list of other features # this feature depends on (and which have to be enbled for this feature # to work.) The features must be given with the full option toggle: # DEAL_II_WITH_[...] # -# FEATURE_${feature}_HAVE_BUNDLED (variable, optional) +# FEATURE_${_feature}_HAVE_BUNDLED (variable, optional) # which should either be set to TRUE if all necessary libraries of the # features comes bundled with deal.II and hence can be supported # without external dependencies, or unset. # -# FEATURE_${feature}_CONFIGURE_BUNDLED(var) (macro, optional) +# FEATURE_${_feature}_CONFIGURE_BUNDLED(var) (macro, optional) # which should setup all necessary configuration for the feature with # bundled source dependencies. var set to TRUE indicates success, # otherwise this script gives an error. # -# FEATURE_${feature}_FIND_EXTERNAL(var) (macro, mandatory) +# FEATURE_${_feature}_FIND_EXTERNAL(var) (macro, mandatory) # which should set var to TRUE if all dependencies for the feature are # fullfilled. In this case all necessary variables for -# FEATURE_${feature}_CONFIGURE_EXTERNAL must be set. Otherwise +# FEATURE_${_feature}_CONFIGURE_EXTERNAL must be set. Otherwise # var should remain unset. # This macro should give an error (FATAL_ERROR or FATAL_ERROR). # -# FEATURE_${feature}_CONFIGURE_EXTERNAL(var) (macro, mandatory) +# FEATURE_${_feature}_CONFIGURE_EXTERNAL(var) (macro, mandatory) # which should setup all necessary configuration for the feature with # external dependencies. var set to TRUE indicates success, # otherwise this script gives an error. # -# FEATURE_${feature}_CUSTOM_ERROR_MESSAGE() (variable, optional) -# which should either be set to TRUE if FEATURE_${feature}_ERROR_MESSAGE +# FEATURE_${_feature}_CUSTOM_ERROR_MESSAGE() (variable, optional) +# which should either be set to TRUE if FEATURE_${_feature}_ERROR_MESSAGE # is set up, or be undefined. # -# FEATURE_${feature}_ERROR_MESSAGE() (macro, optional) +# FEATURE_${_feature}_ERROR_MESSAGE() (macro, optional) # which should print a meaningfull error message (with FATAL_ERROR) for # the case that no external library was found (and bundled is not # allowed to be used.) If not defined, a suitable default error message @@ -76,22 +76,22 @@ # # Some black magic to have substitution in command names: # -MACRO(RUN_COMMAND the_command) +MACRO(RUN_COMMAND _the_command) FILE(WRITE "${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/macro_configure_feature.tmp" - "${the_command}") + "${_the_command}") INCLUDE("${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/macro_configure_feature.tmp") ENDMACRO() # -# A small macro to set the DEAL_II_WITH_${feature} variables: +# A small macro to set the DEAL_II_WITH_${_feature} variables: # -MACRO(SET_CACHED_OPTION str value) - STRING(TOLOWER "${str}" str_lower) - SET(DEAL_II_WITH_${str} - ${value} +MACRO(SET_CACHED_OPTION _str _value) + STRING(TOLOWER "${_str}" _str_lower) + SET(DEAL_II_WITH_${_str} + ${_value} CACHE BOOL - "Build deal.II with support for ${str_lower}." + "Build deal.II with support for ${_str_lower}." FORCE) ENDMACRO() @@ -99,22 +99,22 @@ ENDMACRO() # # A small macro to post a default error message: # -MACRO(FEATURE_ERROR_MESSAGE feature) - STRING(TOLOWER ${feature} feature_lowercase) - IF(FEATURE_${feature}_HAVE_BUNDLED) +MACRO(FEATURE_ERROR_MESSAGE _feature) + STRING(TOLOWER ${_feature} _feature_lowercase) + IF(FEATURE_${_feature}_HAVE_BUNDLED) MESSAGE(FATAL_ERROR "\n" - "Could not find the ${feature_lowercase} library!\n\n" - "Please ensure that the ${feature_lowercase} library is installed on your computer.\n" + "Could not find the ${_feature_lowercase} library!\n\n" + "Please ensure that the ${_feature_lowercase} library is installed on your computer.\n" "If the library is not at a default location, either provide some hints\n" "for the autodetection, or set the relevant variables by hand in ccmake.\n\n" "Alternatively you may choose to compile the bundled library of\n" - "${feature_lowercase} by setting DEAL_II_ALLOW_BUNDLED=on or\n" - "DEAL_II_FORCE_BUNDLED_${feature}=on.\n\n" + "${_feature_lowercase} by setting DEAL_II_ALLOW_BUNDLED=on or\n" + "DEAL_II_FORCE_BUNDLED_${_feature}=on.\n\n" ) ELSE() MESSAGE(FATAL_ERROR "\n" - "Could not find the ${feature_lowercase} library!\n\n" - "Please ensure that the ${feature_lowercase} library is installed on your computer.\n" + "Could not find the ${_feature_lowercase} library!\n\n" + "Please ensure that the ${_feature_lowercase} library is installed on your computer.\n" "If the library is not at a default location, either provide some hints\n" "for the autodetection, or set the relevant variables by hand in ccmake.\n\n" ) @@ -122,7 +122,7 @@ MACRO(FEATURE_ERROR_MESSAGE feature) ENDMACRO() -MACRO(CONFIGURE_FEATURE feature) +MACRO(CONFIGURE_FEATURE _feature) # # This script is arcane black magic. But at least for the better good: We # don't have to copy the configuration logic to every single @@ -135,13 +135,13 @@ MACRO(CONFIGURE_FEATURE feature) # If feature B depends on feature A, configure_A.cmake has to be # included before configure_B.cmake: # - FOREACH(macro_dependency ${FEATURE_${feature}_DEPENDS}) - STRING(REGEX REPLACE "^DEAL_II_WITH_" "" macro_dependency ${macro_dependency}) - IF(NOT FEATURE_${macro_dependency}_PROCESSED) + FOREACH(_dependency ${FEATURE_${_feature}_DEPENDS}) + STRING(REGEX REPLACE "^DEAL_II_WITH_" "" _dependency ${_dependency}) + IF(NOT FEATURE_${_dependency}_PROCESSED) MESSAGE(FATAL_ERROR "\n" - "Internal build system error:\nDEAL_II_WITH_${feature} depends on " - "DEAL_II_WITH_${macro_dependency},\nbut CONFIGURE_FEATURE(${feature}) " - "was called before CONFIGURE_FEATURE(${macro_dependency}).\n\n" + "Internal build system error:\nDEAL_II_WITH_${_feature} depends on " + "DEAL_II_WITH_${_dependency},\nbut CONFIGURE_FEATURE(${_feature}) " + "was called before CONFIGURE_FEATURE(${_dependency}).\n\n" ) ENDIF() ENDFOREACH() @@ -151,147 +151,147 @@ MACRO(CONFIGURE_FEATURE feature) # Obey the user overrides: # IF(FORCE_AUTODETECTION) - UNSET(DEAL_II_WITH_${feature}) + UNSET(DEAL_II_WITH_${_feature}) ENDIF() IF(DISABLE_AUTODETECTION AND - (NOT DEFINED DEAL_II_WITH_${feature}) ) - SET_CACHED_OPTION(${feature} OFF) + (NOT DEFINED DEAL_II_WITH_${_feature}) ) + SET_CACHED_OPTION(${_feature} OFF) ENDIF() # - # Only try to configure ${feature} if we have to, i.e. - # DEAL_II_WITH_${feature} is set to true or not set at all. + # Only try to configure ${_feature} if we have to, i.e. + # DEAL_II_WITH_${_feature} is set to true or not set at all. # - IF((NOT DEFINED DEAL_II_WITH_${feature}) OR - DEAL_II_WITH_${feature}) + IF((NOT DEFINED DEAL_II_WITH_${_feature}) OR + DEAL_II_WITH_${_feature}) # # Are all dependencies fullfilled? # - SET(macro_dependencies_ok TRUE) - FOREACH(macro_dependency ${FEATURE_${feature}_DEPENDS}) - IF(NOT ${macro_dependency}) - IF(DEAL_II_WITH_${feature}) + SET(_dependencies_ok TRUE) + FOREACH(_dependency ${FEATURE_${_feature}_DEPENDS}) + IF(NOT ${_dependency}) + IF(DEAL_II_WITH_${_feature}) MESSAGE(FATAL_ERROR "\n" - "DEAL_II_WITH_${feature} has unmet configuration requirements: " - "${macro_dependency} has to be set to \"ON\".\n\n" + "DEAL_II_WITH_${_feature} has unmet configuration requirements: " + "${_dependency} has to be set to \"ON\".\n\n" ) ELSE() MESSAGE(STATUS - "DEAL_II_WITH_${feature} has unmet configuration requirements: " - "${macro_dependency} has to be set to \"ON\"." + "DEAL_II_WITH_${_feature} has unmet configuration requirements: " + "${_dependency} has to be set to \"ON\"." ) - SET_CACHED_OPTION(${feature} OFF) + SET_CACHED_OPTION(${_feature} OFF) ENDIF() - SET(macro_dependencies_ok FALSE) + SET(_dependencies_ok FALSE) ENDIF() ENDFOREACH() - IF(macro_dependencies_ok) - IF(DEAL_II_FORCE_BUNDLED_${feature}) + IF(_dependencies_ok) + IF(DEAL_II_FORCE_BUNDLED_${_feature}) # - # First case: DEAL_II_FORCE_BUNDLED_${feature} is defined: + # First case: DEAL_II_FORCE_BUNDLED_${_feature} is defined: # - IF(FEATURE_${feature}_HAVE_BUNDLED) + IF(FEATURE_${_feature}_HAVE_BUNDLED) RUN_COMMAND( - "FEATURE_${feature}_CONFIGURE_BUNDLED(FEATURE_${feature}_BUNDLED_CONFIGURED)" + "FEATURE_${_feature}_CONFIGURE_BUNDLED(FEATURE_${_feature}_BUNDLED_CONFIGURED)" ) - IF(FEATURE_${feature}_BUNDLED_CONFIGURED) + IF(FEATURE_${_feature}_BUNDLED_CONFIGURED) MESSAGE(STATUS - "DEAL_II_WITH_${feature} successfully set up with bundled packages." + "DEAL_II_WITH_${_feature} successfully set up with bundled packages." ) - SET_CACHED_OPTION(${feature} ON) + SET_CACHED_OPTION(${_feature} ON) ELSE() # This should not happen. So give an error MESSAGE(FATAL_ERROR "\nInternal build system error: Failed to set up " - "DEAL_II_WITH_${feature} with bundled packages.\n\n" + "DEAL_II_WITH_${_feature} with bundled packages.\n\n" ) ENDIF() ELSE() MESSAGE(FATAL_ERROR "\n" - "Internal build system error: DEAL_II_FORCE_BUNDLED_${feature} " - "defined, but FEATURE_${feature}_HAVE_BUNDLED not present.\n" + "Internal build system error: DEAL_II_FORCE_BUNDLED_${_feature} " + "defined, but FEATURE_${_feature}_HAVE_BUNDLED not present.\n" ) ENDIF() - ELSE(DEAL_II_FORCE_BUNDLED_${feature}) + ELSE(DEAL_II_FORCE_BUNDLED_${_feature}) # # Second case: We are allowed to search for an external library # RUN_COMMAND( - "FEATURE_${feature}_FIND_EXTERNAL(FEATURE_${feature}_EXTERNAL_FOUND)" + "FEATURE_${_feature}_FIND_EXTERNAL(FEATURE_${_feature}_EXTERNAL_FOUND)" ) - IF(FEATURE_${feature}_EXTERNAL_FOUND) + IF(FEATURE_${_feature}_EXTERNAL_FOUND) MESSAGE(STATUS - "All external dependencies for DEAL_II_WITH_${feature} are fullfilled." + "All external dependencies for DEAL_II_WITH_${_feature} are fullfilled." ) RUN_COMMAND( - "FEATURE_${feature}_CONFIGURE_EXTERNAL(FEATURE_${feature}_EXTERNAL_CONFIGURED)" + "FEATURE_${_feature}_CONFIGURE_EXTERNAL(FEATURE_${_feature}_EXTERNAL_CONFIGURED)" ) - IF(FEATURE_${feature}_EXTERNAL_CONFIGURED) + IF(FEATURE_${_feature}_EXTERNAL_CONFIGURED) MESSAGE(STATUS - "DEAL_II_WITH_${feature} successfully set up with external dependencies." + "DEAL_II_WITH_${_feature} successfully set up with external dependencies." ) - SET_CACHED_OPTION(${feature} ON) + SET_CACHED_OPTION(${_feature} ON) ELSE() # This should not happen. So give an error MESSAGE(FATAL_ERROR "\nInternal build system error: Failed to set up " - "DEAL_II_WITH_${feature} with external dependencies.\n\n" + "DEAL_II_WITH_${_feature} with external dependencies.\n\n" ) ENDIF() - ELSE(FEATURE_${feature}_EXTERNAL_FOUND) + ELSE(FEATURE_${_feature}_EXTERNAL_FOUND) MESSAGE(STATUS - "DEAL_II_WITH_${feature} has unmet external dependencies." + "DEAL_II_WITH_${_feature} has unmet external dependencies." ) - IF(FEATURE_${feature}_HAVE_BUNDLED AND DEAL_II_ALLOW_BUNDLED) + IF(FEATURE_${_feature}_HAVE_BUNDLED AND DEAL_II_ALLOW_BUNDLED) RUN_COMMAND( - "FEATURE_${feature}_CONFIGURE_BUNDLED(FEATURE_${feature}_BUNDLED_CONFIGURED)" + "FEATURE_${_feature}_CONFIGURE_BUNDLED(FEATURE_${_feature}_BUNDLED_CONFIGURED)" ) - IF(FEATURE_${feature}_BUNDLED_CONFIGURED) + IF(FEATURE_${_feature}_BUNDLED_CONFIGURED) MESSAGE(STATUS - "DEAL_II_WITH_${feature} successfully set up with bundled packages." + "DEAL_II_WITH_${_feature} successfully set up with bundled packages." ) - SET_CACHED_OPTION(${feature} ON) + SET_CACHED_OPTION(${_feature} ON) ELSE() # This should not happen. So give an error MESSAGE(FATAL_ERROR "\nInternal build system error: Failed to set up " - "DEAL_II_WITH_${feature} with bundled packages.\n\n" + "DEAL_II_WITH_${_feature} with bundled packages.\n\n" ) ENDIF() ELSE() - IF(DEAL_II_WITH_${feature}) - IF(FEATURE_${feature}_CUSTOM_ERROR_MESSAGE) - RUN_COMMAND("FEATURE_${feature}_ERROR_MESSAGE()") + IF(DEAL_II_WITH_${_feature}) + IF(FEATURE_${_feature}_CUSTOM_ERROR_MESSAGE) + RUN_COMMAND("FEATURE_${_feature}_ERROR_MESSAGE()") ELSE() - FEATURE_ERROR_MESSAGE(${feature}) + FEATURE_ERROR_MESSAGE(${_feature}) ENDIF() ELSE() - SET_CACHED_OPTION(${feature} OFF) + SET_CACHED_OPTION(${_feature} OFF) ENDIF() ENDIF() - ENDIF(FEATURE_${feature}_EXTERNAL_FOUND) + ENDIF(FEATURE_${_feature}_EXTERNAL_FOUND) ENDIF() ENDIF() ELSE() # - # DEAL_II_WITH_${feature} is defined and set to OFF, promote it to + # DEAL_II_WITH_${_feature} is defined and set to OFF, promote it to # cache nevertheless: # - SET_CACHED_OPTION(${feature} OFF) + SET_CACHED_OPTION(${_feature} OFF) ENDIF() - SET(FEATURE_${feature}_PROCESSED TRUE) + SET(FEATURE_${_feature}_PROCESSED TRUE) ENDMACRO()