inifile.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2001-2005 The Regents of The University of Michigan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __INIFILE_HH__
#define __INIFILE_HH__
 
#include <fstream>
#include <functional>
#include <list>
#include <string>
#include <unordered_map>
#include <vector>
 
namespace gem5
{
 
class IniFile
{
  protected:
 
    class Entry
    {
        std::string     value;          
        mutable bool    referenced;     
 
      public:
        Entry(const std::string &v)
            : value(v), referenced(false)
        {
        }
 
        bool isReferenced() const { return referenced; }
 
        const std::string &getValue() const;
 
        void setValue(const std::string &v) { value = v; }
 
        void appendValue(const std::string &v) { value += " "; value += v; }
    };
 
    class Section
    {
        typedef std::unordered_map<std::string, Entry> EntryTable;
 
        EntryTable      table;          
        mutable bool    referenced;     
 
      public:
        Section()
            : table(), referenced(false)
        {
        }
 
        bool isReferenced() const { return referenced; }
 
        void addEntry(const std::string &entryName, const std::string &value,
                      bool append);
 
        bool add(const std::string &assignment);
 
        Entry *findEntry(const std::string &entryName);
        const Entry *findEntry(const std::string &entryName) const;
 
        bool printUnreferenced(const std::string &sectionName) const;
 
        void dump(const std::string &sectionName) const;
 
        EntryTable::const_iterator begin() const;
        EntryTable::const_iterator end() const;
    };
 
    typedef std::unordered_map<std::string, Section> SectionTable;
 
  protected:
    SectionTable table;
 
    Section *addSection(const std::string &sectionName);
 
    Section *findSection(const std::string &sectionName);
    const Section *findSection(const std::string &sectionName) const;
 
  public:
    IniFile();
 
    bool load(std::istream &f);
 
    bool load(const std::string &file);
 
    bool add(const std::string &s);
 
    bool find(const std::string &section, const std::string &entry,
              std::string &value) const;
 
    bool entryExists(const std::string &section,
                     const std::string &entry) const;
 
    bool sectionExists(const std::string &section) const;
 
    void getSectionNames(std::vector<std::string> &list) const;
 
    bool printUnreferenced() const;
 
    void dump();
 
    using VisitSectionCallback = std::function<void(
        const std::string&, const std::string&)>;
 
    void visitSection(const std::string &sectionName, VisitSectionCallback cb);
};
 
} // namespace gem5
 
#endif // __INIFILE_HH__