Up to date

This page is up to date for Godot 4.1. If you still find outdated information, please open an issue.

SyntaxHighlighter

Inherits: Resource < RefCounted < Object

Inherited By: CodeHighlighter, EditorSyntaxHighlighter

Base class for syntax highlighters. Provides syntax highlighting data to a TextEdit.

Description

Base class for syntax highlighters. Provides syntax highlighting data to a TextEdit. The associated TextEdit will call into the SyntaxHighlighter on an as-needed basis.

Note: A SyntaxHighlighter instance should not be used across multiple TextEdit nodes.

Methods

void	_clear_highlighting_cache ( ) virtual
Dictionary	_get_line_syntax_highlighting ( int line ) virtual const
void	_update_cache ( ) virtual
void	clear_highlighting_cache ( )
Dictionary	get_line_syntax_highlighting ( int line )
TextEdit	get_text_edit ( ) const
void	update_cache ( )

---

Method Descriptions

void _clear_highlighting_cache ( ) virtual

Virtual method which can be overridden to clear any local caches.

---

Dictionary _get_line_syntax_highlighting ( int line ) virtual const

Virtual method which can be overridden to return syntax highlighting data.

See get_line_syntax_highlighting for more details.

---

void _update_cache ( ) virtual

Virtual method which can be overridden to update any local caches.

---

void clear_highlighting_cache ( )

Clears all cached syntax highlighting data.

Then calls overridable method _clear_highlighting_cache.

---

Dictionary get_line_syntax_highlighting ( int line )

Returns syntax highlighting data for a single line. If the line is not cached, calls _get_line_syntax_highlighting to calculate the data.

The return Dictionary is column number to Dictionary. The column number notes the start of a region, the region will end if another region is found, or at the end of the line. The nested Dictionary contains the data for that region, currently only the key "color" is supported.

Example return:

var color_map = {
    0: {
        "color": Color(1, 0, 0)
    },
    5: {
        "color": Color(0, 1, 0)
    }
}

This will color columns 0-4 red, and columns 5-eol in green.

---

TextEdit get_text_edit ( ) const

Returns the associated TextEdit node.

---

void update_cache ( )

Clears then updates the SyntaxHighlighter caches. Override _update_cache for a callback.

Note: This is called automatically when the associated TextEdit node, updates its own cache.