From 9cae10e14d431366534015e7df36599c3836228e Mon Sep 17 00:00:00 2001 From: Shrouq Sabah Date: Wed, 17 Mar 2021 15:59:03 +0200 Subject: [PATCH] This is a hotfix for side effect on Scrolling, LineWrap and Invalid position of cursor in TextEditor after calling GetNaturalSize or GetHeightForWidth. The number of lines and glyph-positions in visualModel have been changed by calling DoRelayout with size does not equal actualControlSize. Solution: Store the mLines and mGlyphPositions from visualModel so that they can be restored later on with no modifications made on them. Change-Id: Ic14995e1c178b094107f4317e9d3835d6bec7470 --- .../src/dali-toolkit/utc-Dali-TextEditor.cpp | 185 +++++++++++++++++ .../text/text-controller-relayouter.cpp | 188 ++++++++++-------- .../text/text-controller-relayouter.h | 15 ++ 3 files changed, 301 insertions(+), 87 deletions(-) diff --git a/automated-tests/src/dali-toolkit/utc-Dali-TextEditor.cpp b/automated-tests/src/dali-toolkit/utc-Dali-TextEditor.cpp index 12d8805641..62625ef142 100644 --- a/automated-tests/src/dali-toolkit/utc-Dali-TextEditor.cpp +++ b/automated-tests/src/dali-toolkit/utc-Dali-TextEditor.cpp @@ -3386,3 +3386,188 @@ int UtcDaliTextEditorLineCountAfterGetNaturalSize(void) END_TEST; } + + +int utcDaliTextEditorGetHeightForWidthDoesNotChangeLineCountScrollingCase(void) +{ + ToolkitTestApplication application; + + tet_infoline(" utcDaliTextEditorGetHeightForWidthDoesNotChangeLineCountScrollingCase "); + + int lineCountBefore =0 ; + int lineCountAfter =0 ; + + // Create a text editor + TextEditor textEditor = TextEditor::New(); + //Set very large font-size using point-size + textEditor.SetProperty( TextEditor::Property::POINT_SIZE, 10) ; + //Specify font-family + textEditor.SetProperty( TextEditor::Property::FONT_FAMILY, "DejaVu Sans"); + //Specify size + textEditor.SetProperty( Actor::Property::SIZE, Vector2( 100.f, 100.f ) ); + //Set text longer than width of textEditor + textEditor.SetProperty( TextEditor::Property::TEXT, "TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST "); + + application.GetScene().Add( textEditor ); + + application.SendNotification(); + application.Render(); + + //Failed case is the GetHeightForWidth change LineCount then the scrollor will not arrive to latest line + //GetHeightForWidth is a retrieval method which should not modify object + lineCountBefore = textEditor.GetProperty( TextEditor::Property::LINE_COUNT ); + textEditor.GetHeightForWidth(200.f); + + //This is to simulate focus into text editor after calling GetHeightForWidth + //Create a tap event to touch the text editor. + TestGenerateTap( application, 18.0f, 25.0f ); + + application.SendNotification(); + application.Render(); + + lineCountAfter = textEditor.GetProperty( TextEditor::Property::LINE_COUNT ); + + //The LineCount must not be changed when calling GetHeightForWidth. + DALI_TEST_EQUALS( lineCountAfter , lineCountBefore, TEST_LOCATION ); + + END_TEST; +} + +int utcDaliTextEditorGetHeightForWidthDoesNotChangeLineCountLineWrapCharCase(void) +{ + ToolkitTestApplication application; + + tet_infoline(" utcDaliTextEditorGetHeightForWidthDoesNotChangeLineCountLineWrapCharCase "); + + int lineCountBefore =0 ; + int lineCountAfter =0 ; + + // Create a text editor + TextEditor textEditor = TextEditor::New(); + //Set very large font-size using point-size + textEditor.SetProperty( TextEditor::Property::POINT_SIZE, 10) ; + //Specify font-family + textEditor.SetProperty( TextEditor::Property::FONT_FAMILY, "DejaVu Sans"); + //Specify size + textEditor.SetProperty( Actor::Property::SIZE, Vector2( 50.f, 100.f ) ); + //Set text longer than width of textEditor + textEditor.SetProperty( TextEditor::Property::TEXT, "qwertyuiopasdfghjklzxcvbnm\n"); + //Set line wrap mode Character + textEditor.SetProperty(TextEditor::Property::LINE_WRAP_MODE, "CHARACTER"); + + application.GetScene().Add( textEditor ); + + application.SendNotification(); + application.Render(); + + //Failed case is the GetHeightForWidth change LineCount which make position of cursor invalid in TextEditor + //GetHeightForWidth is a retrieval method which should not modify object + lineCountBefore = textEditor.GetProperty( TextEditor::Property::LINE_COUNT ); + textEditor.GetHeightForWidth(200.f); + + //This is to simulate focus into text editor after calling GetHeightForWidth + //Create a tap event to touch the text editor. + TestGenerateTap( application, 18.0f, 25.0f ); + + application.SendNotification(); + application.Render(); + + lineCountAfter = textEditor.GetProperty( TextEditor::Property::LINE_COUNT ); + + //The LineCount must not be changed when calling GetHeightForWidth. + DALI_TEST_EQUALS( lineCountAfter , lineCountBefore, TEST_LOCATION ); + + END_TEST; +} + +int utcDaliTextEditorGetNaturalSizeDoesNotChangeLineCountScrollingCase(void) +{ + ToolkitTestApplication application; + + tet_infoline(" utcDaliTextEditorGetNaturalSizeDoesNotChangeLineCountScrollingCase "); + + int lineCountBefore =0 ; + int lineCountAfter =0 ; + + // Create a text editor + TextEditor textEditor = TextEditor::New(); + //Set very large font-size using point-size + textEditor.SetProperty( TextEditor::Property::POINT_SIZE, 10) ; + //Specify font-family + textEditor.SetProperty( TextEditor::Property::FONT_FAMILY, "DejaVu Sans"); + //Specify size + textEditor.SetProperty( Actor::Property::SIZE, Vector2( 100.f, 100.f ) ); + //Set text longer than width of textEditor + textEditor.SetProperty( TextEditor::Property::TEXT, "TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST "); + + application.GetScene().Add( textEditor ); + + application.SendNotification(); + application.Render(); + + //Failed case is the GetNaturalSize change LineCount then the scrollor will not arrive to latest line + //GetNaturalSize is a retrieval method which should not modify object + lineCountBefore = textEditor.GetProperty( TextEditor::Property::LINE_COUNT ); + textEditor.GetNaturalSize(); + + //This is to simulate focus into text editor after calling GetNaturalSize + //Create a tap event to touch the text editor. + TestGenerateTap( application, 18.0f, 25.0f ); + + application.SendNotification(); + application.Render(); + + lineCountAfter = textEditor.GetProperty( TextEditor::Property::LINE_COUNT ); + + //The LineCount must not be changed when calling GetNaturalSize. + DALI_TEST_EQUALS( lineCountAfter , lineCountBefore, TEST_LOCATION ); + + END_TEST; +} + +int utcDaliTextEditorGetNaturalSizeDoesNotChangeLineCountLineWrapCharCase(void) +{ + ToolkitTestApplication application; + + tet_infoline(" utcDaliTextEditorGetNaturalSizeDoesNotChangeLineCountLineWrapCharCase "); + + int lineCountBefore =0 ; + int lineCountAfter =0 ; + + // Create a text editor + TextEditor textEditor = TextEditor::New(); + //Set very large font-size using point-size + textEditor.SetProperty( TextEditor::Property::POINT_SIZE, 10) ; + //Specify font-family + textEditor.SetProperty( TextEditor::Property::FONT_FAMILY, "DejaVu Sans"); + //Specify size + textEditor.SetProperty( Actor::Property::SIZE, Vector2( 50.f, 100.f ) ); + //Set text longer than width of textEditor + textEditor.SetProperty( TextEditor::Property::TEXT, "qwertyuiopasdfghjklzxcvbnm\n"); + //Set line wrap mode Character + textEditor.SetProperty(TextEditor::Property::LINE_WRAP_MODE, "CHARACTER"); + + application.GetScene().Add( textEditor ); + + application.SendNotification(); + application.Render(); + + //Failed case is the GetNaturalSize change LineCount which make position of cursor invalid in TextEditor + //GetNaturalSize is a retrieval method which should not modify object + lineCountBefore = textEditor.GetProperty( TextEditor::Property::LINE_COUNT ); + textEditor.GetNaturalSize( ); + + //This is to simulate focus into text editor after calling GetNaturalSize + //Create a tap event to touch the text editor. + TestGenerateTap( application, 18.0f, 25.0f ); + + application.SendNotification(); + application.Render(); + + lineCountAfter = textEditor.GetProperty( TextEditor::Property::LINE_COUNT ); + + //The LineCount must not be changed when calling GetNaturalSize. + DALI_TEST_EQUALS( lineCountAfter , lineCountBefore, TEST_LOCATION ); + + END_TEST; +} \ No newline at end of file diff --git a/dali-toolkit/internal/text/text-controller-relayouter.cpp b/dali-toolkit/internal/text/text-controller-relayouter.cpp index 227d889b99..78e7331ad6 100644 --- a/dali-toolkit/internal/text/text-controller-relayouter.cpp +++ b/dali-toolkit/internal/text/text-controller-relayouter.cpp @@ -48,81 +48,122 @@ namespace Toolkit { namespace Text { -Vector3 Controller::Relayouter::GetNaturalSize(Controller& controller) -{ - DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->Controller::GetNaturalSize\n"); - Vector3 naturalSize; - // Make sure the model is up-to-date before layouting - controller.ProcessModifyEvents(); +Size Controller::Relayouter::CalculateLayoutSizeOnRequiredControllerSize(Controller& controller, const Size& requestedControllerSize, const OperationsMask& requestedOperationsMask, bool restoreLinesAndGlyphPositions) +{ + DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->CalculateLayoutSizeOnRequiredControllerSize\n"); + Size calculatedLayoutSize; Controller::Impl& impl = *controller.mImpl; ModelPtr& model = impl.mModel; VisualModelPtr& visualModel = model->mVisualModel; - if(impl.mRecalculateNaturalSize) + + // 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(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 linesBackup = visualModel->mLines; + Vector glyphPositionsBackup = visualModel->mGlyphPositions; + + // Operations that can be done only once until the text changes. + const OperationsMask onlyOnceOperations = static_cast(CONVERT_TO_UTF32 | + GET_SCRIPTS | + VALIDATE_FONTS | + GET_LINE_BREAKS | + BIDI_INFO | + SHAPE_TEXT | + GET_GLYPH_METRICS); + + // Set the update info to relayout the whole text. + TextUpdateInfo& textUpdateInfo = impl.mTextUpdateInfo; + textUpdateInfo.mParagraphCharacterIndex = 0u; + textUpdateInfo.mRequestedNumberOfCharacters = model->mLogicalModel->mText.Count(); + + // Make sure the model is up-to-date before layouting + impl.UpdateModel(onlyOnceOperations); + + // Get a reference to the pending operations member + OperationsMask& operationsPending = impl.mOperationsPending; + + // Layout the text for the new width. + operationsPending = static_cast(operationsPending | requestedOperationsMask); + + // Store the actual control's size to restore later. + const Size actualControlSize = visualModel->mControlSize; + + DoRelayout(controller, + requestedControllerSize, + static_cast(onlyOnceOperations | + requestedOperationsMask), + calculatedLayoutSize); + + + // Clear the update info. This info will be set the next time the text is updated. + textUpdateInfo.Clear(); + textUpdateInfo.mClearAll = true; + + // 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(operationsPendingBackUp & ~onlyOnceOperations); + + // Restore the previously backed-up mLines and mGlyphPositions from visualModel. + if(restoreLinesAndGlyphPositions) { - // 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(impl.mOperationsPending); - // Operations that can be done only once until the text changes. - const OperationsMask onlyOnceOperations = static_cast(CONVERT_TO_UTF32 | - GET_SCRIPTS | - VALIDATE_FONTS | - GET_LINE_BREAKS | - BIDI_INFO | - SHAPE_TEXT | - GET_GLYPH_METRICS); + visualModel->mLines = linesBackup; + visualModel->mGlyphPositions = glyphPositionsBackup; + } - // Set the update info to relayout the whole text. - TextUpdateInfo& textUpdateInfo = impl.mTextUpdateInfo; - textUpdateInfo.mParagraphCharacterIndex = 0u; - textUpdateInfo.mRequestedNumberOfCharacters = model->mLogicalModel->mText.Count(); + return calculatedLayoutSize; +} - // Make sure the model is up-to-date before layouting - impl.UpdateModel(onlyOnceOperations); - // Get a reference to the pending operations member - OperationsMask& operationsPending = impl.mOperationsPending; +Vector3 Controller::Relayouter::GetNaturalSize(Controller& controller) +{ + DALI_LOG_INFO(gLogFilter, Debug::Verbose, "-->Controller::GetNaturalSize\n"); + Vector3 naturalSizeVec3; - // Layout the text for the new width. - operationsPending = static_cast(operationsPending | LAYOUT | REORDER); + // Make sure the model is up-to-date before layouting + controller.ProcessModifyEvents(); + + Controller::Impl& impl = *controller.mImpl; + ModelPtr& model = impl.mModel; + VisualModelPtr& visualModel = model->mVisualModel; + + if(impl.mRecalculateNaturalSize) + { + Size naturalSize; - // Store the actual control's size to restore later. - const Size actualControlSize = visualModel->mControlSize; + // Layout the text for the new width. + OperationsMask requestedOperationsMask = static_cast(LAYOUT | REORDER); + Size sizeMaxWidthAndMaxHeight = Size(MAX_FLOAT, MAX_FLOAT); - DoRelayout(controller, - Size(MAX_FLOAT, MAX_FLOAT), - static_cast(onlyOnceOperations | - LAYOUT | REORDER), - naturalSize.GetVectorXY()); + naturalSize = CalculateLayoutSizeOnRequiredControllerSize(controller, sizeMaxWidthAndMaxHeight, requestedOperationsMask, true); // Stores the natural size to avoid recalculate it again // unless the text/style changes. - visualModel->SetNaturalSize(naturalSize.GetVectorXY()); + visualModel->SetNaturalSize(naturalSize); + naturalSizeVec3 = naturalSize; impl.mRecalculateNaturalSize = false; - // Clear the update info. This info will be set the next time the text is updated. - textUpdateInfo.Clear(); - textUpdateInfo.mClearAll = true; - - // 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(operationsPendingBackUp & ~onlyOnceOperations); - DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize calculated %f,%f,%f\n", naturalSize.x, naturalSize.y, naturalSize.z); + DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize calculated %f,%f,%f\n", naturalSizeVec3.x, naturalSizeVec3.y, naturalSizeVec3.z); } else { - naturalSize = visualModel->GetNaturalSize(); + naturalSizeVec3 = visualModel->GetNaturalSize(); - DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize cached %f,%f,%f\n", naturalSize.x, naturalSize.y, naturalSize.z); + DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::GetNaturalSize cached %f,%f,%f\n", naturalSizeVec3.x, naturalSizeVec3.y, naturalSizeVec3.z); } - naturalSize.x = ConvertToEven(naturalSize.x); - naturalSize.y = ConvertToEven(naturalSize.y); + naturalSizeVec3.x = ConvertToEven(naturalSizeVec3.x); + naturalSizeVec3.y = ConvertToEven(naturalSizeVec3.y); - return naturalSize; + return naturalSizeVec3; } bool Controller::Relayouter::CheckForTextFit(Controller& controller, float pointSize, const Size& layoutSize) @@ -226,6 +267,7 @@ void Controller::Relayouter::FitPointSizeforLayout(Controller& controller, const float Controller::Relayouter::GetHeightForWidth(Controller& controller, float width) { 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(); @@ -235,52 +277,24 @@ float Controller::Relayouter::GetHeightForWidth(Controller& controller, float wi TextUpdateInfo& textUpdateInfo = impl.mTextUpdateInfo; Size layoutSize; + if(fabsf(width - visualModel->mControlSize.width) > Math::MACHINE_EPSILON_1000 || textUpdateInfo.mFullRelayoutNeeded || textUpdateInfo.mClearAll) { - // 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(impl.mOperationsPending); - // Operations that can be done only once until the text changes. - const OperationsMask onlyOnceOperations = static_cast(CONVERT_TO_UTF32 | - GET_SCRIPTS | - VALIDATE_FONTS | - GET_LINE_BREAKS | - BIDI_INFO | - SHAPE_TEXT | - GET_GLYPH_METRICS); - - // Set the update info to relayout the whole text. - textUpdateInfo.mParagraphCharacterIndex = 0u; - textUpdateInfo.mRequestedNumberOfCharacters = model->mLogicalModel->mText.Count(); - - // Make sure the model is up-to-date before layouting - impl.UpdateModel(onlyOnceOperations); - - // Get a reference to the pending operations member - OperationsMask& operationsPending = impl.mOperationsPending; // Layout the text for the new width. - operationsPending = static_cast(operationsPending | LAYOUT); + OperationsMask requestedOperationsMask = static_cast(LAYOUT); + Size sizeRequestedWidthAndMaxHeight = Size(width, MAX_FLOAT); - // Store the actual control's width. - const float actualControlWidth = visualModel->mControlSize.width; + // 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. + bool restoreLinesAndGlyphPositions = visualModel->mControlSize.width>0 && visualModel->mControlSize.height>0; - DoRelayout(controller, - Size(width, MAX_FLOAT), - static_cast(onlyOnceOperations | - LAYOUT), - layoutSize); - - // Clear the update info. This info will be set the next time the text is updated. - textUpdateInfo.Clear(); - textUpdateInfo.mClearAll = true; + layoutSize = CalculateLayoutSizeOnRequiredControllerSize(controller, sizeRequestedWidthAndMaxHeight, requestedOperationsMask, restoreLinesAndGlyphPositions); - // Restore the actual control's width. - visualModel->mControlSize.width = actualControlWidth; - // Restore the previously backed-up pending operations' mask without the only once operations. - impl.mOperationsPending = static_cast(operationsPendingBackUp & ~onlyOnceOperations); DALI_LOG_INFO(gLogFilter, Debug::Verbose, "<--Controller::GetHeightForWidth calculated %f\n", layoutSize.height); } else diff --git a/dali-toolkit/internal/text/text-controller-relayouter.h b/dali-toolkit/internal/text/text-controller-relayouter.h index d2d86706ab..1b586b2b0b 100644 --- a/dali-toolkit/internal/text/text-controller-relayouter.h +++ b/dali-toolkit/internal/text/text-controller-relayouter.h @@ -100,6 +100,21 @@ struct Controller::Relayouter * @param[in] controlSize The control size */ static void CalculateVerticalOffset(Controller& controller, const Size& controlSize); + + /** + * @brief Calculates the layout size of control according to @p requestedControllerSize and @p requestedOperationsMask + * + * GetNaturalSize() and GetHeightForWidth() calls this method. + * + * @param[in] controller The controller to calcualte size on it. + * @param[in] requestedControllerSize The requested size of controller to calcualte layout size on it. + * @param[in] requestedOperationsMask The requested operations-mask to calcualte layout size according to it. + * @param[in] restoreLinesAndGlyphPositions whether to restore lines and glyph-positions to status before requesting calculation on size. + * + * @return The calculated layout-size. + */ + static Size CalculateLayoutSizeOnRequiredControllerSize(Controller& controller, const Size& requestedControllerSize, const OperationsMask& requestedOperationsMask, bool restoreLinesAndGlyphPositions); + }; } // namespace Text -- 2.34.1