2 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali-toolkit/internal/text/logical-model-impl.h>
22 #include <dali-toolkit/internal/text/input-style.h>
23 #include <dali-toolkit/internal/text/text-run-container.h>
31 void FreeFontFamilyNames(Vector<FontDescriptionRun>& fontDescriptionRuns)
33 for(Vector<FontDescriptionRun>::Iterator it = fontDescriptionRuns.Begin(),
34 endIt = fontDescriptionRuns.End();
38 delete[](*it).familyName;
41 fontDescriptionRuns.Clear();
44 void FreeEmbeddedItems(Vector<EmbeddedItem>& embeddedItem)
46 for(Vector<EmbeddedItem>::Iterator it = embeddedItem.Begin(),
47 endIt = embeddedItem.End();
51 EmbeddedItem& item = *it;
58 void FreeAnchors(Vector<Anchor>& anchors)
60 for(auto&& anchor : anchors)
68 LogicalModelPtr LogicalModel::New()
70 return LogicalModelPtr(new LogicalModel());
73 Script LogicalModel::GetScript(CharacterIndex characterIndex) const
75 // If this operation is too slow, consider a binary search.
77 const ScriptRun* const scriptRunBuffer = mScriptRuns.Begin();
78 for(Length index = 0u, length = mScriptRuns.Count(); index < length; ++index)
80 const ScriptRun* const scriptRun = scriptRunBuffer + index;
82 if((scriptRun->characterRun.characterIndex <= characterIndex) &&
83 (characterIndex < scriptRun->characterRun.characterIndex + scriptRun->characterRun.numberOfCharacters))
85 return scriptRun->script;
89 return TextAbstraction::UNKNOWN;
92 CharacterDirection LogicalModel::GetCharacterDirection(CharacterIndex characterIndex) const
94 if(characterIndex >= mCharacterDirections.Count())
96 // The model has no right to left characters, so the vector of directions is void.
100 return *(mCharacterDirections.Begin() + characterIndex);
103 CharacterIndex LogicalModel::GetLogicalCursorIndex(CharacterIndex visualCursorIndex)
105 // The character's directions buffer.
106 const CharacterDirection* const modelCharacterDirections = mCharacterDirections.Begin();
108 // The bidirectional line info.
109 const BidirectionalLineInfoRun* const bidirectionalLineInfo = mBidirectionalLineInfo.Begin() + mBidirectionalLineIndex;
111 // Whether the paragraph starts with a right to left character.
112 const bool isRightToLeftParagraph = bidirectionalLineInfo->direction;
114 // The total number of characters of the line.
115 const Length lastCharacterIndex = bidirectionalLineInfo->characterRun.characterIndex + bidirectionalLineInfo->characterRun.numberOfCharacters;
117 CharacterIndex logicalCursorIndex = 0u;
119 if(bidirectionalLineInfo->characterRun.characterIndex == visualCursorIndex)
121 if(isRightToLeftParagraph)
123 logicalCursorIndex = lastCharacterIndex;
125 else // else logical position is the first of the line.
127 logicalCursorIndex = bidirectionalLineInfo->characterRun.characterIndex;
130 else if(lastCharacterIndex == visualCursorIndex)
132 if(isRightToLeftParagraph)
134 logicalCursorIndex = bidirectionalLineInfo->characterRun.characterIndex;
136 else // else logical position is the number of characters.
138 logicalCursorIndex = lastCharacterIndex;
143 // Get the character indexed by index - 1 and index
144 // and calculate the logical position according the directions of
145 // both characters and the direction of the paragraph.
147 const CharacterIndex previousVisualCursorIndex = visualCursorIndex - 1u;
148 const CharacterIndex previousLogicalCursorIndex = *(bidirectionalLineInfo->visualToLogicalMap + previousVisualCursorIndex - bidirectionalLineInfo->characterRun.characterIndex) + bidirectionalLineInfo->characterRun.characterIndex;
149 const CharacterIndex currentLogicalCursorIndex = *(bidirectionalLineInfo->visualToLogicalMap + visualCursorIndex - bidirectionalLineInfo->characterRun.characterIndex) + bidirectionalLineInfo->characterRun.characterIndex;
151 const CharacterDirection previousCharacterDirection = *(modelCharacterDirections + previousLogicalCursorIndex);
152 const CharacterDirection currentCharacterDirection = *(modelCharacterDirections + currentLogicalCursorIndex);
154 if(previousCharacterDirection == currentCharacterDirection)
156 // Both glyphs have the same direction.
157 if(previousCharacterDirection)
159 logicalCursorIndex = previousLogicalCursorIndex;
163 logicalCursorIndex = currentLogicalCursorIndex;
168 if(isRightToLeftParagraph)
170 if(currentCharacterDirection)
172 logicalCursorIndex = currentLogicalCursorIndex + 1u;
176 logicalCursorIndex = previousLogicalCursorIndex;
181 if(previousCharacterDirection)
183 logicalCursorIndex = currentLogicalCursorIndex;
187 logicalCursorIndex = previousLogicalCursorIndex + 1u;
193 return logicalCursorIndex;
196 CharacterIndex LogicalModel::GetLogicalCharacterIndex(CharacterIndex visualCharacterIndex)
198 // The bidirectional line info.
199 const BidirectionalLineInfoRun* const bidirectionalLineInfo = mBidirectionalLineInfo.Begin() + mBidirectionalLineIndex;
201 return *(bidirectionalLineInfo->visualToLogicalMap + visualCharacterIndex - bidirectionalLineInfo->characterRun.characterIndex) + bidirectionalLineInfo->characterRun.characterIndex;
204 bool LogicalModel::FetchBidirectionalLineInfo(CharacterIndex characterIndex)
206 // The number of bidirectional lines.
207 const Length numberOfBidirectionalLines = mBidirectionalLineInfo.Count();
209 if(0u == numberOfBidirectionalLines)
211 // If there is no bidirectional info.
215 // Find the bidi line where the character is laid-out.
217 const BidirectionalLineInfoRun* const bidirectionalLineInfoBuffer = mBidirectionalLineInfo.Begin();
219 // Check first if the character is in the previously fetched line.
221 BidirectionalLineRunIndex bidiLineIndex = 0u;
222 CharacterIndex lastCharacterOfRightToLeftRun = 0u;
223 if(mBidirectionalLineIndex < numberOfBidirectionalLines)
225 const BidirectionalLineInfoRun& bidiLineRun = *(bidirectionalLineInfoBuffer + mBidirectionalLineIndex);
227 const CharacterIndex lastCharacterOfRunPlusOne = bidiLineRun.characterRun.characterIndex + bidiLineRun.characterRun.numberOfCharacters;
228 if((bidiLineRun.characterRun.characterIndex <= characterIndex) &&
229 (characterIndex < lastCharacterOfRunPlusOne))
231 // The character is in the previously fetched bidi line.
236 // The character is not in the previously fetched line.
237 // Set the bidi line index from where to start the fetch.
239 if(characterIndex < bidiLineRun.characterRun.characterIndex)
241 // Start the fetch from the beginning.
246 // Start the fetch from the next line.
247 bidiLineIndex = mBidirectionalLineIndex + 1u;
248 lastCharacterOfRightToLeftRun = lastCharacterOfRunPlusOne - 1u;
253 // The character has not been found in the previously fetched bidi line.
254 for(Vector<BidirectionalLineInfoRun>::ConstIterator it = bidirectionalLineInfoBuffer + bidiLineIndex,
255 endIt = mBidirectionalLineInfo.End();
257 ++it, ++bidiLineIndex)
259 const BidirectionalLineInfoRun& bidiLineRun = *it;
261 if((lastCharacterOfRightToLeftRun < characterIndex) &&
262 (characterIndex < bidiLineRun.characterRun.characterIndex))
264 // The character is not inside a bidi line.
268 const CharacterIndex lastCharacterOfRunPlusOne = bidiLineRun.characterRun.characterIndex + bidiLineRun.characterRun.numberOfCharacters;
269 lastCharacterOfRightToLeftRun = lastCharacterOfRunPlusOne - 1u;
270 if((bidiLineRun.characterRun.characterIndex <= characterIndex) &&
271 (characterIndex < lastCharacterOfRunPlusOne))
273 // Bidi line found. Fetch the line.
274 mBidirectionalLineIndex = bidiLineIndex;
282 BidirectionalLineRunIndex LogicalModel::GetBidirectionalLineInfo() const
284 return mBidirectionalLineIndex;
287 void LogicalModel::UpdateTextStyleRuns(CharacterIndex index, int numberOfCharacters)
289 const Length totalNumberOfCharacters = mText.Count();
291 // Process the color runs.
292 Vector<ColorRun> removedColorRuns;
293 UpdateCharacterRuns<ColorRun>(index,
295 totalNumberOfCharacters,
299 // Process the background color runs.
300 Vector<ColorRun> removedBackgroundColorRuns;
301 UpdateCharacterRuns<ColorRun>(index,
303 totalNumberOfCharacters,
304 mBackgroundColorRuns,
305 removedBackgroundColorRuns);
307 // Process the font description runs.
308 Vector<FontDescriptionRun> removedFontDescriptionRuns;
309 UpdateCharacterRuns<FontDescriptionRun>(index,
311 totalNumberOfCharacters,
312 mFontDescriptionRuns,
313 removedFontDescriptionRuns);
315 // Free memory allocated for the font family name.
316 FreeFontFamilyNames(removedFontDescriptionRuns);
319 void LogicalModel::RetrieveStyle(CharacterIndex index, InputStyle& style)
321 unsigned int runIndex = 0u;
323 // Set the text color.
324 bool colorOverriden = false;
325 unsigned int colorIndex = 0u;
326 const ColorRun* const colorRunsBuffer = mColorRuns.Begin();
327 for(Vector<ColorRun>::ConstIterator it = colorRunsBuffer,
328 endIt = mColorRuns.End();
332 const ColorRun& colorRun = *it;
334 if((colorRun.characterRun.characterIndex <= index) &&
335 (index < colorRun.characterRun.characterIndex + colorRun.characterRun.numberOfCharacters))
337 colorIndex = runIndex;
338 colorOverriden = true;
342 // Set the text's color if it's overriden.
345 style.textColor = (*(colorRunsBuffer + colorIndex)).color;
346 style.isDefaultColor = false;
349 // Reset the run index.
352 // Set the font's parameters.
353 bool nameOverriden = false;
354 bool weightOverriden = false;
355 bool widthOverriden = false;
356 bool slantOverriden = false;
357 bool sizeOverriden = false;
358 unsigned int nameIndex = 0u;
359 unsigned int weightIndex = 0u;
360 unsigned int widthIndex = 0u;
361 unsigned int slantIndex = 0u;
362 unsigned int sizeIndex = 0u;
363 const FontDescriptionRun* const fontDescriptionRunsBuffer = mFontDescriptionRuns.Begin();
364 for(Vector<FontDescriptionRun>::ConstIterator it = fontDescriptionRunsBuffer,
365 endIt = mFontDescriptionRuns.End();
369 const FontDescriptionRun& fontDescriptionRun = *it;
371 if((fontDescriptionRun.characterRun.characterIndex <= index) &&
372 (index < fontDescriptionRun.characterRun.characterIndex + fontDescriptionRun.characterRun.numberOfCharacters))
374 if(fontDescriptionRun.familyDefined)
376 nameIndex = runIndex;
377 nameOverriden = true;
380 if(fontDescriptionRun.weightDefined)
382 weightIndex = runIndex;
383 weightOverriden = true;
386 if(fontDescriptionRun.widthDefined)
388 widthIndex = runIndex;
389 widthOverriden = true;
392 if(fontDescriptionRun.slantDefined)
394 slantIndex = runIndex;
395 slantOverriden = true;
398 if(fontDescriptionRun.sizeDefined)
400 sizeIndex = runIndex;
401 sizeOverriden = true;
406 // Set the font's family name if it's overriden.
409 const FontDescriptionRun& fontDescriptionRun = *(fontDescriptionRunsBuffer + nameIndex);
411 style.familyName = std::string(fontDescriptionRun.familyName, fontDescriptionRun.familyLength);
412 style.isFamilyDefined = true;
415 // Set the font's weight if it's overriden.
418 const FontDescriptionRun& fontDescriptionRun = *(fontDescriptionRunsBuffer + weightIndex);
420 style.weight = fontDescriptionRun.weight;
421 style.isWeightDefined = true;
424 // Set the font's width if it's overriden.
427 const FontDescriptionRun& fontDescriptionRun = *(fontDescriptionRunsBuffer + widthIndex);
429 style.width = fontDescriptionRun.width;
430 style.isWidthDefined = true;
433 // Set the font's slant if it's overriden.
436 const FontDescriptionRun& fontDescriptionRun = *(fontDescriptionRunsBuffer + slantIndex);
438 style.slant = fontDescriptionRun.slant;
439 style.isSlantDefined = true;
442 // Set the font's size if it's overriden.
445 const FontDescriptionRun& fontDescriptionRun = *(fontDescriptionRunsBuffer + sizeIndex);
447 style.size = static_cast<float>(fontDescriptionRun.size) / 64.f;
448 style.isSizeDefined = true;
452 void LogicalModel::ClearFontDescriptionRuns()
454 FreeFontFamilyNames(mFontDescriptionRuns);
457 void LogicalModel::CreateParagraphInfo(CharacterIndex startIndex,
458 Length numberOfCharacters)
460 const Length totalNumberOfCharacters = mLineBreakInfo.Count();
462 // Count the number of LINE_MUST_BREAK to reserve some space for the vector of paragraph's info.
463 Vector<CharacterIndex> paragraphs;
464 paragraphs.Reserve(numberOfCharacters);
465 const TextAbstraction::LineBreakInfo* lineBreakInfoBuffer = mLineBreakInfo.Begin();
466 const CharacterIndex lastCharacterIndexPlusOne = startIndex + numberOfCharacters;
467 for(Length index = startIndex; index < lastCharacterIndexPlusOne; ++index)
469 if(TextAbstraction::LINE_MUST_BREAK == *(lineBreakInfoBuffer + index))
471 paragraphs.PushBack(index);
475 // Whether the current paragraphs are updated or set from scratch.
476 const bool updateCurrentParagraphs = numberOfCharacters < totalNumberOfCharacters;
478 // Reserve space for current paragraphs plus new ones.
479 const Length numberOfNewParagraphs = paragraphs.Count();
480 const Length totalNumberOfParagraphs = mParagraphInfo.Count() + numberOfNewParagraphs;
481 mParagraphInfo.Resize(totalNumberOfParagraphs);
483 ParagraphRun* paragraphInfoBuffer = NULL;
484 Vector<ParagraphRun> newParagraphs;
486 if(updateCurrentParagraphs)
488 newParagraphs.Resize(numberOfNewParagraphs);
489 paragraphInfoBuffer = newParagraphs.Begin();
493 paragraphInfoBuffer = mParagraphInfo.Begin();
496 // Find where to insert the new paragraphs.
497 ParagraphRunIndex paragraphIndex = 0u;
498 CharacterIndex firstIndex = startIndex;
500 if(updateCurrentParagraphs)
502 for(Vector<ParagraphRun>::ConstIterator it = mParagraphInfo.Begin(),
503 endIt = mParagraphInfo.Begin() + totalNumberOfParagraphs - numberOfNewParagraphs;
507 const ParagraphRun& paragraph(*it);
509 if(startIndex < paragraph.characterRun.characterIndex + paragraph.characterRun.numberOfCharacters)
511 firstIndex = paragraph.characterRun.characterIndex;
519 // Create the paragraph info.
520 ParagraphRunIndex newParagraphIndex = 0u;
521 for(Vector<CharacterIndex>::ConstIterator it = paragraphs.Begin(),
522 endIt = paragraphs.End();
524 ++it, ++newParagraphIndex)
526 const CharacterIndex index = *it;
528 ParagraphRun& paragraph = *(paragraphInfoBuffer + newParagraphIndex);
529 paragraph.characterRun.characterIndex = firstIndex;
530 paragraph.characterRun.numberOfCharacters = 1u + index - firstIndex;
532 firstIndex += paragraph.characterRun.numberOfCharacters;
535 // Insert the new paragraphs.
536 if(updateCurrentParagraphs)
538 mParagraphInfo.Insert(mParagraphInfo.Begin() + paragraphIndex,
539 newParagraphs.Begin(),
540 newParagraphs.End());
542 mParagraphInfo.Resize(totalNumberOfParagraphs);
544 // Update the next paragraph indices.
545 for(Vector<ParagraphRun>::Iterator it = mParagraphInfo.Begin() + paragraphIndex + newParagraphs.Count(),
546 endIt = mParagraphInfo.End();
550 ParagraphRun& paragraph(*it);
552 paragraph.characterRun.characterIndex += numberOfCharacters;
557 void LogicalModel::FindParagraphs(CharacterIndex index,
558 Length numberOfCharacters,
559 Vector<ParagraphRunIndex>& paragraphs)
561 // Reserve som space for the paragraph indices.
562 paragraphs.Reserve(mParagraphInfo.Count());
564 // Traverse the paragraphs to find which ones contain the given characters.
565 ParagraphRunIndex paragraphIndex = 0u;
566 for(Vector<ParagraphRun>::ConstIterator it = mParagraphInfo.Begin(),
567 endIt = mParagraphInfo.End();
569 ++it, ++paragraphIndex)
571 const ParagraphRun& paragraph(*it);
573 if((paragraph.characterRun.characterIndex + paragraph.characterRun.numberOfCharacters > index) &&
574 (paragraph.characterRun.characterIndex < index + numberOfCharacters))
576 paragraphs.PushBack(paragraphIndex);
581 void LogicalModel::ClearEmbeddedImages()
583 FreeEmbeddedItems(mEmbeddedItems);
586 void LogicalModel::ClearAnchors()
588 FreeAnchors(mAnchors);
591 LogicalModel::~LogicalModel()
593 ClearFontDescriptionRuns();
594 ClearEmbeddedImages();
597 LogicalModel::LogicalModel()
598 : mBidirectionalLineIndex(0u)
604 } // namespace Toolkit