Slab.Syntax

Slab.Syntax provides data types to represent the syntax used by the Slab language. It also provides small helpers functions to operate on the syntax.

Documentation

data Block

Constructors

BlockDoctype

Only doctype html for now.

BlockElem Elem TrailingSym [Attr] [Block]

BlockText TextSyntax [Inline]

BlockInclude (Maybe Text) FilePath (Maybe [Block])

Nothing when the template is parsed, then Just nodes after preprocessing (i.e. actually running the include statement). The filter name follows the same behavior as BlockFilter.

BlockFragmentDef DefinitionUse Text [Text] [Block]

BlockFragmentCall Text TrailingSym [Attr] [Expr] [Block]

BlockFor Text (Maybe Text) Expr [Block]

BlockComment CommentType Text

BlockFilter Text Text

BlockRawElem Text [Block]

BlockDefault Text [Block]

default defines an optional formal parameter with a default content. Its content is used when the argument is not given.

BlockImport FilePath (Maybe [Block]) [Block]

Similar to an anonymous fragment call, where the fragment body is the content of the referenced file.

BlockRun Text (Maybe Text) (Maybe [Block])

Run an external command, with maybe some stdin input.

BlockAssignVars [(Text, Expr)]

BlockIf Expr [Block] [Block]

BlockList [Block]

BlockCode Expr

Instances

Show Block

Defined in Slab.Syntax

Methods

showsPrec :: Int -> Block -> ShowS

show :: Block -> String

showList :: [Block] -> ShowS

Eq Block

Defined in Slab.Syntax

Methods

(==) :: Block -> Block -> Bool

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

isDoctype :: Block -> Bool

pasteBlocks :: Block -> Block -> Block

Takes two blocks and returns a BlockList containing both, but peel the outer list of a and b if they are themselves BlockList.

setAttrs :: [Attr] -> [Block] -> [Block]

Set attrs on a the first block, if it is a BlockElem.

setContent :: [Block] -> Block -> Block

Set the content on a block, if it is a BlockElem.

addScript :: Text -> [Block] -> [Block]

Find the head element and add a script element at its end. TODO This doesn't go through all children to find the head. It's best to use "Evaluate.simplify" before using this function.

data CommentType

A "passthrough" comment will be included in the generated HTML.

Constructors

NormalComment

PassthroughComment

Instances

Show CommentType

Defined in Slab.Syntax

Methods

showsPrec :: Int -> CommentType -> ShowS

show :: CommentType -> String

showList :: [CommentType] -> ShowS

Eq CommentType

Defined in Slab.Syntax

Methods

(==) :: CommentType -> CommentType -> Bool

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

data Elem

Constructors

Html

Body

Div

Span

Br

Hr

H1

H2

H3

H4

H5

H6

Header

Head

Meta

Main

Link

A

P

Em

Ul

Li

Title

Table

Thead

Tbody

Tr

Td

Dl

Dt

Dd

Footer

Figure

Form

Label

Blockquote

Button

Figcaption

Audio

Script

Style

Small

Source

Pre

Code

Img

IFrame

Input

I

Svg

Textarea

Canvas

Elem Text

Arbitrary element name, using the el keyword.

Instances

Show Elem

Defined in Slab.Syntax

Methods

showsPrec :: Int -> Elem -> ShowS

show :: Elem -> String

showList :: [Elem] -> ShowS

Eq Elem

Defined in Slab.Syntax

Methods

(==) :: Elem -> Elem -> Bool

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

data DefinitionUse

Specifies if a fragment definition is a normal definition, or one meant to be an argument of a fragment call.

Constructors

DefinitionNormal

DefinitionArg

Instances

Show DefinitionUse

Defined in Slab.Syntax

Methods

showsPrec :: Int -> DefinitionUse -> ShowS

show :: DefinitionUse -> String

showList :: [DefinitionUse] -> ShowS

Eq DefinitionUse

Defined in Slab.Syntax

Methods

(==) :: DefinitionUse -> DefinitionUse -> Bool

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

data TrailingSym

Constructors

HasDot

HasEqual

NoSym

Instances

Show TrailingSym

Defined in Slab.Syntax

Methods

