ConfigVal.H

Go to the documentation of this file.

//========================================================================
// MinVR
// Platform:    Any
// API version: 1.0
//------------------------------------------------------------------------
// The MIT License (MIT)
//
// Copyright (c) 2013 Regents of the University of Minnesota
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//========================================================================

#ifndef CONFIGVAL_H
#define CONFIGVAL_H

#include <iostream>
#include <sstream>
#include "MVRCore/ConfigMap.H"

#define BOOST_ASSERT_MSG_OSTREAM std::cout
#include <boost/assert.hpp>

namespace MinVR {

class ConfigValMap
{
public:
        static ConfigMapRef map;
};



template <class T>
static inline bool retypeVal(const std::string &str, T &val) {
        std::istringstream is(str.c_str());
        is >> val;
        if (!is) return false;
        else return true;
}


static inline void notFoundWarning(const std::string &keyString) {
        std::cout << "No ConfigVal mapping found for \"" << keyString << "\"." << std::endl;
}


template <class KEYTYPE, class VALTYPE>
VALTYPE ConfigVal(KEYTYPE keyString, const VALTYPE &defaultVal, bool warn=true) {
        BOOST_ASSERT_MSG(ConfigValMap::map.notNull(), "The global config map is NULL!");
        if (!ConfigValMap::map->containsKey(keyString)) {
                if (warn) {
                        notFoundWarning(keyString);
                }
                return defaultVal;
        }
        else {
                std::string valString = ConfigValMap::map->getValue(keyString);
                //std::cout << "valString = " << valString << std::endl;
                VALTYPE val;
                bool ok = retypeVal(valString, val);
                if (!ok) {
                        std::string errString = string("ERROR: ConfigVal is unable to retype value.\n\tKey:\t'") 
                                + keyString + string("'\n\tValue:\t'") + valString + string("'\n");
                        std::cout << errString;
                }
                return val;
        }
}


// Override the template above for the case of a quoted string passed in as the 
// default value for the ConfigVal function call.  The quoted string takes on
// different types depending on the compiler (hence the #ifdef's below.)

#if (defined(__SUNPRO_CC) && __SUNPRO_CC >= 0x500) || \
(defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 95)))
#define QUOTED_STRING const char *
#else
#define QUOTED_STRING char *
#endif

inline std::string ConfigVal(QUOTED_STRING keyString, QUOTED_STRING defaultVal, bool warn=true) {
        BOOST_ASSERT_MSG(ConfigValMap::map != nullptr, "The global config map is NULL!");
        if (ConfigValMap::map->containsKey(keyString))
                return replaceEnvVars(ConfigValMap::map->getValue(keyString));
        else {
                if (warn) notFoundWarning(keyString);
                return replaceEnvVars(std::string(defaultVal));
        }
}

inline std::string ConfigVal(QUOTED_STRING keyString, std::string defaultVal, bool warn=true) {
        BOOST_ASSERT_MSG(ConfigValMap::map != nullptr , "The global config map is NULL!");
        if (ConfigValMap::map->containsKey(keyString))
                return replaceEnvVars(ConfigValMap::map->getValue(keyString));
        else {
                if (warn) notFoundWarning(keyString);
                return replaceEnvVars(defaultVal);
        }
}

inline std::string ConfigVal(std::string keyString, QUOTED_STRING defaultVal, bool warn=true) {
        BOOST_ASSERT_MSG(ConfigValMap::map != nullptr, "The global config map is NULL!");
        if (ConfigValMap::map->containsKey(keyString))
                return replaceEnvVars(ConfigValMap::map->getValue(keyString));
        else {
                if (warn) notFoundWarning(keyString);
                return replaceEnvVars(std::string(defaultVal));
        }
}

inline std::string ConfigVal(std::string keyString, std::string defaultVal, bool warn=true) {
        BOOST_ASSERT_MSG(ConfigValMap::map != nullptr, "The global config map is NULL!");
        if (ConfigValMap::map->containsKey(keyString))
                return replaceEnvVars(ConfigValMap::map->getValue(keyString));
        else {
                if (warn) notFoundWarning(keyString);
                return replaceEnvVars(defaultVal);
        }
}


} // end namespace


#endif