# Armaan Bhojwani 2021
import curses
+import curses.panel
+import os
from random import shuffle
import sys
import textwrap
+import time
+
+from . import runner, progress, parse
+
+
+def panel_create(x, y):
+ """Create popup panels to a certain scale"""
+ win = curses.newwin(x, y)
+ panel = curses.panel.new_panel(win)
+ win.erase()
+ return (win, panel)
+
+
+class CursesError(BaseException):
+ def __init__(self, message="lightcards: Curses error!"):
+ self.message = message
+ print(self.message)
+ sys.exit(3)
+
+
+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["confirm_quit"]:
+ 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 Lightcards. Here are some keybindings",
+ "to get you started:",
+ "",
+ 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`.",
+ "",
+ f"Press {c('help_disp')} to go back.",
+ ]
+
+ self.win.addstr(
+ 1,
+ int(mcols / 2) - 8,
+ "LIGHTCARDS HELP",
+ curses.color_pair(1) + curses.A_BOLD,
+ )
+ self.win.hline(2, 1, curses.ACS_HLINE, mcols)
+
+ for t in enumerate(text):
+ self.win.addstr(t[0] + 3, 1, t[1])
+
+ self.win.box()
+
+ def disp(self):
+ """Display help screen"""
+ (mlines, mcols) = self.outer.win.getmaxyx()
+ self.win.mvwin(int(mlines / 2) - 12, int(mcols / 2) - 25)
+ self.panel.show()
+
+ while True:
+ key = self.win.getkey()
+ if key in self.outer.config["quit_key"]:
+ self.outer.leave()
+ elif key in self.outer.config["help_disp"]:
+ self.panel.hide()
+ self.outer.get_key()
+
+
+class Menu(Panel):
+ def __init__(self, outer, mlines=17, mcols=44):
+ """Initialize the menu with content"""
+ super().__init__(outer, mlines, mcols)
+ c = self.config_get
+
+ self.win.addstr(
+ 1,
+ int(mcols / 2) - 8,
+ "LIGHTCARDS MENU",
+ curses.color_pair(1) + curses.A_BOLD,
+ )
+ self.win.hline(2, 1, curses.ACS_HLINE, mcols)
+ env = os.environ.get("EDITOR", "$EDITOR")[:15]
+ text = [
+ 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}",
+ "",
+ 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])
+
+ 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:
+ color = curses.color_pair(2)
+ else:
+ color = curses.color_pair(1)
+
+ self.win.addstr(15, 1, string, color)
+ self.menu_grab()
+
+ def menu_grab(self):
+ """Grab keypresses on the menu screen"""
+ while True:
+ key = self.win.getkey()
+ if (
+ key
+ in self.outer.config["menu_disp"]
+ + self.outer.config["menu_restart"]
+ ):
+ self.panel.hide()
+ self.outer.get_key()
+ elif key in self.outer.config["quit_key"]:
+ self.outer.leave()
+ elif key in self.outer.config["menu_reset"]:
+ self.outer.stack = runner.get_orig()[1]
+ self.menu_print("Stack reset!")
+ elif key in self.outer.config["menu_alphabetize"]:
+ self.outer.stack.sort(key=lambda x: x.front)
+ self.menu_print("Stack alphabetized!")
+ elif key in self.outer.config["menu_unstar"]:
+ [x.unStar() for x in self.outer.stack]
+ self.menu_print("All unstarred!")
+ elif key in self.outer.config["menu_star"]:
+ [x.star() for x in self.outer.stack]
+ self.menu_print("All starred!")
+ elif key in self.outer.config["menu_reverse"]:
+ self.outer.stack.reverse()
+ self.menu_print("Stack reversed!")
+ elif key in self.outer.config["menu_shuffle"]:
+ shuffle(self.outer.stack)
+ self.menu_print("Stack shuffled!")
+ elif key in self.outer.config["menu_open_file"]:
+ progress.dump(self.outer.stack, runner.get_orig()[1])
+ 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)
+ )
+ self.outer.get_key()
+ 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
+ for x in self.outer.stack:
+ if x.starred:
+ cont = True
+ break
+
+ if cont:
+ self.outer.stack = [
+ x for x in self.outer.stack if x.starred
+ ]
+ self.menu_print("Stars only!")
+ else:
+ self.menu_print("ERR: None are starred!", err=True)
+ elif key in self.outer.config["menu_restart"]:
+ self.outer.obj.index = 0
+ self.outer.get_key()
+
+ def disp(self):
+ """
+ Display a menu offering multiple options on how to manipulate the deck
+ and to continue
+ """
+ self.clear_msg()
+
+ (mlines, mcols) = self.outer.win.getmaxyx()
+ self.win.mvwin(int(mlines / 2) - 8, int(mcols / 2) - 22)
+ self.panel.show()
-from . import lightcards, progress
+ self.menu_grab()
-class Display():
- def __init__(self, stack, headers, obj):
+class Display:
+ def __init__(self, stack, headers, obj, view, args, conf):
self.stack = stack
self.headers = headers
self.obj = obj
+ self.view = view
+ self.input_file = args.inp[0]
+ self.config = conf
def run(self, stdscr):
+ """Set important options that require stdscr before starting"""
self.win = stdscr
curses.curs_set(0) # Hide cursor
- curses.init_pair(1, curses.COLOR_CYAN, 0)
- curses.init_pair(2, curses.COLOR_RED, 0)
- curses.init_pair(3, curses.COLOR_YELLOW, 0)
+ curses.use_default_colors() # Allow transparency
+ 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()
+ def check_size(self):
+ (mlines, mcols) = self.win.getmaxyx()
+
+ while mlines < 24 or mcols < 60:
+ self.win.clear()
+ self.win.addstr(
+ 0,
+ 0,
+ textwrap.fill(
+ "Terminal too small! Min size 60x24", width=mcols
+ ),
+ )
+ self.win.refresh()
+ (mlines, mcols) = self.win.getmaxyx()
+ time.sleep(0.1)
+ else:
+ self.disp_card()
+
def leave(self):
- if self.obj.getIdx() == len(self.stack):
- self.obj.setIdx(0)
+ """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.obj, self.stack, self.headers), self.stack)
+ progress.dump(self.stack, runner.get_orig()[1])
sys.exit(0)
- def ntotal(self):
- """Get toal number of starred cards"""
- return(len([card for card in self.stack if card.getStar()]))
+ def nstarred(self):
+ """Get total number of starred cards"""
+ return [card for card in self.stack if card.starred]
def disp_bar(self):
"""
status, and card side.
"""
(mlines, mcols) = self.win.getmaxyx()
+ self.win.hline(mlines - 3, 0, 0, mcols)
# Calculate percent done
if len(self.stack) <= 1:
percent = "100"
else:
- percent = str(round(self.obj.getIdx() /
- len(self.stack) * 100)).zfill(2)
+ percent = str(
+ round(self.obj.index / (len(self.stack) - 1) * 100)
+ ).zfill(2)
# Print yellow if starred
- if self.stack[self.obj.getIdx()].getStar():
+ if self.current_card().starred:
star_color = curses.color_pair(3)
else:
star_color = curses.color_pair(1)
- # Create bar component
+ # Compose bar text
bar_start = "["
- bar_middle = self.stack[self.obj.getIdx()].printStar()
- bar_end = f"] [{self.ntotal()}/{str(len(self.stack))} starred] " + \
- f"[{percent}% (" + \
- str(self.obj.getIdx() + 1).zfill(len(str(len(self.stack)))) + \
- f"/{str(len(self.stack))})] [" + \
- f"{self.headers[self.obj.getSide()]} (" + \
- f"{str(self.obj.getSide() + 1)})] "
+ bar_middle = self.current_card().printStar()
+ bar_end = f"] [{len(self.nstarred())}/{str(len(self.stack))} starred] "
+ if self.view != 3:
+ bar_end += (
+ f" [{self.get_side()} ("
+ f"{str(int(self.current_card().side) + 1)})]"
+ )
+ bar_end += f" [View {str(self.view)}]"
# Put it all togethor
- self.win.hline(mlines - 2, 0, 0, mcols)
- self.win.addstr(mlines - 1, 0, bar_start, curses.color_pair(1))
- self.win.addstr(bar_middle, star_color)
- self.win.insstr(bar_end, curses.color_pair(1))
-
- def menu_print(self, string, err=False):
- self.win.clear()
- if err:
- color = curses.color_pair(2)
- else:
- color = curses.color_pair(1)
- self.disp_menu(keygrab=False)
- self.win.addstr("\n\n" + string, color)
- self.menu_grab()
-
- def menu_grab(self):
- while True:
- key = self.win.getkey()
- if key == "q":
- if len(self.stack) == self.obj.getIdx():
- self.leave()
- elif len(self.stack) < self.obj.getIdx():
- self.obj.setIdx(0)
- self.get_key()
- elif key == "y":
- self.stack = lightcards.get_orig()[1]
- self.menu_print("Stack reset!")
- elif key == "u":
- [x.unStar() for x in self.stack]
- self.menu_print("All unstarred!")
- elif key == "d":
- [x.star() for x in self.stack]
- self.menu_print("All starred!")
- elif key == "t":
- self.stack.reverse()
- self.menu_print(
- "self.stack reversed!")
- elif key == "z":
- shuffle(self.stack)
- self.menu_print("Stack shuffled!")
- elif key == "f":
- for x in self.stack:
- x[0], x[1] = x[1], x[0]
- (self.headers[0], self.headers[1]) = (self.headers[1],
- self.headers[0])
- self.menu_print("Cards flipped!")
- elif key == "s":
- # Check if there are any starred cards before proceeding, and
- # if not, don't allow to proceed and show an error message
- cont = False
- for x in self.stack:
- if x.getStar():
- cont = True
- break
-
- if cont:
- self.stack = [x for x in self.stack if x.getStar()]
- self.menu_print("Stars only!")
- else:
- self.menu_print("ERR: None are starred!", err=True)
- elif key in ["h", "KEY_LEFT"]:
- self.obj.setIdx(len(self.stack) - 1)
- self.get_key()
- elif key == "r":
- self.obj.setIdx(0)
- self.get_key()
-
- def disp_menu(self, keygrab=True, quit=False):
- """
- Display a menu once the end of the deck has been reached, offering
- multiple options on how to continue.
- """
-
- quit_text = "[q]: back"
- if quit:
- quit_text = "[q]: quit"
-
- self.win.addstr("LIGHTCARDS MENU", curses.color_pair(1) +
- curses.A_BOLD)
- self.win.hline(1, 0, curses.ACS_HLINE, 15)
- self.win.addstr(2, 0, "[y]: reset stack to original state\n" +
- "[z]: shuffle stack\n" +
- "[f]: flip all cards in stack\n" +
- "[t]: reverse stack order\n" +
- "[u]: unstar all\n" +
- "[d]: star all\n" +
- "[s]: update stack to include starred only\n\n" +
- "[r]: restart\n" +
- quit_text)
-
- if keygrab:
- self.menu_grab()
+ height = mlines - 2
+ self.win.addstr(height, 0, bar_start, curses.color_pair(1))
+ self.win.addstr(height, len(bar_start), bar_middle, star_color)
+ self.win.addstr(
+ height,
+ len(bar_start + bar_middle),
+ textwrap.shorten(bar_end, width=mcols - 20, placeholder="…"),
+ curses.color_pair(1),
+ )
+
+ progress = (
+ f"[{percent}% ("
+ f"{str(self.obj.index + 1).zfill(len(str(len(self.stack))))}"
+ f"/{str(len(self.stack))})] "
+ )
+
+ self.win.addstr(
+ height + 1,
+ 0,
+ progress,
+ curses.color_pair(1),
+ )
+
+ for i in range(
+ int(
+ self.obj.index
+ / (len(self.stack) - 1)
+ * (mcols - len(progress))
+ - 1
+ )
+ ):
+ self.win.addch(
+ height + 1,
+ i + len(progress),
+ self.config["progress_char"],
+ curses.color_pair(1),
+ )
def wrap_width(self):
+ """Calculate the width at which the body text should wrap"""
(_, mcols) = self.win.getmaxyx()
wrap_width = mcols - 20
if wrap_width > 80:
wrap_width = 80
return wrap_width
+ def get_side(self):
+ if self.obj.side == 0:
+ return self.headers[self.current_card().side]
+ else:
+ return self.headers[self.current_card().get_reverse()]
+
def disp_card(self):
- """
- Display the contents of the card
- Shows a header, a horizontal line, and the contents of the current
- side.
- """
- self.win.clear()
(_, mcols) = self.win.getmaxyx()
- if self.obj.getIdx() == len(self.stack):
- self.disp_menu(quit=True)
- else:
+ self.main_panel.bottom()
+ self.win.clear()
+ num_done = str(self.obj.index + 1).zfill(len(str(len(self.stack))))
+
+ if self.view in [1, 2, 4]:
+ """
+ Display the contents of the card.
+ Shows a header, a horizontal line, and the contents of the current
+ side.
+ """
# If on the back of the card, show the content of the front side in
# the header
- num_done = str(self.obj.getIdx() +
- 1).zfill(len(str(len(self.stack))))
- if self.obj.getSide() == 0:
- top = num_done + " | " + self.headers[self.obj.getSide()]
- else:
- top = num_done + " | " + self.headers[self.obj.getSide()] + \
- " | \"" + str(self.stack[self.obj.getIdx()][0]) + "\""
- header_width = mcols
- if mcols > 80:
- header_width = 80
+ if self.view == 1:
+ self.obj.side = 0
+ elif self.view == 2:
+ self.obj.side = 1
- self.win.addstr(textwrap.shorten(top, width=header_width,
- placeholder="…"), curses.A_BOLD)
-
- # Add horizontal line
- lin_width = header_width
- if len(top) < header_width:
- lin_width = len(top)
- self.win.hline(1, 0, curses.ACS_HLINE, lin_width)
+ if self.current_card().side == 0:
+ top = num_done + " | " + self.get_side()
+ else:
+ top = (
+ num_done
+ + " | "
+ + self.get_side()
+ + ' | "'
+ + str(self.current_card().get()[self.obj.get_reverse()])
+ + '"'
+ )
+
+ self.win.addstr(
+ 0,
+ 0,
+ textwrap.shorten(top, width=mcols - 20, placeholder="…"),
+ curses.A_BOLD,
+ )
# Show current side
- self.win.addstr(2, 0, textwrap.fill(
- self.stack[self.obj.getIdx()][self.obj.getSide()],
- width=self.wrap_width()))
+ self.win.addstr(
+ 2,
+ 0,
+ textwrap.fill(
+ self.current_card().get()[self.obj.side],
+ width=self.wrap_width(),
+ ),
+ )
+
+ elif self.view == 3:
+ """
+ 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,
+ textwrap.shorten(
+ num_done,
+ width=mcols - 20,
+ placeholder="…",
+ ),
+ curses.A_BOLD,
+ )
+
+ # Show card content
+ self.win.addstr(
+ 2,
+ 0,
+ textwrap.fill(
+ self.headers[0] + ": " + self.current_card().front,
+ width=self.wrap_width(),
+ )
+ + "\n\n"
+ + textwrap.fill(
+ self.headers[1] + ": " + self.current_card().back,
+ width=self.wrap_width(),
+ ),
+ )
+
+ self.win.hline(1, 0, curses.ACS_HLINE, mcols)
self.disp_bar()
self.disp_sidebar()
- def disp_help(self):
- """Display help screen"""
- self.win.clear()
- self.win.addstr("LIGHTCARDS HELP", curses.color_pair(1) +
- curses.A_BOLD)
- self.win.hline(1, 0, curses.ACS_HLINE, 15)
- self.win.addstr(2, 0, textwrap.fill(
- "Welcome to lightcards. Here are some keybindings to get you " +
- "started:", width=self.wrap_width()) +
- "\n\nh, left previous card\n" +
- "l, right next card\n" +
- "j, k, up, down flip card\n" +
- "i, / star card\n" +
- "0, ^, home go to the start of the deck\n" +
- "$, end go to the end of the deck\n" +
- "H, ? open this screen\n" +
- "e open the input file in $EDITOR\n" +
- "m open the control menu\n\n" +
- textwrap.fill(
- "More information can be found in the man page, " +
- "or by running `lightcards --help`.",
- width=self.wrap_width()) +
- "\n\nPress [q], [H], or [?] to go back.")
- while True:
- key = self.win.getkey()
- if key in ["q", "H", "?"]:
- self.get_key()
+ def current_card(self):
+ """Get current card object"""
+ return self.stack[self.obj.index]
def get_key(self):
"""
Display a card and wait for the input.
Used as a general way of getting back into the card flow from a menu
"""
-
- self.disp_card()
while True:
+ self.check_size()
key = self.win.getkey()
- if key == "q":
+ if key in self.config["quit_key"]:
self.leave()
- elif key in ["l", "KEY_RIGHT"]:
- self.obj.forward(self.stack)
- self.obj.setSide(0)
- self.disp_card()
- elif key in ["h", "KEY_LEFT"]:
+ elif key in self.config["card_prev"]:
self.obj.back()
- self.obj.setSide(0)
+ self.current_card().side = 0
self.disp_card()
- elif key in ["j", "k", "KEY_UP", "KEY_DOWN"]:
- self.obj.flip()
+ elif key in self.config["card_next"]:
+ if self.obj.index + 1 == len(self.stack):
+ 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 self.config["card_flip"] and self.view != 3:
+ self.current_card().flip()
self.disp_card()
- elif key in ["i", "/"]:
- self.stack[self.obj.getIdx()].toggleStar()
+ elif key in self.config["card_star"]:
+ self.current_card().toggleStar()
self.disp_card()
- elif key in ["0", "^", "KEY_HOME"]:
- self.obj.setIdx(0)
- self.obj.setSide(0)
+ elif key in self.config["card_first"]:
+ self.obj.index = 0
+ self.current_card().side = 0
self.disp_card()
- elif key in ["$", "KEY_END"]:
- self.obj.setIdx(len(self.stack) - 1)
- self.obj.setSide(0)
+ 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", "?"]:
- self.disp_help()
- elif key == "m":
- self.win.clear()
- self.disp_menu()
- elif key == "e":
- (self.headers, self.stack) = lightcards.reparse()
- self.get_key()
+ elif key in self.config["help_disp"]:
+ self.help_obj.disp()
+ elif key in self.config["menu_disp"]:
+ self.menu_obj.disp()
+ 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"""
(mlines, mcols) = self.win.getmaxyx()
left = mcols - 19
- self.win.addstr(0, mcols - 16, "STARRED CARDS",
- curses.color_pair(3) + curses.A_BOLD)
- self.win.vline(0, mcols - 20, 0, mlines - 2)
- self.win.hline(1, left, 0, mlines)
+ self.win.addstr(
+ 0,
+ mcols - 16,
+ "STARRED CARDS",
+ curses.color_pair(3) + curses.A_BOLD,
+ )
+ self.win.vline(0, mcols - 20, 0, mlines - 3)
+
+ nstarred = self.nstarred()
+ for i, card in enumerate(nstarred):
+ term = card.get()[self.obj.side]
+ if len(term) > 18:
+ term = term[:18] + "…"
- i = 0
- for card in self.stack:
if i > mlines - 6:
- self.win.addstr(2 + i, left, f"... ({self.ntotal() - i} more)")
- break
- elif card.getStar():
- term = card[0]
- if len(card[0]) > 18:
- term = card[0][:18] + "…"
+ for i in range(19):
+ self.win.addch(mlines - 3, left + i, " ")
+
+ self.win.addstr(
+ mlines - 4,
+ left,
+ f"({len(nstarred) - i - 2} more)",
+ )
+ else:
self.win.addstr(2 + i, left, term)
- i += 1
-
- if i == 0:
+ if len(self.nstarred()) == 0:
self.win.addstr(2, left, "None starred")
-
projects / lightcards.git / blobdiff