Commonmark.Types

Documentation

newtype Format

Constructors

Format Text

Instances

Eq Format

Defined in Commonmark.Types

Methods

(==) :: Format -> Format -> Bool

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

Data Format

Defined in Commonmark.Types

Methods

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

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

toConstr :: Format -> Constr

dataTypeOf :: Format -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> Format -> Format

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

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

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

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

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

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

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

Show Format

Defined in Commonmark.Types

Methods

showsPrec :: Int -> Format -> ShowS

show :: Format -> String

showList :: [Format] -> ShowS

data ListSpacing

Constructors

TightList

LooseList

Instances

Eq ListSpacing

Defined in Commonmark.Types

Methods

(==) :: ListSpacing -> ListSpacing -> Bool

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

Data ListSpacing

Defined in Commonmark.Types

Methods

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

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

toConstr :: ListSpacing -> Constr

dataTypeOf :: ListSpacing -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> ListSpacing -> ListSpacing

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

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

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

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

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

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

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

Ord ListSpacing

Defined in Commonmark.Types

Methods

compare :: ListSpacing -> ListSpacing -> Ordering

(<) :: ListSpacing -> ListSpacing -> Bool

(<=) :: ListSpacing -> ListSpacing -> Bool

(>) :: ListSpacing -> ListSpacing -> Bool

(>=) :: ListSpacing -> ListSpacing -> Bool

max :: ListSpacing -> ListSpacing -> ListSpacing

min :: ListSpacing -> ListSpacing -> ListSpacing

Show ListSpacing

Defined in Commonmark.Types

Methods

showsPrec :: Int -> ListSpacing -> ShowS

show :: ListSpacing -> String

showList :: [ListSpacing] -> ShowS

data ListType

Constructors

BulletList !Char

OrderedList !Int !EnumeratorType !DelimiterType

Instances

Eq ListType

Defined in Commonmark.Types

Methods

(==) :: ListType -> ListType -> Bool

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

Data ListType

Defined in Commonmark.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

Ord ListType

Defined in Commonmark.Types

Methods

compare :: ListType -> ListType -> Ordering

(<) :: ListType -> ListType -> Bool

(<=) :: ListType -> ListType -> Bool

(>) :: ListType -> ListType -> Bool

(>=) :: ListType -> ListType -> Bool

max :: ListType -> ListType -> ListType

min :: ListType -> ListType -> ListType

Show ListType

Defined in Commonmark.Types

Methods

showsPrec :: Int -> ListType -> ShowS

show :: ListType -> String

showList :: [ListType] -> ShowS

data DelimiterType

Constructors

Period

OneParen

TwoParens

Instances

Eq DelimiterType

Defined in Commonmark.Types

Methods

(==) :: DelimiterType -> DelimiterType -> Bool

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

Data DelimiterType

Defined in Commonmark.Types

Methods

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

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

toConstr :: DelimiterType -> Constr

dataTypeOf :: DelimiterType -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> DelimiterType -> DelimiterType

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

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

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

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

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

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

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

Ord DelimiterType

Defined in Commonmark.Types

Methods

compare :: DelimiterType -> DelimiterType -> Ordering

(<) :: DelimiterType -> DelimiterType -> Bool

(<=) :: DelimiterType -> DelimiterType -> Bool

(>) :: DelimiterType -> DelimiterType -> Bool

(>=) :: DelimiterType -> DelimiterType -> Bool

max :: DelimiterType -> DelimiterType -> DelimiterType

min :: DelimiterType -> DelimiterType -> DelimiterType

Show DelimiterType

Defined in Commonmark.Types

Methods

showsPrec :: Int -> DelimiterType -> ShowS

show :: DelimiterType -> String

showList :: [DelimiterType] -> ShowS

data EnumeratorType

Constructors

Decimal

UpperAlpha

LowerAlpha

UpperRoman

LowerRoman

Instances

Eq EnumeratorType

Defined in Commonmark.Types

Methods

(==) :: EnumeratorType -> EnumeratorType -> Bool

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

Data EnumeratorType

Defined in Commonmark.Types

