Skylighting

Lookup syntax by (in order) full name (case insensitive), short name (case insensitive), extension.

Lookup a syntax by full name (case insensitive).

Lookup a syntax by short name (case insensitive).

Returns a list of syntaxes appropriate for the given file extension.

Returns a list of syntaxes appropriate for the given filename.

Default style.

Default formatting options.

Test for membership in a WordSet.

A set of words to match (either case-sensitive or case-insensitive).

The available levels of color complexity in ANSI terminal output.

A color (red, green, blue).

A Context corresponds to a context element in a Kate syntax description.

Full name of a context: the first member of the pair is the full syntax name, the second the context name within that syntax.

A context switch, either pops or pushes a context.

Options for formatting source code.

Different representations of a Color.

Attributes controlling how keywords are interpreted.

Line numbers

A list item is either just a textual value or an included list. IncludeList (x,y) includes list y from syntax with full name x.

Matchers correspond to the element types in a context.

A rule corresponds to one of the elements of a Kate syntax highlighting "context."

A line of source: a list of labeled tokens.

A rendering style. This determines how each kind of token is to be rendered, and sets a default color and background color for normal tokens. Line numbers can have a different color and background color.

A syntax corresponds to a complete Kate syntax description. The sShortname field is derived from the filename.

A map of syntaxes, keyed by full name.

Things that can be converted to a color.

A pair consisting of a list of attributes and some text.

A TokenStyle determines how a token is to be rendered.

KeywordTok corresponds to dsKeyword in Kate syntax descriptions, and so on.

A set of "words," possibly case insensitive.

Tokenize some text using Syntax. Note that the syntax definitions are assumed to have their keyword lists already resolved into word sets (as is the case for the bundled syntax definitions and for definitions loaded with the functions in Skylighting.Loader). If you construct a syntax map yourself from syntaxes parsed with parseSyntaxDefinition, apply resolveKeywords to each syntax first.

Configuration options for tokenize.

Adds a syntax definition to a syntax map, replacing any existing definition with the same name.

Scan a list of Syntaxs and make sure that IncludeRules never asks for a syntax not in this list. Produces a list of pairs where the first element is the including syntax name and the second element is the (missing) included syntax name. This is intended for sanity checks to avoid run-time errors.

Parses a file containing a Kate XML syntax definition into a Syntax description. Note that the resulting Syntax must be processed with resolveKeywords (once the full syntax map is assembled) before it can be used for tokenizing; the functions in Skylighting.Loader do this automatically.

Resolve Keyword matchers that refer to lists; following up include directives in the syntax map and producing WordSets.

Compile a UTF-8 encoded ByteString as a Regex. If the first parameter is True, then the Regex will be case sensitive. If the second parameter is True, quantifiers are minimal (lazy) rather than greedy by default, and the ? modifier makes them greedy instead of lazy -- this corresponds to PCRE's UNGREEDY option (QRegularExpression's InvertedGreedinessOption, set by minimal="1" in KDE syntax definitions).

Match a Regex against a (presumed UTF-8 encoded) ByteString, returning the matched text and a map of (offset, size) pairs for captures. Note that all matches are from the beginning of the string (a ^ anchor is implicit). As in PCRE, the match returned is the first one that a backtracking matcher would find (leftmost alternatives are preferred), which is not necessarily the longest. Note also that to avoid pathological performance in certain cases, the matcher is limited to considering 2000 possible matches at a time; when that threshold is reached, it discards lower-priority matches. Hence certain regexes may incorrectly fail to match: e.g. a*a{3000}$ on a string of 3000 as.

Like matchRegex, but takes the map of capturing groups (as computed by extractCapturingGroups) as an argument, so that it can be computed once per regex instead of once per match. (The map is only consulted for regexes containing subroutine calls like (?1) or (?R).)

The compiled regex and its capturing groups (cached in the RE by the smart constructor).

A representation of a regular expression.

Style from the breeze-dark KDE syntax highlighting theme.

Style based on ultraviolet's espresso_libre.css (dark background).

Style based on haddock's source highlighting.

Style based on kate's default colors.

Style with no colors.

Parse a KDE theme JSON document into a skylighting Style.

Style based on pygments's default colors.

Style based on pygments's tango colors.

