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>
36 #include <dali-toolkit/internal/text/underlined-character-run.h>
45 typedef IntrusivePtr<LogicalModel> LogicalModelPtr;
49 * @brief A logical text model contains layout independent information.
52 * - A series of UTF-32 characters in logical order
54 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 Retrieves the logical cursor index for the given visual cursor index.
93 * @pre The method FetchBidirectionalLineInfo() must be called before. If the result of FetchBidirectionalLineInfo() is false,
94 * then the character is not in a bidirectional line and the result will be invalid.
96 * @param[in] visualCursorIndex The visual cursor index.
98 * @return The logical cursor index.
100 CharacterIndex GetLogicalCursorIndex(CharacterIndex visualCursorIndex);
103 * @brief Retrieves the logical character index for the given visual character index.
105 * @pre The method FetchBidirectionalLineInfo() must be called before. If the result of FetchBidirectionalLineInfo() is false,
106 * then the character is not in a bidirectional line and the result will be invalid.
108 * @param[in] visualCharacterIndex The visual character index.
110 * @return The logical character index.
112 CharacterIndex GetLogicalCharacterIndex(CharacterIndex visualCharacterIndex);
115 * @brief Fetch the bidirectional line info for the given character.
117 * Call GetBidirectionalLineInfo() to retrieve the last fetched line.
119 * @param[in] characterIndex The character index.
121 * @return @e true if the given @e character is in a bidirectional line.
123 bool FetchBidirectionalLineInfo(CharacterIndex characterIndex);
126 * @brief Retrieves the last fetched bidirectional line info.
128 * @return The index of the bidirectional line info.
130 BidirectionalLineRunIndex GetBidirectionalLineInfo() const;
135 * @brief Updates the text's style runs with the added or removed text.
137 * @param[in] index The character's index.
138 * @param[in] numberOfCharacters The number of characters added or removed. If the value is negative the characters are removed.
140 void UpdateTextStyleRuns(CharacterIndex index, int numberOfCharacters);
143 * @brief Retrieves the text's style for the given character index.
145 * @param[in] index The character index.
146 * @param[out] style The text's style in the given style.
148 void RetrieveStyle(CharacterIndex index, InputStyle& style);
151 * @brief Clears the font description runs.
153 void ClearFontDescriptionRuns();
158 * @brief Creates the paragraph info.
160 * @pre The line break info must be set.
162 * @param[in] startIndex The character from where the paragraph info is set.
163 * @param[in] numberOfCharacters The number of characters.
165 void CreateParagraphInfo(CharacterIndex startIndex,
166 Length numberOfCharacters);
169 * @brief Find the paragraphs which contains the given characters.
171 * @param[in] index The first character's index of the run.
172 * @param[in] numberOfCharacters The number of characters of the run.
173 * @param[out] paragraphs Indices to the paragraphs which contain the characters.
175 void FindParagraphs(CharacterIndex index,
176 Length numberOfCharacters,
177 Vector<ParagraphRunIndex>& paragraphs);
182 * @brief Clears the embedded images.
184 void ClearEmbeddedImages();
187 * @brief Clears the anchors.
193 * @brief A reference counted object may only be deleted by calling Unreference().
195 virtual ~LogicalModel();
199 * @brief Private constructor.
204 LogicalModel(const LogicalModel& handle);
207 LogicalModel& operator=(const LogicalModel& handle);
210 Vector<Character> mText;
211 Vector<ScriptRun> mScriptRuns;
212 Vector<FontRun> mFontRuns;
213 Vector<ColorRun> mColorRuns;
214 Vector<ColorRun> mBackgroundColorRuns;
215 Vector<FontDescriptionRun> mFontDescriptionRuns;
216 Vector<LineBreakInfo> mLineBreakInfo;
217 Vector<ParagraphRun> mParagraphInfo;
218 Vector<BidirectionalParagraphInfoRun> mBidirectionalParagraphInfo;
219 Vector<CharacterDirection> mCharacterDirections; ///< For each character, whether is right to left. ( @e flase is left to right, @e true right to left ).
220 Vector<BidirectionalLineInfoRun> mBidirectionalLineInfo;
221 Vector<EmbeddedItem> mEmbeddedItems;
222 Vector<Anchor> mAnchors;
223 Vector<UnderlinedCharacterRun> mUnderlinedCharacterRuns; ///< The underlined character run from markup-processor
225 BidirectionalLineRunIndex mBidirectionalLineIndex; ///< The last fetched bidirectional line info.
230 } // namespace Toolkit
234 #endif // DALI_TOOLKIT_TEXT_LOGICAL_MODEL_IMPL_H