src/core/config.h

   1 /***************************************************************************
   2  *                                                                         *
   3  *   Copyright (C) 2006 David Brodsky                                      *
   4  *                                                                         *
   5  *   This library is free software; you can redistribute it and/or         *
   6  *   modify it under the terms of the GNU Library General Public           *
   7  *   License as published by the Free Software Foundation and appearing    *
   8  *   in the file LICENSE.LGPL included in the packaging of this file.      *
   9  *                                                                         *
  10  *   This library is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      *
  13  *   Library General Public License for more details.                      *
  14  *                                                                         *
  15  ***************************************************************************/
  16
  17 #ifndef _tairon_core_config_h
  18 #define _tairon_core_config_h
  19
  20 #include <map>
  21
  22 #include "string.h"
  23
  24 namespace Tairon
  25 {
  26
  27 namespace Core
  28 {
  29
  30 /** \brief Class that holds configuration.
  31  *
  32  * It loads a configuration file with simple key-value based structure and then
  33  * provides loaded informations to the rest of the program. This class is a
  34  * singleton.
  35  */
  36 class Config
  37 {
  38         public:
  39                 /** Loads a configuration file. It is an XML file with "config" as the
  40                  * root element's name. Names of root's direct children are used as
  41                  * keys and their texts are treated as values.
  42                  *
  43                  * \param filename Path to the configuration file. If it is pure
  44                  * filename without any directory then it is searched in following
  45                  * paths: . (current directory), /etc, /usr/etc and /usr/local/etc.
  46                  */
  47                 Config(const String &filename);
  48
  49                 /** Standard destructor.
  50                  */
  51                 ~Config();
  52
  53                 /** Returns the key's value. Default value is returned when the key
  54                  * doesn't exist.
  55                  */
  56                 const String &operator[](const String &key);
  57
  58                 /** Returns pointer to the instance of this class.
  59                  */
  60                 static Config *self() {
  61                         return config;
  62                 };
  63
  64         private:
  65                 /** Loads the configuration file and stores data from it into the
  66                  * internal dictionary.
  67                  */
  68                 void loadConfigFile(const String &filename);
  69
  70                 /** Holds pointer to the instance of this class.
  71                  */
  72                 static Config *config;
  73
  74                 /** Dictionary holding configuration.
  75                  */
  76                 std::map<String, String> data;
  77 };
  78
  79 }; // namespace Core
  80
  81 }; // namespace Tairon
  82
  83 #endif
  84
  85 // vim: ai sw=4 ts=4 noet fdm=marker