Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.SGF.Parse

Contents

Orphan instances

Synopsis

collection :: Stream s m Word8 => ParsecT s u m (Collection, [Warning])
clipDate :: PartialDate -> PartialDate
data PropertyType
- = Move
- | Setup
- | Root
- | GameInfo
- | Inherit
- | None
properties :: GameType -> PropertyType -> [String]
extraProperties :: GameType -> PropertyType -> [String]
data Property = Property {
- position :: SourcePos
- name :: String
- values :: [[Word8]]
}
data Warning
data ErrorType
data Error
- = KnownError {
  - errorType :: ErrorType
  - errorPosition :: SourcePos
  }
- | UnknownError {
  - errorDescription :: Maybe String
  }

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

Instances details

Bounded PropertyType Source #
Instance details Defined in Data.SGF.Parse Methods minBound :: PropertyType # maxBound :: PropertyType #
Enum PropertyType Source #
Instance details Defined in Data.SGF.Parse Methods succ :: PropertyType -> PropertyType # pred :: PropertyType -> PropertyType # toEnum :: Int -> PropertyType # fromEnum :: PropertyType -> Int # enumFrom :: PropertyType -> [PropertyType] # enumFromThen :: PropertyType -> PropertyType -> [PropertyType] # enumFromTo :: PropertyType -> PropertyType -> [PropertyType] # enumFromThenTo :: PropertyType -> PropertyType -> PropertyType -> [PropertyType] #
Read PropertyType Source #
Instance details Defined in Data.SGF.Parse Methods readsPrec :: Int -> ReadS PropertyType # readList :: ReadS [PropertyType] # readPrec :: ReadPrec PropertyType # readListPrec :: ReadPrec [PropertyType] #
Show PropertyType Source #
Instance details Defined in Data.SGF.Parse Methods showsPrec :: Int -> PropertyType -> ShowS # show :: PropertyType -> String # showList :: [PropertyType] -> ShowS #
Eq PropertyType Source #
Instance details Defined in Data.SGF.Parse Methods (==) :: PropertyType -> PropertyType -> Bool # (/=) :: PropertyType -> PropertyType -> Bool #
Ord PropertyType Source #
Instance details Defined in Data.SGF.Parse Methods compare :: PropertyType -> PropertyType -> Ordering # (<) :: PropertyType -> PropertyType -> Bool # (<=) :: PropertyType -> PropertyType -> Bool # (>) :: PropertyType -> PropertyType -> Bool # (>=) :: PropertyType -> PropertyType -> Bool # max :: PropertyType -> PropertyType -> PropertyType # min :: PropertyType -> PropertyType -> 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

Instances details

Show Property Source #
Instance details Defined in Data.SGF.Parse.Raw Methods showsPrec :: Int -> Property -> ShowS # show :: Property -> String # showList :: [Property] -> ShowS #
Eq Property Source #
Instance details Defined in Data.SGF.Parse.Raw Methods (==) :: Property -> Property -> Bool # (/=) :: Property -> Property -> Bool #
Ord Property Source #
Instance details Defined in Data.SGF.Parse.Raw Methods compare :: Property -> Property -> Ordering # (<) :: Property -> Property -> Bool # (<=) :: Property -> Property -> Bool # (>) :: Property -> Property -> Bool # (>=) :: Property -> Property -> Bool # max :: Property -> Property -> Property # min :: Property -> Property -> Property #

data Warning Source #

Warnings signify recoverable errors.

Instances

Instances details

Show Warning Source #
Instance details Defined in Data.SGF.Parse.Util Methods showsPrec :: Int -> Warning -> ShowS # show :: Warning -> String # showList :: [Warning] -> ShowS #
Eq Warning Source #
Instance details Defined in Data.SGF.Parse.Util Methods (==) :: Warning -> Warning -> Bool # (/=) :: Warning -> Warning -> Bool #
Ord Warning Source #
Instance details Defined in Data.SGF.Parse.Util Methods compare :: Warning -> Warning -> Ordering # (<) :: Warning -> Warning -> Bool # (<=) :: Warning -> Warning -> Bool # (>) :: Warning -> Warning -> Bool # (>=) :: Warning -> Warning -> Bool # max :: Warning -> Warning -> Warning # min :: Warning -> Warning -> Warning #

data ErrorType Source #

Constructors

UnknownEncoding
AmbiguousEncoding
FormatUnsupported
GameUnsupported
OutOfBounds
BadlyFormattedValue
BadlyEncodedValue
ConcurrentMoveAndSetup
ConcurrentBlackAndWhiteMove
ConcurrentAnnotations
ExtraMoveAnnotations

Instances

Instances details

Bounded ErrorType Source #
Instance details Defined in Data.SGF.Parse.Util Methods minBound :: ErrorType # maxBound :: ErrorType #
Enum ErrorType Source #
Instance details Defined in Data.SGF.Parse.Util Methods succ :: ErrorType -> ErrorType # pred :: ErrorType -> ErrorType # toEnum :: Int -> ErrorType # fromEnum :: ErrorType -> Int # enumFrom :: ErrorType -> [ErrorType] # enumFromThen :: ErrorType -> ErrorType -> [ErrorType] # enumFromTo :: ErrorType -> ErrorType -> [ErrorType] # enumFromThenTo :: ErrorType -> ErrorType -> ErrorType -> [ErrorType] #
Read ErrorType Source #
Instance details Defined in Data.SGF.Parse.Util Methods readsPrec :: Int -> ReadS ErrorType # readList :: ReadS [ErrorType] # readPrec :: ReadPrec ErrorType # readListPrec :: ReadPrec [ErrorType] #
Show ErrorType Source #
Instance details Defined in Data.SGF.Parse.Util Methods showsPrec :: Int -> ErrorType -> ShowS # show :: ErrorType -> String # showList :: [ErrorType] -> ShowS #
Eq ErrorType Source #
Instance details Defined in Data.SGF.Parse.Util Methods (==) :: ErrorType -> ErrorType -> Bool # (/=) :: ErrorType -> ErrorType -> Bool #
Ord ErrorType Source #
Instance details Defined in Data.SGF.Parse.Util Methods compare :: ErrorType -> ErrorType -> Ordering # (<) :: ErrorType -> ErrorType -> Bool # (<=) :: ErrorType -> ErrorType -> Bool # (>) :: ErrorType -> ErrorType -> Bool # (>=) :: ErrorType -> ErrorType -> Bool # max :: ErrorType -> ErrorType -> ErrorType # min :: ErrorType -> ErrorType -> ErrorType #

data Error Source #

Constructors

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

Instances

Instances details

Show Error Source #
Instance details Defined in Data.SGF.Parse.Util Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #
Eq Error Source #
Instance details Defined in Data.SGF.Parse.Util Methods (==) :: Error -> Error -> Bool # (/=) :: Error -> Error -> Bool #
Ord Error Source #
Instance details Defined in Data.SGF.Parse.Util Methods compare :: Error -> Error -> Ordering # (<) :: Error -> Error -> Bool # (<=) :: Error -> Error -> Bool # (>) :: Error -> Error -> Bool # (>=) :: Error -> Error -> Bool # max :: Error -> Error -> Error # min :: Error -> Error -> Error #
MonadFail (Either Error) Source #
Instance details Defined in Data.SGF.Parse Methods fail :: String -> Either Error a #

Orphan instances

MonadFail (Either Error) Source #
Instance details Methods fail :: String -> Either Error a #

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