Text.Lips

Monadic parsing combinator library with attention to locations.

Documentation

data ParsedLines

Lines of text consumed by a parser (fully or partially).

Constructors

ParsedLines

Fields

• plFull :: Seq Text

  Fully consumed lines

• plPartial :: Maybe Text

  Partially consumed line

Instances

Show ParsedLines

Methods

showsPrec :: Int -> ParsedLines -> ShowS

show :: ParsedLines -> String

showList :: [ParsedLines] -> ShowS

data Parser α

Opaque parser type.

Instances

Monad Parser

Methods

(>>=) :: Parser a -> (a -> Parser b) -> Parser b

(>>) :: Parser a -> Parser b -> Parser b

return :: a -> Parser a

fail :: String -> Parser a

Functor Parser

Methods

fmap :: (a -> b) -> Parser a -> Parser b

(<$) :: a -> Parser b -> Parser a

Applicative Parser

Methods

pure :: a -> Parser a

(<*>) :: Parser (a -> b) -> Parser a -> Parser b

(*>) :: Parser a -> Parser b -> Parser b

(<*) :: Parser a -> Parser b -> Parser a

Alternative Parser

Methods

empty :: Parser a

(<|>) :: Parser a -> Parser a -> Parser a

some :: Parser a -> Parser [a]

many :: Parser a -> Parser [a]

MonadPlus Parser

Methods

mzero :: Parser a

mplus :: Parser a -> Parser a -> Parser a

CharParsing Parser

Methods

satisfy :: (Char -> Bool) -> Parser Char

char :: Char -> Parser Char

notChar :: Char -> Parser Char

anyChar :: Parser Char

string :: String -> Parser String

text :: Text -> Parser Text

Parsing Parser

Methods

try :: Parser a -> Parser a

(<?>) :: Parser a -> String -> Parser a

skipMany :: Parser a -> Parser ()

skipSome :: Parser a -> Parser ()

unexpected :: String -> Parser a

eof :: Parser ()

notFollowedBy :: Show a => Parser a -> Parser ()

ResetLineParsing Parser

Methods

resetLineNr :: Word -> Parser (Seq Text)

LocParsing Parser

Associated Types

type ParserLoc (Parser :: * -> *) :: *

Methods

location :: Parser (ParserLoc Parser)

located :: Parser α -> Parser (Located (ParserLoc Parser) α)

spanned :: Parser α -> Parser (Located (Span (ParserLoc Parser)) α)

(~) * α String => IsString (Parser α)

Methods

fromString :: String -> Parser α

type ParserLoc Parser

type ParserLoc Parser = LineCol

data ParserResult α

Parser result.

Constructors

ParserSuccess

Fields

• prLeftovers :: [Text]

  Unparsed input

• prLines :: ParsedLines

  Parsed input

• prLoc :: LineCol

  Last location

• prResult :: α

  Parsed value

ParserFailure

Fields

• prLeftovers :: [Text]

  Unparsed input

• prLines :: ParsedLines

  Parsed input

• prLoc :: LineCol

  Last location

• prErrCtx :: [String]

  Error context

• prErrMsg :: String

  Error message

Instances

Show α => Show (ParserResult α)

Methods

showsPrec :: Int -> ParserResult α -> ShowS

show :: ParserResult α -> String

showList :: [ParserResult α] -> ShowS

data ParserStep α

Parser continuation.

Constructors

ParserCont (Text -> ParserStep α) (ParserResult α)

ParserDone (ParserResult α)

startParser :: Parser α -> ParserStep α

Start a parser.

startParserAtLine :: Word -> Text -> Parser α -> ParserStep α

Start a parser on a specific line number and provide it with a first chunk of the input.

starveParser :: ParserStep α -> ParserResult α

Feed a parser continuation with empty input.

parseText :: Text -> Parser α -> ParserResult α

Run a parser on a text.

class CharParsing p => LocParsing p where

Parsers that provide location information.

Minimal complete definition

located, spanned

Associated Types

type ParserLoc p

Parser location type.

Methods

location :: p (ParserLoc p)

The current location.

location :: (MonadTrans t, Monad m, LocParsing m, p ~ t m, ParserLoc p ~ ParserLoc m) => p (ParserLoc p)

The current location.

located :: p α -> p (Located (ParserLoc p) α)

Attach the starting location to the parsed value.

spanned :: p α -> p (Located (Span (ParserLoc p)) α)

Attach the spanned location to the parsed value.

Instances

LocParsing Parser

Associated Types

type ParserLoc (Parser :: * -> *) :: *

Methods

location :: Parser (ParserLoc Parser)

located :: Parser α -> Parser (Located (ParserLoc Parser) α)

spanned :: Parser α -> Parser (Located (Span (ParserLoc Parser)) α)

(MonadPlus p, LocParsing p) => LocParsing (StateT s p)

Associated Types

type ParserLoc (StateT s p :: * -> *) :: *

Methods

location :: StateT s p (ParserLoc (StateT s p))

located :: StateT s p α -> StateT s p (Located (ParserLoc (StateT s p)) α)

spanned :: StateT s p α -> StateT s p (Located (Span (ParserLoc (StateT s p))) α)

