Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/branches/network/src/lib/util/ini_parser.h @ 5875

Last change on this file since 5875 was 5405, checked in by bensch, 19 years ago

orxonox/trunk: renamed definition to the right term declaration…

File size: 2.9 KB
Line 
1/*!
2 * @file ini_parser.h
3 * A small ini file parser
4 *
5 * Can be used to find a defined [Section] in an ini file and get the VarName = Value entries
6 */
7
8#ifndef _INI_PARSER_H
9#define _INI_PARSER_H
10
11#define PARSELINELENGHT     512       //!< how many chars to read at once
12#ifndef NULL
13#define NULL 0x0                      //!< NULL
14#endif
15
16// FORWARD DECLARATION //
17template<class T> class tList;
18
19//! ini-file parser
20/**
21 * This class can be used to load an initializer file and parse it's contents for variablename=value pairs.
22 */
23class IniParser
24{
25  private:
26    ////////////////////////////////////
27    //! a struct for Entries in the Parser's File's Sections
28    struct IniEntry
29    {
30      char*              name;     //!< name of a given Entry
31      char*              value;    //!< value of a given Entry
32    };
33    //! a struct for Sections in the Parser's file
34    struct IniSection
35    {
36      char*               name;    //!< name of a given section
37      tList<IniEntry>*    entries; //!< a list of entries for this section
38    };
39    ////////////////////////////////////
40
41  public:
42    IniParser (const char* filename = NULL);
43    ~IniParser ();
44
45    bool readFile(const char* fileName);
46    bool writeFile(const char* fileName);
47
48    bool addSection(const char* sectionName);
49    bool getSection(const char* sectionName);
50
51    void getFirstSection();
52    const char* nextSection();
53
54    /** @returns true if the file is opened, false otherwise*/
55    bool isOpen() const { return (sections != NULL)?true:false; };
56    /** @returns the fileName we have opened. */
57    const char* getFileName() const { return this->fileName; };
58
59    bool addVar(const char* entryName, const char* value, const char* sectionName = NULL);
60    const char* getVar(const char* entryName, const char* sectionName, const char* defaultValue = "") const;
61
62    void getFirstVar();
63    bool nextVar();
64
65    /** @returns the name of the Current selected Section */
66    const char* getCurrentSection() const { return (this->currentSection!=NULL)?this->currentSection->name:NULL; };
67    /** @returns the current entries Name, or NULL if we havn't selected a Entry */
68    const char* getCurrentName() const { return (this->currentEntry!=NULL)?this->currentEntry->name:NULL; };
69    /** @returns the current entries Value, or NULL if we havn't selected a Entry */
70    const char* getCurrentValue() const { return (this->currentEntry!=NULL)?this->currentEntry->value:NULL; };
71
72    void debug() const;
73
74  private:
75    void deleteSections();
76    void setFileName(const char* fileName);
77
78  private:
79    char*                 fileName;        //!< The name of the File that was parsed.
80    tList<IniSection>*    sections;        //!< a list of all stored Sections of the Parser
81    IniSection*           currentSection;  //!< the current selected Section
82    IniEntry*             currentEntry;    //!< the current selected entry (in currentSection)
83};
84
85#endif /* _INI_PARSER_H */
Note: See TracBrowser for help on using the repository browser.