dali-toolkit/internal/text/bidirectional-support.h

   1 #ifndef DALI_TOOLKIT_TEXT_BIDIRECTIONAL_SUPPORT_H
   2 #define DALI_TOOLKIT_TEXT_BIDIRECTIONAL_SUPPORT_H
   3
   4 /*
   5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-vector.h>
  23 #include <dali/public-api/actors/actor-enumerations.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/internal/text/bidirectional-line-info-run.h>
  27 #include <dali-toolkit/internal/text/bidirectional-paragraph-info-run.h>
  28 #include <dali-toolkit/internal/text/line-run.h>
  29 #include <dali-toolkit/internal/text/script-run.h>
  30
  31 namespace Dali
  32 {
  33
  34 namespace Toolkit
  35 {
  36
  37 namespace Text
  38 {
  39
  40 /**
  41  * Sets the bidirectional info into the logical model.
  42  *
  43  * @param[in] text Vector of UTF-32 characters.
  44  * @param[in] scripts Vector containing the script runs for the whole text.
  45  * @param[in] lineBreakInfo The line break info.
  46  * @param[in] startIndex The character from where the bidirectional info is set.
  47  * @param[in] numberOfCharacters The number of characters.
  48  * @param[out] bidirectionalInfo Vector with the bidirectional infor for each paragraph.
  49  * @param[in] matchSystemLanguageDirection Whether match for system language direction or not.
  50  * @param[in] layoutDirection The direction of the system language.
  51  */
  52 void SetBidirectionalInfo( const Vector<Character>& text,
  53                            const Vector<ScriptRun>& scripts,
  54                            const Vector<LineBreakInfo>& lineBreakInfo,
  55                            CharacterIndex startIndex,
  56                            Length numberOfCharacters,
  57                            Vector<BidirectionalParagraphInfoRun>& bidirectionalInfo,
  58                            bool matchSystemLanguageDirection = false,
  59                            Dali::LayoutDirection::Type layoutDirection = LayoutDirection::LEFT_TO_RIGHT );
  60
  61 /**
  62  * @brief Sets the visual to logical map table for a given line.
  63  *
  64  * @param[in] bidirectionalParagraphInfo The paragraph's bidirectional info.
  65  * @param[out] lineInfoRuns Line runs with the visual to logical conversion maps.
  66  * @param[in] bidiLineIndex Index to the line's bidirectional info.
  67  * @param[in] startIndex The character from where the bidirectional info is set.
  68  * @param[in] numberOfCharacters The number of characters.
  69  * @param[in] direction The direction of the line.
  70  */
  71 void ReorderLine( const BidirectionalParagraphInfoRun& bidirectionalParagraphInfo,
  72                   Vector<BidirectionalLineInfoRun>& lineInfoRuns,
  73                   BidirectionalLineRunIndex bidiLineIndex,
  74                   CharacterIndex startIndex,
  75                   Length numberOfCharacters,
  76                   CharacterDirection direction );
  77
  78 /**
  79  * @brief Replaces any character in the right to left paragraphs which could be mirrored.
  80  *
  81  * @param[in] text The text.
  82  * @param[in] directions Vector with the direction of each paragraph.
  83  * @param[in] bidirectionalInfo Vector with the bidirectional infor for each paragraph.
  84  * @param[in] startIndex The character from where the text is mirrored.
  85  * @param[in] numberOfCharacters The number of characters.
  86  * @param[out] mirroredText The mirroredText.
  87  *
  88  * @return @e true if a character has been replaced.
  89  */
  90 bool GetMirroredText( const Vector<Character>& text,
  91                       const Vector<CharacterDirection>& directions,
  92                       const Vector<BidirectionalParagraphInfoRun>& bidirectionalInfo,
  93                       CharacterIndex startIndex,
  94                       Length numberOfCharacters,
  95                       Vector<Character>& mirroredText );
  96
  97 /**
  98  * @brief Retrieves the characters' directions.
  99  *
 100  * @pre The @p logicalModel needs to have a text set.
 101  * @pre The @p logicalModel needs to have the bidirectional info indices for each paragraph set.
 102  *
 103  * @param[in] bidirectionalInfo Vector with the bidirectional infor for each paragraph.
 104  * @param[in] totalNumberOfCharacters The number of characters of the whole text.
 105  * @param[in] startIndex The character from where the direction info is set.
 106  * @param[in] numberOfCharacters The number of characters.
 107  * @param[out] directions The direction, @e false is left to right and @e true is right to left, of each character of the paragraph.
 108  */
 109 void GetCharactersDirection( const Vector<BidirectionalParagraphInfoRun>& bidirectionalInfo,
 110                              Length totalNumberOfCharacters,
 111                              CharacterIndex startIndex,
 112                              Length numberOfCharacters,
 113                              Vector<CharacterDirection>& directions );
 114
 115 } // namespace Text
 116
 117 } // namespace Toolkit
 118
 119 } // namespace Dali
 120
 121 #endif // DALI_TOOLKIT_TEXT_BIDIRECTIONAL_SUPPORT_H