2 * Copyright (c) 2022 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/text-selection-handle-controller.h>
21 #include <dali/integration-api/debug.h>
25 #include <dali-toolkit/internal/text/cursor-helper-functions.h>
26 #include <dali-toolkit/internal/text/glyph-metrics-helper.h>
27 #include <dali-toolkit/internal/text/text-controller-impl-event-handler.h>
34 * @brief Struct used to calculate the selection box.
36 struct SelectionBoxInfo
44 #if defined(DEBUG_ENABLED)
45 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
48 const float MAX_FLOAT = std::numeric_limits<float>::max();
49 const float MIN_FLOAT = std::numeric_limits<float>::min();
50 const Dali::Toolkit::Text::CharacterDirection LTR = false; ///< Left To Right direction
60 void SelectionHandleController::Reposition(Controller::Impl& impl)
62 EventData*& eventData = impl.mEventData;
64 CharacterIndex selectionStart = eventData->mLeftSelectionPosition;
65 CharacterIndex selectionEnd = eventData->mRightSelectionPosition;
67 DecoratorPtr& decorator = eventData->mDecorator;
69 if(selectionStart == selectionEnd)
71 // Nothing to select if handles are in the same place.
72 // So, deactive Highlight box.
73 decorator->SetHighlightActive(false);
77 decorator->ClearHighlights();
79 ModelPtr& model = impl.mModel;
80 VisualModelPtr& visualModel = model->mVisualModel;
81 LogicalModelPtr& logicalModel = model->mLogicalModel;
83 const GlyphIndex* const charactersToGlyphBuffer = visualModel->mCharactersToGlyph.Begin();
84 const Length* const glyphsPerCharacterBuffer = visualModel->mGlyphsPerCharacter.Begin();
85 const GlyphInfo* const glyphsBuffer = visualModel->mGlyphs.Begin();
86 const Vector2* const positionsBuffer = visualModel->mGlyphPositions.Begin();
87 const Length* const charactersPerGlyphBuffer = visualModel->mCharactersPerGlyph.Begin();
88 const CharacterIndex* const glyphToCharacterBuffer = visualModel->mGlyphsToCharacters.Begin();
89 const CharacterDirection* const modelCharacterDirectionsBuffer = (0u != logicalModel->mCharacterDirections.Count()) ? logicalModel->mCharacterDirections.Begin() : NULL;
91 const bool isLastCharacter = selectionEnd >= logicalModel->mText.Count();
92 const CharacterDirection startDirection = ((NULL == modelCharacterDirectionsBuffer) ? false : *(modelCharacterDirectionsBuffer + selectionStart));
93 const CharacterDirection endDirection = ((NULL == modelCharacterDirectionsBuffer) ? false : *(modelCharacterDirectionsBuffer + (selectionEnd - (isLastCharacter ? 1u : 0u))));
95 // Swap the indices if the start is greater than the end.
96 const bool indicesSwapped = selectionStart > selectionEnd;
98 // Tell the decorator to flip the selection handles if needed.
99 decorator->SetSelectionHandleFlipState(indicesSwapped, startDirection, endDirection);
103 std::swap(selectionStart, selectionEnd);
106 // Get the indices to the first and last selected glyphs.
107 const CharacterIndex selectionEndMinusOne = selectionEnd - 1u;
108 const GlyphIndex glyphStart = *(charactersToGlyphBuffer + selectionStart);
109 const Length numberOfGlyphs = *(glyphsPerCharacterBuffer + selectionEndMinusOne);
110 const GlyphIndex glyphEnd = *(charactersToGlyphBuffer + selectionEndMinusOne) + ((numberOfGlyphs > 0) ? numberOfGlyphs - 1u : 0u);
111 const float characterSpacing = visualModel->GetCharacterSpacing();
112 Vector<CharacterIndex>& glyphToCharacterMap = visualModel->mGlyphsToCharacters;
113 const CharacterIndex* glyphToCharacterMapBuffer = glyphToCharacterMap.Begin();
115 // Get the lines where the glyphs are laid-out.
116 const LineRun* lineRun = visualModel->mLines.Begin();
118 LineIndex lineIndex = 0u;
119 Length numberOfLines = 0u;
120 visualModel->GetNumberOfLines(glyphStart,
121 1u + glyphEnd - glyphStart,
124 const LineIndex firstLineIndex = lineIndex;
126 // Create the structure to store some selection box info.
127 Vector<SelectionBoxInfo> selectionBoxLinesInfo;
128 selectionBoxLinesInfo.Resize(numberOfLines);
130 SelectionBoxInfo* selectionBoxInfo = selectionBoxLinesInfo.Begin();
131 selectionBoxInfo->minX = MAX_FLOAT;
132 selectionBoxInfo->maxX = MIN_FLOAT;
134 // Keep the min and max 'x' position to calculate the size and position of the highlighed text.
135 float minHighlightX = std::numeric_limits<float>::max();
136 float maxHighlightX = std::numeric_limits<float>::min();
138 Vector2 highLightPosition; // The highlight position in decorator's coords.
140 // Retrieve the first line and get the line's vertical offset, the line's height and the index to the last glyph.
142 // The line's vertical offset of all the lines before the line where the first glyph is laid-out.
143 selectionBoxInfo->lineOffset = CalculateLineOffset(visualModel->mLines,
146 // Transform to decorator's (control) coords.
147 selectionBoxInfo->lineOffset += model->mScrollPosition.y;
149 lineRun += firstLineIndex;
151 selectionBoxInfo->lineHeight = GetLineHeight(*lineRun);
153 GlyphIndex lastGlyphOfLine = lineRun->glyphRun.glyphIndex + lineRun->glyphRun.numberOfGlyphs - 1u;
155 // Check if the first glyph is a ligature that must be broken like Latin ff, fi, or Arabic ﻻ, etc which needs special code.
156 const Length numberOfCharactersStart = *(charactersPerGlyphBuffer + glyphStart);
157 bool splitStartGlyph = (numberOfCharactersStart > 1u) && HasLigatureMustBreak(logicalModel->GetScript(selectionStart));
159 // Check if the last glyph is a ligature that must be broken like Latin ff, fi, or Arabic ﻻ, etc which needs special code.
160 const Length numberOfCharactersEnd = *(charactersPerGlyphBuffer + glyphEnd);
161 bool splitEndGlyph = (glyphStart != glyphEnd) && (numberOfCharactersEnd > 1u) && HasLigatureMustBreak(logicalModel->GetScript(selectionEndMinusOne));
163 // The number of quads of the selection box.
164 const unsigned int numberOfQuads = 1u + (glyphEnd - glyphStart) + ((numberOfLines > 1u) ? 2u * numberOfLines : 0u);
165 decorator->ResizeHighlightQuads(numberOfQuads);
167 // Count the actual number of quads.
168 unsigned int actualNumberOfQuads = 0u;
170 float calculatedAdvance = 0.f;
172 // Traverse the glyphs.
173 for(GlyphIndex index = glyphStart; index <= glyphEnd; ++index)
175 const GlyphInfo& glyph = *(glyphsBuffer + index);
176 const Vector2& position = *(positionsBuffer + index);
177 calculatedAdvance = GetCalculatedAdvance(*(logicalModel->mText.Begin() + (*(glyphToCharacterMapBuffer + index))), characterSpacing, glyph.advance);
181 // If the first glyph is a ligature that must be broken it may be needed to add only part of the glyph to the highlight box.
183 const float glyphAdvance = calculatedAdvance / static_cast<float>(numberOfCharactersStart);
184 const CharacterIndex interGlyphIndex = selectionStart - *(glyphToCharacterBuffer + glyphStart);
185 // Get the direction of the character.
186 CharacterDirection isCurrentRightToLeft = false;
187 if(nullptr != modelCharacterDirectionsBuffer) // If modelCharacterDirectionsBuffer is NULL, it means the whole text is left to right.
189 isCurrentRightToLeft = *(modelCharacterDirectionsBuffer + selectionStart);
192 // The end point could be in the middle of the ligature.
193 // Calculate the number of characters selected.
194 const Length numberOfCharacters = (glyphStart == glyphEnd) ? (selectionEnd - selectionStart) : (numberOfCharactersStart - interGlyphIndex);
196 quad.x = lineRun->alignmentOffset + position.x - glyph.xBearing + model->mScrollPosition.x + glyphAdvance * static_cast<float>(isCurrentRightToLeft ? (numberOfCharactersStart - interGlyphIndex - numberOfCharacters) : interGlyphIndex);
197 quad.y = selectionBoxInfo->lineOffset;
198 quad.z = quad.x + static_cast<float>(numberOfCharacters) * glyphAdvance;
199 quad.w = selectionBoxInfo->lineOffset + selectionBoxInfo->lineHeight;
201 // Store the min and max 'x' for each line.
202 selectionBoxInfo->minX = std::min(selectionBoxInfo->minX, quad.x);
203 selectionBoxInfo->maxX = std::max(selectionBoxInfo->maxX, quad.z);
205 decorator->AddHighlight(actualNumberOfQuads, quad);
206 ++actualNumberOfQuads;
208 splitStartGlyph = false;
212 if(splitEndGlyph && (index == glyphEnd))
214 // Equally, if the last glyph is a ligature that must be broken it may be needed to add only part of the glyph to the highlight box.
216 const float glyphAdvance = calculatedAdvance / static_cast<float>(numberOfCharactersEnd);
217 const CharacterIndex interGlyphIndex = selectionEnd - *(glyphToCharacterBuffer + glyphEnd);
218 // Get the direction of the character.
219 CharacterDirection isCurrentRightToLeft = false;
220 if(nullptr != modelCharacterDirectionsBuffer) // If modelCharacterDirectionsBuffer is NULL, it means the whole text is left to right.
222 isCurrentRightToLeft = *(modelCharacterDirectionsBuffer + selectionEnd);
225 const Length numberOfCharacters = numberOfCharactersEnd - interGlyphIndex;
227 quad.x = lineRun->alignmentOffset + position.x - glyph.xBearing + model->mScrollPosition.x + (isCurrentRightToLeft ? (glyphAdvance * static_cast<float>(numberOfCharacters)) : 0.f);
228 quad.y = selectionBoxInfo->lineOffset;
229 quad.z = quad.x + static_cast<float>(interGlyphIndex) * glyphAdvance;
230 quad.w = quad.y + selectionBoxInfo->lineHeight;
232 // Store the min and max 'x' for each line.
233 selectionBoxInfo->minX = std::min(selectionBoxInfo->minX, quad.x);
234 selectionBoxInfo->maxX = std::max(selectionBoxInfo->maxX, quad.z);
236 decorator->AddHighlight(actualNumberOfQuads,
238 ++actualNumberOfQuads;
240 splitEndGlyph = false;
244 quad.x = lineRun->alignmentOffset + position.x - glyph.xBearing + model->mScrollPosition.x;
245 quad.y = selectionBoxInfo->lineOffset;
246 quad.z = quad.x + calculatedAdvance;
247 quad.w = quad.y + selectionBoxInfo->lineHeight;
249 // Store the min and max 'x' for each line.
250 selectionBoxInfo->minX = std::min(selectionBoxInfo->minX, quad.x);
251 selectionBoxInfo->maxX = std::max(selectionBoxInfo->maxX, quad.z);
253 decorator->AddHighlight(actualNumberOfQuads,
255 ++actualNumberOfQuads;
257 // Whether to retrieve the next line.
258 if(index == lastGlyphOfLine)
261 if(lineIndex < firstLineIndex + numberOfLines)
263 // Retrieve the next line.
266 // Get the last glyph of the new line.
267 lastGlyphOfLine = lineRun->glyphRun.glyphIndex + lineRun->glyphRun.numberOfGlyphs - 1u;
269 // Keep the offset and height of the current selection box.
270 const float currentLineOffset = selectionBoxInfo->lineOffset;
271 const float currentLineHeight = selectionBoxInfo->lineHeight;
273 // Get the selection box info for the next line.
276 selectionBoxInfo->minX = MAX_FLOAT;
277 selectionBoxInfo->maxX = MIN_FLOAT;
279 // Update the line's vertical offset.
280 selectionBoxInfo->lineOffset = currentLineOffset + currentLineHeight;
282 selectionBoxInfo->lineHeight = GetLineHeight(*lineRun);
287 // Traverses all the lines and updates the min and max 'x' positions and the total height.
288 // The final width is calculated after 'boxifying' the selection.
289 for(Vector<SelectionBoxInfo>::ConstIterator it = selectionBoxLinesInfo.Begin(),
290 endIt = selectionBoxLinesInfo.End();
294 const SelectionBoxInfo& info = *it;
296 // Update the size of the highlighted text.
297 highLightSize.height += info.lineHeight;
298 minHighlightX = std::min(minHighlightX, info.minX);
299 maxHighlightX = std::max(maxHighlightX, info.maxX);
302 // Add extra geometry to 'boxify' the selection.
304 if(1u < numberOfLines)
306 // Boxify the first line.
307 lineRun = visualModel->mLines.Begin() + firstLineIndex;
308 const SelectionBoxInfo& firstSelectionBoxLineInfo = *(selectionBoxLinesInfo.Begin());
310 bool boxifyBegin = (LTR != lineRun->direction) && (LTR != startDirection);
311 bool boxifyEnd = (LTR == lineRun->direction) && (LTR == startDirection);
316 quad.y = firstSelectionBoxLineInfo.lineOffset;
317 quad.z = firstSelectionBoxLineInfo.minX;
318 quad.w = firstSelectionBoxLineInfo.lineOffset + firstSelectionBoxLineInfo.lineHeight;
320 // Boxify at the beginning of the line.
321 decorator->AddHighlight(actualNumberOfQuads,
323 ++actualNumberOfQuads;
325 // Update the size of the highlighted text.
331 quad.x = firstSelectionBoxLineInfo.maxX;
332 quad.y = firstSelectionBoxLineInfo.lineOffset;
333 quad.z = visualModel->mControlSize.width;
334 quad.w = firstSelectionBoxLineInfo.lineOffset + firstSelectionBoxLineInfo.lineHeight;
336 // Boxify at the end of the line.
337 decorator->AddHighlight(actualNumberOfQuads,
339 ++actualNumberOfQuads;
341 // Update the size of the highlighted text.
342 maxHighlightX = visualModel->mControlSize.width;
345 // Boxify the central lines.
346 if(2u < numberOfLines)
348 for(Vector<SelectionBoxInfo>::ConstIterator it = selectionBoxLinesInfo.Begin() + 1u,
349 endIt = selectionBoxLinesInfo.End() - 1u;
353 const SelectionBoxInfo& info = *it;
356 quad.y = info.lineOffset;
358 quad.w = info.lineOffset + info.lineHeight;
360 decorator->AddHighlight(actualNumberOfQuads,
362 ++actualNumberOfQuads;
365 quad.y = info.lineOffset;
366 quad.z = visualModel->mControlSize.width;
367 quad.w = info.lineOffset + info.lineHeight;
369 decorator->AddHighlight(actualNumberOfQuads,
371 ++actualNumberOfQuads;
374 // Update the size of the highlighted text.
376 maxHighlightX = visualModel->mControlSize.width;
379 // Boxify the last line.
380 lineRun = visualModel->mLines.Begin() + firstLineIndex + numberOfLines - 1u;
381 const SelectionBoxInfo& lastSelectionBoxLineInfo = *(selectionBoxLinesInfo.End() - 1u);
383 boxifyBegin = (LTR == lineRun->direction) && (LTR == endDirection);
384 boxifyEnd = (LTR != lineRun->direction) && (LTR != endDirection);
389 quad.y = lastSelectionBoxLineInfo.lineOffset;
390 quad.z = lastSelectionBoxLineInfo.minX;
391 quad.w = lastSelectionBoxLineInfo.lineOffset + lastSelectionBoxLineInfo.lineHeight;
393 // Boxify at the beginning of the line.
394 decorator->AddHighlight(actualNumberOfQuads,
396 ++actualNumberOfQuads;
398 // Update the size of the highlighted text.
404 quad.x = lastSelectionBoxLineInfo.maxX;
405 quad.y = lastSelectionBoxLineInfo.lineOffset;
406 quad.z = visualModel->mControlSize.width;
407 quad.w = lastSelectionBoxLineInfo.lineOffset + lastSelectionBoxLineInfo.lineHeight;
409 // Boxify at the end of the line.
410 decorator->AddHighlight(actualNumberOfQuads, quad);
411 ++actualNumberOfQuads;
413 // Update the size of the highlighted text.
414 maxHighlightX = visualModel->mControlSize.width;
418 // Set the actual number of quads.
419 decorator->ResizeHighlightQuads(actualNumberOfQuads);
421 // Sets the highlight's size and position. In decorator's coords.
422 // The highlight's height has been calculated above (before 'boxifying' the highlight).
423 highLightSize.width = maxHighlightX - minHighlightX;
425 highLightPosition.x = minHighlightX;
426 const SelectionBoxInfo& firstSelectionBoxLineInfo = *(selectionBoxLinesInfo.Begin());
427 highLightPosition.y = firstSelectionBoxLineInfo.lineOffset;
429 decorator->SetHighLightBox(highLightPosition, highLightSize, static_cast<float>(model->GetOutlineWidth()));
431 if(!decorator->IsSmoothHandlePanEnabled())
433 CursorInfo primaryCursorInfo;
434 impl.GetCursorPosition(eventData->mLeftSelectionPosition, primaryCursorInfo);
436 const Vector2 primaryPosition = primaryCursorInfo.primaryPosition + model->mScrollPosition;
438 decorator->SetPosition(LEFT_SELECTION_HANDLE,
440 primaryCursorInfo.lineOffset + model->mScrollPosition.y,
441 primaryCursorInfo.lineHeight);
443 CursorInfo secondaryCursorInfo;
444 impl.GetCursorPosition(eventData->mRightSelectionPosition, secondaryCursorInfo);
446 const Vector2 secondaryPosition = secondaryCursorInfo.primaryPosition + model->mScrollPosition;
448 decorator->SetPosition(RIGHT_SELECTION_HANDLE,
450 secondaryCursorInfo.lineOffset + model->mScrollPosition.y,
451 secondaryCursorInfo.lineHeight);
454 // Set the flag to update the decorator.
455 eventData->mDecoratorUpdated = true;
458 void SelectionHandleController::Reposition(Controller::Impl& impl, float visualX, float visualY, Controller::NoTextTap::Action action)
460 EventData*& eventData = impl.mEventData;
461 if(nullptr == eventData)
463 // Nothing to do if there is no text input.
467 if(impl.IsShowingPlaceholderText())
469 // Nothing to do if there is the place-holder text.
473 ModelPtr& model = impl.mModel;
474 VisualModelPtr& visualModel = model->mVisualModel;
475 const Length numberOfGlyphs = visualModel->mGlyphs.Count();
476 const Length numberOfLines = visualModel->mLines.Count();
477 if((0 == numberOfGlyphs) ||
478 (0 == numberOfLines))
480 // Nothing to do if there is no text.
484 // Find which word was selected
485 CharacterIndex selectionStart(0);
486 CharacterIndex selectionEnd(0);
487 CharacterIndex noTextHitIndex(0);
488 const bool characterHit = FindSelectionIndices(visualModel,
489 model->mLogicalModel,
496 DALI_LOG_INFO(gLogFilter, Debug::Verbose, "%p selectionStart %d selectionEnd %d\n", &impl, selectionStart, selectionEnd);
498 if(characterHit || (Controller::NoTextTap::HIGHLIGHT == action))
500 uint32_t oldStart = eventData->mLeftSelectionPosition;
501 uint32_t oldEnd = eventData->mRightSelectionPosition;
503 impl.ChangeState(EventData::SELECTING);
505 eventData->mLeftSelectionPosition = selectionStart;
506 eventData->mRightSelectionPosition = selectionEnd;
508 eventData->mUpdateLeftSelectionPosition = true;
509 eventData->mUpdateRightSelectionPosition = true;
510 eventData->mUpdateHighlightBox = true;
512 // It may happen an InputMethodContext commit event arrives before the selection event
513 // if the InputMethodContext is in pre-edit state. The commit event will set the
514 // eventData->mUpdateCursorPosition flag to true. If it's not set back
515 // to false, the highlight box won't be updated.
516 eventData->mUpdateCursorPosition = false;
518 eventData->mScrollAfterUpdatePosition = (eventData->mLeftSelectionPosition != eventData->mRightSelectionPosition);
520 // Cursor to be positioned at end of selection so if selection interrupted and edit mode restarted the cursor will be at end of selection
521 eventData->mPrimaryCursorPosition = std::max(eventData->mLeftSelectionPosition, eventData->mRightSelectionPosition);
523 if(impl.mSelectableControlInterface != nullptr)
525 impl.mSelectableControlInterface->SelectionChanged(oldStart, oldEnd, eventData->mLeftSelectionPosition, eventData->mRightSelectionPosition);
528 else if(Controller::NoTextTap::SHOW_SELECTION_POPUP == action)
530 // Nothing to select. i.e. a white space, out of bounds
531 impl.ChangeState(EventData::EDITING_WITH_POPUP);
533 eventData->mPrimaryCursorPosition = noTextHitIndex;
535 eventData->mUpdateCursorPosition = true;
536 eventData->mUpdateGrabHandlePosition = true;
537 eventData->mScrollAfterUpdatePosition = true;
538 eventData->mUpdateInputStyle = true;
540 else if(Controller::NoTextTap::NO_ACTION == action)
542 // Nothing to select. i.e. a white space, out of bounds
543 eventData->mPrimaryCursorPosition = noTextHitIndex;
545 eventData->mUpdateCursorPosition = true;
546 eventData->mUpdateGrabHandlePosition = true;
547 eventData->mScrollAfterUpdatePosition = true;
548 eventData->mUpdateInputStyle = true;
552 void SelectionHandleController::Update(Controller::Impl& impl, HandleType handleType, const CursorInfo& cursorInfo)
554 if((LEFT_SELECTION_HANDLE != handleType) &&
555 (RIGHT_SELECTION_HANDLE != handleType))
560 ModelPtr& model = impl.mModel;
561 const Vector2 cursorPosition = cursorInfo.primaryPosition + model->mScrollPosition;
563 // Sets the handle's position.
564 EventData*& eventData = impl.mEventData;
565 eventData->mDecorator->SetPosition(handleType,
567 cursorInfo.lineOffset + model->mScrollPosition.y,
568 cursorInfo.lineHeight);
570 // If selection handle at start of the text and other at end of the text then all text is selected.
571 const CharacterIndex startOfSelection = std::min(eventData->mLeftSelectionPosition, eventData->mRightSelectionPosition);
572 const CharacterIndex endOfSelection = std::max(eventData->mLeftSelectionPosition, eventData->mRightSelectionPosition);
573 eventData->mAllTextSelected = (startOfSelection == 0) && (endOfSelection == model->mLogicalModel->mText.Count());
578 } // namespace Toolkit