akkartik/sokoban.love - Change 656FM555BRGLHJ7PTIZXD2IY5T7PGFEYSHG2T3Z7WNX6QZ5KROSAC

bugfix: clear selection when clicking above or below lines

Matt Wynne pointed out that snap.love would crash when a node went off screen. While debugging it I noticed that selection1 was being set when it shouldn't be.

Turns out I introduced a bug when I fixed the inscript bug back in June (commit 9656e137742). One invariant I want to preserve is: selection1 should be unset after a mouse click (press and release without intervening drag). This invariant was violated in my bugfix back in June. I was concerned only with selection back then, and I didn't realize I was breaking the mouse click case (in a fairly subtle way; you can have selection set, and when it's set identically to the cursor everything looks the same).

I think there might still be an issue in snap.love after this fix. I noticed screen_bottom1.pos was nil, and as far as I recall that should never happen.

Created by Kartik K. Agaram on September 20, 2023

656FM555BRGLHJ7PTIZXD2IY5T7PGFEYSHG2T3Z7WNX6QZ5KROSAC

Dependencies

In channels

main

Change contents

Insertion in text_tests.lua at line 278 [6.2]
[5.434]
[5.434]
```
  Editor_state.selection1 = {}
```
Insertion in text_tests.lua at line 298 [6.2]
[7.689]
[7.689]
```
  Editor_state.selection1 = {}
```
Insertion in text_tests.lua at line 317 [6.2]
[8.7940]
[9.354]
```
  Editor_state.selection1 = {}
```

Insertion in text_tests.lua at line 322 [6.2]

[9.473]

[10.2279]

  check_eq(Editor_state.cursor1.line, 1, 'cursor')
  -- selection remains empty
  check_nil(Editor_state.selection1.line, 'selection is empty to avoid perturbing future edits')
end
function test_click_below_all_lines()
  -- display one line
  App.screen.init{width=50, height=80}
  Editor_state = edit.initialize_test_state()
  Editor_state.lines = load_array{'abc'}
  Text.redraw_all(Editor_state)
  Editor_state.cursor1 = {line=1, pos=1}
  Editor_state.screen_top1 = {line=1, pos=1}
  Editor_state.screen_bottom1 = {}
  Editor_state.selection1 = {}
  -- click below first line
  edit.draw(Editor_state)
  edit.run_after_mouse_click(Editor_state, Editor_state.left+8,Editor_state.top+50, 1)
  -- cursor doesn't move

Insertion in text_tests.lua at line 342 [6.2]

[10.2330]

[11.524]

  -- selection remains empty
  check_nil(Editor_state.selection1.line, 'selection is empty to avoid perturbing future edits')

Insertion in text_tests at line 26 [2.3]
[2.746]
[2.746]
```
click below final line does nothing
```
Insertion in source_text_tests.lua at line 278 [12.3498]
[12.14324]
[12.14324]
```
  Editor_state.selection1 = {}
```
Insertion in source_text_tests.lua at line 298 [12.3498]
[12.15229]
[12.15229]
```
  Editor_state.selection1 = {}
```
Insertion in source_text_tests.lua at line 317 [12.3498]
[12.16039]
[12.16039]
```
  Editor_state.selection1 = {}
```

Insertion in source_text_tests.lua at line 322 [12.3498]

[12.16198]

[10.25645]

  check_eq(Editor_state.cursor1.line, 1, 'cursor')
  -- selection remains empty
  check_nil(Editor_state.selection1.line, 'selection is empty to avoid perturbing future edits')
end
function test_click_below_all_lines()
  -- display one line
  App.screen.init{width=50, height=80}
  Editor_state = edit.initialize_test_state()
  Editor_state.lines = load_array{'abc'}
  Text.redraw_all(Editor_state)
  Editor_state.cursor1 = {line=1, pos=1}
  Editor_state.screen_top1 = {line=1, pos=1}
  Editor_state.screen_bottom1 = {}
  Editor_state.selection1 = {}
  -- click below first line
  edit.draw(Editor_state)
  edit.run_after_mouse_click(Editor_state, Editor_state.left+8,Editor_state.top+50, 1)
  -- cursor doesn't move

Insertion in source_text_tests.lua at line 342 [12.3498]

[10.25696]

[12.16289]

  -- selection remains empty
  check_nil(Editor_state.selection1.line, 'selection is empty to avoid perturbing future edits')

Replacement in source_edit.lua at line 298 [12.152440]

B:BD[4.5220] → [4.5220:5269]

  -- still here? click is below all screen lines

[4.5220]

