FXSettings.h

Go to the documentation of this file.

/********************************************************************************
*                                                                               *
*                           S e t t i n g s   C l a s s                         *
*                                                                               *
*********************************************************************************
* Copyright (C) 1998,2006 by Jeroen van der Zijp.   All Rights Reserved.        *
*********************************************************************************
* This library is free software; you can redistribute it and/or                 *
* modify it under the terms of the GNU Lesser General Public                    *
* License as published by the Free Software Foundation; either                  *
* version 2.1 of the License, or (at your option) any later version.            *
*                                                                               *
* This library 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             *
* Lesser General Public License for more details.                               *
*                                                                               *
* You should have received a copy of the GNU Lesser General Public              *
* License along with this library; if not, write to the Free Software           *
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.    *
*********************************************************************************
* $Id: FXSettings.h,v 1.33 2006/01/22 17:58:09 fox Exp $                        *
********************************************************************************/
#ifndef FXSETTINGS_H
#define FXSETTINGS_H

#ifndef FXDICT_H
#include "FXDict.h"
#endif

namespace FX {


class FXStringDict;


class FXAPI FXSettings : public FXDict {
  FXDECLARE(FXSettings)
protected:
  bool modified;
protected:
  virtual void *createData(const void*);
  virtual void deleteData(void*);
  FXchar* dequote(FXchar* text) const;
  FXchar* enquote(FXchar* result,const FXchar* text);
  FXStringDict* insert(const FXchar* ky){ return (FXStringDict*)FXDict::insert(ky,NULL); }
  FXStringDict* replace(const FXchar* ky,FXStringDict* section){ return (FXStringDict*)FXDict::replace(ky,section,true); }
  FXStringDict* remove(const FXchar* ky){ return (FXStringDict*)FXDict::remove(ky); }
public:

  FXSettings();

  FXSettings(const FXSettings& orig);

  FXSettings &operator=(const FXSettings& orig);

  bool parseFile(const FXString& filename,bool mark);

  bool unparseFile(const FXString& filename);

  FXStringDict* data(FXuint pos) const { return (FXStringDict*)FXDict::data(pos); }

  FXStringDict* find(const FXchar *section) const { return (FXStringDict*)FXDict::find(section); }

  FXint readFormatEntry(const FXchar *section,const FXchar *key,const FXchar *fmt,...) FX_SCANF(4,5) ;

  const FXchar *readStringEntry(const FXchar *section,const FXchar *key,const FXchar *def=NULL);

  FXint readIntEntry(const FXchar *section,const FXchar *key,FXint def=0);

  FXuint readUnsignedEntry(const FXchar *section,const FXchar *key,FXuint def=0);

  FXdouble readRealEntry(const FXchar *section,const FXchar *key,FXdouble def=0.0);

  FXColor readColorEntry(const FXchar *section,const FXchar *key,FXColor def=0);

  FXbool readBoolEntry(const FXchar *section,const FXchar *key,FXbool def=FALSE);

  FXint writeFormatEntry(const FXchar *section,const FXchar *key,const FXchar *fmt,...) FX_PRINTF(4,5) ;

  bool writeStringEntry(const FXchar *section,const FXchar *key,const FXchar *val);

  bool writeIntEntry(const FXchar *section,const FXchar *key,FXint val);

  bool writeUnsignedEntry(const FXchar *section,const FXchar *key,FXuint val);

  bool writeRealEntry(const FXchar *section,const FXchar *key,FXdouble val);

  bool writeColorEntry(const FXchar *section,const FXchar *key,FXColor val);

  bool writeBoolEntry(const FXchar *section,const FXchar *key,FXbool val);

  bool deleteEntry(const FXchar *section,const FXchar *key);

  bool existingEntry(const FXchar *section,const FXchar *key);

  bool deleteSection(const FXchar *section);

  bool existingSection(const FXchar *section);

  bool clear();

  void setModified(bool mdfy=true){ modified=mdfy; }

  bool isModified() const { return modified; }

  virtual ~FXSettings();
  };


namespace FXSettingsHelpers
{
    template<typename type> inline void rwSetting(bool save, FXSettings &settings, const FXchar *section, const FXchar *name, type &val, const type &defval);
    template<> inline void rwSetting<bool>(bool save, FXSettings &settings, const FXchar *section, const FXchar *name, bool &val, const bool &defval)
    {
        save ? settings.writeIntEntry(section, name, val)
            : (val=(0!=settings.readIntEntry(section, name, defval)));
    }
    template<> inline void rwSetting<FXint>(bool save, FXSettings &settings, const FXchar *section, const FXchar *name, FXint &val, const FXint &defval)
    {
        save ? settings.writeIntEntry(section, name, val)
            : (val=settings.readIntEntry(section, name, defval));
    }
    template<> inline void rwSetting<FXuint>(bool save, FXSettings &settings, const FXchar *section, const FXchar *name, FXuint &val, const FXuint &defval)
    {
        save ? settings.writeUnsignedEntry(section, name, val)
            : (val=settings.readUnsignedEntry(section, name, defval));
    }
    /* GCC won't accept that FXColor is different to a FXuint :(
    template<> inline void rwSetting<FXColor(bool save, FXSettings &settings, const FXchar *section, const FXchar *name, FXColor &val, const FXColor &defval)
    {
        save ? settings.writeColorEntry(section, name, val)
            : (val=settings.readColorEntry(section, name, defval));
    }*/
    template<> inline void rwSetting<double>(bool save, FXSettings &settings, const FXchar *section, const FXchar *name, double &val, const double &defval)
    {
        save ? settings.writeRealEntry(section, name, val)
            : (val=settings.readRealEntry(section, name, defval));
    }
    template<> inline void rwSetting<FXString>(bool save, FXSettings &settings, const FXchar *section, const FXchar *name, FXString &val, const FXString &defval)
    {
        save ? settings.writeStringEntry(section, name, val.text())
            : (val=settings.readStringEntry(section, name, defval.text()), true);
    }
    // Ambiguity buster
    template<typename type> inline void rwSetting(bool save, FXSettings &settings, const FXchar *section, const FXchar *name, type &val, int defval)
    {
        rwSetting<type>(save, settings, section, name, val, (type) defval);
    }
}

}

#endif

---

(C) 2002-2009 Niall Douglas. Some parts (C) to assorted authors.