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

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).