[4.5269]

  -- still here? mouse press is below all screen lines

Insertion in source_edit.lua at line 320 [12.152440]

[4.5700]

[13.31211]

    if y < State.top then
      State.cursor1 = {line=State.screen_top1.line, pos=State.screen_top1.pos}
      edit.clean_up_mouse_press(State)
      return
    end

Replacement in source_edit.lua at line 335 [12.152440]

∅:D[4.5901] → [13.31612:32056]

∅:D[14.7222] → [13.31612:32056]

B:BD[13.31612] → [13.31612:32056]

          if State.mousepress_shift then
            if State.old_selection1.line == nil then
              State.selection1 = State.old_cursor1
            else
              State.selection1 = State.old_selection1
            end
          end
          State.old_cursor1, State.old_selection1, State.mousepress_shift = nil
          if eq(State.cursor1, State.selection1) then
            State.selection1 = {}
          end
          break

[4.5901]

[13.32056]

          edit.clean_up_mouse_press(State)
          return

Insertion in source_edit.lua at line 340 [12.152440]

[13.32086]

[4.5902]


    -- still here? mouse release is below all screen lines
    State.cursor1.line, State.cursor1.pos = State.screen_bottom1.line, Text.pos_at_end_of_screen_line(State, State.screen_bottom1)
    edit.clean_up_mouse_press(State)

Insertion in source_edit.lua at line 345 [12.152440]

[4.6097]

[15.11]

  end
end
function edit.clean_up_mouse_press(State)
  if State.mousepress_shift then
    if State.old_selection1.line == nil then
      State.selection1 = State.old_cursor1
    else
      State.selection1 = State.old_selection1
    end

Insertion in source_edit.lua at line 356 [12.152440]

[15.17]

  State.old_cursor1, State.old_selection1, State.mousepress_shift = nil
  if eq(State.cursor1, State.selection1) then
    State.selection1 = {}
  end

Replacement in edit.lua at line 294 [16.413]

B:BD[3.2288] → [3.2288:2337]

  -- still here? click is below all screen lines

[3.2288]

[3.2337]

  -- still here? mouse press is below all screen lines

Insertion in edit.lua at line 316 [16.413]

[3.2768]

[17.5479]

    if y < State.top then
      State.cursor1 = {line=State.screen_top1.line, pos=State.screen_top1.pos}
      edit.clean_up_mouse_press(State)
      return
    end

Replacement in edit.lua at line 331 [16.413]

∅:D[18.354] → [17.5833:5978]

∅:D[19.744] → [17.5833:5978]

∅:D[20.1049] → [17.5833:5978]

∅:D[3.2969] → [17.5833:5978]

B:BD[17.5833] → [17.5833:5978]

∅:D[17.5978] → [16.9343:9360]

∅:D[8.101854] → [16.9343:9360]

B:BD[16.9343] → [16.9343:9360]

B:BD[16.9360] → [17.5979:6033]

∅:D[17.6033] → [16.9402:9432]

∅:D[8.101923] → [16.9402:9432]

B:BD[16.9402] → [16.9402:9432]

B:BD[16.9432] → [17.6034:6202]

∅:D[17.6202] → [16.9564:9594]

∅:D[8.102134] → [16.9564:9594]

B:BD[16.9564] → [16.9564:9594]

          if State.mousepress_shift then
            if State.old_selection1.line == nil then
              State.selection1 = State.old_cursor1
            else
              State.selection1 = State.old_selection1
            end
          end
          State.old_cursor1, State.old_selection1, State.mousepress_shift = nil
          if eq(State.cursor1, State.selection1) then
            State.selection1 = {}
          end
          break

[3.2969]

[16.9594]

          edit.clean_up_mouse_press(State)
          return

Insertion in edit.lua at line 336 [16.413]

[16.9624]

[3.2970]


    -- still here? mouse release is below all screen lines
    State.cursor1.line, State.cursor1.pos = State.screen_bottom1.line, Text.pos_at_end_of_screen_line(State, State.screen_bottom1)
    edit.clean_up_mouse_press(State)

Insertion in edit.lua at line 341 [16.413]

[3.3165]

[15.1864]

  end
end
function edit.clean_up_mouse_press(State)
  if State.mousepress_shift then
    if State.old_selection1.line == nil then
      State.selection1 = State.old_cursor1
    else
      State.selection1 = State.old_selection1
    end

Insertion in edit.lua at line 352 [16.413]

[15.1870]

  State.old_cursor1, State.old_selection1, State.mousepress_shift = nil
  if eq(State.cursor1, State.selection1) then
    State.selection1 = {}
  end