Game.Goatee.Lib.Property

Structures and functions for working with SGF node properties.

Properties

data Property

An SGF property that gives a node meaning. A property is known if its meaning is defined by the SGF specification, and unknown otherwise. Known properties each have their own data constructors. Unknown properties are represented by the UnknownProperty data constructor.

Constructors

B (Maybe Coord)

Black move (nothing iff pass).

KO

Execute move unconditionally (even if illegal).

MN Integer

Assign move number.

W (Maybe Coord)

White move (nothing iff pass).

AB CoordList

Assign black stones.

AE CoordList

Assign empty stones.

AW CoordList

Assign white stones.

PL Color

Player to play.

C Text

Comment.

DM DoubleValue

Even position.

GB DoubleValue

Good for black.

GW DoubleValue

Good for white.

HO DoubleValue

Hotspot.

N SimpleText

Node name.

UC DoubleValue

Unclear position.

V RealValue

Node value.

BM DoubleValue

Bad move.

DO

Doubtful move.

IT

Interesting move.

TE DoubleValue

Tesuji.

AR ArrowList

Arrows.

CR CoordList

Mark points with circles.

DD CoordList

Dim points.

LB LabelList

Label points with text.

LN LineList

Lines.

MA CoordList

Mark points with Xs.

SL CoordList

Mark points as selected.

SQ CoordList

Mark points with squares.

TR CoordList

Mark points with trianges.

AP SimpleText SimpleText

Application info.

CA SimpleText

Charset for SimpleText and Text.

FF Int

File format version.

GM Int

Game (must be 1 = Go).

ST VariationMode

Variation display format.

SZ Int Int

Board size, columns then rows.

AN SimpleText

Name of annotator.

BR SimpleText

Rank of black player.

BT SimpleText

Name of black team.

CP SimpleText

Copyright info.

DT SimpleText

Dates played.

EV SimpleText

Event name.

GC Text

Game comment, or background, or summary.

GN SimpleText

Game name.

ON SimpleText

Information about the opening.

OT SimpleText

The method used for overtime.

PB SimpleText

Name of black player.

PC SimpleText

Where the game was played.

PW SimpleText

Name of white player.

RE GameResult

Result of the game.

RO SimpleText

Round info.

RU Ruleset

Ruleset used.

SO SimpleText

Source of the game.

TM RealValue

Time limit, in seconds.

US SimpleText

Name of user or program who entered the game.

WR SimpleText

Rank of white player.

WT SimpleText

Name of white team.

BL RealValue

Black time left.

OB Int

Black moves left in byo-yomi period.

OW Int

White moves left in byo-yomi period.

WL RealValue

White time left.

VW CoordList

Set viewing region.

HA Int

Handicap stones (>=2).

KM RealValue

Komi.

TB CoordList

Black territory.

TW CoordList

White territory.

UnknownProperty String UnknownPropertyValue

Instances

Eq Property

Defined in Game.Goatee.Lib.Property.Base

Methods

(==) :: Property -> Property -> Bool

(/=) :: Property -> Property -> Bool

Show Property

Defined in Game.Goatee.Lib.Property.Base

Methods

showsPrec :: Int -> Property -> ShowS

show :: Property -> String

showList :: [Property] -> ShowS

Descriptor Property

Defined in Game.Goatee.Lib.Property.Info

Methods

propertyName :: Property -> String

propertyType :: Property -> PropertyType

propertyInherited :: Property -> Bool

propertyPredicate :: Property -> Property -> Bool

propertyValueParser :: Property -> Parser Property

propertyValueRenderer :: Property -> Property -> Render ()

propertyValueRendererPretty :: Property -> Property -> Render ()

Property metadata

data PropertyType

The property types that SGF uses to group properties.

Constructors

MoveProperty

Cannot mix with setup nodes.

SetupProperty

Cannot mix with move nodes.

RootProperty

May only appear in root nodes.

GameInfoProperty

At most one on any path.

GeneralProperty

May appear anywhere in the game tree.

Instances

Eq PropertyType

Defined in Game.Goatee.Lib.Property.Base

Methods

(==) :: PropertyType -> PropertyType -> Bool

(/=) :: PropertyType -> PropertyType -> Bool

Show PropertyType

Defined in Game.Goatee.Lib.Property.Base

Methods

showsPrec :: Int -> PropertyType -> ShowS

show :: PropertyType -> String

showList :: [PropertyType] -> ShowS

class Descriptor a where

A class for types that contain metadata about a Property. The main instance of this class is Property itself; Propertys can be treated as though they have metadata directly. When referring to a property in general rather than a specific instance, use the values of PropertyInfo and ValuedPropertyInfo.

See also ValuedDescriptor.

Methods

propertyName :: a -> String

Returns the name of the property, as used in SGF files.

propertyType :: a -> PropertyType

