]> git.armaanb.net Git - lightcards.git/blobdiff - lightcards/display.py
Add menu keybindings to config
[lightcards.git] / lightcards / display.py
index 386058f474bdd50eb6df755aacb235c2c17cb2ac..8f739e64865629d28cdf28baac35944b134a2409 100644 (file)
@@ -60,33 +60,44 @@ class Quit:
                     self.outer.get_key()
 
 
-class Help:
-    def __init__(self, outer, mlines=21, mcols=52):
-        """Initialize help screen"""
+class Panel:
+    def __init__(self, outer, mlines, mcols):
         self.outer = outer
         (self.win, self.panel) = panel_create(mlines, mcols)
         self.panel.top()
         self.panel.hide()
 
+    def config_get(self, setting, cut=28):
+        return str(list(self.outer.config[setting][:cut])).replace("'", "")
+
+
+class Help(Panel):
+    def __init__(self, outer, mlines=23, mcols=52):
+        """Initialize help screen"""
+        super().__init__(outer, mlines, mcols)
+        c = self.config_get
+
         text = [
-            "Welcome to Lightcards. Here are the default",
-            "keybindings to get you started:",
+            "Welcome to Lightcards. 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",
-            "m                open the control menu",
-            "1, 2, 3          switch views",
-            "q                quit",
+            f"{c('card_prev')}: previous card",
+            f"{c('card_next')}: next card",
+            f"{c('card_flip')}: flip card",
+            f"{c('card_star')}: star card",
+            f"{c('card_first')}: go to first card",
+            f"{c('card_last')}: go to last card",
+            f"{c('help_disp')}: open this help menu",
+            f"{c('menu_disp')}: open the control menu",
+            f"{c('view_one')}: switch to view one",
+            f"{c('view_two')}: switch to view two",
+            f"{c('view_three')}: switch to view three",
+            f"{c('quit_key')}: quit",
             "",
             "More information can be found in the man page, or",
             "by running `lightcards --help`.",
             "",
-            "Press [H], or [?] to go back.",
+            f"Press {c('help_disp')} to go back.",
         ]
 
         self.win.addstr(
@@ -105,25 +116,23 @@ class Help:
     def disp(self):
         """Display help screen"""
         (mlines, mcols) = self.outer.win.getmaxyx()
-        self.win.mvwin(int(mlines / 2) - 11, int(mcols / 2) - 25)
+        self.win.mvwin(int(mlines / 2) - 12, int(mcols / 2) - 25)
         self.panel.show()
 
         while True:
             key = self.win.getkey()
-            if key == "q":
+            if key in self.outer.config["quit_key"]:
                 self.outer.leave()
-            elif key in ["H", "?"]:
+            elif key in self.outer.config["help_disp"]:
                 self.panel.hide()
                 self.outer.get_key()
 
 
-class Menu:
+class Menu(Panel):
     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()
+        super().__init__(outer, mlines, mcols)
+        c = self.config_get
 
         self.win.addstr(
             1,
@@ -132,18 +141,19 @@ class Menu:
             curses.color_pair(1) + curses.A_BOLD,
         )
         self.win.hline(2, 1, curses.ACS_HLINE, mcols)
+        env = os.environ.get("EDITOR", "$EDITOR")[:15]
         text = [
-            "[y]: reset stack to original state",
-            "[a]: alphabetize stack",
-            "[z]: shuffle stack",
-            "[t]: reverse stack order",
-            "[u]: unstar all",
-            "[d]: star all",
-            "[s]: update stack to include starred only",
-            "[e]: open the input file in $EDITOR",
+            f"{c('menu_reset')}: reset stack to original state",
+            f"{c('menu_alphabetize')}: alphabetize stack",
+            f"{c('menu_shuffle')}: shuffle stack",
+            f"{c('menu_reverse')}: reverse stack order",
+            f"{c('menu_unstar')}: unstar all",
+            f"{c('menu_star')}: star all",
+            f"{c('menu_stars_only')}: update stack to include starred only",
+            f"{c('menu_open_file')}: open the input file in {env}",
             "",
-            "[r]: restart",
-            "[m]: close menu",
+            f"{c('menu_restart')}: restart",
+            f"{c('menu_disp')}: close menu",
         ]
 
         for t in enumerate(text):
@@ -151,6 +161,10 @@ class Menu:
 
         self.win.box()
 
+    def clear_msg(self):
+        for i in range(42):
+            self.win.addch(15, i + 1, " ")
+
     def menu_print(self, string, err=False):
         """Print messages on the menu screen"""
         if err:
@@ -165,37 +179,42 @@ class Menu:
         """Grab keypresses on the menu screen"""
         while True:
             key = self.win.getkey()
-            if key in ["r", "m"]:
+            if (
+                key
+                in self.outer.config["menu_disp"]
+                + self.outer.config["menu_restart"]
+            ):
                 self.panel.hide()
                 self.outer.get_key()
-            elif key == "q":
+            elif key in self.outer.config["quit_key"]:
                 self.outer.leave()
-            elif key == "y":
+            elif key in self.outer.config["menu_reset"]:
                 self.outer.stack = runner.get_orig()[1]
                 self.menu_print("Stack reset!")
-            elif key == "a":
+            elif key in self.outer.config["menu_alphabetize"]:
                 self.outer.stack.sort(key=lambda x: x.front)
                 self.menu_print("Stack alphabetized!")
-            elif key == "u":
+            elif key in self.outer.config["menu_unstar"]:
                 [x.unStar() for x in self.outer.stack]
                 self.menu_print("All unstarred!")
-            elif key == "d":
+            elif key in self.outer.config["menu_star"]:
                 [x.star() for x in self.outer.stack]
                 self.menu_print("All starred!")
-            elif key == "t":
+            elif key in self.outer.config["menu_reverse"]:
                 self.outer.stack.reverse()
                 self.menu_print("Stack reversed!")
-            elif key == "z":
+            elif key in self.outer.config["menu_shuffle"]:
                 shuffle(self.outer.stack)
                 self.menu_print("Stack shuffled!")
-            elif key == "e":
+            elif key in self.outer.config["menu_open_file"]:
+                progress.dump(self.outer.stack, runner.get_orig()[1])
                 curses.endwin()
                 os.system(f"$EDITOR {self.outer.input_file}"),
                 (self.outer.headers, self.outer.stack) = parse.parse_html(
                     parse.md2html(self.outer.input_file)
                 )
                 self.outer.get_key()
-            elif key == "s":
+            elif key in self.outer.config["menu_stars_only"]:
                 # Check if there are any starred cards before proceeding, and
                 # if not, don't allow to proceed and show an error message
                 cont = False
@@ -211,7 +230,7 @@ class Menu:
                     self.menu_print("Stars only!")
                 else:
                     self.menu_print("ERR: None are starred!", err=True)
-            elif key == "r":
+            elif key in self.outer.config["menu_restart"]:
                 self.outer.obj.index = 0
                 self.outer.get_key()
 
@@ -220,8 +239,7 @@ class Menu:
         Display a menu offering multiple options on how to manipulate the deck
         and to continue
         """
-        for i in range(42):
-            self.win.addch(14, i + 1, " ")
+        self.clear_msg()
 
         (mlines, mcols) = self.outer.win.getmaxyx()
         self.win.mvwin(int(mlines / 2) - 8, int(mcols / 2) - 22)
@@ -244,9 +262,9 @@ class Display:
         self.win = stdscr
         curses.curs_set(0)  # Hide cursor
         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)
+        curses.init_pair(1, self.config["highlight_color"], -1)
+        curses.init_pair(2, self.config["error_color"], -1)
+        curses.init_pair(3, self.config["starred_color"], -1)
 
         self.main_panel = curses.panel.new_panel(self.win)
         self.menu_obj = Menu(self)
@@ -351,10 +369,11 @@ class Display:
                 - 1
             )
         ):
-            # TODO: Use the variying width unicode block characters to make a
-            # super accurate bar
             self.win.addch(
-                height + 1, i + len(progress), "ยป", curses.color_pair(1)
+                height + 1,
+                i + len(progress),
+                self.config["progress_char"],
+                curses.color_pair(1),
             )
 
     def wrap_width(self):
@@ -469,7 +488,7 @@ class Display:
         while True:
             self.check_size()
             key = self.win.getkey()
-            if key == "q":
+            if key in self.config["quit_key"]:
                 self.leave()
             elif key in self.config["card_prev"]:
                 self.obj.back()
@@ -477,7 +496,8 @@ class Display:
                 self.disp_card()
             elif key in self.config["card_next"]:
                 if self.obj.index + 1 == len(self.stack):
-                    self.menu_obj.disp()
+                    if self.config["show_menu_at_end"]:
+                        self.menu_obj.disp()
                 else:
                     self.obj.forward(self.stack)
                     self.current_card().side = 0