Commonmark.Inlines

Documentation

mkInlineParser :: (Monad m, IsInline a) => [BracketedSpec a] -> [FormattingSpec a] -> [InlineParser m a] -> [InlineParser m Attributes] -> ReferenceMap -> [Tok] -> m (Either ParseError a)

defaultInlineParser :: (Monad m, IsInline a) => InlineParser m a

data IPState m

type InlineParser m = ParsecT [Tok] (IPState m) (StateT Enders m)

Specifies delimiters for formatting, e.g. strong emphasis.

getReferenceMap :: Monad m => InlineParser m ReferenceMap

data FormattingSpec il

Constructors

FormattingSpec

Fields

• formattingDelimChar :: !Char

  Character that triggers formatting

• formattingIntraWord :: !Bool

  True if formatting can start/end in a word

• formattingIgnorePunctuation :: !Bool

  Treat punctuation like letters for purposes of computing can open/can close

• formattingSingleMatch :: Maybe (il -> il)

  Constructor to use for text between single delimiters.

• formattingDoubleMatch :: Maybe (il -> il)

  Constructor to use for text between double delimiters.

• formattingWhenUnmatched :: !Char

  Fallback when not matched.

Instances

Show (FormattingSpec il)

Defined in Commonmark.Inlines

Methods

showsPrec :: Int -> FormattingSpec il -> ShowS

show :: FormattingSpec il -> String

showList :: [FormattingSpec il] -> ShowS

defaultFormattingSpecs :: IsInline il => [FormattingSpec il]

data BracketedSpec il

Constructors

BracketedSpec

Fields

• bracketedName :: !Text

  Name of bracketed text type.

• bracketedNests :: !Bool

  True if this can be nested.

• bracketedPrefix :: Maybe Char

  Prefix character.

• bracketedSuffixEnd :: Maybe Char

  Suffix character.

• bracketedSuffix :: ReferenceMap -> Text -> Parsec [Tok] () (il -> il)

  Parser for suffix after brackets. Returns a constructor. Second parameter is the raw key.

Instances

Show (BracketedSpec il)

Defined in Commonmark.Inlines

Methods

showsPrec :: Int -> BracketedSpec il -> ShowS

show :: BracketedSpec il -> String

showList :: [BracketedSpec il] -> ShowS

defaultBracketedSpecs :: IsInline il => [BracketedSpec il]

data LinkInfo

Constructors

LinkInfo

Fields

• linkDestination :: !Text
• linkTitle :: !Text
• linkAttributes :: !Attributes
• linkPos :: !(Maybe SourcePos)

  Position of the reference link definition for references links.

Instances

Show LinkInfo

Defined in Commonmark.ReferenceMap

Methods

showsPrec :: Int -> LinkInfo -> ShowS

show :: LinkInfo -> String

showList :: [LinkInfo] -> ShowS

imageSpec :: IsInline il => BracketedSpec il

linkSpec :: IsInline il => BracketedSpec il

pLink :: ReferenceMap -> Text -> Parsec [Tok] s LinkInfo

pLinkLabel :: Monad m => ParsecT [Tok] s m Text

pLinkDestination :: Monad m => ParsecT [Tok] s m [Tok]

pLinkTitle :: Monad m => ParsecT [Tok] s m [Tok]

pEscaped :: Monad m => ParsecT [Tok] s m Tok

pEscapedSymbol :: Monad m => ParsecT [Tok] s m Tok

processEmphasis :: IsInline a => [Chunk a] -> [Chunk a]

processBrackets :: IsInline a => [BracketedSpec a] -> ReferenceMap -> [Chunk a] -> Map Text SourcePos -> Either (DState a) [Chunk a]

Process square brackets: links, images, and the span extension.

DState tracks the current position and backtracking limits.

If this function succeeds, returning Right, it will return a list of chunks, now annotated with bracket information.

If this function fails, it will return `Left DState`. This can happen if a chunk straddles a link destination, like this

link text looks like code` ^-----------------^

To recover, the caller must re-Chunk everything after the end paren. The bottoms parameter, in particular, is DState's stackBottoms, and is used to prevent things before the paren from being re-parsed.

pBacktickSpan :: Monad m => Tok -> InlineParser m (Either [Tok] [Tok])

normalizeCodeSpan :: Text -> Text

withAttributes :: (IsInline a, Monad m) => InlineParser m a -> InlineParser m a