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     sal_Int16 from;
  32     sal_Int16 to;
  33     sal_Int16 value;
  34 };
  35
  36 class I18NUTIL_DLLPUBLIC unicode
  37 {
  38 public:
  39
  40     static sal_Int16 SAL_CALL getUnicodeType( const sal_Unicode ch );
  41     static sal_Int16 SAL_CALL getUnicodeScriptType( const sal_Unicode ch, const ScriptTypeList *typeList = nullptr, sal_Int16 unknownType = 0 );
  42     static sal_Unicode SAL_CALL getUnicodeScriptStart(css::i18n::UnicodeScript type);
  43     static sal_Unicode SAL_CALL getUnicodeScriptEnd(css::i18n::UnicodeScript type);
  44     static sal_uInt8 SAL_CALL getUnicodeDirection( const sal_Unicode ch );
  45     static bool SAL_CALL isControl( const sal_Unicode ch);
  46     static bool SAL_CALL isAlpha( const sal_Unicode ch);
  47     static bool SAL_CALL isSpace( const sal_Unicode ch);
  48     static bool SAL_CALL isWhiteSpace( const sal_Unicode ch);
  49
  50     //Map an ISO 15924 script code to Latin/Asian/Complex/Weak
  51     static sal_Int16 SAL_CALL getScriptClassFromUScriptCode(UScriptCode eScript);
  52
  53     //Return a language that can be written in a given ISO 15924 script code
  54     static OString SAL_CALL getExemplarLanguageForUScriptCode(UScriptCode eScript);
  55
  56     //Format a number as a percentage according to the rules of the given
  57     //language, e.g. 100 -> "100%" for en-US vs "100 %" for de-DE
  58     static OUString SAL_CALL formatPercent(double dNumber,
  59         const LanguageTag &rLangTag);
  60 };
  61
  62 /*
  63     Toggle between a character and its Unicode Notation.
  64         -implements the concept found in Microsoft Word's Alt-X
  65         -accepts sequences of up to 8 hex characters and converts into the corresponding Unicode Character
  66             -example:  0000A78c   or   2bc
  67         -accepts sequences of up to 256 characters in Unicode notation
  68             -example:  U+00000065u+0331u+308
  69         -handles complex characters (with combining elements) and the all of the Unicode planes.
  70 */
  71 class I18NUTIL_DLLPUBLIC ToggleUnicodeCodepoint
  72 {
  73 private:
  74     OUStringBuffer maInput;
  75     OUStringBuffer maUtf16;
  76     OUStringBuffer maCombining;
  77     bool mbAllowMoreChars = true;
  78     bool mbRequiresU = false;
  79     bool mbIsHexString = false;
  80
  81 public:
  82     /**
  83     Build an input string of valid UTF16 units to toggle.
  84         -do not call the other functions until the input process is complete
  85         -build string from Right to Left.  (Start from the character to the left of the cursor: move left.)
  86     */
  87     bool AllowMoreInput(sal_Unicode uChar);
  88
  89     /**
  90     Validates (and potentially modifies) the input string.
  91         -all non-input functions must use this function to first to validate the input string
  92         -additional input may be prevented after this function is called
  93     */
  94     OUString StringToReplace();
  95     OUString ReplacementString();
  96
  97     /**
  98     While sInput.getLength() returns the number of utf16 units to delete,
  99         this function returns the number of "characters" to delete - potentially a smaller number
 100     */
 101     sal_uInt32 CharsToDelete();
 102 };
 103
 104 #endif
 105
 106
 107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */