AlterOffice
AlterOffice 3.4 SDK C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
textcvt.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 
3 
4 #ifndef INCLUDED_RTL_TEXTCVT_H
5 #define INCLUDED_RTL_TEXTCVT_H
6 
7 #include "sal/config.h"
8 
9 #include "rtl/textenc.h"
10 #include "sal/saldllapi.h"
11 #include "sal/types.h"
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
17 /* Documentation about this file can be found at
18  <http://udk.openoffice.org/cpp/man/spec/textconversion.html>. */
19 
23 
27 
30 SAL_DLLPUBLIC rtl_TextToUnicodeConverter SAL_CALL rtl_createTextToUnicodeConverter( rtl_TextEncoding eTextEncoding );
31 
34 SAL_DLLPUBLIC void SAL_CALL rtl_destroyTextToUnicodeConverter( rtl_TextToUnicodeConverter hConverter );
35 
38 SAL_DLLPUBLIC rtl_TextToUnicodeContext SAL_CALL rtl_createTextToUnicodeContext( rtl_TextToUnicodeConverter hConverter );
39 
42 SAL_DLLPUBLIC void SAL_CALL rtl_destroyTextToUnicodeContext( rtl_TextToUnicodeConverter hConverter, rtl_TextToUnicodeContext hContext );
43 
46 SAL_DLLPUBLIC void SAL_CALL rtl_resetTextToUnicodeContext( rtl_TextToUnicodeConverter hConverter, rtl_TextToUnicodeContext hContext );
47 
48 #define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_ERROR ((sal_uInt32)0x0001)
49 #define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_IGNORE ((sal_uInt32)0x0002)
50 #define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_MAPTOPRIVATE ((sal_uInt32)0x0003)
51 #define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_DEFAULT ((sal_uInt32)0x0004)
52 #define RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_ERROR ((sal_uInt32)0x0010)
53 #define RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_IGNORE ((sal_uInt32)0x0020)
54 #define RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_DEFAULT ((sal_uInt32)0x0030)
55 #define RTL_TEXTTOUNICODE_FLAGS_INVALID_ERROR ((sal_uInt32)0x0100)
56 #define RTL_TEXTTOUNICODE_FLAGS_INVALID_IGNORE ((sal_uInt32)0x0200)
57 #define RTL_TEXTTOUNICODE_FLAGS_INVALID_DEFAULT ((sal_uInt32)0x0300)
58 #define RTL_TEXTTOUNICODE_FLAGS_FLUSH ((sal_uInt32)0x8000)
59 #define RTL_TEXTTOUNICODE_FLAGS_GLOBAL_SIGNATURE 0x10000
60  /* Accept any global document signatures (for example, in UTF-8, a leading
61  EF BB BF encoding the Byte Order Mark U+FEFF) */
62 
63 #define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_MASK ((sal_uInt32)0x000F)
64 #define RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_MASK ((sal_uInt32)0x00F0)
65 #define RTL_TEXTTOUNICODE_FLAGS_INVALID_MASK ((sal_uInt32)0x0F00)
66 
67 #define RTL_TEXTTOUNICODE_INFO_ERROR ((sal_uInt32)0x0001)
68 // Misspelled constant, kept for backwards compatibility:
69 #define RTL_TEXTTOUNICODE_INFO_SRCBUFFERTOSMALL ((sal_uInt32)0x0002)
70 #define RTL_TEXTTOUNICODE_INFO_SRCBUFFERTOOSMALL ((sal_uInt32)0x0002)
71 // Misspelled constant, kept for backwards compatibility:
72 #define RTL_TEXTTOUNICODE_INFO_DESTBUFFERTOSMALL ((sal_uInt32)0x0004)
73 #define RTL_TEXTTOUNICODE_INFO_DESTBUFFERTOOSMALL ((sal_uInt32)0x0004)
74 #define RTL_TEXTTOUNICODE_INFO_UNDEFINED ((sal_uInt32)0x0008)
75 #define RTL_TEXTTOUNICODE_INFO_MBUNDEFINED ((sal_uInt32)0x0010)
76 #define RTL_TEXTTOUNICODE_INFO_INVALID ((sal_uInt32)0x0020)
77 
89 SAL_DLLPUBLIC sal_Size SAL_CALL rtl_convertTextToUnicode(
90  rtl_TextToUnicodeConverter hConverter,
91  rtl_TextToUnicodeContext hContext,
92  const char* pSrcBuf, sal_Size nSrcBytes,
93  sal_Unicode* pDestBuf, sal_Size nDestChars,
94  sal_uInt32 nFlags, sal_uInt32* pInfo,
95  sal_Size* pSrcCvtBytes );
96 
100 
104 
107 SAL_DLLPUBLIC rtl_UnicodeToTextConverter SAL_CALL rtl_createUnicodeToTextConverter( rtl_TextEncoding eTextEncoding );
108 
111 SAL_DLLPUBLIC void SAL_CALL rtl_destroyUnicodeToTextConverter( rtl_UnicodeToTextConverter hConverter );
112 
115 SAL_DLLPUBLIC rtl_UnicodeToTextContext SAL_CALL rtl_createUnicodeToTextContext( rtl_UnicodeToTextConverter hConverter );
116 
119 SAL_DLLPUBLIC void SAL_CALL rtl_destroyUnicodeToTextContext( rtl_UnicodeToTextConverter hConverter, rtl_UnicodeToTextContext hContext );
120 
123 SAL_DLLPUBLIC void SAL_CALL rtl_resetUnicodeToTextContext( rtl_UnicodeToTextConverter hConverter, rtl_UnicodeToTextContext hContext );
124 
125 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_ERROR ((sal_uInt32)0x0001)
126 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_IGNORE ((sal_uInt32)0x0002)
127 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_0 ((sal_uInt32)0x0003)
128 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_QUESTIONMARK ((sal_uInt32)0x0004)
129 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_UNDERLINE ((sal_uInt32)0x0005)
130 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_DEFAULT ((sal_uInt32)0x0006)
131 #define RTL_UNICODETOTEXT_FLAGS_INVALID_ERROR ((sal_uInt32)0x0010)
132 #define RTL_UNICODETOTEXT_FLAGS_INVALID_IGNORE ((sal_uInt32)0x0020)
133 #define RTL_UNICODETOTEXT_FLAGS_INVALID_0 ((sal_uInt32)0x0030)
134 #define RTL_UNICODETOTEXT_FLAGS_INVALID_QUESTIONMARK ((sal_uInt32)0x0040)
135 #define RTL_UNICODETOTEXT_FLAGS_INVALID_UNDERLINE ((sal_uInt32)0x0050)
136 #define RTL_UNICODETOTEXT_FLAGS_INVALID_DEFAULT ((sal_uInt32)0x0060)
137 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_REPLACE ((sal_uInt32)0x0100)
138 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_REPLACESTR ((sal_uInt32)0x0200)
139 #define RTL_UNICODETOTEXT_FLAGS_PRIVATE_MAPTO0 ((sal_uInt32)0x0400)
140 #define RTL_UNICODETOTEXT_FLAGS_NONSPACING_IGNORE ((sal_uInt32)0x0800)
141 #define RTL_UNICODETOTEXT_FLAGS_CONTROL_IGNORE ((sal_uInt32)0x1000)
142 #define RTL_UNICODETOTEXT_FLAGS_PRIVATE_IGNORE ((sal_uInt32)0x2000)
143 #define RTL_UNICODETOTEXT_FLAGS_NOCOMPOSITE ((sal_uInt32)0x4000)
144 #define RTL_UNICODETOTEXT_FLAGS_FLUSH ((sal_uInt32)0x8000)
145 #define RTL_UNICODETOTEXT_FLAGS_GLOBAL_SIGNATURE 0x10000
146  /* Write any global document signatures (for example, in UTF-8, a leading
147  EF BB BF encoding the Byte Order Mark U+FEFF) */
148 
149 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_MASK ((sal_uInt32)0x000F)
150 #define RTL_UNICODETOTEXT_FLAGS_INVALID_MASK ((sal_uInt32)0x00F0)
151 
152 #define RTL_UNICODETOTEXT_INFO_ERROR ((sal_uInt32)0x0001)
153 #define RTL_UNICODETOTEXT_INFO_SRCBUFFERTOSMALL ((sal_uInt32)0x0002)
154 #define RTL_UNICODETOTEXT_INFO_DESTBUFFERTOSMALL ((sal_uInt32)0x0004)
155 #define RTL_UNICODETOTEXT_INFO_UNDEFINED ((sal_uInt32)0x0008)
156 #define RTL_UNICODETOTEXT_INFO_INVALID ((sal_uInt32)0x0010)
157 
160 SAL_DLLPUBLIC sal_Size SAL_CALL rtl_convertUnicodeToText(
161  rtl_UnicodeToTextConverter hConverter,
162  rtl_UnicodeToTextContext hContext,
163  const sal_Unicode* pSrcBuf, sal_Size nSrcChars,
164  char* pDestBuf, sal_Size nDestBytes,
165  sal_uInt32 nFlags, sal_uInt32* pInfo,
166  sal_Size* pSrcCvtChars );
167 
168 #ifdef __cplusplus
169 }
170 #endif
171 
172 #endif // INCLUDED_RTL_TEXTCVT_H
173 
174 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
SAL_DLLPUBLIC void rtl_destroyUnicodeToTextContext(rtl_UnicodeToTextConverter hConverter, rtl_UnicodeToTextContext hContext)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
SAL_DLLPUBLIC void rtl_destroyTextToUnicodeContext(rtl_TextToUnicodeConverter hConverter, rtl_TextToUnicodeContext hContext)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
SAL_DLLPUBLIC void rtl_destroyTextToUnicodeConverter(rtl_TextToUnicodeConverter hConverter)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
SAL_DLLPUBLIC sal_Size rtl_convertTextToUnicode(rtl_TextToUnicodeConverter hConverter, rtl_TextToUnicodeContext hContext, const char *pSrcBuf, sal_Size nSrcBytes, sal_Unicode *pDestBuf, sal_Size nDestChars, sal_uInt32 nFlags, sal_uInt32 *pInfo, sal_Size *pSrcCvtBytes)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
sal_uInt16 rtl_TextEncoding
The various supported text encodings.
Definition: textenc.h:17
SAL_DLLPUBLIC void rtl_resetTextToUnicodeContext(rtl_TextToUnicodeConverter hConverter, rtl_TextToUnicodeContext hContext)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
SAL_DLLPUBLIC rtl_TextToUnicodeConverter rtl_createTextToUnicodeConverter(rtl_TextEncoding eTextEncoding)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
SAL_DLLPUBLIC sal_Size rtl_convertUnicodeToText(rtl_UnicodeToTextConverter hConverter, rtl_UnicodeToTextContext hContext, const sal_Unicode *pSrcBuf, sal_Size nSrcChars, char *pDestBuf, sal_Size nDestBytes, sal_uInt32 nFlags, sal_uInt32 *pInfo, sal_Size *pSrcCvtChars)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
SAL_DLLPUBLIC void rtl_destroyUnicodeToTextConverter(rtl_UnicodeToTextConverter hConverter)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
sal_uInt16 sal_Unicode
Definition: types.h:103
void * rtl_UnicodeToTextConverter
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
Definition: textcvt.h:99
void * rtl_TextToUnicodeContext
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
Definition: textcvt.h:26
void * rtl_TextToUnicodeConverter
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
Definition: textcvt.h:22
SAL_DLLPUBLIC void rtl_resetUnicodeToTextContext(rtl_UnicodeToTextConverter hConverter, rtl_UnicodeToTextContext hContext)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
SAL_DLLPUBLIC rtl_UnicodeToTextConverter rtl_createUnicodeToTextConverter(rtl_TextEncoding eTextEncoding)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
SAL_DLLPUBLIC rtl_TextToUnicodeContext rtl_createTextToUnicodeContext(rtl_TextToUnicodeConverter hConverter)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
SAL_DLLPUBLIC rtl_UnicodeToTextContext rtl_createUnicodeToTextContext(rtl_UnicodeToTextConverter hConverter)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
#define SAL_DLLPUBLIC
Definition: saldllapi.h:14
void * rtl_UnicodeToTextContext
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
Definition: textcvt.h:103