1 #ifndef DALI_TOOLKIT_TEXT_LOGICAL_MODEL_IMPL_H
2 #define DALI_TOOLKIT_TEXT_LOGICAL_MODEL_IMPL_H
5 * Copyright (c) 2022 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>
36 #include <dali-toolkit/internal/text/strikethrough-character-run.h>
37 #include <dali-toolkit/internal/text/underlined-character-run.h>
46 typedef IntrusivePtr<LogicalModel> LogicalModelPtr;
50 * @brief A logical text model contains layout independent information.
53 * - A series of UTF-32 characters in logical order
55 class LogicalModel : public RefObject
59 * @brief Create a new instance of a LogicalModel.
61 * @return A pointer to a new LogicalModel.
63 static LogicalModelPtr New();
65 // Language support interface.
68 * @brief Retrieves the script for the given character index.
70 * @param[in] characterIndex Index to the character.
72 * @return The character's script.
74 Script GetScript(CharacterIndex characterIndex) const;
76 // Bidirectional support interface.
79 * @brief Retrieves the direction of a characters.
81 * See GetCharacterDirections().
83 * @param[in] characterIndex Index to a character.
85 * @return The character's direction.
87 CharacterDirection GetCharacterDirection(CharacterIndex characterIndex) const;
89 // Visual <--> Logical conversion tables.
92 * @brief Retrieves the logical cursor index for the given visual cursor index.
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.
97 * @param[in] visualCursorIndex The visual cursor index.
99 * @return The logical cursor index.
101 CharacterIndex GetLogicalCursorIndex(CharacterIndex visualCursorIndex);
104 * @brief Retrieves the logical character index for the given visual character index.
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.
109 * @param[in] visualCharacterIndex The visual character index.
111 * @return The logical character index.
113 CharacterIndex GetLogicalCharacterIndex(CharacterIndex visualCharacterIndex);
116 * @brief Fetch the bidirectional line info for the given character.
118 * Call GetBidirectionalLineInfo() to retrieve the last fetched line.
120 * @param[in] characterIndex The character index.
122 * @return @e true if the given @e character is in a bidirectional line.
124 bool FetchBidirectionalLineInfo(CharacterIndex characterIndex);
127 * @brief Retrieves the last fetched bidirectional line info.
129 * @return The index of the bidirectional line info.
131 BidirectionalLineRunIndex GetBidirectionalLineInfo() const;
136 * @brief Updates the text's style runs with the added or removed text.
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.
141 void UpdateTextStyleRuns(CharacterIndex index, int numberOfCharacters);
144 * @brief Retrieves the text's style for the given character index.
146 * @param[in] index The character index.
147 * @param[out] style The text's style in the given style.
149 void RetrieveStyle(CharacterIndex index, InputStyle& style);
152 * @brief Clears the font description runs.
154 void ClearFontDescriptionRuns();
159 * @brief Creates the paragraph info.
161 * @pre The line break info must be set.
163 * @param[in] startIndex The character from where the paragraph info is set.
164 * @param[in] numberOfCharacters The number of characters.
166 void CreateParagraphInfo(CharacterIndex startIndex,
167 Length numberOfCharacters);
170 * @brief Find the paragraphs which contains the given characters.
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.
176 void FindParagraphs(CharacterIndex index,
177 Length numberOfCharacters,
178 Vector<ParagraphRunIndex>& paragraphs);
183 * @brief Clears the embedded images.
185 void ClearEmbeddedImages();
188 * @brief Clears the anchors.
194 * @brief A reference counted object may only be deleted by calling Unreference().
196 virtual ~LogicalModel();
200 * @brief Private constructor.
205 LogicalModel(const LogicalModel& handle);
208 LogicalModel& operator=(const LogicalModel& handle);
211 Vector<Character> mText;
212 Vector<ScriptRun> mScriptRuns;
213 Vector<FontRun> mFontRuns;
214 Vector<ColorRun> mColorRuns;
215 Vector<ColorRun> mBackgroundColorRuns;
216 Vector<FontDescriptionRun> mFontDescriptionRuns;
217 Vector<LineBreakInfo> mLineBreakInfo;
218 Vector<ParagraphRun> mParagraphInfo;
219 Vector<BidirectionalParagraphInfoRun> mBidirectionalParagraphInfo;
220 Vector<CharacterDirection> mCharacterDirections; ///< For each character, whether is right to left. ( @e flase is left to right, @e true right to left ).
221 Vector<BidirectionalLineInfoRun> mBidirectionalLineInfo;
222 Vector<EmbeddedItem> mEmbeddedItems;
223 Vector<Anchor> mAnchors;
224 Vector<UnderlinedCharacterRun> mUnderlinedCharacterRuns; ///< The underlined character run from markup-processor
225 Vector<StrikethroughCharacterRun> mStrikethroughCharacterRuns; ///< The strikethrough character run from markup-processor
227 BidirectionalLineRunIndex mBidirectionalLineIndex; ///< The last fetched bidirectional line info.
232 } // namespace Toolkit
236 #endif // DALI_TOOLKIT_TEXT_LOGICAL_MODEL_IMPL_H