Text.Ginger.Parse

Ginger parser.

Documentation

parseGinger :: Monad m => IncludeResolver m -> Maybe SourceName -> Source -> m (Either ParserError Template)

Parse Ginger source from memory.

parseGingerFile :: Monad m => IncludeResolver m -> SourceName -> m (Either ParserError Template)

Parse Ginger source from a file.

data ParserError

Error information for Ginger parser errors.

Constructors

ParserError

Fields

• peErrorMessage :: String

  Human-readable error message

• peSourceName :: Maybe SourceName

  Source name, if any

• peSourceLine :: Maybe Int

  Line number, if available

• peSourceColumn :: Maybe Int

  Column number, if available

Instances

Show ParserError

Methods

showsPrec :: Int -> ParserError -> ShowS

show :: ParserError -> String

showList :: [ParserError] -> ShowS

Generic ParserError

Associated Types

type Rep ParserError :: * -> *

Methods

from :: ParserError -> Rep ParserError x

to :: Rep ParserError x -> ParserError

Exception ParserError

Methods

toException :: ParserError -> SomeException

fromException :: SomeException -> Maybe ParserError

displayException :: ParserError -> String

type Rep ParserError

type Rep ParserError = D1 (MetaData "ParserError" "Text.Ginger.Parse" "ginger-0.3.7.2-C2vAEs7maG52lOmTZnRc5s" False) (C1 (MetaCons "ParserError" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "peErrorMessage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) (S1 (MetaSel (Just Symbol "peSourceName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe SourceName)))) ((:*:) (S1 (MetaSel (Just Symbol "peSourceLine") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "peSourceColumn") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))))))

type IncludeResolver m = SourceName -> m (Maybe Source)

Used to resolve includes. Ginger will call this function whenever it encounters an {% include %}, {% import %}, or {% extends %} directive. If the required source code is not available, the resolver should return Nothing, else Just the source.

type Source = String

Input type for the parser (source code).

type SourceName = String

A source identifier (typically a filename).