Back to index

lightning-sunbird  0.9+nobinonly
nsEntityConverter.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 #include "nsIEntityConverter.h"
00039 #include "nsIFactory.h"
00040 #include "nsIStringBundle.h"
00041 #include "nsCOMPtr.h"
00042 
00043 nsresult NS_NewEntityConverter(nsISupports** oResult);
00044 
00045 #define kVERSION_STRING_LEN 128
00046 
00047 class nsEntityVersionList
00048 {
00049 public:
00050     nsEntityVersionList() : mEntities(NULL) {}
00051     
00052     PRUint32 mVersion;
00053     PRUnichar mEntityListName[kVERSION_STRING_LEN+1];
00054     nsCOMPtr<nsIStringBundle> mEntities;
00055 };
00056 
00057 class nsEntityConverter: public nsIEntityConverter
00058 {
00059 public:
00060        
00061        //
00062        // implementation methods
00063        //
00064        nsEntityConverter();
00065        virtual ~nsEntityConverter();
00066 
00067        //
00068        // nsISupports
00069        //
00070        NS_DECL_ISUPPORTS
00071 
00072        //
00073        // nsIEntityConverter
00074        //
00075        NS_IMETHOD ConvertUTF32ToEntity(PRUint32 character, PRUint32 entityVersion, char **_retval);
00076        NS_IMETHOD ConvertToEntity(PRUnichar character, PRUint32 entityVersion, char **_retval);
00077 
00078        NS_IMETHOD ConvertToEntities(const PRUnichar *inString, PRUint32 entityVersion, PRUnichar **_retval);
00079 
00080 protected:
00081 
00082   // load a version property file and generate a version list (number/name pair)
00083   NS_IMETHOD LoadVersionPropertyFile();
00084 
00085   // map version number to version string
00086   const PRUnichar* GetVersionName(PRUint32 versionNumber);
00087 
00088   // map version number to a string bundle
00089   nsIStringBundle* GetVersionBundleInstance(PRUint32 versionNumber);
00090 
00091   // load a string bundle file
00092   already_AddRefed<nsIStringBundle> LoadEntityBundle(PRUint32 version);
00093 
00094 
00095   nsEntityVersionList *mVersionList;            // array of version number/name pairs
00096   PRUint32 mVersionListLength;                  // number of supported versions
00097 };