intl/unicharutil/src/nsSaveAsCharset.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 "nsIFactory.h"
  39 #include "nsString.h"
  40 #include "nsVoidArray.h"
  41 #include "nsICharsetConverterManager.h"
  42 #include "nsISaveAsCharset.h"
  43
  44
  45 #define MASK_FALLBACK(a) (nsISaveAsCharset::mask_Fallback & (a))
  46 #define MASK_ENTITY(a) (nsISaveAsCharset::mask_Entity & (a))
  47 #define MASK_CHARSET_FALLBACK(a) (nsISaveAsCharset::mask_CharsetFallback & (a))
  48 #define ATTR_NO_FALLBACK(a) (nsISaveAsCharset::attr_FallbackNone == MASK_FALLBACK(a) && \
  49                              nsISaveAsCharset::attr_EntityAfterCharsetConv != MASK_ENTITY(a))
  50
  51 class nsIUnicodeEncoder;
  52 class nsIEntityConverter;
  53
  54 class nsSaveAsCharset : public nsISaveAsCharset
  55 {
  56 public:
  57
  58         //
  59         // implementation methods
  60         //
  61   nsSaveAsCharset();
  62   virtual ~nsSaveAsCharset();
  63
  64         //
  65         // nsISupports
  66         //
  67         NS_DECL_ISUPPORTS
  68
  69         //
  70         // nsIEntityConverter
  71         //
  72   NS_IMETHOD Init(const char *charset, PRUint32 attr, PRUint32 entityVersion);
  73
  74   NS_IMETHOD Convert(const PRUnichar *inString, char **_retval);
  75
  76   NS_IMETHODIMP GetCharset(char * *aCharset);
  77
  78 protected:
  79
  80   NS_IMETHOD DoCharsetConversion(const PRUnichar *inString, char **outString);
  81
  82   NS_IMETHOD DoConversionFallBack(PRUint32 inUCS4, char *outString, PRInt32 bufferLength);
  83
  84   // do the fallback, reallocate the buffer if necessary
  85   // need to pass destination buffer info (size, current position and estimation of rest of the conversion)
  86   NS_IMETHOD HandleFallBack(PRUint32 character, char **outString, PRInt32 *bufferLength,
  87                             PRInt32 *currentPos, PRInt32 estimatedLength);
  88
  89   nsresult SetupUnicodeEncoder(const char* charset);
  90
  91   nsresult SetupCharsetList(const char *charsetList);
  92
  93   const char * GetNextCharset();
  94
  95   PRUint32 mAttribute;                    // conversion attribute
  96   PRUint32 mEntityVersion;                // see nsIEntityConverter
  97   nsCOMPtr<nsIUnicodeEncoder> mEncoder;   // encoder (convert from unicode)
  98   nsCOMPtr<nsIEntityConverter> mEntityConverter;
  99   nsCStringArray mCharsetList;
 100   PRInt32        mCharsetListIndex;
 101 };
 102
 103
 104 nsresult NS_NewSaveAsCharset(nsISupports **inst);
 105