late-bind my App.* handlers
[lines.love.git] / edit.lua
blobc8d5a03d016fd22d22efcdaf2cc2380b12e7af18
1 -- some constants people might like to tweak
2 Text_color = {r=0, g=0, b=0}
3 Cursor_color = {r=1, g=0, b=0}
4 Stroke_color = {r=0, g=0, b=0}
5 Current_stroke_color = {r=0.7, g=0.7, b=0.7} -- in process of being drawn
6 Current_name_background_color = {r=1, g=0, b=0, a=0.1} -- name currently being edited
7 Focus_stroke_color = {r=1, g=0, b=0} -- what mouse is hovering over
8 Highlight_color = {r=0.7, g=0.7, b=0.9} -- selected text
9 Icon_color = {r=0.7, g=0.7, b=0.7} -- color of current mode icon in drawings
10 Help_color = {r=0, g=0.5, b=0}
11 Help_background_color = {r=0, g=0.5, b=0, a=0.1}
13 Margin_top = 15
14 Margin_left = 25
15 Margin_right = 25
17 Drawing_padding_top = 10
18 Drawing_padding_bottom = 10
19 Drawing_padding_height = Drawing_padding_top + Drawing_padding_bottom
21 Same_point_distance = 4 -- pixel distance at which two points are considered the same
23 edit = {}
25 -- run in both tests and a real run
26 function edit.initialize_state(top, left, right, font_height, line_height) -- currently always draws to bottom of screen
27 local result = {
28 -- a line is either text or a drawing
29 -- a text is a table with:
30 -- mode = 'text',
31 -- string data,
32 -- a drawing is a table with:
33 -- mode = 'drawing'
34 -- a (y) coord in pixels (updated while painting screen),
35 -- a (h)eight,
36 -- an array of points, and
37 -- an array of shapes
38 -- a shape is a table containing:
39 -- a mode
40 -- an array points for mode 'freehand' (raw x,y coords; freehand drawings don't pollute the points array of a drawing)
41 -- an array vertices for mode 'polygon', 'rectangle', 'square'
42 -- p1, p2 for mode 'line'
43 -- center, radius for mode 'circle'
44 -- center, radius, start_angle, end_angle for mode 'arc'
45 -- Unless otherwise specified, coord fields are normalized; a drawing is always 256 units wide
46 -- The field names are carefully chosen so that switching modes in midstream
47 -- remembers previously entered points where that makes sense.
48 lines = {{mode='text', data=''}}, -- array of lines
50 -- Lines can be too long to fit on screen, in which case they _wrap_ into
51 -- multiple _screen lines_.
53 -- rendering wrapped text lines needs some additional short-lived data per line:
54 -- startpos, the index of data the line starts rendering from, can only be >1 for topmost line on screen
55 -- starty, the y coord in pixels the line starts rendering from
56 -- fragments: snippets of the line guaranteed to not straddle screen lines
57 -- screen_line_starting_pos: optional array of grapheme indices if it wraps over more than one screen line
58 line_cache = {},
60 -- Given wrapping, any potential location for the text cursor can be described in two ways:
61 -- * schema 1: As a combination of line index and position within a line (in utf8 codepoint units)
62 -- * schema 2: As a combination of line index, screen line index within the line, and a position within the screen line.
64 -- Most of the time we'll only persist positions in schema 1, translating to
65 -- schema 2 when that's convenient.
67 -- Make sure these coordinates are never aliased, so that changing one causes
68 -- action at a distance.
69 screen_top1 = {line=1, pos=1}, -- position of start of screen line at top of screen
70 cursor1 = {line=1, pos=1}, -- position of cursor
71 screen_bottom1 = {line=1, pos=1}, -- position of start of screen line at bottom of screen
73 selection1 = {},
74 -- some extra state to compute selection between mouse press and release
75 old_cursor1 = nil,
76 old_selection1 = nil,
77 mousepress_shift = nil,
79 -- cursor coordinates in pixels
80 cursor_x = 0,
81 cursor_y = 0,
83 current_drawing_mode = 'line', -- one of the available shape modes
84 previous_drawing_mode = nil, -- extra state for some ephemeral modes like moving/deleting/naming points
86 font_height = font_height,
87 line_height = line_height,
89 top = top,
90 left = math.floor(left),
91 right = math.floor(right),
92 width = right-left,
94 filename = love.filesystem.getSourceBaseDirectory()..'/lines.txt', -- '/' should work even on Windows
95 next_save = nil,
97 -- undo
98 history = {},
99 next_history = 1,
101 -- search
102 search_term = nil,
103 search_backup = nil, -- stuff to restore when cancelling search
105 return result
106 end -- App.initialize_state
108 function edit.check_locs(State)
109 -- if State is inconsistent (i.e. file changed by some other program),
110 -- throw away all cursor state entirely
111 if edit.invalid1(State, State.screen_top1)
112 or edit.invalid_cursor1(State)
113 or not edit.cursor_on_text(State)
114 or not Text.le1(State.screen_top1, State.cursor1) then
115 State.screen_top1 = {line=1, pos=1}
116 State.cursor1 = {line=1, pos=1}
117 edit.put_cursor_on_next_text_line(State)
121 function edit.invalid1(State, loc1)
122 if loc1.line > #State.lines then return true end
123 local l = State.lines[loc1.line]
124 if l.mode ~= 'text' then return false end -- pos is irrelevant to validity for a drawing line
125 return loc1.pos > #State.lines[loc1.line].data
128 -- cursor loc in particular differs from other locs in one way:
129 -- pos might occur just after end of line
130 function edit.invalid_cursor1(State)
131 local cursor1 = State.cursor1
132 if cursor1.line > #State.lines then return true end
133 local l = State.lines[cursor1.line]
134 if l.mode ~= 'text' then return false end -- pos is irrelevant to validity for a drawing line
135 return cursor1.pos > #State.lines[cursor1.line].data + 1
138 function edit.cursor_on_text(State)
139 return State.cursor1.line <= #State.lines
140 and State.lines[State.cursor1.line].mode == 'text'
143 function edit.put_cursor_on_next_text_line(State)
144 while true do
145 if State.cursor1.line >= #State.lines then
146 break
148 if State.lines[State.cursor1.line].mode == 'text' then
149 break
151 State.cursor1.line = State.cursor1.line+1
152 State.cursor1.pos = 1
156 -- return y drawn until
157 function edit.draw(State)
158 State.button_handlers = {}
159 App.color(Text_color)
160 assert(#State.lines == #State.line_cache, ('line_cache is out of date; %d elements when it should be %d'):format(#State.line_cache, #State.lines))
161 assert(Text.le1(State.screen_top1, State.cursor1), ('screen_top (line=%d,pos=%d) is below cursor (line=%d,pos=%d)'):format(State.screen_top1.line, State.screen_top1.pos, State.cursor1.line, State.cursor1.pos))
162 State.cursor_x = nil
163 State.cursor_y = nil
164 local y = State.top
165 local screen_bottom1 = {line=nil, pos=nil}
166 --? print('== draw')
167 for line_index = State.screen_top1.line,#State.lines do
168 local line = State.lines[line_index]
169 --? print('draw:', y, line_index, line)
170 if y + State.line_height > App.screen.height then break end
171 screen_bottom1.line = line_index
172 if line.mode == 'text' then
173 --? print('text.draw', y, line_index)
174 local startpos = 1
175 if line_index == State.screen_top1.line then
176 startpos = State.screen_top1.pos
178 if line.data == '' then
179 -- button to insert new drawing
180 button(State, 'draw', {x=State.left-Margin_left+4, y=y+4, w=12,h=12, bg={r=1,g=1,b=0},
181 icon = icon.insert_drawing,
182 onpress1 = function()
183 Drawing.before = snapshot(State, line_index-1, line_index)
184 table.insert(State.lines, line_index, {mode='drawing', y=y, h=256/2, points={}, shapes={}, pending={}})
185 table.insert(State.line_cache, line_index, {})
186 if State.cursor1.line >= line_index then
187 State.cursor1.line = State.cursor1.line+1
189 schedule_save(State)
190 record_undo_event(State, {before=Drawing.before, after=snapshot(State, line_index-1, line_index+1)})
191 end,
194 y, screen_bottom1.pos = Text.draw(State, line_index, y, startpos)
195 --? print('=> y', y)
196 elseif line.mode == 'drawing' then
197 y = y+Drawing_padding_top
198 Drawing.draw(State, line_index, y)
199 y = y + Drawing.pixels(line.h, State.width) + Drawing_padding_bottom
200 else
201 assert(false, ('unknown line mode %s'):format(line.mode))
204 State.screen_bottom1 = screen_bottom1
205 if State.search_term then
206 Text.draw_search_bar(State)
208 return y
211 function edit.update(State, dt)
212 Drawing.update(State, dt)
213 if State.next_save and State.next_save < Current_time then
214 save_to_disk(State)
215 State.next_save = nil
219 function schedule_save(State)
220 if State.next_save == nil then
221 State.next_save = Current_time + 3 -- short enough that you're likely to still remember what you did
225 function edit.quit(State)
226 -- make sure to save before quitting
227 if State.next_save then
228 save_to_disk(State)
229 -- give some time for the OS to flush everything to disk
230 love.timer.sleep(0.1)
234 function edit.mouse_press(State, x,y, mouse_button)
235 if State.search_term then return end
236 --? print_and_log(('edit.mouse_press: cursor at %d,%d'):format(State.cursor1.line, State.cursor1.pos))
237 if mouse_press_consumed_by_any_button_handler(State, x,y, mouse_button) then
238 -- press on a button and it returned 'true' to short-circuit
239 return
242 if y < State.top then
243 State.old_cursor1 = State.cursor1
244 State.old_selection1 = State.selection1
245 State.mousepress_shift = App.shift_down()
246 State.selection1 = {
247 line=State.screen_top1.line,
248 pos=State.screen_top1.pos,
250 return
253 for line_index,line in ipairs(State.lines) do
254 if line.mode == 'text' then
255 if Text.in_line(State, line_index, x,y) then
256 -- delicate dance between cursor, selection and old cursor/selection
257 -- scenarios:
258 -- regular press+release: sets cursor, clears selection
259 -- shift press+release:
260 -- sets selection to old cursor if not set otherwise leaves it untouched
261 -- sets cursor
262 -- press and hold to start a selection: sets selection on press, cursor on release
263 -- press and hold, then press shift: ignore shift
264 -- i.e. mouse_release should never look at shift state
265 --? print_and_log(('edit.mouse_press: in line %d'):format(line_index))
266 State.old_cursor1 = State.cursor1
267 State.old_selection1 = State.selection1
268 State.mousepress_shift = App.shift_down()
269 State.selection1 = {
270 line=line_index,
271 pos=Text.to_pos_on_line(State, line_index, x, y),
273 return
275 elseif line.mode == 'drawing' then
276 local line_cache = State.line_cache[line_index]
277 if Drawing.in_drawing(line, line_cache, x, y, State.left,State.right) then
278 State.lines.current_drawing_index = line_index
279 State.lines.current_drawing = line
280 Drawing.before = snapshot(State, line_index)
281 Drawing.mouse_press(State, line_index, x,y, mouse_button)
282 return
287 -- still here? mouse press is below all screen lines
288 State.old_cursor1 = State.cursor1
289 State.old_selection1 = State.selection1
290 State.mousepress_shift = App.shift_down()
291 State.selection1 = {
292 line=State.screen_bottom1.line,
293 pos=Text.pos_at_end_of_screen_line(State, State.screen_bottom1),
297 function edit.mouse_release(State, x,y, mouse_button)
298 if State.search_term then return end
299 --? print_and_log(('edit.mouse_release: cursor at %d,%d'):format(State.cursor1.line, State.cursor1.pos))
300 if State.lines.current_drawing then
301 Drawing.mouse_release(State, x,y, mouse_button)
302 schedule_save(State)
303 if Drawing.before then
304 record_undo_event(State, {before=Drawing.before, after=snapshot(State, State.lines.current_drawing_index)})
305 Drawing.before = nil
307 else
308 --? print_and_log('edit.mouse_release: no current drawing')
309 if y < State.top then
310 State.cursor1 = {line=State.screen_top1.line, pos=State.screen_top1.pos}
311 edit.clean_up_mouse_press(State)
312 return
315 for line_index,line in ipairs(State.lines) do
316 if line.mode == 'text' then
317 if Text.in_line(State, line_index, x,y) then
318 --? print_and_log(('edit.mouse_release: in line %d'):format(line_index))
319 State.cursor1 = {
320 line=line_index,
321 pos=Text.to_pos_on_line(State, line_index, x, y),
323 --? print_and_log(('edit.mouse_release: cursor now %d,%d'):format(State.cursor1.line, State.cursor1.pos))
324 edit.clean_up_mouse_press(State)
325 return
330 -- still here? mouse release is below all screen lines
331 State.cursor1.line, State.cursor1.pos = State.screen_bottom1.line, Text.pos_at_end_of_screen_line(State, State.screen_bottom1)
332 edit.clean_up_mouse_press(State)
333 --? print_and_log(('edit.mouse_release: finally selection %s,%s cursor %d,%d'):format(tostring(State.selection1.line), tostring(State.selection1.pos), State.cursor1.line, State.cursor1.pos))
337 function edit.clean_up_mouse_press(State)
338 if State.mousepress_shift then
339 if State.old_selection1.line == nil then
340 State.selection1 = State.old_cursor1
341 else
342 State.selection1 = State.old_selection1
345 State.old_cursor1, State.old_selection1, State.mousepress_shift = nil
346 if eq(State.cursor1, State.selection1) then
347 State.selection1 = {}
351 function edit.mouse_wheel_move(State, dx,dy)
352 if dy > 0 then
353 State.cursor1 = {line=State.screen_top1.line, pos=State.screen_top1.pos}
354 edit.put_cursor_on_next_text_line(State)
355 for i=1,math.floor(dy) do
356 Text.up(State)
358 elseif dy < 0 then
359 State.cursor1 = {line=State.screen_bottom1.line, pos=State.screen_bottom1.pos}
360 edit.put_cursor_on_next_text_line(State)
361 for i=1,math.floor(-dy) do
362 Text.down(State)
367 function edit.text_input(State, t)
368 --? print('text input', t)
369 if State.search_term then
370 State.search_term = State.search_term..t
371 Text.search_next(State)
372 elseif State.lines.current_drawing and State.current_drawing_mode == 'name' then
373 local before = snapshot(State, State.lines.current_drawing_index)
374 local drawing = State.lines.current_drawing
375 local p = drawing.points[drawing.pending.target_point]
376 p.name = p.name..t
377 record_undo_event(State, {before=before, after=snapshot(State, State.lines.current_drawing_index)})
378 else
379 local drawing_index, drawing = Drawing.current_drawing(State)
380 if drawing_index == nil then
381 for _,line_cache in ipairs(State.line_cache) do line_cache.starty = nil end -- just in case we scroll
382 Text.text_input(State, t)
385 schedule_save(State)
388 function edit.keychord_press(State, chord, key)
389 if State.selection1.line and
390 not State.lines.current_drawing and
391 -- printable character created using shift key => delete selection
392 -- (we're not creating any ctrl-shift- or alt-shift- combinations using regular/printable keys)
393 (not App.shift_down() or utf8.len(key) == 1) and
394 chord ~= 'C-a' and chord ~= 'C-c' and chord ~= 'C-x' and chord ~= 'backspace' and chord ~= 'delete' and chord ~= 'C-z' and chord ~= 'C-y' and not App.is_cursor_movement(chord) then
395 Text.delete_selection(State, State.left, State.right)
397 if State.search_term then
398 for _,line_cache in ipairs(State.line_cache) do line_cache.starty = nil end -- just in case we scroll
399 if chord == 'escape' then
400 State.search_term = nil
401 State.cursor1 = State.search_backup.cursor
402 State.screen_top1 = State.search_backup.screen_top
403 State.search_backup = nil
404 Text.redraw_all(State) -- if we're scrolling, reclaim all fragments to avoid memory leaks
405 elseif chord == 'return' then
406 State.search_term = nil
407 State.search_backup = nil
408 elseif chord == 'backspace' then
409 local len = utf8.len(State.search_term)
410 local byte_offset = Text.offset(State.search_term, len)
411 State.search_term = string.sub(State.search_term, 1, byte_offset-1)
412 elseif chord == 'down' then
413 State.cursor1.pos = State.cursor1.pos+1
414 Text.search_next(State)
415 elseif chord == 'up' then
416 Text.search_previous(State)
418 return
419 elseif chord == 'C-f' then
420 State.search_term = ''
421 State.search_backup = {
422 cursor={line=State.cursor1.line, pos=State.cursor1.pos},
423 screen_top={line=State.screen_top1.line, pos=State.screen_top1.pos},
425 -- zoom
426 elseif chord == 'C-=' then
427 edit.update_font_settings(State, State.font_height+2)
428 Text.redraw_all(State)
429 elseif chord == 'C--' then
430 if State.font_height > 2 then
431 edit.update_font_settings(State, State.font_height-2)
432 Text.redraw_all(State)
434 elseif chord == 'C-0' then
435 edit.update_font_settings(State, 20)
436 Text.redraw_all(State)
437 -- undo
438 elseif chord == 'C-z' then
439 for _,line_cache in ipairs(State.line_cache) do line_cache.starty = nil end -- just in case we scroll
440 local event = undo_event(State)
441 if event then
442 local src = event.before
443 State.screen_top1 = deepcopy(src.screen_top)
444 State.cursor1 = deepcopy(src.cursor)
445 State.selection1 = deepcopy(src.selection)
446 patch(State.lines, event.after, event.before)
447 patch_placeholders(State.line_cache, event.after, event.before)
448 -- invalidate various cached bits of lines
449 State.lines.current_drawing = nil
450 -- if we're scrolling, reclaim all fragments to avoid memory leaks
451 Text.redraw_all(State)
452 schedule_save(State)
454 elseif chord == 'C-y' then
455 for _,line_cache in ipairs(State.line_cache) do line_cache.starty = nil end -- just in case we scroll
456 local event = redo_event(State)
457 if event then
458 local src = event.after
459 State.screen_top1 = deepcopy(src.screen_top)
460 State.cursor1 = deepcopy(src.cursor)
461 State.selection1 = deepcopy(src.selection)
462 patch(State.lines, event.before, event.after)
463 -- invalidate various cached bits of lines
464 State.lines.current_drawing = nil
465 -- if we're scrolling, reclaim all fragments to avoid memory leaks
466 Text.redraw_all(State)
467 schedule_save(State)
469 -- clipboard
470 elseif chord == 'C-a' then
471 State.selection1 = {line=1, pos=1}
472 State.cursor1 = {line=#State.lines, pos=utf8.len(State.lines[#State.lines].data)+1}
473 elseif chord == 'C-c' then
474 local s = Text.selection(State)
475 if s then
476 App.set_clipboard(s)
478 elseif chord == 'C-x' then
479 for _,line_cache in ipairs(State.line_cache) do line_cache.starty = nil end -- just in case we scroll
480 local s = Text.cut_selection(State, State.left, State.right)
481 if s then
482 App.set_clipboard(s)
484 schedule_save(State)
485 elseif chord == 'C-v' then
486 for _,line_cache in ipairs(State.line_cache) do line_cache.starty = nil end -- just in case we scroll
487 -- We don't have a good sense of when to scroll, so we'll be conservative
488 -- and sometimes scroll when we didn't quite need to.
489 local before_line = State.cursor1.line
490 local before = snapshot(State, before_line)
491 local clipboard_data = App.get_clipboard()
492 for _,code in utf8.codes(clipboard_data) do
493 local c = utf8.char(code)
494 if c == '\n' then
495 Text.insert_return(State)
496 else
497 Text.insert_at_cursor(State, c)
500 if Text.cursor_out_of_screen(State) then
501 Text.snap_cursor_to_bottom_of_screen(State, State.left, State.right)
503 schedule_save(State)
504 record_undo_event(State, {before=before, after=snapshot(State, before_line, State.cursor1.line)})
505 -- dispatch to drawing or text
506 elseif App.mouse_down(1) or chord:sub(1,2) == 'C-' then
507 -- DON'T reset line_cache.starty here
508 local drawing_index, drawing = Drawing.current_drawing(State)
509 if drawing_index then
510 local before = snapshot(State, drawing_index)
511 Drawing.keychord_press(State, chord)
512 record_undo_event(State, {before=before, after=snapshot(State, drawing_index)})
513 schedule_save(State)
515 elseif chord == 'escape' and not App.mouse_down(1) then
516 for _,line in ipairs(State.lines) do
517 if line.mode == 'drawing' then
518 line.show_help = false
521 elseif State.lines.current_drawing and State.current_drawing_mode == 'name' then
522 if chord == 'return' then
523 State.current_drawing_mode = State.previous_drawing_mode
524 State.previous_drawing_mode = nil
525 else
526 local before = snapshot(State, State.lines.current_drawing_index)
527 local drawing = State.lines.current_drawing
528 local p = drawing.points[drawing.pending.target_point]
529 if chord == 'escape' then
530 p.name = nil
531 record_undo_event(State, {before=before, after=snapshot(State, State.lines.current_drawing_index)})
532 elseif chord == 'backspace' then
533 local len = utf8.len(p.name)
534 if len > 0 then
535 local byte_offset = Text.offset(p.name, len-1)
536 if len == 1 then byte_offset = 0 end
537 p.name = string.sub(p.name, 1, byte_offset)
538 record_undo_event(State, {before=before, after=snapshot(State, State.lines.current_drawing_index)})
542 schedule_save(State)
543 else
544 for _,line_cache in ipairs(State.line_cache) do line_cache.starty = nil end -- just in case we scroll
545 Text.keychord_press(State, chord)
549 function edit.key_release(State, key, scancode)
552 function edit.update_font_settings(State, font_height)
553 State.font_height = font_height
554 love.graphics.setFont(love.graphics.newFont(State.font_height))
555 State.line_height = math.floor(font_height*1.3)
558 --== some methods for tests
560 -- Insulate tests from some key globals so I don't have to change the vast
561 -- majority of tests when they're modified for the real app.
562 Test_margin_left = 25
563 Test_margin_right = 0
565 function edit.initialize_test_state()
566 -- if you change these values, tests will start failing
567 return edit.initialize_state(
568 15, -- top margin
569 Test_margin_left,
570 App.screen.width - Test_margin_right,
571 14, -- font height assuming default LÖVE font
572 15) -- line height
575 -- all text_input events are also keypresses
576 -- TODO: handle chords of multiple keys
577 function edit.run_after_text_input(State, t)
578 edit.keychord_press(State, t)
579 edit.text_input(State, t)
580 edit.key_release(State, t)
581 App.screen.contents = {}
582 edit.update(State, 0)
583 edit.draw(State)
586 -- not all keys are text_input
587 function edit.run_after_keychord(State, chord)
588 edit.keychord_press(State, chord)
589 edit.key_release(State, chord)
590 App.screen.contents = {}
591 edit.update(State, 0)
592 edit.draw(State)
595 function edit.run_after_mouse_click(State, x,y, mouse_button)
596 App.fake_mouse_press(x,y, mouse_button)
597 edit.mouse_press(State, x,y, mouse_button)
598 App.fake_mouse_release(x,y, mouse_button)
599 edit.mouse_release(State, x,y, mouse_button)
600 App.screen.contents = {}
601 edit.update(State, 0)
602 edit.draw(State)
605 function edit.run_after_mouse_press(State, x,y, mouse_button)
606 App.fake_mouse_press(x,y, mouse_button)
607 edit.mouse_press(State, x,y, mouse_button)
608 App.screen.contents = {}
609 edit.update(State, 0)
610 edit.draw(State)
613 function edit.run_after_mouse_release(State, x,y, mouse_button)
614 App.fake_mouse_release(x,y, mouse_button)
615 edit.mouse_release(State, x,y, mouse_button)
616 App.screen.contents = {}
617 edit.update(State, 0)
618 edit.draw(State)