GPL-2.0-only licensed by John MacFarlane
Maintained by [email protected]
This version can be pinned in stack with:skylighting-0.4.2@sha256:7cf1b865898fa00c1cd9372bbe933c655f863483d3170a4ea2a9eb2f0d51df08,14756

skylighting

license travis build status

A Haskell syntax highlighting library with tokenizers derived from KDE XML syntax highlighting descriptions.

A command-line highlighter, skylighting, is also provided.

Motivation

This library is the successor to highlighting-kate, which had some problems that were difficult to resolve given its architecture.

In highlighting-kate, the XML syntax descriptions were converted into individual parsec parsers, which were then compiled. This made it difficult to handle IncludeRules properly without circular imports. There was also no way to load a syntax description dynamically.

Skylighting, by contrast, parses the XML syntax descriptions into Haskell data structures, which are then interpreted by a “tokenize” function. IncludeRules can now be handled properly, and users can add new syntax descriptions dynamically. It is also now possible to convert .theme files directly into styles.

Skylighting is also faster than highlighting-kate, by a factor of 3 in some cases.

Installing

To install the latest release from Hackage, do

stack install skylighting

or

cabal install skylighting

If you want the command-line tool, set the executable flag using --flag "skylighting:executable" in stack or -fexecutable in cabal.

The release tarballs include generated files not present in this repository. Building from this repository is a two-step process. In the first step we build a program, skylighting-extract, which reads XML syntax highlighting definitions from the xml directory and writes Haskell source files. In the second we actually build the library.

Using stack:

make bootstrap
make

Using cabal:

