X-Git-Url: https://harishankar.org/repos/?p=getaclue.git;a=blobdiff_plain;f=crosswordpuzzle.py;h=628392098506ae21438d7e8b561f1cd0ae869148;hp=7d3b2709933e604a71b04171726a1f359ce3291c;hb=HEAD;hpb=8bf14bbd585036c0cfda88c2ace825f1aa471730 diff --git a/crosswordpuzzle.py b/crosswordpuzzle.py index 7d3b270..6283920 100644 --- a/crosswordpuzzle.py +++ b/crosswordpuzzle.py @@ -9,11 +9,14 @@ import cairo class GridItem: # initialize the item - def __init__ (self, item_char='.', across_start = False, down_start = False, - occupied_across = False, occupied_down = False, num = 0, - clue_across = None, clue_down = None, revealed = False): + def __init__ (self, item_char='.', item_guess = None, across_start = False, + down_start = False, occupied_across = False, + occupied_down = False, num = 0, clue_across = None, + clue_down = None, revealed = False): # character in the cell self.char = item_char + # guess of character in cell + self.guess = item_guess # is the cell the start of an across word? self.across_start = across_start # is the cell the start of a down word? @@ -31,12 +34,70 @@ class GridItem: # is the letter revealed or hidden? self.revealed = revealed + # clear the across data + def clear_across_data (self): + self.across_start = False + self.occupied_across = False + self.clue_across = None + # if no down word starting at item + if self.down_start is False: + self.numbered = 0 + # if no down word at the item + if self.occupied_down is False: + self.char = '.' + self.revealed = False + self.guess = None + + # clear the down data + def clear_down_data (self): + self.down_start = False + self.occupied_down = False + self.clue_down = None + # if no across word starting at item + if self.across_start is False: + self.numbered = 0 + # if no across word at the item + if self.occupied_across is False: + self.char = '.' + self.revealed = False + self.guess = None + + # reset a grid item completely - use only to destroy whole grid, otherwise + # use either clear_across_data () or clear_down_data () for erasing single + # words + def reset (self): + # character in the cell + self.char = '.' + # guess of character in cell + self.guess = None + # is the cell the start of an across word? + self.across_start = False + # is the cell the start of a down word? + self.down_start = False + # is the cell occupied by a letter in an across word? + self.occupied_across = False + # is the cell occupied by a letter in a down word? + self.occupied_down = False + # numbering of the cell if it is the start of a word + self.numbered = 0 + # clue across if the cell is the start of an across word + self.clue_across = None + # clue down if the cell is the start of a down word + self.clue_down = None + # is the letter revealed or hidden? + self.revealed = False + # exception for too long words class TooLongWordException (Exception): def __init__ (self, word, length): self.word = word self.length = length +# exception for words containing non-alpha characters +class WordCharsException (Exception): + def __init__ (self, word): + self.word = word + # exception for intersecting words class IntersectWordException (Exception): def __init__ (self, word, length): @@ -53,11 +114,21 @@ 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): self.msg = "No words in grid" +# exception to raise when solution is imcomplete when trying to verify it +class IncompleteSolutionException (Exception): + def __init__ (self): + self.msg = "Solution incomplete" + class CrosswordPuzzle: def __init__ (self, rows, cols): # define number of rows and columns @@ -80,8 +151,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 @@ -143,8 +213,9 @@ class CrosswordPuzzle: html_contents.append ("

Across clues

") html_contents.append ("

") for word, clue in clues_across: + # clue should be: - 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 ("
") html_contents.append ("

") @@ -153,7 +224,7 @@ class CrosswordPuzzle: html_contents.append ("

") 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 ("
") html_contents.append ("

") @@ -169,8 +240,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 ("\r\n") @@ -244,6 +314,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 @@ -316,9 +433,12 @@ 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 has non-alphabetic characters + if not word.isalpha (): + raise WordCharsException (word) # if the word length greater than totalrows - startrow if len(word) > self.rows - row: @@ -335,6 +455,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 @@ -366,9 +491,12 @@ 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 () + + # if the word has non-alphabetic characters + if not word.isalpha (): + raise WordCharsException (word) # is the word length greater than totalcols - startcol? if len(word) > self.cols - col: @@ -385,6 +513,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 @@ -444,3 +577,115 @@ 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 + for row in range (self.rows): + for col in range (self.cols): + # re-initialize all data + 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 + + # clear the guesses for the board + def clear_guesses (self): + # run through the grid and set the guesses to None + for row in range (self.rows): + for col in range (self.cols): + self.data[row][col].guess = None + + # verify the solution - return True if all guessed characters are correct + # return False if some of them are wrong. + # if the board is not completed as yet, raise a IncompleteSolutionException + def is_solution_correct (self): + # run through the grid and check for each character in occupied cells + flag = True + for row in range (self.rows): + for col in range (self.cols): + if (self.data[row][col].occupied_across is True or + self.data[row][col].occupied_down is True): + # if there is no guess at a particular location raise + # the incomplete solution exception + if not self.data[row][col].guess: + raise IncompleteSolutionException + # if a character doesn't match, return False + if self.data[row][col].char <> self.data[row][col].guess: + flag = False + + # finally return result + return flag +