Merge pull request #2016 from LarryThiessen/fix-2013-fit-batch

#2013 Batch the macro-box fit pushes; hard-hide the box scrollbar

Author: TimothyLuke

GSE_GUI/Editor.lua

@@ -549,40 +549,13 @@ local function GetEditorScrollContainer(frame)
     return editor and editor.scrollContainer
 end
 
--- When the macro edit box has focus, wheel scrolls inside it; otherwise
--- forward to the editor's outer scroll container.
-local function ScrollFocusedMacroEditor(macroEditBox, delta)
-    local editBox = macroEditBox and macroEditBox.editBox
-    if not (editBox and editBox.HasFocus and editBox:HasFocus()) then return false end
-
-    local scrollFrame = macroEditBox.scrollFrame
-    if not (scrollFrame and scrollFrame.GetVerticalScroll and scrollFrame.SetVerticalScroll) then return true end
-
-    local range = (scrollFrame.GetVerticalScrollRange and scrollFrame:GetVerticalScrollRange()) or 0
-    if range <= 0 then return true end
-
-    local current = scrollFrame:GetVerticalScroll() or 0
-    local wheelDelta = delta or 0
-    if wheelDelta > 0 then
-        wheelDelta = 1
-    elseif wheelDelta < 0 then
-        wheelDelta = -1
-    end
-    local step = math.max(1, math.min(MACRO_EDITOR_SCROLL_PIXELS, range / 10))
-    local target = current - (wheelDelta * step)
-    if target < 0 then
-        target = 0
-    elseif target > range then
-        target = range
-    end
-    scrollFrame:SetVerticalScroll(target)
-    return true
-end
-
 local function MacroEditor_OnMouseWheel(mouseFrame, delta)