Returns the type of the property, as specified by the SGF spec.

propertyInherited :: a -> Bool

Returns whether the value of the given property is inherited from the lowest ancestor specifying the property, when the property is not set on a node itself.

propertyPredicate :: a -> Property -> Bool

Returns whether the given property has the type of a descriptor.

propertyValueParser :: a -> Parser Property

A parser of property values in SGF format (e.g. "[ab]" for a property that takes a point).

propertyValueRenderer :: a -> Property -> Render ()

A renderer property values to SGF format (e.g. B (Just (1,2)) renders to "[ab]").

propertyValueRendererPretty :: a -> Property -> Render ()

A renderer for displaying property values in a UI. Displays the value in a human-readable format.

Instances

Descriptor PropertyInfo

Defined in Game.Goatee.Lib.Property.Base

Methods

propertyName :: PropertyInfo -> String

propertyType :: PropertyInfo -> PropertyType

propertyInherited :: PropertyInfo -> Bool

propertyPredicate :: PropertyInfo -> Property -> Bool

propertyValueParser :: PropertyInfo -> Parser Property

propertyValueRenderer :: PropertyInfo -> Property -> Render ()

propertyValueRendererPretty :: PropertyInfo -> Property -> Render ()

Descriptor AnyDescriptor

Defined in Game.Goatee.Lib.Property.Base

Methods

propertyName :: AnyDescriptor -> String

propertyType :: AnyDescriptor -> PropertyType

propertyInherited :: AnyDescriptor -> Bool

propertyPredicate :: AnyDescriptor -> Property -> Bool

propertyValueParser :: AnyDescriptor -> Parser Property

propertyValueRenderer :: AnyDescriptor -> Property -> Render ()

propertyValueRendererPretty :: AnyDescriptor -> Property -> Render ()

Descriptor Property

Defined in Game.Goatee.Lib.Property.Info

Methods

propertyName :: Property -> String

propertyType :: Property -> PropertyType

propertyInherited :: Property -> Bool

propertyPredicate :: Property -> Property -> Bool

propertyValueParser :: Property -> Parser Property

propertyValueRenderer :: Property -> Property -> Render ()

propertyValueRendererPretty :: Property -> Property -> Render ()

Descriptor (ValuedPropertyInfo v)

Defined in Game.Goatee.Lib.Property.Base

Methods

propertyName :: ValuedPropertyInfo v -> String

propertyType :: ValuedPropertyInfo v -> PropertyType

propertyInherited :: ValuedPropertyInfo v -> Bool

propertyPredicate :: ValuedPropertyInfo v -> Property -> Bool

propertyValueParser :: ValuedPropertyInfo v -> Parser Property

propertyValueRenderer :: ValuedPropertyInfo v -> Property -> Render ()

propertyValueRendererPretty :: ValuedPropertyInfo v -> Property -> Render ()

Descriptor (AnyValuedDescriptor v)

Defined in Game.Goatee.Lib.Property.Base

Methods

propertyName :: AnyValuedDescriptor v -> String

propertyType :: AnyValuedDescriptor v -> PropertyType

propertyInherited :: AnyValuedDescriptor v -> Bool

propertyPredicate :: AnyValuedDescriptor v -> Property -> Bool

propertyValueParser :: AnyValuedDescriptor v -> Parser Property

propertyValueRenderer :: AnyValuedDescriptor v -> Property -> Render ()

propertyValueRendererPretty :: AnyValuedDescriptor v -> Property -> Render ()

class (Descriptor a, Eq v) => ValuedDescriptor v a | a -> v where

A class for Descriptors of properties that also contain values.

Methods

propertyValue :: a -> Property -> v

Extracts the value from a property of the given type. Behaviour is undefined if the property is not of the given type.

propertyBuilder :: a -> v -> Property

Builds a property from a given value.

Instances

Eq v => ValuedDescriptor v (ValuedPropertyInfo v)

Defined in Game.Goatee.Lib.Property.Base

Methods

propertyValue :: ValuedPropertyInfo v -> Property -> v

propertyBuilder :: ValuedPropertyInfo v -> v -> Property

Eq v => ValuedDescriptor v (AnyValuedDescriptor v)

Defined in Game.Goatee.Lib.Property.Base

Methods

propertyValue :: AnyValuedDescriptor v -> Property -> v

propertyBuilder :: AnyValuedDescriptor v -> v -> Property

data AnyDescriptor

An existential type for any property descriptor. AnyDescriptor has a Descriptor instance, so there is no need to extract the value with a pattern match before using Descriptor methods.

Constructors

forall a.Descriptor a => AnyDescriptor a

Instances

Descriptor AnyDescriptor

Defined in Game.Goatee.Lib.Property.Base

Methods

propertyName :: AnyDescriptor -> String

propertyType :: AnyDescriptor -> PropertyType

