SettingsManager.h

Go to the documentation of this file.

/***************************************************************************
 * Copyright (C) 2005 by Benjamin Hadorn (bhadorn@swissinfo.org)           *
 ***************************************************************************
 * Projekt : Zeus
 * Module  : SettingsManager
 * Package : System
 * Author  : Benjamin Hadorn
 * Datum   : $Date: 5.10.09 22:30 $
 * Ablage  : $File$
 * System  : Cell Computing Model
 ***************************************************************************
 * Licence:                                                                *
 *   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., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA  *
 ***************************************************************************/

/***************************************************************************
 Changes :
 $Log: /Development_F/StuderWIN/dev/Zeus/src/zeusbase/System/SettingsManager.h $
** 
** 12    5.10.09 22:30 Bha
** improving speed using inline methods
** 
** 11    27.03.09 15:11 Bha
** new version 1.0 implemented
** 
** 10    28.04.08 14:52 Mab
** Retval added to setUserXMLFile.
** 
** 9     26.10.07 8:05 bha
** Uint methods added
** New methods to read data from the property file
** 
** 8     19.10.07 11:03 bha
** get method for user data implemented to receive all key within a
** namespace
** 
** 7     1.10.07 13:05 Mabbuehl
** ReadBool und WriteBool hinzugefügt.
** 
** 6     3.09.07 7:04 bha
** New Framework using auto pointer and improved lists
** 
** 5     5.07.07 6:16 bha
** Getting user xml node
** 
** 4     21.06.07 12:33 bha
** New method implemented to receive all properties from a namespace
** 
** 3     18.06.07 7:33 bha
** Implementation of observer notification
** 
** 2     11.06.07 10:29 bha
** Anpassungen an Zeus-Framework 0.4.2
***************************************************************************/
//---------------------------------------------------------------------------

#ifndef SettingsManagerH
#define SettingsManagerH
//---------------------------------------------------------------------------

#include <zeusbase/System/ZObject.h>
#include <zeusbase/System/SingleLinkedList.hpp>
#include <zeusbase/System/Interfaces/ISettingsManager.hpp>

//VC++ needs spam to be happy
#if defined(_MSC_VER)
  #include <zeusbase/System/XMLFile.h>
  #include <zeusbase/System/Interfaces/IXMLDocument.hpp>
  #include <zeusbase/System/Interfaces/IXMLNode.hpp>
#endif

#define SettingsManager  TSettingsManager::getInstance()
#define UserData  getUserData()

BEGIN_NAMESPACE_Zeus

#ifndef _MSC_VER
  class TXMLFile;
  class IXMLDocument;
  class IXMLNode;
  class INotifyObserver;
#endif

class TCriticalSection;

