LibreOffice: rtl/textcvt.h Source File

LibreOffice LibreOffice 26.2 SDK C/C++ API Reference

Loading...
Searching...
No Matches
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 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20/*
21 * This file is part of LibreOffice published API.
22 */
23
24#ifndef INCLUDED_RTL_TEXTCVT_H
25#define INCLUDED_RTL_TEXTCVT_H
26
27#include "sal/config.h"
28
29#include "rtl/textenc.h"
30#include "sal/saldllapi.h"
31#include "sal/types.h"
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37/* Documentation about this file can be found at
38 <http://udk.openoffice.org/cpp/man/spec/textconversion.html>. */
39
42 typedef void* rtl_TextToUnicodeConverter;
43
46 typedef void* rtl_TextToUnicodeContext;
47
50 SAL_DLLPUBLIC rtl_TextToUnicodeConverter SAL_CALL rtl_createTextToUnicodeConverter( rtl_TextEncoding eTextEncoding );
51
54 SAL_DLLPUBLIC void SAL_CALL rtl_destroyTextToUnicodeConverter( rtl_TextToUnicodeConverter hConverter );
55
58 SAL_DLLPUBLIC rtl_TextToUnicodeContext SAL_CALL rtl_createTextToUnicodeContext( rtl_TextToUnicodeConverter hConverter );
59
62 SAL_DLLPUBLIC void SAL_CALL rtl_destroyTextToUnicodeContext( rtl_TextToUnicodeConverter hConverter, rtl_TextToUnicodeContext hContext );
63
66 SAL_DLLPUBLIC void SAL_CALL rtl_resetTextToUnicodeContext( rtl_TextToUnicodeConverter hConverter, rtl_TextToUnicodeContext hContext );
67
68#define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_ERROR ((sal_uInt32)0x0001)
69#define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_IGNORE ((sal_uInt32)0x0002)
70#define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_MAPTOPRIVATE ((sal_uInt32)0x0003)
71#define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_DEFAULT ((sal_uInt32)0x0004)
72#define RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_ERROR ((sal_uInt32)0x0010)
73#define RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_IGNORE ((sal_uInt32)0x0020)
74#define RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_DEFAULT ((sal_uInt32)0x0030)
75#define RTL_TEXTTOUNICODE_FLAGS_INVALID_ERROR ((sal_uInt32)0x0100)
76#define RTL_TEXTTOUNICODE_FLAGS_INVALID_IGNORE ((sal_uInt32)0x0200)
77#define RTL_TEXTTOUNICODE_FLAGS_INVALID_DEFAULT ((sal_uInt32)0x0300)
78#define RTL_TEXTTOUNICODE_FLAGS_FLUSH ((sal_uInt32)0x8000)
79#define RTL_TEXTTOUNICODE_FLAGS_GLOBAL_SIGNATURE 0x10000
80 /* Accept any global document signatures (for example, in UTF-8, a leading
81 EF BB BF encoding the Byte Order Mark U+FEFF) */
82
83#define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_MASK ((sal_uInt32)0x000F)
84#define RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_MASK ((sal_uInt32)0x00F0)
85#define RTL_TEXTTOUNICODE_FLAGS_INVALID_MASK ((sal_uInt32)0x0F00)
86
87#define RTL_TEXTTOUNICODE_INFO_ERROR ((sal_uInt32)0x0001)
88// Misspelled constant, kept for backwards compatibility:
89#define RTL_TEXTTOUNICODE_INFO_SRCBUFFERTOSMALL ((sal_uInt32)0x0002)
90#define RTL_TEXTTOUNICODE_INFO_SRCBUFFERTOOSMALL ((sal_uInt32)0x0002)
91// Misspelled constant, kept for backwards compatibility:
92#define RTL_TEXTTOUNICODE_INFO_DESTBUFFERTOSMALL ((sal_uInt32)0x0004)
93#define RTL_TEXTTOUNICODE_INFO_DESTBUFFERTOOSMALL ((sal_uInt32)0x0004)
94#define RTL_TEXTTOUNICODE_INFO_UNDEFINED ((sal_uInt32)0x0008)
95#define RTL_TEXTTOUNICODE_INFO_MBUNDEFINED ((sal_uInt32)0x0010)
96#define RTL_TEXTTOUNICODE_INFO_INVALID ((sal_uInt32)0x0020)
97
109 SAL_DLLPUBLIC sal_Size SAL_CALL rtl_convertTextToUnicode(
110 rtl_TextToUnicodeConverter hConverter,
111 rtl_TextToUnicodeContext hContext,
112 const char* pSrcBuf, sal_Size nSrcBytes,
113 sal_Unicode* pDestBuf, sal_Size nDestChars,
114 sal_uInt32 nFlags, sal_uInt32* pInfo,
115 sal_Size* pSrcCvtBytes );
116
119 typedef void* rtl_UnicodeToTextConverter;
120
123 typedef void* rtl_UnicodeToTextContext;
124
127 SAL_DLLPUBLIC rtl_UnicodeToTextConverter SAL_CALL rtl_createUnicodeToTextConverter( rtl_TextEncoding eTextEncoding );
128
131 SAL_DLLPUBLIC void SAL_CALL rtl_destroyUnicodeToTextConverter( rtl_UnicodeToTextConverter hConverter );
132
135 SAL_DLLPUBLIC rtl_UnicodeToTextContext SAL_CALL rtl_createUnicodeToTextContext( rtl_UnicodeToTextConverter hConverter );
136
139 SAL_DLLPUBLIC void SAL_CALL rtl_destroyUnicodeToTextContext( rtl_UnicodeToTextConverter hConverter, rtl_UnicodeToTextContext hContext );
140
143 SAL_DLLPUBLIC void SAL_CALL rtl_resetUnicodeToTextContext( rtl_UnicodeToTextConverter hConverter, rtl_UnicodeToTextContext hContext );
144
145#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_ERROR ((sal_uInt32)0x0001)
146#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_IGNORE ((sal_uInt32)0x0002)
147#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_0 ((sal_uInt32)0x0003)
148#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_QUESTIONMARK ((sal_uInt32)0x0004)
149#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_UNDERLINE ((sal_uInt32)0x0005)
150#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_DEFAULT ((sal_uInt32)0x0006)
151#define RTL_UNICODETOTEXT_FLAGS_INVALID_ERROR ((sal_uInt32)0x0010)
152#define RTL_UNICODETOTEXT_FLAGS_INVALID_IGNORE ((sal_uInt32)0x0020)
153#define RTL_UNICODETOTEXT_FLAGS_INVALID_0 ((sal_uInt32)0x0030)
154#define RTL_UNICODETOTEXT_FLAGS_INVALID_QUESTIONMARK ((sal_uInt32)0x0040)
155#define RTL_UNICODETOTEXT_FLAGS_INVALID_UNDERLINE ((sal_uInt32)0x0050)
156#define RTL_UNICODETOTEXT_FLAGS_INVALID_DEFAULT ((sal_uInt32)0x0060)
157#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_REPLACE ((sal_uInt32)0x0100)
158#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_REPLACESTR ((sal_uInt32)0x0200)
159#define RTL_UNICODETOTEXT_FLAGS_PRIVATE_MAPTO0 ((sal_uInt32)0x0400)
160#define RTL_UNICODETOTEXT_FLAGS_NONSPACING_IGNORE ((sal_uInt32)0x0800)
161#define RTL_UNICODETOTEXT_FLAGS_CONTROL_IGNORE ((sal_uInt32)0x1000)
162#define RTL_UNICODETOTEXT_FLAGS_PRIVATE_IGNORE ((sal_uInt32)0x2000)
163#define RTL_UNICODETOTEXT_FLAGS_NOCOMPOSITE ((sal_uInt32)0x4000)
164#define RTL_UNICODETOTEXT_FLAGS_FLUSH ((sal_uInt32)0x8000)
165#define RTL_UNICODETOTEXT_FLAGS_GLOBAL_SIGNATURE 0x10000
166 /* Write any global document signatures (for example, in UTF-8, a leading
167 EF BB BF encoding the Byte Order Mark U+FEFF) */
168
169#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_MASK ((sal_uInt32)0x000F)
170#define RTL_UNICODETOTEXT_FLAGS_INVALID_MASK ((sal_uInt32)0x00F0)
171
172#define RTL_UNICODETOTEXT_INFO_ERROR ((sal_uInt32)0x0001)
173#define RTL_UNICODETOTEXT_INFO_SRCBUFFERTOSMALL ((sal_uInt32)0x0002)
174#define RTL_UNICODETOTEXT_INFO_DESTBUFFERTOSMALL ((sal_uInt32)0x0004)
175#define RTL_UNICODETOTEXT_INFO_UNDEFINED ((sal_uInt32)0x0008)
176#define RTL_UNICODETOTEXT_INFO_INVALID ((sal_uInt32)0x0010)
177
180 SAL_DLLPUBLIC sal_Size SAL_CALL rtl_convertUnicodeToText(
181 rtl_UnicodeToTextConverter hConverter,
182 rtl_UnicodeToTextContext hContext,
183 const sal_Unicode* pSrcBuf, sal_Size nSrcChars,
184 char* pDestBuf, sal_Size nDestBytes,
185 sal_uInt32 nFlags, sal_uInt32* pInfo,
186 sal_Size* pSrcCvtChars );
187
188#ifdef __cplusplus
189}
190#endif
191
192#endif // INCLUDED_RTL_TEXTCVT_H
193
194/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
config.h
types.h
sal_Unicode
sal_uInt16 sal_Unicode
Definition types.h:123
saldllapi.h
SAL_DLLPUBLIC
#define SAL_DLLPUBLIC
Definition saldllapi.h:34
rtl_convertTextToUnicode
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
rtl_TextToUnicodeContext
void * rtl_TextToUnicodeContext
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
Definition textcvt.h:46
rtl_resetTextToUnicodeContext
SAL_DLLPUBLIC void rtl_resetTextToUnicodeContext(rtl_TextToUnicodeConverter hConverter, rtl_TextToUnicodeContext hContext)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
rtl_destroyUnicodeToTextConverter
SAL_DLLPUBLIC void rtl_destroyUnicodeToTextConverter(rtl_UnicodeToTextConverter hConverter)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
rtl_createTextToUnicodeContext
SAL_DLLPUBLIC rtl_TextToUnicodeContext rtl_createTextToUnicodeContext(rtl_TextToUnicodeConverter hConverter)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
rtl_UnicodeToTextConverter
void * rtl_UnicodeToTextConverter
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
Definition textcvt.h:119
rtl_createUnicodeToTextConverter
SAL_DLLPUBLIC rtl_UnicodeToTextConverter rtl_createUnicodeToTextConverter(rtl_TextEncoding eTextEncoding)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
rtl_convertUnicodeToText
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
rtl_destroyTextToUnicodeConverter
SAL_DLLPUBLIC void rtl_destroyTextToUnicodeConverter(rtl_TextToUnicodeConverter hConverter)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
rtl_destroyTextToUnicodeContext
SAL_DLLPUBLIC void rtl_destroyTextToUnicodeContext(rtl_TextToUnicodeConverter hConverter, rtl_TextToUnicodeContext hContext)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
rtl_UnicodeToTextContext
void * rtl_UnicodeToTextContext
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
Definition textcvt.h:123
rtl_destroyUnicodeToTextContext
SAL_DLLPUBLIC void rtl_destroyUnicodeToTextContext(rtl_UnicodeToTextConverter hConverter, rtl_UnicodeToTextContext hContext)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
rtl_TextToUnicodeConverter
void * rtl_TextToUnicodeConverter
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
Definition textcvt.h:42
rtl_resetUnicodeToTextContext
SAL_DLLPUBLIC void rtl_resetUnicodeToTextContext(rtl_UnicodeToTextConverter hConverter, rtl_UnicodeToTextContext hContext)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
rtl_createTextToUnicodeConverter
SAL_DLLPUBLIC rtl_TextToUnicodeConverter rtl_createTextToUnicodeConverter(rtl_TextEncoding eTextEncoding)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
rtl_createUnicodeToTextContext
SAL_DLLPUBLIC rtl_UnicodeToTextContext rtl_createUnicodeToTextContext(rtl_UnicodeToTextConverter hConverter)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
textenc.h
rtl_TextEncoding
sal_uInt16 rtl_TextEncoding
The various supported text encodings.
Definition textenc.h:37