sys.exit(3)
-class Help:
- def __init__(self, outer, mlines=20, mcols=52):
- """Initialize help screen"""
+class Quit:
+ def __init__(self, outer, mlines=5, mcols=20):
+ self.outer = outer
+ (self.win, self.panel) = panel_create(mlines, mcols)
+ self.panel.top()
+ self.panel.hide()
+
+ self.win.addstr(
+ 1,
+ 2,
+ "QUIT LIGHTCARDS?",
+ curses.color_pair(1) + curses.A_BOLD,
+ )
+ self.win.hline(2, 1, curses.ACS_HLINE, mcols)
+ self.win.addstr(3, 1, "Quit? [y/n]")
+
+ self.win.box()
+
+ def disp(self):
+ """Display quit confirmation screen"""
+ (mlines, mcols) = self.outer.win.getmaxyx()
+ self.win.mvwin(int(mlines / 2) - 3, int(mcols / 2) - 10)
+ self.panel.show()
+ if self.outer.config["quit_confirmation"]:
+ while True:
+ key = self.win.getkey()
+ if key == "y":
+ break
+ elif key == "n":
+ self.panel.hide()
+ self.outer.get_key()
+
+
+class Panel:
+ def __init__(self, outer, mlines, mcols):
self.outer = outer
(self.win, self.panel) = panel_create(mlines, mcols)
self.panel.top()
self.panel.hide()
+ def config_get(self, setting, cut=28):
+ return str(list(self.outer.config[setting][:cut])).replace("'", "")
+
+
+class Help(Panel):
+ def __init__(self, outer, mlines=23, mcols=52):
+ """Initialize help screen"""
+ super().__init__(outer, mlines, mcols)
+ c = self.config_get
+
text = [
- "Welcome to runner. Here are some keybindings",
+ "Welcome to Lightcards. Here are some keybindings",
"to get you started:",
"",
- "h, left previous card",
- "l, right next card",
- "j, k, up, down flip card",
- "i, / star card",
- "0, ^, home go to the start of the deck",
- "$, end go to the end of the deck",
- "H, ? open this screen",
- "m open the control menu",
- "1, 2, 3 switch views",
+ f"{c('card_prev')}: previous card",
+ f"{c('card_next')}: next card",
+ f"{c('card_flip')}: flip card",
+ f"{c('card_star')}: star card",
+ f"{c('card_first')}: go to first card",
+ f"{c('card_last')}: go to last card",
+ f"{c('help_disp')}: open this help menu",
+ f"{c('menu_disp')}: open the control menu",
+ f"{c('view_one')}: switch to view one",
+ f"{c('view_two')}: switch to view two",
+ f"{c('view_three')}: switch to view three",
+ f"{c('quit_key')}: quit",
"",
"More information can be found in the man page, or",
"by running `lightcards --help`.",
"",
- "Press [H], or [?] to go back.",
+ f"Press {c('help_disp')} to go back.",
]
self.win.addstr(
)
self.win.hline(2, 1, curses.ACS_HLINE, mcols)
- for t in enumerate(text):
- self.win.addstr(t[0] + 3, 1, t[1])
+ for i, content in enumerate(text, 3):
+ self.win.addstr(i, 1, content)
self.win.box()
def disp(self):
"""Display help screen"""
(mlines, mcols) = self.outer.win.getmaxyx()
- self.win.mvwin(int(mlines / 2) - 10, int(mcols / 2) - 25)
+ self.win.mvwin(int(mlines / 2) - 12, int(mcols / 2) - 25)
self.panel.show()
while True:
key = self.win.getkey()
- if key == "q":
+ if key in self.outer.config["quit_key"]:
self.outer.leave()
- elif key in ["H", "?"]:
+ elif key in self.outer.config["help_disp"]:
self.panel.hide()
self.outer.get_key()
-class Menu:
+class Menu(Panel):
def __init__(self, outer, mlines=17, mcols=44):
"""Initialize the menu with content"""
- self.outer = outer
- (self.win, self.panel) = panel_create(mlines, mcols)
- self.panel.top()
- self.panel.hide()
+ super().__init__(outer, mlines, mcols)
+ c = self.config_get
self.win.addstr(
1,
curses.color_pair(1) + curses.A_BOLD,
)
self.win.hline(2, 1, curses.ACS_HLINE, mcols)
+ env = os.environ.get("EDITOR", "$EDITOR")[:15]
text = [
- "[y]: reset stack to original state",
- "[a]: alphabetize stack",
- "[z]: shuffle stack",
- "[t]: reverse stack order",
- "[u]: unstar all",
- "[d]: star all",
- "[s]: update stack to include starred only",
- "[e]: open the input file in $EDITOR",
+ f"{c('menu_reset')}: reset stack to original state",
+ f"{c('menu_alphabetize')}: alphabetize stack",
+ f"{c('menu_shuffle')}: shuffle stack",
+ f"{c('menu_reverse')}: reverse stack order",
+ f"{c('menu_unstar')}: unstar all",
+ f"{c('menu_star')}: star all",
+ f"{c('menu_stars_only')}: update stack to include starred only",
+ f"{c('menu_open_file')}: open the input file in {env}",
"",
- "[r]: restart",
- "[m]: close menu",
+ f"{c('menu_restart')}: restart",
+ f"{c('menu_disp')}: close menu",
]
- for t in enumerate(text):
- self.win.addstr(t[0] + 3, 1, t[1])
+ for i, content in enumerate(text, 3):
+ self.win.addstr(i, 1, content)
self.win.box()
+ def clear_msg(self):
+ for i in range(42):
+ self.win.addch(15, i + 1, " ")
+
def menu_print(self, string, err=False):
"""Print messages on the menu screen"""
if err:
"""Grab keypresses on the menu screen"""
while True:
key = self.win.getkey()
- if key in ["r", "m"]:
+ if (
+ key
+ in self.outer.config["menu_disp"]
+ + self.outer.config["menu_restart"]
+ ):
self.panel.hide()
self.outer.get_key()
- elif key == "q":
+ elif key in self.outer.config["quit_key"]:
self.outer.leave()
- elif key == "y":
+ elif key in self.outer.config["menu_reset"]:
self.outer.stack = runner.get_orig()[1]
self.menu_print("Stack reset!")
- elif key == "a":
+ elif key in self.outer.config["menu_alphabetize"]:
self.outer.stack.sort(key=lambda x: x.front)
self.menu_print("Stack alphabetized!")
- elif key == "u":
+ elif key in self.outer.config["menu_unstar"]:
[x.unStar() for x in self.outer.stack]
self.menu_print("All unstarred!")
- elif key == "d":
+ elif key in self.outer.config["menu_star"]:
[x.star() for x in self.outer.stack]
self.menu_print("All starred!")
- elif key == "t":
+ elif key in self.outer.config["menu_reverse"]:
self.outer.stack.reverse()
self.menu_print("Stack reversed!")
- elif key == "z":
+ elif key in self.outer.config["menu_shuffle"]:
shuffle(self.outer.stack)
self.menu_print("Stack shuffled!")
- elif key == "e":
+ elif key in self.outer.config["menu_open_file"]:
curses.endwin()
os.system(f"$EDITOR {self.outer.input_file}"),
(self.outer.headers, self.outer.stack) = parse.parse_html(
- parse.md2html(self.outer.input_file)
+ parse.md2html(self.outer.input_file),
+ self.outer.args,
+ self.outer.config,
)
self.outer.get_key()
- elif key == "s":
+ elif key in self.outer.config["menu_stars_only"]:
# Check if there are any starred cards before proceeding, and
# if not, don't allow to proceed and show an error message
cont = False
self.menu_print("Stars only!")
else:
self.menu_print("ERR: None are starred!", err=True)
- elif key == "r":
+ elif key in self.outer.config["menu_restart"]:
self.outer.obj.index = 0
self.outer.get_key()
Display a menu offering multiple options on how to manipulate the deck
and to continue
"""
- for i in range(42):
- self.win.addch(14, i + 1, " ")
+ self.clear_msg()
(mlines, mcols) = self.outer.win.getmaxyx()
self.win.mvwin(int(mlines / 2) - 8, int(mcols / 2) - 22)
class Display:
- def __init__(self, stack, headers, obj, view, input_file):
+ def __init__(self, stack, headers, obj, view, args, conf):
self.stack = stack
self.headers = headers
self.obj = obj
self.view = view
- self.input_file = input_file
+ self.input_file = args.inp
+ self.config = conf
+ self.args = args
def run(self, stdscr):
"""Set important options that require stdscr before starting"""
self.win = stdscr
curses.curs_set(0) # Hide cursor
curses.use_default_colors() # Allow transparency
- curses.init_pair(1, curses.COLOR_CYAN, -1)
- curses.init_pair(2, curses.COLOR_RED, -1)
- curses.init_pair(3, curses.COLOR_YELLOW, -1)
+ curses.init_pair(1, self.config["highlight_color"], -1)
+ curses.init_pair(2, self.config["error_color"], -1)
+ curses.init_pair(3, self.config["starred_color"], -1)
self.main_panel = curses.panel.new_panel(self.win)
self.menu_obj = Menu(self)
self.help_obj = Help(self)
+ self.quit_obj = Quit(self)
self.get_key()
else:
self.disp_card()
+ def dump(self):
+ if self.config["cache"]:
+ progress.dump(self.stack, runner.get_orig()[1])
+
def leave(self):
- """Pickle stack before quitting"""
+ """Pickle stack and confirm before quitting"""
+ self.quit_obj.disp()
if self.obj.index + 1 == len(self.stack):
self.obj.index = 0
- progress.dump(self.stack, runner.get_orig()[1])
+ self.dump()
sys.exit(0)
def nstarred(self):
"""Get total number of starred cards"""
return [card for card in self.stack if card.starred]
- def disp_bar(self):
- """
- Display the statusbar at the bottom of the screen with progress, star
- status, and card side.
- """
+ def prep_bar(self):
(mlines, mcols) = self.win.getmaxyx()
- self.win.hline(mlines - 2, 0, 0, mcols)
# Calculate percent done
if len(self.stack) <= 1:
else:
percent = str(
round(self.obj.index / (len(self.stack) - 1) * 100)
- ).zfill(2)
+ ).zfill(3)
# Print yellow if starred
if self.current_card().starred:
- star_color = curses.color_pair(3)
+ self.star_color = curses.color_pair(3)
else:
- star_color = curses.color_pair(1)
+ self.star_color = curses.color_pair(1)
# Compose bar text
- bar_start = "["
- bar_middle = self.current_card().printStar()
- bar_end = (
+ self.bar_start = "["
+ self.bar_middle = self.current_card().printStar()
+ self.bar_end = (
f"] [{len(self.nstarred())}/{str(len(self.stack))} starred] "
- f"[{percent}% ("
- f"{str(self.obj.index).zfill(len(str(len(self.stack))))}"
- f"/{str(len(self.stack))})]"
)
if self.view != 3:
- bar_end += (
+ self.bar_end += (
f" [{self.get_side()} ("
f"{str(int(self.current_card().side) + 1)})]"
)
- bar_end += f" [View {str(self.view)}]"
+ self.bar_end += f" [View {str(self.view)}]"
+
+ self.progress = (
+ f"[{percent}% ("
+ f"{str(self.obj.index + 1).zfill(len(str(len(self.stack))))}"
+ f"/{str(len(self.stack))})] "
+ )
+ def disp_bar(self):
+ """
+ Display the statusbar at the bottom of the screen with progress, star
+ status, and card side.
+ """
# Put it all togethor
- self.win.addstr(mlines - 1, 0, bar_start, curses.color_pair(1))
- self.win.addstr(mlines - 1, len(bar_start), bar_middle, star_color)
+ (mlines, mcols) = self.win.getmaxyx()
+ height = mlines - 2
+ self.win.addstr(height, 0, self.bar_start, curses.color_pair(1))
self.win.addstr(
- mlines - 1,
- len(bar_start + bar_middle),
- textwrap.shorten(bar_end, width=mcols - 20, placeholder="…"),
+ height, len(self.bar_start), self.bar_middle, self.star_color
+ )
+ self.win.addstr(
+ height,
+ len(self.bar_start + self.bar_middle),
+ textwrap.shorten(self.bar_end, width=mcols - 20, placeholder="…"),
curses.color_pair(1),
)
+ self.win.addstr(
+ height + 1,
+ 0,
+ self.progress,
+ curses.color_pair(1),
+ )
+
+ for i in range(
+ int(
+ self.obj.index
+ / (len(self.stack) - 1)
+ * (mcols - len(self.progress))
+ - 1
+ )
+ ):
+ self.win.addch(
+ height + 1,
+ i + len(self.progress),
+ self.config["progress_char"],
+ curses.color_pair(1),
+ )
+
+ self.win.hline(mlines - 3, 0, 0, mcols)
+
def wrap_width(self):
"""Calculate the width at which the body text should wrap"""
(_, mcols) = self.win.getmaxyx()
def disp_card(self):
(_, mcols) = self.win.getmaxyx()
self.main_panel.bottom()
- self.win.clear()
+ self.prep_bar()
num_done = str(self.obj.index + 1).zfill(len(str(len(self.stack))))
if self.view in [1, 2, 4]:
+ '"'
)
+ self.win.clear()
self.win.addstr(
0,
0,
"""
Display the contents of the card with both the front and back sides.
"""
- (_, mcols) = self.win.getmaxyx()
- self.main_panel.bottom()
self.win.clear()
-
self.win.addstr(
0,
0,
)
self.win.hline(1, 0, curses.ACS_HLINE, mcols)
- self.disp_bar()
self.disp_sidebar()
+ self.disp_bar()
def current_card(self):
"""Get current card object"""
while True:
self.check_size()
key = self.win.getkey()
- if key == "q":
+ if key in self.config["quit_key"]:
self.leave()
- elif key in ["h", "KEY_LEFT"]:
+ elif key in self.config["card_prev"]:
self.obj.back()
self.current_card().side = 0
self.disp_card()
- elif key in ["l", "KEY_RIGHT"]:
+ elif key in self.config["card_next"]:
if self.obj.index + 1 == len(self.stack):
- self.menu_obj.disp()
+ if self.config["show_menu_at_end"]:
+ self.menu_obj.disp()
else:
self.obj.forward(self.stack)
self.current_card().side = 0
self.disp_card()
- elif key in ["j", "k", "KEY_UP", "KEY_DOWN"] and self.view != 3:
+ elif key in self.config["card_flip"] and self.view != 3:
self.current_card().flip()
self.disp_card()
- elif key in ["i", "/"]:
+ elif key in self.config["card_star"]:
self.current_card().toggleStar()
self.disp_card()
- elif key in ["0", "^", "KEY_HOME"]:
+ elif key in self.config["card_first"]:
self.obj.index = 0
self.current_card().side = 0
self.disp_card()
- elif key in ["$", "KEY_END"]:
+ elif key in self.config["card_last"]:
self.obj.index = len(self.stack) - 1
self.current_card().side = 0
self.disp_card()
- elif key in ["H", "?"]:
+ elif key in self.config["help_disp"]:
self.help_obj.disp()
- elif key == "m":
+ elif key in self.config["menu_disp"]:
self.menu_obj.disp()
- elif key in ["1", "2", "3", "4"]:
- self.view = int(key)
+ elif key in self.config["view_one"]:
+ self.view = 1
+ elif key in self.config["view_two"]:
+ self.view = 2
+ elif key in self.config["view_three"]:
+ self.view = 3
def disp_sidebar(self):
"""Display a sidebar with the starred terms"""
"STARRED CARDS",
curses.color_pair(3) + curses.A_BOLD,
)
- self.win.vline(0, mcols - 20, 0, mlines - 2)
+ self.win.vline(0, mcols - 20, 0, mlines - 3)
nstarred = self.nstarred()
for i, card in enumerate(nstarred):
- term = card.get()[self.obj.side]
+ term = card.get(smart=False)[0]
if len(term) > 18:
term = term[:18] + "…"
- if i > mlines - 5:
+ if i > mlines - 6:
for i in range(19):
- self.win.addch(mlines - 3, left + i, " ")
+ self.win.addch(mlines - 4, left + i, " ")
self.win.addstr(
- mlines - 3,
+ mlines - 4,
left,
f"({len(nstarred) - i - 2} more)",
)
projects / lightcards.git / blobdiff