Safe Haskell	None

Data.SGF.Parse

Synopsis

Documentation

collection :: Stream s m Word8 => ParsecT s u m (Collection, [Warning])Source

Parse a Word8 stream into an SGF collection. A collection is a list of games; the documentation for Game has more details. There are generally two kinds of errors in SGF files: recoverable ones (which will be accumulated in the [Warning] return) and unrecoverable ones (which will result in parse errors).

clipDate :: PartialDate -> PartialDate Source

Clip to a valid, representable date. Years are clipped to the 0000-9999 range; months are clipped to the 1-12 range, and days are clipped to the 1-<number of days in the given month> range (accounting for leap years in the case of February).

If a parsed date is changed by this function, a warning is emitted.

data PropertyType Source

Types of properties, as given in the SGF specification.

Constructors

Move
Setup
Root
GameInfo
Inherit	Technically, these properties have type "none" and attribute "inherit", but the property index lists them as properties of type "inherit" with no attributes, so we follow that lead.
None

Instances

Bounded PropertyType
Enum PropertyType
Eq PropertyType
Ord PropertyType
Read PropertyType
Show PropertyType

properties :: GameType -> PropertyType -> [String]Source

All properties of each type listed in the SGF specification.

extraProperties :: GameType -> PropertyType -> [String]Source

Just the properties associated with specific games.

data Property Source

Constructors

Property

Fields

position :: SourcePos: Currently, this is pretty lame: it doesn't track line number and character number, only byte offset from the beginning of the file. This is because I don't really understand how to correctly track line number and character number properly in the face of dynamically changing encodings, whereas byte number is a totally braindead statistic to track.
name :: String: The literal name of the property. This is guaranteed to be a non-empty string of upper-case ASCII characters.
values :: [[Word8]]: The arguments to the property.

Instances

Eq Property
Ord Property
Show Property

data Error Source

Constructors

KnownError
Fields errorType :: ErrorType errorPosition :: SourcePos
UnknownError
Fields errorDescription :: Maybe String

Instances

Eq Error
Ord Error
Show Error
Error Error

DuplicatePropertyOmitted Property
SquareSizeSpecifiedAsRectangle SourcePos
DanglingEscapeCharacterOmitted SourcePos
PropValueForNonePropertyOmitted Property
UnknownPropertyPreserved String
PointSpecifiedAsPointRange Property
DuplicatePointsOmitted Property [Point]
InvalidDatesClipped (Set PartialDate)
AnnotationWithNoMoveOmitted Property
ExtraGameInfoOmitted Property
NestedRootPropertyOmitted Property
MovelessAnnotationOmitted Property
DuplicateSetupOperationsOmitted [Point]
ExtraPositionalJudgmentOmitted (Judgment, Emphasis)
DuplicateMarkupOmitted (Mark, Point)
ExtraPropertyValuesOmitted Property
DuplicateLabelOmitted (Point, String)
UnknownNumberingIgnored Integer

UnknownEncoding
AmbiguousEncoding
FormatUnsupported
GameUnsupported
OutOfBounds
BadlyFormattedValue
BadlyEncodedValue
ConcurrentMoveAndSetup
ConcurrentBlackAndWhiteMove
ConcurrentAnnotations
ExtraMoveAnnotations

Bounded ErrorType
Enum ErrorType
Eq ErrorType
Ord ErrorType
Read ErrorType
Show ErrorType