akkartik/broadsheet.love - Change PP2IIHL6EK4HBFFSYAQNV35BKIK6D4EL2JQOY7NZVJX2DXCLSMGAC

stop putting button state in a global

Symptom: a test (test_click_to_create_drawing) started randomly failing after I inserted a return 2 commits ago.

Cause: my tests call edit.draw, but button handlers only get cleared in app.draw. So my tests weren't clearing button handlers, and every call to edit.draw was accumulating states. Still unclear why those were going to different state objects after the return, but anyway. I'm not going to understand every last thing that happens when things go wrong, just guarantee they can't go wrong. And the way to do that is to decentralize button handlers to each state that receives them.

The State object in buttons.lua doesn't have to be Editor_state. It just has to be some table that provides a Schelling Point for shared state.

Created by Kartik K. Agaram on August 23, 2022

PP2IIHL6EK4HBFFSYAQNV35BKIK6D4EL2JQOY7NZVJX2DXCLSMGAC

Dependencies

In channels

main

Change contents

Deletion in main.lua at line 136 [6.2]
B:BD[4.1373] → [5.47:70]
```
  Button_handlers = {}
```
Insertion in edit.lua at line 131 [9.413]
[7.2727]
[8.999]
```
  State.button_handlers = {}
```

Replacement in edit.lua at line 155 [9.413]

B:BD[10.269] → [10.269:330]

        button('draw', {x=4,y=y+4, w=12,h=12, color={1,1,0},

[10.269]

[10.330]

        button(State, 'draw', {x=4,y=y+4, w=12,h=12, color={1,1,0},

Replacement in edit.lua at line 212 [9.413]

B:BD[7.4647] → [2.114:172]

  if propagate_to_button_handlers(x,y, mouse_button) then

[7.4647]

[2.172]

  if propagate_to_button_handlers(State, x,y, mouse_button) then

Deletion in button.lua at line 5 [12.2058]
∅:D[3.203] → [11.141:142]
B:BD[11.141] → [11.141:142]
B:BD[11.142] → [13.35:56]
```
Button_handlers = {}
```

Replacement in button.lua at line 7 [12.2058]

B:BD[12.2124] → [12.2124:2154]

function button(name, params)

[12.2124]

[12.2154]

function button(State, name, params)
  if State.button_handlers == nil then
    State.button_handlers = {}
  end

Replacement in button.lua at line 14 [12.2058]
B:BD[12.2365] → [13.57:97]
```
  table.insert(Button_handlers, params)
```
[12.2365]
[12.2405]
```
  table.insert(State.button_handlers, params)
```

Replacement in button.lua at line 18 [12.2058]

B:BD[12.2443] → [11.143:201]

B:BD[11.201] → [13.98:139]

function propagate_to_button_handlers(x, y, mouse_button)
  for _,ev in ipairs(Button_handlers) do

[12.2443]

[12.2535]

function propagate_to_button_handlers(State, x, y, mouse_button)
  if State.button_handlers == nil then
    return
  end
  for _,ev in ipairs(State.button_handlers) do

stop putting button state in a global

Dependencies

In channels

Change contents

Deletion in main.lua at line 136 [6.2]

Insertion in edit.lua at line 131 [9.413]

Replacement in edit.lua at line 155 [9.413]

Replacement in edit.lua at line 212 [9.413]

Deletion in button.lua at line 5 [12.2058]

Replacement in button.lua at line 7 [12.2058]

Replacement in button.lua at line 14 [12.2058]

Replacement in button.lua at line 18 [12.2058]