include/anna/core/util/Environment.hpp

   1 // ANNA - Anna is Not 'N' Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_core_Environment_hpp
  38 #define anna_core_Environment_hpp
  39
  40 #include <string>
  41 #include <map>
  42
  43 #include <anna/core/RuntimeException.hpp>
  44 #include <anna/core/Singleton.hpp>
  45
  46
  47 namespace anna {
  48
  49 /**
  50   Environment variables reader
  51 */
  52 class Environment : public Singleton <Environment> {
  53 public:
  54
  55   /**
  56   * Destructor.
  57   */
  58   ~Environment() {;}
  59
  60   /**
  61     Parses the current environment data (all variables available)
  62   */
  63   void initialize() throw();
  64
  65   /**
  66     Return associated value (could be empty).
  67
  68     @param variableName Environment variable name.
  69     @param exceptionIfMissing When enabled, an exception is launched for missing variables. Empty string in other case (default behaviour).
  70
  71     @return Environment value.
  72   */
  73   std::string getValue(const char* variableName, bool exceptionIfMissing = false) const throw(RuntimeException);
  74
  75 private:
  76
  77   std::map < std::string /* variable name */, std::string /* variable value */ > a_managedVars;
  78
  79   Environment() { initialize();}
  80
  81   friend class Singleton <Environment>;
  82 };
  83
  84 }
  85
  86 #endif
  87