Enum HighlightEngine 

pub enum HighlightEngine {
    TreeSitter(Box<Highlighter>),
    TextMate(Box<TextMateEngine>),
    None,
}

Unified highlighting engine supporting multiple backends

Variants

TreeSitter(Box<Highlighter>)

Tree-sitter based highlighting (built-in languages)

TextMate(Box<TextMateEngine>)

TextMate grammar based highlighting

None

No highlighting available

Implementations

impl HighlightEngine

pub fn for_file(path: &Path, registry: &GrammarRegistry) -> Self

Create a highlighting engine for a file

Always uses syntect/TextMate for highlighting, but detects tree-sitter language for other features (indentation, semantic highlighting).

pub fn for_file_with_languages( path: &Path, registry: &GrammarRegistry, languages: &HashMap<String, LanguageConfig>, ) -> Self

Create a highlighting engine for a file, using language configuration for detection.

This method checks the provided languages configuration for filename and extension matches before falling back to built-in detection. This allows users to configure custom filename patterns (like PKGBUILD for bash) that will be respected for syntax highlighting.

pub fn for_file_with_languages_and_preference( path: &Path, registry: &GrammarRegistry, languages: &HashMap<String, LanguageConfig>, preference: HighlighterPreference, ) -> Self

Create a highlighting engine with explicit preference and language configuration.

pub fn for_file_with_preference( path: &Path, registry: &GrammarRegistry, preference: HighlighterPreference, ) -> Self

Create a highlighting engine with explicit preference

pub fn for_language(language: Language) -> Self

Create a highlighting engine for a specific tree-sitter language.

This is useful when manually setting the language (e.g., from UI). Uses tree-sitter for the specified language.

pub fn for_syntax_name( name: &str, registry: &GrammarRegistry, ts_language: Option<Language>, ) -> Self

Create a highlighting engine for a syntax by name.

This looks up the syntax in the grammar registry and creates a TextMate highlighter for it. This supports all syntect syntaxes (100+) including user-configured grammars.

The ts_language parameter optionally provides a tree-sitter language for non-highlighting features (indentation, semantic highlighting).

pub fn highlight_viewport( &mut self, buffer: &Buffer, viewport_start: usize, viewport_end: usize, theme: &Theme, context_bytes: usize, ) -> Vec<HighlightSpan>

Highlight the visible viewport

context_bytes controls how far before/after the viewport to parse for accurate highlighting of multi-line constructs (strings, comments, nested blocks).

pub fn notify_insert(&mut self, position: usize, length: usize)

Notify the highlighting engine of a buffer insert (for checkpoint position tracking).

pub fn notify_delete(&mut self, position: usize, length: usize)

Notify the highlighting engine of a buffer delete (for checkpoint position tracking).

pub fn invalidate_range(&mut self, edit_range: Range<usize>)

Invalidate cache for an edited range

pub fn invalidate_all(&mut self)

Invalidate entire cache

pub fn has_highlighting(&self) -> bool

Check if this engine has highlighting available

pub fn backend_name(&self) -> &str

Get a description of the active backend

pub fn highlight_stats(&self) -> Option<&HighlightStats>

Get performance stats (TextMate engine only).

pub fn reset_highlight_stats(&mut self)

Reset performance counters.

pub fn syntax_name(&self) -> Option<&str>

Get the language/syntax name if available

pub fn category_at_position(&self, position: usize) -> Option<HighlightCategory>

Get the highlight category at a byte position from the cache.

Returns the category if the position falls within a cached highlight span. Useful for detecting whether the cursor is inside a string, comment, etc.

pub fn language(&self) -> Option<&Language>

Get the tree-sitter Language for non-highlighting features Returns the language even when using TextMate for highlighting

Trait Implementations

impl Default for HighlightEngine

fn default() -> HighlightEngine

Returns the “default value” for a type.