dali-toolkit/internal/text/cursor-helper-functions.cpp

   1 /*
   2  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // FILE HEADER
  19 #include <dali-toolkit/internal/text/cursor-helper-functions.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/integration-api/debug.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/internal/text/glyph-metrics-helper.h>
  26
  27 namespace
  28 {
  29 #if defined(DEBUG_ENABLED)
  30 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
  31 #endif
  32
  33 const Dali::Toolkit::Text::CharacterDirection LTR = false; ///< Left To Right direction.
  34
  35 struct FindWordData
  36 {
  37   FindWordData(const Dali::Toolkit::Text::Character* const textBuffer,
  38                Dali::Toolkit::Text::Length                 totalNumberOfCharacters,
  39                Dali::Toolkit::Text::CharacterIndex         hitCharacter,
  40                bool                                        isWhiteSpace,
  41                bool                                        isNewParagraph)
  42   : textBuffer(textBuffer),
  43     totalNumberOfCharacters(totalNumberOfCharacters),
  44     hitCharacter(hitCharacter),
  45     foundIndex(0),
  46     isWhiteSpace(isWhiteSpace),
  47     isNewParagraph(isNewParagraph)
  48   {
  49   }
  50
  51   ~FindWordData()
  52   {
  53   }
  54
  55   const Dali::Toolkit::Text::Character* const textBuffer;
  56   Dali::Toolkit::Text::Length                 totalNumberOfCharacters;
  57   Dali::Toolkit::Text::CharacterIndex         hitCharacter;
  58   Dali::Toolkit::Text::CharacterIndex         foundIndex;
  59   bool                                        isWhiteSpace : 1u;
  60   bool                                        isNewParagraph : 1u;
  61 };
  62
  63 bool IsWhiteSpaceOrNewParagraph(Dali::Toolkit::Text::Character character,
  64                                 bool                           isHitWhiteSpace,
  65                                 bool                           isHitWhiteSpaceOrNewParagraph)
  66 {
  67   bool isWhiteSpaceOrNewParagraph = false;
  68   if(isHitWhiteSpaceOrNewParagraph)
  69   {
  70     if(isHitWhiteSpace)
  71     {
  72       // Whether the current character is a white space. Note a new paragraph character is a white space as well but here is not wanted.
  73       isWhiteSpaceOrNewParagraph = Dali::TextAbstraction::IsWhiteSpace(character) && !Dali::TextAbstraction::IsNewParagraph(character);
  74     }
  75     else
  76     {
  77       // Whether the current character is a new paragraph character.
  78       isWhiteSpaceOrNewParagraph = Dali::TextAbstraction::IsNewParagraph(character);
  79     }
  80   }
  81   else
  82   {
  83     // Whether the current character is a white space or a new paragraph character (note the new paragraph character is a white space as well).
  84     isWhiteSpaceOrNewParagraph = Dali::TextAbstraction::IsWhiteSpace(character);
  85   }
  86
  87   return isWhiteSpaceOrNewParagraph;
  88 }
  89
  90 void FindStartOfWord(FindWordData& data)
  91 {
  92   const bool isHitWhiteSpaceOrNewParagraph = data.isWhiteSpace || data.isNewParagraph;
  93
  94   for(data.foundIndex = data.hitCharacter; data.foundIndex > 0; --data.foundIndex)
  95   {
  96     const Dali::Toolkit::Text::Character character = *(data.textBuffer + data.foundIndex - 1u);
  97
  98     const bool isWhiteSpaceOrNewParagraph = IsWhiteSpaceOrNewParagraph(character,
  99                                                                        data.isWhiteSpace,
 100                                                                        isHitWhiteSpaceOrNewParagraph);
 101
 102     if(isHitWhiteSpaceOrNewParagraph != isWhiteSpaceOrNewParagraph)
 103     {
 104       break;
 105     }
 106   }
 107 }
 108
 109 void FindEndOfWord(FindWordData& data)
 110 {
 111   const bool isHitWhiteSpaceOrNewParagraph = data.isWhiteSpace || data.isNewParagraph;
 112
 113   for(data.foundIndex = data.hitCharacter + 1u; data.foundIndex < data.totalNumberOfCharacters; ++data.foundIndex)
 114   {
 115     const Dali::Toolkit::Text::Character character = *(data.textBuffer + data.foundIndex);
 116
 117     const bool isWhiteSpaceOrNewParagraph = IsWhiteSpaceOrNewParagraph(character,
 118                                                                        data.isWhiteSpace,
 119                                                                        isHitWhiteSpaceOrNewParagraph);
 120
 121     if(isHitWhiteSpaceOrNewParagraph != isWhiteSpaceOrNewParagraph)
 122     {
 123       break;
 124     }
 125   }
 126 }
 127
 128 } //namespace
 129
 130 namespace Dali
 131 {
 132 namespace Toolkit
 133 {
 134 namespace Text
 135 {
 136 LineIndex GetClosestLine(VisualModelPtr visualModel,
 137                          float          visualY,
 138                          bool&          matchedLine)
 139 {
 140   float     totalHeight = 0.f;
 141   LineIndex lineIndex   = 0;
 142   matchedLine           = false;
 143
 144   if(visualY < 0.f)
 145   {
 146     return 0;
 147   }
 148
 149   const Vector<LineRun>& lines = visualModel->mLines;
 150
 151   for(Vector<LineRun>::ConstIterator it    = lines.Begin(),
 152                                      endIt = lines.End();
 153       it != endIt;
 154       ++it, ++lineIndex)
 155   {
 156     const LineRun& lineRun = *it;
 157
 158     totalHeight += GetLineHeight(lineRun);
 159
 160     if(visualY < totalHeight)
 161     {
 162       matchedLine = true;
 163       return lineIndex;
 164     }
 165   }
 166
 167   if(lineIndex == 0)
 168   {
 169     return 0;
 170   }
 171
 172   return lineIndex - 1u;
 173 }
 174
 175 float CalculateLineOffset(const Vector<LineRun>& lines,
 176                           LineIndex              lineIndex)
 177 {
 178   float offset = 0.f;
 179
 180   for(Vector<LineRun>::ConstIterator it    = lines.Begin(),
 181                                      endIt = lines.Begin() + lineIndex;
 182       it != endIt;
 183       ++it)
 184   {
 185     const LineRun& lineRun = *it;
 186
 187     offset += GetLineHeight(lineRun);
 188   }
 189
 190   return offset;
 191 }
 192
 193 CharacterIndex GetClosestCursorIndex(VisualModelPtr         visualModel,
 194                                      LogicalModelPtr        logicalModel,
 195                                      MetricsPtr             metrics,
 196                                      float                  visualX,
 197                                      float                  visualY,
 198                                      CharacterHitTest::Mode mode,
 199                                      bool&                  matchedCharacter)
 200 {
 201   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "GetClosestCursorIndex, closest visualX %f visualY %f\n", visualX, visualY);
 202
 203   // Whether there is a hit on a glyph.
 204   matchedCharacter = false;
 205
 206   CharacterIndex logicalIndex = 0;
 207
 208   const Length totalNumberOfGlyphs = visualModel->mGlyphs.Count();
 209   const Length totalNumberOfLines  = visualModel->mLines.Count();
 210   if((0 == totalNumberOfGlyphs) ||
 211      (0 == totalNumberOfLines))
 212   {
 213     return logicalIndex;
 214   }
 215
 216   // Whether there is a hit on a line.
 217   bool matchedLine = false;
 218
 219   // Find which line is closest.
 220   const LineIndex lineIndex = Text::GetClosestLine(visualModel,
 221                                                    visualY,
 222                                                    matchedLine);
 223
 224   if(!matchedLine && (CharacterHitTest::TAP == mode))
 225   {
 226     // Return the first or the last character if the touch point doesn't hit a line.
 227     return (visualY < 0.f) ? 0 : logicalModel->mText.Count();
 228   }
 229
 230   // Convert from text's coords to line's coords.
 231   const LineRun& line = *(visualModel->mLines.Begin() + lineIndex);
 232
 233   // Transform the tap point from text's coords to line's coords.
 234   visualX -= line.alignmentOffset;
 235
 236   // Get the positions of the glyphs.
 237   const Vector2* const positionsBuffer = visualModel->mGlyphPositions.Begin();
 238
 239   // Get the character to glyph conversion table.
 240   const GlyphIndex* const charactersToGlyphBuffer = visualModel->mCharactersToGlyph.Begin();
 241
 242   // Get the glyphs per character table.
 243   const Length* const glyphsPerCharacterBuffer = visualModel->mGlyphsPerCharacter.Begin();
 244
 245   // Get the characters per glyph table.
 246   const Length* const charactersPerGlyphBuffer = visualModel->mCharactersPerGlyph.Begin();
 247
 248   // Get the glyph's info buffer.
 249   const GlyphInfo* const glyphInfoBuffer = visualModel->mGlyphs.Begin();
 250
 251   const CharacterIndex startCharacter = line.characterRun.characterIndex;
 252   const CharacterIndex endCharacter   = line.characterRun.characterIndex + line.characterRun.numberOfCharacters;
 253   DALI_ASSERT_DEBUG(endCharacter <= logicalModel->mText.Count() && "Invalid line info");
 254
 255   // Whether this line is a bidirectional line.
 256   const bool bidiLineFetched = logicalModel->FetchBidirectionalLineInfo(startCharacter);
 257
 258   // The character's direction buffer.
 259   const CharacterDirection* const directionsBuffer = bidiLineFetched ? logicalModel->mCharacterDirections.Begin() : NULL;
 260
 261   // Whether the touch point if before the first glyph.
 262   bool isBeforeFirstGlyph = false;
 263
 264   // Traverses glyphs in visual order. To do that use the visual to logical conversion table.
 265   CharacterIndex visualIndex              = startCharacter;
 266   Length         numberOfVisualCharacters = 0;
 267   for(; visualIndex < endCharacter; ++visualIndex)
 268   {
 269     // The character in logical order.
 270     const CharacterIndex     characterLogicalOrderIndex = (bidiLineFetched ? logicalModel->GetLogicalCharacterIndex(visualIndex) : visualIndex);
 271     const CharacterDirection direction                  = (bidiLineFetched ? *(directionsBuffer + characterLogicalOrderIndex) : LTR);
 272
 273     // The number of glyphs for that character
 274     const Length numberOfGlyphs = *(glyphsPerCharacterBuffer + characterLogicalOrderIndex);
 275     ++numberOfVisualCharacters;
 276
 277     if(0 != numberOfGlyphs)
 278     {
 279       // Get the first character/glyph of the group of glyphs.
 280       const CharacterIndex firstVisualCharacterIndex  = 1u + visualIndex - numberOfVisualCharacters;
 281       const CharacterIndex firstLogicalCharacterIndex = (bidiLineFetched ? logicalModel->GetLogicalCharacterIndex(firstVisualCharacterIndex) : firstVisualCharacterIndex);
 282       const GlyphIndex     firstLogicalGlyphIndex     = *(charactersToGlyphBuffer + firstLogicalCharacterIndex);
 283
 284       // Get the metrics for the group of glyphs.
 285       GlyphMetrics glyphMetrics;
 286       GetGlyphsMetrics(firstLogicalGlyphIndex,
 287                        numberOfGlyphs,
 288                        glyphMetrics,
 289                        glyphInfoBuffer,
 290                        metrics);
 291
 292       // Get the position of the first glyph.
 293       const Vector2& position = *(positionsBuffer + firstLogicalGlyphIndex);
 294
 295       if(startCharacter == visualIndex)
 296       {
 297         const float glyphPosition = -glyphMetrics.xBearing + position.x;
 298
 299         if(visualX < glyphPosition)
 300         {
 301           isBeforeFirstGlyph = true;
 302           break;
 303         }
 304       }
 305
 306       // Whether the glyph can be split, like Latin ligatures fi, ff or Arabic (ل + ا).
 307       Length numberOfCharacters = *(charactersPerGlyphBuffer + firstLogicalGlyphIndex);
 308       if(direction != LTR)
 309       {
 310         // As characters are being traversed in visual order,
 311         // for right to left ligatures, the character which contains the
 312         // number of glyphs in the table is found first.
 313         // Jump the number of characters to the next glyph is needed.
 314
 315         if(0 == numberOfCharacters)
 316         {
 317           // TODO: This is a workaround to fix an issue with complex characters in the arabic
 318           // script like i.e. رّ or الأَبْجَدِيَّة العَرَبِيَّة
 319           // There are characters that are not shaped in one glyph but in combination with
 320           // the next one generates two of them.
 321           // The visual to logical conversion table have characters in different order than
 322           // expected even if all of them are arabic.
 323
 324           // The workaround doesn't fix the issue completely but it prevents the application
 325           // to hang in an infinite loop.
 326
 327           // Find the number of characters.
 328           for(GlyphIndex index = firstLogicalGlyphIndex + 1u;
 329               (0 == numberOfCharacters) && (index < totalNumberOfGlyphs);
 330               ++index)
 331           {
 332             numberOfCharacters = *(charactersPerGlyphBuffer + index);
 333           }
 334
 335           if(2u > numberOfCharacters)
 336           {
 337             continue;
 338           }
 339
 340           --numberOfCharacters;
 341         }
 342
 343         visualIndex += numberOfCharacters - 1u;
 344       }
 345
 346       // Get the script of the character.
 347       const Script script = logicalModel->GetScript(characterLogicalOrderIndex);
 348
 349       const bool   isInterglyphIndex = (numberOfCharacters > numberOfGlyphs) && HasLigatureMustBreak(script);
 350       const Length numberOfBlocks    = isInterglyphIndex ? numberOfCharacters : 1u;
 351       const float  glyphAdvance      = glyphMetrics.advance / static_cast<float>(numberOfBlocks);
 352
 353       CharacterIndex index = 0;
 354       for(; index < numberOfBlocks; ++index)
 355       {
 356         // Find the mid-point of the area containing the glyph
 357         const float glyphCenter = -glyphMetrics.xBearing + position.x + (static_cast<float>(index) + 0.5f) * glyphAdvance;
 358
 359         if(visualX < glyphCenter)
 360         {
 361           matchedCharacter = true;
 362           break;
 363         }
 364       }
 365
 366       if(matchedCharacter)
 367       {
 368         // If the glyph is shaped from more than one character, it matches the character of the glyph.
 369         visualIndex = firstVisualCharacterIndex + index;
 370         break;
 371       }
 372
 373       numberOfVisualCharacters = 0;
 374     }
 375   } // for characters in visual order.
 376
 377   // The number of characters of the whole text.
 378   const Length totalNumberOfCharacters = logicalModel->mText.Count();
 379
 380   // Return the logical position of the cursor in characters.
 381
 382   if(!matchedCharacter)
 383   {
 384     if(isBeforeFirstGlyph)
 385     {
 386       // If no character is matched, then the first character (in visual order) of the line is used.
 387       visualIndex = startCharacter;
 388     }
 389     else
 390     {
 391       // If no character is matched, then the last character (in visual order) of the line is used.
 392       visualIndex = endCharacter;
 393     }
 394   }
 395
 396   // Get the paragraph direction.
 397   const CharacterDirection paragraphDirection = line.direction;
 398
 399   if(totalNumberOfCharacters != visualIndex)
 400   {
 401     // The visual index is not at the end of the text.
 402
 403     if(LTR == paragraphDirection)
 404     {
 405       // The paragraph direction is left to right.
 406
 407       if(visualIndex == endCharacter)
 408       {
 409         // It places the cursor just before the last character in visual order.
 410         // i.e. it places the cursor just before the '\n' or before the last character
 411         // if there is a long line with no word breaks which is wrapped.
 412
 413         // It doesn't check if the closest line is the last one like the RTL branch below
 414         // because the total number of characters is different than the visual index and
 415         // the visual index is the last character of the line.
 416         --visualIndex;
 417       }
 418     }
 419     else
 420     {
 421       // The paragraph direction is right to left.
 422
 423       if((lineIndex != totalNumberOfLines - 1u) && // is not the last line.
 424          (visualIndex == startCharacter))
 425       {
 426         // It places the cursor just after the first character in visual order.
 427         // i.e. it places the cursor just after the '\n' or after the last character
 428         // if there is a long line with no word breaks which is wrapped.
 429
 430         // If the last line doesn't end with '\n' it won't increase the visual index
 431         // placing the cursor at the beginning of the line (in visual order).
 432         ++visualIndex;
 433       }
 434     }
 435   }
 436   else
 437   {
 438     // The visual index is at the end of text.
 439
 440     // If the text ends with a new paragraph character i.e. a '\n', an extra line with no characters is added at the end of the text.
 441     // This branch checks if the closest line is the one with the last '\n'. If it is, it decrements the visual index to place
 442     // the cursor just before the last '\n'.
 443
 444     if((lineIndex != totalNumberOfLines - 1u) &&
 445        TextAbstraction::IsNewParagraph(*(logicalModel->mText.Begin() + visualIndex - 1u)))
 446     {
 447       --visualIndex;
 448     }
 449   }
 450
 451   logicalIndex = (bidiLineFetched ? logicalModel->GetLogicalCursorIndex(visualIndex) : visualIndex);
 452
 453   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "closest visualIndex %d logicalIndex %d\n", visualIndex, logicalIndex);
 454
 455   DALI_ASSERT_DEBUG((logicalIndex <= logicalModel->mText.Count() && logicalIndex >= 0) && "GetClosestCursorIndex - Out of bounds index");
 456
 457   return logicalIndex;
 458 }
 459
 460 void GetCursorPosition(GetCursorPositionParameters& parameters,
 461                        float                        defaultFontLineHeight,
 462                        CursorInfo&                  cursorInfo)
 463 {
 464   const LineRun* const modelLines = parameters.visualModel->mLines.Begin();
 465   if(NULL == modelLines)
 466   {
 467     // Nothing to do.
 468     return;
 469   }
 470
 471   // Whether the logical cursor position is at the end of the whole text.
 472   const bool isLastPosition = parameters.logicalModel->mText.Count() == parameters.logical;
 473
 474   // Get the line where the character is laid-out.
 475   const CharacterIndex characterOfLine = isLastPosition ? (parameters.logical - 1u) : parameters.logical;
 476
 477   // Whether the cursor is in the last position and the last position is a new paragraph character.
 478   const bool isLastNewParagraph = parameters.isMultiline && isLastPosition && TextAbstraction::IsNewParagraph(*(parameters.logicalModel->mText.Begin() + characterOfLine));
 479
 480   const LineIndex lineIndex = parameters.visualModel->GetLineOfCharacter(characterOfLine);
 481   const LineRun&  line      = *(modelLines + lineIndex);
 482
 483   const GlyphIndex* const charactersToGlyphBuffer  = parameters.visualModel->mCharactersToGlyph.Begin();
 484   const Length* const     glyphsPerCharacterBuffer = parameters.visualModel->mGlyphsPerCharacter.Begin();
 485   const GlyphInfo* const  glyphInfoBuffer          = parameters.visualModel->mGlyphs.Begin();
 486   CharacterIndex          index;
 487   GlyphMetrics            glyphMetrics;
 488   MetricsPtr&             metrics        = parameters.metrics;
 489   GlyphIndex              glyphIndex     = 0u;
 490   Length                  numberOfGlyphs = 0u;
 491
 492   if(isLastNewParagraph)
 493   {
 494     // The cursor is in a new line with no characters. Place the cursor in that line.
 495     const LineIndex newLineIndex = lineIndex + 1u;
 496     const LineRun&  newLine      = *(modelLines + newLineIndex);
 497
 498     cursorInfo.isSecondaryCursor = false;
 499
 500     // Set the line offset and height.
 501     cursorInfo.lineOffset = CalculateLineOffset(parameters.visualModel->mLines,
 502                                                 newLineIndex);
 503
 504     cursorInfo.lineHeight = GetLineHeight(newLine);
 505
 506     index                                = 0u;
 507     const Length totalNumberOfCharacters = parameters.logicalModel->mText.Count();
 508     if(totalNumberOfCharacters > 0u)
 509     {
 510       index = totalNumberOfCharacters - 1u;
 511     }
 512
 513     GetGlyphMetricsFromCharacterIndex(index, glyphInfoBuffer, charactersToGlyphBuffer, glyphsPerCharacterBuffer, metrics, glyphMetrics, glyphIndex, numberOfGlyphs);
 514
 515     // Set the primary cursor's height.
 516     // The primary cursor height will take the font height of the last character and if there are no characters, it'll take the default font line height.
 517     cursorInfo.primaryCursorHeight = (totalNumberOfCharacters > 0) ? (cursorInfo.isSecondaryCursor ? 0.5f * glyphMetrics.fontHeight : glyphMetrics.fontHeight) : defaultFontLineHeight;
 518
 519     // Set the primary cursor's position.
 520     cursorInfo.primaryPosition.x = (LTR == line.direction) ? newLine.alignmentOffset : parameters.visualModel->mControlSize.width - newLine.alignmentOffset;
 521     cursorInfo.primaryPosition.y = cursorInfo.lineOffset;
 522   }
 523   else
 524   {
 525     // Whether this line is a bidirectional line.
 526     const bool bidiLineFetched = parameters.logicalModel->FetchBidirectionalLineInfo(characterOfLine);
 527
 528     // Check if the logical position is the first or the last one of the line.
 529     const bool isFirstPositionOfLine = line.characterRun.characterIndex == parameters.logical;
 530     const bool isLastPositionOfLine  = line.characterRun.characterIndex + line.characterRun.numberOfCharacters == parameters.logical;
 531
 532     // 'logical' is the logical 'cursor' index.
 533     // Get the next and current logical 'character' index.
 534     const CharacterIndex characterIndex     = isFirstPositionOfLine ? parameters.logical : parameters.logical - 1u;
 535     const CharacterIndex nextCharacterIndex = isLastPositionOfLine ? characterIndex : parameters.logical;
 536
 537     // The character's direction buffer.
 538     const CharacterDirection* const directionsBuffer = bidiLineFetched ? parameters.logicalModel->mCharacterDirections.Begin() : NULL;
 539
 540     CharacterDirection isCurrentRightToLeft = false;
 541     CharacterDirection isNextRightToLeft    = false;
 542     if(bidiLineFetched) // If bidiLineFetched is false, it means the whole text is left to right.
 543     {
 544       isCurrentRightToLeft = *(directionsBuffer + characterIndex);
 545       isNextRightToLeft    = *(directionsBuffer + nextCharacterIndex);
 546     }
 547
 548     // Get the paragraph's direction.
 549     const CharacterDirection isRightToLeftParagraph = line.direction;
 550
 551     // Check whether there is an alternative position:
 552     cursorInfo.isSecondaryCursor = ((!isLastPositionOfLine && (isCurrentRightToLeft != isNextRightToLeft)) ||
 553                                     (isLastPositionOfLine && (isRightToLeftParagraph != isCurrentRightToLeft)) ||
 554                                     (isFirstPositionOfLine && (isRightToLeftParagraph != isCurrentRightToLeft)));
 555
 556     // Set the line offset and height.
 557     cursorInfo.lineOffset = CalculateLineOffset(parameters.visualModel->mLines,
 558                                                 lineIndex);
 559
 560     cursorInfo.lineHeight = GetLineHeight(line);
 561
 562     // Calculate the primary cursor.
 563
 564     index = characterIndex;
 565     if(cursorInfo.isSecondaryCursor)
 566     {
 567       // If there is a secondary position, the primary cursor may be in a different place than the logical index.
 568
 569       if(isLastPositionOfLine)
 570       {
 571         // The position of the cursor after the last character needs special
 572         // care depending on its direction and the direction of the paragraph.
 573
 574         // Need to find the first character after the last character with the paragraph's direction.
 575         // i.e l0 l1 l2 r0 r1 should find r0.
 576
 577         index = isRightToLeftParagraph ? line.characterRun.characterIndex : line.characterRun.characterIndex + line.characterRun.numberOfCharacters - 1u;
 578         if(bidiLineFetched)
 579         {
 580           index = parameters.logicalModel->GetLogicalCharacterIndex(index);
 581         }
 582       }
 583       else if(isFirstPositionOfLine)
 584       {
 585         index = isRightToLeftParagraph ? line.characterRun.characterIndex + line.characterRun.numberOfCharacters - 1u : line.characterRun.characterIndex;
 586         if(bidiLineFetched)
 587         {
 588           index = parameters.logicalModel->GetLogicalCharacterIndex(index);
 589         }
 590       }
 591       else
 592       {
 593         index = (isRightToLeftParagraph == isCurrentRightToLeft) ? characterIndex : nextCharacterIndex;
 594       }
 595     }
 596
 597     const Length* const         charactersPerGlyphBuffer = parameters.visualModel->mCharactersPerGlyph.Begin();
 598     const CharacterIndex* const glyphsToCharactersBuffer = parameters.visualModel->mGlyphsToCharacters.Begin();
 599     const Vector2* const        glyphPositionsBuffer     = parameters.visualModel->mGlyphPositions.Begin();
 600
 601     GetGlyphMetricsFromCharacterIndex(index, glyphInfoBuffer, charactersToGlyphBuffer, glyphsPerCharacterBuffer, metrics, glyphMetrics, glyphIndex, numberOfGlyphs);
 602     const GlyphIndex primaryGlyphIndex         = glyphIndex;
 603     const Length     primaryNumberOfCharacters = *(charactersPerGlyphBuffer + primaryGlyphIndex);
 604
 605     // Whether to add the glyph's advance to the cursor position.
 606     // i.e if the paragraph is left to right and the logical cursor is zero, the position is the position of the first glyph and the advance is not added,
 607     //     if the logical cursor is one, the position is the position of the first glyph and the advance is added.
 608     // A 'truth table' was build and an online Karnaugh map tool was used to simplify the logic.
 609     //
 610     // FLCP A
 611     // ------
 612     // 0000 1
 613     // 0001 1
 614     // 0010 0
 615     // 0011 0
 616     // 0100 1
 617     // 0101 0
 618     // 0110 1
 619     // 0111 0
 620     // 1000 0
 621     // 1001 1
 622     // 1010 0
 623     // 1011 1
 624     // 1100 x
 625     // 1101 x
 626     // 1110 x
 627     // 1111 x
 628     //
 629     // Where F -> isFirstPosition
 630     //       L -> isLastPosition
 631     //       C -> isCurrentRightToLeft
 632     //       P -> isRightToLeftParagraph
 633     //       A -> Whether to add the glyph's advance.
 634
 635     const bool addGlyphAdvance = ((isLastPositionOfLine && !isRightToLeftParagraph) ||
 636                                   (isFirstPositionOfLine && isRightToLeftParagraph) ||
 637                                   (!isFirstPositionOfLine && !isLastPosition && !isCurrentRightToLeft));
 638
 639     float glyphAdvance = addGlyphAdvance ? glyphMetrics.advance : 0.f;
 640
 641     if(!isLastPositionOfLine &&
 642        (primaryNumberOfCharacters > 1u))
 643     {
 644       const CharacterIndex firstIndex = *(glyphsToCharactersBuffer + primaryGlyphIndex);
 645
 646       bool isCurrentRightToLeft = false;
 647       if(bidiLineFetched) // If bidiLineFetched is false, it means the whole text is left to right.
 648       {
 649         isCurrentRightToLeft = *(directionsBuffer + index);
 650       }
 651
 652       Length numberOfGlyphAdvance = (isFirstPositionOfLine ? 0 : 1u) + characterIndex - firstIndex;
 653       if(isCurrentRightToLeft)
 654       {
 655         numberOfGlyphAdvance = primaryNumberOfCharacters - numberOfGlyphAdvance;
 656       }
 657
 658       glyphAdvance = static_cast<float>(numberOfGlyphAdvance) * glyphMetrics.advance / static_cast<float>(primaryNumberOfCharacters);
 659     }
 660
 661     // Get the glyph position and x bearing (in the line's coords).
 662     const Vector2& primaryPosition = *(glyphPositionsBuffer + primaryGlyphIndex);
 663
 664     // Set the primary cursor's height.
 665     cursorInfo.primaryCursorHeight = cursorInfo.isSecondaryCursor ? 0.5f * glyphMetrics.fontHeight : glyphMetrics.fontHeight;
 666
 667     cursorInfo.glyphOffset = line.ascender - glyphMetrics.ascender;
 668     // Set the primary cursor's position.
 669     cursorInfo.primaryPosition.x = -glyphMetrics.xBearing + primaryPosition.x + glyphAdvance;
 670     cursorInfo.primaryPosition.y = cursorInfo.lineOffset + cursorInfo.glyphOffset;
 671
 672     // Transform the cursor info from line's coords to text's coords.
 673     cursorInfo.primaryPosition.x += line.alignmentOffset;
 674
 675     // Calculate the secondary cursor.
 676     if(cursorInfo.isSecondaryCursor)
 677     {
 678       // Set the secondary cursor's height.
 679       cursorInfo.secondaryCursorHeight = 0.5f * glyphMetrics.fontHeight;
 680
 681       CharacterIndex index = characterIndex;
 682       if(!isLastPositionOfLine)
 683       {
 684         index = (isRightToLeftParagraph == isCurrentRightToLeft) ? nextCharacterIndex : characterIndex;
 685       }
 686
 687       GetGlyphMetricsFromCharacterIndex(index, glyphInfoBuffer, charactersToGlyphBuffer, glyphsPerCharacterBuffer, metrics, glyphMetrics, glyphIndex, numberOfGlyphs);
 688       const GlyphIndex secondaryGlyphIndex = glyphIndex;
 689       const Vector2&   secondaryPosition   = *(glyphPositionsBuffer + secondaryGlyphIndex);
 690
 691       // Set the secondary cursor's position.
 692
 693       // FCP A
 694       // ------
 695       // 000 1
 696       // 001 x
 697       // 010 0
 698       // 011 0
 699       // 100 x
 700       // 101 0
 701       // 110 1
 702       // 111 x
 703       //
 704       // Where F -> isFirstPosition
 705       //       C -> isCurrentRightToLeft
 706       //       P -> isRightToLeftParagraph
 707       //       A -> Whether to add the glyph's advance.
 708
 709       const bool addGlyphAdvance = ((!isFirstPositionOfLine && !isCurrentRightToLeft) ||
 710                                     (isFirstPositionOfLine && !isRightToLeftParagraph));
 711
 712       cursorInfo.secondaryPosition.x = -glyphMetrics.xBearing + secondaryPosition.x + (addGlyphAdvance ? glyphMetrics.advance : 0.f);
 713       cursorInfo.secondaryPosition.y = cursorInfo.lineOffset + cursorInfo.lineHeight - cursorInfo.secondaryCursorHeight;
 714
 715       // Transform the cursor info from line's coords to text's coords.
 716       cursorInfo.secondaryPosition.x += line.alignmentOffset;
 717     }
 718   }
 719 }
 720
 721 bool FindSelectionIndices(VisualModelPtr  visualModel,
 722                           LogicalModelPtr logicalModel,
 723                           MetricsPtr      metrics,
 724                           float           visualX,
 725                           float           visualY,
 726                           CharacterIndex& startIndex,
 727                           CharacterIndex& endIndex,
 728                           CharacterIndex& noTextHitIndex)
 729 {
 730   /*
 731   Hit character                                           Select
 732 |-------------------------------------------------------|------------------------------------------|
 733 | On a word                                             | The word                                 |
 734 | On a single white space between words                 | The word before or after the white space |
 735 | On one of the multiple contiguous white spaces        | The white spaces                         |
 736 | On a single white space which is in the position zero | The white space and the next word        |
 737 | On a new paragraph character                          | The word or group of white spaces before |
 738 |-------------------------------------------------------|------------------------------------------|
 739 */
 740   const Length totalNumberOfCharacters = logicalModel->mText.Count();
 741   startIndex                           = 0;
 742   endIndex                             = 0;
 743   noTextHitIndex                       = 0;
 744
 745   if(0 == totalNumberOfCharacters)
 746   {
 747     // Nothing to do if the model is empty.
 748     return false;
 749   }
 750
 751   bool           matchedCharacter = false;
 752   CharacterIndex hitCharacter     = Text::GetClosestCursorIndex(visualModel,
 753                                                             logicalModel,
 754                                                             metrics,
 755                                                             visualX,
 756                                                             visualY,
 757                                                             CharacterHitTest::TAP,
 758                                                             matchedCharacter);
 759
 760   if(!matchedCharacter)
 761   {
 762     noTextHitIndex = hitCharacter;
 763   }
 764
 765   DALI_ASSERT_DEBUG((hitCharacter <= totalNumberOfCharacters) && "GetClosestCursorIndex returned out of bounds index");
 766
 767   if(hitCharacter >= totalNumberOfCharacters)
 768   {
 769     // Closest hit character is the last character.
 770     if(hitCharacter == totalNumberOfCharacters)
 771     {
 772       hitCharacter--; //Hit character index set to last character in logical model
 773     }
 774     else
 775     {
 776       // hitCharacter is out of bounds
 777       return false;
 778     }
 779   }
 780
 781   const Character* const textBuffer = logicalModel->mText.Begin();
 782
 783   startIndex = hitCharacter;
 784   endIndex   = hitCharacter;
 785
 786   // Whether the hit character is a new paragraph character.
 787   const bool isHitCharacterNewParagraph = TextAbstraction::IsNewParagraph(*(textBuffer + hitCharacter));
 788
 789   // Whether the hit character is a white space. Note a new paragraph character is a white space as well but here is not wanted.
 790   const bool isHitCharacterWhiteSpace = TextAbstraction::IsWhiteSpace(*(textBuffer + hitCharacter)) && !isHitCharacterNewParagraph;
 791
 792   FindWordData data(textBuffer,
 793                     totalNumberOfCharacters,
 794                     hitCharacter,
 795                     isHitCharacterWhiteSpace,
 796                     isHitCharacterNewParagraph);
 797
 798   if(isHitCharacterNewParagraph)
 799   {
 800     // Find the first character before the hit one which is not a new paragraph character.
 801
 802     if(hitCharacter > 0)
 803     {
 804       endIndex = hitCharacter - 1u;
 805       for(; endIndex > 0; --endIndex)
 806       {
 807         const Dali::Toolkit::Text::Character character = *(data.textBuffer + endIndex);
 808
 809         if(!Dali::TextAbstraction::IsNewParagraph(character))
 810         {
 811           break;
 812         }
 813       }
 814     }
 815
 816     data.hitCharacter   = endIndex;
 817     data.isNewParagraph = false;
 818     data.isWhiteSpace   = TextAbstraction::IsWhiteSpace(*(textBuffer + data.hitCharacter));
 819   }
 820
 821   // Find the start of the word.
 822   FindStartOfWord(data);
 823   startIndex = data.foundIndex;
 824
 825   // Find the end of the word.
 826   FindEndOfWord(data);
 827   endIndex = data.foundIndex;
 828
 829   if(1u == (endIndex - startIndex))
 830   {
 831     if(isHitCharacterWhiteSpace)
 832     {
 833       // Select the word before or after the white space
 834
 835       if(0 == hitCharacter)
 836       {
 837         data.isWhiteSpace = false;
 838         FindEndOfWord(data);
 839         endIndex = data.foundIndex;
 840       }
 841       else if(hitCharacter > 0)
 842       {
 843         // Find the start of the word.
 844         data.hitCharacter = hitCharacter - 1u;
 845         data.isWhiteSpace = false;
 846         FindStartOfWord(data);
 847         startIndex = data.foundIndex;
 848
 849         --endIndex;
 850       }
 851     }
 852   }
 853
 854   return matchedCharacter;
 855 }
 856
 857 } // namespace Text
 858
 859 } // namespace Toolkit
 860
 861 } // namespace Dali