1 # Display card output and retreive input
6 from random import shuffle
10 from . import runner, progress
13 def panel_create(x, y):
14 """Create popup panels to a certain scale"""
15 win = curses.newwin(x, y)
16 panel = curses.panel.new_panel(win)
22 def __init__(self, stack, headers, obj):
24 self.headers = headers
27 def run(self, stdscr):
28 """Set important options that require stdscr before starting"""
30 (mlines, mcols) = self.win.getmaxyx()
31 curses.curs_set(0) # Hide cursor
32 curses.use_default_colors() # Allow transparency
33 curses.init_pair(1, curses.COLOR_CYAN, -1)
34 curses.init_pair(2, curses.COLOR_RED, -1)
35 curses.init_pair(3, curses.COLOR_YELLOW, -1)
37 (self.main_win, self.main_panel) = panel_create(mlines, mcols)
44 """Update panel and window contents"""
45 curses.panel.update_panels()
49 """Pickle stack before quitting"""
50 if self.obj.getIdx() + 1 == len(self.stack):
53 progress.dump(self.stack, runner.get_orig()[1])
57 """Get total number of starred cards"""
58 return [card for card in self.stack if card.getStar()]
62 Display the statusbar at the bottom of the screen with progress, star
63 status, and card side.
65 (mlines, _) = self.win.getmaxyx()
67 # Calculate percent done
68 if len(self.stack) <= 1:
72 round(self.obj.getIdx() / (len(self.stack) - 1) * 100)
75 # Print yellow if starred
76 if self.current_card().getStar():
77 star_color = curses.color_pair(3)
79 star_color = curses.color_pair(1)
81 # Create bar component
83 bar_middle = self.current_card().printStar()
85 f"] [{len(self.nstarred())}/{str(len(self.stack))} starred] "
87 f"{str(self.obj.getIdx()).zfill(len(str(len(self.stack))))}"
88 f"/{str(len(self.stack))})] ["
89 f"{self.headers[self.current_card().getSide()]} ("
90 f"{str(int(self.current_card().getSide()) + 1)})]"
94 self.win.addstr(mlines - 1, 0, bar_start, curses.color_pair(1))
95 self.win.addstr(mlines - 1, len(bar_start), bar_middle, star_color)
98 len(bar_start + bar_middle),
100 curses.color_pair(1),
103 def menu_print(self, string, err=False):
104 """Print messages on the menu screen"""
106 color = curses.color_pair(2)
108 color = curses.color_pair(1)
111 self.menu_win.addch(15, i + 1, " ")
113 self.menu_win.addstr(15, 1, string, color)
118 """Grab keypresses on the menu screen"""
120 key = self.win.getkey()
121 if key in ["r", "m"]:
122 self.menu_panel.hide()
128 self.stack = runner.get_orig()[1]
129 self.menu_print("Stack reset!")
132 self.menu_print("Stack alphabetized!")
134 [x.unStar() for x in self.stack]
135 self.menu_print("All unstarred!")
137 [x.star() for x in self.stack]
138 self.menu_print("All starred!")
141 self.menu_print("Stack reversed!")
144 self.menu_print("Stack shuffled!")
147 x[0], x[1] = x[1], x[0]
148 (self.headers[0], self.headers[1]) = (
152 self.menu_print("Cards flipped!")
154 # Check if there are any starred cards before proceeding, and
155 # if not, don't allow to proceed and show an error message
163 self.stack = [x for x in self.stack if x.getStar()]
164 self.menu_print("Stars only!")
166 self.menu_print("ERR: None are starred!", err=True)
167 elif key in ["h", "KEY_LEFT"]:
168 self.obj.setIdx(len(self.stack) - 1)
175 """Initialize the menu with content"""
176 (self.menu_win, self.menu_panel) = panel_create(17, 44)
177 self.menu_panel.top()
178 self.menu_panel.hide()
180 self.menu_win.addstr(
181 1, 1, "LIGHTCARDS MENU", curses.color_pair(1) + curses.A_BOLD
183 self.menu_win.hline(2, 1, curses.ACS_HLINE, 15)
185 "[y]: reset stack to original state",
186 "[a]: alphabetize stack",
187 "[z]: shuffle stack",
188 "[f]: flip all cards in stack",
189 "[t]: reverse stack order",
192 "[s]: update stack to include starred only",
198 for t in enumerate(text):
199 self.menu_win.addstr(t[0] + 3, 1, t[1])
204 def disp_menu(self, keygrab=True):
206 Display a menu offering multiple options on how to manipulate the deck
209 (mlines, mcols) = self.win.getmaxyx()
210 self.menu_win.mvwin(int(mlines / 2) - 9, int(mcols / 2) - 22)
211 self.menu_panel.show()
217 def wrap_width(self):
218 """Calculate the width at which the body text should wrap"""
219 (_, mcols) = self.win.getmaxyx()
220 wrap_width = mcols - 20
227 Display the contents of the card.
228 Shows a header, a horizontal line, and the contents of the current
231 (mlines, mcols) = self.win.getmaxyx()
232 self.main_panel.bottom()
233 self.main_win.clear()
234 # If on the back of the card, show the content of the front side in
236 num_done = str(self.obj.getIdx() + 1).zfill(len(str(len(self.stack))))
237 if self.current_card().getSide() == 0:
239 num_done + " | " + self.headers[self.current_card().getSide()]
245 + self.headers[self.current_card().getSide()]
247 + str(self.current_card().getFront())
254 self.main_win.addstr(
257 textwrap.shorten(top, width=header_width, placeholder="…"),
261 # Add horizontal line
262 lin_width = header_width
263 if len(top) < header_width:
265 self.main_win.hline(1, 0, curses.ACS_HLINE, lin_width)
268 self.main_win.addstr(
272 self.current_card().get(),
273 width=self.wrap_width(),
279 self.win.hline(mlines - 2, 0, 0, mcols)
282 """Initialize help screen"""
283 (self.help_win, self.help_panel) = panel_create(20, 52)
284 self.help_panel.top()
285 self.help_panel.hide()
286 self.help_win.clear()
287 self.help_win.addstr(
288 1, 1, "LIGHTCARDS HELP", curses.color_pair(1) + curses.A_BOLD
290 self.help_win.hline(2, 1, curses.ACS_HLINE, 15)
292 "Welcome to runner. Here are some keybindings",
293 "to get you started:",
295 "h, left previous card",
296 "l, right next card",
297 "j, k, up, down flip card",
299 "0, ^, home go to the start of the deck",
300 "$, end go to the end of the deck",
301 "H, ? open this screen",
302 "e open the input file in $EDITOR",
303 "m open the control menu",
305 "More information can be found in the man page, or",
306 "by running `lightcards --help`.",
308 "Press [H], or [?] to go back.",
311 for t in enumerate(text):
312 self.help_win.addstr(t[0] + 3, 1, t[1])
317 """Display help screen"""
318 (mlines, mcols) = self.win.getmaxyx()
319 self.help_win.mvwin(int(mlines / 2) - 10, int(mcols / 2) - 26)
321 self.help_panel.show()
323 key = self.help_win.getkey()
326 elif key in ["H", "?"]:
327 self.help_panel.hide()
330 def current_card(self):
331 """Get current card object"""
332 return self.stack[self.obj.getIdx()]
336 Display a card and wait for the input.
337 Used as a general way of getting back into the card flow from a menu
341 key = self.win.getkey()
344 elif key in ["h", "KEY_LEFT"]:
346 self.current_card().setSide(0)
348 elif key in ["l", "KEY_RIGHT"]:
349 if self.obj.getIdx() + 1 == len(self.stack):
352 self.obj.forward(self.stack)
353 self.current_card().setSide(0)
355 elif key in ["j", "k", "KEY_UP", "KEY_DOWN"]:
356 self.current_card().flip()
358 elif key in ["i", "/"]:
359 self.current_card().toggleStar()
361 elif key in ["0", "^", "KEY_HOME"]:
363 self.current_card().setSide(0)
365 elif key in ["$", "KEY_END"]:
366 self.obj.setIdx(len(self.stack) - 1)
367 self.current_card().setSide(0)
369 elif key in ["H", "?"]:
374 (self.headers, self.stack) = runner.reparse()
377 def disp_sidebar(self):
378 """Display a sidebar with the starred terms"""
379 (mlines, mcols) = self.win.getmaxyx()
386 curses.color_pair(3) + curses.A_BOLD,
388 self.win.vline(0, mcols - 20, 0, mlines - 2)
389 self.win.hline(1, left, 0, mlines)
391 nstarred = self.nstarred()
392 if mlines - 5 < len(self.nstarred()):
393 nstarred = self.nstarred()[: mlines - 4]
394 elif mlines - 5 == len(self.nstarred()):
395 nstarred = self.nstarred()[: mlines - 3]
398 for i, card in enumerate(nstarred):
399 term = card.getFront()
402 self.win.addstr(2 + i, left, term)
403 if not nstarred == self.nstarred():
407 f"({len(self.nstarred()) - len(nstarred)} more)",
411 if len(self.nstarred()) == 0:
412 self.win.addstr(2, left, "None starred")