oxidoc-highlight 0.1.1

Lightweight syntax highlighting for documentation engines
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

mod bash;
mod c;
mod css;
mod diff;
mod go;
mod html;
mod java;
mod javascript;
mod json;
mod markdown;
mod php;
mod python;
mod rdx;
mod rust;
mod sql;
mod toml;
mod xml;
mod yaml;

use crate::scanner::Scanner;
use crate::token::Token;

/// Get a scanner for the given language name. Returns `None` for unknown languages.
pub fn get_scanner(lang: &str) -> Option<Box<dyn Scanner>> {
    match lang {
        "rust" | "rs" => Some(Box::new(rust::RustScanner)),
        "javascript" | "js" => Some(Box::new(javascript::JsScanner {
            typescript: false,
            jsx: false,
        })),
        "jsx" => Some(Box::new(javascript::JsScanner {
            typescript: false,
            jsx: true,
        })),
        "typescript" | "ts" => Some(Box::new(javascript::JsScanner {
            typescript: true,
            jsx: false,
        })),
        "tsx" => Some(Box::new(javascript::JsScanner {
            typescript: true,
            jsx: true,
        })),
        "python" | "py" => Some(Box::new(python::PythonScanner)),
        "bash" | "sh" | "shell" | "zsh" => Some(Box::new(bash::BashScanner)),
        "html" | "vue" | "svelte" => Some(Box::new(html::HtmlScanner)),
        "css" | "scss" | "less" => Some(Box::new(css::CssScanner)),
        "json" | "jsonc" | "json5" => Some(Box::new(json::JsonScanner)),
        "toml" => Some(Box::new(toml::TomlScanner)),
        "yaml" | "yml" => Some(Box::new(yaml::YamlScanner)),
        "go" | "golang" => Some(Box::new(go::GoScanner)),
        "c" | "h" => Some(Box::new(c::CScanner { cpp: false })),
        "cpp" | "c++" | "cxx" | "cc" | "hpp" | "hxx" => Some(Box::new(c::CScanner { cpp: true })),
        "java" | "kotlin" | "kt" => Some(Box::new(java::JavaScanner)),
        "php" => Some(Box::new(php::PhpScanner)),
        "sql" | "mysql" | "postgresql" | "sqlite" => Some(Box::new(sql::SqlScanner)),
        "markdown" | "md" => Some(Box::new(markdown::MarkdownScanner)),
        "rdx" => Some(Box::new(rdx::RdxScanner)),
        "xml" | "svg" | "xhtml" | "xsl" => Some(Box::new(xml::XmlScanner)),
        "diff" | "patch" => Some(Box::new(diff::DiffScanner)),
        _ => None,
    }
}

/// List of all supported language names.
pub fn supported() -> Vec<&'static str> {
    vec![
        "rust",
        "rs",
        "javascript",
        "js",
        "jsx",
        "typescript",
        "ts",
        "tsx",
        "python",
        "py",
        "bash",
        "sh",
        "shell",
        "zsh",
        "html",
        "vue",
        "svelte",
        "css",
        "scss",
        "less",
        "json",
        "jsonc",
        "json5",
        "toml",
        "yaml",
        "yml",
        "go",
        "golang",
        "c",
        "h",
        "cpp",
        "c++",
        "cxx",
        "cc",
        "hpp",
        "hxx",
        "java",
        "kotlin",
        "kt",
        "php",
        "sql",
        "mysql",
        "postgresql",
        "sqlite",
        "markdown",
        "md",
        "rdx",
        "xml",
        "svg",
        "xhtml",
        "xsl",
        "diff",
        "patch",
    ]
}

/// Scan code with the given language, or return empty tokens for unknown languages.
pub fn scan(code: &str, lang: &str) -> Vec<Token> {
    match get_scanner(lang) {
        Some(scanner) => scanner.scan(code),
        None => vec![],
    }
}