From 1031f474965b5cce4cb195b274a566b9ba7abc86 Mon Sep 17 00:00:00 2001 From: "Kartik K. Agaram" Date: Fri, 27 Oct 2023 15:48:45 -0700 Subject: [PATCH] snapshot: a whole new approach to panning Basic idea: If the goal is for the cursor to be on the viewport, focus the code on ensuring that constraint by construction. Motivation: The downstream driver.love fork still has persistent bugs. And I'm seeing some inconclusive signs that edit.lua might be failing to change screen_top some of the time when it needs to. But this only happens in driver.love, never in lines.love. So the null hypothesis is that there's some subtle assumption in lines.love that we're violating when rendering it on a surface. What do you do with such subtleties? It might actually be counterproductive to fix them at source. You end up with complexity upstream that won't actually matter there if it breaks. Which is a recipe for it to break silently and far away from the downstream fork that might actually care about it. Or it might confuse people in future who don't care about the downstream forks, just lines.love. Maybe it makes sense to modify edit.lua here and take the hit on all possible future merge conflicts. But considering the cost of tracking this down, it seems simplest to: a) come up with the constraint I care about, and b) modify outside edit.lua, either what it sees or its results, to preserve the new constraint. Long ago I used to have this assertion in pensieve.love that the cursor must be within the viewport, but I ended up taking it out because it kept breaking for me when I was trying to do real work. It seems clear that there are possible assertions that are useful and yet counterproductive. If you can't keep it out of the product in the course of testing, then it annoys users where ignoring it would be a more graceful experience. Even when the user is just yourself! So it turns out this is not a problem only for large teams of extrinsically motivated people who don't eat their own dog food. No, for some things you have to fix the problem by construction, not just verify it with an assertion. This plan isn't fully working yet in this commit. I've only fixed cases for down-arrow. I need to address up arrow, and there might also be changes for left/right arrows. Hmm, I'm going to try to follow the implementation of bring_cursor_of_cursor_node_in_view() in pensieve.love. In the process of doing this I also noticed a bug with page-up/down. It already existed, but this approach has made it more obvious. --- 0019-B | 4 ++-- 0021-compute_layout | 8 ++++---- 0023-on.keychord_press | 23 +++------------------ 0028-A | 8 ++++---- 0030-update_editor_box | 23 +++++---------------- 0035-pan_viewport_to_contain_cursor | 31 +++++++++++++++++++++++++++++ 6 files changed, 49 insertions(+), 48 deletions(-) create mode 100644 0035-pan_viewport_to_contain_cursor diff --git a/0019-B b/0019-B index 43c72b6..7e7d0c7 100644 --- a/0019-B +++ b/0019-B @@ -1,4 +1,4 @@ -B = function(skip_updating_screen_top_for) +B = function() -- recompute various aspects based on the current viewport settings for _,obj in ipairs(Surface) do if obj.type == 'line' then @@ -16,7 +16,7 @@ B = function(skip_updating_screen_top_for) obj.zdata = love.math.newBezierCurve(zdata):render() elseif obj.type == 'text' then if obj.w then - update_editor_box(obj, skip_updating_screen_top_for) + update_editor_box(obj) else obj.text = love.graphics.newText(love.graphics.getFont(), obj.data) end diff --git a/0021-compute_layout b/0021-compute_layout index 4d025f3..eb74338 100644 --- a/0021-compute_layout +++ b/0021-compute_layout @@ -1,4 +1,4 @@ -compute_layout = function(node, x,y, nodes_to_render, skip_updating_screen_top_for) +compute_layout = function(node, x,y, nodes_to_render) -- append to nodes_to_render flattened instructions to render a hierarchy of nodes -- return x,y rendered until (surface coordinates) if node.type == 'text' then @@ -31,7 +31,7 @@ compute_layout = function(node, x,y, nodes_to_render, skip_updating_screen_top_f if node.editor == nil then initialize_editor(node) else - update_editor_box(node, skip_updating_screen_top_for) + update_editor_box(node) end node.h = box_height(node) table.insert(nodes_to_render, node) @@ -59,7 +59,7 @@ compute_layout = function(node, x,y, nodes_to_render, skip_updating_screen_top_f if not child.width then child.width = node.width -- HACK: should we set child.w or child.width? Neither is quite satisfactory. end - subx,suby = compute_layout(child, x,suby, nodes_to_render, skip_updating_screen_top_for) + subx,suby = compute_layout(child, x,suby, nodes_to_render) if w < child.w then w = child.w end @@ -87,7 +87,7 @@ compute_layout = function(node, x,y, nodes_to_render, skip_updating_screen_top_f subx = subx+child.margin w = w+child.margin end - subx,suby = compute_layout(child, subx,y, nodes_to_render, skip_updating_screen_top_for) + subx,suby = compute_layout(child, subx,y, nodes_to_render) w = w + child.w if h < child.h then h = child.h diff --git a/0023-on.keychord_press b/0023-on.keychord_press index f81a332..ba8c5a7 100644 --- a/0023-on.keychord_press +++ b/0023-on.keychord_press @@ -17,27 +17,10 @@ on.keychord_press = function(chord, key) elseif chord == 'C-z' then dump_state() elseif Cursor_node and Cursor_node.editor.cursor_x then - local old_top = {line=Cursor_node.editor.screen_top1.line, pos=Cursor_node.editor.screen_top1.pos} + print('cursor before', Cursor_node.editor.cursor1.line, Cursor_node.editor.cursor1.pos) edit.keychord_press(Cursor_node.editor, chord, key) ---? print('edit', old_top.line, '=>', Cursor_node.editor.screen_top1.line) - if not eq(Cursor_node.editor.screen_top1, old_top) then ---? print('modifying Viewport', Viewport.y, 'based on', Cursor_node.y, Cursor_node.editor.screen_top1.line, Cursor_node.editor.line_height) - Viewport.y = Cursor_node.y + y_of_schema1(Cursor_node.editor, Cursor_node.editor.screen_top1)/Viewport.zoom ---? print('modified Viewport', Viewport.y) - -- Most of the time, we update the screen_top of nodes from Viewport.y. - -- But here we went the other way. - -- It's very important to avoid creating a recurrence, to avoid running - -- both sides of this feedback loop in a single frame. These apps are - -- not very numerically precise (e.g. we force text lines to start at - -- integer pixels regardless of zoom, because that keeps text crisp), - -- and the computations of Viewport.y and node.top will almost certainly - -- not converge. The resulting bugs are extremely difficult to chase - -- down. - -- The optional skip_updating_screen_top_for arg ensures we don't run - -- the other side of the feedback loop. - A(--[[skip updating screen_top for]] Cursor_node) - return - end + print('cursor after', Cursor_node.editor.cursor1.line, Cursor_node.editor.cursor1.pos) + pan_viewport_to_contain_cursor(Cursor_node) A() else if chord == 'up' then diff --git a/0028-A b/0028-A index eee11f4..120d1c4 100644 --- a/0028-A +++ b/0028-A @@ -1,4 +1,4 @@ -A = function(skip_updating_screen_top_for) +A = function() love.graphics.setFont(love.graphics.newFont(scale(20))) -- editor objects implicitly depend on current font -- translate Page and Page2 to Surface Surface = {} @@ -9,9 +9,9 @@ A = function(skip_updating_screen_top_for) red = not red end end - compute_layout(Page, Page.x,Page.y, Surface, skip_updating_screen_top_for) - compute_layout(Page2, Page2.x,Page2.y, Surface, skip_updating_screen_top_for) + compute_layout(Page, Page.x,Page.y, Surface) + compute_layout(Page2, Page2.x,Page2.y, Surface) -- continue the pipeline - B(skip_updating_screen_top_for) + B() -- TODO: ugly that we're manipulating editor objects twice end diff --git a/0030-update_editor_box b/0030-update_editor_box index 6da4daa..3a7906b 100644 --- a/0030-update_editor_box +++ b/0030-update_editor_box @@ -1,29 +1,16 @@ -update_editor_box = function(node, skip_updating_screen_top_for) +update_editor_box = function(node, skip_updating) if node.editor == nil then return end + if node == skip_updating then return end edit.update_font_settings(node.editor, scale(20)) node.editor.left = math.floor(vx(node.x)) node.editor.right = math.ceil(vx(node.x+node.w)) node.editor.width = node.editor.right - node.editor.left Text.redraw_all(node.editor) ---? print('update', node.y, Viewport.y, 'spx', node.editor.screen_top1.line, node.editor.top, 'vpx') if node.y > Viewport.y then - if node ~= skip_updating_screen_top_for then ---? print('modifying screen_top to 1') - node.editor.screen_top1.line = 1 - node.editor.screen_top1.pos = 1 - end + node.editor.screen_top1.line = 1 + node.editor.screen_top1.pos = 1 node.editor.top = vy(node.y) else ---? print('<=', node, skip_updating_screen_top_for) - if node ~= skip_updating_screen_top_for then - node.editor.screen_top1, node.editor.top = schema1_of_y(node.editor, scale(Viewport.y-node.y)) - print('modified screen_top to', node.editor.screen_top1.line, 'at', node.editor.top, 'vpx') - else - -- adjust editor to start rendering near top of viewport ---? print(Viewport.y) - node.editor.top = Viewport.y%node.editor.line_height - if node.editor.top > 0 then node.editor.top = node.editor.top - node.editor.line_height end ---? print('top', node.editor.top) - end + node.editor.screen_top1, node.editor.top = schema1_of_y(node.editor, scale(Viewport.y-node.y)) end end diff --git a/0035-pan_viewport_to_contain_cursor b/0035-pan_viewport_to_contain_cursor new file mode 100644 index 0000000..8ff4de1 --- /dev/null +++ b/0035-pan_viewport_to_contain_cursor @@ -0,0 +1,31 @@ +function pan_viewport_to_contain_cursor(node) + print('viewport', Viewport.y) + local safety_margin = 2*node.editor.line_height + print('safety margin', screen_top_y, 'dvpx') + print('node', node.y) + local cursor_y = y_of_schema1(node.editor, node.editor.cursor1) + print('cursor', cursor_y, 'dvpx') + if Viewport.y < node.y then + -- node starts within Viewport + print('node starts within viewport') + local max_cursor_y = App.screen.height - scale(node.y - Viewport.y) - safety_margin + if cursor_y > max_cursor_y then + -- set Viewport.y so cursor_y == max_cursor_y + -- equation: cursor_y == App.screen.height - (node.y - Viewport.y)*Viewport.zoom - safety_margin + -- solve for Viewport.y + Viewport.y = node.y - (App.screen.height - cursor_y - safety_margin)/Viewport.zoom + print('adjusting Viewport to', Viewport.y) + end + else + -- node extends above Viewport + print('node extends above viewport') + local screen_top_y = y_of_schema1(node.editor, node.editor.screen_top1) + print('screen top', screen_top_y, 'dvpx') + local min_screen_top_y = cursor_y + safety_margin - App.screen.height + if screen_top_y < min_screen_top_y then + screen_top_y = min_screen_top_y + Viewport.y = node.y + screen_top_y/Viewport.zoom + print('adjusting Viewport to', Viewport.y) + end + end +end