(MonadPlus p, LocParsing p) => LocParsing (StateT s p)

Associated Types

type ParserLoc (StateT s p :: * -> *) :: *

Methods

location :: StateT s p (ParserLoc (StateT s p))

located :: StateT s p α -> StateT s p (Located (ParserLoc (StateT s p)) α)

spanned :: StateT s p α -> StateT s p (Located (Span (ParserLoc (StateT s p))) α)

(Monoid w, MonadPlus p, LocParsing p) => LocParsing (WriterT w p)

Associated Types

type ParserLoc (WriterT w p :: * -> *) :: *

Methods

location :: WriterT w p (ParserLoc (WriterT w p))

located :: WriterT w p α -> WriterT w p (Located (ParserLoc (WriterT w p)) α)

spanned :: WriterT w p α -> WriterT w p (Located (Span (ParserLoc (WriterT w p))) α)

(Monoid w, MonadPlus p, LocParsing p) => LocParsing (WriterT w p)

Associated Types

type ParserLoc (WriterT w p :: * -> *) :: *

Methods

location :: WriterT w p (ParserLoc (WriterT w p))

located :: WriterT w p α -> WriterT w p (Located (ParserLoc (WriterT w p)) α)

spanned :: WriterT w p α -> WriterT w p (Located (Span (ParserLoc (WriterT w p))) α)

(MonadPlus p, LocParsing p) => LocParsing (IdentityT * p)

Associated Types

type ParserLoc (IdentityT * p :: * -> *) :: *

Methods

location :: IdentityT * p (ParserLoc (IdentityT * p))

located :: IdentityT * p α -> IdentityT * p (Located (ParserLoc (IdentityT * p)) α)

spanned :: IdentityT * p α -> IdentityT * p (Located (Span (ParserLoc (IdentityT * p))) α)

(MonadPlus p, LocParsing p) => LocParsing (ReaderT * r p)

Associated Types

type ParserLoc (ReaderT * r p :: * -> *) :: *

Methods

location :: ReaderT * r p (ParserLoc (ReaderT * r p))

located :: ReaderT * r p α -> ReaderT * r p (Located (ParserLoc (ReaderT * r p)) α)

spanned :: ReaderT * r p α -> ReaderT * r p (Located (Span (ParserLoc (ReaderT * r p))) α)

(Monoid w, MonadPlus p, LocParsing p) => LocParsing (RWST r w s p)

Associated Types

type ParserLoc (RWST r w s p :: * -> *) :: *

Methods

location :: RWST r w s p (ParserLoc (RWST r w s p))

located :: RWST r w s p α -> RWST r w s p (Located (ParserLoc (RWST r w s p)) α)

spanned :: RWST r w s p α -> RWST r w s p (Located (Span (ParserLoc (RWST r w s p))) α)

(Monoid w, MonadPlus p, LocParsing p) => LocParsing (RWST r w s p)

Associated Types

type ParserLoc (RWST r w s p :: * -> *) :: *

Methods

location :: RWST r w s p (ParserLoc (RWST r w s p))

located :: RWST r w s p α -> RWST r w s p (Located (ParserLoc (RWST r w s p)) α)

spanned :: RWST r w s p α -> RWST r w s p (Located (Span (ParserLoc (RWST r w s p))) α)

class LocParsing p => ResetLineParsing p where

Parsers with resettable line numbers.

Methods

resetLineNr :: Word -> p (Seq Text)

Reset the current line number and return the text lines fully consumed by the parser so far.

resetLineNr :: (MonadTrans t, Monad m, ResetLineParsing m, p ~ t m) => Word -> p (Seq Text)

Reset the current line number and return the text lines fully consumed by the parser so far.

Instances

ResetLineParsing Parser

Methods

resetLineNr :: Word -> Parser (Seq Text)

(MonadPlus p, ResetLineParsing p) => ResetLineParsing (StateT s p)

Methods

resetLineNr :: Word -> StateT s p (Seq Text)

(MonadPlus p, ResetLineParsing p) => ResetLineParsing (StateT s p)

Methods

resetLineNr :: Word -> StateT s p (Seq Text)

(Monoid w, MonadPlus p, ResetLineParsing p) => ResetLineParsing (WriterT w p)

Methods

resetLineNr :: Word -> WriterT w p (Seq Text)

(Monoid w, MonadPlus p, ResetLineParsing p) => ResetLineParsing (WriterT w p)

Methods

resetLineNr :: Word -> WriterT w p (Seq Text)

(MonadPlus p, ResetLineParsing p) => ResetLineParsing (IdentityT * p)

Methods

resetLineNr :: Word -> IdentityT * p (Seq Text)

(MonadPlus p, ResetLineParsing p) => ResetLineParsing (ReaderT * r p)

Methods

resetLineNr :: Word -> ReaderT * r p (Seq Text)

(Monoid w, MonadPlus p, ResetLineParsing p) => ResetLineParsing (RWST r w s p)

Methods

resetLineNr :: Word -> RWST r w s p (Seq Text)

(Monoid w, MonadPlus p, ResetLineParsing p) => ResetLineParsing (RWST r w s p)

Methods

resetLineNr :: Word -> RWST r w s p (Seq Text)