cheapskate-0.1.1.2: Experimental markdown processor.

Safe HaskellSafe
LanguageHaskell2010

Cheapskate.Types

Synopsis

Documentation

data Doc Source #

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

Constructors

Doc Options Blocks 
Instances
Data Doc Source # 
Instance details

Defined in Cheapskate.Types

Methods

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

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

toConstr :: Doc -> Constr #

dataTypeOf :: Doc -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> Doc -> Doc #

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

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

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

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

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

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

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

Show Doc Source # 
Instance details

Defined in Cheapskate.Types

Methods

showsPrec :: Int -> Doc -> ShowS #

show :: Doc -> String #

showList :: [Doc] -> ShowS #

Generic Doc Source # 
Instance details

Defined in Cheapskate.Types

Associated Types

type Rep Doc :: Type -> Type #

Methods

from :: Doc -> Rep Doc x #

to :: Rep Doc x -> Doc #

ToMarkup Doc Source # 
Instance details

Defined in Cheapskate

NFData Doc Source # 
Instance details

Defined in Cheapskate.Types

Methods

rnf :: Doc -> () #

type Rep Doc Source # 
Instance details

Defined in Cheapskate.Types

data Block Source #

Block-level elements.

Instances
Data Block Source # 
Instance details

Defined in Cheapskate.Types

Methods

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

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

toConstr :: Block -> Constr #

dataTypeOf :: Block -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> Block -> Block #

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

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

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

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

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

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

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

Show Block Source # 
Instance details

Defined in Cheapskate.Types

Methods

showsPrec :: Int -> Block -> ShowS #

show :: Block -> String #

showList :: [Block] -> ShowS #

Generic Block Source # 
Instance details

Defined in Cheapskate.Types

Associated Types

type Rep Block :: Type -> Type #

Methods

from :: Block -> Rep Block x #

to :: Rep Block x -> Block #

NFData Block Source # 
Instance details

Defined in Cheapskate.Types

Methods

rnf :: Block -> () #

type Rep Block Source # 
Instance details

Defined in Cheapskate.Types

type Rep Block = D1 (MetaData "Block" "Cheapskate.Types" "cheapskate-0.1.1.2-GHDt1kcDjAPEXqf9q9dD02" False) ((C1 (MetaCons "Para" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Inlines)) :+: (C1 (MetaCons "Header" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Inlines)) :+: C1 (MetaCons "Blockquote" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Blocks)))) :+: ((C1 (MetaCons "List" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ListType) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Blocks]))) :+: C1 (MetaCons "CodeBlock" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CodeAttr) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) :+: (C1 (MetaCons "HtmlBlock" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: C1 (MetaCons "HRule" PrefixI False) (U1 :: Type -> Type))))

data CodeAttr Source #

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

Constructors

CodeAttr 

Fields

Instances
Data CodeAttr Source # 
Instance details

Defined in Cheapskate.Types

Methods

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

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

toConstr :: CodeAttr -> Constr #

dataTypeOf :: CodeAttr -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> CodeAttr -> CodeAttr #

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

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

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

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

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

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

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

Show CodeAttr Source # 
Instance details

Defined in Cheapskate.Types

Generic CodeAttr Source # 
Instance details

Defined in Cheapskate.Types

Associated Types

type Rep CodeAttr :: Type -> Type #

Methods

from :: CodeAttr -> Rep CodeAttr x #

to :: Rep CodeAttr x -> CodeAttr #

NFData CodeAttr Source # 
Instance details

Defined in Cheapskate.Types

Methods

rnf :: CodeAttr -> () #

type Rep CodeAttr Source # 
Instance details

Defined in Cheapskate.Types

