adze-tablegen 0.8.0

Table generation and compression for pure-Rust Tree-sitter
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
//! High-level language builder producing validated Language structures.

use crate::compress::CompressedParseTable;
use crate::validation::TSLanguage;
use adze_glr_core::ParseTable;
use adze_ir::Grammar;
use proc_macro2::TokenStream;
use quote::quote;

/// Language builder that produces validated Language structs
pub struct LanguageBuilder {
    grammar: Grammar,
    parse_table: ParseTable,
    start_can_be_empty: bool,
}

impl LanguageBuilder {
    /// Create a new generator
    pub fn new(grammar: Grammar, parse_table: ParseTable) -> Self {
        Self {
            grammar,
            parse_table,
            start_can_be_empty: false,
        }
    }

    /// Set whether the start symbol can be empty (nullable)
    pub fn set_start_can_be_empty(&mut self, value: bool) {
        self.start_can_be_empty = value;
    }

    /// Generate a static Language struct with full validation
    #[must_use = "generation result must be checked"]
    pub fn generate_language(&self) -> Result<TSLanguage, String> {
        // Create compressed tables
        let compressed = CompressedParseTable::from_parse_table(&self.parse_table);

        // Build the Language struct
        let language = self.build_language_struct(&compressed)?;

        // Note: Validation would be done separately by the caller
        // to avoid lifetime issues

        Ok(language)
    }

    /// Build the Language struct with all required fields
    fn build_language_struct(
        &self,
        compressed: &CompressedParseTable,
    ) -> Result<TSLanguage, String> {
        // Count various elements
        let symbol_count = self.parse_table.symbol_count as u32;
        let state_count = self.parse_table.state_count as u32;
        // token_count includes EOF (symbol 0) plus all user-defined tokens
        let token_count = (self.grammar.tokens.len() + 1) as u32;
        let external_token_count = self.grammar.externals.len() as u32;
        let field_count = self.grammar.fields.len() as u32;

        // TODO: Calculate these properly
        let alias_count = 0;
        let large_state_count = 0;
        let production_id_count = self.grammar.alias_sequences.len() as u32;
        let max_alias_sequence_length = 0;

        // Build symbol names array
        let symbol_names = self.build_symbol_names();

        // Build field names array
        let field_names = self.build_field_names();

        // Build symbol metadata
        let symbol_metadata = self.build_symbol_metadata();

        // Build minimal parse tables for validation
        // For now, create dummy tables - in real implementation these would be
        // generated from the compressed parse table data
        let small_parse_table = self.build_small_parse_table(compressed);

        Ok(TSLanguage {
            version: 15,
            symbol_count,
            alias_count,
            token_count,
            external_token_count,
            state_count,
            large_state_count,
            production_id_count,
            field_count,
            max_alias_sequence_length,
            parse_table: std::ptr::null(),
            small_parse_table: Box::leak(Box::new(small_parse_table)).as_ptr(),
            small_parse_table_map: std::ptr::null(),
            parse_actions: std::ptr::null(),
            symbol_names: Box::leak(Box::new(symbol_names)).as_ptr(),
            field_names: if field_count > 0 {
                Box::leak(Box::new(field_names)).as_ptr()
            } else {
                std::ptr::null()
            },
            field_map_slices: std::ptr::null(),
            field_map_entries: std::ptr::null(),
            symbol_metadata: Box::leak(Box::new(symbol_metadata)).as_ptr(),
            public_symbol_map: std::ptr::null(),
            alias_map: std::ptr::null(),
            alias_sequences: std::ptr::null(),
            lex_modes: std::ptr::null(),
            lex_fn: None,
            keyword_lex_fn: None,
            keyword_capture_token: 0,
            external_scanner_data: crate::validation::TSExternalScannerData {
                states: std::ptr::null(),
                symbol_map: std::ptr::null(),
                create: None,
                destroy: None,
                scan: None,
                serialize: None,
                deserialize: None,
            },
            primary_state_ids: std::ptr::null(),
        })
    }

