# 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
+def disp_bar(stdscr, stack, headers, obj):
+ """
+ Display the statusbar at the bottom of the screen with progress, star
+ status, and card side.
+ """
+ (mlines, mcols) = stdscr.getmaxyx()
- def flip(self):
- if self.side == 0:
- self.side = 1
- else:
- self.side = 0
+ # Calculate percent done
+ if len(stack) <= 1:
+ percent = "100"
+ else:
+ percent = str(round(obj.getIdx() / (len(stack) - 1) * 100)).zfill(3)
- def setSide(self, inp):
- self.side = inp
+ # Print yellow if starred
+ stdscr.addstr(mlines - 1, 0, "[", curses.color_pair(1))
+ if stack[obj.getIdx()].getStar():
+ stdscr.addstr(stack[obj.getIdx()].printStar(), curses.color_pair(3))
+ else:
+ stdscr.addstr(stack[obj.getIdx()].printStar(), curses.color_pair(1))
- def getSide(self):
- return self.side
+ # Put all the info together
+ stdscr.addstr("] [" +
+ percent +
+ "% (" +
+ str(obj.getIdx() + 1).zfill(len(str(len(stack)))) +
+ "/" +
+ str(len(stack)) +
+ ")]" +
+ " [" +
+ headers[obj.getSide()] +
+ " (" +
+ str(obj.getSide() + 1) +
+ ")]", curses.color_pair(1))
- def getIdx(self):
- return self.index
+def disp_menu(stdscr, stack, headers, idx):
+ """
+ Display a menu once the end of the deck has been reached, offering
+ multiple options on how to continue.
+ """
+ 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" +
+ "[z]: restart and shuffle cards\n" +
+ "[f]: restart and show the other side first\n" +
+ "[t]: restart in reverse order\n" +
+ "[q]: quit")
+ while True:
+ key = stdscr.getkey()
+ if key == "q":
+ sys.exit(0)
+ elif key == "r":
+ idx.setIdx(0)
+ get_key(stdscr, stack, headers, idx)
+ 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 stack:
+ if x.getStar():
+ cont = True
-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()]))
+ if cont:
+ idx.setIdx(0)
+ stack = [x for x in stack if x.getStar()]
+ get_key(stdscr, stack, headers, idx)
+ else:
+ stdscr.clear()
+ stdscr.addstr("ERR: Stack empty. Choose another option\n\n",
+ curses.color_pair(2))
+ disp_menu(stdscr, stack, headers, idx)
+ elif key == "u":
+ idx.setIdx(0)
+ for x in stack:
+ x.unStar()
+ get_key(stdscr, stack, headers, idx)
+ elif key == "z":
+ idx.setIdx(0)
+ shuffle(stack)
+ get_key(stdscr, stack, headers, idx)
+ elif key == "f":
+ idx.setIdx(0)
+ for x in stack:
+ x[0], x[1] = x[1], x[0]
+ headers[0], headers[1] = headers[1], headers[0]
+ get_key(stdscr, stack, headers, idx)
+ elif key == "t":
+ idx.setIdx(0)
+ stack.reverse()
+ get_key(stdscr, stack, headers, idx)
+def disp_card(stdscr, stack, headers, obj):
+ """
+ Display the contents of the card
+ Shows a header, a horizontal line, and the contents of the current side.
+ """
+ stdscr.clear()
(mlines, mcols) = stdscr.getmaxyx()
- mlines -= 1
- mcols -= 5
-
- try:
- stdscr.insch(mlines, mcols, str(obj.getIdx() + 1))
- stdscr.insch(mlines, mcols+1, '-')
+ if obj.getIdx() == len(stack):
+ disp_menu(stdscr, stack, headers, obj)
+ else:
+ # If on the back of the card, show the content of the front side in the
+ # header
+ num_done = str(obj.getIdx() + 1).zfill(len(str(len(stack))))
if obj.getSide() == 0:
- stdscr.insch(mlines, mcols+2, '1')
+ top = num_done + " | " + headers[obj.getSide()]
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)
+ top = num_done + " | " + 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)
+
+ # 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)
+ # 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 disp_help(stdscr, stack, headers, idx):
+ """Display help screen"""
+ stdscr.clear()
+ stdscr.addstr("LIGHTCARDS HELP", curses.color_pair(1) + curses.A_BOLD)
+ stdscr.hline(1, 0, curses.ACS_HLINE, 15)
+ 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 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\n" +
+ "More information can be found in the man page, or by\n" +
+ "running `lightcards --help`.\n\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):
+ """Initialize curses options. Entrypoint into the display functions."""
+ 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)
+ get_key(stdscr, stack, headers, idx)
+
+
+def get_key(stdscr, stack, headers, idx):
+ """
+ Display a card and wait for the input.
+ Used as a general way of getting back into the card flow from a menu
+ """
+
+ disp_card(stdscr, stack, headers, idx)
while True:
key = stdscr.getkey()
- try:
- if key == "q" or key == os.linesep:
- exit(0)
- if key == "j":
- idx.forward(stack)
- idx.setSide(0)
- disp_card(stdscr, stack, headers, idx)
- if key == "k":
- idx.back()
- idx.setSide(0)
- disp_card(stdscr, stack, headers, idx)
- if key == "l" or key == "h":
- idx.flip()
- disp_card(stdscr, stack, headers, idx)
- except Exception:
- pass
+ if key == "q":
+ sys.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)
+ elif key in ["j", "k", "KEY_UP", "KEY_DOWN"]:
+ idx.flip()
+ disp_card(stdscr, stack, headers, idx)
+ elif key in ["i", "/"]:
+ stack[idx.getIdx()].toggleStar()
+ 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)
+ elif key == "e":
+ (headers, stack) = lightcards.reparse()
+ get_key(stdscr, stack, headers, idx)