[dali_2.1.3] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / text-controller-relayouter.cpp
index 4c71934..34e7053 100644 (file)
@@ -24,6 +24,7 @@
 
 // INTERNAL INCLUDES
 #include <dali-toolkit/internal/text/layouts/layout-parameters.h>
+#include <dali-toolkit/internal/text/text-controller-event-handler.h>
 #include <dali-toolkit/internal/text/text-controller-impl.h>
 
 namespace
@@ -48,7 +49,7 @@ namespace Toolkit
 {
 namespace Text
 {
-Size Controller::Relayouter::CalculateLayoutSizeOnRequiredControllerSize(Controller& controller, const Size& requestedControllerSize, const OperationsMask& requestedOperationsMask, bool restoreLinesAndGlyphPositions)
+Size Controller::Relayouter::CalculateLayoutSizeOnRequiredControllerSize(Controller& controller, const Size& requestedControllerSize, const OperationsMask& requestedOperationsMask)
 {
   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->CalculateLayoutSizeOnRequiredControllerSize\n");
   Size calculatedLayoutSize;
@@ -57,17 +58,6 @@ Size Controller::Relayouter::CalculateLayoutSizeOnRequiredControllerSize(Control
   ModelPtr&         model       = impl.mModel;
   VisualModelPtr&   visualModel = model->mVisualModel;
 
-  // Store the pending operations mask so that it can be restored later on with no modifications made on it
-  // while getting the natural size were reflected on the original mask.
-  OperationsMask operationsPendingBackUp = static_cast<OperationsMask>(impl.mOperationsPending);
-
-  // This is a hotfix for side effect on Scrolling, LineWrap and Invalid position of cursor in TextEditor after calling CalculateLayoutSizeOnRequiredControllerSize.
-  // The number of lines and glyph-positions inside visualModel have been changed by calling DoRelayout with requestedControllerSize.
-  // Store the mLines and mGlyphPositions from visualModel so that they can be restored later on with no modifications made on them.
-  //TODO: Refactor "DoRelayout" and extract common code of size calculation without modifying attributes of mVisualModel, and then blah, blah, etc.
-  Vector<LineRun> linesBackup          = visualModel->mLines;
-  Vector<Vector2> glyphPositionsBackup = visualModel->mGlyphPositions;
-
   // Operations that can be done only once until the text changes.
   const OperationsMask onlyOnceOperations = static_cast<OperationsMask>(CONVERT_TO_UTF32 |
                                                                         GET_SCRIPTS |
@@ -78,43 +68,69 @@ Size Controller::Relayouter::CalculateLayoutSizeOnRequiredControllerSize(Control
                                                                         GET_GLYPH_METRICS);
 
   // Set the update info to relayout the whole text.
-  TextUpdateInfo& textUpdateInfo              = impl.mTextUpdateInfo;
+  TextUpdateInfo& textUpdateInfo = impl.mTextUpdateInfo;
+  if((0 == textUpdateInfo.mNumberOfCharactersToAdd) &&
+     (0 == textUpdateInfo.mPreviousNumberOfCharacters) &&
+     ((visualModel->mControlSize.width < Math::MACHINE_EPSILON_1000) || (visualModel->mControlSize.height < Math::MACHINE_EPSILON_1000)))
+  {
+    textUpdateInfo.mNumberOfCharactersToAdd = model->mLogicalModel->mText.Count();
+  }
   textUpdateInfo.mParagraphCharacterIndex     = 0u;
   textUpdateInfo.mRequestedNumberOfCharacters = model->mLogicalModel->mText.Count();
 
-  // Make sure the model is up-to-date before layouting
-  impl.UpdateModel(onlyOnceOperations);
+  // This is to keep Index to the first character to be updated.
+  // Then restore it after calling Clear method.
+  auto updateInfoCharIndexBackup = textUpdateInfo.mCharacterIndex;
 
   // Get a reference to the pending operations member
   OperationsMask& operationsPending = impl.mOperationsPending;
 
   // Layout the text for the new width.
-  operationsPending = static_cast<OperationsMask>(operationsPending | requestedOperationsMask);
+  // Apply the pending operations, requested operations and the only once operations.
+  // Then remove onlyOnceOperations
+  operationsPending = static_cast<OperationsMask>(operationsPending | requestedOperationsMask | onlyOnceOperations);
+
+  // Make sure the model is up-to-date before layouting
+  impl.UpdateModel(static_cast<OperationsMask>(operationsPending & ~UPDATE_LAYOUT_SIZE));
 
   // Store the actual control's size to restore later.
   const Size actualControlSize = visualModel->mControlSize;
 
-  DoRelayout(controller,
+  DoRelayout(impl,
              requestedControllerSize,
-             static_cast<OperationsMask>(onlyOnceOperations |
-                                         requestedOperationsMask),
+             static_cast<OperationsMask>(operationsPending & ~UPDATE_LAYOUT_SIZE),
              calculatedLayoutSize);
 
   // Clear the update info. This info will be set the next time the text is updated.
   textUpdateInfo.Clear();
-  textUpdateInfo.mClearAll = true;
+
+  //TODO: Refactor "DoRelayout" and extract common code of size calculation without modifying attributes of mVisualModel,
+  //TODO: then calculate GlyphPositions. Lines, Size, Layout for Natural-Size
+  //TODO: and utilize the values in OperationsPending and TextUpdateInfo without changing the original one.
+  //TODO: Also it will improve performance because there is no need todo FullRelyout on the next need for layouting.
+
+  // FullRelayoutNeeded should be true because DoRelayout is MAX_FLOAT, MAX_FLOAT.
+  // By this no need to take backup and restore it.
+  textUpdateInfo.mFullRelayoutNeeded = true;
+
+  // Restore mCharacterIndex. Because "Clear" set it to the maximum integer.
+  // The "CalculateTextUpdateIndices" does not work proprely because the mCharacterIndex will be greater than mPreviousNumberOfCharacters.
+  // Which apply an assumption to update only the last  paragraph. That could cause many of out of index crashes.
+  textUpdateInfo.mCharacterIndex = updateInfoCharIndexBackup;
+
+  // Do not do again the only once operations.
+  operationsPending = static_cast<OperationsMask>(operationsPending & ~onlyOnceOperations);
+
+  // Do the size related operations again.
+
+  const OperationsMask sizeOperations = static_cast<OperationsMask>(LAYOUT |
+                                                                    ALIGN |
+                                                                    REORDER);
+
+  operationsPending = static_cast<OperationsMask>(operationsPending | sizeOperations);
 
   // Restore the actual control's size.
   visualModel->mControlSize = actualControlSize;
-  // Restore the previously backed-up pending operations' mask without the only once operations.
-  impl.mOperationsPending = static_cast<OperationsMask>(operationsPendingBackUp & ~onlyOnceOperations);
-
-  // Restore the previously backed-up mLines and mGlyphPositions from visualModel.
-  if(restoreLinesAndGlyphPositions)
-  {
-    visualModel->mLines          = linesBackup;
-    visualModel->mGlyphPositions = glyphPositionsBackup;
-  }
 
   return calculatedLayoutSize;
 }
@@ -125,7 +141,7 @@ Vector3 Controller::Relayouter::GetNaturalSize(Controller& controller)
   Vector3 naturalSizeVec3;
 
   // Make sure the model is up-to-date before layouting
-  controller.ProcessModifyEvents();
+  EventHandler::ProcessModifyEvents(controller);
 
   Controller::Impl& impl        = *controller.mImpl;
   ModelPtr&         model       = impl.mModel;
@@ -139,7 +155,7 @@ Vector3 Controller::Relayouter::GetNaturalSize(Controller& controller)
     OperationsMask requestedOperationsMask  = static_cast<OperationsMask>(LAYOUT | REORDER);
     Size           sizeMaxWidthAndMaxHeight = Size(MAX_FLOAT, MAX_FLOAT);
 
-    naturalSize = CalculateLayoutSizeOnRequiredControllerSize(controller, sizeMaxWidthAndMaxHeight, requestedOperationsMask, true);
+    naturalSize = CalculateLayoutSizeOnRequiredControllerSize(controller, sizeMaxWidthAndMaxHeight, requestedOperationsMask);
 
     // Stores the natural size to avoid recalculate it again
     // unless the text/style changes.
@@ -170,7 +186,7 @@ bool Controller::Relayouter::CheckForTextFit(Controller& controller, float point
   TextUpdateInfo&   textUpdateInfo  = impl.mTextUpdateInfo;
   impl.mFontDefaults->mFitPointSize = pointSize;
   impl.mFontDefaults->sizeDefined   = true;
-  controller.ClearFontData();
+  impl.ClearFontData();
 
   // Operations that can be done only once until the text changes.
   const OperationsMask onlyOnceOperations = static_cast<OperationsMask>(CONVERT_TO_UTF32 |
@@ -187,7 +203,7 @@ bool Controller::Relayouter::CheckForTextFit(Controller& controller, float point
   // Make sure the model is up-to-date before layouting
   impl.UpdateModel(onlyOnceOperations);
 
-  DoRelayout(controller,
+  DoRelayout(impl,
              Size(layoutSize.width, MAX_FLOAT),
              static_cast<OperationsMask>(onlyOnceOperations | LAYOUT),
              textSize);
@@ -212,10 +228,11 @@ void Controller::Relayouter::FitPointSizeforLayout(Controller& controller, const
   {
     ModelPtr& model = impl.mModel;
 
-    bool  actualellipsis = model->mElideEnabled;
-    float minPointSize   = impl.mTextFitMinSize;
-    float maxPointSize   = impl.mTextFitMaxSize;
-    float pointInterval  = impl.mTextFitStepSize;
+    bool  actualellipsis      = model->mElideEnabled;
+    float minPointSize        = impl.mTextFitMinSize;
+    float maxPointSize        = impl.mTextFitMaxSize;
+    float pointInterval       = impl.mTextFitStepSize;
+    float currentFitPointSize = impl.mFontDefaults->mFitPointSize;
 
     model->mElideEnabled = false;
     Vector<float> pointSizeArray;
@@ -254,10 +271,14 @@ void Controller::Relayouter::FitPointSizeforLayout(Controller& controller, const
       }
     }
 
-    model->mElideEnabled              = actualellipsis;
+    model->mElideEnabled = actualellipsis;
+    if(currentFitPointSize != pointSizeArray[bestSizeIndex])
+    {
+      impl.mTextFitChanged = true;
+    }
     impl.mFontDefaults->mFitPointSize = pointSizeArray[bestSizeIndex];
     impl.mFontDefaults->sizeDefined   = true;
-    controller.ClearFontData();
+    impl.ClearFontData();
   }
 }
 
@@ -266,7 +287,7 @@ float Controller::Relayouter::GetHeightForWidth(Controller& controller, float wi
   DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->Controller::GetHeightForWidth %p width %f\n", &controller, width);
 
   // Make sure the model is up-to-date before layouting
-  controller.ProcessModifyEvents();
+  EventHandler::ProcessModifyEvents(controller);
 
   Controller::Impl& impl           = *controller.mImpl;
   ModelPtr&         model          = impl.mModel;
@@ -283,15 +304,7 @@ float Controller::Relayouter::GetHeightForWidth(Controller& controller, float wi
     OperationsMask requestedOperationsMask        = static_cast<OperationsMask>(LAYOUT);
     Size           sizeRequestedWidthAndMaxHeight = Size(width, MAX_FLOAT);
 
-    // Skip restore, because if GetHeightForWidth called before rendering and layouting then visualModel->mControlSize will be zero which will make LineCount zero.
-    // The implementation of Get LineCount property depends on calling GetHeightForWidth then read mLines.Count() from visualModel direct.
-    // If the LineCount property is requested before rendering and layouting then the value will be zero, which is incorrect.
-    // So we will not restore the previously backed-up mLines and mGlyphPositions from visualModel in such case.
-    // 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.
-    // For example, when the text is changed.
-    bool restoreLinesAndGlyphPositions = (visualModel->mControlSize.width > 0 && visualModel->mControlSize.height > 0) && (visualModel->mControlSize.width != width);
-
-    layoutSize = CalculateLayoutSizeOnRequiredControllerSize(controller, sizeRequestedWidthAndMaxHeight, requestedOperationsMask, restoreLinesAndGlyphPositions);
+    layoutSize = CalculateLayoutSizeOnRequiredControllerSize(controller, sizeRequestedWidthAndMaxHeight, requestedOperationsMask);
 
     DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth calculated %f\n", layoutSize.height);
   }
@@ -402,12 +415,12 @@ Controller::UpdateTextType Controller::Relayouter::Relayout(Controller& controll
   }
 
   // Make sure the model is up-to-date before layouting.
-  controller.ProcessModifyEvents();
+  EventHandler::ProcessModifyEvents(controller);
   bool updated = impl.UpdateModel(operationsPending);
 
   // Layout the text.
   Size layoutSize;
-  updated = DoRelayout(controller, size, operationsPending, layoutSize) || updated;
+  updated = DoRelayout(impl, size, operationsPending, layoutSize) || updated;
 
   if(updated)
   {
@@ -431,7 +444,7 @@ Controller::UpdateTextType Controller::Relayouter::Relayout(Controller& controll
   if(!isEditable || !controller.IsMultiLineEnabled())
   {
     // After doing the text layout, the vertical offset to place the actor in the desired position can be calculated.
-    controller.CalculateVerticalOffset(size);
+    CalculateVerticalOffset(controller, size);
   }
 
   if(isEditable)
@@ -459,13 +472,11 @@ Controller::UpdateTextType Controller::Relayouter::Relayout(Controller& controll
   return updateTextType;
 }
 
-bool Controller::Relayouter::DoRelayout(Controller& controller, const Size& size, OperationsMask operationsRequired, Size& layoutSize)
+bool Controller::Relayouter::DoRelayout(Controller::Impl& impl, const Size& size, OperationsMask operationsRequired, Size& layoutSize)
 {
-  DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->Controller::DoRelayout %p size %f,%f\n", &controller, size.width, size.height);
+  DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->Controller::Relayouter::DoRelayout %p size %f,%f\n", &impl, size.width, size.height);
   bool viewUpdated(false);
 
-  Controller::Impl& impl = *controller.mImpl;
-
   // Calculate the operations to be done.
   const OperationsMask operations = static_cast<OperationsMask>(impl.mOperationsPending & operationsRequired);
 
@@ -500,7 +511,7 @@ bool Controller::Relayouter::DoRelayout(Controller& controller, const Size& size
        (lastIndex > charactersToGlyph.Count() && charactersToGlyph.Count() > 0u))
     {
       std::string currentText;
-      controller.GetText(currentText);
+      impl.GetText(currentText);
 
       DALI_LOG_ERROR("Controller::DoRelayout: Attempting to access invalid buffer\n");
       DALI_LOG_ERROR("Current text is: %s\n", currentText.c_str());
@@ -561,7 +572,7 @@ bool Controller::Relayouter::DoRelayout(Controller& controller, const Size& size
       // Reset the scroll position in inactive state
       if(elideTextEnabled && (impl.mEventData->mState == EventData::INACTIVE))
       {
-        controller.ResetScrollPosition();
+        impl.ResetScrollPosition();
       }
     }
 
@@ -631,10 +642,10 @@ bool Controller::Relayouter::DoRelayout(Controller& controller, const Size& size
   }
 #if defined(DEBUG_ENABLED)
   std::string currentText;
-  controller.GetText(currentText);
-  DALI_LOG_INFO(gLogFilter, Debug::Concise, "Controller::DoRelayout [%p] mImpl->mIsTextDirectionRTL[%s] [%s]\n", &controller, (impl.mIsTextDirectionRTL) ? "true" : "false", currentText.c_str());
+  impl.GetText(currentText);
+  DALI_LOG_INFO(gLogFilter, Debug::Concise, "Controller::Relayouter::DoRelayout [%p] mImpl->mIsTextDirectionRTL[%s] [%s]\n", &impl, (impl.mIsTextDirectionRTL) ? "true" : "false", currentText.c_str());
 #endif
-  DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::DoRelayout, view updated %s\n", (viewUpdated ? "true" : "false"));
+  DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::Relayouter::DoRelayout, view updated %s\n", (viewUpdated ? "true" : "false"));
   return viewUpdated;
 }