INIFile.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: INIFile.h,v 1.41.20.1 2007/08/09 17:11:53 amoll Exp $
//

#ifndef BALL_FORMAT_INIFILE_H
#define BALL_FORMAT_INIFILE_H

#ifndef BALL_DATATYPE_STRINGHASHMAP_H
# include <BALL/DATATYPE/stringHashMap.h>
#endif

#ifndef BALL_CONCEPT_PROCESSOR_H
# include <BALL/CONCEPT/processor.h>
#endif

namespace BALL 
{
  class INIFile;

  class BALL_EXPORT INIFile
  {
    public:

    enum
    {
      MAX_LINE_LENGTH = 1048576
    };

    class IteratorTraits_;
  
    class BALL_EXPORT Section
    {
      public:

      friend class INIFile;
      friend class IteratorTraits_;

      const String& getName() const
      {
        return name_;
      }

      bool operator == (const Section& section) const
      {
        return (name_    == section.name_   &&
                lines_   == section.lines_);
      }

      bool operator < (const Section& section) const
        ;

      bool operator > (const Section& section) const
        ;

      protected:

      // name of the section
      String                                  name_;

      // all lines of the section
      std::list<String>                           lines_;

      // hashmap with all keys
      StringHashMap<std::list<String>::iterator>    key_map_;
    };

    typedef std::list<Section>::iterator SectionIterator;

    typedef IteratorTraits_ LineIterator;

    static const String UNDEFINED;
    
    static const String HEADER;   
    

    INIFile();

    INIFile(const String& filename);

    virtual ~INIFile();

    void clear();



    bool read();

    bool write();

    const String& getFilename() const;

    void setFilename(const String& filename);



    bool isValid() const;



    LineIterator getLine(Size line_number);


    
    bool setLine(LineIterator line_it, const String& line);
    
    bool deleteLine(LineIterator line_it);
    
    bool insertLine(LineIterator line_it, const String& line);
    


    bool appendLine(const String& section_name, const String& line);

    bool appendLine(const String& line);

    Size getNumberOfLines() const;
        
    bool hasSection(const String& section_name) const;

    SectionIterator getSection(const String& section_name);

    SectionIterator getSection(Position pos);

    Size getNumberOfSections() const;

    LineIterator getSectionFirstLine(const String& section_name);

    LineIterator getSectionLastLine(const String& section_name);  

    Size getSectionLength(const String& section_name) const;

    bool deleteSection(const String& section);

    bool appendSection(const String& section);



    bool hasEntry(const String& section, const String& key) const;
    
    String getValue(const String& section, const String& key) const;

    bool setValue(const String& section, const String& key, const String& value);

    bool insertValue(const String& section, const String& key, const String& value);

    const INIFile& operator = (const INIFile& file)
      ;



    bool operator == (const INIFile& inifile) const;

    bool isValid(const LineIterator& it) const;

    bool isValid(const SectionIterator& it) const;


    bool apply(UnaryProcessor<LineIterator>& processor);

    void setDuplicateKeyCheck(bool mode);

    bool duplicateKeyCheckEnabled() const;

    std::list<String> getContent() const
      ;

    bool setContent(const std::list<String>& lines)
      ;

    protected:

    bool                              check_duplicate_keys_;

    bool                              valid_;

    String                            filename_;  

    // all sections, 0. section is HEADER
    std::list<Section>                      sections_;

    // hashmap with the section names  => index
    StringHashMap<SectionIterator>    section_index_;

    public:

    class BALL_EXPORT IteratorTraits_
    {
      friend class INIFile;

      public:

      BALL_CREATE(IteratorTraits_)

      
      IteratorTraits_();

      IteratorTraits_(const IteratorTraits_& traits);

      virtual ~IteratorTraits_();
      
      const IteratorTraits_& operator = (const IteratorTraits_ &traits);

      std::list<String>::iterator getPosition();

      SectionIterator getSection();
    
      const String& operator * () const;

      IteratorTraits_& operator ++ ();

      IteratorTraits_& operator -- ();

      IteratorTraits_& getSectionNextLine();

      bool operator == (const IteratorTraits_& traits) const;

      bool operator != (const IteratorTraits_& traits) const;
      
      bool operator + () const;

      bool isValid() const;

      void toSectionFirstLine();

      void toSectionLastLine();

      void toSectionEnd();

      bool isSectionFirstLine() const;

      bool isSectionLastLine() const;

      bool isSectionEnd() const;

      void toFirstLine();

      void toLastLine();

      void toEnd();

      protected:

      //_
      IteratorTraits_(std::list<Section>& list,
                      SectionIterator section, 
                      std::list<String>::iterator line);
      
      //_
      const std::list<Section>* getBound_() const;

      //_
      void setLine_(const String& line);

      private:

      std::list<Section>*         bound_;
      SectionIterator         section_;
      std::list<String>::iterator position_;
    };
  };
} // namespace BALL

#endif // BALL_FORMAT_INIFILE_H