Ipuz – 1.0

An acrostic is a quote-based word puzzle. It consists of two parts: a grid containing a quote, and a list of clues. Each cell in the grid has a label and corresponds to one of the cells in a clue. The puzzle can be solved by a combination of guessing words in the quote and solving the clues.

A crossword puzzle with lines between words instead of blocks. Their clues tend to be cryptic in nature and often exhibit symmetry.

Crosswords are a word puzzle consisting of a grid of open cells and blocks into which answers are written. It has clues in both the Across and Down directions to lead the solver to the answer. Crosswords are frequently symmetric, and use numbers to identify clues.

Cryptics are a crossword variant featuring cryptic clues.

IpuzGrid is the base class for all grid-like puzzles. It is used to access the IpuzCell of a given puzzle kind, and is indexed by IpuzCellCoord.

A nonogram is a picture-based logic puzzle in which the player uses hints on the edge of the puzzle to reveal a picture.

A color nonogram puzzle.

IpuzPuzzle is the base class for all puzzles that libipuz supports. It contains the common puzzle metadata that all puzzle kinds share.

IpuzPuzzleInfo provides a snapshot of statistics and meta information of an IpuzPuzzle. It can only be created through calling ipuz_puzzle_get_puzzle_info(), and should not be independently created.

An interface to access and modify the clues of a crossword-like puzzle. It is intended to be used with IpuzClue clues only, and will not work with other clue types.

An opaque data type containing the information for an individual IpuzGrid cell.

A data type representing the coordinates of a single IpuzCell.

An opaque data structure that stores an ordered list of IpuzCellCoords.

A data type that stores statistics about an IpuzPuzzle.

An opaque, immutable data structure that stores an ordered count of unicode characters.

An opaque data structure used to dynamically build an IpuzCharset.

A data structure that represents the value of an index of an IpuzCharset.

An opaque data type representing an individual clue in a puzzle. Clues are used by both IpuzCrossword and IpuzAcrostic puzzles.

A data type that represents a relative identifier for an IpuzClue.

An opaque, immutable data type that stores the enumeration of a clue.

An opaque data type representing the user’s guesses. It allows storing an arbitrary string per cell.

A data type used by IpuzNonogram to indicate a segment of a clue array in a nonogram.

An opaque data type that defines how an IpuzCell should be visually styled.

Indicates which direction to sync the puzzle when called by the IpuzAcrostic _fix() functions.

Indicates the type and behavior of a given IpuzCell.

Possible directions for a clue.

Indication of where to physically place the clues on a playing board compared to the grid.

A deliminator is a hint in a puzzle grid about the nature of a cell or word. This enum indicates the type of deliminator that should be used for a given location in the grid.

Operation passed to ipuz_grid_check_cell().

Represents a type of puzzle.

Specifies how a cell should be divided.

Specifies a background shape to be drawn in an IpuzCell. Shapes like the circle and square are expected to be hollow, as to contain the text in the cell.

Mode of symmetry between cells in a gridded puzzle.

Offset off the mode of symmetry.

Flags that specifying information about a puzzle.

Specifies where a given mark should be locate within the cell. These can be combined to indicate multiple locations.

Specifies which sides a border decoration (such as barred or dotted) is referring to. These can be combined to indicate multiple sides at once.

Error codes when creating an IpuzPuzzle.

The function to be passed to ipuz_arrowword_foreach_blocks().

The function to be passed to ipuz_clues_foreach_clue().

The function to be passed to ipuz_enumeration_foreach_delim().

The function to be passed to ipuz_grid_foreach_cell().

The function to be passed to ipuz_puzzle_foreach_style().

The function to be passed to ipuz_style_foreach_mark().

Evaluates to TRUE if direction has a physical direction in the puzzle.

Indicates if the BOTTOM flag in sides is set.

Indicates if the LEFT flag in sides is set.

Indicates if the RIGHT flag in sides is set.

Indicates if the TOP flag in sides is set.

Maximum normalized character count that a quote can be set to in an acrostic puzzle.

String to pass to ipuz_puzzle_get_style() to acquire the left style of an IpuzBarred instance.

String to pass to ipuz_puzzle_get_style() to acquire the top style of an IpuzBarred instance.

String to pass to ipuz_puzzle_get_style() to acquire the top-left style of an IpuzBarred instance.

Style mark representing the bottom of the cell. Used for comparison within a IpuzStyleForeachMarkFunc callback.

Style mark representing the center column of the cell. Used for comparison within a IpuzStyleForeachMarkFunc callback.

Style mark representing the center row of the cell. Used for comparison within a IpuzStyleForeachMarkFunc callback.

Style mark representing the left of the cell. Used for comparison within a IpuzStyleForeachMarkFunc callback.

Style mark representing the right of the cell. Used for comparison within a IpuzStyleForeachMarkFunc callback.

Style mark representing the top of the cell. Used for comparison within a IpuzStyleForeachMarkFunc callback.