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

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