CommonCodeCopierMenu.py

#!/usr/bin/python
import sys
import curses
import pyperclip

def draw_window(screen):
  # Initialize size, borders and color schema
  box_width        = 40
  box_height       = 9
  input_box_height = 5
  
  curses.start_color()
  winHeight, winWidth = screen.getmaxyx()
  curses.use_default_colors()
  curses.init_pair(1, curses.COLOR_RED,   -1)
  curses.init_pair(2, curses.COLOR_CYAN,  -1)
  curses.init_pair(3, curses.COLOR_GREEN, -1)
  
  # Read the textfile, make 
  Code = readFile()
  if (len(Code) + box_height > winHeight):
    raise IOError("Lines in input file exceeds number of lines vertically in window. Either grow window size or shrink file.")
  box_height = box_height + len(Code)
  
  # Capture the largest code written in the textfile and render the selection box based on the largest line
  widest = countWidestLine(Code)
  if (widest + 7 > winWidth): # The 7 includes all of the added borders around the edges.
    raise IOError("Lines in input file exceeds number of lines horizontally in window. Either grow window size or shrink file.")
  elif (widest > box_width - 7):
    box_width = widest + 7
  
  # Declaration of strings
  intro              = "Welcome to the"[:box_width-1]
  title              = "Common Code Copier"[:box_width-1]
  subtitle           = "by Eric McDaniel, November 2019"[:box_width-1]
  instructionsTop    = "Please choose one option from"[:box_width-1]
  instructionsBottom = "the following selection"[:box_width-1]
  enterSelection     = "Enter Selection: "[:box_width-1]
  customSelection    = "Type \'f\' for additional help"[:box_width-1]
  quitSelection      = "Or type \'q\' to quit"[:box_width-1]

  # Define x starting position for flexible window creation
  start_x_intro              = int((box_width // 2) - (len(intro + title) // 2) - len(intro) % 2) + 1
  start_x_title              = int((box_width // 2) -  len(title) % 2)
  start_x_subtitle           = int((box_width // 2) - (len(subtitle) // 2) - len(subtitle) % 2) + 2
  start_x_instructionsTop    = int((box_width // 2) - (len(instructionsTop) // 2) - len(instructionsTop) % 2) + 2
  start_x_instructionsBottom = int((box_width // 2) - (len(instructionsBottom) // 2) - len(instructionsBottom) % 2) + 2
  start_x_enterSelection     = int((box_width // 2) - (len(enterSelection) // 2) - len(enterSelection) % 2) + 2
  start_x_customSelection    = int((box_width // 2) - (len(customSelection) // 2) - len(customSelection) % 2) + 1
  start_x_quitSelection      = int((box_width // 2) - (len(quitSelection) // 2) - len(quitSelection) % 2) + 1
  
  # Render the text in appropriate location
  screen.addstr(1, start_x_intro, intro)
  screen.attron(curses.A_BOLD)
  screen.addstr(1, start_x_title, title, curses.color_pair(1))
  screen.attroff(curses.A_BOLD)
  screen.addstr(2, start_x_subtitle, subtitle)

  # Create main box and render centered instructions
  box1 = curses.newwin(box_height, box_width, 3, 1)
  box1.box()
  screen.refresh()
  box1.refresh()
  screen.addstr(4, start_x_instructionsTop, instructionsTop)
  screen.addstr(5, start_x_instructionsBottom, instructionsBottom)
  # Prints the horizontal bar across the top below the instructions
  for x in range(2, box_width):
    screen.addch(6, x, curses.ACS_HLINE)
  
  # Add the text file data
  row = 7 # starting row, after instructions and window box lines
  for line in Code:
    screen.addstr(row, 3, "{}. {}".format((row - 6), line.strip()))
    row = row + 1
    
  # Draw User selection box
  input_box = curses.newwin(input_box_height, box_width - 2, box_height - input_box_height + 4, 2)
  input_box.box()
  input_box.refresh()
  screen.addstr(box_height - input_box_height + 6, start_x_customSelection, customSelection, curses.color_pair(3))
  screen.addstr(box_height - input_box_height + 7, start_x_quitSelection, quitSelection, curses.color_pair(1))
  screen.addstr(box_height - input_box_height + 5, start_x_enterSelection, enterSelection, curses.color_pair(2))
  
  selection = screen.getch()
  # 113 = q, quit the application
  if (selection == 113): 
    sys.exit(0)
  # 102 = f, additional help menu
  elif (selection == 102):
    customizeClipboard(screen, Code)
  # Throw an exception if user input is improper
  elif (selection < 48 or selection > 48 + len(Code)):
    raise ValueError("Expected an integer such as 1, 2, ... , but got invalid input.")

  # Ascii value conversion of char 1 to decimal 1
  selection = selection - 49

  # 10 matches keyboard value of enter key, only save to clipboard when confirmed
  pyperclip.copy(Code[int(selection)].rstrip())


def customizeClipboard(screen, Code):
  screen.clear()
  box_width        = 40
  box_height       = 25
  input_box_height = 4
  winHeight, winWidth = screen.getmaxyx()
  if winHeight < box_height + 2:
    raise IOError("Lines in input file exceeds number of lines vertically in window. You must grow window size.")
  if winWidth < box_width + 2:
    raise IOError("Lines in input file exceeds number of lines horizontally in window. You must grow window size.")
  
  box1 = curses.newwin(box_height, box_width, 1, 1)
  box1.box()
  screen.refresh()
  box1.refresh()
  
  # Draw User selection box
  input_box = curses.newwin(input_box_height, box_width - 2, box_height - input_box_height + 2, 2)
  input_box.box()
  input_box.refresh()
  
  # Prints the horizontal bar across the top below the instructions
  for x in range(2, box_width):
    screen.addch(3, x, curses.ACS_HLINE)
  screen.addstr(4, 3, "1. Add a custom line of code")
  screen.addstr(5, 3, "2. Remove a custom line of code")
  screen.addstr(6, 3, "3. Get help and instructions")
  
  instructionsTop  = "What would you like to do?"[:box_width-1]
  enterSelection   = "Enter Selection: "[:box_width-1]
  explainSelection = "Instructions will print"[:box_width-1]

  # Define x starting position for flexible window creation
  start_x_instructionsTop    = int((box_width // 2) - (len(instructionsTop) // 2) - len(instructionsTop) % 2) + 2
  start_x_enterSelection     = int((box_width // 3) - (len(enterSelection) // 2) - len(enterSelection) % 2) + 2
  start_x_customSelection    = int((box_width // 2) - (len(explainSelection) // 2) - len(explainSelection) % 2) + 1
  screen.addstr(2, start_x_instructionsTop, instructionsTop, curses.color_pair(2))
  screen.addstr(box_height - input_box_height + 4, start_x_customSelection, explainSelection, curses.color_pair(3))
  screen.addstr(box_height - input_box_height + 3, start_x_enterSelection, enterSelection, curses.color_pair(2))
  
  addingCustomCode   = "Adding Custom Code"[:box_width-1]
  removingCustomCode = "Removing Custom Code"[:box_width-1]
  instructions = "Instructions"[:box_width-1]
  start_x_addingCustomCode   = int((box_width // 2) - (len(addingCustomCode) // 2) - len(addingCustomCode) % 2) + 2
  start_x_removingCustomCode = int((box_width // 2) - (len(removingCustomCode) // 2) - len(removingCustomCode) % 2) + 2
  start_x_instructions  = int((box_width // 2) - (len(instructions) // 2) - len(instructions) % 2) + 1
  
  selection = screen.getch()
  # Clear the options and Print all instructions
  for x in range(5):
    screen.addstr(4 + x, 3, "                                    ")
  if (int(selection) == 49):
    screen.addstr(5, start_x_addingCustomCode, addingCustomCode, curses.color_pair(3))
    screen.addstr(7, 3, "You can add custom lines of code to", curses.color_pair(2))
    screen.addstr(8, 3, "this program by nagivating to the", curses.color_pair(2))
    screen.addstr(9, 3, "directory where this script is saved.", curses.color_pair(2))
    screen.addstr(10, 3, "Included in that directory is a text", curses.color_pair(2))
    screen.addstr(11, 3, "file titled", curses.color_pair(2))
    screen.addstr(11, 15, "code-options.txt", curses.color_pair(3))
    screen.addstr(11, 32, "which", curses.color_pair(2))
    screen.addstr(12, 3, "stores all of the data rendered here.", curses.color_pair(2))
    screen.addstr(14, 3, "BEWARE!", curses.color_pair(1))
    screen.addstr(14, 11, "One of the first things this", curses.color_pair(2))
    screen.addstr(15, 3, "application does is check the size of", curses.color_pair(2))
    screen.addstr(16, 3, "the window before rendering any text.", curses.color_pair(2))
    screen.addstr(17, 3, "If there are more lines of code in", curses.color_pair(2))
    screen.addstr(18, 3, "that text file that can fit in this", curses.color_pair(2))
    screen.addstr(19, 3, "window, then this program will fail", curses.color_pair(2))
    screen.addstr(20, 3, "safely. Either grow your window or", curses.color_pair(2))
    screen.addstr(21, 3, "remove lines from the file.", curses.color_pair(2))
  elif (int(selection) == 50):
    screen.addstr(5, start_x_removingCustomCode, removingCustomCode, curses.color_pair(3))
    screen.addstr(7, 3, "The process to remove code from your", curses.color_pair(2))
    screen.addstr(8, 3, "clipboard is similar to the process", curses.color_pair(2))
    screen.addstr(9, 3, "of adding code. Navigate to the", curses.color_pair(2))
    screen.addstr(10, 3, "local directory that contains this", curses.color_pair(2))
    screen.addstr(11, 3, "script, and look for the file titled", curses.color_pair(2))
    screen.addstr(12, 3, "code-options.txt", curses.color_pair(3))
    screen.addstr(12, 19, " which contains all", curses.color_pair(2))
    screen.addstr(13, 3, "of the custom code snippets saved", curses.color_pair(2))
    screen.addstr(14, 3, "into memory.", curses.color_pair(2))
    screen.addstr(16, 3, "Remove desired lines from file", curses.color_pair(2))
    screen.addstr(17, 3, "avoiding gaps of space between lines.", curses.color_pair(2))
  elif (int(selection) == 51):
    screen.addstr(5, start_x_instructions, instructions, curses.color_pair(3))
    screen.addstr(7, 3, "This application's goal intent is to", curses.color_pair(2))
    screen.addstr(8, 3, "provide programmers (as well as", curses.color_pair(2))
    screen.addstr(9, 3, "non-programmers) a tool to improve", curses.color_pair(2))
    screen.addstr(10, 3, "their efficiency by providing an", curses.color_pair(2))
    screen.addstr(11, 3, "application that copies some of the", curses.color_pair(2))
    screen.addstr(12, 3, "most commonly typed syntax on to", curses.color_pair(2))
    screen.addstr(13, 3, "their clipboards.", curses.color_pair(2))
    screen.addstr(15, 3, "After having to write Java's infamous", curses.color_pair(2))
    screen.addstr(16, 3, "System.out.println();", curses.color_pair(3))
    screen.addstr(16, 24, " so many times", curses.color_pair(2))
    screen.addstr(17, 3, "for an assignment, I wanted an app", curses.color_pair(2))
    screen.addstr(18, 3, "that would make my time spent more", curses.color_pair(2))
    screen.addstr(19, 3, "efficiently and was as resource", curses.color_pair(2))
    screen.addstr(20, 3, "minimal as possible.", curses.color_pair(2))
    screen.addstr(box_height, 3, "                                    ")
    screen.addstr(box_height - 1, 3, "    Press any key for next page     ", curses.color_pair(3))
    screen.getch()
    for x in range(18):
      screen.addstr(4 + x, 3, "                                     ")
    instructions = "Instructions, continued"[:box_width-1]
    start_x_instructions  = int((box_width // 2) - (len(instructions) // 2) - len(instructions) % 2) + 1
    screen.addstr(5, start_x_instructions, instructions, curses.color_pair(3))
    screen.addstr(7, 3, "Primarily intended for Linux, use the", curses.color_pair(2))
    screen.addstr(8, 3, "accompanying bash shell script to", curses.color_pair(2))
    screen.addstr(9, 3, "launch the python script. A separate", curses.color_pair(2))
    screen.addstr(10, 3, "terminal window will open, which is", curses.color_pair(2))
    screen.addstr(11, 3, "intentional. Configure your keyboard", curses.color_pair(2))
    screen.addstr(12, 3, "layout with your window manager/ ", curses.color_pair(2))
    screen.addstr(13, 3, "desktop environment to execute the", curses.color_pair(2))
    screen.addstr(14, 3, "shell script, which opens the", curses.color_pair(2))
    screen.addstr(15, 3, "terminal runs the python script.", curses.color_pair(2))
    screen.addstr(17, 3, "When configured correctly, running", curses.color_pair(2))
    screen.addstr(18, 3, "the program should take no more than", curses.color_pair(2))
    screen.addstr(19, 3, "two keystrokes. The first to launch", curses.color_pair(2))
    screen.addstr(20, 3, "the program, and the second as your", curses.color_pair(2))
    screen.addstr(21, 3, "numerical selection of options.", curses.color_pair(2))
    
  elif (int(selection) < 49 or int(selection) > 51):
    raise ValueError("Expected an integer such as 1, 2, ... , but got invalid input.")
  
  screen.addstr(box_height, 3, "                                    ")
  screen.addstr(box_height - 1, 3, "        Press any key to exit       ", curses.color_pair(1))
  screen.getch()
  sys.exit(0)  

# Returns the list of copy/pastable codes saved from the text file
def readFile():
  clipboard = open("code-options.txt", "r")
  count = 1
  codeList = []
  for line in clipboard:
    codeList.append(line)
    count = count + 1    
  clipboard.close()
  return codeList

# Helper method determines which is the widest line in the collection for rendering the window
def countWidestLine(Code):
  countWidest = 0
  widest = 0
  for line in Code:
    for letter in line:
      countWidest = countWidest + 1
    if (countWidest > widest):
      widest = countWidest
    countWidest = 0
  return widest

def main():
  draw_window(curses.initscr())

if __name__ == '__main__':
  try:
    main()
  except KeyboardInterrupt:
    sys.exit(1)
  except ValueError:
    sys.exit(2)
  except IOError:
    sys.exit(3)