Back to index

lightning-sunbird  0.9+nobinonly
nsIUnicodeEncodeHelper.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 nsIUnicodeEncodeHelper_h___
00039 #define nsIUnicodeEncodeHelper_h___
00040 
00041 #include "nscore.h"
00042 #include "uconvutil.h"
00043 #include "nsISupports.h"
00044 #include "nsIMappingCache.h"
00045 
00046 // Interface ID for our Unicode Encode Helper interface
00047 // {D8E6B700-CA9D-11d2-8AA9-00600811A836}
00048 #define NS_IUNICODEENCODEHELPER_IID \
00049 { 0xd8e6b700, 0xca9d, 0x11d2, {0x8a, 0xa9, 0x0, 0x60, 0x8, 0x11, 0xa8, 0x36}}
00050 
00051 // Class ID for our UnicodeEncoderHelper implementation
00052 // {1767FC50-CAA4-11d2-8AA9-00600811A836}
00053 #define NS_UNICODEENCODEHELPER_CID \
00054 { 0x1767fc50, 0xcaa4, 0x11d2, {0x8a, 0xa9, 0x0, 0x60, 0x8, 0x11, 0xa8, 0x36}}
00055 
00056 
00057 #define NS_UNICODEENCODEHELPER_CONTRACTID "@mozilla.org/intl/unicode/encodehelper;1"
00058 
00059 #define NS_ERROR_UENC_NOHELPER  \
00060   NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_UCONV, 0x31)
00061 
00062 //----------------------------------------------------------------------
00063 // Class nsIUnicodeEncodeHelper [declaration]
00064 
00071 class nsIUnicodeEncodeHelper : public nsISupports
00072 {
00073 public:
00074 
00075   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IUNICODEENCODEHELPER_IID)
00076 
00077   
00080   NS_IMETHOD ConvertByTable(const PRUnichar * aSrc, PRInt32 * aSrcLength, 
00081       char * aDest, PRInt32 * aDestLength, uShiftTable * aShiftTable, 
00082       uMappingTable  * aMappingTable) = 0;
00083 
00087   NS_IMETHOD ConvertByMultiTable(const PRUnichar * aSrc, PRInt32 * aSrcLength,
00088       char * aDest, PRInt32 * aDestLength, PRInt32 aTableCount, 
00089       uShiftTable ** aShiftTable, uMappingTable  ** aMappingTable) = 0;
00090 
00094   NS_IMETHOD CreateCache(nsMappingCacheType aType, nsIMappingCache* aResult) = 0;
00095 
00099   NS_IMETHOD DestroyCache(nsIMappingCache aCache) = 0;
00100   
00104   NS_IMETHOD FillInfo(PRUint32* aInfo, uMappingTable  * aMappingTable) = 0;
00105   NS_IMETHOD FillInfo(PRUint32* aInfo, PRInt32 aTableCount, uMappingTable  ** aMappingTable) = 0;
00106 };
00107 
00108 
00109 
00110 #endif /* nsIUnicodeEncodeHelper_h___ */