sal/textenc/textenc.cxx

   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 /* TODO! This file should not be called textenc.c, because it is not the
  21    implementation of rtl/textenc.h.  Rather, it should be called
  22    gettextencodingdata.c. */
  23
  24 #include <sal/config.h>
  25
  26 #include <cstddef>
  27 #include <cstdlib>
  28
  29 #include <osl/module.hxx>
  30 #include <rtl/instance.hxx>
  31 #include <rtl/textenc.h>
  32 #include <rtl/ustring.h>
  33 #include <rtl/ustring.hxx>
  34 #include <sal/log.hxx>
  35 #include <sal/macros.h>
  36 #include <sal/types.h>
  37
  38 #include "convertsimple.hxx"
  39 #include "gettextencodingdata.hxx"
  40 #include "tcvtbyte.hxx"
  41 #include "tcvtutf8.hxx"
  42 #include "tenchelp.hxx"
  43
  44 #define NOTABUNI_START 0xFF
  45 #define NOTABUNI_END 0x00
  46
  47 #define NOTABCHAR_START 0xFFFF
  48 #define NOTABCHAR_END 0x0000
  49
  50 #define SAME8090UNI_START 0x80
  51 #define SAME8090UNI_END 0x9F
  52 static sal_uInt16 const aImpl8090SameToUniTab[SAME8090UNI_END
  53                                                   - SAME8090UNI_START
  54                                                   + 1]
  55 = { 0x0080, 0x0081, 0x0082, 0x0083, 0x0084, 0x0085, 0x0086, 0x0087, /* 0x80 */
  56     0x0088, 0x0089, 0x008A, 0x008B, 0x008C, 0x008D, 0x008E, 0x008F,
  57     0x0090, 0x0091, 0x0092, 0x0093, 0x0094, 0x0095, 0x0096, 0x0097, /* 0x90 */
  58     0x0098, 0x0099, 0x009A, 0x009B, 0x009C, 0x009D, 0x009E, 0x009F };
  59
  60 #define SAME8090CHAR_START 0x0080
  61 #define SAME8090CHAR_END 0x009F
  62 static unsigned char const aImpl8090SameToCharTab[SAME8090CHAR_END
  63                                                   - SAME8090CHAR_START
  64                                                   + 1]
  65     = { 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, /* 0x0080 */
  66         0x88, 0x89, 0x8A, 0x8B, 0x8C, 0x8D, 0x8E, 0x8F,
  67         0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, /* 0x0090 */
  68         0x98, 0x99, 0x9A, 0x9B, 0x9C, 0x9D, 0x9E, 0x9F };
  69
  70 #define SAMEA0FFCHAR_START 0x00A0
  71 #define SAMEA0FFCHAR_END 0x00FF
  72 static unsigned char const aImplA0FFSameToCharTab[SAMEA0FFCHAR_END
  73                                                   - SAMEA0FFCHAR_START
  74                                                   + 1]
  75     = { 0xA0, 0xA1, 0xA2, 0xA3, 0xA4, 0xA5, 0xA6, 0xA7, /* 0x00A0 */
  76         0xA8, 0xA9, 0xAA, 0xAB, 0xAC, 0xAD, 0xAE, 0xAF,
  77         0xB0, 0xB1, 0xB2, 0xB3, 0xB4, 0xB5, 0xB6, 0xB7, /* 0x00B0 */
  78         0xB8, 0xB9, 0xBA, 0xBB, 0xBC, 0xBD, 0xBE, 0xBF,
  79         0xC0, 0xC1, 0xC2, 0xC3, 0xC4, 0xC5, 0xC6, 0xC7, /* 0x00C0 */
  80         0xC8, 0xC9, 0xCA, 0xCB, 0xCC, 0xCD, 0xCE, 0xCF,
  81         0xD0, 0xD1, 0xD2, 0xD3, 0xD4, 0xD5, 0xD6, 0xD7, /* 0x00D0 */
  82         0xD8, 0xD9, 0xDA, 0xDB, 0xDC, 0xDD, 0xDE, 0xDF,
  83         0xE0, 0xE1, 0xE2, 0xE3, 0xE4, 0xE5, 0xE6, 0xE7, /* 0x00E0 */
  84         0xE8, 0xE9, 0xEA, 0xEB, 0xEC, 0xED, 0xEE, 0xEF,
  85         0xF0, 0xF1, 0xF2, 0xF3, 0xF4, 0xF5, 0xF6, 0xF7, /* 0x00F0 */
  86         0xF8, 0xF9, 0xFA, 0xFB, 0xFC, 0xFD, 0xFE, 0xFF };
  87
  88 /* ======================================================================= */
  89
  90 /* MS-1252 */
  91 /* Windows Standard CharSet (ANSI) for Western Script */
  92 /* 1-Byte, 0x00-0x7F ASCII without exception */
  93 /* Convert-Tables: mappings/vendors/micsft/windows/cp1252.txt from 04/15/98 Version 2.01 */
  94 /* Last-Changes from us: */
  95
  96 /* ----------------------------------------------------------------------- */
  97
  98 #define MS1252UNI_START                 0x80
  99 #define MS1252UNI_END                   0xFF
 100 static sal_uInt16 const aImplMS1252ToUniTab[MS1252UNI_END - MS1252UNI_START + 1] =
 101 {
 102 /*       0       1       2       3       4       5       6       7 */
 103 /*       8       9       A       B       C       D       E       F */
 104     0x20AC,      0, 0x201A, 0x0192, 0x201E, 0x2026, 0x2020, 0x2021, /* 0x80 */
 105     0x02C6, 0x2030, 0x0160, 0x2039, 0x0152,      0, 0x017D,      0, /* 0x80 */
 106          0, 0x2018, 0x2019, 0x201C, 0x201D, 0x2022, 0x2013, 0x2014, /* 0x90 */
 107     0x02DC, 0x2122, 0x0161, 0x203A, 0x0153,      0, 0x017E, 0x0178, /* 0x90 */
 108     0x00A0, 0x00A1, 0x00A2, 0x00A3, 0x00A4, 0x00A5, 0x00A6, 0x00A7, /* 0xA0 */
 109     0x00A8, 0x00A9, 0x00AA, 0x00AB, 0x00AC, 0x00AD, 0x00AE, 0x00AF, /* 0xA0 */
 110     0x00B0, 0x00B1, 0x00B2, 0x00B3, 0x00B4, 0x00B5, 0x00B6, 0x00B7, /* 0xB0 */
 111     0x00B8, 0x00B9, 0x00BA, 0x00BB, 0x00BC, 0x00BD, 0x00BE, 0x00BF, /* 0xB0 */
 112     0x00C0, 0x00C1, 0x00C2, 0x00C3, 0x00C4, 0x00C5, 0x00C6, 0x00C7, /* 0xC0 */
 113     0x00C8, 0x00C9, 0x00CA, 0x00CB, 0x00CC, 0x00CD, 0x00CE, 0x00CF, /* 0xC0 */
 114     0x00D0, 0x00D1, 0x00D2, 0x00D3, 0x00D4, 0x00D5, 0x00D6, 0x00D7, /* 0xD0 */
 115     0x00D8, 0x00D9, 0x00DA, 0x00DB, 0x00DC, 0x00DD, 0x00DE, 0x00DF, /* 0xD0 */
 116     0x00E0, 0x00E1, 0x00E2, 0x00E3, 0x00E4, 0x00E5, 0x00E6, 0x00E7, /* 0xE0 */
 117     0x00E8, 0x00E9, 0x00EA, 0x00EB, 0x00EC, 0x00ED, 0x00EE, 0x00EF, /* 0xE0 */
 118     0x00F0, 0x00F1, 0x00F2, 0x00F3, 0x00F4, 0x00F5, 0x00F6, 0x00F7, /* 0xF0 */
 119     0x00F8, 0x00F9, 0x00FA, 0x00FB, 0x00FC, 0x00FD, 0x00FE, 0x00FF  /* 0xF0 */
 120 };
 121
 122 /* ----------------------------------------------------------------------- */
 123
 124 #define MS1252TOCHARTABEX_COUNT         27
 125 static ImplUniCharTabData const aImplMS1252ToCharTabEx[MS1252TOCHARTABEX_COUNT] =
 126 {
 127   { 0x0152, 0x8C, 0 },
 128   { 0x0153, 0x9C, 0 },
 129   { 0x0160, 0x8A, 0 },
 130   { 0x0161, 0x9A, 0 },
 131   { 0x0178, 0x9F, 0 },
 132   { 0x017D, 0x8E, 0 },
 133   { 0x017E, 0x9E, 0 },
 134   { 0x0192, 0x83, 0 },
 135   { 0x02C6, 0x88, 0 },
 136   { 0x02DC, 0x98, 0 },
 137   { 0x2013, 0x96, 0 },
 138   { 0x2014, 0x97, 0 },
 139   { 0x2018, 0x91, 0 },
 140   { 0x2019, 0x92, 0 },
 141   { 0x201A, 0x82, 0 },
 142   { 0x201C, 0x93, 0 },
 143   { 0x201D, 0x94, 0 },
 144   { 0x201E, 0x84, 0 },
 145   { 0x2020, 0x86, 0 },
 146   { 0x2021, 0x87, 0 },
 147   { 0x2022, 0x95, 0 },
 148   { 0x2026, 0x85, 0 },
 149   { 0x2030, 0x89, 0 },
 150   { 0x2039, 0x8B, 0 },
 151   { 0x203A, 0x9B, 0 },
 152   { 0x20AC, 0x80, 0 },
 153   { 0x2122, 0x99, 0 },
 154 };
 155
 156 /* ----------------------------------------------------------------------- */
 157
 158 static ImplByteConvertData const aImplMS1252ByteCvtData =
 159 {
 160     aImplMS1252ToUniTab,
 161     nullptr,
 162     MS1252UNI_START, MS1252UNI_END,
 163     NOTABUNI_START, NOTABUNI_END,
 164     aImplA0FFSameToCharTab,
 165     nullptr,
 166     aImplMS1252ToCharTabEx,
 167     SAMEA0FFCHAR_START, SAMEA0FFCHAR_END,
 168     NOTABCHAR_START, NOTABCHAR_END,
 169     MS1252TOCHARTABEX_COUNT
 170 };
 171
 172 /* ----------------------------------------------------------------------- */
 173
 174 static ImplTextEncodingData const aImplMS1252TextEncodingData
 175     = { { &aImplMS1252ByteCvtData,
 176           sal::detail::textenc::convertCharToUnicode,
 177           sal::detail::textenc::convertUnicodeToChar,
 178           nullptr,
 179           nullptr,
 180           nullptr,
 181           nullptr,
 182           nullptr,
 183           nullptr },
 184         1,
 185         1,
 186         1,
 187         0,
 188         "iso8859-1",
 189         "windows-1252",
 190         RTL_TEXTENCODING_INFO_ASCII | RTL_TEXTENCODING_INFO_MIME };
 191     /* WIN, SCRIPT_LATIN, pc code page 850 */
 192
 193 /* ======================================================================= */
 194
 195 /* ISO-8859-1 */
 196 /* Unix Standard CharSet (Latin1) for Western Script */
 197 /* 1-Byte, 0x00-0x7F ASCII without exception, 0x80-0x9F control character like in Unicode */
 198 /* Convert-Tables: mappings/iso8859/8859-1.txt from 07/27/99 Version 1.0 (based on Unicode 3.0) */
 199 /* Last-Changes from us: */
 200
 201 #define ISO88591UNI_START               0xA0
 202 #define ISO88591UNI_END                 0xFF
 203 static sal_uInt16 const aImplISO88591ToUniTab[ISO88591UNI_END - ISO88591UNI_START + 1] =
 204 {
 205 /*       0       1       2       3       4       5       6       7 */
 206 /*       8       9       A       B       C       D       E       F */
 207     0x00A0, 0x00A1, 0x00A2, 0x00A3, 0x00A4, 0x00A5, 0x00A6, 0x00A7, /* 0xA0 */
 208     0x00A8, 0x00A9, 0x00AA, 0x00AB, 0x00AC, 0x00AD, 0x00AE, 0x00AF, /* 0xA0 */
 209     0x00B0, 0x00B1, 0x00B2, 0x00B3, 0x00B4, 0x00B5, 0x00B6, 0x00B7, /* 0xB0 */
 210     0x00B8, 0x00B9, 0x00BA, 0x00BB, 0x00BC, 0x00BD, 0x00BE, 0x00BF, /* 0xB0 */
 211     0x00C0, 0x00C1, 0x00C2, 0x00C3, 0x00C4, 0x00C5, 0x00C6, 0x00C7, /* 0xC0 */
 212     0x00C8, 0x00C9, 0x00CA, 0x00CB, 0x00CC, 0x00CD, 0x00CE, 0x00CF, /* 0xC0 */
 213     0x00D0, 0x00D1, 0x00D2, 0x00D3, 0x00D4, 0x00D5, 0x00D6, 0x00D7, /* 0xD0 */
 214     0x00D8, 0x00D9, 0x00DA, 0x00DB, 0x00DC, 0x00DD, 0x00DE, 0x00DF, /* 0xD0 */
 215     0x00E0, 0x00E1, 0x00E2, 0x00E3, 0x00E4, 0x00E5, 0x00E6, 0x00E7, /* 0xE0 */
 216     0x00E8, 0x00E9, 0x00EA, 0x00EB, 0x00EC, 0x00ED, 0x00EE, 0x00EF, /* 0xE0 */
 217     0x00F0, 0x00F1, 0x00F2, 0x00F3, 0x00F4, 0x00F5, 0x00F6, 0x00F7, /* 0xF0 */
 218     0x00F8, 0x00F9, 0x00FA, 0x00FB, 0x00FC, 0x00FD, 0x00FE, 0x00FF  /* 0xF0 */
 219 };
 220
 221 /* ----------------------------------------------------------------------- */
 222
 223 static ImplByteConvertData const aImplISO88591ByteCvtData =
 224 {
 225     aImplISO88591ToUniTab,
 226     aImpl8090SameToUniTab,
 227     ISO88591UNI_START, ISO88591UNI_END,
 228     SAME8090UNI_START, SAME8090UNI_END,
 229     aImplA0FFSameToCharTab,
 230     aImpl8090SameToCharTab,
 231     nullptr,
 232     SAMEA0FFCHAR_START, SAMEA0FFCHAR_END,
 233     SAME8090CHAR_START, SAME8090CHAR_END,
 234     0
 235 };
 236
 237 /* ----------------------------------------------------------------------- */
 238
 239 static ImplTextEncodingData const aImplISO88591TextEncodingData
 240     = { { &aImplISO88591ByteCvtData,
 241           sal::detail::textenc::convertCharToUnicode,
 242           sal::detail::textenc::convertUnicodeToChar,
 243           nullptr,
 244           nullptr,
 245           nullptr,
 246           nullptr,
 247           nullptr,
 248           nullptr },
 249         1,
 250         1,
 251         1,
 252         0,
 253         "iso8859-1",
 254         "iso-8859-1",
 255         RTL_TEXTENCODING_INFO_ASCII | RTL_TEXTENCODING_INFO_MIME };
 256     /* SCRIPT_LATIN, pc code page 850 */
 257
 258 /* ======================================================================= */
 259
 260 /* US-ASCII */
 261 /* 7-Bit ASCII */
 262 /* 1-Byte, 0x00-0x7F ASCII without exception */
 263 /* For the import we use ISO-8859-1 with MS extension (MS-1252), because */
 264 /* when the 8-Bit is set, the chance, that this is an ISO-8859-1 character */
 265 /* is the greatest. For the export all chars greater than 127 are not */
 266 /* converted and are replaced by the replacement character. */
 267 /* Last-Changes from us: */
 268
 269 /* ----------------------------------------------------------------------- */
 270
 271 static ImplByteConvertData const aImplUSASCIIByteCvtData =
 272 {
 273     aImplMS1252ToUniTab,
 274     nullptr,
 275     MS1252UNI_START, MS1252UNI_END,
 276     NOTABUNI_START, NOTABUNI_END,
 277     nullptr,
 278     nullptr,
 279     nullptr,
 280     NOTABCHAR_START, NOTABCHAR_END,
 281     NOTABCHAR_START, NOTABCHAR_END,
 282     0
 283 };
 284
 285 /* ----------------------------------------------------------------------- */
 286
 287 static ImplTextEncodingData const aImplUSASCIITextEncodingData
 288     = { { &aImplUSASCIIByteCvtData,
 289           sal::detail::textenc::convertCharToUnicode,
 290           sal::detail::textenc::convertUnicodeToChar,
 291           nullptr,
 292           nullptr,
 293           nullptr,
 294           nullptr,
 295           nullptr,
 296           nullptr },
 297         1,
 298         1,
 299         1,
 300         0,
 301         "iso8859-1",
 302         "us-ascii",
 303         RTL_TEXTENCODING_INFO_ASCII
 304             | RTL_TEXTENCODING_INFO_7BIT
 305             | RTL_TEXTENCODING_INFO_MIME };
 306     /* SCRIPT_LATIN, pc code page 437 */
 307
 308 static ImplTextEncodingData const aImplUTF8TextEncodingData
 309     = { { nullptr,
 310           &ImplConvertUtf8ToUnicode,
 311           &ImplConvertUnicodeToUtf8,
 312           &ImplCreateUtf8ToUnicodeContext,
 313           &ImplDestroyUtf8ToUnicodeContext,
 314           &ImplResetUtf8ToUnicodeContext,
 315           &ImplCreateUnicodeToUtf8Context,
 316           &ImplDestroyUnicodeToUtf8Context,
 317           &ImplResetUnicodeToUtf8Context },
 318         1,
 319         6,
 320         1,
 321         0,
 322         "iso8859-1",
 323         "utf-8",
 324         RTL_TEXTENCODING_INFO_ASCII
 325             | RTL_TEXTENCODING_INFO_UNICODE
 326             | RTL_TEXTENCODING_INFO_MULTIBYTE
 327             | RTL_TEXTENCODING_INFO_MIME };
 328     /* SCRIPT_UNICODE, pc code page 850 */
 329
 330 static char aImplJavaUtf8TextConverterTag;
 331     /* The value of this tag is irrelevant.  Only its address != NULL is used to
 332        distinguish between RTL_TEXTENCODING_UTF8 and
 333        RTL_TEXTENCODING_JAVA_UTF8. */
 334
 335 static ImplTextEncodingData const aImplJavaUtf8TextEncodingData
 336     = { { &aImplJavaUtf8TextConverterTag,
 337           &ImplConvertUtf8ToUnicode,
 338           &ImplConvertUnicodeToUtf8,
 339           &ImplCreateUtf8ToUnicodeContext,
 340           &ImplDestroyUtf8ToUnicodeContext,
 341           &ImplResetUtf8ToUnicodeContext,
 342           &ImplCreateUnicodeToUtf8Context,
 343           &ImplDestroyUnicodeToUtf8Context,
 344           &ImplResetUnicodeToUtf8Context },
 345         1,
 346         3,
 347         1,
 348         0,
 349         nullptr,
 350         nullptr,
 351         RTL_TEXTENCODING_INFO_UNICODE | RTL_TEXTENCODING_INFO_MULTIBYTE };
 352
 353 namespace {
 354
 355 #if defined DISABLE_DYNLOADING || defined ANDROID
 356
 357 extern "C" ImplTextEncodingData const * sal_getFullTextEncodingData(
 358     rtl_TextEncoding); // from tables.cxx in sal_textenc library
 359
 360 class FullTextEncodingData {
 361 public:
 362     ImplTextEncodingData const * get(rtl_TextEncoding encoding) {
 363         (void) this; // loplugin:staticmethods
 364         return sal_getFullTextEncodingData(encoding);
 365     }
 366     FullTextEncodingData() = default;
 367     FullTextEncodingData(const FullTextEncodingData&) = delete;
 368     FullTextEncodingData& operator=(const FullTextEncodingData&) = delete;
 369 };
 370
 371 #else
 372
 373 extern "C" {
 374
 375 typedef ImplTextEncodingData const * TextEncodingFunction(rtl_TextEncoding);
 376
 377 void thisModule() {}
 378
 379 }
 380
 381 class FullTextEncodingData {
 382 public:
 383     FullTextEncodingData() {
 384         if (!module_.loadRelative(&thisModule, SAL_MODULENAME("sal_textenclo")))
 385         {
 386             SAL_WARN( "sal.textenc", "Loading sal_textenc library failed" );
 387             std::abort();
 388         }
 389         function_ = reinterpret_cast< TextEncodingFunction * >(
 390             module_.getFunctionSymbol("sal_getFullTextEncodingData"));
 391         if (function_ == nullptr) {
 392             SAL_WARN( "sal.textenc", "Obtaining sal_getFullTextEncodingData function from sal_textenc"
 393                 " library failed");
 394             std::abort();
 395         }
 396     }
 397
 398     ImplTextEncodingData const * get(rtl_TextEncoding encoding) const {
 399         return (*function_)(encoding);
 400     }
 401
 402     FullTextEncodingData(const FullTextEncodingData&) = delete;
 403     FullTextEncodingData& operator=(const FullTextEncodingData&) = delete;
 404
 405 private:
 406     osl::Module module_;
 407     TextEncodingFunction * function_;
 408 };
 409
 410 #endif
 411
 412 struct FullTextEncodingDataSingleton:
 413     public rtl::Static< FullTextEncodingData, FullTextEncodingDataSingleton >
 414 {};
 415
 416 }
 417
 418 ImplTextEncodingData const *
 419 Impl_getTextEncodingData(rtl_TextEncoding nEncoding)
 420 {
 421     switch(nEncoding)
 422     {
 423         case RTL_TEXTENCODING_ASCII_US:
 424             return &aImplUSASCIITextEncodingData; break;
 425         case RTL_TEXTENCODING_MS_1252:
 426             return &aImplMS1252TextEncodingData; break;
 427         case RTL_TEXTENCODING_UTF8:
 428             return &aImplUTF8TextEncodingData; break;
 429         case RTL_TEXTENCODING_JAVA_UTF8:
 430             return &aImplJavaUtf8TextEncodingData; break;
 431         case RTL_TEXTENCODING_ISO_8859_1:
 432             return &aImplISO88591TextEncodingData; break;
 433         default:
 434             return FullTextEncodingDataSingleton::get().get(nEncoding);
 435     }
 436 }
 437
 438 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */