Modulecheapskate-0.1.1.2Haskell2010

Cheapskate.Types

Synopsis

data Doc
data Block
data CodeAttr
data ListType
data NumWrapper
data HtmlTagType
type Blocks
data Inline
type Inlines
type ReferenceMap
data Options

Packagecheapskate-0.1.1.2
Exports11
LanguageHaskell2010
LicenceBSD-3-Clause
SourceTypes.hs

datadata Doc

Source#

Structured representation of a document. The Options affect how the document is rendered by toHtml.

Constructors

Doc Options Blocks

Instances6Data, Show, Generic, NFData, ToMarkup, Rep

Data DocDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Show DocDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Generic DocDefined in cheapskate-0.1.1.2 · Cheapskate.Types
NFData DocDefined in cheapskate-0.1.1.2 · Cheapskate.Types
ToMarkup DocDefined in cheapskate-0.1.1.2 · Cheapskate · orphan
type Rep Doc = D1 ('MetaData "Doc" "Cheapskate.Types" "cheapskate-0.1.1.2-JQTncewRz9n6xEafvm1qk8" 'False) (C1 ('MetaCons "Doc" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Options) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Blocks)))Defined in cheapskate-0.1.1.2 · Cheapskate.Types

datadata Block

Source#

Block-level elements.

Constructors

Para Inlines
Header Int Inlines
Blockquote Blocks
List Bool ListType [Blocks]
CodeBlock CodeAttr Text
HtmlBlock Text
HRule

Instances5Data, Show, Generic, NFData, Rep

Data BlockDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Show BlockDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Generic BlockDefined in cheapskate-0.1.1.2 · Cheapskate.Types
NFData BlockDefined in cheapskate-0.1.1.2 · Cheapskate.Types
type Rep Block = D1 ('MetaData "Block" "Cheapskate.Types" "cheapskate-0.1.1.2-JQTncewRz9n6xEafvm1qk8" 'False) ((C1 ('MetaCons "Para" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Inlines)) :+: (C1 ('MetaCons "Header" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Inlines)) :+: C1 ('MetaCons "Blockquote" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Blocks)))) :+: ((C1 ('MetaCons "List" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ListType) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Blocks]))) :+: C1 ('MetaCons "CodeBlock" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CodeAttr) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :+: (C1 ('MetaCons "HtmlBlock" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "HRule" 'PrefixI 'False) U1)))Defined in cheapskate-0.1.1.2 · Cheapskate.Types

datadata CodeAttr

Source#

Attributes for fenced code blocks. codeLang is the first word of the attribute line, codeInfo is the rest.

Constructors

CodeAttr
- codeLang :: Text
- codeInfo :: Text

Instances5Data, Show, Generic, NFData, Rep

