Struct Highlighter

pub struct Highlighter {
    pub atoms: Vec<Vec<Atom>>,
    pub atom_def: Vec<AtomDef>,
    pub bounded_def: Vec<BoundedDef>,
    pub line_ref: Vec<Vec<usize>>,
    pub tokens: Vec<TokenRef>,
    pub tab_width: usize,
    /* private fields */
}

This is the main struct that will highlight your document

Fields

atoms: Vec<Vec<Atom>>

The list of atoms, encapsulated within an inner vector for atoms on the same line

atom_def: Vec<AtomDef>

The list of atom definitions to be used at atomization

bounded_def: Vec<BoundedDef>

The list of bounded definitions to be used at tokenization

line_ref: Vec<Vec<usize>>

A reference to what tokens lie on which line numbers

tokens: Vec<TokenRef>

A list of the resulting tokens generated from run and append

tab_width: usize

How many spaces a tab character should be

Implementations

impl Highlighter

pub fn new(tab_width: usize) -> Self

Creates a new highlighter

pub fn keyword<S: Into<String>>(&mut self, name: S, exp: &str)

Register a new keyword token, provide its name and regex

pub fn bounded<S: Into<String>>( &mut self, name: S, start: S, end: S, escapable: bool, )

Register a new bounded token, with a start and end, e.g. a multiline comment having starting /* and an ending */ to delimit it The last argument is a boolean when true, tokens can be escaped with a backslash e.g. “"” would be a string of a quote

pub fn bounded_interp<S: Into<String>>( &mut self, name: S, start: S, end: S, i_start: S, i_end: S, escapable: bool, )

Register a new interpolatable bounded token, with a start and end, e.g. a string as a bounded token, but allowing substitution between {} The last argument is a boolean when true, tokens can be escaped with a backslash e.g. “"” would be a string of a quote

pub fn run(&mut self, lines: &[String])

Do an initial pass on a vector of lines.

Note that this will overwrite any existing information, use append to add extra lines to the document.

pub fn append(&mut self, line: &str)

Appends a line to the highlighter.

pub fn line(&self, y: usize, line: &str) -> Vec<TokOpt>

Once you have called the run or append methods, you can use this function to retrieve individual lines by providing the original line text and the y index.

Example

let highlighter = Highlighter::new(4); // Tab ('\t') has a display width of 4
highlighter.keyword("kw", "keyword"); // All occurances of "keyword" will be classed as a token of "kw"
highlighter.run(vec![
    "this is a keyword".to_string(), 
    "second line!".to_string()
]);
// Get the TokOpt for the first line
highlighter.line(0, &"this is a keyword".to_string())
// Get the TokOpt for the second line
highlighter.line(1, &"second line!".to_string())

pub fn edit(&mut self, y: usize, line: &str)

Whenever a character is deleted or inserted on a line, call this function to update any tokens.

pub fn insert_line(&mut self, y: usize, line: &str)

Whenever a line is inserted into the document, call this function to update any tokens.

pub fn remove_line(&mut self, y: usize)

Whenever a line is removed from a document, call this function to update any tokens.

Trait Implementations

impl Clone for Highlighter

fn clone(&self) -> Highlighter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Highlighter

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

Formats the value using the given formatter.