Struct GrammarRegistry 

pub struct GrammarRegistry { /* private fields */ }

A collection of TextMate JSON grammars and their external include scopes.

Implementations

impl GrammarRegistry

pub fn new() -> Self

Creates an empty grammar registry with default resource limits.

pub fn with_limits(limits: GrammarLimits) -> Self

Creates an empty registry with the supplied limits, clamped to at least one.

pub fn add_json(&mut self, json: &str) -> Result<GrammarId>

Parses and adds one JSON TextMate grammar.

Add every grammar referenced through an external include before constructing a tokenizer.

pub fn validate_regexes(&self) -> Result<()>

Checks every registered regex for parser diagnostics, returning the first.

This opt-in check does not change loading or tokenization. The engine is permissive and can skip malformed or unsupported constructs. A diagnostic may describe unsupported syntax rather than invalid Oniguruma syntax. Positions count Unicode scalar values from zero within the pattern.

use syntaxmate::{Error, GrammarErrorKind, GrammarRegistry};
let mut registry = GrammarRegistry::new();
registry.add_json(r#"{"scopeName":"source.demo","patterns":[{"match":"é)"}]}"#)?;
match registry.validate_regexes() {
    Err(Error::Grammar(error)) => {
        assert_eq!(error.scope_name(), Some("source.demo"));
        if let GrammarErrorKind::InvalidRegex(regex) = error.kind() {
            assert_eq!(regex.pattern(), "é)");
            assert_eq!(regex.position(), 1);
        }
    }
    result => panic!("expected a regex diagnostic: {result:?}"),
}

pub fn grammar_count(&self) -> usize

Returns the number of registered grammars.

pub fn validate(&self) -> Result<()>

Validates local and external include references across the registry.

Trait Implementations

impl Clone for GrammarRegistry

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GrammarRegistry

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GrammarRegistry

fn default() -> Self

Returns the “default value” for a type.