modules/libpref/src/nsPrefService.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla Communicator client code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Brian Nesse <bnesse@netscape.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsPrefService_h__
  40 #define nsPrefService_h__
  41
  42 #include "nsIPrefService.h"
  43 #include "nsIPrefBranch.h"
  44 #include "nsIPrefBranchInternal.h"
  45 #include "nsIObserver.h"
  46 #include "nsCOMPtr.h"
  47 #include "nsWeakReference.h"
  48
  49 class nsIFile;
  50
  51 class nsPrefService : public nsIPrefService,
  52                       public nsIObserver,
  53                       public nsIPrefBranchInternal,
  54                       public nsSupportsWeakReference
  55 {
  56 public:
  57   NS_DECL_ISUPPORTS
  58   NS_DECL_NSIPREFSERVICE
  59   NS_FORWARD_NSIPREFBRANCH(mRootBranch->)
  60   NS_FORWARD_NSIPREFBRANCH2(mRootBranch->)
  61   NS_DECL_NSIOBSERVER
  62
  63   nsPrefService();
  64   virtual ~nsPrefService();
  65
  66   nsresult Init();
  67
  68 protected:
  69   nsresult NotifyServiceObservers(const char *aSubject);
  70   nsresult UseDefaultPrefFile();
  71   nsresult UseUserPrefFile();
  72   nsresult ReadAndOwnUserPrefFile(nsIFile *aFile);
  73   nsresult ReadAndOwnSharedUserPrefFile(nsIFile *aFile);
  74   nsresult SavePrefFileInternal(nsIFile* aFile);
  75   nsresult WritePrefFile(nsIFile* aFile);
  76   nsresult MakeBackupPrefFile(nsIFile *aFile);
  77
  78 private:
  79   nsCOMPtr<nsIPrefBranch2> mRootBranch;
  80   nsCOMPtr<nsIFile>       mCurrentFile;
  81   PRPackedBool            mDontWriteUserPrefs;
  82 };
  83
  84 #endif // nsPrefService_h__