LibreOffice
LibreOffice 7.1 SDK C/C++ API Reference
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#ifndef INCLUDED_RTL_TEXTCVT_H
21#define INCLUDED_RTL_TEXTCVT_H
22
23#include "sal/config.h"
24
25#include "rtl/textenc.h"
26#include "sal/saldllapi.h"
27#include "sal/types.h"
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33/* Documentation about this file can be found at
34 <http://udk.openoffice.org/cpp/man/spec/textconversion.html>. */
35
39
43
47
51
55
59
63
64#define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_ERROR ((sal_uInt32)0x0001)
65#define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_IGNORE ((sal_uInt32)0x0002)
66#define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_MAPTOPRIVATE ((sal_uInt32)0x0003)
67#define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_DEFAULT ((sal_uInt32)0x0004)
68#define RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_ERROR ((sal_uInt32)0x0010)
69#define RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_IGNORE ((sal_uInt32)0x0020)
70#define RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_DEFAULT ((sal_uInt32)0x0030)
71#define RTL_TEXTTOUNICODE_FLAGS_INVALID_ERROR ((sal_uInt32)0x0100)
72#define RTL_TEXTTOUNICODE_FLAGS_INVALID_IGNORE ((sal_uInt32)0x0200)
73#define RTL_TEXTTOUNICODE_FLAGS_INVALID_DEFAULT ((sal_uInt32)0x0300)
74#define RTL_TEXTTOUNICODE_FLAGS_FLUSH ((sal_uInt32)0x8000)
75#define RTL_TEXTTOUNICODE_FLAGS_GLOBAL_SIGNATURE 0x10000
76 /* Accept any global document signatures (for example, in UTF-8, a leading
77 EF BB BF encoding the Byte Order Mark U+FEFF) */
78
79#define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_MASK ((sal_uInt32)0x000F)
80#define RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_MASK ((sal_uInt32)0x00F0)
81#define RTL_TEXTTOUNICODE_FLAGS_INVALID_MASK ((sal_uInt32)0x0F00)
82
83#define RTL_TEXTTOUNICODE_INFO_ERROR ((sal_uInt32)0x0001)
84// Misspelled constant, kept for backwards compatibility:
85#define RTL_TEXTTOUNICODE_INFO_SRCBUFFERTOSMALL ((sal_uInt32)0x0002)
86#define RTL_TEXTTOUNICODE_INFO_SRCBUFFERTOOSMALL ((sal_uInt32)0x0002)
87// Misspelled constant, kept for backwards compatibility:
88#define RTL_TEXTTOUNICODE_INFO_DESTBUFFERTOSMALL ((sal_uInt32)0x0004)
89#define RTL_TEXTTOUNICODE_INFO_DESTBUFFERTOOSMALL ((sal_uInt32)0x0004)
90#define RTL_TEXTTOUNICODE_INFO_UNDEFINED ((sal_uInt32)0x0008)
91#define RTL_TEXTTOUNICODE_INFO_MBUNDEFINED ((sal_uInt32)0x0010)
92#define RTL_TEXTTOUNICODE_INFO_INVALID ((sal_uInt32)0x0020)
93
108 const char* pSrcBuf, sal_Size nSrcBytes,
109 sal_Unicode* pDestBuf, sal_Size nDestChars,
110 sal_uInt32 nFlags, sal_uInt32* pInfo,
111 sal_Size* pSrcCvtBytes );
112
116
120
124
128
132
136
140
141#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_ERROR ((sal_uInt32)0x0001)
142#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_IGNORE ((sal_uInt32)0x0002)
143#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_0 ((sal_uInt32)0x0003)
144#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_QUESTIONMARK ((sal_uInt32)0x0004)
145#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_UNDERLINE ((sal_uInt32)0x0005)
146#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_DEFAULT ((sal_uInt32)0x0006)
147#define RTL_UNICODETOTEXT_FLAGS_INVALID_ERROR ((sal_uInt32)0x0010)
148#define RTL_UNICODETOTEXT_FLAGS_INVALID_IGNORE ((sal_uInt32)0x0020)
149#define RTL_UNICODETOTEXT_FLAGS_INVALID_0 ((sal_uInt32)0x0030)
150#define RTL_UNICODETOTEXT_FLAGS_INVALID_QUESTIONMARK ((sal_uInt32)0x0040)
151#define RTL_UNICODETOTEXT_FLAGS_INVALID_UNDERLINE ((sal_uInt32)0x0050)
152#define RTL_UNICODETOTEXT_FLAGS_INVALID_DEFAULT ((sal_uInt32)0x0060)
153#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_REPLACE ((sal_uInt32)0x0100)
154#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_REPLACESTR ((sal_uInt32)0x0200)
155#define RTL_UNICODETOTEXT_FLAGS_PRIVATE_MAPTO0 ((sal_uInt32)0x0400)
156#define RTL_UNICODETOTEXT_FLAGS_NONSPACING_IGNORE ((sal_uInt32)0x0800)
157#define RTL_UNICODETOTEXT_FLAGS_CONTROL_IGNORE ((sal_uInt32)0x1000)
158#define RTL_UNICODETOTEXT_FLAGS_PRIVATE_IGNORE ((sal_uInt32)0x2000)
159#define RTL_UNICODETOTEXT_FLAGS_NOCOMPOSITE ((sal_uInt32)0x4000)
160#define RTL_UNICODETOTEXT_FLAGS_FLUSH ((sal_uInt32)0x8000)
161#define RTL_UNICODETOTEXT_FLAGS_GLOBAL_SIGNATURE 0x10000
162 /* Write any global document signatures (for example, in UTF-8, a leading
163 EF BB BF encoding the Byte Order Mark U+FEFF) */
164
165#define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_MASK ((sal_uInt32)0x000F)
166#define RTL_UNICODETOTEXT_FLAGS_INVALID_MASK ((sal_uInt32)0x00F0)
167
168#define RTL_UNICODETOTEXT_INFO_ERROR ((sal_uInt32)0x0001)
169#define RTL_UNICODETOTEXT_INFO_SRCBUFFERTOSMALL ((sal_uInt32)0x0002)
170#define RTL_UNICODETOTEXT_INFO_DESTBUFFERTOSMALL ((sal_uInt32)0x0004)
171#define RTL_UNICODETOTEXT_INFO_UNDEFINED ((sal_uInt32)0x0008)
172#define RTL_UNICODETOTEXT_INFO_INVALID ((sal_uInt32)0x0010)
173
179 const sal_Unicode* pSrcBuf, sal_Size nSrcChars,
180 char* pDestBuf, sal_Size nDestBytes,
181 sal_uInt32 nFlags, sal_uInt32* pInfo,
182 sal_Size* pSrcCvtChars );
183
184#ifdef __cplusplus
185}
186#endif
187
188#endif // INCLUDED_RTL_TEXTCVT_H
189
190/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
sal_uInt16 sal_Unicode
Definition: types.h:119
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
void * rtl_TextToUnicodeContext
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
Definition: textcvt.h:42
SAL_DLLPUBLIC void rtl_resetTextToUnicodeContext(rtl_TextToUnicodeConverter hConverter, rtl_TextToUnicodeContext hContext)
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_DLLPUBLIC rtl_TextToUnicodeContext rtl_createTextToUnicodeContext(rtl_TextToUnicodeConverter hConverter)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
void * rtl_UnicodeToTextConverter
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
Definition: textcvt.h:115
SAL_DLLPUBLIC rtl_UnicodeToTextConverter rtl_createUnicodeToTextConverter(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_destroyTextToUnicodeConverter(rtl_TextToUnicodeConverter hConverter)
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
void * rtl_UnicodeToTextContext
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
Definition: textcvt.h:119
SAL_DLLPUBLIC void rtl_destroyUnicodeToTextContext(rtl_UnicodeToTextConverter hConverter, rtl_UnicodeToTextContext hContext)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
void * rtl_TextToUnicodeConverter
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
Definition: textcvt.h:38
SAL_DLLPUBLIC void rtl_resetUnicodeToTextContext(rtl_UnicodeToTextConverter hConverter, rtl_UnicodeToTextContext 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 rtl_UnicodeToTextContext rtl_createUnicodeToTextContext(rtl_UnicodeToTextConverter hConverter)
see http://udk.openoffice.org/cpp/man/spec/textconversion.html
sal_uInt16 rtl_TextEncoding
The various supported text encodings.
Definition: textenc.h:33