Add help screen and create disp_init() function

[lightcards.git] / lightcards / display.py

diff --git a/lightcards/display.py b/lightcards/display.py
index aa13c05e38809089f7e236f6d901f1f54a66895f..bdad1d1e3c82acdef7dfec5da5167cfb9f9d0795 100755 (executable)
--- a/lightcards/display.py
+++ b/lightcards/display.py
@@ -3,6 +3,8 @@
 
 import curses
 from random import shuffle
+import sys
+import textwrap
 
 
 def disp_bar(stdscr, stack, headers, obj):
@@ -24,12 +26,15 @@ def disp_bar(stdscr, stack, headers, obj):
                   ")]" +
                   " [" +
                   headers[obj.getSide()] +
-                  "]")
+                  " (" +
+                  str(obj.getSide() + 1) +
+                  ")]", curses.color_pair(1))
 
 
 def disp_menu(stdscr, stack, headers, idx):
-    stdscr.addstr("Good job, you've completed a round!\n\n" +
-                  "Choose one of the following options:\n" +
+    stdscr.addstr("Good job, you've completed a round!\n\n",
+                  curses.color_pair(1))
+    stdscr.addstr("Choose one of the following options:\n" +
                   "[r]: restart\n" +
                   "[s]: restart with starred only\n" +
                   "[u]: restart and unstar all\n" +
@@ -38,7 +43,7 @@ def disp_menu(stdscr, stack, headers, idx):
     while True:
         key = stdscr.getkey()
         if key == "q":
-            exit(0)
+            sys.exit(0)
         elif key == "r":
             idx.setIdx(0)
             get_key(stdscr, stack, headers, idx)
@@ -59,7 +64,8 @@ def disp_menu(stdscr, stack, headers, idx):
                 get_key(stdscr, stack, headers, idx)
             else:
                 stdscr.clear()
-                stdscr.addstr("ERR: Stack empty. Choose another option\n\n")
+                stdscr.addstr("ERR: Stack empty. Choose another option\n\n",
+                              curses.color_pair(2))
                 disp_menu(stdscr, stack, headers, idx)
         elif key == "z":
             idx.setIdx(0)
@@ -69,34 +75,71 @@ def disp_menu(stdscr, stack, headers, idx):
 
 def disp_card(stdscr, stack, headers, obj):
     stdscr.clear()
+    (mlines, mcols) = stdscr.getmaxyx()
     if obj.getIdx() == len(stack):
         disp_menu(stdscr, stack, headers, obj)
     else:
         if obj.getSide() == 0:
-            top = headers[obj.getSide()] + " " + str(obj.getIdx() + 1) + "\n"
+            top = str(obj.getIdx() + 1) + " | " + headers[obj.getSide()]
         else:
-            top = headers[obj.getSide()] + " " + str(obj.getIdx() + 1) + \
-                "; " + str(stack[obj.getIdx()][0]) + "\n"
+            top = str(obj.getIdx() + 1) + " | " + headers[obj.getSide()] \
+                + " | \"" + str(stack[obj.getIdx()][0]) + "\""
+        header_width = mcols
+        if mcols > 80:
+            header_width = 80
+
+        stdscr.addstr(textwrap.shorten(top, width=header_width,
+                                       placeholder="…"), curses.A_BOLD)
 
-        stdscr.addstr(top)
-        (mlines, mcols) = stdscr.getmaxyx()
-        if len(top) < mcols:
-            mcols = len(top)
-        for i in range(mcols):
-            stdscr.addch("=")
+        # Add horizontal line
+        lin_width = header_width
+        if len(top) < header_width:
+            lin_width = len(top)
+        stdscr.hline(1, 0, curses.ACS_HLINE, lin_width)
 
-        stdscr.addstr("\n" + str(stack[obj.getIdx()][obj.getSide()]))
+        # Show current side
+        wrap_width = mcols
+        if mcols > 80:
+            wrap_width = 80
+        stdscr.addstr(2, 0, textwrap.fill(stack[obj.getIdx()][obj.getSide()],
+                                          width=wrap_width))
     disp_bar(stdscr, stack, headers, obj)
 
 
-def get_key(stdscr, stack, headers, idx):
+def disp_help(stdscr, stack, headers, idx):
+    stdscr.clear()
+    stdscr.addstr("LIGHTCARDS HELP SCREEN", curses.color_pair(1))
+    stdscr.hline(1, 0, curses.ACS_HLINE, 23)
+    stdscr.addstr(2, 0,
+                  "Welcome to lightcards. Here are some keybindings to get\n" +
+                  "you started.\n\n" +
+                  "h, left            previous card\n" +
+                  "l, right           next card\n" +
+                  "j, k, up, down     flip card\n" +
+                  "i, /               star card\n" +
+                  "0, ^, home         go to start of deck\n" +
+                  "$, end             go to end of deck\n" +
+                  "H, ?               open this screen\n\n" +
+                  "More information can be found in the man page.\n" +
+                  "Press [q], [H], or [?] to go back.")
+    while True:
+        key = stdscr.getkey()
+        if key in ["q", "H", "?"]:
+            get_key(stdscr, stack, headers, idx)
+
+
+def init_disp(stdscr, stack, headers, idx):
     curses.curs_set(0)
-    disp_card(stdscr, stack, headers, idx)
+    curses.init_pair(1, curses.COLOR_CYAN, 0)
+    curses.init_pair(2, curses.COLOR_RED, 0)
+    get_key(stdscr, stack, headers, idx)
 
+def get_key(stdscr, stack, headers, idx):
+    disp_card(stdscr, stack, headers, idx)
     while True:
         key = stdscr.getkey()
         if key == "q":
-            exit(0)
+            sys.exit(0)
         elif key in ["l", "KEY_LEFT"]:
             idx.forward(stack)
             idx.setSide(0)
@@ -113,7 +156,11 @@ def get_key(stdscr, stack, headers, idx):
             disp_card(stdscr, stack, headers, idx)
         elif key in ["0", "^", "KEY_HOME"]:
             idx.setIdx(0)
+            idx.setSide(0)
             disp_card(stdscr, stack, headers, idx)
         elif key in ["$", "KEY_END"]:
             idx.setIdx(len(stack) - 1)
+            idx.setSide(0)
             disp_card(stdscr, stack, headers, idx)
+        elif key in ["H", "?"]:
+            disp_help(stdscr, stack, headers, idx)