Implemented the reveal/hide solution functionality
[getaclue.git] / crosswordpuzzle.py
index 57878b8..ffdd915 100644 (file)
@@ -109,6 +109,11 @@ class NoWordException (Exception):
        def __init__ (self, row, col):
                self.pos = (row, col)
 
+# exception when a word number is not found in the grid
+class NoNumberException (Exception):
+       def __init__ (self, num):
+               self.num = num
+
 # exception when no words are present in the grid
 class NoWordsException (Exception):
        def __init__ (self):
@@ -136,8 +141,7 @@ class CrosswordPuzzle:
        def export_image (self, pngfile, htmlfile=None, puztitle="Crossword Puzzle",
                solution=True):
                # don't export if grid is not frozen
-               if self.frozen_grid is False:
-                       raise FrozenGridException
+               self.assert_frozen_grid ()
 
                # create cairo image surface and context
                px = 30
@@ -199,8 +203,9 @@ class CrosswordPuzzle:
                        html_contents.append ("<h2>Across clues</h2>")
                        html_contents.append ("<p>")
                        for word, clue in clues_across:
+                               # clue should be: <num> - clue text (chars)
                                clue_str = str (self.data[word[1]][word[2]].numbered) + " - " \
-                                                       + clue
+                                                       + clue + " (" + str (word[3]) + ")"
                                html_contents.append (clue_str)
                                html_contents.append ("<br />")
                        html_contents.append ("</p>")
@@ -209,7 +214,7 @@ class CrosswordPuzzle:
                        html_contents.append ("<p>")
                        for word, clue in clues_down:
                                clue_str = str (self.data[word[1]][word[2]].numbered) + " - " \
-                                                       + clue
+                                                       + clue + " (" + str (word[3]) + ")"
                                html_contents.append (clue_str)
                                html_contents.append ("<br />")
                        html_contents.append ("</p>")
@@ -225,8 +230,7 @@ class CrosswordPuzzle:
        # get the AcrossLite(TM) data for exporting
        def export_acrosslite (self, title, author, copyright):
                # don't export if grid is not frozen
-               if self.frozen_grid is False:
-                       raise FrozenGridException
+               self.assert_frozen_grid ()
 
                across_data = []
                across_data.append ("<ACROSS PUZZLE>\r\n")
@@ -300,6 +304,53 @@ class CrosswordPuzzle:
 
                return clues
 
+       # getting an across word at a number (note that the grid should be
+       # frozen for calling this otherwise a FrozenGridException will be raised)
+       def get_word_across_at_num (self, num):
+               # assert that the grid is frozen
+               self.assert_frozen_grid ()
+
+               # traverse the grid
+               for row in range (self.rows):
+                       for col in range (self.cols):
+                               if self.data[row][col].numbered == num:
+                                       word = self.get_word_across (row, col)
+                                       return word
+
+               # if number is not found
+               raise NoNumberException (num)
+
+       # getting a down word at a number (note that the grid should be frozen
+       # for calling this otherwise a FrozenGridException will be raised)
+       def get_word_down_at_num (self, num):
+               # assert that the grid is frozen
+               self.assert_frozen_grid ()
+
+               # traverse the grid
+               for row in range (self.rows):
+                       for col in range (self.cols):
+                               if self.data[row][col].numbered == num:
+                                       word = self.get_word_down (row, col)
+                                       return word
+
+               # if number is not found
+               raise NoNumberException (num)
+
+       # getting the position of a number on the grid (note that the grid should
+       # be frozen for calling this otherwise a FrozenGridException will be raised)
+       def get_position_of_num (self, num):
+               # assert that the grid is frozen
+               self.assert_frozen_grid ()
+
+               # traverse the grid
+               for row in range (self.rows):
+                       for col in range (self.cols):
+                               if self.data[row][col].numbered == num:
+                                       return (row, col)
+
+               # if number is not found
+               raise NoNumberException (num)
+
        # getting a down word at a position
        def get_word_down (self, row, col):
                # if index is out of bounds
@@ -372,9 +423,8 @@ class CrosswordPuzzle:
 
        # setting a down word
        def set_word_down (self, row, col, word):
-               # if the grid is frozen the abort
-               if self.frozen_grid is True:
-                       raise FrozenGridException
+               # if the grid is frozen then abort
+               self.assert_unfrozen_grid ()
 
                # if the word length greater than totalrows - startrow
                if len(word) > self.rows - row:
