Camfort.Specification.Parser

Specification Parsers

data SpecParser e r

Parser for specifications of type r that may fail with error type e.

looksLikeASpec :: SpecParser e r -> String -> Bool

Check if a comment is probably an attempt at a specification that can be parsed by the given parser.

mkParser

Arguments

:: (String -> Either e r)

Parser with error type e and result type r.

-> [String]

Keywords that indicate the type of specification.

-> SpecParser e r

Define a specification parser.

runParser :: SpecParser e r -> String -> Either (SpecParseError e) r

Run the given parser on a string to produce a specification (or a reason why it couldn't be parsed).

Errors

data SpecParseError e

Instances

Eq e => Eq (SpecParseError e)

Methods

(==) :: SpecParseError e -> SpecParseError e -> Bool

(/=) :: SpecParseError e -> SpecParseError e -> Bool

Show e => Show (SpecParseError e)

Methods

showsPrec :: Int -> SpecParseError e -> ShowS

show :: SpecParseError e -> String

showList :: [SpecParseError e] -> ShowS

parseError :: e -> SpecParseError e

Embed an error as a specification parse error.