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["quit_confirmation"]:
  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 i, content in enumerate(text, 3):
 112             self.win.addstr(i, 1, content)
 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 i, content in enumerate(text, 3):
 160             self.win.addstr(i, 1, content)
 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                 curses.endwin()
 211                 os.system(f"$EDITOR {self.outer.input_file}"),
 212                 (self.outer.headers, self.outer.stack) = parse.parse_html(
 213                     parse.md2html(self.outer.input_file),
 214                     self.outer.args,
 215                     self.outer.config,
 216                 )
 217                 self.outer.get_key()
 218             elif key in self.outer.config["menu_stars_only"]:
 219                 # Check if there are any starred cards before proceeding, and
 220                 # if not, don't allow to proceed and show an error message
 221                 cont = False
 222                 for x in self.outer.stack:
 223                     if x.starred:
 224                         cont = True
 225                         break
 226
 227                 if cont:
 228                     self.outer.stack = [
 229                         x for x in self.outer.stack if x.starred
 230                     ]
 231                     self.menu_print("Stars only!")
 232                 else:
 233                     self.menu_print("ERR: None are starred!", err=True)
 234             elif key in self.outer.config["menu_restart"]:
 235                 self.outer.obj.index = 0
 236                 self.outer.get_key()
 237
 238     def disp(self):
 239         """
 240         Display a menu offering multiple options on how to manipulate the deck
 241         and to continue
 242         """
 243         self.clear_msg()
 244
 245         (mlines, mcols) = self.outer.win.getmaxyx()
 246         self.win.mvwin(int(mlines / 2) - 8, int(mcols / 2) - 22)
 247         self.panel.show()
 248
 249         self.menu_grab()
 250
 251
 252 class Display:
 253     def __init__(self, stack, headers, obj, view, args, conf):
 254         self.stack = stack
 255         self.headers = headers
 256         self.obj = obj
 257         self.view = view
 258         self.input_file = args.inp
 259         self.config = conf
 260         self.args = args
 261
 262     def run(self, stdscr):
 263         """Set important options that require stdscr before starting"""
 264         self.win = stdscr
 265         curses.curs_set(0)  # Hide cursor
 266         curses.use_default_colors()  # Allow transparency
 267         curses.init_pair(1, self.config["highlight_color"], -1)
 268         curses.init_pair(2, self.config["error_color"], -1)
 269         curses.init_pair(3, self.config["starred_color"], -1)
 270
 271         self.main_panel = curses.panel.new_panel(self.win)
 272         self.menu_obj = Menu(self)
 273         self.help_obj = Help(self)
 274         self.quit_obj = Quit(self)
 275
 276         self.get_key()
 277
 278     def check_size(self):
 279         (mlines, mcols) = self.win.getmaxyx()
 280
 281         while mlines < 24 or mcols < 60:
 282             self.win.clear()
 283             self.win.addstr(
 284                 0,
 285                 0,
 286                 textwrap.fill(
 287                     "Terminal too small! Min size 60x24", width=mcols
 288                 ),
 289             )
 290             self.win.refresh()
 291             (mlines, mcols) = self.win.getmaxyx()
 292             time.sleep(0.1)
 293         else:
 294             self.disp_card()
 295
 296     def dump(self):
 297         if self.config["cache"]:
 298             progress.dump(self.stack, runner.get_orig()[1])
 299
 300     def leave(self):
 301         """Pickle stack and confirm before quitting"""
 302         self.quit_obj.disp()
 303         if self.obj.index + 1 == len(self.stack):
 304             self.obj.index = 0
 305
 306         self.dump()
 307         sys.exit(0)
 308
 309     def nstarred(self):
 310         """Get total number of starred cards"""
 311         return [card for card in self.stack if card.starred]
 312
 313     def prep_bar(self):
 314         (mlines, mcols) = self.win.getmaxyx()
 315
 316         # Calculate percent done
 317         if len(self.stack) <= 1:
 318             percent = "100"
 319         else:
 320             percent = str(
 321                 round(self.obj.index / (len(self.stack) - 1) * 100)
 322             ).zfill(3)
 323
 324         # Print yellow if starred
 325         if self.current_card().starred:
 326             self.star_color = curses.color_pair(3)
 327         else:
 328             self.star_color = curses.color_pair(1)
 329
 330         # Compose bar text
 331         self.bar_start = "["
 332         self.bar_middle = self.current_card().printStar()
 333         self.bar_end = (
 334             f"] [{len(self.nstarred())}/{str(len(self.stack))} starred] "
 335         )
 336         if self.view != 3:
 337             self.bar_end += (
 338                 f" [{self.get_side()} ("
 339                 f"{str(int(self.current_card().side) + 1)})]"
 340             )
 341         self.bar_end += f" [View {str(self.view)}]"
 342
 343         self.progress = (
 344             f"[{percent}% ("
 345             f"{str(self.obj.index + 1).zfill(len(str(len(self.stack))))}"
 346             f"/{str(len(self.stack))})] "
 347         )
 348
 349     def disp_bar(self):
 350         """
 351         Display the statusbar at the bottom of the screen with progress, star
 352         status, and card side.
 353         """
 354         # Put it all togethor
 355         (mlines, mcols) = self.win.getmaxyx()
 356         height = mlines - 2
 357         self.win.addstr(height, 0, self.bar_start, curses.color_pair(1))
 358         self.win.addstr(
 359             height, len(self.bar_start), self.bar_middle, self.star_color
 360         )
 361         self.win.addstr(
 362             height,
 363             len(self.bar_start + self.bar_middle),
 364             textwrap.shorten(self.bar_end, width=mcols - 20, placeholder="…"),
 365             curses.color_pair(1),
 366         )
 367
 368         self.win.addstr(
 369             height + 1,
 370             0,
 371             self.progress,
 372             curses.color_pair(1),
 373         )
 374
 375         for i in range(
 376             int(
 377                 self.obj.index
 378                 / (len(self.stack) - 1)
 379                 * (mcols - len(self.progress))
 380                 - 1
 381             )
 382         ):
 383             self.win.addch(
 384                 height + 1,
 385                 i + len(self.progress),
 386                 self.config["progress_char"],
 387                 curses.color_pair(1),
 388             )
 389
 390         self.win.hline(mlines - 3, 0, 0, mcols)
 391
 392     def wrap_width(self):
 393         """Calculate the width at which the body text should wrap"""
 394         (_, mcols) = self.win.getmaxyx()
 395         wrap_width = mcols - 20
 396         if wrap_width > 80:
 397             wrap_width = 80
 398         return wrap_width
 399
 400     def get_side(self):
 401         if self.obj.side == 0:
 402             return self.headers[self.current_card().side]
 403         else:
 404             return self.headers[self.current_card().get_reverse()]
 405
 406     def disp_card(self):
 407         (_, mcols) = self.win.getmaxyx()
 408         self.main_panel.bottom()
 409         self.prep_bar()
 410         num_done = str(self.obj.index + 1).zfill(len(str(len(self.stack))))
 411
 412         if self.view in [1, 2, 4]:
 413             """
 414             Display the contents of the card.
 415             Shows a header, a horizontal line, and the contents of the current
 416             side.
 417             """
 418             # If on the back of the card, show the content of the front side in
 419             # the header
 420             if self.view == 1:
 421                 self.obj.side = 0
 422             elif self.view == 2:
 423                 self.obj.side = 1
 424
 425             if self.current_card().side == 0:
 426                 top = num_done + " | " + self.get_side()
 427             else:
 428                 top = (
 429                     num_done
 430                     + " | "
 431                     + self.get_side()
 432                     + ' | "'
 433                     + str(self.current_card().get()[self.obj.get_reverse()])
 434                     + '"'
 435                 )
 436
 437             self.win.clear()
 438             self.win.addstr(
 439                 0,
 440                 0,
 441                 textwrap.shorten(top, width=mcols - 20, placeholder="…"),
 442                 curses.A_BOLD,
 443             )
 444
 445             # Show current side
 446             self.win.addstr(
 447                 2,
 448                 0,
 449                 textwrap.fill(
 450                     self.current_card().get()[self.obj.side],
 451                     width=self.wrap_width(),
 452                 ),
 453             )
 454
 455         elif self.view == 3:
 456             """
 457             Display the contents of the card with both the front and back sides.
 458             """
 459             self.win.clear()
 460             self.win.addstr(
 461                 0,
 462                 0,
 463                 textwrap.shorten(
 464                     num_done,
 465                     width=mcols - 20,
 466                     placeholder="…",
 467                 ),
 468                 curses.A_BOLD,
 469             )
 470
 471             # Show card content
 472             self.win.addstr(
 473                 2,
 474                 0,
 475                 textwrap.fill(
 476                     self.headers[0] + ": " + self.current_card().front,
 477                     width=self.wrap_width(),
 478                 )
 479                 + "\n\n"
 480                 + textwrap.fill(
 481                     self.headers[1] + ": " + self.current_card().back,
 482                     width=self.wrap_width(),
 483                 ),
 484             )
 485
 486         self.win.hline(1, 0, curses.ACS_HLINE, mcols)
 487         self.disp_sidebar()
 488         self.disp_bar()
 489
 490     def current_card(self):
 491         """Get current card object"""
 492         return self.stack[self.obj.index]
 493
 494     def get_key(self):
 495         """
 496         Display a card and wait for the input.
 497         Used as a general way of getting back into the card flow from a menu
 498         """
 499         while True:
 500             self.check_size()
 501             key = self.win.getkey()
 502             if key in self.config["quit_key"]:
 503                 self.leave()
 504             elif key in self.config["card_prev"]:
 505                 self.obj.back()
 506                 self.current_card().side = 0
 507                 self.disp_card()
 508             elif key in self.config["card_next"]:
 509                 if self.obj.index + 1 == len(self.stack):
 510                     if self.config["show_menu_at_end"]:
 511                         self.menu_obj.disp()
 512                 else:
 513                     self.obj.forward(self.stack)
 514                     self.current_card().side = 0
 515                     self.disp_card()
 516             elif key in self.config["card_flip"] and self.view != 3:
 517                 self.current_card().flip()
 518                 self.disp_card()
 519             elif key in self.config["card_star"]:
 520                 self.current_card().toggleStar()
 521                 self.disp_card()
 522             elif key in self.config["card_first"]:
 523                 self.obj.index = 0
 524                 self.current_card().side = 0
 525                 self.disp_card()
 526             elif key in self.config["card_last"]:
 527                 self.obj.index = len(self.stack) - 1
 528                 self.current_card().side = 0
 529                 self.disp_card()
 530             elif key in self.config["help_disp"]:
 531                 self.help_obj.disp()
 532             elif key in self.config["menu_disp"]:
 533                 self.menu_obj.disp()
 534             elif key in self.config["view_one"]:
 535                 self.view = 1
 536             elif key in self.config["view_two"]:
 537                 self.view = 2
 538             elif key in self.config["view_three"]:
 539                 self.view = 3
 540
 541     def disp_sidebar(self):
 542         """Display a sidebar with the starred terms"""
 543         (mlines, mcols) = self.win.getmaxyx()
 544         left = mcols - 19
 545
 546         self.win.addstr(
 547             0,
 548             mcols - 16,
 549             "STARRED CARDS",
 550             curses.color_pair(3) + curses.A_BOLD,
 551         )
 552         self.win.vline(0, mcols - 20, 0, mlines - 3)
 553
 554         nstarred = self.nstarred()
 555         for i, card in enumerate(nstarred):
 556             term = card.get()[self.obj.side]
 557             if len(term) > 18:
 558                 term = term[:18] + "…"
 559
 560             if i > mlines - 6:
 561                 for i in range(19):
 562                     self.win.addch(mlines - 4, left + i, " ")
 563
 564                 self.win.addstr(
 565                     mlines - 4,
 566                     left,
 567                     f"({len(nstarred) - i - 2} more)",
 568                 )
 569             else:
 570                 self.win.addstr(2 + i, left, term)
 571
 572         if len(self.nstarred()) == 0:
 573             self.win.addstr(2, left, "None starred")