type Rep CodeAttr = D1 (MetaData "CodeAttr" "Cheapskate.Types" "cheapskate-0.1.1.2-GHDt1kcDjAPEXqf9q9dD02" False) (C1 (MetaCons "CodeAttr" PrefixI True) (S1 (MetaSel (Just "codeLang") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "codeInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data ListType Source #

Instances
Eq ListType Source # 
Instance details

Defined in Cheapskate.Types

Data ListType Source # 
Instance details

Defined in Cheapskate.Types

Methods

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

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

toConstr :: ListType -> Constr #

dataTypeOf :: ListType -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> ListType -> ListType #

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

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

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

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

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

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

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

Show ListType Source # 
Instance details

Defined in Cheapskate.Types

Generic ListType Source # 
Instance details

Defined in Cheapskate.Types

Associated Types

type Rep ListType :: Type -> Type #

Methods

from :: ListType -> Rep ListType x #

to :: Rep ListType x -> ListType #

NFData ListType Source # 
Instance details

Defined in Cheapskate.Types

Methods

rnf :: ListType -> () #

type Rep ListType Source # 
Instance details

Defined in Cheapskate.Types

data NumWrapper Source #

Instances
Eq NumWrapper Source # 
Instance details

Defined in Cheapskate.Types

Data NumWrapper Source # 
Instance details

Defined in Cheapskate.Types

Methods

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

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

toConstr :: NumWrapper -> Constr #

dataTypeOf :: NumWrapper -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> NumWrapper -> NumWrapper #

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

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

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

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

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

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

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

Show NumWrapper Source # 
Instance details

Defined in Cheapskate.Types

Generic NumWrapper Source # 
Instance details

Defined in Cheapskate.Types

Associated Types

type Rep NumWrapper :: Type -> Type #

NFData NumWrapper Source # 
Instance details

Defined in Cheapskate.Types

Methods

rnf :: NumWrapper -> () #

type Rep NumWrapper Source # 
Instance details

Defined in Cheapskate.Types

type Rep NumWrapper = D1 (MetaData "NumWrapper" "Cheapskate.Types" "cheapskate-0.1.1.2-GHDt1kcDjAPEXqf9q9dD02" False) (C1 (MetaCons "PeriodFollowing" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "ParenFollowing" PrefixI False) (U1 :: Type -> Type))

data HtmlTagType Source #

Simple representation of HTML tag.

Instances
Data HtmlTagType Source # 
Instance details

Defined in Cheapskate.Types

Methods

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

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

toConstr :: HtmlTagType -> Constr #

dataTypeOf :: HtmlTagType -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> HtmlTagType -> HtmlTagType #

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

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

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

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

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

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

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

Show HtmlTagType Source # 
Instance details

Defined in Cheapskate.Types

Generic HtmlTagType Source # 
Instance details

Defined in Cheapskate.Types

Associated Types

type Rep HtmlTagType :: Type -> Type #

NFData HtmlTagType Source # 
Instance details

Defined in Cheapskate.Types

Methods

rnf :: HtmlTagType -> () #

type Rep HtmlTagType Source # 
Instance details

Defined in Cheapskate.Types

data Inline Source #

Inline elements.

Instances
Data Inline Source # 
Instance details

Defined in Cheapskate.Types

Methods

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

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

toConstr :: Inline -> Constr #

dataTypeOf :: Inline -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> Inline -> Inline #

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

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

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

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

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

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

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

Show Inline Source # 
Instance details

Defined in Cheapskate.Types

Generic Inline Source # 
Instance details

Defined in Cheapskate.Types

Associated Types

type Rep Inline :: Type -> Type #

Methods

from :: Inline -> Rep Inline x #

to :: Rep Inline x -> Inline #

NFData Inline Source # 
Instance details

Defined in Cheapskate.Types

Methods

rnf :: Inline -> () #

type Rep Inline Source # 
Instance details

Defined in Cheapskate.Types

type Rep Inline = D1 (MetaData "Inline" "Cheapskate.Types" "cheapskate-0.1.1.2-GHDt1kcDjAPEXqf9q9dD02" False) (((C1 (MetaCons "Str" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: C1 (MetaCons "Space" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "SoftBreak" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "LineBreak" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Emph" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Inlines))))) :+: ((C1 (MetaCons "Strong" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Inlines)) :+: (C1 (MetaCons "Code" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: C1 (MetaCons "Link" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Inlines) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))) :+: (C1 (MetaCons "Image" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Inlines) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) :+: (C1 (MetaCons "Entity" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: C1 (MetaCons "RawHtml" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))))

data Options Source #

Rendering and parsing options.

Constructors

Options 

Fields

Instances
Data Options Source # 
Instance details

Defined in Cheapskate.Types

Methods

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

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

toConstr :: Options -> Constr #

dataTypeOf :: Options -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> Options -> Options #

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

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

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

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

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

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

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

Show Options Source # 
Instance details

Defined in Cheapskate.Types

Generic Options Source # 
Instance details

Defined in Cheapskate.Types

Associated Types

type Rep Options :: Type -> Type #

Methods

from :: Options -> Rep Options x #

to :: Rep Options x -> Options #

Default Options Source # 
Instance details

Defined in Cheapskate.Types

Methods

def :: Options #

NFData Options Source # 
Instance details

Defined in Cheapskate.Types

Methods

rnf :: Options -> () #

type Rep Options Source # 
Instance details

Defined in Cheapskate.Types

type Rep Options = D1 (MetaData "Options" "Cheapskate.Types" "cheapskate-0.1.1.2-GHDt1kcDjAPEXqf9q9dD02" 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))))