1 #ifndef DALI_TOOLKIT_TEXT_LOGICAL_MODEL_IMPL_H
2 #define DALI_TOOLKIT_TEXT_LOGICAL_MODEL_IMPL_H
5 * Copyright (c) 2021 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/anchor.h>
28 #include <dali-toolkit/internal/text/bidirectional-line-info-run.h>
29 #include <dali-toolkit/internal/text/bidirectional-paragraph-info-run.h>
30 #include <dali-toolkit/internal/text/color-run.h>
31 #include <dali-toolkit/internal/text/embedded-item.h>
32 #include <dali-toolkit/internal/text/font-description-run.h>
33 #include <dali-toolkit/internal/text/font-run.h>
34 #include <dali-toolkit/internal/text/paragraph-run.h>
35 #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
57 * @brief Create a new instance of a LogicalModel.
59 * @return A pointer to a new LogicalModel.
61 static LogicalModelPtr New();
63 // Language support interface.
66 * @brief Retrieves the script for the given character index.
68 * @param[in] characterIndex Index to the character.
70 * @return The character's script.
72 Script GetScript(CharacterIndex characterIndex) const;
74 // Bidirectional support interface.
77 * @brief Retrieves the direction of a characters.
79 * See GetCharacterDirections().
81 * @param[in] characterIndex Index to a character.
83 * @return The character's direction.
85 CharacterDirection GetCharacterDirection(CharacterIndex characterIndex) const;
87 // Visual <--> Logical conversion tables.
90 * @brief Retrieves the logical cursor index for the given visual cursor index.
92 * @pre The method FetchBidirectionalLineInfo() must be called before. If the result of FetchBidirectionalLineInfo() is false,
93 * then the character is not in a bidirectional line and the result will be invalid.
95 * @param[in] visualCursorIndex The visual cursor index.
97 * @return The logical cursor index.
99 CharacterIndex GetLogicalCursorIndex(CharacterIndex visualCursorIndex);
102 * @brief Retrieves the logical character index for the given visual character index.
104 * @pre The method FetchBidirectionalLineInfo() must be called before. If the result of FetchBidirectionalLineInfo() is false,
105 * then the character is not in a bidirectional line and the result will be invalid.
107 * @param[in] visualCharacterIndex The visual character index.
109 * @return The logical character index.
111 CharacterIndex GetLogicalCharacterIndex(CharacterIndex visualCharacterIndex);
114 * @brief Fetch the bidirectional line info for the given character.
116 * Call GetBidirectionalLineInfo() to retrieve the last fetched line.
118 * @param[in] characterIndex The character index.
120 * @return @e true if the given @e character is in a bidirectional line.
122 bool FetchBidirectionalLineInfo(CharacterIndex characterIndex);
125 * @brief Retrieves the last fetched bidirectional line info.
127 * @return The index of the bidirectional line info.
129 BidirectionalLineRunIndex GetBidirectionalLineInfo() const;
134 * @brief Updates the text's style runs with the added or removed text.
136 * @param[in] index The character's index.
137 * @param[in] numberOfCharacters The number of characters added or removed. If the value is negative the characters are removed.
139 void UpdateTextStyleRuns(CharacterIndex index, int numberOfCharacters);
142 * @brief Retrieves the text's style for the given character index.
144 * @param[in] index The character index.
145 * @param[out] style The text's style in the given style.
147 void RetrieveStyle(CharacterIndex index, InputStyle& style);
150 * @brief Clears the font description runs.
152 void ClearFontDescriptionRuns();
157 * @brief Creates the paragraph info.
159 * @pre The line break info must be set.
161 * @param[in] startIndex The character from where the paragraph info is set.
162 * @param[in] numberOfCharacters The number of characters.
164 void CreateParagraphInfo(CharacterIndex startIndex,
165 Length numberOfCharacters);
168 * @brief Find the paragraphs which contains the given characters.
170 * @param[in] index The first character's index of the run.
171 * @param[in] numberOfCharacters The number of characters of the run.
172 * @param[out] paragraphs Indices to the paragraphs which contain the characters.
174 void FindParagraphs(CharacterIndex index,
175 Length numberOfCharacters,
176 Vector<ParagraphRunIndex>& paragraphs);
181 * @brief Clears the embedded images.
183 void ClearEmbeddedImages();
186 * @brief Clears the anchors.
192 * @brief A reference counted object may only be deleted by calling Unreference().
194 virtual ~LogicalModel();
198 * @brief Private constructor.
203 LogicalModel(const LogicalModel& handle);
206 LogicalModel& operator=(const LogicalModel& handle);
209 Vector<Character> mText;
210 Vector<ScriptRun> mScriptRuns;
211 Vector<FontRun> mFontRuns;
212 Vector<ColorRun> mColorRuns;
213 Vector<ColorRun> mBackgroundColorRuns;
214 Vector<FontDescriptionRun> mFontDescriptionRuns;
215 Vector<LineBreakInfo> mLineBreakInfo;
216 Vector<ParagraphRun> mParagraphInfo;
217 Vector<BidirectionalParagraphInfoRun> mBidirectionalParagraphInfo;
218 Vector<CharacterDirection> mCharacterDirections; ///< For each character, whether is right to left. ( @e flase is left to right, @e true right to left ).
219 Vector<BidirectionalLineInfoRun> mBidirectionalLineInfo;
220 Vector<EmbeddedItem> mEmbeddedItems;
221 Vector<Anchor> mAnchors;
223 BidirectionalLineRunIndex mBidirectionalLineIndex; ///< The last fetched bidirectional line info.
228 } // namespace Toolkit
232 #endif // DALI_TOOLKIT_TEXT_LOGICAL_MODEL_IMPL_H