Class
IpuzBarred
Description [src]
class Ipuz.Barred : Ipuz.Crossword
implements Ipuz.Clues {
/* No available fields */
}A crossword puzzle with lines between words instead of blocks. Their clues tend to be cryptic in nature and often exhibit symmetry.
Barred puzzles inherit from IpuzCrossword and can use all
of the methods associated with that class. In particular, the
_fix() methods will take bars under consideration when working
with the grid.
Representation
Barred puzzles are not explicitly defined in the ipuz spec. As a
result, libipuz has an additional
IpuzPuzzle:puzzle-kind field available as a libipuz extension.
When saving, libipuz adds the https://libipuz.org/barred#1 tag to
the kind field, as well as the http://ipuz.org/crossword#1
tag. This will keep compatibility with other implementations, but
allow libipuz to identify these puzzles. In practice, barred
puzzles act like crosswords when being solved and can be treated as
such. However the additional kind tag lets libipuz load those
puzzles into a IpuzBarred object which provides additional
editing capabilities.
Grid
Barred puzzles use an IpuzStyle with
IpuzStyleSides set to indicate lines in the puzzle. As a
result, many cells in the puzzle will have a style attached to
them. Typically, only IpuzCellType cells are found
within a barred crossword. Blocks and null cells are possible, but non-traditional.
A barred puzzle will create three named styles that can be used to
modify the grid. These styles are empty other than a side set. They
can be looked up using ipuz_puzzle_get_style() with the
following constants:
These styles set a side on the left, top, and top-left of a cell
respectively. When building the grid’s shape, these are used to
fill out the overall shape of the grid. There’s no need for right,
bottom, and bottom-right borders as that effect can be had by
setting the above styles on a neighbooring cell. See
ipuz_barred_set_cell_bars() for more information.
It’s possible for users of the cell to reuse these styles — or
provide their own. For example, you could set a style with a border
on the top and with the answer circled. The _fix() functions will
recognize and preserve that.
Clues
Clues with IpuzBarred objects are the same as with
IpuzCrossword, and can be accessed through the
IpuzClues interface.
Guesses
Guesses with IpuzBarred objects are identical to
IpuzCrossword.
Editing
Editing a barred puzzle can be done with a combination of
ipuz_barred_set_cell_bars() and the IpuzCrossword
_fix() functions. One thing to call out is that
ipuz_crossword_fix_styles() will convert all styles that
only contain bars to the internal styles.
Note
It’s also worth pointing out that filling a barred grid with letters is even harder then filling a standard crossword. Solving this is outside the scope of libipuz.
Instance methods
ipuz_barred_calculate_side_toggle
Calculate the sides of a cell after toggling one of its sides while
taking symmetry into account. For most of the cells on the grid
this just changes the side. However, the center line of symmetry
and the center square need special handling as toggling those cells
will modify multiple sides.
ipuz_barred_get_cell_bars
Returns the orientation of any bars set around the cell at
coord. This function will inspect the style at coord — as well as
any neighboring cells — in order to calculate this value.
ipuz_barred_set_cell_bars
Sets the cell at coord to have bars as determined by sides. Note
that if sides contains IpuzStyleSides, then this
will be implemented by setting the left side of the cell to the
right of coord. A similar pattern occurs when sides contains
IpuzStyleSides.
Methods inherited from IpuzCrossword (19)
ipuz_crossword_check_mirror
ipuz_crossword_clue_continues_down
ipuz_crossword_clue_continues_left
ipuz_crossword_clue_continues_right
ipuz_crossword_clue_continues_up
ipuz_crossword_fix_all
ipuz_crossword_fix_clues
ipuz_crossword_fix_enumerations
ipuz_crossword_fix_numbering
ipuz_crossword_fix_styles
ipuz_crossword_fix_symmetry
Enforce the board symmetry of the cells in coords in the direction
of symmetry. That is to say, go through each cell in coords and
make sure that the appropriate cell at the point(s) of symmetry
have the same IpuzCellType.
ipuz_crossword_get_clue_placement
ipuz_crossword_get_show_enumerations
ipuz_crossword_get_solution_chars
ipuz_crossword_get_symmetry
Calculates the symmetry of self. Note, there can be multiple valid
calculations for a board. For example, we can’t say anything at all
about the symmetry for a blank, square board. This function returns
the first one that matches.
ipuz_crossword_mirror_cell
ipuz_crossword_print
ipuz_crossword_set_clue_placement
ipuz_crossword_set_show_enumerations
Methods inherited from IpuzGrid (10)
ipuz_grid_check_cell
Invokes the operation determined by check_type on cell and
guesses at coord.
ipuz_grid_create_guesses
Creates a fresh IpuzGuesses. It will be initialized to
the current state of the grid.
ipuz_grid_fix_guesses
Fixes the guesses associated with self. The result will be a
playable IpuzGuesses struct.
ipuz_grid_foreach_cell
Calls func for each IpuzCell in self.
ipuz_grid_get_cell
Retrieves the cell at coord. If the coordinates are
outside the bounds of the grid then NULL will be returned.
ipuz_grid_get_guesses
Returns the IpuzGuesses associated with self.
ipuz_grid_get_height
Returns the number of rows in self.
ipuz_grid_get_width
Returns the number of columns in self.
ipuz_grid_resize
Resizes self to the new size.
ipuz_grid_set_guesses
Sets guesses for self. If there’s a mismatch in the cell types
between guesses and self then FALSE is returned. guesses will
be set regardless of the return value.
Methods inherited from IpuzPuzzle (55)
Please see IpuzPuzzle for a full list of methods.
Methods inherited from IpuzClues (18)
ipuz_clues_add_clue_set
Adds a new clue set to clues. This clue set will be in the
direction of direction, and will be empty. If label is set, then
it will set the label of the newly created clue set.
ipuz_clues_clear_clue_sets
Removes all the clues and clue sets of clues.
ipuz_clues_clue_guessed
Returns TRUE if clue has a user guess for every cell. If all the
user guesses are correct, then correct is set to TRUE as well.
ipuz_clues_clue_set_get_dir
Returns the direction of the clueset at index.
ipuz_clues_clue_set_get_label
Returns the label of the clueset at direction.
ipuz_clues_find_clue_by_coord
[ RETHINK THIS FUNCTION. CANT WE GET IT FROM THE CELL?]
ipuz_clues_find_clue_by_label
Searches for and returns the clue with direction and label.
ipuz_clues_find_clue_by_number
Searches for and returns the clue with direction and number.
ipuz_clues_foreach_clue
Calls func for each IpuzClue in clues.
ipuz_clues_get_clue_by_id
Returns the clue at clue_id, or NULL.
ipuz_clues_get_clue_string_by_id
Returns a string containing the solution of the puzzle for a given clue. This string will have ‘?’ characters embedded within it if there are cells without solutions set yet.
ipuz_clues_get_clues
Returns an array of all clues in the direction of direction.
ipuz_clues_get_guess_string_by_id
Returns a string containing the guess in the puzzle for a given clue. This string will have ‘?’ characters embedded within it if there are cells not completely filled out.
ipuz_clues_get_id_by_clue
Finds the IpuzClueId of clue within clues.
ipuz_clues_get_n_clue_sets
Returns the number of clue sets associated with clues.
ipuz_clues_get_n_clues
Returns the number of clues in direction.
ipuz_clues_remove_clue
Removes clue from clues. The clue will also be unlinked from the grid.
ipuz_clues_remove_clue_set
Removes the clue set in the direction of direction. All the clues
associated with that clue set will be unreffed.
Properties
Properties inherited from IpuzCrossword (2)
Ipuz.Crossword:clue-placement
Ipuz.Crossword:show-enumerations
Properties inherited from IpuzGrid (3)
Ipuz.Grid:guesses
Ipuz.Grid:height
Ipuz.Grid:width
Properties inherited from IpuzPuzzle (24)
Ipuz.Puzzle:annotation
Non-displayed annotation.
Ipuz.Puzzle:author
Author of the puzzle.
Ipuz.Puzzle:block
The text value that represents a block in the saved file.
Ipuz.Puzzle:charset
Characters that can be entered in the puzzle. Setting this
explicitly will override the charset defined by
IpuzPuzzle:locale.
Ipuz.Puzzle:charset-str
Characters that can be entered in the puzzle, in string form.
Setting this explicitly will override the charset defined by
IpuzPuzzle:locale.
Ipuz.Puzzle:copyright
Copyright information for the puzzle.
Ipuz.Puzzle:date
Date of puzzle or publication date.
Ipuz.Puzzle:difficulty
Difficulty of the puzzle. Advisory only, as there is no standard for difficulty.
Ipuz.Puzzle:editor
Editor of the puzzle.
Ipuz.Puzzle:empty
Text value that represents an empty cell.
Ipuz.Puzzle:explanation
Text to be displayed after a successful solve.
Ipuz.Puzzle:intro
Text displayed above the puzzle.
Ipuz.Puzzle:license
License of the puzzle.
Ipuz.Puzzle:locale
Locale of the puzzle.
Ipuz.Puzzle:notes
Notes about the puzzle.
Ipuz.Puzzle:origin
Program-specific information about the program that wrote the puzzle file.
Ipuz.Puzzle:publication
Bibliographic reference for a published puzzle.
Ipuz.Puzzle:publisher
Name and/or reference for a publisher.
Ipuz.Puzzle:puzzle-kind
The kind type of the puzzle.
Ipuz.Puzzle:styles
A GHash table containing all the named styles for the puzzle. These can be added or removed by calling ipuz_puzzle_set_style()
Ipuz.Puzzle:title
Title of the puzzle.
Ipuz.Puzzle:uniqueid
Globally unique identifier for the puzzle.
Ipuz.Puzzle:url
Permanent URL for the puzzle.
Ipuz.Puzzle:version
Version of the ipuz spec used for the puzzle.
Signals
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.