intl/strres/src/nsStringBundle.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   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 nsStringBundle_h__
  39 #define nsStringBundle_h__
  40
  41 #include "nsIStringBundle.h"
  42 #include "nsCOMPtr.h"
  43 #include "nsIPersistentProperties2.h"
  44 #include "nsString.h"
  45 #include "nsCOMArray.h"
  46 #include "nsIStringBundleOverride.h"
  47
  48 class nsStringBundle : public nsIStringBundle
  49 {
  50 public:
  51     // init version
  52     nsStringBundle(const char* aURLSpec, nsIStringBundleOverride*);
  53     nsresult LoadProperties();
  54     virtual ~nsStringBundle();
  55
  56     NS_DECL_ISUPPORTS
  57     NS_DECL_NSISTRINGBUNDLE
  58
  59     nsCOMPtr<nsIPersistentProperties> mProps;
  60
  61 protected:
  62     //
  63     // functional decomposition of the funitions repeatively called
  64     //
  65     nsresult GetStringFromID(PRInt32 aID, nsAString& aResult);
  66     nsresult GetStringFromName(const nsAString& aName, nsAString& aResult);
  67
  68     nsresult GetCombinedEnumeration(nsIStringBundleOverride* aOverrideString,
  69                                     nsISimpleEnumerator** aResult);
  70 private:
  71     nsCString              mPropertiesURL;
  72     nsCOMPtr<nsIStringBundleOverride> mOverrideStrings;
  73     PRPackedBool                 mAttemptedLoad;
  74     PRPackedBool                 mLoaded;
  75
  76 public:
  77     static nsresult FormatString(const PRUnichar *formatStr,
  78                                  const PRUnichar **aParams, PRUint32 aLength,
  79                                  PRUnichar **aResult);
  80 };
  81
  82 /**
  83  * An extesible implementation of the StringBudle interface.
  84  *
  85  * @created         28/Dec/1999
  86  * @author  Catalin Rotaru [CATA]
  87  */
  88 class nsExtensibleStringBundle : public nsIStringBundle
  89 {
  90   NS_DECL_ISUPPORTS
  91   NS_DECL_NSISTRINGBUNDLE
  92
  93   nsresult Init(const char * aCategory, nsIStringBundleService *);
  94 private:
  95
  96   nsCOMArray<nsIStringBundle> mBundles;
  97   PRBool             mLoaded;
  98
  99 public:
 100
 101   nsExtensibleStringBundle();
 102   virtual ~nsExtensibleStringBundle();
 103 };
 104
 105
 106
 107 #endif