Back to index

lightning-sunbird  0.9+nobinonly
nsIUnicodeDecoder.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
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 Communicator client 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 nsIUnicodeDecoder_h___
00039 #define nsIUnicodeDecoder_h___
00040 
00041 #include "nscore.h"
00042 #include "nsISupports.h"
00043 
00044 // Interface ID for our Unicode Decoder interface
00045 // {B2F178E1-832A-11d2-8A8E-00600811A836}
00046 //NS_DECLARE_ID(kIUnicodeDecoderIID,
00047 //  0xb2f178e1, 0x832a, 0x11d2, 0x8a, 0x8e, 0x0, 0x60, 0x8, 0x11, 0xa8, 0x36);
00048 
00049 #define NS_IUNICODEDECODER_IID     \
00050        { 0xb2f178e1, 0x832a, 0x11d2,      \
00051               { 0x8a, 0x8e, 0x0, 0x60, 0x8, 0x11, 0xa8, 0x36 }}
00052 
00053 // XXX deprecated
00054 /*---------- BEGIN DEPRECATED */ 
00055 #define NS_EXACT_LENGTH \
00056   NS_ERROR_GENERATE_SUCCESS(NS_ERROR_MODULE_UCONV, 11)
00057 
00058 #define NS_PARTIAL_MORE_INPUT \
00059   NS_ERROR_GENERATE_SUCCESS(NS_ERROR_MODULE_UCONV, 12)
00060 
00061 #define NS_PARTIAL_MORE_OUTPUT \
00062   NS_ERROR_GENERATE_SUCCESS(NS_ERROR_MODULE_UCONV, 13)
00063 
00064 #define NS_ERROR_ILLEGAL_INPUT \
00065   NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_UCONV, 14)
00066 /*---------- END DEPRECATED */ 
00067 
00068 // XXX make us hex! (same digits though)
00069 #define NS_OK_UDEC_EXACTLENGTH      \
00070   NS_ERROR_GENERATE_SUCCESS(NS_ERROR_MODULE_UCONV, 11)
00071 
00072 #define NS_OK_UDEC_MOREINPUT        \
00073   NS_ERROR_GENERATE_SUCCESS(NS_ERROR_MODULE_UCONV, 12)
00074 
00075 #define NS_OK_UDEC_MOREOUTPUT       \
00076   NS_ERROR_GENERATE_SUCCESS(NS_ERROR_MODULE_UCONV, 13)
00077 
00078 #define NS_ERROR_UDEC_ILLEGALINPUT  \
00079   NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_UCONV, 14)
00080 
00081 #define NS_OK_UDEC_NOBOMFOUND       \
00082   NS_ERROR_GENERATE_SUCCESS(NS_ERROR_MODULE_UCONV, 14)
00083 
00084 
00085 #define NS_UNICODEDECODER_CONTRACTID_BASE "@mozilla.org/intl/unicode/decoder;1?charset="
00086 
00093 class nsIUnicodeDecoder : public nsISupports
00094 {
00095 public:
00096   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IUNICODEDECODER_IID)
00097 
00098   enum {
00099     kOnError_Recover,       // on an error, recover and continue
00100     kOnError_Signal         // on an error, stop and signal
00101   };
00102 
00149   NS_IMETHOD Convert(const char * aSrc, PRInt32 * aSrcLength, 
00150       PRUnichar * aDest, PRInt32 * aDestLength) = 0;
00151 
00163   NS_IMETHOD GetMaxLength(const char * aSrc, PRInt32 aSrcLength, 
00164       PRInt32 * aDestLength) = 0;
00165 
00170   NS_IMETHOD Reset() = 0;
00171 };
00172 
00173 #endif /* nsIUnicodeDecoder_h___ */