betterSIS Text Editor Code Documentation

BETTERSIS.TEXTEDITOR: A simple text editor for betterSIS.

Features:

• edit (and save) files

• syntax highlighting

Note

This code was inspired by the prompt_toolkit example: https://github.com/prompt-toolkit/python-prompt-toolkit/blob/7fdd81597597a7a2f47655238b7f0cb3ea637091/examples/full-screen/text-editor.py # noqa: E501

class bettersis.texteditor.SimpleTextEditor(t_file)

Opens the <t_file> file with the a simple CLI text editor.

Parameters:

t_file (str) – file to open with the text editor

get_statusbar_right_text()

Shows the cursor position on the bottom right of the screen.

Return str:

string with cursor position

get_statusbar_text()

Shows control hotkeys.

If the user saved the file with Ctrl-S show “Saved to file” instead.

Return str:

string with the control commands

class bettersis.texteditor.SisLexer

Defines a lexer for the text editor.

lex_document(document)

Reads document to parse each line.

Parameters:

document – document to parse

Return function get_line:

function that parses lines