1 #ifndef __DALI_TOOLKIT_TEXT_LOGICAL_MODEL_IMPL_H__
2 #define __DALI_TOOLKIT_TEXT_LOGICAL_MODEL_IMPL_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
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/script-run.h>
44 typedef IntrusivePtr<LogicalModel> LogicalModelPtr;
48 * @brief A logical text model contains layout independent information.
51 * - A series of UTF-32 characters in logical order
53 class LogicalModel : public RefObject
58 * @brief Create a new instance of a LogicalModel.
60 * @return A pointer to a new LogicalModel.
62 static LogicalModelPtr New();
64 // Language support interface.
67 * @brief Retrieves the script for the given character index.
69 * @param[in] characterIndex Index to the character.
71 * @return The character's script.
73 Script GetScript( CharacterIndex characterIndex ) const;
75 // Bidirectional support interface.
78 * @brief Retrieves the direction of a characters.
80 * See GetCharacterDirections().
82 * @param[in] characterIndex Index to a character.
84 * @return The character's direction.
86 CharacterDirection GetCharacterDirection( CharacterIndex characterIndex ) const;
88 // Visual <--> Logical conversion tables.
91 * @brief Sets the visual to logical and the logical to visual map tables.
93 * Replaces any map tables previously set.
95 * @note If the number of runs is zero the bidirectional info buffer is cleared.
97 * @param[in] bidirectionalInfo Pointer to a buffer with all the bidirectional info runs.
98 * @param[in] numberOfRuns The number of bidirectional info runs.
100 void SetVisualToLogicalMap( const BidirectionalLineInfoRun* const bidirectionalInfo,
101 Length numberOfRuns );
104 * @brief Retrieves the logical character index for the given visual character index.
106 * @param[in] visualCharacterIndex The visual character index.
108 * @return The logical character index.
110 CharacterIndex GetLogicalCharacterIndex( CharacterIndex visualCharacterIndex ) const;
113 * @brief Updates the text's style runs with the added or removed text.
115 * @param[in] index The character's index.
116 * @param[in] numberOfCharacters The number of characters added or removed. If the value is negative the characters are removed.
118 void UpdateTextStyleRuns( CharacterIndex index, int numberOfCharacters );
121 * @brief Retrieves the text's style for the given character index.
123 * @param[in] index The character index.
124 * @param[out] style The text's style in the given style.
126 void RetrieveStyle( CharacterIndex index, InputStyle& style );
129 * @brief Clears the font description runs.
131 void ClearFontDescriptionRuns();
136 * @brief A reference counted object may only be deleted by calling Unreference().
138 virtual ~LogicalModel();
143 * @brief Private constructor.
148 LogicalModel( const LogicalModel& handle );
151 LogicalModel& operator=( const LogicalModel& handle );
155 Vector<Character> mText;
156 Vector<ScriptRun> mScriptRuns;
157 Vector<FontRun> mFontRuns;
158 Vector<ColorRun> mColorRuns;
159 Vector<FontDescriptionRun> mFontDescriptionRuns;
160 Vector<LineBreakInfo> mLineBreakInfo;
161 Vector<WordBreakInfo> mWordBreakInfo;
162 Vector<BidirectionalParagraphInfoRun> mBidirectionalParagraphInfo;
163 Vector<CharacterDirection> mCharacterDirections; ///< For each character, whether is right to left. ( @e flase is left to right, @e true right to left ).
164 Vector<BidirectionalLineInfoRun> mBidirectionalLineInfo;
165 Vector<CharacterIndex> mLogicalToVisualMap; ///< Bidirectional logical to visual conversion table.
166 Vector<CharacterIndex> mVisualToLogicalMap; ///< Bidirectional visual to logical conversion table.
167 Vector<CharacterIndex> mVisualToLogicalCursorMap; ///< Bidirectional visual to logical cursor conversion table.
172 } // namespace Toolkit
176 #endif // __DALI_TOOLKIT_TEXT_LOGICAL_MODEL_IMPL_H__