/******************************************************************************/
/******************************************************************************/
zeusbase_class TSettingsManager : public TZObject, public ISettingsManager
{
  public:
    /***********************************************************************/
    /***********************************************************************/
    zeusbase_class TUserData : public TZObject
    {
      public:
        TUserData();
        virtual ~TUserData();

        Retval commit();
        void getPropertyNamesByNameSpace(const IString& rNameSpace, IStringList& rList) const ;
        void getPropertyNamesByNameSpace(const wchar_t* pNameSpace, IStringList& rList) const ;

        Retval readBool(const IString& rKey, bool& rValue, bool bDefault = false);
        Retval readInt(const IString& rKey, Int& rValue, Int iDefault = 0);
        Retval readUint(const IString& rKey, Uint& rValue, Uint uiDefault = 0);
        Retval readFloat(const IString& rKey, Float& rValue, Float fDefault = 0.0);
        Retval readString(const IString& rKey, IString& rValue, TString strDefault=L"");
        inline Retval readBool(const wchar_t* pKey, bool& rValue, bool bDefault = false)       { return readBool(TString(pKey), rValue, bDefault); }
        inline Retval readInt(const wchar_t* pKey, Int& rValue, Int iDefault = 0)              { return readInt(TString(pKey), rValue, iDefault); }
        inline Retval readUint(const wchar_t* pKey, Uint& rValue, Uint uiDefault = 0)          { return readUint(TString(pKey), rValue, uiDefault); }
        inline Retval readFloat(const wchar_t* pKey, Float& rValue, Float fDefault = 0.0)      { return readFloat(TString(pKey), rValue, fDefault); }
        inline Retval readString(const wchar_t* pKey, IString& rValue, TString strDefault=L"") { return readString(TString(pKey), rValue, strDefault); }

        Retval writeBool(const IString& rKey, bool bValue);
        Retval writeInt(const IString& rKey, Int iValue);
        Retval writeUint(const IString& rKey, Uint uiValue);
        Retval writeFloat(const IString& rKey, Float fValue);
        Retval writeString(const IString& rKey, const IString& rValue);
        inline Retval writeBool(const wchar_t* pKey, bool bValue)             { return writeBool(TString(pKey), bValue); }
        inline Retval writeInt(const wchar_t* pKey, Int iValue)               { return writeInt(TString(pKey), iValue); }
        inline Retval writeUint(const wchar_t* pKey, Uint uiValue)            { return writeUint(TString(pKey), uiValue); }
        inline Retval writeFloat(const wchar_t* pKey, Float fValue)           { return writeFloat(TString(pKey), fValue); }
        inline Retval writeString(const wchar_t* pKey, const IString& rValue) { return writeString(TString(pKey), rValue); }

        Retval getUserDataNode(const IString& rName, IXMLNode*& rpNode);


        void setDocument(NAMESPACE_Zeus::IXMLDocument& rDocument);
        void releaseDocument();

      private:
        TAutoPtr<NAMESPACE_Zeus::IXMLDocument> m_ptrDocument;
        TAutoPtr<IXMLNode> m_ptrMainNode;
        TCriticalSection& m_rLock;

    };


    static TSettingsManager& getInstance();

    TUserData& getUserData();
    void setPropertyInterface(IPropertyAccess& rIface);
    Retval setUserXMLFile(const IString& rFileName);
    Retval setUserXMLFile(TXMLFile& rFile);
    void releaseSourceInterfaces();
    void releasePropertyInterfaces();
    void releaseUserXMLFile();

    void releaseDelegationInterface();
    void setDelegationInterface(ISettingsManager& rIface);
    TString completePathProperty(const TString& strPropName, const TString& strBasePath, bool bCreate = false);

    //read methods for property file
    Retval readBoolProperty(const IString& rKey, bool& rValue, bool bDefault = false);
    Retval readIntProperty(const IString& rKey, Int& rValue, Int iDefault = 0);
    Retval readUintProperty(const IString& rKey, Uint& rValue, Uint uiDefault = 0);
    Retval readFloatProperty(const IString& rKey, Float& rValue, Float fDefault = 0.0);
    Retval readStringProperty(const IString& rKey, IString& rValue, TString strDefault=L"");
    inline Retval readBoolProperty(const wchar_t* pKey, bool& rValue, bool bDefault = false)       { return readBoolProperty(TString(pKey), rValue, bDefault); }
    inline Retval readIntProperty(const wchar_t* pKey, Int& rValue, Int iDefault = 0)              { return readIntProperty(TString(pKey), rValue, iDefault); }
    inline Retval readUintProperty(const wchar_t* pKey, Uint& rValue, Uint uiDefault = 0)          { return readUintProperty(TString(pKey), rValue, uiDefault); }
    inline Retval readFloatProperty(const wchar_t* pKey, Float& rValue, Float fDefault = 0.0)      { return readFloatProperty(TString(pKey), rValue, fDefault); }
    inline Retval readStringProperty(const wchar_t* pKey, IString& rValue, TString strDefault=L"") { return readStringProperty(TString(pKey), rValue, strDefault); }

    Retval writeBoolProperty(const IString& rKey, bool bValue);
    Retval writeIntProperty(const IString& rKey, Int iValue);
    Retval writeUintProperty(const IString& rKey, Uint uiValue);
    Retval writeFloatProperty(const IString& rKey, Float fValue);
    Retval writeStringProperty(const IString& rKey, const IString& rValue);
    inline Retval writeBoolProperty(const wchar_t* pKey, bool bValue)             { return writeBoolProperty(TString(pKey), bValue); }
    inline Retval writeIntProperty(const wchar_t* pKey, Int iValue)               { return writeIntProperty(TString(pKey), iValue); }
    inline Retval writeUintProperty(const wchar_t* pKey, Uint uiValue)            { return writeUintProperty(TString(pKey), uiValue); }
    inline Retval writeFloatProperty(const wchar_t* pKey, Float fValue)           { return writeFloatProperty(TString(pKey), fValue); }
    inline Retval writeStringProperty(const wchar_t* pKey, const IString& rValue) { return writeStringProperty(TString(pKey), rValue); }


    //Methods of ISettingsManager
    virtual Retval MQUALIFIER getUserDocument(NAMESPACE_Zeus::IXMLDocument*& rpDocument) const;
    virtual void MQUALIFIER notifyObservers();
    virtual void MQUALIFIER attach(INotifyObserver& rObserver);
    virtual void MQUALIFIER detach(INotifyObserver& rObserver);

    //Methods of IPropertyAccess
    virtual Retval MQUALIFIER addProperty(const IString& rName, const IString& rValue);
    virtual bool MQUALIFIER existsProperty(const IString& rName)const ;
    virtual void MQUALIFIER getPropertyNames(IStringList& rList)const ;
    virtual void MQUALIFIER getPropertyNamesByNameSpace(const IString& rNameSpace, IStringList& rList) const ;
    virtual Retval MQUALIFIER getPropertyValue(const IString& rName, IString& rValue)const ;
    virtual Retval MQUALIFIER setPropertyValue(const IString& rName, const IString& rValue);
    virtual Retval MQUALIFIER getPropertyPathValue(const IString& rName, IString& rValue)const;
    virtual Retval MQUALIFIER getPropertyFileValue(const IString& rName, IString& rValue)const;

    //Methods of IZUnknown
    MEMORY_MANAGER_DECL

  private:

    static TAutoPtr<TSettingsManager> m_ptrInstance;
    TAutoPtr<ISettingsManager> m_ptrDelegation;
    TAutoPtr<IPropertyAccess> m_ptrSourceInterface;
    TAutoPtr<TXMLFile> m_ptrUserFile;
    TUserData m_UserData;
    TSingleLinkedList<INotifyObserver*> m_lstObservers;
    TCriticalSection& m_rLock;

    //Compiler problem on older version from microsoft
    #ifdef _MSC_VER
      public:
    #endif

    TSettingsManager();
    virtual ~TSettingsManager();
};

