intl/uconv/src/nsUnicodeToUTF8.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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 Communicator client 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 nsUnicodeToUTF8_h___
  39 #define nsUnicodeToUTF8_h___
  40
  41 // Class ID for our UnicodeToUTF8 charset converter
  42 // {7C657D18-EC5E-11d2-8AAC-00600811A836}
  43 #define NS_UNICODETOUTF8_CID \
  44   { 0x7c657d18, 0xec5e, 0x11d2, {0x8a, 0xac, 0x0, 0x60, 0x8, 0x11, 0xa8, 0x36}}
  45
  46 #define NS_UNICODETOUTF8_CONTRACTID "@mozilla.org/intl/unicode/encoder;1?charset=UTF-8"
  47
  48 //#define NS_ERROR_UCONV_NOUNICODETOUTF8
  49 //  NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_UCONV, 0x31)
  50
  51 //----------------------------------------------------------------------
  52 // Class nsUnicodeToUTF8 [declaration]
  53
  54 /**
  55  * A character set converter from Unicode to UTF8.
  56  *
  57  * @created         05/Apr/1999
  58  * @author  Catalin Rotaru [CATA]
  59  */
  60 class nsUnicodeToUTF8 : public nsIUnicodeEncoder
  61 {
  62   NS_DECL_ISUPPORTS
  63
  64 public:
  65
  66   /**
  67    * Class constructor.
  68    */
  69   nsUnicodeToUTF8() {mHighSurrogate = 0;}
  70
  71   NS_IMETHOD FillInfo(PRUint32* aInfo);
  72
  73   NS_IMETHOD Convert(const PRUnichar * aSrc,
  74                      PRInt32 * aSrcLength,
  75                      char * aDest,
  76                      PRInt32 * aDestLength);
  77
  78   NS_IMETHOD Finish(char * aDest, PRInt32 * aDestLength);
  79
  80   NS_IMETHOD GetMaxLength(const PRUnichar * aSrc, PRInt32 aSrcLength,
  81       PRInt32 * aDestLength);
  82
  83   NS_IMETHOD Reset() {mHighSurrogate = 0; return NS_OK;}
  84
  85   NS_IMETHOD SetOutputErrorBehavior(PRInt32 aBehavior,
  86     nsIUnicharEncoder * aEncoder, PRUnichar aChar) {return NS_OK;}
  87
  88 protected:
  89   PRUnichar mHighSurrogate;
  90
  91 };
  92
  93 #endif /* nsUnicodeToUTF8_h___ */