Back to index

lightning-sunbird  0.9+nobinonly
nsSaveAsCharset.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 "nsIFactory.h"
00039 #include "nsString.h"
00040 #include "nsVoidArray.h"
00041 #include "nsICharsetConverterManager.h"
00042 #include "nsISaveAsCharset.h"
00043 
00044 
00045 #define MASK_FALLBACK(a) (nsISaveAsCharset::mask_Fallback & (a))
00046 #define MASK_ENTITY(a) (nsISaveAsCharset::mask_Entity & (a))
00047 #define MASK_CHARSET_FALLBACK(a) (nsISaveAsCharset::mask_CharsetFallback & (a))
00048 #define MASK_IGNORABLE_FALLBACK(a) (nsISaveAsCharset::mask_IgnorableFallback & (a))
00049 #define ATTR_NO_FALLBACK(a) (nsISaveAsCharset::attr_FallbackNone == MASK_FALLBACK(a) && \
00050                              nsISaveAsCharset::attr_EntityAfterCharsetConv != MASK_ENTITY(a))
00051 
00052 class nsIUnicodeEncoder;
00053 class nsIEntityConverter;
00054 
00055 class nsSaveAsCharset : public nsISaveAsCharset
00056 {
00057 public:
00058        
00059        //
00060        // implementation methods
00061        //
00062   nsSaveAsCharset();
00063   virtual ~nsSaveAsCharset();
00064 
00065        //
00066        // nsISupports
00067        //
00068        NS_DECL_ISUPPORTS
00069 
00070        //
00071        // nsIEntityConverter
00072        //
00073   NS_IMETHOD Init(const char *charset, PRUint32 attr, PRUint32 entityVersion);
00074 
00075   NS_IMETHOD Convert(const PRUnichar *inString, char **_retval);
00076 
00077   NS_IMETHODIMP GetCharset(char * *aCharset);
00078 
00079 protected:
00080 
00081   NS_IMETHOD DoCharsetConversion(const PRUnichar *inString, char **outString);
00082 
00083   NS_IMETHOD DoConversionFallBack(PRUint32 inUCS4, char *outString, PRInt32 bufferLength);
00084 
00085   // do the fallback, reallocate the buffer if necessary
00086   // need to pass destination buffer info (size, current position and estimation of rest of the conversion)
00087   NS_IMETHOD HandleFallBack(PRUint32 character, char **outString, PRInt32 *bufferLength, 
00088                             PRInt32 *currentPos, PRInt32 estimatedLength);
00089 
00090   nsresult SetupUnicodeEncoder(const char* charset);
00091 
00092   nsresult SetupCharsetList(const char *charsetList);
00093 
00094   const char * GetNextCharset();
00095 
00096   PRUint32 mAttribute;                    // conversion attribute
00097   PRUint32 mEntityVersion;                // see nsIEntityConverter
00098   nsCOMPtr<nsIUnicodeEncoder> mEncoder;   // encoder (convert from unicode)
00099   nsCOMPtr<nsIEntityConverter> mEntityConverter;
00100   nsCStringArray mCharsetList;
00101   PRInt32        mCharsetListIndex;
00102 };
00103 
00104 
00105 nsresult NS_NewSaveAsCharset(nsISupports **inst);
00106