Text.EDE.Internal.Types

Warning: this is an internal module, and does not have a stable API or name. Functions in this module may not check or enforce preconditions expected by public modules. Use at your own risk!

Documentation

type AnsiDoc = Doc AnsiStyle

class AnsiPretty a where

Methods

apretty :: a -> AnsiDoc

Instances

AnsiPretty Var

Defined in Text.EDE.Internal.Types

Methods

apretty :: Var -> AnsiDoc

AnsiPretty Term

Defined in Text.EDE.Internal.Quoting

Methods

apretty :: Term -> AnsiDoc

Show a => AnsiPretty (Result a)

Defined in Text.EDE.Internal.Types

Methods

apretty :: Result a -> AnsiDoc

AnsiPretty (PP Text)

Defined in Text.EDE.Internal.Types

Methods

apretty :: PP Text -> AnsiDoc

AnsiPretty (PP Value)

Defined in Text.EDE.Internal.Types

Methods

apretty :: PP Value -> AnsiDoc

newtype PP a

Convenience wrapper for Pretty instances.

Constructors

PP

Fields

• unPP :: a

Instances

AnsiPretty (PP Text)

Defined in Text.EDE.Internal.Types

Methods

apretty :: PP Text -> AnsiDoc

AnsiPretty (PP Value)

Defined in Text.EDE.Internal.Types

Methods

apretty :: PP Value -> AnsiDoc

pp :: AnsiPretty (PP a) => a -> AnsiDoc

(</>) :: Doc ann -> Doc ann -> Doc ann

bold :: AnsiDoc -> AnsiDoc

red :: AnsiDoc -> AnsiDoc

data Result a

The result of running parsing or rendering steps.

Constructors

Success a

Failure AnsiDoc

Instances

Monad Result

Defined in Text.EDE.Internal.Types

Methods

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

(>>) :: Result a -> Result b -> Result b

return :: a -> Result a

Functor Result

Defined in Text.EDE.Internal.Types

Methods

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

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

Applicative Result

Defined in Text.EDE.Internal.Types

Methods

pure :: a -> Result a

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

liftA2 :: (a -> b -> c) -> Result a -> Result b -> Result c

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

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

Foldable Result

Defined in Text.EDE.Internal.Types

Methods

fold :: Monoid m => Result m -> m

foldMap :: Monoid m => (a -> m) -> Result a -> m

foldMap' :: Monoid m => (a -> m) -> Result a -> m

foldr :: (a -> b -> b) -> b -> Result a -> b

foldr' :: (a -> b -> b) -> b -> Result a -> b

foldl :: (b -> a -> b) -> b -> Result a -> b

foldl' :: (b -> a -> b) -> b -> Result a -> b

foldr1 :: (a -> a -> a) -> Result a -> a

foldl1 :: (a -> a -> a) -> Result a -> a

toList :: Result a -> [a]

null :: Result a -> Bool

length :: Result a -> Int

elem :: Eq a => a -> Result a -> Bool

maximum :: Ord a => Result a -> a

minimum :: Ord a => Result a -> a

sum :: Num a => Result a -> a

product :: Num a => Result a -> a

Traversable Result

Defined in Text.EDE.Internal.Types

Methods

traverse :: Applicative f => (a -> f b) -> Result a -> f (Result b)

sequenceA :: Applicative f => Result (f a) -> f (Result a)

mapM :: Monad m => (a -> m b) -> Result a -> m (Result b)

sequence :: Monad m => Result (m a) -> m (Result a)

Alternative Result

Defined in Text.EDE.Internal.Types

Methods

empty :: Result a

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

some :: Result a -> Result [a]

many :: Result a -> Result [a]

Show a => Show (Result a)

Defined in Text.EDE.Internal.Types

Methods

showsPrec :: Int -> Result a -> ShowS

show :: Result a -> String

showList :: [Result a] -> ShowS

Show a => AnsiPretty (Result a)

Defined in Text.EDE.Internal.Types

Methods

apretty :: Result a -> AnsiDoc

_Failure :: forall a. Prism' (Result a) AnsiDoc

_Success :: forall a a. Prism (Result a) (Result a) a a

eitherResult :: Result a -> Either String a

Convert a Result to an Either with the Left case holding a formatted error message, and Right being the successful result over which Result is paramterised.

result

Arguments

:: (AnsiDoc -> b)

Function to apply to the Failure case.

-> (a -> b)

Function to apply to the Success case.

-> Result a

The Result to map over.

-> b

Perform a case analysis on a Result.

success :: Monad m => a -> m (Result a)