Methods

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

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

toConstr :: EnumeratorType -> Constr

dataTypeOf :: EnumeratorType -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> EnumeratorType -> EnumeratorType

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

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

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

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

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

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

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

Ord EnumeratorType

Defined in Commonmark.Types

Methods

compare :: EnumeratorType -> EnumeratorType -> Ordering

(<) :: EnumeratorType -> EnumeratorType -> Bool

(<=) :: EnumeratorType -> EnumeratorType -> Bool

(>) :: EnumeratorType -> EnumeratorType -> Bool

(>=) :: EnumeratorType -> EnumeratorType -> Bool

max :: EnumeratorType -> EnumeratorType -> EnumeratorType

min :: EnumeratorType -> EnumeratorType -> EnumeratorType

Show EnumeratorType

Defined in Commonmark.Types

Methods

showsPrec :: Int -> EnumeratorType -> ShowS

show :: EnumeratorType -> String

showList :: [EnumeratorType] -> ShowS

class (Monoid a, Show a, Rangeable a, HasAttributes a) => IsInline a where

Methods

lineBreak :: a

softBreak :: a

str :: Text -> a

entity :: Text -> a

escapedChar :: Char -> a

emph :: a -> a

strong :: a -> a

link

Arguments

:: Text

Destination

-> Text

Title

-> a

Link description

-> a

image

Arguments

:: Text

Source

-> Text

Title

-> a

Description

-> a

code :: Text -> a

rawInline :: Format -> Text -> a

Instances

(IsInline a, Semigroup a) => IsInline (WithSourceMap a)

Defined in Commonmark.SourceMap

Methods

lineBreak :: WithSourceMap a

softBreak :: WithSourceMap a

str :: Text -> WithSourceMap a

entity :: Text -> WithSourceMap a

escapedChar :: Char -> WithSourceMap a

emph :: WithSourceMap a -> WithSourceMap a

strong :: WithSourceMap a -> WithSourceMap a

link :: Text -> Text -> WithSourceMap a -> WithSourceMap a

image :: Text -> Text -> WithSourceMap a -> WithSourceMap a

code :: Text -> WithSourceMap a

rawInline :: Format -> Text -> WithSourceMap a

Rangeable (Html a) => IsInline (Html a)

Defined in Commonmark.Html

Methods

lineBreak :: Html a

softBreak :: Html a

str :: Text -> Html a

entity :: Text -> Html a

escapedChar :: Char -> Html a

emph :: Html a -> Html a

strong :: Html a -> Html a

link :: Text -> Text -> Html a -> Html a

image :: Text -> Text -> Html a -> Html a

code :: Text -> Html a

rawInline :: Format -> Text -> Html a

class (Monoid b, Show b, Rangeable b, IsInline il, HasAttributes b) => IsBlock il b | b -> il where

Methods

paragraph :: il -> b

plain :: il -> b

thematicBreak :: b

blockQuote :: b -> b

codeBlock :: Text -> Text -> b

heading

Arguments

:: Int

Level

-> il

text

-> b

rawBlock :: Format -> Text -> b

referenceLinkDefinition

Arguments

:: Text

Label

-> (Text, Text)

Destination, title

-> b

list :: ListType -> ListSpacing -> [b] -> b

Instances

(IsBlock b a, IsInline b, IsInline (WithSourceMap b), Semigroup a) => IsBlock (WithSourceMap b) (WithSourceMap a)

Defined in Commonmark.SourceMap

Methods

paragraph :: WithSourceMap b -> WithSourceMap a

plain :: WithSourceMap b -> WithSourceMap a

thematicBreak :: WithSourceMap a

blockQuote :: WithSourceMap a -> WithSourceMap a

codeBlock :: Text -> Text -> WithSourceMap a

heading :: Int -> WithSourceMap b -> WithSourceMap a

rawBlock :: Format -> Text -> WithSourceMap a

referenceLinkDefinition :: Text -> (Text, Text) -> WithSourceMap a

list :: ListType -> ListSpacing -> [WithSourceMap a] -> WithSourceMap a

