dali-toolkit/internal/text/text-controller-relayouter.cpp

   1 /*
   2  * Copyright (c) 2021 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 // CLASS HEADER
  19 #include <dali-toolkit/internal/text/text-controller-relayouter.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/integration-api/debug.h>
  23 #include <limits>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/internal/text/layouts/layout-parameters.h>
  27 #include <dali-toolkit/internal/text/text-controller-impl.h>
  28
  29 namespace
  30 {
  31 #if defined(DEBUG_ENABLED)
  32 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
  33 #endif
  34
  35 constexpr float MAX_FLOAT = std::numeric_limits<float>::max();
  36
  37 float ConvertToEven(float value)
  38 {
  39   int intValue(static_cast<int>(value));
  40   return static_cast<float>(intValue + (intValue & 1));
  41 }
  42
  43 } // namespace
  44
  45 namespace Dali
  46 {
  47 namespace Toolkit
  48 {
  49 namespace Text
  50 {
  51 Size Controller::Relayouter::CalculateLayoutSizeOnRequiredControllerSize(Controller& controller, const Size& requestedControllerSize, const OperationsMask& requestedOperationsMask, bool restoreLinesAndGlyphPositions)
  52 {
  53   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->CalculateLayoutSizeOnRequiredControllerSize\n");
  54   Size calculatedLayoutSize;
  55
  56   Controller::Impl& impl        = *controller.mImpl;
  57   ModelPtr&         model       = impl.mModel;
  58   VisualModelPtr&   visualModel = model->mVisualModel;
  59
  60   // Store the pending operations mask so that it can be restored later on with no modifications made on it
  61   // while getting the natural size were reflected on the original mask.
  62   OperationsMask operationsPendingBackUp = static_cast<OperationsMask>(impl.mOperationsPending);
  63
  64   // This is a hotfix for side effect on Scrolling, LineWrap and Invalid position of cursor in TextEditor after calling CalculateLayoutSizeOnRequiredControllerSize.
  65   // The number of lines and glyph-positions inside visualModel have been changed by calling DoRelayout with requestedControllerSize.
  66   // Store the mLines and mGlyphPositions from visualModel so that they can be restored later on with no modifications made on them.
  67   //TODO: Refactor "DoRelayout" and extract common code of size calculation without modifying attributes of mVisualModel, and then blah, blah, etc.
  68   Vector<LineRun> linesBackup          = visualModel->mLines;
  69   Vector<Vector2> glyphPositionsBackup = visualModel->mGlyphPositions;
  70
  71   // Operations that can be done only once until the text changes.
  72   const OperationsMask onlyOnceOperations = static_cast<OperationsMask>(CONVERT_TO_UTF32 |
  73                                                                         GET_SCRIPTS |
  74                                                                         VALIDATE_FONTS |
  75                                                                         GET_LINE_BREAKS |
  76                                                                         BIDI_INFO |
  77                                                                         SHAPE_TEXT |
  78                                                                         GET_GLYPH_METRICS);
  79
  80   // Set the update info to relayout the whole text.
  81   TextUpdateInfo& textUpdateInfo = impl.mTextUpdateInfo;
  82   if((0 == textUpdateInfo.mNumberOfCharactersToAdd) &&
  83      (0 == textUpdateInfo.mPreviousNumberOfCharacters) &&
  84      ((visualModel->mControlSize.width < Math::MACHINE_EPSILON_1000) || (visualModel->mControlSize.height < Math::MACHINE_EPSILON_1000)))
  85   {
  86     textUpdateInfo.mNumberOfCharactersToAdd = model->mLogicalModel->mText.Count();
  87   }
  88   textUpdateInfo.mParagraphCharacterIndex     = 0u;
  89   textUpdateInfo.mRequestedNumberOfCharacters = model->mLogicalModel->mText.Count();
  90
  91   // Make sure the model is up-to-date before layouting
  92   impl.UpdateModel(onlyOnceOperations);
  93
  94   // Get a reference to the pending operations member
  95   OperationsMask& operationsPending = impl.mOperationsPending;
  96
  97   // Layout the text for the new width.
  98   operationsPending = static_cast<OperationsMask>(operationsPending | requestedOperationsMask);
  99
 100   // Store the actual control's size to restore later.
 101   const Size actualControlSize = visualModel->mControlSize;
 102
 103   DoRelayout(controller,
 104              requestedControllerSize,
 105              static_cast<OperationsMask>(onlyOnceOperations |
 106                                          requestedOperationsMask),
 107              calculatedLayoutSize);
 108
 109   // Clear the update info. This info will be set the next time the text is updated.
 110   textUpdateInfo.Clear();
 111   textUpdateInfo.mClearAll = true;
 112
 113   // Restore the actual control's size.
 114   visualModel->mControlSize = actualControlSize;
 115   // Restore the previously backed-up pending operations' mask without the only once operations.
 116   impl.mOperationsPending = static_cast<OperationsMask>(operationsPendingBackUp & ~onlyOnceOperations);
 117
 118   // Restore the previously backed-up mLines and mGlyphPositions from visualModel.
 119   if(restoreLinesAndGlyphPositions)
 120   {
 121     visualModel->mLines          = linesBackup;
 122     visualModel->mGlyphPositions = glyphPositionsBackup;
 123   }
 124
 125   return calculatedLayoutSize;
 126 }
 127
 128 Vector3 Controller::Relayouter::GetNaturalSize(Controller& controller)
 129 {
 130   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->Controller::GetNaturalSize\n");
 131   Vector3 naturalSizeVec3;
 132
 133   // Make sure the model is up-to-date before layouting
 134   controller.ProcessModifyEvents();
 135
 136   Controller::Impl& impl        = *controller.mImpl;
 137   ModelPtr&         model       = impl.mModel;
 138   VisualModelPtr&   visualModel = model->mVisualModel;
 139
 140   if(impl.mRecalculateNaturalSize)
 141   {
 142     Size naturalSize;
 143
 144     // Layout the text for the new width.
 145     OperationsMask requestedOperationsMask  = static_cast<OperationsMask>(LAYOUT | REORDER);
 146     Size           sizeMaxWidthAndMaxHeight = Size(MAX_FLOAT, MAX_FLOAT);
 147
 148     naturalSize = CalculateLayoutSizeOnRequiredControllerSize(controller, sizeMaxWidthAndMaxHeight, requestedOperationsMask, true);
 149
 150     // Stores the natural size to avoid recalculate it again
 151     // unless the text/style changes.
 152     visualModel->SetNaturalSize(naturalSize);
 153     naturalSizeVec3 = naturalSize;
 154
 155     impl.mRecalculateNaturalSize = false;
 156
 157     DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize calculated %f,%f,%f\n", naturalSizeVec3.x, naturalSizeVec3.y, naturalSizeVec3.z);
 158   }
 159   else
 160   {
 161     naturalSizeVec3 = visualModel->GetNaturalSize();
 162
 163     DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize cached %f,%f,%f\n", naturalSizeVec3.x, naturalSizeVec3.y, naturalSizeVec3.z);
 164   }
 165
 166   naturalSizeVec3.x = ConvertToEven(naturalSizeVec3.x);
 167   naturalSizeVec3.y = ConvertToEven(naturalSizeVec3.y);
 168
 169   return naturalSizeVec3;
 170 }
 171
 172 bool Controller::Relayouter::CheckForTextFit(Controller& controller, float pointSize, const Size& layoutSize)
 173 {
 174   Size              textSize;
 175   Controller::Impl& impl            = *controller.mImpl;
 176   TextUpdateInfo&   textUpdateInfo  = impl.mTextUpdateInfo;
 177   impl.mFontDefaults->mFitPointSize = pointSize;
 178   impl.mFontDefaults->sizeDefined   = true;
 179   impl.ClearFontData();
 180
 181   // Operations that can be done only once until the text changes.
 182   const OperationsMask onlyOnceOperations = static_cast<OperationsMask>(CONVERT_TO_UTF32 |
 183                                                                         GET_SCRIPTS |
 184                                                                         VALIDATE_FONTS |
 185                                                                         GET_LINE_BREAKS |
 186                                                                         BIDI_INFO |
 187                                                                         SHAPE_TEXT |
 188                                                                         GET_GLYPH_METRICS);
 189
 190   textUpdateInfo.mParagraphCharacterIndex     = 0u;
 191   textUpdateInfo.mRequestedNumberOfCharacters = impl.mModel->mLogicalModel->mText.Count();
 192
 193   // Make sure the model is up-to-date before layouting
 194   impl.UpdateModel(onlyOnceOperations);
 195
 196   DoRelayout(controller,
 197              Size(layoutSize.width, MAX_FLOAT),
 198              static_cast<OperationsMask>(onlyOnceOperations | LAYOUT),
 199              textSize);
 200
 201   // Clear the update info. This info will be set the next time the text is updated.
 202   textUpdateInfo.Clear();
 203   textUpdateInfo.mClearAll = true;
 204
 205   if(textSize.width > layoutSize.width || textSize.height > layoutSize.height)
 206   {
 207     return false;
 208   }
 209   return true;
 210 }
 211
 212 void Controller::Relayouter::FitPointSizeforLayout(Controller& controller, const Size& layoutSize)
 213 {
 214   Controller::Impl& impl = *controller.mImpl;
 215
 216   const OperationsMask operations = impl.mOperationsPending;
 217   if(NO_OPERATION != (UPDATE_LAYOUT_SIZE & operations) || impl.mTextFitContentSize != layoutSize)
 218   {
 219     ModelPtr& model = impl.mModel;
 220
 221     bool  actualellipsis      = model->mElideEnabled;
 222     float minPointSize        = impl.mTextFitMinSize;
 223     float maxPointSize        = impl.mTextFitMaxSize;
 224     float pointInterval       = impl.mTextFitStepSize;
 225     float currentFitPointSize = impl.mFontDefaults->mFitPointSize;
 226
 227     model->mElideEnabled = false;
 228     Vector<float> pointSizeArray;
 229
 230     // check zero value
 231     if(pointInterval < 1.f)
 232     {
 233       impl.mTextFitStepSize = pointInterval = 1.0f;
 234     }
 235
 236     pointSizeArray.Reserve(static_cast<unsigned int>(ceil((maxPointSize - minPointSize) / pointInterval)));
 237
 238     for(float i = minPointSize; i < maxPointSize; i += pointInterval)
 239     {
 240       pointSizeArray.PushBack(i);
 241     }
 242
 243     pointSizeArray.PushBack(maxPointSize);
 244
 245     int bestSizeIndex = 0;
 246     int min           = bestSizeIndex + 1;
 247     int max           = pointSizeArray.Size() - 1;
 248     while(min <= max)
 249     {
 250       int destI = (min + max) / 2;
 251
 252       if(CheckForTextFit(controller, pointSizeArray[destI], layoutSize))
 253       {
 254         bestSizeIndex = min;
 255         min           = destI + 1;
 256       }
 257       else
 258       {
 259         max           = destI - 1;
 260         bestSizeIndex = max;
 261       }
 262     }
 263
 264     model->mElideEnabled = actualellipsis;
 265     if(currentFitPointSize != pointSizeArray[bestSizeIndex])
 266     {
 267       impl.mTextFitChanged = true;
 268     }
 269     impl.mFontDefaults->mFitPointSize = pointSizeArray[bestSizeIndex];
 270     impl.mFontDefaults->sizeDefined   = true;
 271     impl.ClearFontData();
 272   }
 273 }
 274
 275 float Controller::Relayouter::GetHeightForWidth(Controller& controller, float width)
 276 {
 277   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->Controller::GetHeightForWidth %p width %f\n", &controller, width);
 278
 279   // Make sure the model is up-to-date before layouting
 280   controller.ProcessModifyEvents();
 281
 282   Controller::Impl& impl           = *controller.mImpl;
 283   ModelPtr&         model          = impl.mModel;
 284   VisualModelPtr&   visualModel    = model->mVisualModel;
 285   TextUpdateInfo&   textUpdateInfo = impl.mTextUpdateInfo;
 286
 287   Size layoutSize;
 288
 289   if(fabsf(width - visualModel->mControlSize.width) > Math::MACHINE_EPSILON_1000 ||
 290      textUpdateInfo.mFullRelayoutNeeded ||
 291      textUpdateInfo.mClearAll)
 292   {
 293     // Layout the text for the new width.
 294     OperationsMask requestedOperationsMask        = static_cast<OperationsMask>(LAYOUT);
 295     Size           sizeRequestedWidthAndMaxHeight = Size(width, MAX_FLOAT);
 296
 297     // Skip restore, because if GetHeightForWidth called before rendering and layouting then visualModel->mControlSize will be zero which will make LineCount zero.
 298     // The implementation of Get LineCount property depends on calling GetHeightForWidth then read mLines.Count() from visualModel direct.
 299     // If the LineCount property is requested before rendering and layouting then the value will be zero, which is incorrect.
 300     // So we will not restore the previously backed-up mLines and mGlyphPositions from visualModel in such case.
 301     // Another case to skip restore is when the requested width equals the Control's width which means the caller need to update the old values.
 302     // For example, when the text is changed.
 303     bool restoreLinesAndGlyphPositions = (visualModel->mControlSize.width > 0 && visualModel->mControlSize.height > 0) && (visualModel->mControlSize.width != width);
 304
 305     layoutSize = CalculateLayoutSizeOnRequiredControllerSize(controller, sizeRequestedWidthAndMaxHeight, requestedOperationsMask, restoreLinesAndGlyphPositions);
 306
 307     DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth calculated %f\n", layoutSize.height);
 308   }
 309   else
 310   {
 311     layoutSize = visualModel->GetLayoutSize();
 312     DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth cached %f\n", layoutSize.height);
 313   }
 314
 315   return layoutSize.height;
 316 }
 317
 318 Controller::UpdateTextType Controller::Relayouter::Relayout(Controller& controller, const Size& size, Dali::LayoutDirection::Type layoutDirection)
 319 {
 320   Controller::Impl& impl           = *controller.mImpl;
 321   ModelPtr&         model          = impl.mModel;
 322   VisualModelPtr&   visualModel    = model->mVisualModel;
 323   TextUpdateInfo&   textUpdateInfo = impl.mTextUpdateInfo;
 324
 325   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->Controller::Relayout %p size %f,%f, autoScroll[%s]\n", &controller, size.width, size.height, impl.mIsAutoScrollEnabled ? "true" : "false");
 326
 327   UpdateTextType updateTextType = NONE_UPDATED;
 328
 329   if((size.width < Math::MACHINE_EPSILON_1000) || (size.height < Math::MACHINE_EPSILON_1000))
 330   {
 331     if(0u != visualModel->mGlyphPositions.Count())
 332     {
 333       visualModel->mGlyphPositions.Clear();
 334       updateTextType = MODEL_UPDATED;
 335     }
 336
 337     // Clear the update info. This info will be set the next time the text is updated.
 338     textUpdateInfo.Clear();
 339
 340     // Not worth to relayout if width or height is equal to zero.
 341     DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::Relayout (skipped)\n");
 342
 343     return updateTextType;
 344   }
 345
 346   // Whether a new size has been set.
 347   const bool newSize = (size != visualModel->mControlSize);
 348
 349   // Get a reference to the pending operations member
 350   OperationsMask& operationsPending = impl.mOperationsPending;
 351
 352   if(newSize)
 353   {
 354     DALI_LOG_INFO(gLogFilter, Debug::Verbose, "new size (previous size %f,%f)\n", visualModel->mControlSize.width, visualModel->mControlSize.height);
 355
 356     if((0 == textUpdateInfo.mNumberOfCharactersToAdd) &&
 357        (0 == textUpdateInfo.mPreviousNumberOfCharacters) &&
 358        ((visualModel->mControlSize.width < Math::MACHINE_EPSILON_1000) || (visualModel->mControlSize.height < Math::MACHINE_EPSILON_1000)))
 359     {
 360       textUpdateInfo.mNumberOfCharactersToAdd = model->mLogicalModel->mText.Count();
 361     }
 362
 363     // Layout operations that need to be done if the size changes.
 364     operationsPending = static_cast<OperationsMask>(operationsPending |
 365                                                     LAYOUT |
 366                                                     ALIGN |
 367                                                     UPDATE_LAYOUT_SIZE |
 368                                                     REORDER);
 369     // Set the update info to relayout the whole text.
 370     textUpdateInfo.mFullRelayoutNeeded = true;
 371     textUpdateInfo.mCharacterIndex     = 0u;
 372
 373     // Store the size used to layout the text.
 374     visualModel->mControlSize = size;
 375   }
 376
 377   // Whether there are modify events.
 378   if(0u != impl.mModifyEvents.Count())
 379   {
 380     // Style operations that need to be done if the text is modified.
 381     operationsPending = static_cast<OperationsMask>(operationsPending | COLOR);
 382   }
 383
 384   // Set the update info to elide the text.
 385   if(model->mElideEnabled ||
 386      ((NULL != impl.mEventData) && impl.mEventData->mIsPlaceholderElideEnabled))
 387   {
 388     // Update Text layout for applying elided
 389     operationsPending                  = static_cast<OperationsMask>(operationsPending |
 390                                                     ALIGN |
 391                                                     LAYOUT |
 392                                                     UPDATE_LAYOUT_SIZE |
 393                                                     REORDER);
 394     textUpdateInfo.mFullRelayoutNeeded = true;
 395     textUpdateInfo.mCharacterIndex     = 0u;
 396   }
 397
 398   if(impl.mLayoutDirection != layoutDirection)
 399   {
 400     // Clear the update info. This info will be set the next time the text is updated.
 401     textUpdateInfo.mClearAll = true;
 402     // Apply modifications to the model
 403     // Shape the text again is needed because characters like '()[]{}' have to be mirrored and the glyphs generated again.
 404     operationsPending     = static_cast<OperationsMask>(operationsPending |
 405                                                     GET_GLYPH_METRICS |
 406                                                     SHAPE_TEXT |
 407                                                     UPDATE_DIRECTION |
 408                                                     ALIGN |
 409                                                     LAYOUT |
 410                                                     BIDI_INFO |
 411                                                     REORDER);
 412     impl.mLayoutDirection = layoutDirection;
 413   }
 414
 415   // Make sure the model is up-to-date before layouting.
 416   controller.ProcessModifyEvents();
 417   bool updated = impl.UpdateModel(operationsPending);
 418
 419   // Layout the text.
 420   Size layoutSize;
 421   updated = DoRelayout(controller, size, operationsPending, layoutSize) || updated;
 422
 423   if(updated)
 424   {
 425     updateTextType = MODEL_UPDATED;
 426   }
 427
 428   // Do not re-do any operation until something changes.
 429   operationsPending          = NO_OPERATION;
 430   model->mScrollPositionLast = model->mScrollPosition;
 431
 432   // Whether the text control is editable
 433   const bool isEditable = NULL != impl.mEventData;
 434
 435   // Keep the current offset as it will be used to update the decorator's positions (if the size changes).
 436   Vector2 offset;
 437   if(newSize && isEditable)
 438   {
 439     offset = model->mScrollPosition;
 440   }
 441
 442   if(!isEditable || !controller.IsMultiLineEnabled())
 443   {
 444     // After doing the text layout, the vertical offset to place the actor in the desired position can be calculated.
 445     controller.CalculateVerticalOffset(size);
 446   }
 447
 448   if(isEditable)
 449   {
 450     if(newSize)
 451     {
 452       // If there is a new size, the scroll position needs to be clamped.
 453       impl.ClampHorizontalScroll(layoutSize);
 454
 455       // Update the decorator's positions is needed if there is a new size.
 456       impl.mEventData->mDecorator->UpdatePositions(model->mScrollPosition - offset);
 457     }
 458
 459     // Move the cursor, grab handle etc.
 460     if(impl.ProcessInputEvents())
 461     {
 462       updateTextType = static_cast<UpdateTextType>(updateTextType | DECORATOR_UPDATED);
 463     }
 464   }
 465
 466   // Clear the update info. This info will be set the next time the text is updated.
 467   textUpdateInfo.Clear();
 468   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::Relayout\n");
 469
 470   return updateTextType;
 471 }
 472
 473 bool Controller::Relayouter::DoRelayout(Controller& controller, const Size& size, OperationsMask operationsRequired, Size& layoutSize)
 474 {
 475   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->Controller::DoRelayout %p size %f,%f\n", &controller, size.width, size.height);
 476   bool viewUpdated(false);
 477
 478   Controller::Impl& impl = *controller.mImpl;
 479
 480   // Calculate the operations to be done.
 481   const OperationsMask operations = static_cast<OperationsMask>(impl.mOperationsPending & operationsRequired);
 482
 483   TextUpdateInfo&      textUpdateInfo              = impl.mTextUpdateInfo;
 484   const CharacterIndex startIndex                  = textUpdateInfo.mParagraphCharacterIndex;
 485   const Length         requestedNumberOfCharacters = textUpdateInfo.mRequestedNumberOfCharacters;
 486
 487   // Get the current layout size.
 488   VisualModelPtr& visualModel = impl.mModel->mVisualModel;
 489   layoutSize                  = visualModel->GetLayoutSize();
 490
 491   if(NO_OPERATION != (LAYOUT & operations))
 492   {
 493     DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->Controller::DoRelayout LAYOUT & operations\n");
 494
 495     // Some vectors with data needed to layout and reorder may be void
 496     // after the first time the text has been laid out.
 497     // Fill the vectors again.
 498
 499     // Calculate the number of glyphs to layout.
 500     const Vector<GlyphIndex>& charactersToGlyph        = visualModel->mCharactersToGlyph;
 501     const Vector<Length>&     glyphsPerCharacter       = visualModel->mGlyphsPerCharacter;
 502     const GlyphIndex* const   charactersToGlyphBuffer  = charactersToGlyph.Begin();
 503     const Length* const       glyphsPerCharacterBuffer = glyphsPerCharacter.Begin();
 504
 505     const CharacterIndex lastIndex       = startIndex + ((requestedNumberOfCharacters > 0u) ? requestedNumberOfCharacters - 1u : 0u);
 506     const GlyphIndex     startGlyphIndex = textUpdateInfo.mStartGlyphIndex;
 507
 508     // Make sure the index is not out of bound
 509     if(charactersToGlyph.Count() != glyphsPerCharacter.Count() ||
 510        requestedNumberOfCharacters > charactersToGlyph.Count() ||
 511        (lastIndex > charactersToGlyph.Count() && charactersToGlyph.Count() > 0u))
 512     {
 513       std::string currentText;
 514       controller.GetText(currentText);
 515
 516       DALI_LOG_ERROR("Controller::DoRelayout: Attempting to access invalid buffer\n");
 517       DALI_LOG_ERROR("Current text is: %s\n", currentText.c_str());
 518       DALI_LOG_ERROR("startIndex: %u, lastIndex: %u, requestedNumberOfCharacters: %u, charactersToGlyph.Count = %lu, glyphsPerCharacter.Count = %lu\n", startIndex, lastIndex, requestedNumberOfCharacters, charactersToGlyph.Count(), glyphsPerCharacter.Count());
 519
 520       return false;
 521     }
 522
 523     const Length numberOfGlyphs      = (requestedNumberOfCharacters > 0u) ? *(charactersToGlyphBuffer + lastIndex) + *(glyphsPerCharacterBuffer + lastIndex) - startGlyphIndex : 0u;
 524     const Length totalNumberOfGlyphs = visualModel->mGlyphs.Count();
 525
 526     if(0u == totalNumberOfGlyphs)
 527     {
 528       if(NO_OPERATION != (UPDATE_LAYOUT_SIZE & operations))
 529       {
 530         visualModel->SetLayoutSize(Size::ZERO);
 531       }
 532
 533       // Nothing else to do if there is no glyphs.
 534       DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::DoRelayout no glyphs, view updated true\n");
 535       return true;
 536     }
 537
 538     // Set the layout parameters.
 539     Layout::Parameters layoutParameters(size, impl.mModel);
 540
 541     // Resize the vector of positions to have the same size than the vector of glyphs.
 542     Vector<Vector2>& glyphPositions = visualModel->mGlyphPositions;
 543     glyphPositions.Resize(totalNumberOfGlyphs);
 544
 545     // Whether the last character is a new paragraph character.
 546     const Character* const textBuffer           = impl.mModel->mLogicalModel->mText.Begin();
 547     textUpdateInfo.mIsLastCharacterNewParagraph = TextAbstraction::IsNewParagraph(*(textBuffer + (impl.mModel->mLogicalModel->mText.Count() - 1u)));
 548     layoutParameters.isLastNewParagraph         = textUpdateInfo.mIsLastCharacterNewParagraph;
 549
 550     // The initial glyph and the number of glyphs to layout.
 551     layoutParameters.startGlyphIndex        = startGlyphIndex;
 552     layoutParameters.numberOfGlyphs         = numberOfGlyphs;
 553     layoutParameters.startLineIndex         = textUpdateInfo.mStartLineIndex;
 554     layoutParameters.estimatedNumberOfLines = textUpdateInfo.mEstimatedNumberOfLines;
 555
 556     // Update the ellipsis
 557     bool elideTextEnabled = impl.mModel->mElideEnabled;
 558     auto ellipsisPosition = impl.mModel->mEllipsisPosition;
 559
 560     if(NULL != impl.mEventData)
 561     {
 562       if(impl.mEventData->mPlaceholderEllipsisFlag && impl.IsShowingPlaceholderText())
 563       {
 564         elideTextEnabled = impl.mEventData->mIsPlaceholderElideEnabled;
 565       }
 566       else if(EventData::INACTIVE != impl.mEventData->mState)
 567       {
 568         // Disable ellipsis when editing
 569         elideTextEnabled = false;
 570       }
 571
 572       // Reset the scroll position in inactive state
 573       if(elideTextEnabled && (impl.mEventData->mState == EventData::INACTIVE))
 574       {
 575         impl.ResetScrollPosition();
 576       }
 577     }
 578
 579     // Update the visual model.
 580     bool isAutoScrollEnabled = impl.mIsAutoScrollEnabled;
 581     Size newLayoutSize;
 582     viewUpdated               = impl.mLayoutEngine.LayoutText(layoutParameters,
 583                                                 newLayoutSize,
 584                                                 elideTextEnabled,
 585                                                 isAutoScrollEnabled,
 586                                                 ellipsisPosition);
 587     impl.mIsAutoScrollEnabled = isAutoScrollEnabled;
 588
 589     viewUpdated = viewUpdated || (newLayoutSize != layoutSize);
 590
 591     if(viewUpdated)
 592     {
 593       layoutSize = newLayoutSize;
 594
 595       if(NO_OPERATION != (UPDATE_DIRECTION & operations))
 596       {
 597         impl.mIsTextDirectionRTL = false;
 598       }
 599
 600       if((NO_OPERATION != (UPDATE_DIRECTION & operations)) && !visualModel->mLines.Empty())
 601       {
 602         impl.mIsTextDirectionRTL = visualModel->mLines[0u].direction;
 603       }
 604
 605       // Sets the layout size.
 606       if(NO_OPERATION != (UPDATE_LAYOUT_SIZE & operations))
 607       {
 608         visualModel->SetLayoutSize(layoutSize);
 609       }
 610     } // view updated
 611   }
 612
 613   if(NO_OPERATION != (ALIGN & operations))
 614   {
 615     // The laid-out lines.
 616     Vector<LineRun>& lines = visualModel->mLines;
 617
 618     CharacterIndex alignStartIndex                  = startIndex;
 619     Length         alignRequestedNumberOfCharacters = requestedNumberOfCharacters;
 620
 621     // the whole text needs to be full aligned.
 622     // If you do not do a full aligned, only the last line of the multiline input is aligned.
 623     if(impl.mEventData && impl.mEventData->mUpdateAlignment)
 624     {
 625       alignStartIndex                   = 0u;
 626       alignRequestedNumberOfCharacters  = impl.mModel->mLogicalModel->mText.Count();
 627       impl.mEventData->mUpdateAlignment = false;
 628     }
 629
 630     // Need to align with the control's size as the text may contain lines
 631     // starting either with left to right text or right to left.
 632     impl.mLayoutEngine.Align(size,
 633                              alignStartIndex,
 634                              alignRequestedNumberOfCharacters,
 635                              impl.mModel->mHorizontalAlignment,
 636                              lines,
 637                              impl.mModel->mAlignmentOffset,
 638                              impl.mLayoutDirection,
 639                              (impl.mModel->mMatchLayoutDirection != DevelText::MatchLayoutDirection::CONTENTS));
 640
 641     viewUpdated = true;
 642   }
 643 #if defined(DEBUG_ENABLED)
 644   std::string currentText;
 645   controller.GetText(currentText);
 646   DALI_LOG_INFO(gLogFilter, Debug::Concise, "Controller::DoRelayout [%p] mImpl->mIsTextDirectionRTL[%s] [%s]\n", &controller, (impl.mIsTextDirectionRTL) ? "true" : "false", currentText.c_str());
 647 #endif
 648   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::DoRelayout, view updated %s\n", (viewUpdated ? "true" : "false"));
 649   return viewUpdated;
 650 }
 651
 652 void Controller::Relayouter::CalculateVerticalOffset(Controller& controller, const Size& controlSize)
 653 {
 654   Controller::Impl& impl                  = *controller.mImpl;
 655   ModelPtr&         model                 = impl.mModel;
 656   VisualModelPtr&   visualModel           = model->mVisualModel;
 657   Size              layoutSize            = model->mVisualModel->GetLayoutSize();
 658   Size              oldLayoutSize         = layoutSize;
 659   float             offsetY               = 0.f;
 660   bool              needRecalc            = false;
 661   float             defaultFontLineHeight = impl.GetDefaultFontLineHeight();
 662
 663   if(fabsf(layoutSize.height) < Math::MACHINE_EPSILON_1000)
 664   {
 665     // Get the line height of the default font.
 666     layoutSize.height = defaultFontLineHeight;
 667   }
 668
 669   // Whether the text control is editable
 670   const bool isEditable = NULL != impl.mEventData;
 671   if(isEditable && layoutSize.height != defaultFontLineHeight && impl.IsShowingPlaceholderText())
 672   {
 673     // This code prevents the wrong positioning of cursor when the layout size is bigger/smaller than defaultFontLineHeight.
 674     // This situation occurs when the size of placeholder text is different from the default text.
 675     layoutSize.height = defaultFontLineHeight;
 676     needRecalc        = true;
 677   }
 678
 679   switch(model->mVerticalAlignment)
 680   {
 681     case VerticalAlignment::TOP:
 682     {
 683       model->mScrollPosition.y = 0.f;
 684       offsetY                  = 0.f;
 685       break;
 686     }
 687     case VerticalAlignment::CENTER:
 688     {
 689       model->mScrollPosition.y = floorf(0.5f * (controlSize.height - layoutSize.height)); // try to avoid pixel alignment.
 690       if(needRecalc) offsetY = floorf(0.5f * (layoutSize.height - oldLayoutSize.height));
 691       break;
 692     }
 693     case VerticalAlignment::BOTTOM:
 694     {
 695       model->mScrollPosition.y = controlSize.height - layoutSize.height;
 696       if(needRecalc) offsetY = layoutSize.height - oldLayoutSize.height;
 697       break;
 698     }
 699   }
 700
 701   if(needRecalc)
 702   {
 703     // Update glyphPositions according to recalculation.
 704     const Length     positionCount  = visualModel->mGlyphPositions.Count();
 705     Vector<Vector2>& glyphPositions = visualModel->mGlyphPositions;
 706     for(Length index = 0u; index < positionCount; index++)
 707     {
 708       glyphPositions[index].y += offsetY;
 709     }
 710   }
 711 }
 712
 713 } // namespace Text
 714
 715 } // namespace Toolkit
 716
 717 } // namespace Dali