Changeset 5945 in orxonox.OLD for trunk/src/lib/parser/ini_parser/ini_parser.h

Timestamp:

Dec 6, 2005, 11:39:05 PM (18 years ago)

Author:

bensch

Message:

orxonox/trunk: small rearangements

File:

• trunk/src/lib/parser/ini_parser/ini_parser.h (modified) (3 diffs)

trunk/src/lib/parser/ini_parser/ini_parser.h

@@ -27 +27 @@
     struct IniEntry
     {
-      char*              name;     //!< name of a given Entry
-      char*              value;    //!< value of a given Entry
+      char*               comment;  //!< A Comment that is appendet to the Top of this Entry.
+      char*               name;     //!< name of a given Entry
+      char*               value;    //!< value of a given Entry
     };
+
     //! a struct for Sections in the Parser's file
     struct IniSection
     {
-      char*               name;    //!< name of a given section
-      std::list<IniEntry> entries; //!< a list of entries for this section
+      char*               comment;  //!< A Comment that is appendet to the Top of this Section.
+      char*               name;     //!< name of a given section
+      std::list<IniEntry> entries;  //!< a list of entries for this section
     };
     ////////////////////////////////////
@@ -42 +45 @@
     ~IniParser ();
 
+    /** @returns true if the file is opened, false otherwise*/
+    bool isOpen() const { return (this->fileName != NULL)? true : false; };
+    /** @returns the fileName we have opened. */
+    const char* getFileName() const { return this->fileName; };
+
     bool readFile(const char* fileName);
     bool writeFile(const char* fileName) const;
 
+    void setFileComment(const char* fileComment);
+    const char* getFileComment() const { return this->comment; };
+
     bool addSection(const char* sectionName);
     bool getSection(const char* sectionName);
+    void setSectionComment(const char* comment, const char* sectionName);
+    const char* getSectionComment(const char* sectionNane) const;
 
-    /** @returns true if the file is opened, false otherwise*/
-    bool isOpen() const { return (this->fileName != NULL)? true : false; };
-
+    // iterate through sections with these Functions
     void firstSection();
     const char* nextSection();
 
-    /** @returns the fileName we have opened. */
-    const char* getFileName() const { return this->fileName; };
 
     bool addVar(const char* entryName, const char* value, const char* sectionName = NULL);
     const char* getVar(const char* entryName, const char* sectionName, const char* defaultValue = "") const;
+    const char* setEntryComment(const char* comment, const char* entryName, const char* sectionName);
+    const char* getEntryComment(const char* entryName, const char* sectionName) const;
 
+    // iterate Through Variables with these Functions.
     void firstVar();
     bool nextVar();
 
+
+    // retrieving functions when iterating.
     const char* getCurrentSection() const;
     const char* getCurrentName() const;
     const char* getCurrentValue() const;
 
+
+    // maintenance.
     void debug() const;
 
@@ -74 +90 @@
     void setFileName(const char* fileName);
 
+    std::list<IniSection>::const_iterator getSectionIT(const char* sectionName) const;
+    std::list<IniEntry>::const_iterator getEntryIT(const char* entryName, const char* sectionName = NULL) const;
+
   private:
     char*                            fileName;        //!< The name of the File that was parsed.
+    char*                            comment;         //!< A Comment for the header of this File.
     std::list<IniSection>            sections;        //!< a list of all stored Sections of the Parser
     std::list<IniSection>::iterator  currentSection;  //!< the current selected Section
     std::list<IniEntry>::iterator    currentEntry;    //!< the current selected entry (in currentSection)
+
+    std::list<char*>                 commentList;     //!< A list of Comments. (this is for temporary saving of Comments, that are inserted in front of Sections/Entries.)
 };