IsInline (Html a) => IsBlock (Html a) (Html a)

Defined in Commonmark.Html

Methods

paragraph :: Html a -> Html a

plain :: Html a -> Html a

thematicBreak :: Html a

blockQuote :: Html a -> Html a

codeBlock :: Text -> Text -> Html a

heading :: Int -> Html a -> Html a

rawBlock :: Format -> Text -> Html a

referenceLinkDefinition :: Text -> (Text, Text) -> Html a

list :: ListType -> ListSpacing -> [Html a] -> Html a

newtype SourceRange

Constructors

SourceRange

Fields

• unSourceRange :: [(SourcePos, SourcePos)]

Instances

Eq SourceRange

Defined in Commonmark.Types

Methods

(==) :: SourceRange -> SourceRange -> Bool

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

Data SourceRange

Defined in Commonmark.Types

Methods

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

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

toConstr :: SourceRange -> Constr

dataTypeOf :: SourceRange -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> SourceRange -> SourceRange

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

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

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

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

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

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

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

Ord SourceRange

Defined in Commonmark.Types

Methods

compare :: SourceRange -> SourceRange -> Ordering

(<) :: SourceRange -> SourceRange -> Bool

(<=) :: SourceRange -> SourceRange -> Bool

(>) :: SourceRange -> SourceRange -> Bool

(>=) :: SourceRange -> SourceRange -> Bool

max :: SourceRange -> SourceRange -> SourceRange

min :: SourceRange -> SourceRange -> SourceRange

Show SourceRange

Defined in Commonmark.Types

Methods

showsPrec :: Int -> SourceRange -> ShowS

show :: SourceRange -> String

showList :: [SourceRange] -> ShowS

Semigroup SourceRange

Defined in Commonmark.Types

Methods

(<>) :: SourceRange -> SourceRange -> SourceRange

sconcat :: NonEmpty SourceRange -> SourceRange

stimes :: Integral b => b -> SourceRange -> SourceRange

Monoid SourceRange

Defined in Commonmark.Types

Methods

mempty :: SourceRange

mappend :: SourceRange -> SourceRange -> SourceRange

mconcat :: [SourceRange] -> SourceRange

Rangeable (Html SourceRange)

Defined in Commonmark.Html

Methods

ranged :: SourceRange -> Html SourceRange -> Html SourceRange

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

Defined in Text.Parsec.Pos

Methods

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

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

Data SourcePos

Defined in Text.Parsec.Pos

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

Defined in Text.Parsec.Pos

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

Defined in Text.Parsec.Pos

Methods

showsPrec :: Int -> SourcePos -> ShowS

show :: SourcePos -> String

showList :: [SourcePos] -> ShowS

class Rangeable a where

Methods

ranged :: SourceRange -> a -> a

Instances

(Rangeable a, Monoid a, Show a) => Rangeable (WithSourceMap a)

Defined in Commonmark.SourceMap

Methods

ranged :: SourceRange -> WithSourceMap a -> WithSourceMap a

Rangeable (Html ())

Defined in Commonmark.Html

Methods

ranged :: SourceRange -> Html () -> Html ()

Rangeable (Html SourceRange)

Defined in Commonmark.Html

Methods

ranged :: SourceRange -> Html SourceRange -> Html SourceRange

type Attribute = (Text, Text)

type Attributes = [Attribute]

class HasAttributes a where

Methods

addAttributes :: Attributes -> a -> a

Instances

HasAttributes (WithSourceMap a)

Defined in Commonmark.SourceMap

Methods

addAttributes :: Attributes -> WithSourceMap a -> WithSourceMap a

HasAttributes (Html a)

Defined in Commonmark.Html

Methods

addAttributes :: Attributes -> Html a -> Html a

class ToPlainText a where

Methods

toPlainText :: a -> Text

Instances

ToPlainText a => ToPlainText (WithSourceMap a)

Defined in Commonmark.SourceMap

Methods

toPlainText :: WithSourceMap a -> Text

ToPlainText (Html a)

Defined in Commonmark.Html

Methods

toPlainText :: Html a -> Text