propertyInherited :: AnyDescriptor -> Bool

propertyPredicate :: AnyDescriptor -> Property -> Bool

propertyValueParser :: AnyDescriptor -> Parser Property

propertyValueRenderer :: AnyDescriptor -> Property -> Render ()

propertyValueRendererPretty :: AnyDescriptor -> Property -> Render ()

data AnyValuedDescriptor v

An existential type for any descriptor of a property that holds a value of a specific type. Has instances for Descriptor and ValuedDescriptor, similar to AnyDescriptor.

Constructors

forall a.ValuedDescriptor v a => AnyValuedDescriptor a

Instances

Eq v => ValuedDescriptor v (AnyValuedDescriptor v)

Defined in Game.Goatee.Lib.Property.Base

Methods

propertyValue :: AnyValuedDescriptor v -> Property -> v

propertyBuilder :: AnyValuedDescriptor v -> v -> Property

Descriptor (AnyValuedDescriptor v)

Defined in Game.Goatee.Lib.Property.Base

Methods

propertyName :: AnyValuedDescriptor v -> String

propertyType :: AnyValuedDescriptor v -> PropertyType

propertyInherited :: AnyValuedDescriptor v -> Bool

propertyPredicate :: AnyValuedDescriptor v -> Property -> Bool

propertyValueParser :: AnyValuedDescriptor v -> Parser Property

propertyValueRenderer :: AnyValuedDescriptor v -> Property -> Render ()

propertyValueRendererPretty :: AnyValuedDescriptor v -> Property -> Render ()

type AnyCoordListDescriptor = AnyValuedDescriptor CoordList

data PropertyInfo

Metadata for a property that does not contain a value. Corresponds to a nullary data constructor of Property.

Instances

Descriptor PropertyInfo

Defined in Game.Goatee.Lib.Property.Base

Methods

propertyName :: PropertyInfo -> String

propertyType :: PropertyInfo -> PropertyType

propertyInherited :: PropertyInfo -> Bool

propertyPredicate :: PropertyInfo -> Property -> Bool

propertyValueParser :: PropertyInfo -> Parser Property

propertyValueRenderer :: PropertyInfo -> Property -> Render ()

propertyValueRendererPretty :: PropertyInfo -> Property -> Render ()

data ValuedPropertyInfo v

Metadata for a property that contains a value. Corresponds to a non-nullary data constructor of Property.

Constructors

ValuedPropertyInfo String PropertyType Bool (Property -> Bool) (PropertyValueType v) (Property -> v) (v -> Property)

Instances

Eq v => ValuedDescriptor v (ValuedPropertyInfo v)

Defined in Game.Goatee.Lib.Property.Base

Methods

propertyValue :: ValuedPropertyInfo v -> Property -> v

propertyBuilder :: ValuedPropertyInfo v -> v -> Property

Descriptor (ValuedPropertyInfo v)

Defined in Game.Goatee.Lib.Property.Base

Methods

propertyName :: ValuedPropertyInfo v -> String

propertyType :: ValuedPropertyInfo v -> PropertyType

propertyInherited :: ValuedPropertyInfo v -> Bool

propertyPredicate :: ValuedPropertyInfo v -> Property -> Bool

propertyValueParser :: ValuedPropertyInfo v -> Parser Property

propertyValueRenderer :: ValuedPropertyInfo v -> Property -> Render ()

propertyValueRendererPretty :: ValuedPropertyInfo v -> Property -> Render ()

(Internal) Property metadata declaration

defProperty

Arguments

:: String

The SGF textual name of the property.

-> Name

The name of the PropertyType.

-> Bool

Whether the property is inherited.

-> DecsQ

Internal to this module, do not use outside. Template Haskell function to declare a property that does not contain a value.

