akkartik
/
lines.love
1
0
Fork 0
Code Issues 1 Pull Requests Releases Activity
An editor for plain text where you can also seamlessly insert line drawings http://akkartik.name/lines.html
962 Commits 1 Branch 0 Tags 1.5 MiB
Lua 100%
Go to file
Kartik K. Agaram 57fb2d4b57 clean up test mocks before aborting 
Scenario:
  modify a test to fail in the source editor
  delete any settings in the 'config' file in the save dir
  start lines.love
  press C-e to switch to source editor

Before this commit, this scenario led to the following events:
  the C-e keypress invokes App.run_tests_and_initialize()
  the failing test results in a call to error()
  the call to error() is trapped by the xpcall around the event handler in love.run
  handle_error runs
  Current_app is 'source', so love.event.quit() is triggered
  love.quit() is invoked
  source.settings() is invoked
  App.screen.position() is invoked, which calls the test mock
  Since App.screen.move was never invoked, App.screen.position() returns nil
  The 'config' file is written without values for source.x and source.y

As a result, future runs fail to open.

This is likely a corner case only I will ever run into, since I'm
careful to never commit failing unit tests. Still, I spent some time
trying to figure out the best place to fix this. Options:
* don't write config if Error_message is set
  but we do want config written in this scenario:
  * we hit an error, source editor opens
  * we spend some time debugging and don't immediately fix the issue
  * we quit, with some new files opened in various places
* hardcode source.settings() to call love.window.getPosition() rather
  than App.screen.position().
  drawback: weird special case
* clean up test mocks before aborting
  this seems like something we always want

I'm not very sure of my choice.
This bug doesn't leave me feeling very great about my whole app.
Arguably everything I've done is bullshit hacks piled on hacks.

Perhaps the issue is:
  - naked error() in LÖVE apps never invokes love.quit(), but
  - an unhandled error within my handle_error invokes love.quit() (via
    love.event.quit)
Perhaps LÖVE should provide a way to abort without invoking the quit
handler. There's literally no other way in LÖVE to request a quit.
 		2024-01-12 03:22:43 -08:00