Style based on the popular zenburn vim color scheme

Format tokens as a ConTeXt highlighting typing environment. The highlighting environemnt is defined by the macros produced by styleToConTeXt; it is a typing environment with default escaping enabled, i.e., / is the escape character.

Formats tokens as ConTeXt using custom commands inside a type{}. A KeywordTok is rendered using \KeywordTok{..}, and so on.

Converts a Style to a set of ConTeXt command definitions, which should be placed in the document's preamble.

Like formatHtmlBlock but uses only attributes valid in HTML 4 (so, no aria-hidden or aria-label attributes are used on the line anchors).

Format tokens as an HTML pre block. Each line is wrapped in a span element whose id is the line number (prefixed with lineIdPrefix), beginning with an empty anchor linking to the line. If line numbering is selected, the surrounding pre is given the class ‘numberSource’, and the resulting html will display line numbers thanks to the included CSS. See the documentation for formatHtmlInline for information about how tokens are encoded.

Format tokens using HTML spans inside code tags. For example, A KeywordTok is rendered as a span with class kw. Short class names correspond to TokenTypes as follows: KeywordTok = kw, DataTypeTok = dt, DecValTok = dv, BaseNTok = bn, FloatTok = fl, CharTok = ch, StringTok = st, CommentTok = co, OtherTok = ot, AlertTok = al, FunctionTok = fu, RegionMarkerTok = re, ErrorTok = er, ConstantTok = cn, SpecialCharTok = sc, VerbatimStringTok = vs, SpecialStringTok = ss, ImportTok = im, DocumentationTok = do, AnnotationTok = an, CommentVarTok = cv, VariableTok = va, ControlFlowTok = cf, OperatorTok = op, BuiltInTok = bu, ExtensionTok = ex, PreprocessorTok = pp, AttributeTok = at, InformationTok = in, WarningTok = wa. A NormalTok is not marked up at all.

Returns CSS for styling highlighted code according to the given style.

Format tokens as a LaTeX Highlighting environment inside a Shaded environment. Highlighting and Shaded are defined by the macros produced by styleToLaTeX. Highlighting is a verbatim environment using fancyvrb; \, {, and } have their normal meanings inside this environment, so that formatting commands work. Shaded is either nothing (if the style's background color is default) or a snugshade environment from framed, providing a background color for the whole code block, even if it spans multiple pages.

Formats tokens as LaTeX using custom commands inside | characters. Assumes that | is defined as a short verbatim command by the macros produced by styleToLaTeX. A KeywordTok is rendered using \KeywordTok{..}, and so on.

Converts a Style to a set of LaTeX macro definitions, which should be placed in the document's preamble. Note: default LaTeX setup doesn't allow boldface typewriter font. To make boldface work in styles, you need to use a different typewriter font. This will work for computer modern:

\DeclareFontShape{OT1}{cmtt}{bx}{n}{<5><6><7><8><9><10><10.95><12><14.4><17.28><20.74><24.88>cmttb10}{}

Or, with xelatex:

\usepackage{fontspec}
\setmainfont[SmallCapsFont={* Caps}]{Latin Modern Roman}
\setsansfont{Latin Modern Sans}
\setmonofont[SmallCapsFont={Latin Modern Mono Caps}]{Latin Modern Mono Light}

Format tokens as a Typst Highlighting environment inside a Skylighting block that can be styled. Skylighting is defined by the macros produced by styleToTypst.

Formats tokens as Typst using custom commands inside | characters. Assumes that | is defined as a short verbatim command by the macros produced by styleToTypst. A KeywordTok is rendered using \KeywordTok{..}, and so on.

Converts a Style to a set of Typst macro definitions, which should be placed in the document's preamble.

Loads a syntax definition from the specified file path. The file path must refer to a file containing an XML Kate syntax definition.

Loads all syntax definitions from the specified directory by looking for files with an ".xml" extension. This function assumes such files are Kate XML syntax definitions, so XML files with unexpected contents will cause a parsing error returned as a Left and syntax parsing will be aborted.

Loads all valid syntax definitions from the specified directory by looking for files with an ".xml" extension. Any files that are not valid Kate XML syntax definitions will have an entry in the resulting error map; the returned SyntaxMap will be made up of only the files that could successfully be loaded and parsed.