lightcards/display.py

   1 # Display card output and retreive input
   2 # Armaan Bhojwani 2021
   3
   4 import curses
   5 import curses.panel
   6 import os
   7 from random import shuffle
   8 import sys
   9 import textwrap
  10 import time
  11
  12 from . import runner, progress, parse
  13
  14
  15 def panel_create(x, y):
  16     """Create popup panels to a certain scale"""
  17     win = curses.newwin(x, y)
  18     panel = curses.panel.new_panel(win)
  19     win.erase()
  20     return (win, panel)
  21
  22
  23 class CursesError(BaseException):
  24     def __init__(self, message="lightcards: Curses error!"):
  25         self.message = message
  26         print(self.message)
  27         sys.exit(3)
  28
  29
  30 class Quit:
  31     def __init__(self, outer, mlines=5, mcols=20):
  32         self.outer = outer
  33         (self.win, self.panel) = panel_create(mlines, mcols)
  34         self.panel.top()
  35         self.panel.hide()
  36
  37         self.win.addstr(
  38             1,
  39             2,
  40             "QUIT LIGHTCARDS?",
  41             curses.color_pair(1) + curses.A_BOLD,
  42         )
  43         self.win.hline(2, 1, curses.ACS_HLINE, mcols)
  44         self.win.addstr(3, 1, "Quit? [y/n]")
  45
  46         self.win.box()
  47
  48     def disp(self):
  49         """Display quit confirmation screen"""
  50         (mlines, mcols) = self.outer.win.getmaxyx()
  51         self.win.mvwin(int(mlines / 2) - 3, int(mcols / 2) - 10)
  52         self.panel.show()
  53         if self.outer.config["confirm_quit"]:
  54             while True:
  55                 key = self.win.getkey()
  56                 if key == "y":
  57                     break
  58                 elif key == "n":
  59                     self.panel.hide()
  60                     self.outer.get_key()
  61
  62
  63 class Panel:
  64     def __init__(self, outer, mlines, mcols):
  65         self.outer = outer
  66         (self.win, self.panel) = panel_create(mlines, mcols)
  67         self.panel.top()
  68         self.panel.hide()
  69
  70     def config_get(self, setting, cut=28):
  71         return str(list(self.outer.config[setting][:cut])).replace("'", "")
  72
  73
  74 class Help(Panel):
  75     def __init__(self, outer, mlines=23, mcols=52):
  76         """Initialize help screen"""
  77         super().__init__(outer, mlines, mcols)
  78         c = self.config_get
  79
  80         text = [
  81             "Welcome to Lightcards. Here are some keybindings",
  82             "to get you started:",
  83             "",
  84             f"{c('card_prev')}: previous card",
  85             f"{c('card_next')}: next card",
  86             f"{c('card_flip')}: flip card",
  87             f"{c('card_star')}: star card",
  88             f"{c('card_first')}: go to first card",
  89             f"{c('card_last')}: go to last card",
  90             f"{c('help_disp')}: open this help menu",
  91             f"{c('menu_disp')}: open the control menu",
  92             f"{c('view_one')}: switch to view one",
  93             f"{c('view_two')}: switch to view two",
  94             f"{c('view_three')}: switch to view three",
  95             f"{c('quit_key')}: quit",
  96             "",
  97             "More information can be found in the man page, or",
  98             "by running `lightcards --help`.",
  99             "",
 100             f"Press {c('help_disp')} to go back.",
 101         ]
 102
 103         self.win.addstr(
 104             1,
 105             int(mcols / 2) - 8,
 106             "LIGHTCARDS HELP",
 107             curses.color_pair(1) + curses.A_BOLD,
 108         )
 109         self.win.hline(2, 1, curses.ACS_HLINE, mcols)
 110
 111         for t in enumerate(text):
 112             self.win.addstr(t[0] + 3, 1, t[1])
 113
 114         self.win.box()
 115
 116     def disp(self):
 117         """Display help screen"""
 118         (mlines, mcols) = self.outer.win.getmaxyx()
 119         self.win.mvwin(int(mlines / 2) - 12, int(mcols / 2) - 25)
 120         self.panel.show()
 121
 122         while True:
 123             key = self.win.getkey()
 124             if key in self.outer.config["quit_key"]:
 125                 self.outer.leave()
 126             elif key in self.outer.config["help_disp"]:
 127                 self.panel.hide()
 128                 self.outer.get_key()
 129
 130
 131 class Menu(Panel):
 132     def __init__(self, outer, mlines=17, mcols=44):
 133         """Initialize the menu with content"""
 134         super().__init__(outer, mlines, mcols)
 135         c = self.config_get
 136
 137         self.win.addstr(
 138             1,
 139             int(mcols / 2) - 8,
 140             "LIGHTCARDS MENU",
 141             curses.color_pair(1) + curses.A_BOLD,
 142         )
 143         self.win.hline(2, 1, curses.ACS_HLINE, mcols)
 144         env = os.environ.get("EDITOR", "$EDITOR")[:15]
 145         text = [
 146             f"{c('menu_reset')}: reset stack to original state",
 147             f"{c('menu_alphabetize')}: alphabetize stack",
 148             f"{c('menu_shuffle')}: shuffle stack",
 149             f"{c('menu_reverse')}: reverse stack order",
 150             f"{c('menu_unstar')}: unstar all",
 151             f"{c('menu_star')}: star all",
 152             f"{c('menu_stars_only')}: update stack to include starred only",
 153             f"{c('menu_open_file')}: open the input file in {env}",
 154             "",
 155             f"{c('menu_restart')}: restart",
 156             f"{c('menu_disp')}: close menu",
 157         ]
 158
 159         for t in enumerate(text):
 160             self.win.addstr(t[0] + 3, 1, t[1])
 161
 162         self.win.box()
 163
 164     def clear_msg(self):
 165         for i in range(42):
 166             self.win.addch(15, i + 1, " ")
 167
 168     def menu_print(self, string, err=False):
 169         """Print messages on the menu screen"""
 170         if err:
 171             color = curses.color_pair(2)
 172         else:
 173             color = curses.color_pair(1)
 174
 175         self.win.addstr(15, 1, string, color)
 176         self.menu_grab()
 177
 178     def menu_grab(self):
 179         """Grab keypresses on the menu screen"""
 180         while True:
 181             key = self.win.getkey()
 182             if (
 183                 key
 184                 in self.outer.config["menu_disp"]
 185                 + self.outer.config["menu_restart"]
 186             ):
 187                 self.panel.hide()
 188                 self.outer.get_key()
 189             elif key in self.outer.config["quit_key"]:
 190                 self.outer.leave()
 191             elif key in self.outer.config["menu_reset"]:
 192                 self.outer.stack = runner.get_orig()[1]
 193                 self.menu_print("Stack reset!")
 194             elif key in self.outer.config["menu_alphabetize"]:
 195                 self.outer.stack.sort(key=lambda x: x.front)
 196                 self.menu_print("Stack alphabetized!")
 197             elif key in self.outer.config["menu_unstar"]:
 198                 [x.unStar() for x in self.outer.stack]
 199                 self.menu_print("All unstarred!")
 200             elif key in self.outer.config["menu_star"]:
 201                 [x.star() for x in self.outer.stack]
 202                 self.menu_print("All starred!")
 203             elif key in self.outer.config["menu_reverse"]:
 204                 self.outer.stack.reverse()
 205                 self.menu_print("Stack reversed!")
 206             elif key in self.outer.config["menu_shuffle"]:
 207                 shuffle(self.outer.stack)
 208                 self.menu_print("Stack shuffled!")
 209             elif key in self.outer.config["menu_open_file"]:
 210                 progress.dump(self.outer.stack, runner.get_orig()[1])
 211                 curses.endwin()
 212                 os.system(f"$EDITOR {self.outer.input_file}"),
 213                 (self.outer.headers, self.outer.stack) = parse.parse_html(
 214                     parse.md2html(self.outer.input_file)
 215                 )
 216                 self.outer.get_key()
 217             elif key in self.outer.config["menu_stars_only"]:
 218                 # Check if there are any starred cards before proceeding, and
 219                 # if not, don't allow to proceed and show an error message
 220                 cont = False
 221                 for x in self.outer.stack:
 222                     if x.starred:
 223                         cont = True
 224                         break
 225
 226                 if cont:
 227                     self.outer.stack = [
 228                         x for x in self.outer.stack if x.starred
 229                     ]
 230                     self.menu_print("Stars only!")
 231                 else:
 232                     self.menu_print("ERR: None are starred!", err=True)
 233             elif key in self.outer.config["menu_restart"]:
 234                 self.outer.obj.index = 0
 235                 self.outer.get_key()
 236
 237     def disp(self):
 238         """
 239         Display a menu offering multiple options on how to manipulate the deck
 240         and to continue
 241         """
 242         self.clear_msg()
 243
 244         (mlines, mcols) = self.outer.win.getmaxyx()
 245         self.win.mvwin(int(mlines / 2) - 8, int(mcols / 2) - 22)
 246         self.panel.show()
 247
 248         self.menu_grab()
 249
 250
 251 class Display:
 252     def __init__(self, stack, headers, obj, view, args, conf):
 253         self.stack = stack
 254         self.headers = headers
 255         self.obj = obj
 256         self.view = view
 257         self.input_file = args.inp[0]
 258         self.config = conf
 259
 260     def run(self, stdscr):
 261         """Set important options that require stdscr before starting"""
 262         self.win = stdscr
 263         curses.curs_set(0)  # Hide cursor
 264         curses.use_default_colors()  # Allow transparency
 265         curses.init_pair(1, self.config["highlight_color"], -1)
 266         curses.init_pair(2, self.config["error_color"], -1)
 267         curses.init_pair(3, self.config["starred_color"], -1)
 268
 269         self.main_panel = curses.panel.new_panel(self.win)
 270         self.menu_obj = Menu(self)
 271         self.help_obj = Help(self)
 272         self.quit_obj = Quit(self)
 273
 274         self.get_key()
 275
 276     def check_size(self):
 277         (mlines, mcols) = self.win.getmaxyx()
 278
 279         while mlines < 24 or mcols < 60:
 280             self.win.clear()
 281             self.win.addstr(
 282                 0,
 283                 0,
 284                 textwrap.fill(
 285                     "Terminal too small! Min size 60x24", width=mcols
 286                 ),
 287             )
 288             self.win.refresh()
 289             (mlines, mcols) = self.win.getmaxyx()
 290             time.sleep(0.1)
 291         else:
 292             self.disp_card()
 293
 294     def leave(self):
 295         """Pickle stack and confirm before quitting"""
 296         self.quit_obj.disp()
 297         if self.obj.index + 1 == len(self.stack):
 298             self.obj.index = 0
 299
 300         progress.dump(self.stack, runner.get_orig()[1])
 301         sys.exit(0)
 302
 303     def nstarred(self):
 304         """Get total number of starred cards"""
 305         return [card for card in self.stack if card.starred]
 306
 307     def disp_bar(self):
 308         """
 309         Display the statusbar at the bottom of the screen with progress, star
 310         status, and card side.
 311         """
 312         (mlines, mcols) = self.win.getmaxyx()
 313         self.win.hline(mlines - 3, 0, 0, mcols)
 314
 315         # Calculate percent done
 316         if len(self.stack) <= 1:
 317             percent = "100"
 318         else:
 319             percent = str(
 320                 round(self.obj.index / (len(self.stack) - 1) * 100)
 321             ).zfill(2)
 322
 323         # Print yellow if starred
 324         if self.current_card().starred:
 325             star_color = curses.color_pair(3)
 326         else:
 327             star_color = curses.color_pair(1)
 328
 329         # Compose bar text
 330         bar_start = "["
 331         bar_middle = self.current_card().printStar()
 332         bar_end = f"] [{len(self.nstarred())}/{str(len(self.stack))} starred] "
 333         if self.view != 3:
 334             bar_end += (
 335                 f" [{self.get_side()} ("
 336                 f"{str(int(self.current_card().side) + 1)})]"
 337             )
 338         bar_end += f" [View {str(self.view)}]"
 339
 340         # Put it all togethor
 341         height = mlines - 2
 342         self.win.addstr(height, 0, bar_start, curses.color_pair(1))
 343         self.win.addstr(height, len(bar_start), bar_middle, star_color)
 344         self.win.addstr(
 345             height,
 346             len(bar_start + bar_middle),
 347             textwrap.shorten(bar_end, width=mcols - 20, placeholder="…"),
 348             curses.color_pair(1),
 349         )
 350
 351         progress = (
 352             f"[{percent}% ("
 353             f"{str(self.obj.index + 1).zfill(len(str(len(self.stack))))}"
 354             f"/{str(len(self.stack))})] "
 355         )
 356
 357         self.win.addstr(
 358             height + 1,
 359             0,
 360             progress,
 361             curses.color_pair(1),
 362         )
 363
 364         for i in range(
 365             int(
 366                 self.obj.index
 367                 / (len(self.stack) - 1)
 368                 * (mcols - len(progress))
 369                 - 1
 370             )
 371         ):
 372             self.win.addch(
 373                 height + 1,
 374                 i + len(progress),
 375                 self.config["progress_char"],
 376                 curses.color_pair(1),
 377             )
 378
 379     def wrap_width(self):
 380         """Calculate the width at which the body text should wrap"""
 381         (_, mcols) = self.win.getmaxyx()
 382         wrap_width = mcols - 20
 383         if wrap_width > 80:
 384             wrap_width = 80
 385         return wrap_width
 386
 387     def get_side(self):
 388         if self.obj.side == 0:
 389             return self.headers[self.current_card().side]
 390         else:
 391             return self.headers[self.current_card().get_reverse()]
 392
 393     def disp_card(self):
 394         (_, mcols) = self.win.getmaxyx()
 395         self.main_panel.bottom()
 396         self.win.clear()
 397         num_done = str(self.obj.index + 1).zfill(len(str(len(self.stack))))
 398
 399         if self.view in [1, 2, 4]:
 400             """
 401             Display the contents of the card.
 402             Shows a header, a horizontal line, and the contents of the current
 403             side.
 404             """
 405             # If on the back of the card, show the content of the front side in
 406             # the header
 407             if self.view == 1:
 408                 self.obj.side = 0
 409             elif self.view == 2:
 410                 self.obj.side = 1
 411
 412             if self.current_card().side == 0:
 413                 top = num_done + " | " + self.get_side()
 414             else:
 415                 top = (
 416                     num_done
 417                     + " | "
 418                     + self.get_side()
 419                     + ' | "'
 420                     + str(self.current_card().get()[self.obj.get_reverse()])
 421                     + '"'
 422                 )
 423
 424             self.win.addstr(
 425                 0,
 426                 0,
 427                 textwrap.shorten(top, width=mcols - 20, placeholder="…"),
 428                 curses.A_BOLD,
 429             )
 430
 431             # Show current side
 432             self.win.addstr(
 433                 2,
 434                 0,
 435                 textwrap.fill(
 436                     self.current_card().get()[self.obj.side],
 437                     width=self.wrap_width(),
 438                 ),
 439             )
 440
 441         elif self.view == 3:
 442             """
 443             Display the contents of the card with both the front and back sides.
 444             """
 445             (_, mcols) = self.win.getmaxyx()
 446             self.main_panel.bottom()
 447             self.win.clear()
 448
 449             self.win.addstr(
 450                 0,
 451                 0,
 452                 textwrap.shorten(
 453                     num_done,
 454                     width=mcols - 20,
 455                     placeholder="…",
 456                 ),
 457                 curses.A_BOLD,
 458             )
 459
 460             # Show card content
 461             self.win.addstr(
 462                 2,
 463                 0,
 464                 textwrap.fill(
 465                     self.headers[0] + ": " + self.current_card().front,
 466                     width=self.wrap_width(),
 467                 )
 468                 + "\n\n"
 469                 + textwrap.fill(
 470                     self.headers[1] + ": " + self.current_card().back,
 471                     width=self.wrap_width(),
 472                 ),
 473             )
 474
 475         self.win.hline(1, 0, curses.ACS_HLINE, mcols)
 476         self.disp_bar()
 477         self.disp_sidebar()
 478
 479     def current_card(self):
 480         """Get current card object"""
 481         return self.stack[self.obj.index]
 482
 483     def get_key(self):
 484         """
 485         Display a card and wait for the input.
 486         Used as a general way of getting back into the card flow from a menu
 487         """
 488         while True:
 489             self.check_size()
 490             key = self.win.getkey()
 491             if key in self.config["quit_key"]:
 492                 self.leave()
 493             elif key in self.config["card_prev"]:
 494                 self.obj.back()
 495                 self.current_card().side = 0
 496                 self.disp_card()
 497             elif key in self.config["card_next"]:
 498                 if self.obj.index + 1 == len(self.stack):
 499                     if self.config["show_menu_at_end"]:
 500                         self.menu_obj.disp()
 501                 else:
 502                     self.obj.forward(self.stack)
 503                     self.current_card().side = 0
 504                     self.disp_card()
 505             elif key in self.config["card_flip"] and self.view != 3:
 506                 self.current_card().flip()
 507                 self.disp_card()
 508             elif key in self.config["card_star"]:
 509                 self.current_card().toggleStar()
 510                 self.disp_card()
 511             elif key in self.config["card_first"]:
 512                 self.obj.index = 0
 513                 self.current_card().side = 0
 514                 self.disp_card()
 515             elif key in self.config["card_last"]:
 516                 self.obj.index = len(self.stack) - 1
 517                 self.current_card().side = 0
 518                 self.disp_card()
 519             elif key in self.config["help_disp"]:
 520                 self.help_obj.disp()
 521             elif key in self.config["menu_disp"]:
 522                 self.menu_obj.disp()
 523             elif key in self.config["view_one"]:
 524                 self.view = 1
 525             elif key in self.config["view_two"]:
 526                 self.view = 2
 527             elif key in self.config["view_three"]:
 528                 self.view = 3
 529
 530     def disp_sidebar(self):
 531         """Display a sidebar with the starred terms"""
 532         (mlines, mcols) = self.win.getmaxyx()
 533         left = mcols - 19
 534
 535         self.win.addstr(
 536             0,
 537             mcols - 16,
 538             "STARRED CARDS",
 539             curses.color_pair(3) + curses.A_BOLD,
 540         )
 541         self.win.vline(0, mcols - 20, 0, mlines - 3)
 542
 543         nstarred = self.nstarred()
 544         for i, card in enumerate(nstarred):
 545             term = card.get()[self.obj.side]
 546             if len(term) > 18:
 547                 term = term[:18] + "…"
 548
 549             if i > mlines - 6:
 550                 for i in range(19):
 551                     self.win.addch(mlines - 3, left + i, " ")
 552
 553                 self.win.addstr(
 554                     mlines - 4,
 555                     left,
 556                     f"({len(nstarred) - i - 2} more)",
 557                 )
 558             else:
 559                 self.win.addstr(2 + i, left, term)
 560
 561         if len(self.nstarred()) == 0:
 562             self.win.addstr(2, left, "None starred")