]> git.armaanb.net Git - lightcards.git/blobdiff - lightcards/display.py
Make menus more logical
[lightcards.git] / lightcards / display.py
index 2a25354fa995ad2a0f0d7405e7b2d243935afdaf..58a9055004760f1c13d640ea85465d3ba84b313a 100644 (file)
@@ -17,13 +17,14 @@ class Display:
         self.obj = obj
 
     def run(self, stdscr):
-        """Set important options before beginning"""
+        """Set important options that require stdscr before starting"""
         self.win = stdscr
         (mlines, mcols) = self.win.getmaxyx()
         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)
+        curses.use_default_colors()  # Allow transparency
+        curses.init_pair(1, curses.COLOR_CYAN, -1)
+        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()
@@ -32,13 +33,14 @@ class Display:
         self.get_key()
 
     def panel_create(self, x, y):
-        """Create popup menus"""
+        """Create popup panels to a certain scale"""
         win = curses.newwin(x, y)
         panel = curses.panel.new_panel(win)
         win.erase()
         return (win, panel)
 
     def panel_up(self):
+        """Update panel and window contents"""
         curses.panel.update_panels()
         self.win.refresh()
 
@@ -47,11 +49,11 @@ class Display:
         if self.obj.getIdx() + 1 == len(self.stack):
             self.obj.setIdx(0)
 
-        progress.dump(self.stack, runner.get_orig())
+        progress.dump(self.stack, runner.get_orig()[1])
         sys.exit(0)
 
     def ntotal(self):
-        """Get toal number of starred cards"""
+        """Get total number of starred cards"""
         return [card for card in self.stack if card.getStar()]
 
     def disp_bar(self):
@@ -66,7 +68,7 @@ class Display:
             percent = "100"
         else:
             percent = str(
-                round(self.obj.getIdx() / len(self.stack) * 100)
+                round(self.obj.getIdx() / (len(self.stack) - 1) * 100)
             ).zfill(2)
 
         # Print yellow if starred
@@ -80,11 +82,11 @@ class Display:
         bar_middle = self.current_card().printStar()
         bar_end = (
             f"] [{len(self.ntotal())}/{str(len(self.stack))} starred] "
-            f"[{percent}% ("
-            + str(self.obj.getIdx() + 1).zfill(len(str(len(self.stack))))
-            f"/{str(len(self.stack))})] ["
-            f"{self.headers[self.current_card().getSide()]} ("
-            + f"{str(self.current_card().getSide()) + str(1)})] "
+            f"[{percent}% ("
+            f"{str(self.obj.getIdx()).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)})]"
         )
 
         # Put it all togethor
@@ -112,18 +114,15 @@ class Display:
         self.menu_grab()
 
     def menu_grab(self):
-        """Grab keypresses for the menu screen"""
+        """Grab keypresses on the menu screen"""
         while True:
             key = self.win.getkey()
-            if key in ["r", "q", "m"]:
+            if key in ["r", "m"]:
                 self.menu_panel.hide()
                 self.panel_up()
-            if key in ["q", "m"]:
-                if len(self.stack) == self.obj.getIdx() + 1:
-                    self.leave()
-                elif len(self.stack) < self.obj.getIdx() + 1:
-                    self.obj.setIdx(0)
                 self.get_key()
+            elif key == "q":
+                self.leave()
             elif key == "y":
                 self.stack = runner.get_orig()[1]
                 self.menu_print("Stack reset!")
@@ -171,14 +170,11 @@ class Display:
                 self.obj.setIdx(0)
                 self.get_key()
 
-    def menu_init(self, quit=True):
+    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()
-        # TODO: fix this
-        quit_text = "[q]: back"
-        if quit:
-            quit_text = "[q]: quit"
 
         self.menu_win.addstr(
             1, 1, "LIGHTCARDS MENU", curses.color_pair(1) + curses.A_BOLD
@@ -193,20 +189,21 @@ class Display:
             "[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.addstr(len(text) + 4, 1, "[r]: restart")
-        self.menu_win.addstr(len(text) + 5, 1, quit_text)
 
         self.menu_win.box()
         self.panel_up()
 
     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.
+        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)
@@ -217,7 +214,7 @@ class Display:
             self.menu_grab()
 
     def wrap_width(self):
-        """Calculate the width at which the body should wrap"""
+        """Calculate the width at which the body text should wrap"""
         (_, mcols) = self.win.getmaxyx()
         wrap_width = mcols - 20
         if wrap_width > 80:
@@ -226,7 +223,7 @@ class Display:
 
     def disp_card(self):
         """
-        Display the contents of the card
+        Display the contents of the card.
         Shows a header, a horizontal line, and the contents of the current
         side.
         """
@@ -281,7 +278,7 @@ class Display:
         self.win.hline(mlines - 2, 0, 0, mcols)
 
     def help_init(self):
-        """Display help screen"""
+        """Initialize help screen"""
         (self.help_win, self.help_panel) = self.panel_create(20, 52)
         self.help_panel.top()
         self.help_panel.hide()
@@ -307,7 +304,7 @@ class Display:
             "More information can be found in the man page, or",
             "by running `lightcards --help`.",
             "",
-            "Press [q], [H], or [?] to go back.",
+            "Press [H], or [?] to go back.",
         ]
 
         for t in enumerate(text):
@@ -316,17 +313,21 @@ class Display:
         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 in ["q", "H", "?"]:
+            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()]
 
     def get_key(self):
@@ -334,7 +335,6 @@ class Display:
         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()