    fn build_symbol_names(&self) -> Vec<*const i8> {
        let mut names = Vec::new();

        // Add terminal symbols
        for (_, token) in &self.grammar.tokens {
            let name = std::ffi::CString::new(token.name.clone())
                .expect("symbol name must not contain NUL bytes");
            names.push(Box::leak(Box::new(name)).as_ptr());
        }

        // Add non-terminal symbols
        for (symbol_id, _) in &self.grammar.rules {
            let name = std::ffi::CString::new(format!("rule_{}", symbol_id.0))
                .expect("rule name must not contain NUL bytes");
            names.push(Box::leak(Box::new(name)).as_ptr());
        }

        // Add external symbols
        for external in &self.grammar.externals {
            let name = std::ffi::CString::new(external.name.clone())
                .expect("external name must not contain NUL bytes");
            names.push(Box::leak(Box::new(name)).as_ptr());
        }

        names
    }

    fn build_field_names(&self) -> Vec<*const i8> {
        let mut names = Vec::new();

        // First entry is always empty string
        let empty = std::ffi::CString::new("").expect("empty string cannot contain NUL bytes");
        names.push(Box::leak(Box::new(empty)).as_ptr());

        // Add field names in lexicographic order
        for (_, field_name) in &self.grammar.fields {
            let name = std::ffi::CString::new(field_name.clone())
                .expect("field name must not contain NUL bytes");
            names.push(Box::leak(Box::new(name)).as_ptr());
        }

        names
    }

    fn build_symbol_metadata(&self) -> Vec<crate::validation::TSSymbolMetadata> {
        let mut metadata = Vec::new();

        // First symbol is always EOF (invisible, unnamed)
        metadata.push(crate::validation::TSSymbolMetadata {
            visible: false,
            named: false,
        });

        // Add metadata for terminals
        for (_, token) in &self.grammar.tokens {
            let visible = !token.name.starts_with('_');
            let named = matches!(&token.pattern, adze_ir::TokenPattern::Regex(_)) && visible;

            metadata.push(crate::validation::TSSymbolMetadata { visible, named });
        }

        // Add metadata for non-terminals
        for (symbol_id, _) in &self.grammar.rules {
            let rule_name = format!("rule_{}", symbol_id.0);
            let visible = !rule_name.starts_with('_');
            let named = visible;

            metadata.push(crate::validation::TSSymbolMetadata { visible, named });
        }

        // Add metadata for externals
        for external in &self.grammar.externals {
            let visible = !external.name.starts_with('_');
            let named = visible;

            metadata.push(crate::validation::TSSymbolMetadata { visible, named });
        }

        metadata
    }

    /// Build a minimal small parse table for testing
    fn build_small_parse_table(&self, _compressed: &CompressedParseTable) -> Vec<u16> {
        // Create a minimal parse table with the right dimensions
        // In real implementation, this would be generated from compressed data
        let table_size = self.parse_table.state_count * self.parse_table.symbol_count;
        vec![0xFFFE; table_size] // Fill with error actions for now
    }

    /// Generate Rust code for the Language
    pub fn generate_language_code(&self) -> TokenStream {
        quote! {
            // Placeholder for Language code generation
            pub fn language() -> *const TSLanguage {
                std::ptr::null()
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use adze_glr_core::Action;
    use adze_ir::*;

    fn create_test_grammar() -> Grammar {
        let mut grammar = Grammar {
            name: "test".to_string(),
            ..Default::default()
        };

        // Add a simple token
        grammar.tokens.insert(
            SymbolId(1),
            Token {
                name: "number".to_string(),
                pattern: TokenPattern::Regex(r"\d+".to_string()),
                fragile: false,
            },
        );

        // Add a simple rule
        grammar.add_rule(Rule {
            lhs: SymbolId(0),
            rhs: vec![Symbol::Terminal(SymbolId(1))],
            precedence: None,
            associativity: None,
            fields: vec![],
            production_id: ProductionId(0),
        });

        // Add field names
        grammar.fields.insert(FieldId(0), "value".to_string());

        grammar
    }

    fn create_test_parse_table() -> ParseTable {
        let mut table = crate::test_helpers::test::make_minimal_table(
            vec![vec![vec![]; 2]; 3], // 3 states, 2 symbols
            vec![vec![crate::test_helpers::test::INVALID; 2]; 3],
            vec![],
            adze_ir::SymbolId(1), // start_symbol
            adze_ir::SymbolId(1), // eof_symbol
            0,                    // external_token_count
        );

        // Add some basic actions
        // Since we don't have an actions field, just initialize the action table with proper size
        table.action_table = vec![vec![vec![Action::Error]; table.symbol_count]; table.state_count];

        table
    }

    #[test]
    fn test_language_builder_creation() {
        let grammar = create_test_grammar();
        let parse_table = create_test_parse_table();
        let builder = LanguageBuilder::new(grammar, parse_table);

        // Just verify it can be created
        assert!(builder.grammar.name == "test");
    }

    #[test]
    fn test_generate_language() {
        let grammar = create_test_grammar();
        let parse_table = create_test_parse_table();
        let builder = LanguageBuilder::new(grammar, parse_table);

        let result = builder.generate_language();
        assert!(result.is_ok());

        let language = result.unwrap();
        assert_eq!(language.version, 15);
        assert_eq!(language.symbol_count, 2);
        assert_eq!(language.state_count, 3);
    }

    #[test]
    fn test_build_symbol_names() {
        let grammar = create_test_grammar();
        let parse_table = create_test_parse_table();
        let builder = LanguageBuilder::new(grammar, parse_table);

        let names = builder.build_symbol_names();
        assert!(!names.is_empty());
        // Should have at least the token name
        assert!(
            // SAFETY: `name` points to a string literal leaked by `build_symbol_names`,
            // so it is valid, null-terminated, and lives for 'static.
            names.iter().any(|&name| unsafe {
                std::ffi::CStr::from_ptr(name).to_str().unwrap() == "number"
            })
        );
    }

    #[test]
    fn test_build_field_names() {
        let grammar = create_test_grammar();
        let parse_table = create_test_parse_table();
        let builder = LanguageBuilder::new(grammar, parse_table);

        let names = builder.build_field_names();
        // GLR adds an extra null field at index 0
        assert_eq!(names.len(), 2);
        // First field should be null (empty string)
        assert_eq!(
            // SAFETY: `names[0]` is a leaked CString pointer from `build_field_names`.
            unsafe { std::ffi::CStr::from_ptr(names[0]).to_str().unwrap() },
            ""
        );
        // Second field should be "value"
        assert_eq!(
            // SAFETY: `names[1]` is a leaked CString pointer from `build_field_names`.
            unsafe { std::ffi::CStr::from_ptr(names[1]).to_str().unwrap() },
            "value"
        );
    }

    #[test]
    fn test_build_symbol_metadata() {
        let grammar = create_test_grammar();
        let parse_table = create_test_parse_table();
        let builder = LanguageBuilder::new(grammar, parse_table);

        let metadata = builder.build_symbol_metadata();
        assert!(!metadata.is_empty());
    }

    #[test]
    fn test_language_generator_code() {
        let grammar = create_test_grammar();
        let parse_table = create_test_parse_table();
        let builder = LanguageBuilder::new(grammar, parse_table);

        let code = builder.generate_language_code();
        let code_str = code.to_string();

        // Check for key elements
        assert!(code_str.contains("language"));
        assert!(code_str.contains("TSLanguage"));
    }

    #[test]
    fn test_language_with_externals() {
        let mut grammar = create_test_grammar();

        // Add external token
        grammar.externals.push(ExternalToken {
            name: "comment".to_string(),
            symbol_id: SymbolId(100),
        });

        let parse_table = create_test_parse_table();
        let builder = LanguageBuilder::new(grammar, parse_table);

        let result = builder.generate_language();
        assert!(result.is_ok());

        let language = result.unwrap();
        assert_eq!(language.external_token_count, 1);
    }

    #[test]
    fn test_language_with_multiple_fields() {
        let mut grammar = create_test_grammar();

        // Add more fields
        grammar.fields.insert(FieldId(1), "left".to_string());
        grammar.fields.insert(FieldId(2), "operator".to_string());
        grammar.fields.insert(FieldId(3), "right".to_string());

        let parse_table = create_test_parse_table();
        let builder = LanguageBuilder::new(grammar, parse_table);

        let result = builder.generate_language();
        assert!(result.is_ok());

        let language = result.unwrap();
        assert_eq!(language.field_count, 4);
    }
}