$(defProperty "KO" 'MoveProperty False)

This example declares a propertyKO :: PropertyInfo that is a MoveProperty and is not inherited.

defValuedProperty :: String -> Name -> Bool -> Name -> DecsQ

Internal to this module, do not use outside. Template Haskell function to declare a property that contains a value.

$(defValuedProperty "B" 'MoveProperty False 'maybeCoordPrinter)

This example declares a propertyB :: ValuedPropertyInfo (Maybe Coord) that is a MoveProperty and is not inherited. The value type is automatically inferred.

Known property metadata

propertyB :: ValuedPropertyInfo (Maybe Coord)

propertyKO :: PropertyInfo

propertyMN :: ValuedPropertyInfo Integer

propertyW :: ValuedPropertyInfo (Maybe Coord)

propertyAB :: ValuedPropertyInfo CoordList

propertyAE :: ValuedPropertyInfo CoordList

propertyAW :: ValuedPropertyInfo CoordList

propertyPL :: ValuedPropertyInfo Color

propertyC :: ValuedPropertyInfo Text

propertyDM :: ValuedPropertyInfo DoubleValue

propertyGB :: ValuedPropertyInfo DoubleValue

propertyGW :: ValuedPropertyInfo DoubleValue

propertyHO :: ValuedPropertyInfo DoubleValue

propertyN :: ValuedPropertyInfo SimpleText

propertyUC :: ValuedPropertyInfo DoubleValue

propertyV :: ValuedPropertyInfo RealValue

propertyBM :: ValuedPropertyInfo DoubleValue

propertyDO :: PropertyInfo

propertyIT :: PropertyInfo

propertyTE :: ValuedPropertyInfo DoubleValue

propertyAR :: ValuedPropertyInfo ArrowList

propertyCR :: ValuedPropertyInfo CoordList

propertyDD :: ValuedPropertyInfo CoordList

propertyLB :: ValuedPropertyInfo LabelList

propertyLN :: ValuedPropertyInfo LineList

propertyMA :: ValuedPropertyInfo CoordList

propertySL :: ValuedPropertyInfo CoordList

propertySQ :: ValuedPropertyInfo CoordList

propertyTR :: ValuedPropertyInfo CoordList

propertyAP :: ValuedPropertyInfo (SimpleText, SimpleText)

propertyCA :: ValuedPropertyInfo SimpleText

propertyFF :: ValuedPropertyInfo Int

propertyGM :: ValuedPropertyInfo Int

propertyST :: ValuedPropertyInfo VariationMode

propertySZ :: ValuedPropertyInfo (Int, Int)

propertyAN :: ValuedPropertyInfo SimpleText

propertyBR :: ValuedPropertyInfo SimpleText

propertyBT :: ValuedPropertyInfo SimpleText

propertyCP :: ValuedPropertyInfo SimpleText

propertyDT :: ValuedPropertyInfo SimpleText

propertyEV :: ValuedPropertyInfo SimpleText

propertyGC :: ValuedPropertyInfo Text

propertyGN :: ValuedPropertyInfo SimpleText

propertyON :: ValuedPropertyInfo SimpleText

propertyOT :: ValuedPropertyInfo SimpleText

propertyPB :: ValuedPropertyInfo SimpleText

propertyPC :: ValuedPropertyInfo SimpleText

propertyPW :: ValuedPropertyInfo SimpleText

propertyRE :: ValuedPropertyInfo GameResult

propertyRO :: ValuedPropertyInfo SimpleText

propertyRU :: ValuedPropertyInfo Ruleset

propertySO :: ValuedPropertyInfo SimpleText

propertyTM :: ValuedPropertyInfo RealValue

propertyUS :: ValuedPropertyInfo SimpleText

propertyWR :: ValuedPropertyInfo SimpleText

propertyWT :: ValuedPropertyInfo SimpleText

propertyBL :: ValuedPropertyInfo RealValue

propertyOB :: ValuedPropertyInfo Int

propertyOW :: ValuedPropertyInfo Int

propertyWL :: ValuedPropertyInfo RealValue

propertyVW :: ValuedPropertyInfo CoordList

propertyHA :: ValuedPropertyInfo Int

propertyKM :: ValuedPropertyInfo RealValue

propertyTB :: ValuedPropertyInfo CoordList

propertyTW :: ValuedPropertyInfo CoordList

Property metadata utilities

allKnownDescriptors :: [AnyDescriptor]

A list of descriptors for all known Propertys.

propertyUnknown :: String -> ValuedPropertyInfo UnknownPropertyValue

Builds a ValuedPropertyInfo for an unknown property with the given name. Does not check that the name is actually unknown.

propertyInfo :: Property -> AnyDescriptor

Returns a descriptor for any Property, known or unknown. Because a Property has a Descriptor instance, this function is not normally necessary for use outside of this module, but it can be used to throw away a value associated with a Property and retain only the metadata.

descriptorForName :: String -> AnyDescriptor

Returns a descriptor for the given property name. The name does not have to be for a known property; an unknown property will use propertyUnknown.

descriptorForName' :: String -> Maybe AnyDescriptor

Returns a descriptor for a known property with the given name, or Nothing if the name does not belong to a known property.

stoneAssignmentProperties :: [AnyCoordListDescriptor]

Descriptors for setup properties that assign stones to the board. For use with stoneAssignmentPropertyToStone and stoneToStoneAssignmentProperty.

stoneAssignmentPropertyToStone :: AnyCoordListDescriptor -> Maybe Color

Converts a descriptor in stoneAssignmentProperties to the type of stone it assigns.

stoneToStoneAssignmentProperty :: Maybe Color -> AnyCoordListDescriptor

Converts a type of stone assignment to a descriptor in stoneAssignmentProperties.

markProperty :: Mark -> ValuedPropertyInfo CoordList

Returns the descriptor for a mark.