intl/unicharutil/src/nsEntityConverter.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 #include "nsIEntityConverter.h"
  39 #include "nsIFactory.h"
  40 #include "nsIStringBundle.h"
  41 #include "nsCOMPtr.h"
  42
  43 nsresult NS_NewEntityConverter(nsISupports** oResult);
  44
  45 #define kVERSION_STRING_LEN 128
  46
  47 class nsEntityVersionList
  48 {
  49 public:
  50     nsEntityVersionList() : mEntities(NULL) {}
  51
  52     PRUint32 mVersion;
  53     PRUnichar mEntityListName[kVERSION_STRING_LEN+1];
  54     nsCOMPtr<nsIStringBundle> mEntities;
  55 };
  56
  57 class nsEntityConverter: public nsIEntityConverter
  58 {
  59 public:
  60
  61         //
  62         // implementation methods
  63         //
  64         nsEntityConverter();
  65         virtual ~nsEntityConverter();
  66
  67         //
  68         // nsISupports
  69         //
  70         NS_DECL_ISUPPORTS
  71
  72         //
  73         // nsIEntityConverter
  74         //
  75         NS_IMETHOD ConvertUTF32ToEntity(PRUint32 character, PRUint32 entityVersion, char **_retval);
  76         NS_IMETHOD ConvertToEntity(PRUnichar character, PRUint32 entityVersion, char **_retval);
  77
  78         NS_IMETHOD ConvertToEntities(const PRUnichar *inString, PRUint32 entityVersion, PRUnichar **_retval);
  79
  80 protected:
  81
  82   // load a version property file and generate a version list (number/name pair)
  83   NS_IMETHOD LoadVersionPropertyFile();
  84
  85   // map version number to version string
  86   const PRUnichar* GetVersionName(PRUint32 versionNumber);
  87
  88   // map version number to a string bundle
  89   nsIStringBundle* GetVersionBundleInstance(PRUint32 versionNumber);
  90
  91   // load a string bundle file
  92   already_AddRefed<nsIStringBundle> LoadEntityBundle(PRUint32 version);
  93
  94
  95   nsEntityVersionList *mVersionList;            // array of version number/name pairs
  96   PRUint32 mVersionListLength;                  // number of supported versions
  97 };