include/rtl/textcvt.h

   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
  34 extern "C" {
  35 #endif
  36
  37 /* Documentation about this file can be found at
  38    <http://udk.openoffice.org/cpp/man/spec/textconversion.html>. */
  39
  40 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
  41  */
  42 typedef void* rtl_TextToUnicodeConverter;
  43
  44 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
  45  */
  46 typedef void* rtl_TextToUnicodeContext;
  47
  48 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
  49  */
  50 SAL_DLLPUBLIC rtl_TextToUnicodeConverter SAL_CALL rtl_createTextToUnicodeConverter( rtl_TextEncoding eTextEncoding );
  51
  52 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
  53  */
  54 SAL_DLLPUBLIC void SAL_CALL rtl_destroyTextToUnicodeConverter( rtl_TextToUnicodeConverter hConverter );
  55
  56 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
  57  */
  58 SAL_DLLPUBLIC rtl_TextToUnicodeContext SAL_CALL rtl_createTextToUnicodeContext( rtl_TextToUnicodeConverter hConverter );
  59
  60 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
  61  */
  62 SAL_DLLPUBLIC void SAL_CALL rtl_destroyTextToUnicodeContext( rtl_TextToUnicodeConverter hConverter, rtl_TextToUnicodeContext hContext );
  63
  64 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
  65  */
  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
  98 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
  99
 100     Deviating from the linked specification, the behavior of
 101     RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_ERROR, RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_ERROR, and
 102     RTL_TEXTTOUNICODE_FLAGS_INVALID_ERROR is as follows:  When RTL_TEXTTOUNICODE_FLAGS_FLUSH is not
 103     set, the erroneous input bytes are consumed as required by the linked specification.  But if
 104     RTL_TEXTTOUNICODE_FLAGS_FLUSH is set, any of those erroneous input bytes that would have been
 105     consumed by this invocation of rtl_convertTextToUnicode (i.e., which had not already been
 106     captured in hContext from a previous invocation with RTL_TEXTTOUNICODE_FLAGS_FLUSH unset) are
 107     not consumed.
 108  */
 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
 117 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 118  */
 119 typedef void* rtl_UnicodeToTextConverter;
 120
 121 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 122  */
 123 typedef void* rtl_UnicodeToTextContext;
 124
 125 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 126  */
 127 SAL_DLLPUBLIC rtl_UnicodeToTextConverter SAL_CALL rtl_createUnicodeToTextConverter( rtl_TextEncoding eTextEncoding );
 128
 129 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 130  */
 131 SAL_DLLPUBLIC void SAL_CALL rtl_destroyUnicodeToTextConverter( rtl_UnicodeToTextConverter hConverter );
 132
 133 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 134  */
 135 SAL_DLLPUBLIC rtl_UnicodeToTextContext SAL_CALL rtl_createUnicodeToTextContext( rtl_UnicodeToTextConverter hConverter );
 136
 137 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 138  */
 139 SAL_DLLPUBLIC void SAL_CALL rtl_destroyUnicodeToTextContext( rtl_UnicodeToTextConverter hConverter, rtl_UnicodeToTextContext hContext );
 140
 141 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 142  */
 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) ///< has no effect @deprecated
 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
 178 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 179  */
 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: */