Back to index

lightning-sunbird  0.9+nobinonly
nsSharedPrefHandler.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2003
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Conrad Carlen <ccarlen@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef nsSharedPrefHandler_h__
00040 #define nsSharedPrefHandler_h__
00041 
00042 // Interfaces needed
00043 #include "ipcITransactionService.h"
00044 #include "ipcITransactionObserver.h"
00045 
00046 // Includes
00047 #include "nsCOMPtr.h"
00048 #include "nsString.h"
00049 #include "nsVoidArray.h"
00050 
00051 // Local includes
00052 #include "prefapi.h"
00053 
00054 // Forward declarations
00055 class nsPrefService;
00056 
00057 // --------------------------------------------------------------------------------------
00058 //  nsSharedPrefHandler
00059 // --------------------------------------------------------------------------------------
00060 
00061 class nsSharedPrefHandler : public ipcITransactionObserver
00062 {
00063   friend nsresult NS_CreateSharedPrefHandler(nsPrefService*);
00064     
00065   NS_DECL_ISUPPORTS
00066   NS_DECL_IPCITRANSACTIONOBSERVER
00067     
00068 public:    
00069   nsresult        OnSessionBegin();
00070   nsresult        OnSessionEnd();
00071 
00072   nsresult        OnSavePrefs();
00073   
00074   nsresult        OnPrefChanged(PRBool defaultPref,
00075                                 PrefHashEntry* pref,
00076                                 PrefValue newValue);
00077 
00078   void            ReadingUserPrefs(PRBool isReading)
00079                   { mReadingUserPrefs = isReading; }
00080 
00081   PRBool          IsPrefShared(const char* prefName);
00082   
00083 protected:
00084                   nsSharedPrefHandler();
00085   virtual         ~nsSharedPrefHandler();
00086 
00087   nsresult        Init(nsPrefService *aOwner);
00088   nsresult        ReadExceptionFile();
00089   nsresult        EnsureTransactionService();
00090   
00091 protected:
00092   nsPrefService   *mPrefService;      // weak ref
00093   
00094   nsCOMPtr<ipcITransactionService> mTransService;
00095   const nsCString mPrefsTSQueueName;
00096   
00097   PRPackedBool    mSessionActive;
00098   PRPackedBool    mReadingUserPrefs;
00099   PRPackedBool    mProcessingTransaction;
00100   
00101   nsAutoVoidArray mExceptionList;
00102 };
00103 
00104 // --------------------------------------------------------------------------------------
00105 
00106 extern nsSharedPrefHandler *gSharedPrefHandler; // greasy, but used by procedural code.
00107 
00114 extern nsresult NS_CreateSharedPrefHandler(nsPrefService *aOwner);
00115                                         
00116 #endif // nsSharedPrefHandler_h__