@@ -391,6 +441,11 @@ class CrosswordPuzzle:
                                if i > 0 and i < len(word) - 1:
                                        if self.data[row+i][col-1].occupied_down is True:
                                                raise IntersectWordException (word, len(word))
+                               # if the previous column is the end of an across word
+                               if (self.data[row+i][col-1].occupied_across is True and
+                                       self.data[row+i][col].occupied_across is False):
+                                       raise IntersectWordException (word, len(word))
+
                        # on the next column except last column
                        if col < len(word) - 1:
                                # except the first and last row check if there is any
@@ -422,9 +477,8 @@ class CrosswordPuzzle:
 
        # setting an across word
        def set_word_across (self, row, col, word):
-               # if the grid is frozen the abort
-               if self.frozen_grid is True:
-                       raise FrozenGridException
+               # if the grid is frozen then abort
+               self.assert_unfrozen_grid ()
 
                # is the word length greater than totalcols - startcol?
                if len(word) > self.cols - col:
@@ -441,6 +495,11 @@ class CrosswordPuzzle:
                                if i > 0 and i < len(word) - 1:
                                        if self.data[row-1][col+i].occupied_across is True:
                                                raise IntersectWordException (word, len(word))
+                               # if the previous row is the end of a down word
+                               if (self.data[row-1][col+i].occupied_down is True and
+                                       self.data[row][col+i].occupied_down is False):
+                                       raise IntersectWordException (word, len(word))
+
                        # on a next row
                        if (row < (self.rows - 1)):
                                # except the first and last letter check if there is
@@ -500,6 +559,16 @@ class CrosswordPuzzle:
 
                self.frozen_grid = False
 
+       # raise an exception if the grid is frozen
+       def assert_unfrozen_grid (self):
+               if self.frozen_grid is True:
+                       raise FrozenGridException
+
+       # raise an exception if the grid is NOT frozen
+       def assert_frozen_grid (self):
+               if self.frozen_grid is False:
+                       raise FrozenGridException
+
        # reset the entire grid
        def reset_grid (self):
                # run through the grid
@@ -509,3 +578,69 @@ class CrosswordPuzzle:
                                self.data[row][col].reset ()
 
                self.frozen_grid = False
+
+       # remove an across word at position
+       def remove_word_across (self, row, col):
+               # if grid is frozen don't allow removal of word
+               self.assert_unfrozen_grid ()
+
+               word, brow, bcol, l = self.get_word_across (row, col)
+
+               # traverse from the beginning to end of the word and erase it
+               c = bcol
+               while c < self.cols:
+                       if self.data[brow][c].occupied_across is True:
+                               self.data[brow][c].clear_across_data ()
+                       else:
+                               break
+                       c += 1
+
+       # remove a down word at position
+       def remove_word_down (self, row, col):
+               # if grid is frozen don't allow removal of word
+               self.assert_unfrozen_grid ()
+
+               word, brow, bcol, l = self.get_word_down (row, col)
+               # traverse from the beginn to end of the word and erase it
+               r = brow
+               while r < self.rows:
+                       if self.data[r][bcol].occupied_down is True:
+                               self.data[r][bcol].clear_down_data ()
+                       else:
+                               break
+                       r += 1
+
+       # reveal/unreveal a word at position
+       def reveal_word_across (self, row, col, revealed=True):
+               # set the revealed flag for the word at the position
+               word= self.get_word_across (row, col)
+
+               c = word[2]
+               while c < self.cols:
+                       if self.data[word[1]][c].occupied_across is True:
+                               self.data[word[1]][c].revealed = revealed
+                       else:
+                               break
+                       c += 1
+
+       # reveal/unreveal a word at position
+       def reveal_word_down (self, row, col, revealed=True):
+               # set the revealed flag for the word at the position
+               word = self.get_word_down (row, col)
+
+               r = word[1]
+               while r < self.rows:
+                       if self.data[r][word[2]].occupied_down is True:
+                               self.data[r][word[2]].revealed = revealed
+                       else:
+                               break
+                       r += 1
+
+       # reveal/hide the entire solution by resetting revealed flag at all cells
+       def reveal_solution (self, revealed=True):
+               # run through the grid and set revealed to False
+               for row in range (self.rows):
+                       for col in range (self.cols):
+                               self.data[row][col].revealed = revealed
+
+