showsPrec :: Int -> TrailingSym -> ShowS

show :: TrailingSym -> String

showList :: [TrailingSym] -> ShowS

Eq TrailingSym

Defined in Slab.Syntax

Methods

(==) :: TrailingSym -> TrailingSym -> Bool

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

data Attr

Represent an attribute or an argument of an element. Attributes can be IDs, classes, or arbitrary keys. Arguments are expressions with no key. The Code must already be evaluated.

Constructors

Id Text

Class Text

Attr Text Expr

Arg Expr

Instances

Show Attr

Defined in Slab.Syntax

Methods

showsPrec :: Int -> Attr -> ShowS

show :: Attr -> String

showList :: [Attr] -> ShowS

Eq Attr

Defined in Slab.Syntax

Methods

(==) :: Attr -> Attr -> Bool

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

splitAttrsAndArgs :: [Attr] -> ([Attr], [Expr])

data TextSyntax

Constructors

Normal

The text follows an element on the same line.

Pipe

The text follows a pipe character. Multiple lines each introduced by a pipe symbol are grouped as a single BlockText node.

Dot

The text is part of a text block following a trailing dot.

Include

The text is the content of an include statement without a .slab extension.

RunOutput

The text is the output of command.

Instances

Show TextSyntax

Defined in Slab.Syntax

Methods

showsPrec :: Int -> TextSyntax -> ShowS

show :: TextSyntax -> String

showList :: [TextSyntax] -> ShowS

Eq TextSyntax

Defined in Slab.Syntax

Methods

(==) :: TextSyntax -> TextSyntax -> Bool

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

data Expr

Simple expression language.

Constructors

Variable Text

Bool Bool

Int Int

SingleQuoteString Text

List [Expr]

Object [(Expr, Expr)]

Lookup Text Expr

Application Expr Expr

Add Expr Expr

Sub Expr Expr

Times Expr Expr

Divide Expr Expr

GreaterThan Expr Expr

LesserThan Expr Expr

Equal Expr Expr

Cons Expr Expr

Block Block

Frag [Text] Env [Block]

Thunk Env Expr

JsonPath FilePath

Allow to assign the content of a JSON file to a variable.

BuiltIn Text

Instances

Show Expr

Defined in Slab.Syntax

Methods

showsPrec :: Int -> Expr -> ShowS

show :: Expr -> String

showList :: [Expr] -> ShowS

Eq Expr

Defined in Slab.Syntax

Methods

(==) :: Expr -> Expr -> Bool

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

data Inline

A representation of a Text template is a list of Inline, supporting efficient rendering. Use parse to create a template from a text containing placeholders. Lit is a literal Text value. Place is a placeholder created with #{...}.

Constructors

Lit !Text

Place !Expr

Instances

Show Inline

Defined in Slab.Syntax

Methods

showsPrec :: Int -> Inline -> ShowS

show :: Inline -> String

showList :: [Inline] -> ShowS

Eq Inline

Defined in Slab.Syntax

Methods

(==) :: Inline -> Inline -> Bool

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

data Env

Constructors

Env

Fields

• envVariables :: [(Text, Expr)]

Instances

Show Env

Defined in Slab.Syntax

Methods

showsPrec :: Int -> Env -> ShowS

show :: Env -> String

showList :: [Env] -> ShowS

Eq Env

Defined in Slab.Syntax

Methods

(==) :: Env -> Env -> Bool

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

emptyEnv :: Env

displayEnv :: Env -> Text

trailingSym :: Block -> TrailingSym

freeVariables :: Expr -> [Text]

thunk :: Env -> Expr -> Expr

extractClasses :: [Block] -> [Text]

extractFragments :: [Block] -> [BlockFragment]

findFragment :: Text -> [BlockFragment] -> Maybe [Block]

idNamesFromAttrs :: [Attr] -> [Text]

idNamesFromAttrs' :: [Attr] -> Maybe Text

classNamesFromAttrs :: [Attr] -> [Text]

namesFromAttrs :: [Attr] -> [(Text, Text)]

groupAttrs :: [Attr] -> [Attr]

Group multiple classes or IDs in a single class or ID, and transform the other attributes in SingleQuoteStrings.