akkartik/pensieve.love - Change 6LBSEPBJTXIVBYX3AH5FYCQCN66ZRFFO3IVYMDS7IQUGEAZM3MHQC

back to the problem of cursor going off screen

I just went over all my changes in this vein: git diff 6fe017ba75

(Turns out git diff "does what you want" and excludes changes merged in from upstream: https://stackoverflow.com/questions/7488956/git-diff-on-topic-branch-excluding-merge-commits-that-happened-in-the-meantime)

First step: clean up all debug prints. I'm still going to keep unrelated improvements. In particular, the assertion checking for screen going off screen now works, so this bug will be more apparent.

Summary of the problem: Text.snap_cursor_to_bottom_of_screen (which sets screen_top) interacts poorly with plan_draw (which sets Display_settings.y). It's easy to cause 3 misfits:

typing on bottom screen line: cursor goes off screen when line wraps
down arrow in edit mode: cursor goes off screen
down arrow in edit mode: cursor doesn't actually move to next line text (ignoring scrolling)
unnecessary scrolling: down arrow at top screen line or up arrow at bottom screen line

Created by Kartik K. Agaram on August 22, 2022

6LBSEPBJTXIVBYX3AH5FYCQCN66ZRFFO3IVYMDS7IQUGEAZM3MHQC

Dependencies

In channels

main

Change contents

Replacement in text.lua at line 476 [7.1]

B:BD[6.5973] → [2.3:158]

  print('down', State.screen_top1.line, State.screen_top1.pos, State.cursor1.line, State.cursor1.pos, State.screen_bottom1.line, State.screen_bottom1.pos)

[6.5973]

[8.1281]

--?   print('down', State.screen_top1.line, State.screen_top1.pos, State.cursor1.line, State.cursor1.pos, State.screen_bottom1.line, State.screen_bottom1.pos)

Replacement in text.lua at line 479 [7.1]

B:BD[9.2960] → [10.159:212]

    print('cursor at final screen line of its line')

[9.2960]

[6.6133]

--?     print('cursor at final screen line of its line')

Replacement in text.lua at line 490 [7.1]

B:BD[11.1321] → [2.159:222]

    print('new cursor', State.cursor1.line, State.cursor1.pos)

[11.1321]

[6.6478]

--?     print('new cursor', State.cursor1.line, State.cursor1.pos)

Replacement in text.lua at line 492 [7.1]

B:BD[6.6537] → [10.213:337]

      print('screen top before:', State.screen_top1.line, State.screen_top1.pos)
      print('scroll up preserving cursor')

[6.6537]

[8.1451]

--?       print('screen top before:', State.screen_top1.line, State.screen_top1.pos)
--?       print('scroll up preserving cursor')

Replacement in text.lua at line 495 [7.1]

B:BD[8.1501] → [10.338:418]

      print('screen top after:', State.screen_top1.line, State.screen_top1.pos)

[8.1501]

[9.3680]

--?       print('screen top after:', State.screen_top1.line, State.screen_top1.pos)

Replacement in text.lua at line 500 [7.1]

∅:D[12.75] → [10.419:479]

B:BD[9.3929] → [10.419:479]

    print('cursor is NOT at final screen line of its line')

[12.75]

[5.3]

--?     print('cursor is NOT at final screen line of its line')

Replacement in text.lua at line 503 [7.1]

∅:D[12.311] → [10.480:622]

B:BD[13.688] → [10.480:622]

    print('switching pos of screen line at cursor from '..tostring(screen_line_starting_pos)..' to '..tostring(new_screen_line_starting_pos))

[12.311]

[12.313]

--?     print('switching pos of screen line at cursor from '..tostring(screen_line_starting_pos)..' to '..tostring(new_screen_line_starting_pos))

Replacement in text.lua at line 507 [7.1]

B:BD[8.1720] → [10.623:693]

    print('cursor pos is now', State.cursor1.line, State.cursor1.pos)

[8.1720]

[14.130]

--?     print('cursor pos is now', State.cursor1.line, State.cursor1.pos)

Replacement in text.lua at line 509 [7.1]

B:BD[14.154] → [10.694:737]

      print('scroll up preserving cursor')

[14.154]

[8.1721]

--?       print('scroll up preserving cursor')

Replacement in text.lua at line 511 [7.1]

B:BD[8.1771] → [10.738:818]

      print('screen top after:', State.screen_top1.line, State.screen_top1.pos)

[8.1771]

[9.4796]

--?       print('screen top after:', State.screen_top1.line, State.screen_top1.pos)

Replacement in text.lua at line 514 [7.1]

B:BD[9.4810] → [10.819:972]

  print('=>', State.cursor1.line, State.cursor1.pos, State.screen_top1.line, State.screen_top1.pos, State.screen_bottom1.line, State.screen_bottom1.pos)

[9.4810]

[15.6091]

--?   print('=>', State.cursor1.line, State.cursor1.pos, State.screen_top1.line, State.screen_top1.pos, State.screen_bottom1.line, State.screen_bottom1.pos)

Insertion in text.lua at line 679 [7.1]

[8.2786]

--?   print('snap cursor to bottom:', State.top, State.screen_top1.line, State.screen_top1.pos, State.cursor1.line, State.cursor1.pos)

Replacement in text.lua at line 682 [7.1]

B:BD[16.580] → [2.223:257]

∅:D[2.257] → [10.973:1090]

B:BD[16.580] → [10.973:1090]

  print('snap cursor', State.top)
  print('cursor pos '..tostring(State.cursor1.pos)..' is on the #'..tostring(top2.screen_line)..' screen line down')

[16.580]

[17.3208]

--?   print('cursor pos '..tostring(State.cursor1.pos)..' is on the #'..tostring(top2.screen_line)..' screen line down')

Replacement in text.lua at line 686 [7.1]

B:BD[18.660] → [10.1091:1159]

    print(y, 'top2:', top2.line, top2.screen_line, top2.screen_pos)

[18.660]

[19.331]

--?     print(y, 'top2:', top2.line, top2.screen_line, top2.screen_pos)

Replacement in text.lua at line 688 [7.1]

B:BD[19.394] → [2.258:332]

    if top2.screen_line > 1 or State.lines[top2.line].mode == 'text' then

[19.394]

[2.332]

    if top2.screen_line > 1 or State.lines[top2.line-1].mode == 'text' then

Replacement in text.lua at line 697 [7.1]

B:BD[19.614] → [2.378:433]

      assert(State.lines[top2.line].mode == 'drawing')

[19.614]

[19.665]

      assert(State.lines[top2.line-1].mode == 'drawing')

Replacement in text.lua at line 700 [7.1]

B:BD[19.767] → [2.434:529]

      local h = Drawing_padding_height + Drawing.pixels(State.lines[top2.line].h, State.width)

[19.767]

[20.16768]

      local h = Drawing_padding_height + Drawing.pixels(State.lines[top2.line-1].h, State.width)

Replacement in text.lua at line 704 [7.1]

B:BD[19.881] → [10.1160:1205]

      print('skipping drawing of height', h)

[19.881]

[19.930]

--?       print('skipping drawing of height', h)

Replacement in text.lua at line 709 [7.1]

B:BD[18.931] → [10.1206:1277]

  print('top2 finally:', top2.line, top2.screen_line, top2.screen_pos)

[18.931]

[17.3661]

--?   print('top2 finally:', top2.line, top2.screen_line, top2.screen_pos)

Replacement in text.lua at line 711 [7.1]

B:BD[17.3705] → [10.1278:1350]

  print('top1 finally:', State.screen_top1.line, State.screen_top1.pos)

[17.3705]

[17.3781]

--?   print('top1 finally:', State.screen_top1.line, State.screen_top1.pos)

Replacement in main.lua at line 297 [22.2]
B:BD[21.678] → [2.535:565]
```
  print('update pane bounds')
```
[21.678]
[21.679]
```
--?   print('update pane bounds')
```

Deletion in main.lua at line 327 [22.2]

B:BD[23.1225] → [24.63:178]

          if column_index == 5 then print('0', body_sy, Display_settings.y, pane.top, Header_height, y_offset) end

Replacement in main.lua at line 328 [22.2]
B:BD[24.232] → [24.232:257]
```
            pane.top = 0
```
[25.332]
[26.753]
```
            pane.top = Margin_above
```

Replacement in main.lua at line 330 [22.2]

B:BD[26.768] → [3.8:60]

            pane.top = body_sy - Display_settings.y

[26.768]

[26.830]

            pane.top = body_sy - Display_settings.y + Margin_above

Deletion in main.lua at line 342 [22.2]
B:BD[10.1368] → [10.1368:1428]
∅:D[27.94] → [23.1667:1679]
∅:D[28.251] → [23.1667:1679]
∅:D[29.345] → [23.1667:1679]
∅:D[10.1428] → [23.1667:1679]
B:BD[23.1667] → [23.1667:1679]
```
        if column_index == 5 then
          pane.foo = true
        end
```

Replacement in main.lua at line 412 [22.2]

B:BD[30.162] → [2.566:600]

--?         assert(pane.cursor_y)

[30.162]

[30.192]

        assert(pane.cursor_y, 'cursor went off screen; this should never happen')

Replacement in main.lua at line 751 [22.2]
B:BD[31.408] → [10.1429:1462]
```
  print('keychord press', chord)
```
[31.408]
[32.8]
```
--?   print('keychord press', chord)
```

Replacement in main.lua at line 1095 [22.2]

B:BD[33.253] → [3.61:116]

  if pane.cursor_x == nil or pane.cursor_y == nil then

[33.253]

[34.8]

  if pane.cursor_x == nil then
    assert(pane.cursor_y == nil)

Replacement in main.lua at line 1103 [22.2]

B:BD[33.489] → [10.1725:1780]

    print(('%s pressed in editor pane'):format(chord))

[33.489]

[4.119]

--?     print(('%s pressed in editor pane'):format(chord))

Replacement in main.lua at line 1115 [22.2]

B:BD[35.269] → [10.1781:2045]

    print(('screen top changed from (%d,%d) to (%d,%d)'):format(old_top.line, old_top.pos, pane.screen_top1.line, pane.screen_top1.pos))
    print('updating viewport based on screen top')
    print('from', Display_settings.y, y_of_schema1(pane, pane.screen_top1))

[35.269]

[35.324]

--?     print(('screen top changed from (%d,%d) to (%d,%d)'):format(old_top.line, old_top.pos, pane.screen_top1.line, pane.screen_top1.pos))
--?     print('updating viewport based on screen top')
--?     print('from', Display_settings.y, y_of_schema1(pane, pane.screen_top1))

Replacement in main.lua at line 1119 [22.2]
B:BD[35.433] → [10.2046:2082]
```
    print('to', Display_settings.y)
```
[35.433]
[30.293]
```
--?     print('to', Display_settings.y)
```
Replacement in main.lua at line 1148 [22.2]
B:BD[36.419] → [37.423:453]
```
  local result = Margin_above
```
[36.419]
[36.419]
```
  local result = 0
```

Deletion in edit.lua at line 138 [38.413]

B:BD[38.4124] → [2.608:673]

  if State.foo then
    print('edit.draw from', State.top)
  end

Deletion in edit.lua at line 140 [38.413]

B:BD[39.3030] → [2.674:787]

    if State.foo then
    print('draw:', line_index, y, '+', State.line_height, 'vs', App.screen.height)
    end

Deletion in edit.lua at line 178 [38.413]

B:BD[38.5853] → [10.2389:2611]

  end
  if State.foo then
    print('draw: screen top', State.screen_top1.line, State.screen_top1.pos, 'cursor', State.cursor1.line, State.cursor1.pos, 'screen bottom', State.screen_bottom1.line, State.screen_bottom1.pos)

Deletion in edit.lua at line 184 [38.413]
B:BD[10.2618] → [10.2618:2658]
∅:D[40.2101] → [38.6084:6090]
∅:D[10.2658] → [38.6084:6090]
B:BD[38.6084] → [38.6084:6090]
```
  if State.foo then
    State.foo = nil
  end
```

Replacement in commands.lua at line 139 [42.39]

B:BD[41.1039] → [2.821:1438]

--?           if pane.cursor_x >= 0 and pane.cursor_x < App.screen.width and pane.cursor_y >= Header_height and pane.cursor_y < App.screen.height then
--?             add_hotkey_to_menu('ctrl+e: stop editing')
--?             add_hotkey_to_menu('ctrl+h on drawing: help')
--?             add_hotkey_to_menu('ctrl+f: find')
--?             add_hotkey_to_menu('alt+left alt+right: prev/next word')
--?             add_hotkey_to_menu('ctrl+z ctrl+y: undo/redo')
--?             add_hotkey_to_menu('ctrl+x ctrl+c ctrl+v: cut/copy/paste')
--?           else
--?             add_panning_hotkeys_to_menu()
--?           end

[41.1039]

[41.1079]

          if pane.cursor_x >= 0 and pane.cursor_x < App.screen.width and pane.cursor_y >= Header_height and pane.cursor_y < App.screen.height then
            add_hotkey_to_menu('ctrl+e: stop editing')
            add_hotkey_to_menu('ctrl+h on drawing: help')
            add_hotkey_to_menu('ctrl+f: find')
            add_hotkey_to_menu('alt+left alt+right: prev/next word')
            add_hotkey_to_menu('ctrl+z ctrl+y: undo/redo')
            add_hotkey_to_menu('ctrl+x ctrl+c ctrl+v: cut/copy/paste')
          else
            add_panning_hotkeys_to_menu()
          end