Safe Haskell	None
Language	Haskell2010

Commonmark.Inlines

Synopsis

mkInlineParser :: (Monad m, IsInline a) => [BracketedSpec a] -> [FormattingSpec a] -> [InlineParser m a] -> [InlineParser m Attributes] -> ReferenceMap -> [Tok] -> m (Either ParseError a)
defaultInlineParser :: forall (m :: Type -> Type) a. (Monad m, IsInline a) => InlineParser m a
data IPState (m :: Type -> Type)
type InlineParser (m :: Type -> Type) = ParsecT [Tok] (IPState m) (StateT Enders m)
getReferenceMap :: forall (m :: Type -> Type). Monad m => InlineParser m ReferenceMap
data FormattingSpec il = FormattingSpec {
- formattingDelimChar :: !Char
- formattingIntraWord :: !Bool
- formattingIgnorePunctuation :: !Bool
- formattingSingleMatch :: Maybe (il -> il)
- formattingDoubleMatch :: Maybe (il -> il)
- formattingWhenUnmatched :: !Char
}
defaultFormattingSpecs :: IsInline il => [FormattingSpec il]
data BracketedSpec il = BracketedSpec {
- bracketedName :: !Text
- bracketedNests :: !Bool
- bracketedPrefix :: Maybe Char
- bracketedSuffixEnd :: Maybe Char
- bracketedSuffix :: ReferenceMap -> Text -> Parsec [Tok] () (il -> il)
}
defaultBracketedSpecs :: IsInline il => [BracketedSpec il]
data LinkInfo = LinkInfo {
- linkDestination :: !Text
- linkTitle :: !Text
- linkAttributes :: !Attributes
- linkPos :: !(Maybe SourcePos)
}
imageSpec :: IsInline il => BracketedSpec il
linkSpec :: IsInline il => BracketedSpec il
pLink :: ReferenceMap -> Text -> Parsec [Tok] s LinkInfo
pLinkLabel :: forall (m :: Type -> Type) s. Monad m => ParsecT [Tok] s m Text
pLinkDestination :: forall (m :: Type -> Type) s. Monad m => ParsecT [Tok] s m [Tok]
pLinkTitle :: forall (m :: Type -> Type) s. Monad m => ParsecT [Tok] s m [Tok]
pEscaped :: forall (m :: Type -> Type) s. Monad m => ParsecT [Tok] s m Tok
pEscapedSymbol :: forall (m :: Type -> Type) s. 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]
pBacktickSpan :: forall (m :: Type -> Type). Monad m => Tok -> InlineParser m (Either [Tok] [Tok])
normalizeCodeSpan :: Text -> Text
withAttributes :: forall a (m :: Type -> Type). (IsInline a, Monad m) => InlineParser m a -> InlineParser m a

Documentation

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

defaultInlineParser :: forall (m :: Type -> Type) a. (Monad m, IsInline a) => InlineParser m a Source #

data IPState (m :: Type -> Type) Source #

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

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

getReferenceMap :: forall (m :: Type -> Type). Monad m => InlineParser m ReferenceMap Source #

data FormattingSpec il Source #

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

Instances details

Show (FormattingSpec il) Source #
Instance details Defined in Commonmark.Inlines Methods showsPrec :: Int -> FormattingSpec il -> ShowS # show :: FormattingSpec il -> String # showList :: [FormattingSpec il] -> ShowS #

defaultFormattingSpecs :: IsInline il => [FormattingSpec il] Source #

data BracketedSpec il Source #

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

Instances details

Show (BracketedSpec il) Source #
Instance details Defined in Commonmark.Inlines Methods showsPrec :: Int -> BracketedSpec il -> ShowS # show :: BracketedSpec il -> String # showList :: [BracketedSpec il] -> ShowS #

defaultBracketedSpecs :: IsInline il => [BracketedSpec il] Source #

data LinkInfo Source #

Constructors

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

Instances

Instances details

Show LinkInfo Source #
Instance details Defined in Commonmark.ReferenceMap Methods showsPrec :: Int -> LinkInfo -> ShowS # show :: LinkInfo -> String # showList :: [LinkInfo] -> ShowS #

imageSpec :: IsInline il => BracketedSpec il Source #

linkSpec :: IsInline il => BracketedSpec il Source #

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

pLinkLabel :: forall (m :: Type -> Type) s. Monad m => ParsecT [Tok] s m Text Source #

pLinkDestination :: forall (m :: Type -> Type) s. Monad m => ParsecT [Tok] s m [Tok] Source #

pLinkTitle :: forall (m :: Type -> Type) s. Monad m => ParsecT [Tok] s m [Tok] Source #

pEscaped :: forall (m :: Type -> Type) s. Monad m => ParsecT [Tok] s m Tok Source #

pEscapedSymbol :: forall (m :: Type -> Type) s. Monad m => ParsecT [Tok] s m Tok Source #

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

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

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 :: forall (m :: Type -> Type). Monad m => Tok -> InlineParser m (Either [Tok] [Tok]) Source #

normalizeCodeSpan :: Text -> Text Source #

withAttributes :: forall a (m :: Type -> Type). (IsInline a, Monad m) => InlineParser m a -> InlineParser m a Source #