intl/strres/src/nsStringBundleService.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.org 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  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef nsStringBundleService_h__
  39 #define nsStringBundleService_h__
  40
  41 #include "prclist.h"
  42 #include "plarena.h"
  43
  44 #include "nsCOMPtr.h"
  45 #include "nsHashtable.h"
  46 #include "nsIPersistentProperties2.h"
  47 #include "nsIStringBundle.h"
  48 #include "nsIObserver.h"
  49 #include "nsWeakReference.h"
  50 #include "nsIErrorService.h"
  51 #include "nsIStringBundleOverride.h"
  52
  53 struct bundleCacheEntry_t;
  54
  55 class nsStringBundleService : public nsIStringBundleService,
  56                               public nsIObserver,
  57                               public nsSupportsWeakReference
  58 {
  59 public:
  60   nsStringBundleService();
  61   virtual ~nsStringBundleService();
  62
  63   nsresult Init();
  64
  65   NS_DECL_ISUPPORTS
  66   NS_DECL_NSISTRINGBUNDLESERVICE
  67   NS_DECL_NSIOBSERVER
  68
  69 private:
  70   nsresult getStringBundle(const char *aUrl, nsIStringBundle** aResult);
  71   nsresult FormatWithBundle(nsIStringBundle* bundle, nsresult aStatus,
  72                             PRUint32 argCount, PRUnichar** argArray,
  73                             PRUnichar* *result);
  74
  75   void flushBundleCache();
  76
  77   bundleCacheEntry_t *insertIntoCache(nsIStringBundle *aBundle,
  78                                       nsCStringKey *aHashKey);
  79
  80   static void recycleEntry(bundleCacheEntry_t*);
  81
  82   nsHashtable mBundleMap;
  83   PRCList mBundleCache;
  84   PLArenaPool mCacheEntryPool;
  85
  86   nsCOMPtr<nsIErrorService>     mErrorService;
  87   nsCOMPtr<nsIStringBundleOverride> mOverrideStrings;
  88 };
  89
  90 #endif