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.

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

Parse Ginger source from a file.

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

Parse Ginger source from memory.

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

Parse Ginger source from a file.

data ParserError

Error information for Ginger parser errors.

Constructors

ParserError

Fields

• peErrorMessage :: String

  Human-readable error message

• peSourcePosition :: Maybe SourcePos

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.7.1.0-HH2VkQxGaqlBrXp82r90z" False) (C1 (MetaCons "ParserError" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "peErrorMessage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) (S1 (MetaSel (Just Symbol "peSourcePosition") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe SourcePos)))))

data ParserOptions m

Constructors

ParserOptions

Fields

• poIncludeResolver :: IncludeResolver m
• poSourceName :: Maybe SourceName
• poKeepTrailingNewline :: Bool
• poLStripBlocks :: Bool
• poTrimBlocks :: Bool

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

formatParserError :: Maybe String -> ParserError -> String

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

Methods

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

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

Data SourcePos

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

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

Methods

showsPrec :: Int -> SourcePos -> ShowS

show :: SourcePos -> String

showList :: [SourcePos] -> ShowS

sourceLine :: SourcePos -> Line

Extracts the line number from a source position.

sourceColumn :: SourcePos -> Column

Extracts the column number from a source position.

sourceName :: SourcePos -> SourceName

Extracts the name of the source from a source position.

Orphan instances

ToGVal m SourcePos

Methods

toGVal :: SourcePos -> GVal m