Modulecommonmark-0.3.1Haskell2010

Commonmark.Types

Contents

Re-exports

Synopsis

newtype Format
data ListSpacing
data ListType
data DelimiterType
data EnumeratorType
class IsInline
class IsBlock
newtype SourceRange
class Rangeable
type Attribute
type Attributes
class HasAttributes
class ToPlainText
value sourceColumn
value sourceLine
value sourceName
data SourcePos

Packagecommonmark-0.3.1
Exports17
LanguageHaskell2010
LicenceBSD-3-Clause
SourcePos.hs

newtypenewtype Format

Constructors

Format Text

Instances3Eq, Data, Show

Eq FormatDefined in commonmark-0.3.1 · Commonmark.Types
Data FormatDefined in commonmark-0.3.1 · Commonmark.Types
Show FormatDefined in commonmark-0.3.1 · Commonmark.Types

datadata ListSpacing

TightList LooseList

Instances4Eq, Data, Ord, Show

Eq ListSpacingDefined in commonmark-0.3.1 · Commonmark.Types
Data ListSpacingDefined in commonmark-0.3.1 · Commonmark.Types
Ord ListSpacingDefined in commonmark-0.3.1 · Commonmark.Types
Show ListSpacingDefined in commonmark-0.3.1 · Commonmark.Types

datadata ListType

Constructors

BulletList !Char
OrderedList !Int !EnumeratorType !DelimiterType

Instances4Eq, Data, Ord, Show

Eq ListTypeDefined in commonmark-0.3.1 · Commonmark.Types
Data ListTypeDefined in commonmark-0.3.1 · Commonmark.Types
Ord ListTypeDefined in commonmark-0.3.1 · Commonmark.Types
Show ListTypeDefined in commonmark-0.3.1 · Commonmark.Types

datadata DelimiterType

Period OneParen TwoParens

Instances4Eq, Data, Ord, Show

Eq DelimiterTypeDefined in commonmark-0.3.1 · Commonmark.Types
Data DelimiterTypeDefined in commonmark-0.3.1 · Commonmark.Types
Ord DelimiterTypeDefined in commonmark-0.3.1 · Commonmark.Types
Show DelimiterTypeDefined in commonmark-0.3.1 · Commonmark.Types

datadata EnumeratorType

Decimal UpperAlpha LowerAlpha UpperRoman LowerRoman

Instances4Eq, Data, Ord, Show

Eq EnumeratorTypeDefined in commonmark-0.3.1 · Commonmark.Types
Data EnumeratorTypeDefined in commonmark-0.3.1 · Commonmark.Types
Ord EnumeratorTypeDefined in commonmark-0.3.1 · Commonmark.Types
Show EnumeratorTypeDefined in commonmark-0.3.1 · Commonmark.Types

classclass (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 :: Text -> Text -> a -> a
image :: Text -> Text -> a -> a
code :: Text -> a
rawInline :: Format -> Text -> a

Instances3IsInline

Rangeable (Html a) => IsInline (Html a)Defined in commonmark-0.3.1 · Commonmark.Html
(IsInline a, Semigroup a) => IsInline (WithSourceMap a)Defined in commonmark-0.3.1 · Commonmark.SourceMap
(Applicative f, IsInline a, Monoid (f a), Show (f a)) => IsInline (f a)Defined in commonmark-0.3.1 · Commonmark.Types

classclass (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 :: Int -> il -> b
rawBlock :: Format -> Text -> b
referenceLinkDefinition :: Text -> (Text, Text) -> b
list :: ListType -> ListSpacing -> [b] -> b

Instances3IsBlock

IsInline (Html a) => IsBlock (Html a) (Html a)Defined in commonmark-0.3.1 · Commonmark.Html
(IsBlock b a, IsInline b, IsInline (WithSourceMap b), Semigroup a) => IsBlock (WithSourceMap b) (WithSourceMap a)Defined in commonmark-0.3.1 · Commonmark.SourceMap
(Applicative f, Monoid (f il), Show (f il), Monoid (f b), Show (f b), IsBlock il b) => IsBlock (f il) (f b)Defined in commonmark-0.3.1 · Commonmark.Types

newtypenewtype SourceRange

Constructors

SourceRange
- unSourceRange :: [(SourcePos, SourcePos)]

Instances7Eq, Data, Ord, Show, Semigroup, Monoid, …

Eq SourceRangeDefined in commonmark-0.3.1 · Commonmark.Types
Data SourceRangeDefined in commonmark-0.3.1 · Commonmark.Types
Ord SourceRangeDefined in commonmark-0.3.1 · Commonmark.Types
Show SourceRangeDefined in commonmark-0.3.1 · Commonmark.Types
Semigroup SourceRangeDefined in commonmark-0.3.1 · Commonmark.Types
Monoid SourceRangeDefined in commonmark-0.3.1 · Commonmark.Types
Rangeable (Html SourceRange)Defined in commonmark-0.3.1 · Commonmark.Html

classclass Rangeable a where

Methods

ranged :: SourceRange -> a -> a

Instances4Rangeable

Rangeable (Html SourceRange)Defined in commonmark-0.3.1 · Commonmark.Html
Rangeable (Html ())Defined in commonmark-0.3.1 · Commonmark.Html
(Rangeable a, Monoid a, Show a) => Rangeable (WithSourceMap a)Defined in commonmark-0.3.1 · Commonmark.SourceMap
(Functor f, Rangeable a) => Rangeable (f a)Defined in commonmark-0.3.1 · Commonmark.Types

typetype Attribute = (Text, Text)

typetype Attributes = [Attribute]

classclass HasAttributes a where

Methods

addAttributes :: Attributes -> a -> a

Instances3HasAttributes

HasAttributes (Html a)Defined in commonmark-0.3.1 · Commonmark.Html
HasAttributes (WithSourceMap a)Defined in commonmark-0.3.1 · Commonmark.SourceMap
(Functor f, HasAttributes a) => HasAttributes (f a)Defined in commonmark-0.3.1 · Commonmark.Types

classclass ToPlainText a where

Methods

toPlainText :: a -> Text

Instances2ToPlainText

ToPlainText (Html a)Defined in commonmark-0.3.1 · Commonmark.Html
ToPlainText a => ToPlainText (WithSourceMap a)Defined in commonmark-0.3.1 · Commonmark.SourceMap

Re-exports

valuesourceColumn :: SourcePos -> Column

Source#

Extracts the column number from a source position.

valuesourceLine :: SourcePos -> Line

Source#

Extracts the line number from a source position.

valuesourceName :: SourcePos -> SourceName

Source#

Extracts the name of the source from a source position.

datadata SourcePos

Source#

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.

Instances4Eq, Data, Ord, Show

Eq SourcePosDefined in parsec-3.1.18.0 · Text.Parsec.Pos
Data SourcePosDefined in parsec-3.1.18.0 · Text.Parsec.Pos
Ord SourcePosDefined in parsec-3.1.18.0 · Text.Parsec.Pos
Show SourcePosDefined in parsec-3.1.18.0 · Text.Parsec.Pos