-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Skylighting is a syntax highlighting library with support for over one
--   hundred languages. It derives its tokenizers from XML syntax
--   definitions used by KDE's KSyntaxHighlighting framework, so any syntax
--   supported by that framework can be added. An optional command-line
--   program is provided. Skylighting is intended to be the successor to
--   highlighting-kate. This package provides generated syntax modules
--   based on the KDE XML definitions provided by the
--   <tt>skylighting-core</tt> package. As a result this package is
--   licensed under the GPL.
@package skylighting
@version 0.14.7


-- | Provides syntax highlighting definitions. THIS FILE IS AUTOMATICALLY
--   GENERATED. DO NOT EDIT IT MANUALLY.
module Skylighting.Syntax

-- | Default mapping from short names to syntax definitions.
defaultSyntaxMap :: SyntaxMap

module Skylighting
lookupSyntax :: Text -> SyntaxMap -> Maybe Syntax
syntaxByName :: SyntaxMap -> Text -> Maybe Syntax
syntaxByShortName :: SyntaxMap -> Text -> Maybe Syntax
syntaxesByExtension :: SyntaxMap -> String -> [Syntax]
syntaxesByFilename :: SyntaxMap -> String -> [Syntax]
defStyle :: TokenStyle
defaultFormatOpts :: FormatOptions
inWordSet :: (FoldCase a, Ord a) => a -> WordSet a -> Bool
makeWordSet :: (FoldCase a, Ord a) => Bool -> [a] -> WordSet a
data ANSIColorLevel
ANSI16Color :: ANSIColorLevel
ANSI256Color :: ANSIColorLevel
ANSITrueColor :: ANSIColorLevel
data Color
RGB :: Word8 -> Word8 -> Word8 -> Color
data Context
Context :: !Text -> !Text -> ![Rule] -> !TokenType -> ![ContextSwitch] -> ![ContextSwitch] -> ![ContextSwitch] -> !Bool -> ![ContextSwitch] -> !Bool -> Context
[cName] :: Context -> !Text
[cSyntax] :: Context -> !Text
[cRules] :: Context -> ![Rule]
[cAttribute] :: Context -> !TokenType
[cLineEmptyContext] :: Context -> ![ContextSwitch]
[cLineEndContext] :: Context -> ![ContextSwitch]
[cLineBeginContext] :: Context -> ![ContextSwitch]
[cFallthrough] :: Context -> !Bool
[cFallthroughContext] :: Context -> ![ContextSwitch]
[cDynamic] :: Context -> !Bool
type ContextName = (Text, Text)
data ContextSwitch
Pop :: ContextSwitch
Push :: !ContextName -> ContextSwitch
data FormatOptions
FormatOptions :: !Bool -> !Int -> !Bool -> !Bool -> ![Text] -> ![Text] -> !Text -> !ANSIColorLevel -> FormatOptions
[numberLines] :: FormatOptions -> !Bool
[startNumber] :: FormatOptions -> !Int
[lineAnchors] :: FormatOptions -> !Bool
[titleAttributes] :: FormatOptions -> !Bool
[codeClasses] :: FormatOptions -> ![Text]
[containerClasses] :: FormatOptions -> ![Text]
[lineIdPrefix] :: FormatOptions -> !Text
[ansiColorLevel] :: FormatOptions -> !ANSIColorLevel
class FromColor a
fromColor :: FromColor a => Color -> a
data KeywordAttr
KeywordAttr :: !Bool -> !Set Char -> KeywordAttr
[keywordCaseSensitive] :: KeywordAttr -> !Bool
[keywordDelims] :: KeywordAttr -> !Set Char
newtype LineNo
LineNo :: Int -> LineNo
[lineNo] :: LineNo -> Int
data ListItem
Item :: !Text -> ListItem
IncludeList :: !(Text, Text) -> ListItem
data Matcher
DetectChar :: !Char -> Matcher
Detect2Chars :: !Char -> !Char -> Matcher
AnyChar :: !Set Char -> Matcher
RangeDetect :: !Char -> !Char -> Matcher
StringDetect :: !Text -> Matcher
WordDetect :: !Text -> Matcher
RegExpr :: !RE -> Matcher
Keyword :: !KeywordAttr -> Either Text (WordSet Text) -> Matcher
Int :: Matcher
Float :: Matcher
HlCOct :: Matcher
HlCHex :: Matcher
HlCStringChar :: Matcher
HlCChar :: Matcher
LineContinue :: Matcher
IncludeRules :: !ContextName -> Matcher
DetectSpaces :: Matcher
DetectIdentifier :: Matcher
data Rule
Rule :: !Matcher -> !TokenType -> !Bool -> Set Char -> !Bool -> !Bool -> ![Rule] -> !Bool -> !Bool -> !Maybe Int -> ![ContextSwitch] -> Rule
[rMatcher] :: Rule -> !Matcher
[rAttribute] :: Rule -> !TokenType
[rIncludeAttribute] :: Rule -> !Bool
[rWeakDeliminators] :: Rule -> Set Char
[rDynamic] :: Rule -> !Bool
[rCaseSensitive] :: Rule -> !Bool
[rChildren] :: Rule -> ![Rule]
[rLookahead] :: Rule -> !Bool
[rFirstNonspace] :: Rule -> !Bool
[rColumn] :: Rule -> !Maybe Int
[rContextSwitch] :: Rule -> ![ContextSwitch]
type SourceLine = [Token]
data Style
Style :: !Map TokenType TokenStyle -> !Maybe Color -> !Maybe Color -> !Maybe Color -> !Maybe Color -> Style
[tokenStyles] :: Style -> !Map TokenType TokenStyle
[defaultColor] :: Style -> !Maybe Color
[backgroundColor] :: Style -> !Maybe Color
[lineNumberColor] :: Style -> !Maybe Color
[lineNumberBackgroundColor] :: Style -> !Maybe Color
data Syntax
Syntax :: !Text -> !String -> !Text -> !Map Text [ListItem] -> !Map Text Context -> !Text -> !Text -> !Text -> ![String] -> !Text -> Syntax
[sName] :: Syntax -> !Text
[sFilename] :: Syntax -> !String
[sShortname] :: Syntax -> !Text
[sLists] :: Syntax -> !Map Text [ListItem]
[sContexts] :: Syntax -> !Map Text Context
[sAuthor] :: Syntax -> !Text
[sVersion] :: Syntax -> !Text
[sLicense] :: Syntax -> !Text
[sExtensions] :: Syntax -> ![String]
[sStartingContext] :: Syntax -> !Text
type SyntaxMap = Map Text Syntax
class ToColor a
toColor :: ToColor a => a -> Maybe Color
type Token = (TokenType, Text)
data TokenStyle
TokenStyle :: !Maybe Color -> !Maybe Color -> !Bool -> !Bool -> !Bool -> TokenStyle
[tokenColor] :: TokenStyle -> !Maybe Color
[tokenBackground] :: TokenStyle -> !Maybe Color
[tokenBold] :: TokenStyle -> !Bool
[tokenItalic] :: TokenStyle -> !Bool
[tokenUnderline] :: TokenStyle -> !Bool
data TokenType
KeywordTok :: TokenType
DataTypeTok :: TokenType
DecValTok :: TokenType
BaseNTok :: TokenType
FloatTok :: TokenType
ConstantTok :: TokenType
CharTok :: TokenType
SpecialCharTok :: TokenType
StringTok :: TokenType
VerbatimStringTok :: TokenType
SpecialStringTok :: TokenType
ImportTok :: TokenType
CommentTok :: TokenType
DocumentationTok :: TokenType
AnnotationTok :: TokenType
CommentVarTok :: TokenType
OtherTok :: TokenType
FunctionTok :: TokenType
VariableTok :: TokenType
ControlFlowTok :: TokenType
OperatorTok :: TokenType
BuiltInTok :: TokenType
ExtensionTok :: TokenType
PreprocessorTok :: TokenType
AttributeTok :: TokenType
RegionMarkerTok :: TokenType
InformationTok :: TokenType
WarningTok :: TokenType
AlertTok :: TokenType
ErrorTok :: TokenType
NormalTok :: TokenType
data WordSet a
CaseSensitiveWords :: !Set a -> WordSet a
CaseInsensitiveWords :: !Set a -> WordSet a
tokenize :: TokenizerConfig -> Syntax -> Text -> Either String [SourceLine]
data TokenizerConfig
TokenizerConfig :: SyntaxMap -> Bool -> TokenizerConfig
[syntaxMap] :: TokenizerConfig -> SyntaxMap
[traceOutput] :: TokenizerConfig -> Bool
addSyntaxDefinition :: Syntax -> SyntaxMap -> SyntaxMap
missingIncludes :: [Syntax] -> [(Text, Text)]
parseSyntaxDefinition :: FilePath -> IO (Either String Syntax)
parseSyntaxDefinitionFromText :: FilePath -> Text -> Either String Syntax
resolveKeywords :: SyntaxMap -> Syntax -> Syntax
testRegex :: Bool -> String -> String -> Maybe (String, [(Int, String)])
compileRegex :: Bool -> ByteString -> Either String Regex
matchRegex :: Regex -> ByteString -> Maybe (ByteString, IntMap (Int, Int))
isWordChar :: Char -> Bool
pattern RE :: ByteString -> Bool -> RE
compileRE :: RE -> Either String Regex
reCaseSensitive :: RE -> Bool
reString :: RE -> ByteString
data Regex
MatchAnyChar :: Regex
MatchDynamic :: !Int -> Regex
MatchChar :: (Char -> Bool) -> Regex
MatchSome :: !Regex -> Regex
MatchAlt :: !Regex -> !Regex -> Regex
MatchConcat :: !Regex -> !Regex -> Regex
MatchCapture :: !Int -> !Regex -> Regex
MatchCaptured :: !Int -> Regex
AssertWordBoundary :: Regex
AssertBeginning :: Regex
AssertEnd :: Regex
AssertPositive :: !Direction -> !Regex -> Regex
AssertNegative :: !Direction -> !Regex -> Regex
Possessive :: !Regex -> Regex
Lazy :: !Regex -> Regex
Subroutine :: !Int -> Regex
MatchNull :: Regex
data RE
breezeDark :: Style
espresso :: Style
haddock :: Style
kate :: Style
monochrome :: Style
parseTheme :: ByteString -> Either String Style
pygments :: Style
tango :: Style
zenburn :: Style
formatANSI :: FormatOptions -> Style -> [SourceLine] -> Text
formatConTeXtBlock :: FormatOptions -> [SourceLine] -> Text
formatConTeXtInline :: FormatOptions -> [SourceLine] -> Text
styleToConTeXt :: Style -> Text
formatHtml4Block :: FormatOptions -> [SourceLine] -> Html
formatHtmlBlock :: FormatOptions -> [SourceLine] -> Html
formatHtmlInline :: FormatOptions -> [SourceLine] -> Html
styleToCss :: Style -> String
formatLaTeXBlock :: FormatOptions -> [SourceLine] -> Text
formatLaTeXInline :: FormatOptions -> [SourceLine] -> Text
styleToLaTeX :: Style -> Text
formatTypstBlock :: FormatOptions -> [SourceLine] -> Text
formatTypstInline :: FormatOptions -> [SourceLine] -> Text
styleToTypst :: Style -> Text
loadSyntaxFromFile :: FilePath -> IO (Either String Syntax)
loadSyntaxesFromDir :: FilePath -> IO (Either String SyntaxMap)
loadValidSyntaxesFromDir :: FilePath -> IO (LoadErrMap, SyntaxMap)
