desktop: disable callback handling while changing the view

When changing the view, some components are disabled
and re-enabled. This triggers a flood of invalidations
that then result in rendering requests. For each rendering
the view is set, which triggers more invalidations.

The Sidebar suffers from this, and it causes cpu pegging.
This fix prevents this issue by disabling all callbacks
during setView.

Change-Id: If6b93b2ab31f568a0761f15d945a43de1bc2d4d0
Reviewed-on: https://gerrit.libreoffice.org/84184
Reviewed-by: Ashod Nakashian <ashnakash@gmail.com>
Tested-by: Ashod Nakashian <ashnakash@gmail.com>
Reviewed-on: https://gerrit.libreoffice.org/84226
Tested-by: Jenkins
Reviewed-by: Michael Meeks <michael.meeks@collabora.com>

2 files changed, 33 insertions, 20 deletions

diff --git a/desktop/inc/lib/init.hxx b/desktop/inc/lib/init.hxx
index 3587ba003e37..5957f56ed344 100644
--- a/desktop/inc/lib/init.hxx
+++ b/desktop/inc/lib/init.hxx
@@ -79,15 +79,14 @@ namespace desktop {
         static void callback(const int type, const char* payload, void* data);
         void queue(const int type, const char* data);
 
-        /// When enabled events are queued but callback not invoked.
-        void setEventLatch(const bool bEventLatch)
-        {
-            m_bEventLatch = bEventLatch;
-        }
-
-        bool isEventLatchOn() const { return m_bEventLatch; }
-        void setPartTilePainting(const bool bPartPainting) { m_bPartTilePainting = bPartPainting; }
-        bool isPartTilePainting() const { return m_bPartTilePainting; }
+        /// Disables callbacks on this handler. Must match with identical count
+        /// of enableCallbacks. Used during painting and changing views.
+        void disableCallbacks() { ++m_nDisableCallbacks; }
+        /// Enables callbacks on this handler. Must match with identical count
+        /// of disableCallbacks. Used during painting and changing views.
+        void enableCallbacks() { --m_nDisableCallbacks; }
+        /// Returns true iff callbacks are disabled.
+        bool callbacksDisabled() const { return m_nDisableCallbacks != 0; }
 
         void addViewStates(int viewId);
         void removeViewStates(int viewId);
@@ -140,7 +139,7 @@ namespace desktop {
         LibreOfficeKitDocument* m_pDocument;
         LibreOfficeKitCallback m_pCallback;
         void *m_pData;
-        bool m_bPartTilePainting;
+        int m_nDisableCallbacks;
         bool m_bEventLatch;
         std::mutex m_mutex;
     };
diff --git a/desktop/source/lib/init.cxx b/desktop/source/lib/init.cxx
index 7ecc9fcdf78b..e5f9d6893bf2 100644
--- a/desktop/source/lib/init.cxx
+++ b/desktop/source/lib/init.cxx
@@ -1084,7 +1084,7 @@ CallbackFlushHandler::CallbackFlushHandler(LibreOfficeKitDocument* pDocument, Li
       m_pDocument(pDocument),
       m_pCallback(pCallback),
       m_pData(pData),
-      m_bPartTilePainting(false),
+      m_nDisableCallbacks(0),
       m_bEventLatch(false)
 {
     SetPriority(TaskPriority::POST_PAINT);
@@ -1134,7 +1134,7 @@ void CallbackFlushHandler::queue(const int type, const char* data)
         bIsChartActive = aChartHelper.GetWindow() != nullptr;
     }
 
-    if (m_bPartTilePainting && !bIsChartActive)
+    if (callbacksDisabled() && !bIsChartActive)
     {
         // We drop notifications when this is set, except for important ones.
         // When we issue a complex command (such as .uno:InsertAnnotation)
@@ -2854,9 +2854,9 @@ static void doc_paintPartTile(LibreOfficeKitDocument* pThis,
     // Disable callbacks while we are painting.
     if (nOrigViewId >= 0)
     {
-        auto findIt = pDocument->mpCallbackFlushHandlers.find(nOrigViewId);
-        if (findIt != pDocument->mpCallbackFlushHandlers.end())
-            findIt->second->setPartTilePainting(true);
+        const auto handlerIt = pDocument->mpCallbackFlushHandlers.find(nOrigViewId);
+        if (handlerIt != pDocument->mpCallbackFlushHandlers.end())
+            handlerIt->second->disableCallbacks();
     }
 
     try
@@ -2909,9 +2909,9 @@ static void doc_paintPartTile(LibreOfficeKitDocument* pThis,
 
     if (nOrigViewId >= 0)
     {
-        auto findIt = pDocument->mpCallbackFlushHandlers.find(nOrigViewId);
-        if (findIt != pDocument->mpCallbackFlushHandlers.end())
-            findIt->second->setPartTilePainting(false);
+        const auto handlerIt = pDocument->mpCallbackFlushHandlers.find(nOrigViewId);
+        if (handlerIt != pDocument->mpCallbackFlushHandlers.end())
+            handlerIt->second->enableCallbacks();
     }
 }
 
@@ -4672,14 +4672,28 @@ static void doc_destroyView(SAL_UNUSED_PARAMETER LibreOfficeKitDocument* /*pThis
     SfxLokHelper::destroyView(nId);
 }
 
-static void doc_setView(SAL_UNUSED_PARAMETER LibreOfficeKitDocument* /*pThis*/, int nId)
+static void doc_setView(LibreOfficeKitDocument* pThis, int nId)
 {
     comphelper::ProfileZone aZone("doc_setView");
 
     SolarMutexGuard aGuard;
     SetLastExceptionMsg();
 
-    SfxLokHelper::setView(nId);
+    LibLODocument_Impl* pDocument = static_cast<LibLODocument_Impl*>(pThis);
+    const auto handlerIt = pDocument->mpCallbackFlushHandlers.find(nId);
+    if (handlerIt != pDocument->mpCallbackFlushHandlers.end())
+        handlerIt->second->disableCallbacks();
+
+    try
+    {
+        SfxLokHelper::setView(nId);
+    }
+    catch (const std::exception&)
+    {
+    }
+
+    if (handlerIt != pDocument->mpCallbackFlushHandlers.end())
+        handlerIt->second->enableCallbacks();
 }
 
 static int doc_getView(SAL_UNUSED_PARAMETER LibreOfficeKitDocument* /*pThis*/)