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 #include "nsISupports.idl"
39
40 interface nsIInputStream;
41
42 %{C++
43 // {0A698C44-3BFF-11d4-9649-00C0CA135B4E}
44 #define NS_ISCRIPTABLEUNICODECONVERTER_CID { 0x0A698C44, 0x3BFF, 0x11d4, { 0x96, 0x49, 0x00, 0xC0, 0xCA, 0x13, 0x5B, 0x4E } }
45 #define NS_ISCRIPTABLEUNICODECONVERTER_CONTRACTID "@mozilla.org/intl/scriptableunicodeconverter"
46 %}
47
48 /**
49 * This interface is a unicode encoder for use by scripts
50 *
51 * @created 8/Jun/2000
52 * @author Makoto Kato [m_kato@ga2.so-net.ne.jp]
53 */
54 [scriptable, uuid(1ea19c6c-c59f-4fd7-9fc7-151e946baca0)]
55 interface nsIScriptableUnicodeConverter : nsISupports
56 {
57 /**
58 * Converts the data from Unicode to one Charset.
59 * Returns the converted string. After converting, Finish should be called
60 * and its return value appended to this return value.
61 */
62 ACString ConvertFromUnicode(in AString aSrc);
63
64 /**
65 * Returns the terminator string.
66 * Should be called after ConvertFromUnicode() and appended to that
67 * function's return value.
68 */
69 ACString Finish();
70
71 /**
72 * Converts the data from one Charset to Unicode.
73 */
74 AString ConvertToUnicode(in ACString aSrc);
75
76 /**
77 * Converts an array of bytes to a unicode string.
78 */
79 AString convertFromByteArray([const,array,size_is(aCount)] in octet aData,
80 in unsigned long aCount);
81
82 /**
83 * Convert a unicode string to an array of bytes. Finish does not need to be
84 * called.
85 */
86 void convertToByteArray(in AString aString,
87 out unsigned long aLen,
88 [array, size_is(aLen),retval] out octet aData);
89
90 /**
91 * Converts a unicode string to an input stream. The bytes in the stream are
92 * encoded according to the charset attribute.
93 * The returned stream will be nonblocking.
94 */
95 nsIInputStream convertToInputStream(in AString aString);
96
97 /**
98 * Current character set.
99 *
100 * @throw NS_ERROR_UCONV_NOCONV
101 * The requested charset is not supported.
102 */
103 attribute string charset;
104 };