include/i18nutil/unicode.hxx

   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 #ifndef INCLUDED_I18NUTIL_UNICODE_HXX
  20 #define INCLUDED_I18NUTIL_UNICODE_HXX
  21
  22 #include <com/sun/star/i18n/UnicodeScript.hpp>
  23 #include <sal/types.h>
  24 #include <rtl/ustrbuf.hxx>
  25 #include <unicode/uscript.h>
  26 #include <i18nutil/i18nutildllapi.h>
  27
  28 class LanguageTag;
  29
  30 struct ScriptTypeList
  31 {
  32     css::i18n::UnicodeScript from;
  33     css::i18n::UnicodeScript to;
  34     sal_Int16 value;
  35 };
  36
  37 class I18NUTIL_DLLPUBLIC unicode
  38 {
  39 public:
  40     static sal_Int16 getUnicodeType(const sal_Unicode ch);
  41     static sal_Int16 getUnicodeScriptType(const sal_Unicode ch, const ScriptTypeList* typeList,
  42                                           sal_Int16 unknownType = 0);
  43     static sal_Unicode getUnicodeScriptStart(css::i18n::UnicodeScript type);
  44     static sal_Unicode getUnicodeScriptEnd(css::i18n::UnicodeScript type);
  45     static sal_uInt8 getUnicodeDirection(const sal_Unicode ch);
  46     static sal_uInt32 GetMirroredChar(sal_uInt32);
  47     static bool isControl(const sal_Unicode ch);
  48     static bool isAlpha(const sal_Unicode ch);
  49     static bool isSpace(const sal_Unicode ch);
  50     static bool isWhiteSpace(const sal_Unicode ch);
  51
  52     /** Check for Unicode variation sequence selectors
  53
  54         @param nCode  A Unicode code point.
  55
  56         @return  True if code is a Unicode variation sequence selector.
  57      */
  58     static bool isIVSSelector(sal_uInt32 nCode)
  59     {
  60         return (nCode >= 0xFE00 && nCode <= 0xFE0F) // Variation Selectors block
  61                || (nCode >= 0xE0100 && nCode <= 0xE01EF); // Variation Selectors Supplement block
  62     }
  63
  64     /** Check for base characters of a CJK ideographic variation sequence (IVS)
  65
  66         @param nCode  A Unicode code point.
  67
  68         @return  True if code is a Unicode base character part of CJK IVS
  69      */
  70     static bool isCJKIVSCharacter(sal_uInt32 nCode)
  71     {
  72         return (nCode >= 0x4E00 && nCode <= 0x9FFF) // CJK Unified Ideographs
  73                || (nCode >= 0x3400 && nCode <= 0x4DBF) // CJK Unified Ideographs Extension A
  74                || (nCode >= 0x20000 && nCode <= 0x2A6DF); // CJK Unified Ideographs Extension B
  75     }
  76
  77     //Map an ISO 15924 script code to Latin/Asian/Complex/Weak
  78     static sal_Int16 getScriptClassFromUScriptCode(UScriptCode eScript);
  79
  80     //Return a language that can be written in a given ISO 15924 script code
  81     static OString getExemplarLanguageForUScriptCode(UScriptCode eScript);
  82
  83     //Format a number as a percentage according to the rules of the given
  84     //language, e.g. 100 -> "100%" for en-US vs "100 %" for de-DE
  85     static OUString formatPercent(double dNumber, const LanguageTag& rLangTag);
  86
  87     /** Map a LanguageTag's language ISO 639 code or script ISO 15924 code or
  88         language-script or locale to Latin/Asian/Complex/Weak. If more than one
  89         script is used with a language(-country) tag then the first (default)
  90         script is mapped for that language.
  91
  92         @return a css::i18n::ScriptType value.
  93      */
  94     static sal_Int16 getScriptClassFromLanguageTag(const LanguageTag& rLanguageTag);
  95 };
  96
  97 /*
  98     Toggle between a character and its Unicode Notation.
  99         -implements the concept found in Microsoft Word's Alt-X
 100         -accepts sequences of up to 8 hex characters and converts into the corresponding Unicode Character
 101             -example:  0000A78c   or   2bc
 102         -accepts sequences of up to 256 characters in Unicode notation
 103             -example:  U+00000065u+0331u+308
 104         -handles complex characters (with combining elements) and the all of the Unicode planes.
 105 */
 106 class I18NUTIL_DLLPUBLIC ToggleUnicodeCodepoint
 107 {
 108 private:
 109     OUStringBuffer maInput;
 110     OUStringBuffer maUtf16;
 111     OUStringBuffer maCombining;
 112     bool mbAllowMoreChars = true;
 113     bool mbRequiresU = false;
 114     bool mbIsHexString = false;
 115
 116 public:
 117     /**
 118     Build an input string of valid UTF16 units to toggle.
 119         -do not call the other functions until the input process is complete
 120         -build string from Right to Left.  (Start from the character to the left of the cursor: move left.)
 121     */
 122     bool AllowMoreInput(sal_Unicode uChar);
 123
 124     /**
 125     Validates (and potentially modifies) the input string.
 126         -all non-input functions must use this function to first to validate the input string
 127         -additional input may be prevented after this function is called
 128     */
 129     OUString StringToReplace();
 130     OUString ReplacementString();
 131
 132     /**
 133     While sInput.getLength() returns the number of utf16 units to delete,
 134         this function returns the number of "characters" to delete - potentially a smaller number
 135     */
 136     sal_uInt32 CharsToDelete();
 137 };
 138
 139 #endif
 140
 141 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */