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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
use proc_macro2::TokenStream;
use quote::quote;
use crate::Language;
pub fn languages_enum_def(languages: &[Language]) -> TokenStream {
let members = languages
.iter()
.filter(|lang| lang.name != "plaintext")
.map(Language::pretty_name);
let features = languages
.iter()
.filter(|lang| lang.name != "plaintext")
.map(Language::feature);
quote! {
/// The set of all languages supported by Inkjet.
#[non_exhaustive]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum Language {
/// A language resolved at runtime using the provided function pointer.
///
/// This allows languages not statically known to Inkjet to be used in formatting.
///
/// # Examples
/// ```rust
/// # use inkjet::tree_sitter_highlight::HighlightConfiguration;
/// # use inkjet::formatter;
/// # use inkjet::Language;
/// # use inkjet::Highlighter;
/// fn rust_config() -> &'static HighlightConfiguration {
/// Language::Rust.config()
/// }
///
/// let code = r#"
/// fn main() {
/// println!("Hello, world!");
/// }
/// "#;
///
/// let mut highlighter = Highlighter::new();
///
/// let _string = highlighter.highlight_to_string(
/// Language::Runtime(rust_config),
/// &formatter::Html,
/// code
/// )
/// .expect("Highlighting should not fail");
/// ```
Runtime(fn() -> &'static HighlightConfiguration),
/// A plaintext "language." Highlighting with this is a no-op.
#[cfg(feature = "language-plaintext")]
Plaintext,
#(#[cfg(feature = #features)] #members),*
}
}
}
pub fn languages_impl_def(languages: &[Language]) -> TokenStream {
let variants: Vec<_> = languages
.iter()
.map(Language::pretty_name)
.collect();
let features: Vec<_> = languages
.iter()
.map(Language::feature)
.collect();
let all_langs = quote! {
/// Array containing all (statically known) language variants.
pub const ALL_LANGS: &'static [Self] = &[
#(#[cfg(feature = #features)] Self::#variants),*
];
};
let tokens = languages
.iter()
.flat_map(|lang| {
[&lang.name]
.into_iter()
.chain(&lang.aliases)
.map(|token| {
let feature = lang.feature();
let name = lang.pretty_name();
quote! {
#[cfg(feature = #feature)]
#token => Some(Self::#name),
}
})
});
let from_token = quote! {
/// Attempts to convert a string token (such as `rust` or `rs`) into the corresponding language.
///
/// Returns [`None`] if the language was not found.
///
/// The tokens for each language are sourced from its `name` and `aliases` keys in
/// `build/languages.toml`.
///
/// # Example
/// ```rust
/// # use inkjet::Language;
/// assert_eq!(
/// Language::from_token("rs").unwrap(),
/// Language::Rust
/// );
/// ```
pub fn from_token(token: impl AsRef<str>) -> Option<Self> {
match token.as_ref() {
#(#tokens)*
_ => None
}
}
};
let names = languages
.iter()
.map(|lang| quote::format_ident!{
"{}",
lang.name
});
let config = quote! {
/// Get the underlying [`HighlightConfiguration`] for a language.
pub fn config(&self) -> &'static HighlightConfiguration {
match *self {
#(#[cfg(feature = #features)] Self::#variants => &#names::CONFIG,)*
Self::Runtime(ptr) => ptr(),
}
}
};
quote! {
impl Language {
#all_langs
#from_token
#config
}
}
}
pub fn language_module_def(lang: &Language) -> TokenStream {
use std::path::Path;
let name = &lang.name;
let include_path = |query| -> TokenStream {
let path = format!("languages/{name}/queries/{query}.scm");
let query = match Path::new(&path).exists() {
false => "\"\"".to_string(),
true => format!("include_str!(\"../{}\")", &path),
};
query.parse().unwrap()
};
let highlight_query = include_path("highlights");
let injections_query = include_path("injections");
let locals_query = include_path("locals");
let feature = lang.feature();
let name = quote::format_ident!("{name}");
let hl_config_name = format!("{name}");
let ts_ffi = quote::format_ident!("tree_sitter_{name}");
let error = format!("\"Failed to load highlight configuration for language '{name}'\"");
quote::quote! {
#[cfg(feature = #feature)]
pub mod #name {
use std::sync::LazyLock;
use tree_sitter::Language;
use tree_sitter_highlight::HighlightConfiguration;
use crate::constants::HIGHLIGHT_NAMES;
extern "C" {
pub fn #ts_ffi() -> Language;
}
pub static CONFIG: LazyLock<HighlightConfiguration> = LazyLock::new(|| {
let mut config = HighlightConfiguration::new(
unsafe { #ts_ffi() },
#hl_config_name,
HIGHLIGHT_QUERY,
INJECTIONS_QUERY,
LOCALS_QUERY,
)
.expect(#error);
config.configure(HIGHLIGHT_NAMES);
config
});
pub const HIGHLIGHT_QUERY: &str = #highlight_query;
pub const INJECTIONS_QUERY: &str = #injections_query;
pub const LOCALS_QUERY: &str = #locals_query;
#[cfg(test)]
mod tests {
use super::*;
use crate::tree_sitter_highlight::Highlighter;
#[test]
fn grammar_loading() {
let mut parser = tree_sitter::Parser::new();
parser
.set_language(unsafe { &#ts_ffi() })
.expect("Grammar should load successfully.");
}
#[test]
fn config_loading() {
let mut highlighter = Highlighter::new();
let _events = highlighter.highlight(
&CONFIG,
b"",
None,
|_|
None
).expect("Highlighter should generate events successfully.");
}
}
}
}
}