cabal install -fbootstrap --disable-optimizations
cabal run skylighting-extract -- xml/*.xml
cabal install -f-bootstrap --disable-optimizations

Command-line tool

A command-line executable, skylighting, is installed if the executable cabal flag is set in building.

For help, skylighting --help.

Adding new syntaxes

To compile with additional syntaxes, simply add the syntax definition (XML) file to the xml directory and repeat the bootstrap build described above.

Note that both the library and the executable can dynamically load syntax definitions, so you may not need to compile them in.

License

Skylighting is licensed under the GPL, because some of the xml syntax descriptions from which its tokenizers are generated are GPL-licensed.

References

Kate syntax highlighting documentation: https://docs.kde.org/stable5/en/applications/katepart/highlight.html

Kate highlighting definitions: https://github.com/KDE/syntax-highlighting/tree/master/data/syntax

Changes

Revision history for skylighting

0.4.2 — 2017-10-26

  • HTML output: remove outer div. This prevented margin collapsing between the pre and surrounding block elements, and often gave us excess white space around code blocks. See jgm/pandoc#3996.

0.4.1 — 2017-09-28

  • Updated XML definitions from KDE repository. Changed: actionscript, ada, agda, alert, alert_indent, asn1, awk, bash, boo, c, changelog, clojure, cmake, coldfusion, commonlisp, cpp, cs, css, curry, d, dockerfile, dot, doxygen, doxygenlua, eiffel, email, erlang, fortran, fsharp, gcc, haskell, haxe, isocpp, java, javascript, jsp, julia, lilypond, lua, m4, makefile, matlab, maxima, mips, modelines, modula-2, monobasic, objectivec, objectivecpp, ocaml, octave, opencl, pascal, perl, php, pike, postscript, prolog, purebasic, python, r, relaxng, relaxngcompact, rest, rhtml, ruby, rust, scala, scheme, sci, sql-mysql, sql-postgresql, sql, tcl, tcsh, verilog, vhdl, xml, xslt, xul, zsh.
  • Added support for powershell, using definition from KDE repository.
  • Stop terminating long builds on TravisCI (Kyle Ondy).

0.4 — 2017-09-15

  • Removed ToJSON/FromJSON instances for KeywordAttr, WordSet, Matcher, Context, ContextSwitch, Rule, Syntax (added in 0.3.5). Creating these increased the memory requirements for compiling skylighting to a degree not justified by the usefulness of these instances.

0.3.5 — 2017-09-14

  • Added ToJSON/FromJSON instances for all basic types.
  • Added some background colors to ‘kate’ style, matching default.theme, and made FromJSON for Style sensitive to background-color.

0.3.4.1 – 2017-09-09

  • HTML formatting: do not use div elements for source lines in inline output.

0.3.4 – 2017-09-09

  • HTML formatting changes (David Baynard). Note that these changes may require changes in hard-coded CSS that is used with skylighting’s HTML output.

    • Wrap lines of source code in a div with display set to inline-block. The divs make per-line processing easier. They cannot be set as display: block as that introduces extra new lines when copying and pasting.
    • Render line numbers in html using CSS pseudo elements rather than a table. The line numbers are always produced, as data-line-number attributes, and css to display them as ::before elements are always produced. The option to switch on line numbering only toggles a class; this means it is possible to toggle line numbering without re-running skylighting.
    • If the linkAnchors option is set, wrap with an a element rather than a div, set so that clicking the line number (and only the line number) will jump to that line.
    • Code wraps by default when html is printed, with wrapped lines indented.

0.3.3.1 – 2017-06-26

  • Updated xml syntax definitions and clojure test.
  • Improved ‘make update-xml’ target.
  • Updated version bound for criterion.

0.3.3 – 2017-04-22

  • Revert change from 0.3.2; now entities from a DTD are resolved if the DTD element is included. This is needed for agda.xml and some others. If you want to use a custom xml definition without needing language.dtd, just remove the reference to language.dtd in your xml file.
  • Added case keyword for ats (Hanwen (Steinway) Wu).

0.3.2 – 2017-04-01

  • Parse xml definitions without resolving entities from language.dtd. This allows xml definitions to be used even when language.dtd isn’t available. Existing definitions don’t rely on the two or three entities definied in language.dtd, so this is harmless.
  • Small optimizations.

0.3.1 – 2017-02-28

  • Use handwritten parser for Float instead of regex. Fixes jgm/highlighting-kate#57 (again).
  • Added float parsing tests.
  • Use parsec parsers, not regex, for CStringChar and CChar.
  • Rewrote Int, Hex, Oct, CStringChar, CCHar parsers with parsec instead of regex. This speeds things up.
  • Don’t include leading + in Int, Hex, Oct parsers. That gives bad results for things like i+1.

0.3 – 2017-02-19

  • Store literal binary-encoded representations of the Syntax structure in Skylighting.Syntax.*.hs, instead of the structure itself. This works around a problem ghc has compiling modules with large structures. This indirect method produces faster compile times and avoids massive memory usage by ghc (especially in profiling builds). For background see http://stackoverflow.com/questions/16348340/. Closes #7.
  • Types: Internals of ‘WordSet’ are no longer exposed.

0.2 – 2017-02-19

  • Restore Data, Typeable, Generic instances for basic types. To do this, we remove reCompiled field from RE (API change). Instead, we have the tokenizer compile regexes the first time it encounters them, memoizing the results. Performance is not significantly worse.
  • Skylighting.Syntax.*: use string representation of the Syntax, which is then ‘read’, rather than including the code for the data structure directly (#7). This indirect method produces faster compile times and avoids massive memory usage by ghc (especially in profiling builds). For background see http://stackoverflow.com/questions/16348340/compiling-very-large-constants-with-ghc
  • Use -fprof-auto-exported for profiling builds.
  • Added benchmark for xml syntax definition parsing.
  • Patched perl.xml (improperly escaped regex) (#8). This fixes a perl regex compilation error for regex patterns with backslash as delimiter, e.g. m\a.
  • Add a flag to build with system pcre (Felix Yan).

0.1.1.5 – 2017-02-03

  • Avoid depending on a PrintfArg instance for Text (#5). This isn’t provided in some older versions of the text library. This change should allow the package to build on older platforms.

0.1.1.4 – 2017-01-31

  • Properly escape characters in subDynamic. This fixes a problem that caused failures with

    echo -e "s\0b\0c" | skylighting -s perl
    
  • More efficient rewrite of char escaping for regexes.

0.1.1.3 – 2017-01-29

  • Increase test timeout to 6s.
  • Avoid double {{}} in latex macros.
  • Fixed problem compiling Format.LaTeX on older ghc versions (7.8.3) that can’t take a Text as PrintfArg.

0.1.1.2 – 2017-01-28

  • Added much more extensive testing to ensure that tokenizers don’t hang or drop input.
  • Fixed some issues with line-end and fallthrough context handling.
  • Fixed a bug in WordDetect handling which caused it to drop input (#2).

0.1.1.1 – 2017-01-21

  • Optimized. Speed is now comparable to highlighting-kate and often better.
  • Added benchmarks.

0.1.1 – 2017-01-19

  • Added breezeDark style, from breeze-dark.theme.
  • Fixed performance bug in regex application (#1). This gives a significant speedup, especially for inputs with long lines.

0.1.0.1 – 2016-12-23

  • Fixed bug in LaTeX renderer (backslash in wrong position).

0.1.0.0 – 2016-12-23

  • Initial release