ini-file.h

Go to the documentation of this file.

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#ifndef COMMON_INI_FILE_H
#define COMMON_INI_FILE_H

#include "common/hash-str.h"
#include "common/list.h"
#include "common/str.h"

namespace Common {

class SeekableReadStream;
class WriteStream;

class INIFile {
public:
    struct KeyValue {
        String key;
        String value;
        String comment;
    };

    typedef List<KeyValue> SectionKeyList;

    struct Section {
        String name;
        List<KeyValue> keys;
        String comment;

        bool hasKey(const String &key) const;
        const KeyValue* getKey(const String &key) const;
        void setKey(const String &key, const String &value);
        void removeKey(const String &key);
        const SectionKeyList getKeys() const { return keys; }
    };

    typedef List<Section> SectionList;

public:
    INIFile();
    ~INIFile();

    // TODO: Maybe add a copy constructor etc.?

    static bool isValidName(const String &name);

    void    clear();

    bool    loadFromFile(const String &filename);
    bool    loadFromSaveFile(const String &filename);
    bool    loadFromStream(SeekableReadStream &stream);
    bool    saveToFile(const String &filename);
    bool    saveToSaveFile(const String &filename);
    bool    saveToStream(WriteStream &stream);

    bool    hasSection(const String &section) const;
    void    addSection(const String &section);
    void    removeSection(const String &section);
    void    renameSection(const String &oldName, const String &newName);

    bool    hasKey(const String &key, const String &section) const;
    bool    getKey(const String &key, const String &section, String &value) const;
    void    setKey(const String &key, const String &section, const String &value);
    void    removeKey(const String &key, const String &section);

    const SectionList getSections() const { return _sections; }
    const SectionKeyList getKeys(const String &section) const;

    void listKeyValues(StringMap &kv);

private:
    SectionList _sections;

    Section *getSection(const String &section);
    const Section *getSection(const String &section) const;
};

} // End of namespace Common

#endif