//INLINE METHODS
/******************************************************************************/
/******************************************************************************/
inline /*static*/ TSettingsManager& TSettingsManager::getInstance()
{
  return *m_ptrInstance;
}

/*****************************************************************************/
/*****************************************************************************/
inline TSettingsManager::TUserData& TSettingsManager::getUserData()
{
  return m_UserData;
}

/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::readBoolProperty(const IString& rKey, bool& rValue, bool bDefault /*= false*/)
{
  Int iValue = 0;
  Retval retValue = readIntProperty(rKey, iValue, bDefault);
  rValue = (iValue == 0 ? false : true);
  return retValue;
}

/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::readIntProperty(const IString& rKey, Int& rValue, Int iDefault /*= 0*/)
{
  TString strValue;
  Retval retValue = readStringProperty(rKey, strValue, TString(iDefault));
  rValue = strValue.toInt();
  return retValue;
}

/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::readUintProperty(const IString& rKey, Uint& rValue, Uint uiDefault /*= 0*/)
{
  TString strValue;
  Retval retValue = readStringProperty(rKey, strValue, TString(uiDefault));
  rValue = strValue.toUint();
  return retValue;
}

/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::readFloatProperty(const IString& rKey, Float& rValue, Float fDefault /*= 0*/)
{
  TString strValue;
  Retval retValue = readStringProperty(rKey, strValue, TString(fDefault));
  rValue = strValue.toFloat();
  return retValue;
}

/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::writeBoolProperty(const IString& rKey, bool bValue)
{
  return writeIntProperty(rKey, bValue ? 1 : 0);
}

/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::writeIntProperty(const IString& rKey, Int iValue)
{
  return setPropertyValue(rKey, TString(iValue));
}

/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::writeUintProperty(const IString& rKey, Uint uiValue)
{
  return setPropertyValue(rKey, TString(uiValue));
}

/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::writeFloatProperty(const IString& rKey, Float fValue)
{
  return setPropertyValue(rKey, TString(fValue));
}

/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::writeStringProperty(const IString& rKey, const IString& rValue)
{
  return setPropertyValue(rKey, rValue);
}

//##########################################################################
//                                USER DATA
/**************************************************************************/
/**************************************************************************/
inline void TSettingsManager::TUserData::getPropertyNamesByNameSpace(const wchar_t* pNameSpace, IStringList& rList) const
{
  getPropertyNamesByNameSpace(TString(pNameSpace), rList);
}

/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::TUserData::readBool(const IString& rKey, bool& rValue,
                                                    bool bDefault /* = false */)
{
  Int iValue = 0;
  Retval retValue = readInt(rKey, iValue, bDefault);
  rValue = (iValue == 0 ? false : true);
  return retValue;
}

/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::TUserData::readInt(const IString& rKey, Int& rValue, Int iDefault /*= 0*/)
{
  TString strValue;
  Retval retValue = readString(rKey, strValue, TString(iDefault));
  rValue = strValue.toInt();
  return retValue;
}

/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::TUserData::readUint(const IString& rKey, Uint& rValue, Uint uiDefault /*= 0*/)
{
  TString strValue;
  Retval retValue = readString(rKey, strValue, TString(uiDefault));
  rValue = strValue.toUint();
  return retValue;
}


/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::TUserData::readFloat(const IString& rKey, Float& rValue, Float fDefault /*= 0.0*/)
{
  TString strValue;
  Retval retValue = readString(rKey, strValue, TString(fDefault));
  rValue = strValue.toFloat();
  return retValue;
}

/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::TUserData::writeBool(const IString& rKey, bool bValue)
{
  return writeInt(rKey, bValue ? 1 : 0);
}

/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::TUserData::writeInt(const IString& rKey, Int iValue)
{
  return writeString(rKey, TString(iValue));
}

/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::TUserData::writeUint(const IString& rKey, Uint uiValue)
{
  return writeString(rKey, TString(uiValue));
}


/**************************************************************************/
/**************************************************************************/
inline Retval TSettingsManager::TUserData::writeFloat(const IString& rKey, Float fValue)
{
  return writeString(rKey, TString(fValue));
}


END_NAMESPACE_Zeus

#endif

---

Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Wed Oct 28 21:42:30 2009