Merge pull request #2001 from LarryThiessen/fix-1998-macro-box-autofit

#1998 Auto-size the macro-block command box to its content

Author: TimothyLuke

GSE_GUI/Editor.lua

@@ -611,6 +611,99 @@ end
 -- Inline "X/255" indicator anchored to the top-right of the macro edit box,
 -- replacing the old side-panel that listed compiled output. Created on first
 -- call; subsequent calls just retext + recolour.
+-- Size the macro-commands box to its content: one row per line of macro
+-- text, never fewer than MACRO_BOX_MIN_LINES (short blocks keep a usable
+-- box), never more than MACRO_BOX_MAX_LINES (a huge block scrolls instead
+-- of swallowing the window). Re-fitted as the user types; only re-lays out
+-- when the row count actually changes so fast typing stays cheap.
+local MACRO_BOX_MIN_LINES = 3
+local MACRO_BOX_MAX_LINES = 24
+-- Rows the widget is BUILT at, before the first fit runs. This has to stay in
+-- step with macrolayout's SetHeight(108) below -- NativeUI's SetNumLines(n) is
+-- n * 16 + STYLE.frameContentTop (28), so 5 rows is exactly 108. The fit pushes
+-- the DELTA from this baseline up through the fixed-height ancestors, so a
+-- baseline that disagrees with the container leaves that much dead space under
+-- the box. It is NOT the minimum -- MACRO_BOX_MIN_LINES is, and is free to move
+-- on its own.
+local MACRO_BOX_BASE_LINES = 5
+-- Slack the fitted frame carries over the measured text, and the floor NativeUI
+-- clamps the inner editbox to (updateEditBoxSize). At a small chat font the
+-- min-row fit lands under that floor and the bottom row would render outside
+-- the visible scroll area, so the frame is never asked for less.
+local MACRO_BOX_CHROME_SLACK = 6
+local MACRO_BOX_MIN_INNER = 40
+-- Rows -> pixels in the box's OWN font: a row is the measured line height, and
+-- every row after the first also carries the editbox's line spacing.
+local function MacroBoxRowsHeight(rows, oneRow, spacing)
+    return rows * oneRow + math.max(rows - 1, 0) * spacing
+end
+local function FitMacroEditBoxToContent(macroEditBox, text)
+    if not (macroEditBox and macroEditBox.SetHeight) then return end
+    local eb = macroEditBox.editBox or macroEditBox.editbox
+    if not eb then return end
+    local plain = text or ""
+    if GSE.DecodeMacroEditorText then plain = GSE.DecodeMacroEditorText(plain) or plain end
+    plain = tostring(plain)
+    -- Stored macro text commonly ends with a newline; that trailing newline is
+    -- not a row the author sees as content, so it is not measured -- EXCEPT
+    -- while the author is typing on that last empty row (box focused, caret at
+    -- the end), so pressing Enter at the bottom still opens the new row.
+    local body = plain:gsub("\n+$", "")
+    local typingOnTrailingRow = #body < #plain and eb.HasFocus and eb:HasFocus()
+        and eb.GetCursorPosition and eb.GetText and eb:GetCursorPosition() >= #(eb:GetText() or "")
+
+    -- MEASURE the rendered text height with a hidden FontString in the box's
+    -- own font (wraps included) instead of estimating rows x font size --
+    -- estimates drifted by about a row and showed a spare empty line.
+    local meter = macroEditBox.gseHeightMeter
+    if not meter then
+        meter = macroEditBox.frame:CreateFontString(nil, "ARTWORK")
+        meter:Hide()
+        macroEditBox.gseHeightMeter = meter
+    end
+    local fontPath, fontSize, fontFlags = eb:GetFont()
+    if fontPath then meter:SetFont(fontPath, fontSize or 14, fontFlags or "") end
+    local spacing = (eb.GetSpacing and eb:GetSpacing()) or 0
+    if meter.SetSpacing then meter:SetSpacing(spacing) end
+    meter:SetWordWrap(true)
+    local width = eb:GetWidth() or 0
+    meter:SetWidth(width > 50 and width or 600)
+    meter:SetText("X")
+    local oneRow = meter:GetStringHeight() or (fontSize or 14)
+    if oneRow <= 0 then oneRow = fontSize or 14 end
+    meter:SetText(body ~= "" and body or "X")
+    local textHeight = meter:GetStringHeight() or oneRow
+    if typingOnTrailingRow then textHeight = textHeight + oneRow + spacing end
+    textHeight =
+        math.max(
+            MacroBoxRowsHeight(MACRO_BOX_MIN_LINES, oneRow, spacing),
+            math.min(MacroBoxRowsHeight(MACRO_BOX_MAX_LINES, oneRow, spacing), textHeight)
+        )
+    textHeight = math.max(textHeight, MACRO_BOX_MIN_INNER - MACRO_BOX_CHROME_SLACK)
+
+    local chrome =
+        (macroEditBox.labelHeight or 12) + (macroEditBox.verticalOffset or 2) * 3 + MACRO_BOX_CHROME_SLACK
+    local newHeight = math.ceil(textHeight + chrome)
+    if macroEditBox.gseFitHeight == newHeight then return end
+    macroEditBox.gseFitHeight = newHeight
+    local delta = newHeight - (macroEditBox.height or newHeight)
+    macroEditBox:SetHeight(newHeight)
+    -- The box sits under several EXPLICIT-height containers (macrolayout,
+    -- 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.
+    local parent = macroEditBox.parent
+    while parent do
+        if delta ~= 0 and parent.explicitHeight and not parent.autoAdjustHeight
+            and parent.height and parent.SetHeight then
+            parent:SetHeight(parent.height + delta)
+        elseif parent.DoLayout then
+            parent:DoLayout()
+        end
+        parent = parent.parent
+    end
+end
+
 local function SetMacroCountText(macroEditBox, lenMacro)
     if not (macroEditBox and macroEditBox.frame) then return end
 
@@ -5180,6 +5273,8 @@ function GSE.CreateEditor()
 			local macrolayout = UI:Create("SimpleGroup")
 			macrolayout:SetLayout("Flow")
 			macrolayout:SetFullWidth(true)
+			-- 108 == a MACRO_BOX_BASE_LINES-row macro box (SetNumLines: rows * 16 +
+			-- frameContentTop); the auto-fit measures its delta from that pairing.
 			macrolayout:SetHeight(108)
 			if macrolayout.SetFlowOffset then macrolayout:SetFlowOffset(0, 4) end
 			if macrolayout.SetFlowPadding then macrolayout:SetFlowPadding(4, 0, 4, 0) end
@@ -5243,6 +5338,10 @@ function GSE.CreateEditor()
 			macroFields:AddChild(macrolayout)
 			macroBody:AddChild(macroRail)
 			macroBody:AddChild(macroFields)
+			-- Fit the macro box to its content now that it sits under its containers:
+			-- the fit pushes the height delta up through macrolayout/macroFields/
+			-- macroBody (all explicit-height, sized above for the 108px baseline).
+			FitMacroEditBoxToContent(macroeditbox, macroeditbox:GetText())
 			spellcontainer:AddChild(macroBody)
 			-- Report the COMPILED macro body length (after spell-name translation)
 			-- so the "X/255" indicator matches the over-limit trigger and what WoW
@@ -7296,7 +7395,7 @@ function GSE.CreateEditor()
             DisableMultilineEditorColoring(macroEditBox)
             macroEditBox:SetLabel(L["Macro Name or Macro Commands"])
             macroEditBox:DisableButton(true)
-            macroEditBox:SetNumLines(5)
+            macroEditBox:SetNumLines(MACRO_BOX_BASE_LINES)
             macroEditBox:SetRelativeWidth(0.5)
             macroEditBox:SetText(spelltext)
             ForwardMacroEditorMouseWheel(macroEditBox, frame)
@@ -7376,6 +7475,7 @@ function GSE.CreateEditor()
                         if compiledMacro.parent and compiledMacro.parent.DoLayout then compiledMacro.parent:DoLayout() end
                     end
                     SetMacroCountText(macroEditBox, GSE.GetMacroEditorTextLength(value or ""))
+                    FitMacroEditBoxToContent(macroEditBox, value)
                     UpdateMacroLimitState(macroEditBox, sequence.Versions[version].Actions[keyPath].macro, editframe, version)
                 end
             )