Fixed order of tuple in return statement
[getaclue.git] / crosswordpuzzle.py
index fb9ada5..4e291db 100644 (file)
@@ -45,18 +45,17 @@ class FrozenGridException (Exception):
        def __init__ (self):
                self.msg = "Grid is frozen and cannot be edited"
 
-class CrosswordPuzzle:
-       # ansi color codes for grid display
-       BRICKRED = '\033[44;1;31m'
-       # bold
-       BOLD = '\033[33m'
-       # blue
-       BLUE = '\033[34m'
-       # grey
-       GREY = '\033[30m'
-       # disable colors
-       ENDCOL = '\033[0m'
+# exception when no word is found at a position
+class NoWordException (Exception):
+       def __init__ (self, row, col):
+               self.pos = (row, col)
+
+# exception when no words are present in the grid
+class NoWordsException (Exception):
+       def __init__ (self):
+               self.msg = "No words in grid"
 
+class CrosswordPuzzle:
        def __init__ (self, rows, cols):
                # define number of rows and columns
                self.rows = rows
@@ -74,6 +73,108 @@ class CrosswordPuzzle:
                        for j in range (cols):
                                self.data[i].append (GridItem ())
 
+       # get all the clues for across
+       def get_clues_across (self):
+               clues = []
+               # traverse the grid
+               for row in range (self.rows):
+                       for col in range (self.cols):
+                               if (self.data[row][col].occupied_across is True and
+                               self.data[row][col].across_start is True):
+                                       word_across = self.get_word_across (row, col)
+                                       clues.append ((word_across, self.data[row][col].clue_across))
+               # if no across words are found at all
+               if not clues:
+                       raise NoWordsException
+
+               return clues
+
+       # get all the clues for down
+       def get_clues_down (self):
+               clues = []
+               # traverse the grid
+               for row in range (self.rows):
+                       for col in range (self.cols):
+                               if (self.data[row][col].occupied_down is True and
+                               self.data[row][col].down_start is True):
+                                       word_down = self.get_word_down (row, col)
+                                       clues.append ((word_down, self.data[row][col].clue_down))
+               # if no down words are found at all
+               if not clues:
+                       raise NoWordsException
+
+               return clues
+
+       # getting a down word at a position
+       def get_word_down (self, row, col):
+               # if index is out of bounds
+               if row >= self.rows or col >= self.cols:
+                       raise NoWordException (row, col)
+
+               # if there is no occupied down letter at that position
+               if self.data[row][col].occupied_down is False:
+                       raise NoWordException (row, col)
+
+               # now traverse the grid to find the beginning of the word
+               i = row
+               while i >= 0:
+                       # if it is occupied down and is the beginning of the word
+                       if (self.data[i][col].occupied_down is True and
+                               self.data[i][col].down_start is True):
+                               start_row = i
+                               break
+                       i -= 1
+
+               i = start_row
+               word_chars = []
+               # now seek the end of the word
+               while i < self.rows:
+                       if self.data[i][col].occupied_down is True:
+                               word_chars.append (self.data[i][col].char)
+                       else:
+                               break
+                       i += 1
+
+               word = "".join (word_chars)
+
+               # return the word, starting row, column and length as a tuple
+               return (word, start_row, col, len(word))
+
+       # getting an across word at a position
+       def get_word_across (self, row, col):
+               # if index is out of bounds
+               if row >= self.rows or col >= self.cols:
+                       raise NoWordException (row, col)
+
+               # if there is no occupied across letter at that position
+               if self.data[row][col].occupied_across is False:
+                       raise NoWordException (row, col)
+
+               # now traverse the grid to look for the beginning of the word
+               i = col
+               while i >= 0:
+                       # if it is occupied across and is the beginning of the word
+                       if (self.data[row][i].occupied_across is True and
+                               self.data[row][i].across_start is True):
+                               start_col = i
+                               break
+                       i -= 1
+
+               i = start_col
+               word_chars = []
+               # now seek the end of the word
+               while i < self.cols:
+                       if self.data[row][i].occupied_across is True:
+                               word_chars.append (self.data[row][i].char)
+                       else:
+                               break
+                       i += 1
+
+               word = "".join (word_chars)
+
+               # return the word, starting column, row and length as a tuple
+               return (word, row, start_col, len(word))
+
        # setting a down word
        def set_word_down (self, row, col, word):
                # if the grid is frozen the abort
@@ -89,14 +190,23 @@ class CrosswordPuzzle:
                        # on the same column
                        if self.data[row+i][col].occupied_down is True:
                                raise IntersectWordException (word, len(word))
-                       # on the previous column
-                       if col > 0 and self.data[row+i][col-1].occupied_down is True:
-                               raise IntersectWordException (word, len(word))
-                       # on the next column
-                       if (col < (len(word) - 1) and
-                               (self.data[row+i][col+1].occupied_down is True or
-                               self.data[row+i][col+1].across_start is True)):
-                               raise IntersectWordException (word, len(word))
+                       # on the previous column except first column
+                       if col > 0:
+                               # except the first and last col
+                               if i > 0 and i < len(word) - 1:
+                                       if self.data[row+i][col-1].occupied_down is True:
+                                               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
+                               # down word in previous column
+                               if i > 0 and i < len(word) - 1:
+                                       if self.data[row+i][col+1].occupied_down is True:
+                                               raise IntersectWordException (word, len(word))
+                               # check if there is any across word starting in the
+                               # next column
+                               if self.data[row+i][col+1].across_start is True:
+                                       raise IntersectWordException (word, len(word))
 
                # also check the character before and after
                if (row > 0 and self.data[row-1][col].occupied_down is True
@@ -127,17 +237,26 @@ class CrosswordPuzzle:
 
                # is the word intersecting any other word?
                for i in range (len(word)):
-                       # on the same line
+                       # on the same row
                        if self.data[row][col+i].occupied_across is True:
                                raise IntersectWordException (word, len(word))
-                       # on a previous line except the last column
-                       if row > 0 and self.data[row-1][col+i].occupied_across is True:
-                               raise IntersectWordException (word, len(word))
-                       # on a next line except the last column
-                       if (row < (self.rows - 1) and
-                        (self.data[row+1][col+i].down_start is True
-                       or self.data[row+1][col+i].occupied_across is True)):
-                               raise IntersectWordException (word, len(word))
+                       # on a previous row except first row
+                       if row > 0:
+                               # if not the first or last col
+                               if i > 0 and i < len(word) - 1:
+                                       if self.data[row-1][col+i].occupied_across is True:
+                                               raise IntersectWordException (word, len(word))
+                       # on a next row
+                       if (row < (self.rows - 1)):
+                               # except the first and last letter check if there is
+                               # any across intersection
+                               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 a down word is starting at any column below the
+                               # word
+                               if self.data[row+1][col+i].down_start is True:
+                                       raise IntersectWordException (word, len(word))
 
                # also check the character beyond and before and after
                if (col > 0 and (self.data[row][col-1].occupied_across is True or
@@ -184,3 +303,5 @@ class CrosswordPuzzle:
                                        self.data[row][col].occupied_down is False):
                                        self.data[row][col].char = '.'
 
+               self.frozen_grid = False
+