swconfig.h

Go to the documentation of this file.

/******************************************************************************
 *
 * swconfig.h -     class SWConfig: used for saving and
 *          retrieval of configuration information
 *
 * $Id: swconfig.h 3786 2020-08-30 11:35:14Z scribe $
 *
 * Copyright 1997-2013 CrossWire Bible Society (http://www.crosswire.org)
 *  CrossWire Bible Society
 *  P. O. Box 2528
 *  Tempe, AZ  85280-2528
 *
 * 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 version 2.
 *
 * 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.
 *
 */

#ifndef SWCONFIG_H
#define SWCONFIG_H

#include <map>

#include <defs.h>
#include <multimapwdef.h>
#include <swbuf.h>

SWORD_NAMESPACE_START

typedef multimapwithdefault < SWBuf, SWBuf, std::less < SWBuf > >ConfigEntMap;
typedef std::map < SWBuf, ConfigEntMap, std::less < SWBuf > >SectionMap;

class SWDLLEXPORT SWConfig {
public:
    SWConfig(const char *fileName);
    SWConfig();
    virtual ~SWConfig();

    virtual SectionMap &getSections();
    const SectionMap &getSections() const { return const_cast<SWConfig *>(this)->getSections(); }

    virtual void load();

    virtual void save() const;

    virtual void augment(const SWConfig &addFrom);

    ConfigEntMap &getSection(const char *section) { return getSections()[section]; }


    ConfigEntMap &operator [](const char *section) { return getSection(section); }

    SWConfig &operator +=(const SWConfig &addFrom) { augment(addFrom); return *this; }

    SWBuf getValue(const char *section, const char *key) {
        return (*this)[section][key];
    }

    void setValue(const char *section, const char *key, const char *value) {
        (*this)[section][key] = value;
    }

    SWBuf getFileName() const;


    // ****** Deprecated methods for removal in 2.0

    SWDEPRECATED SectionMap Sections;

    SWDEPRECATED SWBuf filename;

    SWDEPRECATED void Load() { load(); }

    SWDEPRECATED void Save() { save(); }

};
SWORD_NAMESPACE_END
#endif