crosswordpuzzlecreator.py

   1 # Get A Clue (C) 2010 V. Harishankar
   2 # Crossword puzzle maker program
   3 # Licensed under the GNU GPL v3
   4
   5 # Cross puzzle creator class
   6 import sys
   7 import cPickle
   8 import readline
   9
  10 import crosswordpuzzle
  11
  12 class CrosswordPuzzleCreator:
  13         # ansi color codes for grid display
  14         BRICKRED = '\033[31m'
  15         # bold
  16         BOLD = '\033[33m'
  17         # blue
  18         BLUE = '\033[34m'
  19         # grey
  20         GREY = '\033[30m'
  21         # Black background white text
  22         BLACK_BG = '\033[40;1;37m'
  23         # white background black text
  24         WHITE_BG = '\033[47;1;30m'
  25         # white background red text
  26         REDWHITE_BG = '\033[47;1;31m'
  27         # disable colors
  28         ENDCOL = '\033[0m'
  29
  30         def __init__ (self):
  31                 self.do_main_loop ()
  32                 self.current_file = None
  33                 self.puzzle = None
  34
  35         # save the puzzle
  36         def save_puzzle (self):
  37                 if self.current_file:
  38                         fpuzzle = open (self.current_file, "wb")
  39                         cPickle.dump (self.puzzle, fpuzzle, cPickle.HIGHEST_PROTOCOL)
  40                         sys.stdout.write (self.BLUE + "Puzzle saved to: " +
  41                                                 self.current_file + "\n" + self.ENDCOL)
  42
  43         # load the puzzle
  44         def load_puzzle (self):
  45                 if self.current_file:
  46                         fpuzzle = open (self.current_file, "rb")
  47                         self.puzzle = cPickle.load (fpuzzle)
  48
  49         # display the grid with words
  50         def print_puzzle (self, no_words=False):
  51                 # if self.puzzle is not none
  52                 if self.puzzle:
  53                         # get row, col and print them (with grid number if set)
  54                         for col in range (self.puzzle.cols):
  55                                 # print the first row as column headers
  56                                 sys.stdout.write (self.BLUE + '  %02d' % col + self.ENDCOL)
  57                         sys.stdout.write ("\n")
  58
  59                         for row in range (self.puzzle.rows):
  60                                 for col in range (self.puzzle.cols):
  61                                         # print the data
  62                                         # if the cell is numbered i.e. start of a word
  63                                         if self.puzzle.data[row][col].numbered != 0:
  64                                                 sys.stdout.write (self.REDWHITE_BG +
  65                                                 '%02d ' % self.puzzle.data[row][col].numbered + self.ENDCOL)
  66                                         # print spaces
  67                                         else:
  68                                                 if self.puzzle.data[row][col].char == "#":
  69                                                         sys.stdout.write (self.BLACK_BG + '   ' + self.ENDCOL)
  70                                                 else:
  71                                                         sys.stdout.write (self.WHITE_BG + '   ' + self.ENDCOL)
  72                                         # if the character is not a blank or a block
  73                                         if (self.puzzle.data[row][col].char <> "." and
  74                                                                                 self.puzzle.data[row][col].char <> "#"):
  75                                                 # if words are to be shown regardless of hidden/revealed state
  76                                                 if no_words is False:
  77                                                         sys.stdout.write (self.WHITE_BG +
  78                                                                 self.puzzle.data[row][col].char + self.ENDCOL)
  79                                                 else:
  80                                                         # display only revealed
  81                                                         if self.puzzle.data[row][col].revealed is True:
  82                                                                 sys.stdout.write (self.WHITE_BG +
  83                                                                         self.puzzle.data[row][col].char + self.ENDCOL)
  84                                                         # else print a blank
  85                                                         else:
  86                                                                 sys.stdout.write (self.WHITE_BG + '.' + self.ENDCOL)
  87                                         elif self.puzzle.data[row][col].char == '.':
  88                                                 sys.stdout.write (self.WHITE_BG +
  89                                                                 self.puzzle.data[row][col].char + self.ENDCOL)
  90                                         elif self.puzzle.data[row][col].char == '#':
  91                                                 sys.stdout.write (self.BLACK_BG + " " + self.ENDCOL)
  92
  93                                 sys.stdout.write (' ' + self.BLUE + "%2d" % row + self.ENDCOL + "\n")
  94                         raw_input (self.BRICKRED + "Press <return> to continue" + self.ENDCOL)
  95
  96         # display existing clues
  97         def on_display_clues (self):
  98                 try:
  99                         aclues = self.puzzle.get_clues_across ()
 100                         sys.stdout.write (self.BOLD + "\n------------\n")
 101                         sys.stdout.write ("Across words\n")
 102                         sys.stdout.write ("------------\n" + self.ENDCOL)
 103
 104                         for word, clue in aclues:
 105                                 sys.stdout.write (self.BOLD + word[0] + ": " + self.ENDCOL)
 106                                 if clue:
 107                                         sys.stdout.write (self.BLUE + clue + "\n" + self.ENDCOL)
 108                                 else:
 109                                         sys.stdout.write (self.BLUE + "(No clue yet)\n" + self.ENDCOL)
 110                 except crosswordpuzzle.NoWordsException:
 111                         sys.stderr.write ("No words across\n")
 112
 113                 try:
 114                         dclues = self.puzzle.get_clues_down ()
 115                         sys.stdout.write (self.BOLD + "\n----------\n")
 116                         sys.stdout.write ("Down words\n")
 117                         sys.stdout.write ("----------\n" + self.ENDCOL)
 118
 119                         for word, clue in dclues:
 120                                 sys.stdout.write (self.BOLD + word[0] + ": " + self.ENDCOL)
 121                                 if clue:
 122                                         sys.stdout.write (self.BLUE + clue + "\n" + self.ENDCOL)
 123                                 else:
 124                                         sys.stdout.write (self.BLUE + "(No clue yet)\n" + self.ENDCOL)
 125                 except crosswordpuzzle.NoWordsException:
 126                         sys.stderr.write ("No words down\n")
 127
 128                 raw_input (self.BRICKRED + "Press <return> to continue" + self.ENDCOL)
 129
 130         # set a clue to a word
 131         def on_set_clue (self):
 132                 self.print_puzzle ()
 133                 # get the row and column
 134                 srow = raw_input (self.BRICKRED + "At row: " + self.ENDCOL)
 135                 scol = raw_input (self.BRICKRED + "At col: " + self.ENDCOL)
 136                 # try converting it to number
 137                 try:
 138                         row = int (srow)
 139                         col = int (scol)
 140                 except ValueError:
 141                         sys.stderr.write ("Invalid row or column\n")
 142                         return
 143
 144                 try:
 145                         # across word set the clue if found
 146                         aword, arow, acol, alen = self.puzzle.get_word_across (row, col)
 147                         sys.stdout.write (self.BLUE + "Across word at position: " + aword + "\n" + self.ENDCOL)
 148                         clue = raw_input (self.BRICKRED + "Clue for across word: " + self.ENDCOL)
 149                         if clue:
 150                                 self.puzzle.data[arow][acol].clue_across = clue
 151                                 sys.stdout.write (self.BLUE + "Set clue: \n" + self.puzzle.data[arow][acol].clue_across)
 152                 except crosswordpuzzle.NoWordException:
 153                         sys.stderr.write ("No across word found at that position\n")
 154
 155                 try:
 156                         # down word set the clue if found
 157                         dword, drow, dcol, dlen = self.puzzle.get_word_down (row, col)
 158                         sys.stdout.write (self.BLUE + "Down word at position: " + dword + "\n" + self.ENDCOL)
 159                         clue = raw_input (self.BRICKRED + "Clue for down word: " + self.ENDCOL)
 160                         if clue:
 161                                 self.puzzle.data[drow][dcol].clue_down = clue
 162                                 sys.stdout.write (self.BLUE + "Set clue: \n" + self.puzzle.data[drow][dcol].clue_down)
 163                 except crosswordpuzzle.NoWordException:
 164                         sys.stderr.write ("No down word found at that position\n")
 165
 166         # add a word to the puzzle
 167         def on_add_word (self, across=True):
 168                 # first display the grid
 169                 self.print_puzzle ()
 170                 # get the row and column
 171                 srow = raw_input (self.BRICKRED + "Start row: " + self.ENDCOL)
 172                 scol = raw_input (self.BRICKRED + "Start col: " + self.ENDCOL)
 173                 # try converting it to number
 174                 try:
 175                         row = int (srow)
 176                         col = int (scol)
 177                 except ValueError:
 178                         sys.stderr.write ("Invalid row or column\n")
 179                         return
 180                 # get the word
 181                 word = raw_input (self.BRICKRED + "Word: " + self.ENDCOL)
 182
 183                 # try to add the word to the puzzle grid
 184                 try:
 185                         if across == True:
 186                                 self.puzzle.set_word_across (row, col, word)
 187                         else:
 188                                 self.puzzle.set_word_down (row, col, word)
 189                 except crosswordpuzzle.TooLongWordException:
 190                         sys.stderr.write ("Word is too long to fit in the grid! Aborting.\n")
 191                 except crosswordpuzzle.IntersectWordException:
 192                         sys.stderr.write ("Word intersects badly with another word!\n")
 193                 except crosswordpuzzle.FrozenGridException:
 194                         sys.stderr.write ("Word cannot be added to a frozen puzzle.\n")
 195
 196         # Export to across lite
 197         def on_export_acrosslite (self):
 198                 try:
 199                         sys.stdout.write (self.BLUE + "Exporting to AcrossLite(tm) Format\n" +
 200                                                 self.ENDCOL)
 201                         title = raw_input (self.BRICKRED + "Puzzle title: " + self.ENDCOL)
 202                         name = raw_input (self.BRICKRED + "Author name: " + self.ENDCOL)
 203                         copyright = raw_input (self.BRICKRED + "Copyright: " + self.ENDCOL)
 204                         exportfile = raw_input (self.BRICKRED + "Export to file: " + self.ENDCOL)
 205
 206                         acrosslite_str = self.puzzle.export_acrosslite (title, name, copyright)
 207                         fexport = open (exportfile, "w")
 208                         fexport.write (acrosslite_str)
 209                         fexport.close ()
 210                         sys.stdout.write (self.BLUE + "Exported AcrossLite(tm) File: " +
 211                                 exportfile + "\n" + self.ENDCOL)
 212                 except crosswordpuzzle.FrozenGridException:
 213                         sys.stderr.write ("Cannot export as grid is not frozen/finalized\n")
 214                 except crosswordpuzzle.NoWordsException:
 215                         sys.stderr.write ("No words to export!\n")
 216
 217         # Puzzle loop
 218         def do_puzzle_loop (self):
 219                 # there is a current file
 220                 if self.current_file and self.puzzle:
 221                         while True:
 222                                 sys.stdout.write (self.BOLD + "\n-----------------------------------\n")
 223                                 sys.stdout.write ("Puzzle: " + self.current_file + "\n")
 224                                 sys.stdout.write ("-----------------------------------" + self.ENDCOL + "\n")
 225                                 sys.stdout.write (self.BLUE + "1. Display grid\n")
 226                                 sys.stdout.write ("2. Add across word\n")
 227                                 sys.stdout.write ("3. Add down word\n")
 228                                 sys.stdout.write ("4. Remove across word\n")
 229                                 sys.stdout.write ("5. Remove down word\n")
 230                                 sys.stdout.write ("6. Freeze grid\n")
 231                                 sys.stdout.write ("7. Unfreeze grid\n")
 232                                 sys.stdout.write ("8. Set clue for word\n")
 233                                 sys.stdout.write ("9. Display clues\n")
 234                                 sys.stdout.write ("S. Save puzzle\n")
 235                                 sys.stdout.write ("E. Export to AcrossLite(TM) format\n")
 236                                 sys.stdout.write ("X. Exit to main menu\n" + self.ENDCOL)
 237                                 ch = raw_input (self.BRICKRED + "Your choice: " + self.ENDCOL)
 238                                 if ch == "1":
 239                                         self.print_puzzle ()
 240                                 elif ch == "2":
 241                                         self.on_add_word ()
 242                                 elif ch == "3":
 243                                         self.on_add_word (False)
 244                                 elif ch == "6":
 245                                         self.puzzle.freeze_grid ()
 246                                 elif ch == "7":
 247                                         self.puzzle.unfreeze_grid ()
 248                                 elif ch == "8":
 249                                         self.on_set_clue ()
 250                                 elif ch == "9":
 251                                         self.on_display_clues ()
 252                                 elif ch == "S" or ch == "s":
 253                                         self.save_puzzle ()
 254                                 elif ch == "E" or ch == "e":
 255                                         self.on_export_acrosslite ()
 256                                 elif ch == "X" or ch == "x":
 257                                         break
 258
 259         # when user chooses new puzzle
 260         def on_new_puzzle (self):
 261                 self.current_file = raw_input (self.BRICKRED + "New puzzle file name: "
 262                                         + self.ENDCOL)
 263                 srows = raw_input (self.BRICKRED + "Number of rows: " + self.ENDCOL)
 264                 scols = raw_input (self.BRICKRED + "Number of cols: " + self.ENDCOL)
 265                 try:
 266                         rows = int (srows)
 267                         cols = int (scols)
 268                 except ValueError:
 269                         sys.stderr.write ("Invalid number of rows/columns")
 270                         return
 271                 self.puzzle = crosswordpuzzle.CrosswordPuzzle (rows, cols)
 272                 self.do_puzzle_loop ()
 273
 274         # when user chooses to load puzzle
 275         def on_load_puzzle (self):
 276                 self.current_file = raw_input (self.BRICKRED + "Puzzle to load: "
 277                                                 + self.ENDCOL)
 278                 self.load_puzzle ()
 279                 self.do_puzzle_loop ()
 280
 281         # Main application loop
 282         def do_main_loop (self):
 283                 # display the menu
 284                 while True:
 285                         sys.stdout.write (self.BOLD + "\n-----------------------------------\n")
 286                         sys.stdout.write ("Get A Clue - Crossword Puzzle Maker\n")
 287                         sys.stdout.write ("-----------------------------------\n" + self.ENDCOL)
 288                         sys.stdout.write (self.BLUE + "1. Start a new puzzle\n")
 289                         sys.stdout.write ("2. Open an existing puzzle\n")
 290                         sys.stdout.write ("X. Exit\n" + self.ENDCOL)
 291                         ch = raw_input (self.BRICKRED + "Your choice: " + self.ENDCOL)
 292                         if ch == '1':
 293                                 self.on_new_puzzle ()
 294                         if ch == '2':
 295                                 self.on_load_puzzle ()
 296                         if ch == 'x' or ch == 'X':
 297                                 break