Text.Ginger.Parse

Ginger parser.

Documentation

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

Parse Ginger source from memory. The initial template is taken directly from the provided Source, while all subsequent includes are loaded through the provided IncludeResolver.

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

Parse Ginger source from a file. Both the initial template and all subsequent includes are loaded through the provided IncludeResolver. A consequence of this is that if you pass a "null resolver" (like `const (return Nothing)`), this function will always fail.

parseGinger' :: Monad m => ParserOptions m -> Source -> m (Either ParserError (Template SourcePos))

Parse Ginger source from memory. Flavor of parseGinger that takes additional ParserOptions.

parseGingerFile' :: Monad m => ParserOptions m -> SourceName -> m (Either ParserError (Template SourcePos))

Parse Ginger source from a file. Flavor of parseGingerFile that takes additional ParserOptions.

data ParserError

Error information for Ginger parser errors.

Constructors

ParserError

Fields

• peErrorMessage :: String

  Human-readable error message

• peSourcePosition :: Maybe SourcePos

Instances

Show ParserError

Defined in Text.Ginger.Parse

Methods

showsPrec :: Int -> ParserError -> ShowS

show :: ParserError -> String

showList :: [ParserError] -> ShowS

Generic ParserError

Defined in Text.Ginger.Parse

Associated Types

type Rep ParserError :: Type -> Type

Methods

from :: ParserError -> Rep ParserError x

to :: Rep ParserError x -> ParserError

Exception ParserError

Defined in Text.Ginger.Parse

Methods

toException :: ParserError -> SomeException

fromException :: SomeException -> Maybe ParserError

displayException :: ParserError -> String

type Rep ParserError

Defined in Text.Ginger.Parse

type Rep ParserError = D1 (MetaData "ParserError" "Text.Ginger.Parse" "ginger-0.8.2.0-7D19jtPjl0e8nb8DBJlYC7" False) (C1 (MetaCons "ParserError" PrefixI True) (S1 (MetaSel (Just "peErrorMessage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: S1 (MetaSel (Just "peSourcePosition") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe SourcePos))))

data ParserOptions m

Constructors

ParserOptions

Fields

• poIncludeResolver :: IncludeResolver m

  How to load templates / includes

• poSourceName :: Maybe SourceName

  Current source file name, if any

• poKeepTrailingNewline :: Bool

  Disable newline stripping

• poLStripBlocks :: Bool

  Enable auto-stripping of {% block %}s

• poTrimBlocks :: Bool

  Enable auto-trimming of {% block %}s

• poDelimiters :: Delimiters

  Interpolation, tag, and comment delimiters

mkParserOptions :: Monad m => IncludeResolver m -> ParserOptions m

Default parser options for a given resolver

data Delimiters

Delimiter configuration.

Constructors

Delimiters

Fields

• delimOpenInterpolation :: String
• delimCloseInterpolation :: String
• delimOpenTag :: String
• delimCloseTag :: String
• delimOpenComment :: String
• delimCloseComment :: String

defDelimiters :: Delimiters

Default delimiter configuration: {{ }} for interpolation, {% %} for tags, {} for comments.

formatParserError

Arguments

:: Maybe String

Template source code (not filename)

-> ParserError

Error to format

-> String

Formats a parser errror into something human-friendly. If template source code is not provided, only the line and column numbers and the error message are printed. If template source code is provided, the offending source line is also printed, with a caret (^) marking the exact location of the error.

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

data SourcePos

The abstract data type SourcePos represents source positions. It contains the name of the source (i.e. file name), a line number and a column number. SourcePos is an instance of the Show, Eq and Ord class.

Instances

Eq SourcePos

Defined in Text.Parsec.Pos

Methods

(==) :: SourcePos -> SourcePos -> Bool

(/=) :: SourcePos -> SourcePos -> Bool

Data SourcePos

Defined in Text.Parsec.Pos

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SourcePos -> c SourcePos

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SourcePos

toConstr :: SourcePos -> Constr

dataTypeOf :: SourcePos -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SourcePos)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SourcePos)

gmapT :: (forall b. Data b => b -> b) -> SourcePos -> SourcePos

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SourcePos -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SourcePos -> r

gmapQ :: (forall d. Data d => d -> u) -> SourcePos -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SourcePos -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SourcePos -> m SourcePos

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SourcePos -> m SourcePos

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SourcePos -> m SourcePos

Ord SourcePos

Defined in Text.Parsec.Pos

Methods

compare :: SourcePos -> SourcePos -> Ordering

(<) :: SourcePos -> SourcePos -> Bool

(<=) :: SourcePos -> SourcePos -> Bool

(>) :: SourcePos -> SourcePos -> Bool

(>=) :: SourcePos -> SourcePos -> Bool

max :: SourcePos -> SourcePos -> SourcePos

min :: SourcePos -> SourcePos -> SourcePos

Show SourcePos

Defined in Text.Parsec.Pos

Methods

showsPrec :: Int -> SourcePos -> ShowS

show :: SourcePos -> String

showList :: [SourcePos] -> ShowS

ToGVal m SourcePos

Defined in Text.Ginger.Parse

Methods

toGVal :: SourcePos -> GVal m

sourceName :: SourcePos -> SourceName

Extracts the name of the source from a source position.

sourceLine :: SourcePos -> Line

Extracts the line number from a source position.

sourceColumn :: SourcePos -> Column

Extracts the column number from a source position.

setSourceName :: SourcePos -> SourceName -> SourcePos

Set the name of the source.

Orphan instances

ToGVal m SourcePos

Methods

toGVal :: SourcePos -> GVal m