base/inifile.hh

   1 /*
   2  * Copyright (c) 2003 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef __INIFILE_HH__
  30 #define __INIFILE_HH__
  31
  32 #include <fstream>
  33 #include <list>
  34 #include <string>
  35 #include <vector>
  36
  37 #include "base/hashmap.hh"
  38
  39 class IniFile
  40 {
  41   protected:
  42     class Entry
  43     {
  44         std::string     value;
  45         mutable bool    referenced;
  46
  47       public:
  48         Entry(const std::string &v)
  49             : value(v), referenced(false)
  50         {
  51         }
  52
  53         bool isReferenced() { return referenced; }
  54
  55         const std::string &getValue() const;
  56
  57         void setValue(const std::string &v) { value = v; }
  58     };
  59
  60     class Section
  61     {
  62         typedef m5::hash_map<std::string, Entry *> EntryTable;
  63
  64         EntryTable      table;
  65         mutable bool    referenced;
  66
  67       public:
  68         Section()
  69             : table(), referenced(false)
  70         {
  71         }
  72
  73         bool isReferenced() { return referenced; }
  74
  75         void addEntry(const std::string &entryName, const std::string &value);
  76         Entry *findEntry(const std::string &entryName) const;
  77
  78         bool printUnreferenced(const std::string &sectionName);
  79         void dump(const std::string &sectionName);
  80     };
  81
  82     typedef m5::hash_map<std::string, Section *> ConfigTable;
  83
  84   protected:
  85     ConfigTable table;
  86
  87     Section *addSection(const std::string &sectionName);
  88     Section *findSection(const std::string &sectionName) const;
  89
  90     bool load(std::istream &f);
  91
  92   public:
  93     IniFile();
  94     ~IniFile();
  95
  96     bool loadCPP(const std::string &file, std::vector<char *> &cppFlags);
  97     bool load(const std::string &file);
  98
  99     bool add(const std::string &s);
 100
 101     bool find(const std::string &section, const std::string &entry,
 102               std::string &value) const;
 103     bool findDefault(const std::string &section, const std::string &entry,
 104                      std::string &value) const;
 105
 106     bool printUnreferenced();
 107
 108     void dump();
 109 };
 110
 111 #endif // __INIFILE_HH__