pref.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:11k
源码类别:

Symbian

开发平台:

C/C++

  1. /* ***** BEGIN LICENSE BLOCK ***** 
  2.  * Version: RCSL 1.0/RPSL 1.0 
  3.  *  
  4.  * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. 
  5.  *      
  6.  * The contents of this file, and the files included with this file, are 
  7.  * subject to the current version of the RealNetworks Public Source License 
  8.  * Version 1.0 (the "RPSL") available at 
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed 
  10.  * the file under the RealNetworks Community Source License Version 1.0 
  11.  * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, 
  12.  * in which case the RCSL will apply. You may also obtain the license terms 
  13.  * directly from RealNetworks.  You may not use this file except in 
  14.  * compliance with the RPSL or, if you have a valid RCSL with RealNetworks 
  15.  * applicable to this file, the RCSL.  Please see the applicable RPSL or 
  16.  * RCSL for the rights, obligations and limitations governing use of the 
  17.  * contents of the file.  
  18.  *  
  19.  * This file is part of the Helix DNA Technology. RealNetworks is the 
  20.  * developer of the Original Code and owns the copyrights in the portions 
  21.  * it created. 
  22.  *  
  23.  * This file, and the files included with this file, is distributed and made 
  24.  * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
  25.  * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
  26.  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS 
  27.  * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
  28.  * 
  29.  * Technology Compatibility Kit Test Suite(s) Location: 
  30.  *    http://www.helixcommunity.org/content/tck 
  31.  * 
  32.  * Contributor(s): 
  33.  *  
  34.  * ***** END LICENSE BLOCK ***** */ 
  35. #ifdef _MACINTOSH
  36. #pragma once
  37. #endif
  38. #ifndef _PREF
  39. #define  _PREF
  40. #include "hxtypes.h"
  41. #include "hxresult.h"
  42. #include "hxassert.h"
  43. struct IHXBuffer;
  44. typedef struct _HXxRect     HXxRect;
  45. typedef struct _HXxSize     HXxSize;
  46. typedef struct _HXxPoint    HXxPoint;
  47. typedef ULONG32     HXxColor;
  48. class CHXBuffer;
  49. class CPref;
  50. typedef _INTERFACE IHXPreferences IHXPreferences;
  51. #define MAX_PREF_NAME       256
  52. #define MAX_PREF_SIZE       1024
  53. #define MAX_INT_BUFFER       20
  54. #define MAX_RECT_BUFFER       60
  55. #define MAX_SIZE_BUFFER       30
  56. #define MAX_POINT_BUFFER      30
  57. #define HX_PRODUCTNAME_SHARED "HelixShared"    // Special shared product name. 
  58. typedef struct _PrefTableEntry
  59. {
  60.     char*   szPrefName;
  61.     char*   pDefaultValue;
  62. } PrefTableEntry;
  63. // Helper class used by CPref, but can also be used outside of CPref if a pref table is being used
  64. class CPrefTable
  65. {
  66. public:
  67.     CPrefTable(PrefTableEntry* pPrefTable,INT32 nTableEntries,CPref* pPrefs);
  68.     CPrefTable(PrefTableEntry* pPrefTable,INT32 nTableEntries,IHXPreferences* pPrefs);
  69.     virtual ~CPrefTable();
  70.    BOOL IsPrefSet(INT32 nPrefKey,INT32 nIndex=0);
  71.    HX_RESULT ReadPrefInt(INT32 nPrefKey,INT32& nValue,INT32 nIndex=0);
  72.    HX_RESULT ReadPrefColor(INT32 nPrefKey,HXxColor& color,INT32 nIndex=0);
  73.    HX_RESULT ReadPrefRect(INT32 nPrefKey,HXxRect& rect,INT32 nIndex=0);
  74.    HX_RESULT ReadPrefSize(INT32 nPrefKey,HXxSize& size,INT32 nIndex=0);
  75.    HX_RESULT ReadPrefPoint(INT32 nPrefKey,HXxPoint& pt,INT32 nIndex=0);
  76.    HX_RESULT ReadPrefString(INT32 nPrefKey,char* szString,INT32 nStrLen,INT32 nIndex=0);
  77.    HX_RESULT ReadPrefBuffer(INT32 nPrefKey,IHXBuffer*& pBuffer,INT32 nIndex=0);
  78.     
  79.    HX_RESULT WritePrefInt(INT32 nPrefKey,INT32 nValue,INT32 nIndex=0);
  80.    HX_RESULT WritePrefColor(INT32 nPrefKey,const HXxColor& color,INT32 nIndex=0);
  81.    HX_RESULT WritePrefRect(INT32 nPrefKey,const HXxRect& rect,INT32 nIndex=0);
  82.    HX_RESULT WritePrefSize(INT32 nPrefKey,const HXxSize& size,INT32 nIndex=0);
  83.    HX_RESULT WritePrefPoint(INT32 nPrefKey,const HXxPoint& pt,INT32 nIndex=0);
  84.    HX_RESULT WritePrefString(INT32 nPrefKey,const char* szString,INT32 nIndex=0);
  85.    HX_RESULT WritePrefBuffer(INT32 nPrefKey,IHXBuffer* pBuffer,INT32 nIndex=0);
  86.    HX_RESULT RemoveIndexedPref(INT32 nPrefKey);
  87.    HX_RESULT RemovePref(INT32 nPrefKey);
  88.    HX_RESULT BeginSubPref(INT32 nPrefKey);
  89. protected:
  90.    HX_RESULT ReadPref(INT32 nPrefKey,INT32 nIndex,IHXBuffer*& pBuffer);
  91.    BOOL ReadPoints(const char* pBuffer,HXxPoint* pt,int nNumPoints);
  92.    HX_RESULT WritePref(INT32 nPrefKey,INT32 nIndex,IHXBuffer* pBuffer);
  93.    IHXBuffer* CreateIHXBuffer(const char* szString);
  94.    INT32     m_nTableEntries;
  95.    PrefTableEntry*  m_pPrefTable;   
  96.    CPref*     m_pCPref;
  97.    IHXPreferences* m_pIHXPrefs;
  98. };
  99. class CPref 
  100. {
  101. public:
  102. /*    last_error() returns the last platform specific error that occurred */
  103.    HX_RESULT last_error(void)   
  104.    {
  105.        return mLastError;
  106.    };
  107. /*    class destructor */  
  108.    virtual              ~CPref         (void);
  109. /*  read_pref reads the preference specified by Key to the Buffer. */
  110.    virtual HX_RESULT read_pref(const char* pPrefKey, IHXBuffer*& pBuffer) = 0;
  111.    /* To use these methods you need to call UsePrefTable() and setup up a product specific pref table */
  112.    inline BOOL IsPrefSet(INT32 nPrefKey,INT32 nIndex=0)
  113.    {
  114.        return (m_pPrefTable ? m_pPrefTable->IsPrefSet(nPrefKey,nIndex) : FALSE);
  115.    }
  116.    inline HX_RESULT ReadPrefInt(INT32 nPrefKey,INT32& nValue,INT32 nIndex=0)
  117.    {
  118.        return (m_pPrefTable ? m_pPrefTable->ReadPrefInt(nPrefKey,nValue,nIndex) : HXR_FAIL);
  119.    }
  120.    inline HX_RESULT ReadPrefColor(INT32 nPrefKey,HXxColor& color,INT32 nIndex=0)
  121.    {
  122.        return (m_pPrefTable ? m_pPrefTable->ReadPrefColor(nPrefKey,color,nIndex) : HXR_FAIL);
  123.    }
  124.    inline HX_RESULT ReadPrefRect(INT32 nPrefKey,HXxRect& rect,INT32 nIndex=0)
  125.    {
  126.        return (m_pPrefTable ? m_pPrefTable->ReadPrefRect(nPrefKey,rect,nIndex) : HXR_FAIL);
  127.    }
  128.    inline HX_RESULT ReadPrefSize(INT32 nPrefKey,HXxSize& size,INT32 nIndex=0)
  129.    {
  130.        return (m_pPrefTable ? m_pPrefTable->ReadPrefSize(nPrefKey,size,nIndex) : HXR_FAIL);
  131.    }
  132.    inline HX_RESULT ReadPrefPoint(INT32 nPrefKey,HXxPoint& pt,INT32 nIndex=0)
  133.    {
  134.        return (m_pPrefTable ? m_pPrefTable->ReadPrefPoint(nPrefKey,pt,nIndex) : HXR_FAIL);
  135.    }
  136.    inline HX_RESULT ReadPrefString(INT32 nPrefKey,char* szString,INT32 nStrLen,INT32 nIndex=0)
  137.    {
  138.        return (m_pPrefTable ? m_pPrefTable->ReadPrefString(nPrefKey,szString,nStrLen,nIndex) : HXR_FAIL);
  139.    }
  140.    inline HX_RESULT ReadPrefBuffer(INT32 nPrefKey,IHXBuffer*& pBuffer,INT32 nIndex=0)
  141.    {
  142.        return (m_pPrefTable ? m_pPrefTable->ReadPrefBuffer(nPrefKey,pBuffer,nIndex) : HXR_FAIL);
  143.    }
  144. /*  write_pref writes (saves) the preference specified by Key from the Buffer. */       
  145.    virtual HX_RESULT write_pref(const char* pPrefKey, IHXBuffer* pBuffer) = 0; 
  146. /*  write_pref deletes the preference specified by Key from the Buffer. */       
  147.    virtual HX_RESULT delete_pref(const char* pPrefKey) = 0; 
  148.    /* commit_prefs saves all changes to the prefs to disk (e.g. on Unix) */ 
  149.    virtual HX_RESULT commit_prefs() {return HXR_OK;};
  150.    
  151.    /* To use these methods you need to call UsePrefTable() and setup up a product specific pref table */
  152.    inline HX_RESULT WritePrefInt(INT32 nPrefKey,INT32 nValue,INT32 nIndex=0)
  153.    {
  154.        return (m_pPrefTable ? m_pPrefTable->WritePrefInt(nPrefKey,nValue,nIndex) : HXR_FAIL);
  155.    }
  156.    inline HX_RESULT WritePrefColor(INT32 nPrefKey,const HXxColor& color,INT32 nIndex=0)
  157.    {
  158.        return (m_pPrefTable ? m_pPrefTable->WritePrefColor(nPrefKey,color,nIndex) : HXR_FAIL);
  159.    }
  160.    inline HX_RESULT WritePrefRect(INT32 nPrefKey,const HXxRect& rect,INT32 nIndex=0)
  161.    {
  162.        return (m_pPrefTable ? m_pPrefTable->WritePrefRect(nPrefKey,rect,nIndex) : HXR_FAIL);
  163.    }
  164.    inline HX_RESULT WritePrefSize(INT32 nPrefKey,const HXxSize& size,INT32 nIndex=0)
  165.    {
  166.        return (m_pPrefTable ? m_pPrefTable->WritePrefSize(nPrefKey,size,nIndex) : HXR_FAIL);
  167.    }
  168.    inline HX_RESULT WritePrefPoint(INT32 nPrefKey,const HXxPoint& pt,INT32 nIndex=0)
  169.    {
  170.        return (m_pPrefTable ? m_pPrefTable->WritePrefPoint(nPrefKey,pt,nIndex) : HXR_FAIL);
  171.    }
  172.    inline HX_RESULT WritePrefString(INT32 nPrefKey,const char* szString,INT32 nIndex=0)
  173.    {
  174.        return (m_pPrefTable ? m_pPrefTable->WritePrefString(nPrefKey,szString,nIndex) : HXR_FAIL);
  175.    }
  176.    inline HX_RESULT WritePrefBuffer(INT32 nPrefKey,IHXBuffer* pBuffer,INT32 nIndex=0)
  177.    {
  178.        return (m_pPrefTable ? m_pPrefTable->WritePrefBuffer(nPrefKey,pBuffer,nIndex) : HXR_FAIL);
  179.    }
  180.    inline HX_RESULT RemoveIndexedPref(INT32 nPrefKey)
  181.    {
  182.        return (m_pPrefTable ? m_pPrefTable->RemoveIndexedPref(nPrefKey) : HXR_FAIL);
  183.    }
  184.    inline HX_RESULT RemovePref(INT32 nPrefKey)
  185.    {
  186.        return (m_pPrefTable ? m_pPrefTable->RemovePref(nPrefKey) : HXR_FAIL);
  187.    }
  188. /*  call open_pref() to automatically create the correct platform specific preference 
  189.     object. If open_pref() returns NULL, an error occurred and the CPref object was 
  190.     not created. Call last_error to get the error */
  191. #if defined(_CARBON) || defined(_MAC_UNIX)
  192.    // for the Mac, we default to bCommon=FALSE since we want non-admin users to be able to run a new install, so by default
  193.    // prefs get written per-user
  194.    static CPref* open_pref(const char* pCompanyName, const char* pProductName, int nProdMajorVer, int nProdMinorVer, BOOL bCommon = FALSE);
  195. #else
  196.    static CPref* open_pref(const char* pCompanyName, const char* pProductName, int nProdMajorVer, int nProdMinorVer, BOOL bCommon = TRUE);
  197. #endif
  198.    static CPref* open_shared_pref(const char* pCompanyName);
  199.    static CPref* open_shared_user_pref(const char* pCompanyName);
  200.    void SetupPrefTable(PrefTableEntry* pPrefTable,INT32 nTableEntries);
  201. /*  remove_indexed_pref removes indexed preference specified by Key */       
  202.    virtual HX_RESULT remove_indexed_pref(const char* pPrefKey) = 0; 
  203.    /* Sub-Preference Support */
  204.    /* 
  205.     * After calling BeginSubPref all calls to Read/Write preferences will write the preferences under the Sub-Prefernece
  206.     * passed into BeginSubPref.  When done writing Sub-Preferences call EndSubPref.  Each call to BeginSubPref must
  207.     * be matched with a call to EndSubPref otherwise preferences may be written to the incorrect place.  You can call
  208.     * BeginSubPref multiple times to traverse deeper into sub-preferences, but each call must be matched with an EndSubPref
  209.     * on the way out.
  210.     */
  211.    virtual HX_RESULT BeginSubPref(const char* szSubPref) = 0;
  212.    inline  HX_RESULT BeginSubPref(INT32 nPrefKey)
  213.    {
  214.        return (m_pPrefTable ? m_pPrefTable->BeginSubPref(nPrefKey) : HXR_FAIL);
  215.    }
  216.    virtual HX_RESULT EndSubPref() = 0;
  217.    /* Preference Enumeration Support */
  218.    /*
  219.     * Gets a specified pref key for the specified index.  Use 0 to get the first pref key and then just keep incrementing
  220.     * until GetPrefKey returns HXR_FAIL.  pBuffer will contain the pref key
  221.     */
  222.    virtual HX_RESULT GetPrefKey(UINT32 nIndex,IHXBuffer*& pBuffer) = 0;
  223.    // remove the preference specified
  224.    virtual HX_RESULT remove_pref(const char* pPrefKey)
  225.    { HX_ASSERT(FALSE); return(HXR_FAIL); }
  226.    
  227.    virtual BOOL IsCommonPref() { return m_bIsCommonPref; }
  228. protected:
  229. /*  Constructor NOTE: use open_pref() to create an instance of this class */
  230.    CPref();
  231.    HX_RESULT       mLastError;       // last error to occur 
  232.    CPrefTable*    m_pPrefTable;     // The pref table information
  233.    BOOL    m_bIsCommonPref;  // pref was created bCommon (machine-wide)
  234. };              
  235. #endif // _PREF