+    -- Macro boxes auto-fit their content (#1998), so there is nothing left to
+    -- scroll INSIDE one: the wheel always drives the outer block list, making
+    -- scrolling identical wherever the cursor hovers in the editor. (The old
+    -- focused-box inner scroll predates the auto-fit and made wheel behaviour
+    -- change depending on what the mouse happened to be over.)
     local macroEditBox = mouseFrame and mouseFrame.gseWheelForwardWidget
-    if ScrollFocusedMacroEditor(macroEditBox, delta) then return end
-
     local scrollContainer = GetEditorScrollContainer(macroEditBox and macroEditBox.gseWheelForwardFrame)
     if scrollContainer and scrollContainer.MoveScroll then
         scrollContainer:MoveScroll(delta)
@@ -637,6 +610,61 @@ local MACRO_BOX_MIN_INNER = 40
 local function MacroBoxRowsHeight(rows, oneRow, spacing)
     return rows * oneRow + math.max(rows - 1, 0) * spacing
 end
+-- The ancestor push a fitted box needs, run OUTSIDE the frame that drew it.
+-- Walking the ancestors per box DURING the draw was the version-click stall:
+-- the walk itself costs almost no Lua, but each mid-draw ancestor resize
+-- feeds the engine's layout/anchor invalidation, and per-box walks multiplied
+-- that into a 0.5-1.2 s blocked frame (proven by bisection: draw with the
+-- walk skipped is stall-free, everything else unchanged). Pushes are queued
+-- and flushed in ONE batch per frame instead.
+--   ...and ONLY within the block. The first auto-height ancestor is the block
+-- panel, which recomputes its height from its children; everything above it
+-- (the block list, the scroll frame, the window) is SHARED chrome -- resizing
+-- those per block collapsed the editor (issue #2002). Past that boundary we
+-- only re-lay out, never resize.
+-- layoutQueue/layoutSeen: the shared ancestors (block list, scroll frame...)
+-- are common to EVERY box, and re-laying them out once per box is the SetPoint
+-- storm that stalled the client. Each container is queued ONCE per flush, in
+-- discovery order (inner containers first), and laid out after all height
+-- pushes have been applied.
+local function ApplyFitPush(macroEditBox, delta, layoutQueue, layoutSeen)
+    local parent = macroEditBox.parent
+    local sharedChrome = false
+    while parent do
+        if parent.autoAdjustHeight then sharedChrome = true end
+        if not sharedChrome and delta ~= 0 and parent.explicitHeight
+            and parent.height and parent.SetHeight then
+            parent:SetHeight(parent.height + delta)
+        elseif parent.DoLayout and not layoutSeen[parent] then
+            layoutSeen[parent] = true
+            layoutQueue[#layoutQueue + 1] = parent
+        end
+        parent = parent.parent
+    end
+end
+local pendingFitPushes = {}
+local fitFlushDriver = CreateFrame("Frame")
+fitFlushDriver:Hide()
+fitFlushDriver:SetScript("OnUpdate", function(self)
+    local pushes = pendingFitPushes
+    pendingFitPushes = {}
+    self:Hide()
+    local layoutQueue, layoutSeen = {}, {}
+    for _, push in ipairs(pushes) do
+        -- A widget released (or pooled) since queueing has no parent chain of
+        -- its own any more; its push is meaningless, skip it.
+        if push[1].parent then
+            ApplyFitPush(push[1], push[2], layoutQueue, layoutSeen)
+        end
+    end
+    for _, container in ipairs(layoutQueue) do
+        container:DoLayout()
+    end
+end)
+local function QueueFitPush(macroEditBox, delta)
+    pendingFitPushes[#pendingFitPushes + 1] = { macroEditBox, delta }
+    fitFlushDriver:Show()
+end
 local function FitMacroEditBoxToContent(macroEditBox, text)
     if not (macroEditBox and macroEditBox.SetHeight) then return end
     local eb = macroEditBox.editBox or macroEditBox.editbox
@@ -678,7 +706,17 @@ local function FitMacroEditBoxToContent(macroEditBox, text)
     -- 255-char block cannot realistically reach the row cap; one that did needs
     -- rethinking, not a scrollbar.)
     local bar = macroEditBox.scrollBar
-    if bar and bar.Hide then bar:Hide() end
+    if bar and bar.Hide then
+        bar:Hide()
+        -- The scroll template re-Shows the bar whenever the text's scroll
+        -- range changes (SetText on a reused box, typing past the cap...).
+        -- A one-time Hide loses that race, so make Show itself hide: the bar
+        -- stays dead for the widget's whole life, pooled reuses included.
+        if not bar.gseHardHidden then
+            bar.gseHardHidden = true
+            bar.Show = bar.Hide
+        end
+    end
     textHeight =
         math.max(
             MacroBoxRowsHeight(MACRO_BOX_MIN_LINES, oneRow, spacing),
@@ -697,24 +735,7 @@ local function FitMacroEditBoxToContent(macroEditBox, text)
     -- macroFields, macroBody -- sized at draw time); auto-height ancestors
     -- above them only follow if those grow too. Push the delta up through
     -- every fixed-height ancestor, relaying out as we go.
-    -- ...but ONLY within this block. The first auto-height ancestor is the block
-    -- panel, which recomputes its height from its children; everything above it
-    -- (the block list, the scroll frame, the window) is SHARED chrome. Resizing
-    -- those by the delta made every block on load shrink the same containers
-    -- again, collapsing the list so it no longer filled the window. Past that
-    -- boundary we only re-lay out, never resize.
-    local parent = macroEditBox.parent
-    local sharedChrome = false
-    while parent do
-        if parent.autoAdjustHeight then sharedChrome = true end
-        if not sharedChrome and delta ~= 0 and parent.explicitHeight
-            and parent.height and parent.SetHeight then
-            parent:SetHeight(parent.height + delta)
-        elseif parent.DoLayout then
-            parent:DoLayout()
-        end
-        parent = parent.parent
-    end
+    QueueFitPush(macroEditBox, delta)
 end
 
 local function SetMacroCountText(macroEditBox, lenMacro)