dali-toolkit/internal/text/logical-model-impl.h

   1 #ifndef __DALI_TOOLKIT_TEXT_LOGICAL_MODEL_IMPL_H__
   2 #define __DALI_TOOLKIT_TEXT_LOGICAL_MODEL_IMPL_H__
   3
   4 /*
   5  * Copyright (c) 2015 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/common/intrusive-ptr.h>
  24 #include <dali/public-api/object/ref-object.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/internal/text/bidirectional-line-info-run.h>
  28 #include <dali-toolkit/internal/text/bidirectional-paragraph-info-run.h>
  29 #include <dali-toolkit/internal/text/color-run.h>
  30 #include <dali-toolkit/internal/text/font-run.h>
  31 #include <dali-toolkit/internal/text/font-description-run.h>
  32 #include <dali-toolkit/internal/text/paragraph-run.h>
  33 #include <dali-toolkit/internal/text/script-run.h>
  34
  35 namespace Dali
  36 {
  37
  38 namespace Toolkit
  39 {
  40
  41 namespace Text
  42 {
  43
  44 class LogicalModel;
  45 typedef IntrusivePtr<LogicalModel> LogicalModelPtr;
  46 struct InputStyle;
  47
  48 /**
  49  * @brief A logical text model contains layout independent information.
  50  *
  51  * This includes:
  52  * - A series of UTF-32 characters in logical order
  53  */
  54 class LogicalModel : public RefObject
  55 {
  56 public:
  57
  58   /**
  59    * @brief Create a new instance of a LogicalModel.
  60    *
  61    * @return A pointer to a new LogicalModel.
  62    */
  63   static LogicalModelPtr New();
  64
  65   // Language support interface.
  66
  67   /**
  68    * @brief Retrieves the script for the given character index.
  69    *
  70    * @param[in] characterIndex Index to the character.
  71    *
  72    * @return The character's script.
  73    */
  74   Script GetScript( CharacterIndex characterIndex ) const;
  75
  76   // Bidirectional support interface.
  77
  78   /**
  79    * @brief Retrieves the direction of a characters.
  80    *
  81    * See GetCharacterDirections().
  82    *
  83    * @param[in] characterIndex Index to a character.
  84    *
  85    * @return The character's direction.
  86    */
  87   CharacterDirection GetCharacterDirection( CharacterIndex characterIndex ) const;
  88
  89   // Visual <--> Logical conversion tables.
  90
  91   /**
  92    * @brief Retrieves the logical cursor index for the given visual cursor index.
  93    *
  94    * @pre The method FetchBidirectionalLineInfo() must be called before. If the result of FetchBidirectionalLineInfo() is false,
  95    *      then the character is not in a bidirectional line and the result will be invalid.
  96    *
  97    * @param[in] visualCursorIndex The visual cursor index.
  98    *
  99    * @return The logical cursor index.
 100    */
 101   CharacterIndex GetLogicalCursorIndex( CharacterIndex visualCursorIndex );
 102
 103   /**
 104    * @brief Retrieves the logical character index for the given visual character index.
 105    *
 106    * @pre The method FetchBidirectionalLineInfo() must be called before. If the result of FetchBidirectionalLineInfo() is false,
 107    *      then the character is not in a bidirectional line and the result will be invalid.
 108    *
 109    * @param[in] visualCharacterIndex The visual character index.
 110    *
 111    * @return The logical character index.
 112    */
 113   CharacterIndex GetLogicalCharacterIndex( CharacterIndex visualCharacterIndex );
 114
 115   /**
 116    * @brief Fetch the bidirectional line info for the given character.
 117    *
 118    * Call GetBidirectionalLineInfo() to retrieve the last fetched line.
 119    *
 120    * @param[in] characterIndex The character index.
 121    *
 122    * @return @e true if the given @e character is in a bidirectional line.
 123    */
 124   bool FetchBidirectionalLineInfo( CharacterIndex characterIndex );
 125
 126   /**
 127    * @brief Retrieves the last fetched bidirectional line info.
 128    *
 129    * @return The index of the bidirectional line info.
 130    */
 131   BidirectionalLineRunIndex GetBidirectionalLineInfo() const;
 132
 133   // Text style.
 134
 135   /**
 136    * @brief Updates the text's style runs with the added or removed text.
 137    *
 138    * @param[in] index The character's index.
 139    * @param[in] numberOfCharacters The number of characters added or removed. If the value is negative the characters are removed.
 140    */
 141   void UpdateTextStyleRuns( CharacterIndex index, int numberOfCharacters );
 142
 143   /**
 144    * @brief Retrieves the text's style for the given character index.
 145    *
 146    * @param[in] index The character index.
 147    * @param[out] style The text's style in the given style.
 148    */
 149   void RetrieveStyle( CharacterIndex index, InputStyle& style );
 150
 151   /**
 152    * @brief Clears the font description runs.
 153    */
 154   void ClearFontDescriptionRuns();
 155
 156   // Paragraphs
 157
 158   /**
 159    * @brief Creates the paragraph info.
 160    *
 161    * @pre The line break info must be set.
 162    *
 163    * @param[in] startIndex The character from where the paragraph info is set.
 164    * @param[in] numberOfCharacters The number of characters.
 165    */
 166   void CreateParagraphInfo( CharacterIndex startIndex,
 167                             Length numberOfCharacters );
 168
 169   /**
 170    * @brief Find the paragraphs which contains the given characters.
 171    *
 172    * @param[in] index The first character's index of the run.
 173    * @param[in] numberOfCharacters The number of characters of the run.
 174    * @param[out] paragraphs Indices to the paragraphs which contain the characters.
 175    */
 176   void FindParagraphs( CharacterIndex index,
 177                        Length numberOfCharacters,
 178                        Vector<ParagraphRunIndex>& paragraphs );
 179
 180 protected:
 181
 182   /**
 183    * @brief A reference counted object may only be deleted by calling Unreference().
 184    */
 185   virtual ~LogicalModel();
 186
 187 private:
 188
 189   /**
 190    * @brief Private constructor.
 191    */
 192   LogicalModel();
 193
 194   // Undefined
 195   LogicalModel( const LogicalModel& handle );
 196
 197   // Undefined
 198   LogicalModel& operator=( const LogicalModel& handle );
 199
 200 public:
 201
 202   Vector<Character>                     mText;
 203   Vector<ScriptRun>                     mScriptRuns;
 204   Vector<FontRun>                       mFontRuns;
 205   Vector<ColorRun>                      mColorRuns;
 206   Vector<FontDescriptionRun>            mFontDescriptionRuns;
 207   Vector<LineBreakInfo>                 mLineBreakInfo;
 208   Vector<WordBreakInfo>                 mWordBreakInfo;
 209   Vector<ParagraphRun>                  mParagraphInfo;
 210   Vector<BidirectionalParagraphInfoRun> mBidirectionalParagraphInfo;
 211   Vector<CharacterDirection>            mCharacterDirections;              ///< For each character, whether is right to left. ( @e flase is left to right, @e true right to left ).
 212   Vector<BidirectionalLineInfoRun>      mBidirectionalLineInfo;
 213
 214   BidirectionalLineRunIndex             mBidirectionalLineIndex;           ///< The last fetched bidirectional line info.
 215 };
 216
 217 } // namespace Text
 218
 219 } // namespace Toolkit
 220
 221 } // namespace Dali
 222
 223 #endif // __DALI_TOOLKIT_TEXT_LOGICAL_MODEL_IMPL_H__