Data CodeAttrDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Show CodeAttrDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Generic CodeAttrDefined in cheapskate-0.1.1.2 · Cheapskate.Types
NFData CodeAttrDefined in cheapskate-0.1.1.2 · Cheapskate.Types
type Rep CodeAttr = D1 ('MetaData "CodeAttr" "Cheapskate.Types" "cheapskate-0.1.1.2-JQTncewRz9n6xEafvm1qk8" 'False) (C1 ('MetaCons "CodeAttr" 'PrefixI 'True) (S1 ('MetaSel ('Just "codeLang") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "codeInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))Defined in cheapskate-0.1.1.2 · Cheapskate.Types

datadata ListType

Constructors

Bullet Char
Numbered NumWrapper Int

Instances6Eq, Data, Show, Generic, NFData, Rep

Eq ListTypeDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Data ListTypeDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Show ListTypeDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Generic ListTypeDefined in cheapskate-0.1.1.2 · Cheapskate.Types
NFData ListTypeDefined in cheapskate-0.1.1.2 · Cheapskate.Types
type Rep ListType = D1 ('MetaData "ListType" "Cheapskate.Types" "cheapskate-0.1.1.2-JQTncewRz9n6xEafvm1qk8" 'False) (C1 ('MetaCons "Bullet" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Char)) :+: C1 ('MetaCons "Numbered" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NumWrapper) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))Defined in cheapskate-0.1.1.2 · Cheapskate.Types

datadata NumWrapper

PeriodFollowing ParenFollowing

Instances6Eq, Data, Show, Generic, NFData, Rep

Eq NumWrapperDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Data NumWrapperDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Show NumWrapperDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Generic NumWrapperDefined in cheapskate-0.1.1.2 · Cheapskate.Types
NFData NumWrapperDefined in cheapskate-0.1.1.2 · Cheapskate.Types
type Rep NumWrapper = D1 ('MetaData "NumWrapper" "Cheapskate.Types" "cheapskate-0.1.1.2-JQTncewRz9n6xEafvm1qk8" 'False) (C1 ('MetaCons "PeriodFollowing" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ParenFollowing" 'PrefixI 'False) U1)Defined in cheapskate-0.1.1.2 · Cheapskate.Types

datadata HtmlTagType

Source#

Simple representation of HTML tag.

Constructors

Opening Text
Closing Text
SelfClosing Text

Instances5Data, Show, Generic, NFData, Rep

Data HtmlTagTypeDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Show HtmlTagTypeDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Generic HtmlTagTypeDefined in cheapskate-0.1.1.2 · Cheapskate.Types
NFData HtmlTagTypeDefined in cheapskate-0.1.1.2 · Cheapskate.Types
type Rep HtmlTagType = D1 ('MetaData "HtmlTagType" "Cheapskate.Types" "cheapskate-0.1.1.2-JQTncewRz9n6xEafvm1qk8" 'False) (C1 ('MetaCons "Opening" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "Closing" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "SelfClosing" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))Defined in cheapskate-0.1.1.2 · Cheapskate.Types

typetype Blocks = Seq Block

datadata Inline

Source#

Inline elements.

Constructors

Str Text
Space
SoftBreak
LineBreak
Emph Inlines
Strong Inlines
Code Text
Link Inlines Text Text
Image Inlines Text Text
Entity Text
RawHtml Text

Instances5Data, Show, Generic, NFData, Rep

Data InlineDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Show InlineDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Generic InlineDefined in cheapskate-0.1.1.2 · Cheapskate.Types
NFData InlineDefined in cheapskate-0.1.1.2 · Cheapskate.Types
type Rep Inline = D1 ('MetaData "Inline" "Cheapskate.Types" "cheapskate-0.1.1.2-JQTncewRz9n6xEafvm1qk8" 'False) (((C1 ('MetaCons "Str" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "Space" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "SoftBreak" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "LineBreak" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Emph" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Inlines))))) :+: ((C1 ('MetaCons "Strong" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Inlines)) :+: (C1 ('MetaCons "Code" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "Link" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Inlines) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))) :+: (C1 ('MetaCons "Image" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Inlines) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :+: (C1 ('MetaCons "Entity" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "RawHtml" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))))Defined in cheapskate-0.1.1.2 · Cheapskate.Types

typetype Inlines = Seq Inline

typetype ReferenceMap = Map Text (Text, Text)

datadata Options

Source#

Rendering and parsing options.

Constructors

Options
- sanitize :: Bool
  Sanitize raw HTML, link/image attributes
- allowRawHtml :: Bool
  Allow raw HTML (if false it gets escaped)
- preserveHardBreaks :: Bool
  Preserve hard line breaks in the source
- debug :: Bool
  Print container structure for debugging

Instances6Data, Show, Generic, NFData, Default, Rep

Data OptionsDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Show OptionsDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Generic OptionsDefined in cheapskate-0.1.1.2 · Cheapskate.Types
NFData OptionsDefined in cheapskate-0.1.1.2 · Cheapskate.Types
Default OptionsDefined in cheapskate-0.1.1.2 · Cheapskate.Types
type Rep Options = D1 ('MetaData "Options" "Cheapskate.Types" "cheapskate-0.1.1.2-JQTncewRz9n6xEafvm1qk8" 'False) (C1 ('MetaCons "Options" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sanitize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "allowRawHtml") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "preserveHardBreaks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "debug") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))Defined in cheapskate-0.1.1.2 · Cheapskate.Types