1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/*************************************************************************
*
* $RCSfile: tencinfo.h,v $
*
* $Revision: 1.6 $
*
* last change: $Author: sb $ $Date: 2002-03-19 15:08:03 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef _RTL_TENCINFO_H
#define _RTL_TENCINFO_H
#ifndef _SAL_TYPES_H
#include <sal/types.h>
#endif
#ifndef _RTL_TEXTENC_H
#include <rtl/textenc.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
#define RTL_TEXTENCODING_INFO_CONTEXT ((sal_uInt32)0x00000001)
#define RTL_TEXTENCODING_INFO_ASCII ((sal_uInt32)0x00000002)
#define RTL_TEXTENCODING_INFO_UNICODE ((sal_uInt32)0x00000004)
#define RTL_TEXTENCODING_INFO_MULTIBYTE ((sal_uInt32)0x00000008)
#define RTL_TEXTENCODING_INFO_R2L ((sal_uInt32)0x00000010)
#define RTL_TEXTENCODING_INFO_7BIT ((sal_uInt32)0x00000020)
#define RTL_TEXTENCODING_INFO_SYMBOL ((sal_uInt32)0x00000040)
#define RTL_TEXTENCODING_INFO_MIME ((sal_uInt32)0x00000080)
/** Information about a text encoding.
*/
typedef struct _rtl_TextEncodingInfo
{
/** The size (in bytes) of this structure. Should be 12.
*/
sal_uInt32 StructSize;
/** The minimum number of bytes needed to encode any character in the
given encoding.
Can be rather meaningless for encodings that encode global state along
with the characters (e.g., ISO-2022 encodings).
*/
sal_uInt8 MinimumCharSize;
/** The maximum number of bytes needed to encode any character in the
given encoding.
Can be rather meaningless for encodings that encode global state along
with the characters (e.g., ISO-2022 encodings).
*/
sal_uInt8 MaximumCharSize;
/** The average number of bytes needed to encode a character in the given
encoding.
*/
sal_uInt8 AverageCharSize;
/** An unused byte, for padding.
*/
sal_uInt8 Reserved;
/** Any combination of the flags RTL_TEXTENCODING_INFO_CONTEXT (with
unknown semantics), RTL_TEXTENCODING_INFO_ASCII (the encoding is a
superset of ASCII), RTL_TEXTENCODING_INFO_UNICODE (the encoding's
character set is Unicode), RTL_TEXTENCODING_INFO_MULTIBYTE (a
multi-byte encoding), RTL_TEXTENCODING_INFO_R2L (an encoding used
mainly or exclusively for languages written from right to left),
RTL_TEXTENCODING_INFO_7BIT (a 7-bit instead of an 8-bit encoding),
RTL_TEXTENCODING_INFO_SYMBOL (an encoding for symbol character sets),
and RTL_TEXTENCODING_INFO_MIME (the encoding is registered as a MIME
charset).
*/
sal_uInt32 Flags;
} rtl_TextEncodingInfo;
/** Determine whether a text encoding uses single octets as basic units of
information (and can thus be used with the conversion routines in
rtl/textcvt.h).
@param nEncoding
Any rtl_TextEncoding value.
@return
True if the given encoding uses single octets as basic units of
information, false otherwise.
*/
sal_Bool SAL_CALL rtl_isOctetTextEncoding(rtl_TextEncoding nEncoding);
/** Return information about a text encoding.
@param eTextEncoding
Any rtl_TextEncoding value.
@param pEncInfo
Returns information about the given encoding. Must not be null, and the
StructSize member must be set correctly.
@return
True if information about the given encoding is available, false
otherwise.
*/
sal_Bool SAL_CALL rtl_getTextEncodingInfo( rtl_TextEncoding eTextEncoding, rtl_TextEncodingInfo* pEncInfo );
/** Map from a numeric Windows charset to a text encoding.
@param nWinCharset
Any numeric Windows charset.
@return
The corresponding rtl_TextEncoding value, or RTL_TEXTENCODING_DONTKNOW if
no mapping is applicable.
*/
rtl_TextEncoding SAL_CALL rtl_getTextEncodingFromWindowsCharset( sal_uInt8 nWinCharset );
/** Map from a MIME charset to a text encoding.
@param pMimeCharset
Any MIME charset string. Must not be null.
@return
The corresponding rtl_TextEncoding value, or RTL_TEXTENCODING_DONTKNOW if
no mapping is applicable.
*/
rtl_TextEncoding SAL_CALL rtl_getTextEncodingFromMimeCharset( const sal_Char* pMimeCharset );
/** Map from a Unix charset to a text encoding.
@param pMimeCharset
Any Unix charset string. Must not be null.
@return
The corresponding rtl_TextEncoding value, or RTL_TEXTENCODING_DONTKNOW if
no mapping is applicable.
*/
rtl_TextEncoding SAL_CALL rtl_getTextEncodingFromUnixCharset( const sal_Char* pUnixCharset );
/** Map from a text encoding to the best matching numeric Windows charset.
@param eTextEncoding
Any rtl_TextEncoding value.
@return
The best matching numeric Windows charset, or 1 if none matches.
*/
sal_uInt8 SAL_CALL rtl_getBestWindowsCharsetFromTextEncoding( rtl_TextEncoding eTextEncoding );
/** Map from a text encoding to a corresponding MIME charset name, if
available (see <http://www.iana.org/assignments/character-sets>).
@param nEncoding
Any rtl_TextEncoding value.
@return
The (preferred) MIME charset name corresponding to the given encoding, or
NULL if none is available.
*/
char const * SAL_CALL rtl_getMimeCharsetFromTextEncoding(rtl_TextEncoding
nEncoding);
/** Map from a text encoding to the best matching MIME charset.
@param eTextEncoding
Any rtl_TextEncoding value.
@return
The best matching MIME charset string, or null if none matches.
*/
const sal_Char* SAL_CALL rtl_getBestMimeCharsetFromTextEncoding( rtl_TextEncoding eTextEncoding );
/** Map from a text encoding to the best matching Unix charset.
@param eTextEncoding
Any rtl_TextEncoding value.
@return
The best matching Unix charset string, or null if none matches.
*/
const sal_Char* SAL_CALL rtl_getBestUnixCharsetFromTextEncoding( rtl_TextEncoding eTextEncoding );
#ifdef __cplusplus
}
#endif
#endif /* _RTL_TENCINFO_H */
|
