KSyntaxHighlighting – A new Syntax Highlighting Framework

Today, KDE Frameworks 5.28 was released with the brand new KSyntaxHighlighting framework. The announcement says:

New framework: syntax-highlighting
Syntax highlighting engine for Kate syntax definitions

This is a stand-alone implementation of the Kate syntax highlighting engine. It’s meant as a building block for text editors as well as for simple highlighted text rendering (e.g. as HTML), supporting both integration with a custom editor as well as a ready-to-use QSyntaxHighlighter sub-class.

This year, on March 31st, KDE’s advanced text editor Kate had its 15th birthday. 15 years are a long time in the software world, and during this time Kate won the hearts of many users and developers. As text editing component, Kate uses the KTextEditor framework, which is used also by applications such as KDevelop or Kile.

The KTextEditor framework essentially is an embeddable text editing component. It ships everything from painting the line numbers, the background color, the text lines with syntax highlighting, the blinking cursor to code completion and many more features. One major feature is its very powerful syntax highlighting engine, enabling us to properly highlight around 275 languages.

Each syntax highlighting is defined in terms of an xml file (many examples), as described in Kate’s documentation. These xml files are read by KTextEditor and the context based highlighting rules in these files are then used to highlight the file contents.

For the last 15 years, this syntax highlighting engine was tightly coupled with the rest of the KTextEditor code. As such, it was not possible to simply reuse the highlighting engine in other projects without using KTextEditor. This lead to the unfortunate situation, where e.g. the Qt Creator developers partly reimplemented Kate’s syntax highlighting engine in order to support other languages next to C/C++.

This changed as of today: The KSyntaxHighlighting framework is a tier 1 functional framework that solely depends on Qt (no dependency on Qt Widgets or QML), is very well unit tested, and licensed under the LGPLv2+. As mentioned in the announcement and in the API documentation, it is a stand-alone implementation of the Kate syntax highlighting engine. It’s meant as a building block for text editors as well as for simple highlighted text rendering (e.g. as HTML), supporting both integration with a custom editor as well as a ready-to-use QSyntaxHighlighter sub-class. This also implies that you can reuse this framework to add syntax highlighting to e.g. QML applications.

We hope that other applications such as Qt Creator will start to use the KSyntaxHighlighting framework, since it allows us to cleanly share one single implementation of the syntax highlighting engine.

In the next KDE Frameworks releases, we will remove KTextEditors syntax highlighting engine in favor of just using KSyntaxHighlighting. This will happen step by step. For instance, we already have a pending patch that removes all xml files from KTextEditor.git in favor of using the ones shipped by the KSyntaxHighlighting framework. That means, with the KDE Frameworks 5.29 release, Kate’s and KTextEditors dependency (and other application’s dependencies) will look as follows:

KTextEditor and KSyntaxHighlighting

This is quite an interesting change, especially since moving the syntax highlighting engine out of KTextEditor was already planned since Akademy 2013 in Bilbao:

Another idea was raised at this year’s Akademy in Bilbao: Split Kate Part’s highlighting into a separate library. This way, other applications could use the Kate Part’s highlighting system. Think of a command line tool to create highlighted html pages, or a syntax highlighter for QTextEdits. The highlighting engine right now is mostly internal to Kate Part, so such a split could happen also later after the initial release of KTextEditor on 5.

This goal is now reached – thanks to Volker Krause who did most of the work. Pretty cool!

If you are interested in using the KSyntaxHighlighting framework, feel free to contact us on our mailing list. Further, we welcome all contributions, so please send patches to our mailing list, or post them on phabricator. (You can also find the KSyntaxHighlighting framework on github for convenience, but it’s not our primary platform).

You can also support Kate and the KDE Frameworks by donating to the KDE e.V., KDE’s non-profit organization.

Update: Changed XML Syntax Definition File Location

Starting with KDE Frameworks 5.29, the KTextEditor framework now uses the syntax highlighting files from KSyntaxHighlighting. These files are located in $HOME/.local/share/org.kde.syntax-highlighting/syntax. If this folder does not exist, just create it. Futher, you will not find any syntax highlighting files in your system installation, since the syntax highlighting files shipped with KSyntaxHighlighting are compiled into the executable.

12 thoughts on “KSyntaxHighlighting – A new Syntax Highlighting Framework

  1. One thing that is not clear to me: can I use it to render simple html? (i.e. like QTextDocument does or KHTML used to do)

  2. It is possible to use syntax highlighting from other editors like Atom?
    There are a missing syntax highlighting for new languages like Pug, Stylus, Vue… So if we can import them from other editor it will be nice for us

    1. No, the KSyntaxHighlighting framework only supports the syntax definitions in terms of the xml files. Adding support for other syntax highlighting files is not feasible, since other highlighting systems work completely different. Sorry.

      But we are happy to accept all contributions, so if you have syntax highlighting file, please let us know so we can add it.

      1. But it’s not possible to write a converter for example to convert Vim highlighting files to Kate highlighting file?

  3. As you mention Kile, are there any news about a Qt5-based release? Kile 2.1.3 was released several years ago and new features and bugfixes are in trunk. I saw several related questions on their mailing list but the devs bever answered them.

    1. Yes and no: My understanding was that Kile’s Qt5 and KDE Frameworks 5 port is petty much ready, but a stable Okular was missing. And that hindered also Kile from doing releases, since Kile indeed relies on Okular and its part for the live-preview.

      That said, Okular should also be pretty much ready, so I’d expect a release to happen in the next 6 months hopefully.

      It would certainly help, if you ask this question on kde-devel@kde.org, or the respective Kile and Okular mailing lists, since it would show that there indeed is interest on a 5 based version.

      1. Okular KF5 version will be part of the KDE Applications 16.12 release. A beta will be released in the coming days.

        The more testing Okular KF5 gets, the faster Kile developers can decide to relase their KF5 port.

Leave a Reply

Your email address will not be published. Required fields are marked *

Scroll to top