sal/inc/rtl/textcvt.h

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: textcvt.h,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _RTL_TEXTCVT_H
  32 #define _RTL_TEXTCVT_H
  33
  34 #ifndef _SAL_TYPES_H
  35 #include <sal/types.h>
  36 #endif
  37 #include <rtl/textenc.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 /* Documentation about this file can be found at
  44    <http://udk.openoffice.org/cpp/man/spec/textconversion.html>. */
  45
  46 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
  47  */
  48 typedef void* rtl_TextToUnicodeConverter;
  49
  50 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
  51  */
  52 typedef void* rtl_TextToUnicodeContext;
  53
  54 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
  55  */
  56 rtl_TextToUnicodeConverter SAL_CALL rtl_createTextToUnicodeConverter( rtl_TextEncoding eTextEncoding );
  57
  58 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
  59  */
  60 void                                       SAL_CALL rtl_destroyTextToUnicodeConverter( rtl_TextToUnicodeConverter hConverter );
  61
  62 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
  63  */
  64 rtl_TextToUnicodeContext   SAL_CALL rtl_createTextToUnicodeContext( rtl_TextToUnicodeConverter hConverter );
  65
  66 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
  67  */
  68 void                                       SAL_CALL rtl_destroyTextToUnicodeContext( rtl_TextToUnicodeConverter hConverter, rtl_TextToUnicodeContext hContext );
  69
  70 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
  71  */
  72 void                                       SAL_CALL rtl_resetTextToUnicodeContext( rtl_TextToUnicodeConverter hConverter, rtl_TextToUnicodeContext hContext );
  73
  74 #define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_ERROR                         ((sal_uInt32)0x0001)
  75 #define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_IGNORE                        ((sal_uInt32)0x0002)
  76 #define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_MAPTOPRIVATE          ((sal_uInt32)0x0003)
  77 #define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_DEFAULT                       ((sal_uInt32)0x0004)
  78 #define RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_ERROR                       ((sal_uInt32)0x0010)
  79 #define RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_IGNORE                      ((sal_uInt32)0x0020)
  80 #define RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_DEFAULT             ((sal_uInt32)0x0030)
  81 #define RTL_TEXTTOUNICODE_FLAGS_INVALID_ERROR                           ((sal_uInt32)0x0100)
  82 #define RTL_TEXTTOUNICODE_FLAGS_INVALID_IGNORE                          ((sal_uInt32)0x0200)
  83 #define RTL_TEXTTOUNICODE_FLAGS_INVALID_DEFAULT                         ((sal_uInt32)0x0300)
  84 #define RTL_TEXTTOUNICODE_FLAGS_FLUSH                                           ((sal_uInt32)0x8000)
  85 #define RTL_TEXTTOUNICODE_FLAGS_GLOBAL_SIGNATURE 0x10000
  86     /* Accept any global document signatures (for example, in UTF-8, a leading
  87        EF BB BF encoding the Byte Order Mark U+FEFF) */
  88
  89 #define RTL_TEXTTOUNICODE_FLAGS_UNDEFINED_MASK                          ((sal_uInt32)0x000F)
  90 #define RTL_TEXTTOUNICODE_FLAGS_MBUNDEFINED_MASK                        ((sal_uInt32)0x00F0)
  91 #define RTL_TEXTTOUNICODE_FLAGS_INVALID_MASK                            ((sal_uInt32)0x0F00)
  92
  93 #define RTL_TEXTTOUNICODE_INFO_ERROR                                            ((sal_uInt32)0x0001)
  94 #define RTL_TEXTTOUNICODE_INFO_SRCBUFFERTOSMALL                         ((sal_uInt32)0x0002)
  95 #define RTL_TEXTTOUNICODE_INFO_DESTBUFFERTOSMALL                        ((sal_uInt32)0x0004)
  96 #define RTL_TEXTTOUNICODE_INFO_UNDEFINED                                        ((sal_uInt32)0x0008)
  97 #define RTL_TEXTTOUNICODE_INFO_MBUNDEFINED                                      ((sal_uInt32)0x0010)
  98 #define RTL_TEXTTOUNICODE_INFO_INVALID                                          ((sal_uInt32)0x0020)
  99
 100 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 101  */
 102 sal_Size SAL_CALL rtl_convertTextToUnicode( rtl_TextToUnicodeConverter hConverter,
 103                                             rtl_TextToUnicodeContext hContext,
 104                                             const sal_Char* pSrcBuf, sal_Size nSrcBytes,
 105                                             sal_Unicode* pDestBuf, sal_Size nDestChars,
 106                                             sal_uInt32 nFlags, sal_uInt32* pInfo,
 107                                             sal_Size* pSrcCvtBytes );
 108
 109 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 110  */
 111 typedef void* rtl_UnicodeToTextConverter;
 112
 113 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 114  */
 115 typedef void* rtl_UnicodeToTextContext;
 116
 117 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 118  */
 119 rtl_UnicodeToTextConverter SAL_CALL rtl_createUnicodeToTextConverter( rtl_TextEncoding eTextEncoding );
 120
 121 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 122  */
 123 void                                       SAL_CALL rtl_destroyUnicodeToTextConverter( rtl_UnicodeToTextConverter hConverter );
 124
 125 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 126  */
 127 rtl_UnicodeToTextContext   SAL_CALL rtl_createUnicodeToTextContext( rtl_UnicodeToTextConverter hConverter );
 128
 129 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 130  */
 131 void                                       SAL_CALL rtl_destroyUnicodeToTextContext( rtl_UnicodeToTextConverter hConverter, rtl_UnicodeToTextContext hContext );
 132
 133 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 134  */
 135 void                                       SAL_CALL rtl_resetUnicodeToTextContext( rtl_UnicodeToTextConverter hConverter, rtl_UnicodeToTextContext hContext );
 136
 137 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_ERROR                         ((sal_uInt32)0x0001)
 138 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_IGNORE                        ((sal_uInt32)0x0002)
 139 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_0                             ((sal_uInt32)0x0003)
 140 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_QUESTIONMARK          ((sal_uInt32)0x0004)
 141 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_UNDERLINE             ((sal_uInt32)0x0005)
 142 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_DEFAULT                       ((sal_uInt32)0x0006)
 143 #define RTL_UNICODETOTEXT_FLAGS_INVALID_ERROR                           ((sal_uInt32)0x0010)
 144 #define RTL_UNICODETOTEXT_FLAGS_INVALID_IGNORE                          ((sal_uInt32)0x0020)
 145 #define RTL_UNICODETOTEXT_FLAGS_INVALID_0                                       ((sal_uInt32)0x0030)
 146 #define RTL_UNICODETOTEXT_FLAGS_INVALID_QUESTIONMARK            ((sal_uInt32)0x0040)
 147 #define RTL_UNICODETOTEXT_FLAGS_INVALID_UNDERLINE                       ((sal_uInt32)0x0050)
 148 #define RTL_UNICODETOTEXT_FLAGS_INVALID_DEFAULT                         ((sal_uInt32)0x0060)
 149 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_REPLACE                       ((sal_uInt32)0x0100)
 150 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_REPLACESTR            ((sal_uInt32)0x0200)
 151 #define RTL_UNICODETOTEXT_FLAGS_PRIVATE_MAPTO0                          ((sal_uInt32)0x0400)
 152 #define RTL_UNICODETOTEXT_FLAGS_NONSPACING_IGNORE                       ((sal_uInt32)0x0800)
 153 #define RTL_UNICODETOTEXT_FLAGS_CONTROL_IGNORE                          ((sal_uInt32)0x1000)
 154 #define RTL_UNICODETOTEXT_FLAGS_PRIVATE_IGNORE                          ((sal_uInt32)0x2000)
 155 #define RTL_UNICODETOTEXT_FLAGS_NOCOMPOSITE                             ((sal_uInt32)0x4000)
 156 #define RTL_UNICODETOTEXT_FLAGS_FLUSH                                           ((sal_uInt32)0x8000)
 157 #define RTL_UNICODETOTEXT_FLAGS_GLOBAL_SIGNATURE 0x10000
 158     /* Write any global document signatures (for example, in UTF-8, a leading
 159        EF BB BF encoding the Byte Order Mark U+FEFF) */
 160
 161 #define RTL_UNICODETOTEXT_FLAGS_UNDEFINED_MASK                          ((sal_uInt32)0x000F)
 162 #define RTL_UNICODETOTEXT_FLAGS_INVALID_MASK                            ((sal_uInt32)0x00F0)
 163
 164 #define RTL_UNICODETOTEXT_INFO_ERROR                                            ((sal_uInt32)0x0001)
 165 #define RTL_UNICODETOTEXT_INFO_SRCBUFFERTOSMALL                         ((sal_uInt32)0x0002)
 166 #define RTL_UNICODETOTEXT_INFO_DESTBUFFERTOSMALL                        ((sal_uInt32)0x0004)
 167 #define RTL_UNICODETOTEXT_INFO_UNDEFINED                                        ((sal_uInt32)0x0008)
 168 #define RTL_UNICODETOTEXT_INFO_INVALID                                          ((sal_uInt32)0x0010)
 169
 170 /** see http://udk.openoffice.org/cpp/man/spec/textconversion.html
 171  */
 172 sal_Size SAL_CALL rtl_convertUnicodeToText( rtl_UnicodeToTextConverter hConverter,
 173                                             rtl_UnicodeToTextContext hContext,
 174                                             const sal_Unicode* pSrcBuf, sal_Size nSrcChars,
 175                                             sal_Char* pDestBuf, sal_Size nDestBytes,
 176                                             sal_uInt32 nFlags, sal_uInt32* pInfo,
 177                                             sal_Size* pSrcCvtChars );
 178
 179 #ifdef __cplusplus
 180 }
 181 #endif
 182
 183 #endif /* _RTL_TEXTCVT_H */