src/IniFile.hpp

   1 /*
   2     suPHP - (c)2002-2008 Sebastian Marsching <sebastian@marsching.com>
   3
   4     This file is part of suPHP.
   5
   6     suPHP is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     suPHP is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with suPHP; if not, write to the Free Software
  18     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19 */
  20
  21 #ifndef SUPHP_INIFILE_H
  22
  23 namespace suPHP {
  24     class IniFile;
  25 };
  26
  27 #define SUPHP_INIFILE_H
  28
  29 #include <string>
  30 #include <vector>
  31 #include <map>
  32
  33 #include "KeyNotFoundException.hpp"
  34 #include "ParsingException.hpp"
  35 #include "IOException.hpp"
  36 #include "IniSection.hpp"
  37
  38 namespace suPHP {
  39     /**
  40      * Class providing access to configuration in a INI file.
  41      */
  42     class IniFile {
  43     private:
  44         std::map<std::string, IniSection> sections;
  45
  46         std::string parseValue(const std::string& value) const throw (ParsingException);
  47
  48     public:
  49         /**
  50          * Reads values from INI file
  51          */
  52         void parse(const File& file) throw (IOException, ParsingException);
  53
  54         /**
  55          * Returns section
  56          */
  57         const IniSection& getSection(const std::string& name) const throw (KeyNotFoundException);
  58
  59         /**
  60          * Index operator
  61          */
  62         const IniSection& operator[](const std::string& name) const throw (KeyNotFoundException);
  63
  64         /**
  65          * Returns vector containing names of all sections
  66          */
  67         const std::vector<const std::string> getSections();
  68
  69         /**
  70          * Checks wheter a section is existing
  71          */
  72         bool hasSection(const std::string& name) const;
  73     };
  74 };
  75
  76 #endif // SUPHP_INIFILE_H