]> git.armaanb.net Git - lightcards.git/blobdiff - lightcards/display.py
Remove ability to go left to quit the menu
[lightcards.git] / lightcards / display.py
index aa121af67d7973d7341fecfe0e291c0916e57d24..aa5beed58c70c7b4a14a4b86ed9c8648ffde9eb1 100644 (file)
@@ -6,10 +6,195 @@ import curses.panel
 from random import shuffle
 import sys
 import textwrap
+import time
 
 from . import runner, progress
 
 
+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 Help:
+    def __init__(self, outer, mlines=20, mcols=52):
+        """Initialize help screen"""
+        self.outer = outer
+        (self.win, self.panel) = panel_create(mlines, mcols)
+        self.panel.top()
+        self.panel.hide()
+        self.win.clear()
+
+        text = [
+            "Welcome to runner. Here are some keybindings",
+            "to get you started:",
+            "",
+            "h, left          previous card",
+            "l, right         next card",
+            "j, k, up, down   flip card",
+            "i, /             star card",
+            "0, ^, home       go to the start of the deck",
+            "$, end           go to the end of the deck",
+            "H, ?             open this screen",
+            "e                open the input file in $EDITOR",
+            "m                open the control menu",
+            "",
+            "More information can be found in the man page, or",
+            "by running `lightcards --help`.",
+            "",
+            "Press [H], or [?] 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) - 10, int(mcols / 2) - 26)
+        self.outer.update_panels()
+        self.panel.show()
+
+        while True:
+            key = self.win.getkey()
+            if key == "q":
+                self.outer.leave()
+            elif key in ["H", "?"]:
+                self.panel.hide()
+                self.outer.get_key()
+
+
+class Menu:
+    def __init__(self, outer, mlines=17, mcols=44):
+        """Initialize the menu with content"""
+        self.outer = outer
+        (self.win, self.panel) = panel_create(mlines, mcols)
+        self.panel.top()
+        self.panel.hide()
+
+        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)
+        text = [
+            "[y]: reset stack to original state",
+            "[a]: alphabetize stack",
+            "[z]: shuffle stack",
+            "[f]: flip all cards in stack",
+            "[t]: reverse stack order",
+            "[u]: unstar all",
+            "[d]: star all",
+            "[s]: update stack to include starred only",
+            "",
+            "[r]: restart",
+            "[m]: close menu",
+        ]
+
+        for t in enumerate(text):
+            self.win.addstr(t[0] + 3, 1, t[1])
+
+        self.win.box()
+        self.outer.update_panels()
+
+    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)
+
+        for i in range(42):
+            self.win.addch(15, i + 1, " ")
+
+        self.win.addstr(15, 1, string, color)
+        self.outer.update_panels()
+        self.menu_grab()
+
+    def menu_grab(self):
+        """Grab keypresses on the menu screen"""
+        while True:
+            key = self.win.getkey()
+            if key in ["r", "m"]:
+                self.panel.hide()
+                self.outer.update_panels()
+                self.outer.get_key()
+            elif key == "q":
+                self.outer.leave()
+            elif key == "y":
+                self.outer.stack = runner.get_orig()[1]
+                self.menu_print("Stack reset!")
+            elif key == "a":
+                self.outer.stack.sort(key=lambda x: x.front)
+                self.menu_print("Stack alphabetized!")
+            elif key == "u":
+                [x.unStar() for x in self.outer.stack]
+                self.menu_print("All unstarred!")
+            elif key == "d":
+                [x.star() for x in self.outer.stack]
+                self.menu_print("All starred!")
+            elif key == "t":
+                self.outer.stack.reverse()
+                self.menu_print("Stack reversed!")
+            elif key == "z":
+                shuffle(self.outer.stack)
+                self.menu_print("Stack shuffled!")
+            elif key == "f":
+                for x in self.outer.stack:
+                    x.front, x.back = x.back, x.front
+                (self.outer.headers[0], self.outer.headers[1]) = (
+                    self.outer.headers[1],
+                    self.outer.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.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 == "r":
+                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
+        """
+        (mlines, mcols) = self.outer.win.getmaxyx()
+        self.win.mvwin(int(mlines / 2) - 9, int(mcols / 2) - 22)
+        self.panel.show()
+        self.outer.update_panels()
+
+        self.menu_grab()
+
+
 class Display:
     def __init__(self, stack, headers, obj):
         self.stack = stack
@@ -26,35 +211,47 @@ class Display:
         curses.init_pair(2, curses.COLOR_RED, -1)
         curses.init_pair(3, curses.COLOR_YELLOW, -1)
 
-        (self.main_win, self.main_panel) = self.panel_create(mlines, mcols)
-        self.menu_init()
-        self.help_init()
+        (self.main_win, self.main_panel) = panel_create(mlines, mcols)
+        self.menu_obj = Menu(self)
+        self.help_obj = Help(self)
 
         self.get_key()
 
-    def panel_create(self, 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)
+    def check_size(self):
+        (mlines, mcols) = self.win.getmaxyx()
+
+        while mlines < 24 or mcols < 60:
+            self.main_win.clear()
+            self.main_win.addstr(
+                0,
+                0,
+                textwrap.fill(
+                    "Terminal too small! Min size 60x24", width=mcols
+                ),
+            )
+            self.main_win.redrawwin()
+            self.main_win.refresh()
+            (mlines, mcols) = self.win.getmaxyx()
+            time.sleep(0.1)
+        else:
+            self.disp_card()
 
-    def panel_up(self):
+    def update_panels(self):
         """Update panel and window contents"""
         curses.panel.update_panels()
         self.win.refresh()
 
     def leave(self):
         """Pickle stack before quitting"""
-        if self.obj.getIdx() + 1 == len(self.stack):
-            self.obj.setIdx(0)
+        if self.obj.index + 1 == len(self.stack):
+            self.obj.index = 0
 
         progress.dump(self.stack, runner.get_orig()[1])
         sys.exit(0)
 
     def nstarred(self):
         """Get total number of starred cards"""
-        return [card for card in self.stack if card.getStar()]
+        return [card for card in self.stack if card.starred]
 
     def disp_bar(self):
         """
@@ -62,17 +259,18 @@ class Display:
         status, and card side.
         """
         (mlines, mcols) = self.win.getmaxyx()
+        self.win.hline(mlines - 2, 0, 0, mcols)
 
         # Calculate percent done
         if len(self.stack) <= 1:
             percent = "100"
         else:
             percent = str(
-                round(self.obj.getIdx() / (len(self.stack) - 1) * 100)
+                round(self.obj.index / (len(self.stack) - 1) * 100)
             ).zfill(2)
 
         # Print yellow if starred
-        if self.current_card().getStar():
+        if self.current_card().starred:
             star_color = curses.color_pair(3)
         else:
             star_color = curses.color_pair(1)
@@ -83,10 +281,10 @@ class Display:
         bar_end = (
             f"] [{len(self.nstarred())}/{str(len(self.stack))} starred] "
             f"[{percent}% ("
-            f"{str(self.obj.getIdx()).zfill(len(str(len(self.stack))))}"
+            f"{str(self.obj.index).zfill(len(str(len(self.stack))))}"
             f"/{str(len(self.stack))})] ["
-            f"{self.headers[self.current_card().getSide()]} ("
-            f"{str(int(self.current_card().getSide()) + 1)})]"
+            f"{self.headers[self.current_card().side]} ("
+            f"{str(int(self.current_card().side) + 1)})]"
         )
 
         # Put it all togethor
@@ -95,124 +293,10 @@ class Display:
         self.win.addstr(
             mlines - 1,
             len(bar_start + bar_middle),
-            bar_end,
+            textwrap.shorten(bar_end, width=mcols - 20, placeholder="…"),
             curses.color_pair(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)
-
-        for i in range(42):
-            self.menu_win.addch(15, i + 1, " ")
-
-        self.menu_win.addstr(15, 1, string, color)
-        self.panel_up()
-        self.menu_grab()
-
-    def menu_grab(self):
-        """Grab keypresses on the menu screen"""
-        while True:
-            key = self.win.getkey()
-            if key in ["r", "m"]:
-                self.menu_panel.hide()
-                self.panel_up()
-                self.get_key()
-            elif key == "q":
-                self.leave()
-            elif key == "y":
-                self.stack = runner.get_orig()[1]
-                self.menu_print("Stack reset!")
-            elif key == "a":
-                self.stack.sort()
-                self.menu_print("Stack alphabetized!")
-            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("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 menu_init(self):
-        """Initialize the menu with content"""
-        (self.menu_win, self.menu_panel) = self.panel_create(17, 44)
-        self.menu_panel.top()
-        self.menu_panel.hide()
-
-        self.menu_win.addstr(
-            1, 1, "LIGHTCARDS MENU", curses.color_pair(1) + curses.A_BOLD
-        )
-        self.menu_win.hline(2, 1, curses.ACS_HLINE, 15)
-        text = [
-            "[y]: reset stack to original state",
-            "[a]: alphabetize stack",
-            "[z]: shuffle stack",
-            "[f]: flip all cards in stack",
-            "[t]: reverse stack order",
-            "[u]: unstar all",
-            "[d]: star all",
-            "[s]: update stack to include starred only",
-            "",
-            "[r]: restart",
-            "[m]: close menu",
-        ]
-
-        for t in enumerate(text):
-            self.menu_win.addstr(t[0] + 3, 1, t[1])
-
-        self.menu_win.box()
-        self.panel_up()
-
-    def disp_menu(self, keygrab=True):
-        """
-        Display a menu offering multiple options on how to manipulate the deck
-        and to continue
-        """
-        (mlines, mcols) = self.win.getmaxyx()
-        self.menu_win.mvwin(int(mlines / 2) - 9, int(mcols / 2) - 22)
-        self.menu_panel.show()
-        self.panel_up()
-
-        if keygrab:
-            self.menu_grab()
-
     def wrap_width(self):
         """Calculate the width at which the body text should wrap"""
         (_, mcols) = self.win.getmaxyx()
@@ -232,18 +316,16 @@ class Display:
         self.main_win.clear()
         # 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.current_card().getSide() == 0:
-            top = (
-                num_done + " | " + self.headers[self.current_card().getSide()]
-            )
+        num_done = str(self.obj.index + 1).zfill(len(str(len(self.stack))))
+        if self.current_card().side == 0:
+            top = num_done + " | " + self.headers[self.current_card().side]
         else:
             top = (
                 num_done
                 + " | "
-                + self.headers[self.current_card().getSide()]
+                + self.headers[self.current_card().side]
                 + ' | "'
-                + str(self.current_card().getFront())
+                + str(self.current_card().front)
                 + '"'
             )
         header_width = mcols
@@ -258,10 +340,7 @@ class Display:
         )
 
         # Add horizontal line
-        lin_width = header_width
-        if len(top) < header_width:
-            lin_width = len(top)
-        self.main_win.hline(1, 0, curses.ACS_HLINE, lin_width)
+        self.main_win.hline(1, 0, curses.ACS_HLINE, mcols)
 
         # Show current side
         self.main_win.addstr(
@@ -272,84 +351,34 @@ class Display:
                 width=self.wrap_width(),
             ),
         )
-        self.panel_up()
+        self.update_panels()
         self.disp_bar()
         self.disp_sidebar()
-        self.win.hline(mlines - 2, 0, 0, mcols)
-
-    def help_init(self):
-        """Initialize help screen"""
-        (self.help_win, self.help_panel) = self.panel_create(20, 52)
-        self.help_panel.top()
-        self.help_panel.hide()
-        self.help_win.clear()
-        self.help_win.addstr(
-            1, 1, "LIGHTCARDS HELP", curses.color_pair(1) + curses.A_BOLD
-        )
-        self.help_win.hline(2, 1, curses.ACS_HLINE, 15)
-        text = [
-            "Welcome to runner. Here are some keybindings",
-            "to get you started:",
-            "",
-            "h, left          previous card",
-            "l, right         next card",
-            "j, k, up, down   flip card",
-            "i, /             star card",
-            "0, ^, home       go to the start of the deck",
-            "$, end           go to the end of the deck",
-            "H, ?             open this screen",
-            "e                open the input file in $EDITOR",
-            "m                open the control menu",
-            "",
-            "More information can be found in the man page, or",
-            "by running `lightcards --help`.",
-            "",
-            "Press [H], or [?] to go back.",
-        ]
-
-        for t in enumerate(text):
-            self.help_win.addstr(t[0] + 3, 1, t[1])
-
-        self.help_win.box()
-
-    def disp_help(self):
-        """Display help screen"""
-        (mlines, mcols) = self.win.getmaxyx()
-        self.help_win.mvwin(int(mlines / 2) - 10, int(mcols / 2) - 26)
-        self.panel_up()
-        self.help_panel.show()
-        while True:
-            key = self.help_win.getkey()
-            if key == "q":
-                self.leave()
-            elif key in ["H", "?"]:
-                self.help_panel.hide()
-                self.get_key()
 
     def current_card(self):
         """Get current card object"""
-        return self.stack[self.obj.getIdx()]
+        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":
                 self.leave()
             elif key in ["h", "KEY_LEFT"]:
                 self.obj.back()
-                self.current_card().setSide(0)
+                self.current_card().side = 0
                 self.disp_card()
             elif key in ["l", "KEY_RIGHT"]:
-                if self.obj.getIdx() + 1 == len(self.stack):
-                    self.disp_menu()
+                if self.obj.index + 1 == len(self.stack):
+                    self.menu_obj.disp()
                 else:
                     self.obj.forward(self.stack)
-                    self.current_card().setSide(0)
+                    self.current_card().side = 0
                     self.disp_card()
             elif key in ["j", "k", "KEY_UP", "KEY_DOWN"]:
                 self.current_card().flip()
@@ -358,17 +387,17 @@ class Display:
                 self.current_card().toggleStar()
                 self.disp_card()
             elif key in ["0", "^", "KEY_HOME"]:
-                self.obj.setIdx(0)
-                self.current_card().setSide(0)
+                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.current_card().setSide(0)
+                self.obj.index = len(self.stack) - 1
+                self.current_card().side = 0
                 self.disp_card()
             elif key in ["H", "?"]:
-                self.disp_help()
+                self.help_obj.disp()
             elif key == "m":
-                self.disp_menu()
+                self.menu_obj.disp()
             elif key == "e":
                 (self.headers, self.stack) = runner.reparse()
                 self.get_key()
@@ -378,6 +407,9 @@ class Display:
         (mlines, mcols) = self.win.getmaxyx()
         left = mcols - 19
 
+        for i in range(20):
+            self.win.addch(0, mcols - 20 + i, " ")
+
         self.win.addstr(
             0,
             mcols - 16,
@@ -385,7 +417,6 @@ class Display:
             curses.color_pair(3) + curses.A_BOLD,
         )
         self.win.vline(0, mcols - 20, 0, mlines - 2)
-        self.win.hline(1, left, 0, mlines)
 
         nstarred = self.nstarred()
         if mlines - 5 < len(self.nstarred()):
@@ -395,7 +426,7 @@ class Display:
 
         for _ in nstarred:
             for i, card in enumerate(nstarred):
-                term = card.getFront()
+                term = card.front
                 if len(term) > 18:
                     term = term + "…"
                 self.win.addstr(2 + i, left, term)