Convenience for returning a successful Result.

failure :: Monad m => AnsiDoc -> m (Result a)

Convenience for returning an error Result.

type Delim = (String, String)

data Syntax

Constructors

Syntax

Fields

• _delimPragma :: !Delim
• _delimInline :: !Delim
• _delimComment :: !Delim
• _delimBlock :: !Delim

Instances

HasSyntax Syntax

Defined in Text.EDE.Internal.Types

Methods

syntax :: Lens' Syntax Syntax

delimBlock :: Lens' Syntax Delim

delimComment :: Lens' Syntax Delim

delimInline :: Lens' Syntax Delim

delimPragma :: Lens' Syntax Delim

class HasSyntax c where

Minimal complete definition

syntax

Methods

syntax :: Lens' c Syntax

delimBlock :: Lens' c Delim

delimComment :: Lens' c Delim

delimInline :: Lens' c Delim

delimPragma :: Lens' c Delim

Instances

HasSyntax Syntax

Defined in Text.EDE.Internal.Types

Methods

syntax :: Lens' Syntax Syntax

delimBlock :: Lens' Syntax Delim

delimComment :: Lens' Syntax Delim

delimInline :: Lens' Syntax Delim

delimPragma :: Lens' Syntax Delim

HasSyntax Env

Defined in Text.EDE.Internal.Parser

Methods

syntax :: Lens' Env Syntax

delimBlock :: Lens' Env Delim

delimComment :: Lens' Env Delim

delimInline :: Lens' Env Delim

delimPragma :: Lens' Env Delim

type Resolver m = Syntax -> Id -> Delta -> m (Result Template)

A function to resolve the target of an include expression.

data Template

A parsed and compiled template.

Constructors

Template

Fields

• _tmplName :: !Text
• _tmplExp :: !(Exp Delta)
• _tmplIncl :: HashMap Id (Exp Delta)

Instances

Eq Template

Defined in Text.EDE.Internal.Types

Methods

(==) :: Template -> Template -> Bool

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

type Id = Text

newtype Var

Constructors

Var (NonEmpty Id)

Instances

Eq Var

Defined in Text.EDE.Internal.Types

Methods

(==) :: Var -> Var -> Bool

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

Show Var

Defined in Text.EDE.Internal.Types

Methods

showsPrec :: Int -> Var -> ShowS

show :: Var -> String

showList :: [Var] -> ShowS

AnsiPretty Var

Defined in Text.EDE.Internal.Types

Methods

apretty :: Var -> AnsiDoc

data Collection where

Constructors

Col :: Foldable f => Int -> f (Maybe Text, Value) -> Collection

Instances

Unquote Collection

Defined in Text.EDE.Internal.Quoting

Methods

unquote :: Id -> Int -> Term -> Result Collection

data Pat

Constructors

PWild

PVar !Var

PLit !Value

Instances

Eq Pat

Defined in Text.EDE.Internal.Types

Methods

(==) :: Pat -> Pat -> Bool

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

Show Pat

Defined in Text.EDE.Internal.Types

Methods

showsPrec :: Int -> Pat -> ShowS

show :: Pat -> String

showList :: [Pat] -> ShowS

type Alt a = (Pat, a)

data ExpF a

Constructors

ELit !Value

EVar !Var

EFun !Id

EApp !a !a

ELet !Id !a !a

ECase !a [Alt a]

ELoop !Id !a !a

EIncl !Text

Instances

Functor ExpF

Defined in Text.EDE.Internal.Types

Methods

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

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

Eq1 ExpF

Defined in Text.EDE.Internal.Types

Methods

liftEq :: (a -> b -> Bool) -> ExpF a -> ExpF b -> Bool

Eq a => Eq (ExpF a)

Defined in Text.EDE.Internal.Types

Methods

(==) :: ExpF a -> ExpF a -> Bool

(/=) :: ExpF a -> ExpF a -> Bool

Show a => Show (ExpF a)

Defined in Text.EDE.Internal.Types

Methods

showsPrec :: Int -> ExpF a -> ShowS

show :: ExpF a -> String

showList :: [ExpF a] -> ShowS

HasDelta (Exp Delta)

Defined in Text.EDE.Internal.Types

Methods

delta :: Exp Delta -> Delta

type Exp = Cofree ExpF

fromValue :: Value -> Maybe Object

Unwrap a Value to an Object safely.

See Aeson's documentation for more details.

fromPairs :: [Pair] -> Object

Create an Object from a list of name/value Pairs.

See Aeson's documentation for more details.