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-event-handler.h>
  28 #include <dali-toolkit/internal/text/text-controller-impl.h>
  29
  30 namespace
  31 {
  32 #if defined(DEBUG_ENABLED)
  33 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, true, "LOG_TEXT_CONTROLS");
  34 #endif
  35
  36 constexpr float MAX_FLOAT = std::numeric_limits<float>::max();
  37
  38 float ConvertToEven(float value)
  39 {
  40   int intValue(static_cast<int>(value));
  41   return static_cast<float>(intValue + (intValue & 1));
  42 }
  43
  44 } // namespace
  45
  46 namespace Dali
  47 {
  48 namespace Toolkit
  49 {
  50 namespace Text
  51 {
  52 Size Controller::Relayouter::CalculateLayoutSizeOnRequiredControllerSize(Controller& controller, const Size& requestedControllerSize, const OperationsMask& requestedOperationsMask)
  53 {
  54   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->CalculateLayoutSizeOnRequiredControllerSize\n");
  55   Size calculatedLayoutSize;
  56
  57   Controller::Impl& impl        = *controller.mImpl;
  58   ModelPtr&         model       = impl.mModel;
  59   VisualModelPtr&   visualModel = model->mVisualModel;
  60
  61   // Operations that can be done only once until the text changes.
  62   const OperationsMask onlyOnceOperations = static_cast<OperationsMask>(CONVERT_TO_UTF32 |
  63                                                                         GET_SCRIPTS |
  64                                                                         VALIDATE_FONTS |
  65                                                                         GET_LINE_BREAKS |
  66                                                                         BIDI_INFO |
  67                                                                         SHAPE_TEXT |
  68                                                                         GET_GLYPH_METRICS);
  69
  70   // Set the update info to relayout the whole text.
  71   TextUpdateInfo& textUpdateInfo = impl.mTextUpdateInfo;
  72   if((0 == textUpdateInfo.mNumberOfCharactersToAdd) &&
  73      (0 == textUpdateInfo.mPreviousNumberOfCharacters) &&
  74      ((visualModel->mControlSize.width < Math::MACHINE_EPSILON_1000) || (visualModel->mControlSize.height < Math::MACHINE_EPSILON_1000)))
  75   {
  76     textUpdateInfo.mNumberOfCharactersToAdd = model->mLogicalModel->mText.Count();
  77   }
  78   textUpdateInfo.mParagraphCharacterIndex     = 0u;
  79   textUpdateInfo.mRequestedNumberOfCharacters = model->mLogicalModel->mText.Count();
  80
  81   // This is to keep Index to the first character to be updated.
  82   // Then restore it after calling Clear method.
  83   auto updateInfoCharIndexBackup = textUpdateInfo.mCharacterIndex;
  84
  85   // Get a reference to the pending operations member
  86   OperationsMask& operationsPending = impl.mOperationsPending;
  87
  88   // Layout the text for the new width.
  89   // Apply the pending operations, requested operations and the only once operations.
  90   // Then remove onlyOnceOperations
  91   operationsPending = static_cast<OperationsMask>(operationsPending | requestedOperationsMask | onlyOnceOperations);
  92
  93   // Make sure the model is up-to-date before layouting
  94   impl.UpdateModel(static_cast<OperationsMask>(operationsPending & ~UPDATE_LAYOUT_SIZE));
  95
  96   // Store the actual control's size to restore later.
  97   const Size actualControlSize = visualModel->mControlSize;
  98
  99   DoRelayout(impl,
 100              requestedControllerSize,
 101              static_cast<OperationsMask>(operationsPending & ~UPDATE_LAYOUT_SIZE),
 102              calculatedLayoutSize);
 103
 104   // Clear the update info. This info will be set the next time the text is updated.
 105   textUpdateInfo.Clear();
 106
 107   //TODO: Refactor "DoRelayout" and extract common code of size calculation without modifying attributes of mVisualModel,
 108   //TODO: then calculate GlyphPositions. Lines, Size, Layout for Natural-Size
 109   //TODO: and utilize the values in OperationsPending and TextUpdateInfo without changing the original one.
 110   //TODO: Also it will improve performance because there is no need todo FullRelyout on the next need for layouting.
 111
 112   // FullRelayoutNeeded should be true because DoRelayout is MAX_FLOAT, MAX_FLOAT.
 113   // By this no need to take backup and restore it.
 114   textUpdateInfo.mFullRelayoutNeeded = true;
 115
 116   // Restore mCharacterIndex. Because "Clear" set it to the maximum integer.
 117   // The "CalculateTextUpdateIndices" does not work proprely because the mCharacterIndex will be greater than mPreviousNumberOfCharacters.
 118   // Which apply an assumption to update only the last  paragraph. That could cause many of out of index crashes.
 119   textUpdateInfo.mCharacterIndex = updateInfoCharIndexBackup;
 120
 121   // Do not do again the only once operations.
 122   operationsPending = static_cast<OperationsMask>(operationsPending & ~onlyOnceOperations);
 123
 124   // Do the size related operations again.
 125
 126   const OperationsMask sizeOperations = static_cast<OperationsMask>(LAYOUT |
 127                                                                     ALIGN |
 128                                                                     REORDER);
 129
 130   operationsPending = static_cast<OperationsMask>(operationsPending | sizeOperations);
 131
 132   // Restore the actual control's size.
 133   visualModel->mControlSize = actualControlSize;
 134
 135   return calculatedLayoutSize;
 136 }
 137
 138 Vector3 Controller::Relayouter::GetNaturalSize(Controller& controller)
 139 {
 140   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->Controller::GetNaturalSize\n");
 141   Vector3 naturalSizeVec3;
 142
 143   // Make sure the model is up-to-date before layouting
 144   EventHandler::ProcessModifyEvents(controller);
 145
 146   Controller::Impl& impl        = *controller.mImpl;
 147   ModelPtr&         model       = impl.mModel;
 148   VisualModelPtr&   visualModel = model->mVisualModel;
 149
 150   if(impl.mRecalculateNaturalSize)
 151   {
 152     Size naturalSize;
 153
 154     // Layout the text for the new width.
 155     OperationsMask requestedOperationsMask  = static_cast<OperationsMask>(LAYOUT | REORDER);
 156     Size           sizeMaxWidthAndMaxHeight = Size(MAX_FLOAT, MAX_FLOAT);
 157
 158     naturalSize = CalculateLayoutSizeOnRequiredControllerSize(controller, sizeMaxWidthAndMaxHeight, requestedOperationsMask);
 159
 160     // Stores the natural size to avoid recalculate it again
 161     // unless the text/style changes.
 162     visualModel->SetNaturalSize(naturalSize);
 163     naturalSizeVec3 = naturalSize;
 164
 165     impl.mRecalculateNaturalSize = false;
 166
 167     DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize calculated %f,%f,%f\n", naturalSizeVec3.x, naturalSizeVec3.y, naturalSizeVec3.z);
 168   }
 169   else
 170   {
 171     naturalSizeVec3 = visualModel->GetNaturalSize();
 172
 173     DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize cached %f,%f,%f\n", naturalSizeVec3.x, naturalSizeVec3.y, naturalSizeVec3.z);
 174   }
 175
 176   naturalSizeVec3.x = ConvertToEven(naturalSizeVec3.x);
 177   naturalSizeVec3.y = ConvertToEven(naturalSizeVec3.y);
 178
 179   return naturalSizeVec3;
 180 }
 181
 182 bool Controller::Relayouter::CheckForTextFit(Controller& controller, float pointSize, const Size& layoutSize)
 183 {
 184   Size              textSize;
 185   Controller::Impl& impl            = *controller.mImpl;
 186   TextUpdateInfo&   textUpdateInfo  = impl.mTextUpdateInfo;
 187   impl.mFontDefaults->mFitPointSize = pointSize;
 188   impl.mFontDefaults->sizeDefined   = true;
 189   impl.ClearFontData();
 190
 191   // Operations that can be done only once until the text changes.
 192   const OperationsMask onlyOnceOperations = static_cast<OperationsMask>(CONVERT_TO_UTF32 |
 193                                                                         GET_SCRIPTS |
 194                                                                         VALIDATE_FONTS |
 195                                                                         GET_LINE_BREAKS |
 196                                                                         BIDI_INFO |
 197                                                                         SHAPE_TEXT |
 198                                                                         GET_GLYPH_METRICS);
 199
 200   textUpdateInfo.mParagraphCharacterIndex     = 0u;
 201   textUpdateInfo.mRequestedNumberOfCharacters = impl.mModel->mLogicalModel->mText.Count();
 202
 203   // Make sure the model is up-to-date before layouting
 204   impl.UpdateModel(onlyOnceOperations);
 205
 206   DoRelayout(impl,
 207              Size(layoutSize.width, MAX_FLOAT),
 208              static_cast<OperationsMask>(onlyOnceOperations | LAYOUT),
 209              textSize);
 210
 211   // Clear the update info. This info will be set the next time the text is updated.
 212   textUpdateInfo.Clear();
 213   textUpdateInfo.mClearAll = true;
 214
 215   if(textSize.width > layoutSize.width || textSize.height > layoutSize.height)
 216   {
 217     return false;
 218   }
 219   return true;
 220 }
 221
 222 void Controller::Relayouter::FitPointSizeforLayout(Controller& controller, const Size& layoutSize)
 223 {
 224   Controller::Impl& impl = *controller.mImpl;
 225
 226   const OperationsMask operations = impl.mOperationsPending;
 227   if(NO_OPERATION != (UPDATE_LAYOUT_SIZE & operations) || impl.mTextFitContentSize != layoutSize)
 228   {
 229     ModelPtr& model = impl.mModel;
 230
 231     bool  actualellipsis      = model->mElideEnabled;
 232     float minPointSize        = impl.mTextFitMinSize;
 233     float maxPointSize        = impl.mTextFitMaxSize;
 234     float pointInterval       = impl.mTextFitStepSize;
 235     float currentFitPointSize = impl.mFontDefaults->mFitPointSize;
 236
 237     model->mElideEnabled = false;
 238     Vector<float> pointSizeArray;
 239
 240     // check zero value
 241     if(pointInterval < 1.f)
 242     {
 243       impl.mTextFitStepSize = pointInterval = 1.0f;
 244     }
 245
 246     pointSizeArray.Reserve(static_cast<unsigned int>(ceil((maxPointSize - minPointSize) / pointInterval)));
 247
 248     for(float i = minPointSize; i < maxPointSize; i += pointInterval)
 249     {
 250       pointSizeArray.PushBack(i);
 251     }
 252
 253     pointSizeArray.PushBack(maxPointSize);
 254
 255     int bestSizeIndex = 0;
 256     int min           = bestSizeIndex + 1;
 257     int max           = pointSizeArray.Size() - 1;
 258     while(min <= max)
 259     {
 260       int destI = (min + max) / 2;
 261
 262       if(CheckForTextFit(controller, pointSizeArray[destI], layoutSize))
 263       {
 264         bestSizeIndex = min;
 265         min           = destI + 1;
 266       }
 267       else
 268       {
 269         max           = destI - 1;
 270         bestSizeIndex = max;
 271       }
 272     }
 273
 274     model->mElideEnabled = actualellipsis;
 275     if(currentFitPointSize != pointSizeArray[bestSizeIndex])
 276     {
 277       impl.mTextFitChanged = true;
 278     }
 279     impl.mFontDefaults->mFitPointSize = pointSizeArray[bestSizeIndex];
 280     impl.mFontDefaults->sizeDefined   = true;
 281     impl.ClearFontData();
 282   }
 283 }
 284
 285 float Controller::Relayouter::GetHeightForWidth(Controller& controller, float width)
 286 {
 287   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->Controller::GetHeightForWidth %p width %f\n", &controller, width);
 288
 289   // Make sure the model is up-to-date before layouting
 290   EventHandler::ProcessModifyEvents(controller);
 291
 292   Controller::Impl& impl           = *controller.mImpl;
 293   ModelPtr&         model          = impl.mModel;
 294   VisualModelPtr&   visualModel    = model->mVisualModel;
 295   TextUpdateInfo&   textUpdateInfo = impl.mTextUpdateInfo;
 296
 297   Size layoutSize;
 298
 299   if(fabsf(width - visualModel->mControlSize.width) > Math::MACHINE_EPSILON_1000 ||
 300      textUpdateInfo.mFullRelayoutNeeded ||
 301      textUpdateInfo.mClearAll)
 302   {
 303     // Layout the text for the new width.
 304     OperationsMask requestedOperationsMask        = static_cast<OperationsMask>(LAYOUT);
 305     Size           sizeRequestedWidthAndMaxHeight = Size(width, MAX_FLOAT);
 306
 307     layoutSize = CalculateLayoutSizeOnRequiredControllerSize(controller, sizeRequestedWidthAndMaxHeight, requestedOperationsMask);
 308
 309     DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth calculated %f\n", layoutSize.height);
 310   }
 311   else
 312   {
 313     layoutSize = visualModel->GetLayoutSize();
 314     DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth cached %f\n", layoutSize.height);
 315   }
 316
 317   return layoutSize.height;
 318 }
 319
 320 Controller::UpdateTextType Controller::Relayouter::Relayout(Controller& controller, const Size& size, Dali::LayoutDirection::Type layoutDirection)
 321 {
 322   Controller::Impl& impl           = *controller.mImpl;
 323   ModelPtr&         model          = impl.mModel;
 324   VisualModelPtr&   visualModel    = model->mVisualModel;
 325   TextUpdateInfo&   textUpdateInfo = impl.mTextUpdateInfo;
 326
 327   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->Controller::Relayout %p size %f,%f, autoScroll[%s]\n", &controller, size.width, size.height, impl.mIsAutoScrollEnabled ? "true" : "false");
 328
 329   UpdateTextType updateTextType = NONE_UPDATED;
 330
 331   if((size.width < Math::MACHINE_EPSILON_1000) || (size.height < Math::MACHINE_EPSILON_1000))
 332   {
 333     if(0u != visualModel->mGlyphPositions.Count())
 334     {
 335       visualModel->mGlyphPositions.Clear();
 336       updateTextType = MODEL_UPDATED;
 337     }
 338
 339     // Clear the update info. This info will be set the next time the text is updated.
 340     textUpdateInfo.Clear();
 341
 342     // Not worth to relayout if width or height is equal to zero.
 343     DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::Relayout (skipped)\n");
 344
 345     return updateTextType;
 346   }
 347
 348   // Whether a new size has been set.
 349   const bool newSize = (size != visualModel->mControlSize);
 350
 351   // Get a reference to the pending operations member
 352   OperationsMask& operationsPending = impl.mOperationsPending;
 353
 354   if(newSize)
 355   {
 356     DALI_LOG_INFO(gLogFilter, Debug::Verbose, "new size (previous size %f,%f)\n", visualModel->mControlSize.width, visualModel->mControlSize.height);
 357
 358     if((0 == textUpdateInfo.mNumberOfCharactersToAdd) &&
 359        (0 == textUpdateInfo.mPreviousNumberOfCharacters) &&
 360        ((visualModel->mControlSize.width < Math::MACHINE_EPSILON_1000) || (visualModel->mControlSize.height < Math::MACHINE_EPSILON_1000)))
 361     {
 362       textUpdateInfo.mNumberOfCharactersToAdd = model->mLogicalModel->mText.Count();
 363     }
 364
 365     // Layout operations that need to be done if the size changes.
 366     operationsPending = static_cast<OperationsMask>(operationsPending |
 367                                                     LAYOUT |
 368                                                     ALIGN |
 369                                                     UPDATE_LAYOUT_SIZE |
 370                                                     REORDER);
 371     // Set the update info to relayout the whole text.
 372     textUpdateInfo.mFullRelayoutNeeded = true;
 373     textUpdateInfo.mCharacterIndex     = 0u;
 374
 375     // Store the size used to layout the text.
 376     visualModel->mControlSize = size;
 377   }
 378
 379   // Whether there are modify events.
 380   if(0u != impl.mModifyEvents.Count())
 381   {
 382     // Style operations that need to be done if the text is modified.
 383     operationsPending = static_cast<OperationsMask>(operationsPending | COLOR);
 384   }
 385
 386   // Set the update info to elide the text.
 387   if(model->mElideEnabled ||
 388      ((NULL != impl.mEventData) && impl.mEventData->mIsPlaceholderElideEnabled))
 389   {
 390     // Update Text layout for applying elided
 391     operationsPending                  = static_cast<OperationsMask>(operationsPending |
 392                                                     ALIGN |
 393                                                     LAYOUT |
 394                                                     UPDATE_LAYOUT_SIZE |
 395                                                     REORDER);
 396     textUpdateInfo.mFullRelayoutNeeded = true;
 397     textUpdateInfo.mCharacterIndex     = 0u;
 398   }
 399
 400   if(impl.mLayoutDirection != layoutDirection)
 401   {
 402     // Clear the update info. This info will be set the next time the text is updated.
 403     textUpdateInfo.mClearAll = true;
 404     // Apply modifications to the model
 405     // Shape the text again is needed because characters like '()[]{}' have to be mirrored and the glyphs generated again.
 406     operationsPending     = static_cast<OperationsMask>(operationsPending |
 407                                                     GET_GLYPH_METRICS |
 408                                                     SHAPE_TEXT |
 409                                                     UPDATE_DIRECTION |
 410                                                     ALIGN |
 411                                                     LAYOUT |
 412                                                     BIDI_INFO |
 413                                                     REORDER);
 414     impl.mLayoutDirection = layoutDirection;
 415   }
 416
 417   // Make sure the model is up-to-date before layouting.
 418   EventHandler::ProcessModifyEvents(controller);
 419   bool updated = impl.UpdateModel(operationsPending);
 420
 421   // Layout the text.
 422   Size layoutSize;
 423   updated = DoRelayout(impl, size, operationsPending, layoutSize) || updated;
 424
 425   if(updated)
 426   {
 427     updateTextType = MODEL_UPDATED;
 428   }
 429
 430   // Do not re-do any operation until something changes.
 431   operationsPending          = NO_OPERATION;
 432   model->mScrollPositionLast = model->mScrollPosition;
 433
 434   // Whether the text control is editable
 435   const bool isEditable = NULL != impl.mEventData;
 436
 437   // Keep the current offset as it will be used to update the decorator's positions (if the size changes).
 438   Vector2 offset;
 439   if(newSize && isEditable)
 440   {
 441     offset = model->mScrollPosition;
 442   }
 443
 444   if(!isEditable || !controller.IsMultiLineEnabled())
 445   {
 446     // After doing the text layout, the vertical offset to place the actor in the desired position can be calculated.
 447     CalculateVerticalOffset(controller, size);
 448   }
 449
 450   if(isEditable)
 451   {
 452     if(newSize)
 453     {
 454       // If there is a new size, the scroll position needs to be clamped.
 455       impl.ClampHorizontalScroll(layoutSize);
 456
 457       // Update the decorator's positions is needed if there is a new size.
 458       impl.mEventData->mDecorator->UpdatePositions(model->mScrollPosition - offset);
 459     }
 460
 461     // Move the cursor, grab handle etc.
 462     if(impl.ProcessInputEvents())
 463     {
 464       updateTextType = static_cast<UpdateTextType>(updateTextType | DECORATOR_UPDATED);
 465     }
 466   }
 467
 468   // Clear the update info. This info will be set the next time the text is updated.
 469   textUpdateInfo.Clear();
 470   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::Relayout\n");
 471
 472   return updateTextType;
 473 }
 474
 475 bool Controller::Relayouter::DoRelayout(Controller::Impl& impl, const Size& size, OperationsMask operationsRequired, Size& layoutSize)
 476 {
 477   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->Controller::Relayouter::DoRelayout %p size %f,%f\n", &impl, size.width, size.height);
 478   bool viewUpdated(false);
 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       impl.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   impl.GetText(currentText);
 646   DALI_LOG_INFO(gLogFilter, Debug::Concise, "Controller::Relayouter::DoRelayout [%p] mImpl->mIsTextDirectionRTL[%s] [%s]\n", &impl, (impl.mIsTextDirectionRTL) ? "true" : "false", currentText.c_str());
 647 #endif
 648   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::Relayouter::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