LICENSE.txt add a license 2022-05-16 18:51:28 -07:00
Manual_tests.md minor tweaks to manual tests while pushing to all forks 2023-12-07 01:06:19 -08:00
MemoryReferenceInfo.lua.0 remove some memory leaks from rendered fragments 2022-06-10 11:16:41 -07:00
MemoryReferenceInfo.lua.unused clean up memory leak experiments 2022-06-10 13:46:59 -07:00
README.md Revert "deemphasize the source editor" 2023-09-10 21:45:59 -07:00
app.lua clean up test mocks before aborting 2024-01-12 03:22:43 -08:00
button.lua bugfix :( 2023-12-18 21:39:01 -08:00
colorize.lua stop highlighting strings in code 2023-06-17 10:41:50 -07:00
commands.lua audit all asserts 2023-11-18 11:32:01 -08:00
drawing.lua audit all asserts 2023-11-18 11:32:01 -08:00
drawing_tests.lua bugfix: naming points 2023-03-26 09:36:41 -07:00
edit.lua bugfix 2023-12-29 11:52:28 -08:00
file.lua audit all asserts 2023-11-18 11:32:01 -08:00
geom.lua audit all asserts 2023-11-18 11:32:01 -08:00
help.lua get rid of to_text 2023-04-01 16:12:55 -07:00
icons.lua switch source side to new screen-line-based render 2023-04-03 08:33:07 -07:00
json.lua forgot to add json.lua 2022-05-15 14:36:25 -07:00
keychord.lua support for num pad 2023-07-07 18:40:12 -07:00
log.lua change section delimiters in log for OpenBSD 2023-10-20 15:53:03 -07:00
log_browser.lua bugfix 2023-12-29 11:52:28 -08:00
main.lua copy correct warning message 2023-12-07 01:08:09 -08:00
nativefs.lua cleaner API for file-system access 2023-08-30 19:04:06 -07:00
reference.md bugfix 2023-12-29 11:52:28 -08:00
run.lua bugfix 2023-12-29 11:52:28 -08:00
run_tests.lua deduce test names on failures 2023-01-20 21:48:49 -08:00
search.lua audit all asserts 2023-11-18 11:32:01 -08:00
select.lua manually maintain mouse button press state 2023-12-01 21:56:35 -08:00
source.lua moar bugfix X-( 2023-12-29 12:02:45 -08:00
source_edit.lua moar bugfix X-( 2023-12-29 12:02:45 -08:00
source_file.lua audit all asserts 2023-11-18 11:32:01 -08:00
source_select.lua mouse button state in source editor 2023-12-01 22:07:24 -08:00
source_tests.lua bugfix: Windows pushing title bar off screen 2023-07-10 17:09:09 -07:00
source_text.lua bugfix: utf-8 2023-12-26 11:19:23 -08:00
source_text_tests.lua streamline button.lua 2023-12-16 23:41:10 -08:00
source_undo.lua audit all asserts 2023-11-18 11:32:01 -08:00
test.lua show another detail on test failure 2023-01-20 21:48:49 -08:00
text.lua bugfix: utf-8 2023-12-26 11:19:23 -08:00
text_tests bugfix: clear selection when clicking above or below lines 2023-09-20 13:39:29 -07:00
text_tests.lua streamline button.lua 2023-12-16 23:41:10 -08:00
undo.lua fix a couple of asserts missed in the recent audit 2023-12-09 09:22:45 -08:00

README.md

Plain text with lines

An editor for plain text where you can also seamlessly insert line drawings. Designed above all to be easy to modify and give you early warning if your modifications break something.

http://akkartik.name/lines.html

Getting started

Install LÖVE. It's just a 5MB download, open-source and extremely well-behaved. I'll assume below that you can invoke it using the love command, but that might vary depending on your OS.

To run from the terminal, pass this directory to LÖVE, optionally with a file path to edit.

Alternatively, turn it into a .love file you can double-click on:

$ zip -r /tmp/lines.love *.lua

By default, lines.love reads/writes the file lines.txt in a directory relative to this app.

To open a different file, drop it on the lines.love window.

Keyboard shortcuts

While editing text:

  • ctrl+f to find patterns within a file
  • ctrl+c to copy, ctrl+x to cut, ctrl+v to paste
  • ctrl+z to undo, ctrl+y to redo
  • ctrl+= to zoom in, ctrl+- to zoom out, ctrl+0 to reset zoom
  • alt+right/alt+left to jump to the next/previous word, respectively
  • mouse drag or shift + movement to select text, ctrl+a to select all
  • ctrl+e to modify the sources

For shortcuts while editing drawings, consult the online help. Either:

  • hover on a drawing and hit ctrl+h, or
  • click on a drawing to start a stroke and then press and hold h to see your options at any point during a stroke.

lines.love has been exclusively tested so far with a US keyboard layout. If you use a different layout, please let me know if things worked, or if you found anything amiss: http://akkartik.name/contact

Known issues

  • No support yet for Unicode graphemes spanning multiple codepoints.

  • No support yet for right-to-left languages.

  • Undo/redo may be sluggish in large files. Large files may grow sluggish in other ways. lines.love works well in all circumstances with files under 50KB.

  • If you kill the process, say by force-quitting because things things get sluggish, you can lose data.

  • The text cursor will always stay on the screen. This can have some strange implications:

    • A long series of drawings will get silently skipped when you hit page-down, until a line of text can be showed on screen.
    • If there's no line of text at the top of the file, you may not be able to scroll back up to the top with page-up.

    So far this app isn't really designed for drawing-heavy files. For now I'm targeting mostly-text files with a few drawings mixed in.

  • No clipping yet for drawings. In particular, circles/squares/rectangles and point labels can overflow a drawing.

  • Touchpads can drag the mouse pointer using a light touch or a heavy click. On Linux, drags using the light touch get interrupted when a key is pressed. You'll have to press down to drag.

  • Can't scroll while selecting text with mouse.

  • No scrollbars yet. That stuff is hard.

Mirrors and Forks

Updates to lines.love can be downloaded from the following mirrors in addition to the website above:

Forks of lines.love are encouraged. If you show me your fork, I'll link to it here.

Associated tools

Feedback

Most appreciated.