Modulecommonmark-0.3.1Haskell2010

Commonmark.Inlines

5 types
19 values

Packagecommonmark-0.3.1
Exports24
LanguageHaskell2010
LicenceBSD-3-Clause
SourceInlines.hs

valuemkInlineParser

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

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

datadata IPState (m :: Type -> Type)

typetype InlineParser (m :: Type -> Type) = ParsecT [Tok] (IPState m) (StateT Enders m)

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

valuegetReferenceMap :: Monad m => InlineParser m ReferenceMap

valuegetPrecedingTokType :: Monad m => InlineParser m (Maybe TokType)

Type of the token immediately preceding the current position, if recorded. Preceding token types are recorded for positions of delimiter characters, and for word tokens preceded by a symbol. Nothing at the start of a word token means it begins the input or is preceded by whitespace.

datadata FormattingSpec il

Constructors

FormattingSpec
- 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.

Instances1Show

Show (FormattingSpec il)Defined in commonmark-0.3.1 · Commonmark.Inlines

valuedefaultFormattingSpecs :: IsInline il => [FormattingSpec il]

datadata BracketedSpec il

Constructors

BracketedSpec
- 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.

Instances1Show

Show (BracketedSpec il)Defined in commonmark-0.3.1 · Commonmark.Inlines

valuedefaultBracketedSpecs :: IsInline il => [BracketedSpec il]

datadata LinkInfo

Constructors

LinkInfo
- linkDestination :: !Text
- linkTitle :: !Text
- linkAttributes :: !Attributes
- linkPos :: !Maybe SourcePos
  Position of the reference link definition for references links.

Instances1Show

Show LinkInfoDefined in commonmark-0.3.1 · Commonmark.ReferenceMap

valueimageSpec :: IsInline il => BracketedSpec il

valuelinkSpec :: IsInline il => BracketedSpec il

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

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

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

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

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

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

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

valueprocessBrackets

:: 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.

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

valuenormalizeCodeSpan :: Text -> Text

valuewithAttributes

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