]> git.armaanb.net Git - lightcards.git/blobdiff - lightcards/display.py
Make control menu always accessible with "m"
[lightcards.git] / lightcards / display.py
old mode 100755 (executable)
new mode 100644 (file)
index b276680..940d15e
 # Armaan Bhojwani 2021
 
 import curses
-import os
+from random import shuffle
+import sys
+import textwrap
 
-class Status():
-    index = 0
-    side = 0
+from . import lightcards
 
-    def forward(self, stack):
-        if not self.index == len(stack) - 1:
-            self.index += 1
 
-    def back(self):
-        if not self.index < 1:
-            self.index -= 1
+class Display():
+    def __init__(self, stack, headers, obj):
+        self.stack = stack
+        self.headers = headers
+        self.obj = obj
 
-    def flip(self):
-        if self.side == 0:
-            self.side = 1
+    def run(self, stdscr):
+        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)
+        self.get_key()
+
+    def disp_bar(self):
+        """
+        Display the statusbar at the bottom of the screen with progress, star
+        status, and card side.
+        """
+        (mlines, mcols) = self.win.getmaxyx()
+
+        # Calculate percent done
+        if len(self.stack) <= 1:
+            percent = "100"
+        else:
+            percent = str(round(self.obj.getIdx() /
+                                len(self.stack) * 100)).zfill(2)
+
+        # Print yellow if starred
+        if self.stack[self.obj.getIdx()].getStar():
+            star_color = curses.color_pair(3)
         else:
-            self.side = 0
+            star_color = curses.color_pair(1)
 
-    def setSide(self, inp):
-        self.side = inp
+        # Create bar component
+        bar_start = "["
+        bar_middle = self.stack[self.obj.getIdx()].printStar()
+        bar_end = "] [" + percent + "% (" + \
+            str(self.obj.getIdx() + 1).zfill(len(str(len(self.stack)))) + \
+            "/" + str(len(self.stack)) + ")] [" + \
+            self.headers[self.obj.getSide()] + " (" + \
+            str(self.obj.getSide() + 1) + ")]"
+
+        # Put it all togethor
+        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):
+        (mlines, mcols) = self.win.getmaxyx()
+        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 getSide(self):
-        return self.side
+    def menu_grab(self):
+        while True:
+            key = self.win.getkey()
+            if key == "q":
+                if len(self.stack) == self.obj.getIdx():
+                    sys.exit(0)
+                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
 
-    def getIdx(self):
-        return self.index
+                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):
+        """
+        Display a menu once the end of the deck has been reached, offering
+        multiple options on how to continue.
+        """
 
-def disp_card(stdscr, stack, headers, obj):
-    stdscr.clear()
-    side_title = headers[obj.getSide()]
-    stdscr.addstr(side_title + "\n")
-    for i in range(len(side_title)):
-        stdscr.addstr("=")
-    stdscr.addstr("\n" + str(stack[obj.getIdx()][obj.getSide()]))
+        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" +
+                        "[q]: back")
 
+        if keygrab:
+            self.menu_grab()
 
-    (mlines, mcols) = stdscr.getmaxyx()
-    mlines -= 1
-    mcols -= 5
+    def wrap_width(self):
+        (mlines, mcols) = self.win.getmaxyx()
+        wrap_width = mcols
+        if mcols > 80:
+            wrap_width = 80
+        return wrap_width
 
-    try:
-        stdscr.insch(mlines, mcols, str(obj.getIdx() + 1))
-        stdscr.insch(mlines, mcols+1, '-')
-        if obj.getSide() == 0:
-            stdscr.insch(mlines, mcols+2, '1')
+    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()
+        (mlines, mcols) = self.win.getmaxyx()
+        if self.obj.getIdx() == len(self.stack):
+            self.disp_menu()
         else:
-            stdscr.insch(mlines, mcols+2, '2')
-        stdscr.insch(mlines, mcols+3, '/')
-        stdscr.insch(mlines, mcols+4, str(len(stack)))
-    except:
-        pass
-
-def get_key(stdscr, stack, headers):
-    idx = Status()
-    curses.curs_set(0)
-    disp_card(stdscr, stack, headers, idx)
-
-    while True:
-        key = stdscr.getkey()
-        try:
-            if key == "q" or key == os.linesep:
-                exit(0)
-            elif key in ["l", "KEY_LEFT"]:
-                idx.forward(stack)
-                idx.setSide(0)
-                disp_card(stdscr, stack, headers, idx)
-            elif key in ["h", "KEY_RIGHT"]:
-                idx.back()
-                idx.setSide(0)
-                disp_card(stdscr, stack, headers,  idx)
+            # 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
+
+            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)
+
+            # Show current side
+            self.win.addstr(2, 0, textwrap.fill(
+                self.stack[self.obj.getIdx()][self.obj.getSide()],
+                width=self.wrap_width()))
+        self.disp_bar()
+
+    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 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:
+            key = self.win.getkey()
+            if key == "q":
+                sys.exit(0)
+            elif key in ["l", "KEY_RIGHT"]:
+                self.obj.forward(self.stack)
+                self.obj.setSide(0)
+                self.disp_card()
+            elif key in ["h", "KEY_LEFT"]:
+                self.obj.back()
+                self.obj.setSide(0)
+                self.disp_card()
             elif key in ["j", "k", "KEY_UP", "KEY_DOWN"]:
-                idx.flip()
-                disp_card(stdscr, stack, headers, idx)
-        except Exception:
-            pass
+                self.obj.flip()
+                self.disp_card()
+            elif key in ["i", "/"]:
+                self.stack[self.obj.getIdx()].toggleStar()
+                self.disp_card()
+            elif key in ["0", "^", "KEY_HOME"]:
+                self.obj.setIdx(0)
+                self.obj.setSide(0)
+                self.disp_card()
+            elif key in ["$", "KEY_END"]:
+                self.obj.setIdx(len(self.stack) - 1)
+                self.obj.setSide(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()