PreferenceHandler.h

Go to the documentation of this file.

/* -*- Mode: CC; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 5 -*- */

/*
 * The PreferenceHandler class provides an easy mechanism to store and 
 * retrieve key/value pairs of different types (bool, int, float and string).
 */

/*
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Created by Daniel Aarno on Mon Oct 13 2003.
Copyright (c) 2004 by Daniel Aarno - <macbishop@users.sf.net>
M. Sc. in Electrical Engineering - http://www.e.kth.se/~e98_aar

All Rights Reserved
ATTRIBUTION ASSURANCE LICENSE (adapted from the original BSD license)
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the conditions below are met.
These conditions require a modest attribution to  (the
"Author"), who hopes that its promotional value may help justify the
thousands of dollars in otherwise billable time invested in writing
this and other freely available, open-source software.

1. Redistributions of source code, in whole or part and with or without
modification (the "Code"), must prominently display this GPG-signed
text in verifiable form.
2. Redistributions of the Code in binary form must be accompanied by
this GPG-signed text in any documentation and, each time the resulting
executable program or a program dependent thereon is launched, a
prominent display (e.g., splash screen or banner text) of the Author's
attribution information, which includes:
(a) Name ("Daniel Aarno"),
(b) Professional identification ("M. Sc. in Electrical Engineering"), and
(c) URL ("http://www.e.kth.se/~e98_aar").
3. Neither the name nor any trademark of the Author may be used to
endorse or promote products derived from this software without specific
prior written permission.
4. Users are entirely responsible, to the exclusion of the Author and
any other persons, for compliance with (1) regulations set by owners or
administrators of employed equipment, (2) licensing terms of any other
software, and (3) local regulations regarding use, including those
regarding import, export, and use of encryption software.

THIS FREE SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
EVENT SHALL THE AUTHOR OR ANY CONTRIBUTOR BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
EFFECTS OF UNAUTHORIZED OR MALICIOUS NETWORK ACCESS;
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (GNU/Linux)

iD8DBQFB+7iBi6ECThHTSIkRAuH8AKC1JQmsD5L+fRFOW9qIciicWvbgigCeIREb
BnQOCM2kl3Is+rZ2Cz1iy1E=
=qw2o
-----END PGP SIGNATURE-----
*/

#ifndef _PREFERENCE_HANDLER_
#define _PREFERENCE_HANDLER_

#include <string>
#include <unistd.h>
#include <sys/types.h>
#include <errno.h>
#include <libxml/xmlmemory.h>
#include <libxml/parser.h>

enum {
     PREFERENCE_HANDLER_PARSE_ERROR = 1,
     PREFERENCE_HANDLER_NO_KEY_ERROR
};

class PreferenceHandler
{
 private:
     std::string path;
     xmlDocPtr doc;
     int error;
     bool modified;

     static PreferenceHandler* stdPH;
     
 public:
     PreferenceHandler(std::string path);

     ~PreferenceHandler();

     int getError() { return error; }

     bool boolForKey(const std::string &key);
     bool boolForKey(const char* key);

     float floatForKey(const std::string &key);
     float floatForKey(const char* key);

     int intForKey(const std::string &key);
     int intForKey(const char* key);

     std::string stringForKey(const std::string &key);
     std::string stringForKey(const char* key);

     void setBoolForKey(const bool b, const std::string &key);
     void setBoolForKey(const bool b, const char* key);
     
     void setFloatForKey(const float f, const std::string &key);
     void setFloatForKey(const float f, const char* key);
     
     void setIntForKey(const int i, const std::string &key);
     void setIntForKey(const int i, const char* key);
     
     void setStringForKey(const std::string &str, const std::string &key);
     void setStringForKey(const char* str, const char* key);

     bool synchronize();

     static void Init(std::string path);

     static void Clean();
     static PreferenceHandler* StandardPreferenceHandler();

     static void ExpandTildeInPath(std::string &path);

 private:
     xmlNodePtr getNodeForKey(const std::string &key);
     xmlNodePtr addNewKey(const std::string &key);
};

#endif //_PREFERENCE_HANDLER_

---