Back to index

lightning-sunbird  0.9+nobinonly
nsStringBundle.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; 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) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsStringBundle_h__
00039 #define nsStringBundle_h__
00040 
00041 #include "nsIStringBundle.h"
00042 #include "nsCOMPtr.h"
00043 #include "nsIPersistentProperties2.h"
00044 #include "nsString.h"
00045 #include "nsCOMArray.h"
00046 #include "nsIStringBundleOverride.h"
00047 
00048 class nsStringBundle : public nsIStringBundle
00049 {
00050 public:
00051     // init version
00052     nsStringBundle(const char* aURLSpec, nsIStringBundleOverride*);
00053     nsresult LoadProperties();
00054     virtual ~nsStringBundle();
00055   
00056     NS_DECL_ISUPPORTS
00057     NS_DECL_NSISTRINGBUNDLE
00058 
00059     nsCOMPtr<nsIPersistentProperties> mProps;
00060 
00061 protected:
00062     //
00063     // functional decomposition of the funitions repeatively called 
00064     //
00065     nsresult GetStringFromID(PRInt32 aID, nsAString& aResult);
00066     nsresult GetStringFromName(const nsAString& aName, nsAString& aResult);
00067 
00068     nsresult GetCombinedEnumeration(nsIStringBundleOverride* aOverrideString,
00069                                     nsISimpleEnumerator** aResult);
00070 private:
00071     nsCString              mPropertiesURL;
00072     nsCOMPtr<nsIStringBundleOverride> mOverrideStrings;
00073     PRPackedBool                 mAttemptedLoad;
00074     PRPackedBool                 mLoaded;
00075     
00076 public:
00077     static nsresult FormatString(const PRUnichar *formatStr,
00078                                  const PRUnichar **aParams, PRUint32 aLength,
00079                                  PRUnichar **aResult);
00080 };
00081 
00088 class nsExtensibleStringBundle : public nsIStringBundle
00089 {
00090   NS_DECL_ISUPPORTS
00091   NS_DECL_NSISTRINGBUNDLE
00092 
00093   nsresult Init(const char * aCategory, nsIStringBundleService *);
00094 private:
00095   
00096   nsCOMArray<nsIStringBundle> mBundles;
00097   PRBool             mLoaded;
00098 
00099 public:
00100 
00101   nsExtensibleStringBundle();
00102   virtual ~nsExtensibleStringBundle();
00103 };
00104 
00105 
00106 
00107 #endif