carta-highlight 0.0.8

Syntax highlighting engine: tokenizes source code from bundled grammars and resolves color styles.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

//! A syntax highlighting engine: it tokenizes source code against a catalog of bundled grammars and
//! resolves the color styles that renderers paint those tokens with.
//!
//! The entry point is [`Highlighter`], which owns the grammar [`Registry`] and the caches that make
//! repeated tokenization cheap. Give it a language name and source text and it returns one
//! [`SourceLine`] per line, each a sequence of classified [`Token`]s. Color [`Theme`]s and the list
//! of bundled languages and styles are exposed alongside for the CLI and the writers.

mod firstbytes;
mod grammar;
mod highlighter;
mod parse;
mod registry;
mod style;
mod token;

pub use highlighter::Highlighter;
pub use parse::ParseError;
pub use registry::{Registry, builtin_style, style_names};
pub use style::{Error as StyleError, Theme, TokenStyle};
pub use token::{SourceLine, Token, TokenKind};

/// The names of the languages offered in listings, in published order.
#[must_use]
pub fn languages() -> Vec<String> {
    Registry::new().languages()
}

/// The names of the built-in color themes, in published order.
#[must_use]
pub fn styles() -> Vec<String> {
    style_names()
}