luau-syntax 0.732.0

Luau lexer, parser, AST, CST, and source utilities
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
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
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
use crate::ast::{
    AstString, Attribute, Block, Expression, Function, GenericType, GenericTypePack, Statement,
    Type, TypePack,
};
use crate::lexer::QuoteStyle as LexerQuoteStyle;
use crate::location::Position;
use luau_common::{DenseHashHasher, DenseHashMap};

#[derive(Debug, Clone)]
pub struct CstNodeMap<'ast> {
    nodes: DenseHashMap<AstNodeKey, Option<CstNode<'ast>>, AstNodeKeyHasher>,
}

impl Default for CstNodeMap<'_> {
    fn default() -> Self {
        Self {
            nodes: DenseHashMap::new(AstNodeKey::empty()),
        }
    }
}

impl PartialEq for CstNodeMap<'_> {
    fn eq(&self, other: &Self) -> bool {
        self.nodes.len() == other.nodes.len()
            && self
                .nodes
                .iter()
                .all(|(key, value)| other.nodes.get(key) == Some(value))
    }
}

impl<'ast> CstNodeMap<'ast> {
    pub fn is_empty(&self) -> bool {
        self.nodes.is_empty()
    }

    pub(crate) fn insert(&mut self, node: impl AstNodeKeySource, cst: CstNode<'ast>) {
        self.nodes.insert(node.key(), Some(cst));
    }

    pub(crate) fn get(&self, node: impl AstNodeKeySource) -> Option<&CstNode<'ast>> {
        self.nodes.get(&node.key()).and_then(Option::as_ref)
    }

    pub fn get_block(&self, block: Block) -> Option<&CstNode<'ast>> {
        self.get(block.as_statement())
    }

    pub fn get_statement(&self, statement: Statement) -> Option<&CstNode<'ast>> {
        self.get(statement)
    }

    pub fn get_expression(&self, expression: Expression) -> Option<&CstNode<'ast>> {
        self.get(expression)
    }

    pub fn get_function(&self, function: &Function) -> Option<&CstNode<'ast>> {
        self.get(function)
    }

    pub fn get_attribute(&self, attribute: &Attribute) -> Option<&CstNode<'ast>> {
        self.get(attribute)
    }

    pub fn get_type(&self, annotation: Type) -> Option<&CstNode<'ast>> {
        self.get(annotation)
    }

    pub fn get_type_pack(&self, annotation: TypePack) -> Option<&CstNode<'ast>> {
        self.get(annotation)
    }

    pub fn get_generic_type(&self, generic: &GenericType) -> Option<&CstNode<'ast>> {
        self.get(generic)
    }

    pub fn get_generic_type_pack(&self, generic: &GenericTypePack) -> Option<&CstNode<'ast>> {
        self.get(generic)
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub(crate) struct AstNodeKey(usize);

impl AstNodeKey {
    fn empty() -> Self {
        Self(0)
    }

    fn from_ref<T>(node: &T) -> Self {
        Self((node as *const T).cast::<()>() as usize)
    }

    fn from_ptr(ptr: *const ()) -> Self {
        Self(ptr as usize)
    }
}

pub(crate) trait AstNodeKeySource {
    fn key(self) -> AstNodeKey;
}

impl AstNodeKeySource for Expression<'_> {
    fn key(self) -> AstNodeKey {
        AstNodeKey::from_ptr(self.as_ptr())
    }
}

impl AstNodeKeySource for Statement<'_> {
    fn key(self) -> AstNodeKey {
        AstNodeKey::from_ptr(self.as_ptr())
    }
}

impl AstNodeKeySource for Block<'_> {
    fn key(self) -> AstNodeKey {
        self.as_statement().key()
    }
}

impl AstNodeKeySource for Type<'_> {
    fn key(self) -> AstNodeKey {
        AstNodeKey::from_ptr(self.as_ptr())
    }
}

impl AstNodeKeySource for TypePack<'_> {
    fn key(self) -> AstNodeKey {
        AstNodeKey::from_ptr(self.as_ptr())
    }
}

impl<T> AstNodeKeySource for &T {
    fn key(self) -> AstNodeKey {
        AstNodeKey::from_ref(self)
    }
}

#[derive(Debug, Clone, Copy)]
struct AstNodeKeyHasher;

impl DenseHashHasher<AstNodeKey> for AstNodeKeyHasher {
    fn hash(key: &AstNodeKey) -> u64 {
        let key = key.0;
        ((key >> 4) ^ (key >> 9)) as u64
    }
}

#[derive(Debug, Clone, PartialEq)]
pub enum CstNode<'ast> {
    ExprConstantNumber(CstExprConstantNumber<'ast>),
    ExprConstantInteger(CstExprConstantInteger<'ast>),
    ExprConstantString(CstExprConstantString<'ast>),
    ExprCall(CstExprCall),
    ExprGroup(CstExprGroup),
    ExprIndexExpr(CstExprIndexExpr),
    ExprFunction(CstExprFunction<'ast>),
    Attribute(CstAttribute),
    ExprTable(CstExprTable),
    ExprOp(CstExprOp),
    ExprTypeAssertion(CstExprTypeAssertion),
    ExprIfElse(CstExprIfElse),
    ExprInterpString(CstExprInterpString<'ast>),
    ExprExplicitTypeInstantiation(CstExprExplicitTypeInstantiation),
    StatDo(CstStatDo),
    StatRepeat(CstStatRepeat),
    StatReturn(CstStatReturn),
    StatLocal(CstStatLocal<'ast>),
    StatFor(CstStatFor),
    StatForIn(CstStatForIn<'ast>),
    StatAssign(CstStatAssign<'ast>),
    StatCompoundAssign(CstStatCompoundAssign),
    StatFunction(CstStatFunction),
    StatLocalFunction(CstStatLocalFunction),
    GenericType(CstGenericType),
    GenericTypePack(CstGenericTypePack),
    StatTypeAlias(CstStatTypeAlias),
    StatTypeFunction(CstStatTypeFunction),
    TypeReference(CstTypeReference),
    TypeGroup(CstTypeGroup),
    TypeTable(CstTypeTable<'ast>),
    TypeFunction(CstTypeFunction),
    TypeTypeof(CstTypeTypeof),
    TypeUnion(CstTypeUnion),
    TypeIntersection(CstTypeIntersection),
    TypeSingletonString(CstTypeSingletonString<'ast>),
    TypePackExplicit(CstTypePackExplicit),
    TypePackGeneric(CstTypePackGeneric),
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct CstExprConstantNumber<'ast> {
    pub value: AstString<'ast>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct CstExprConstantInteger<'ast> {
    pub value: AstString<'ast>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct CstExprConstantString<'ast> {
    pub source_string: AstString<'ast>,
    pub quote_style: CstStringQuoteStyle,
    pub block_depth: u32,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum CstStringQuoteStyle {
    QuotedSingle,
    QuotedDouble,
    QuotedRaw,
    QuotedInterp,
}

impl From<LexerQuoteStyle> for CstStringQuoteStyle {
    fn from(quote_style: LexerQuoteStyle) -> Self {
        match quote_style {
            LexerQuoteStyle::Single => Self::QuotedSingle,
            LexerQuoteStyle::Double => Self::QuotedDouble,
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstTypeInstantiation {
    pub left_arrow_1: Position,
    pub left_arrow_2: Position,
    pub comma_positions: Vec<Position>,
    pub right_arrow_1: Position,
    pub right_arrow_2: Position,
}

impl Default for CstTypeInstantiation {
    fn default() -> Self {
        Self {
            left_arrow_1: Position::missing(),
            left_arrow_2: Position::missing(),
            comma_positions: Vec::new(),
            right_arrow_1: Position::missing(),
            right_arrow_2: Position::missing(),
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstExprCall {
    pub open_parens: Option<Position>,
    pub close_parens: Option<Position>,
    pub comma_positions: Vec<Position>,
    pub explicit_types: Option<CstTypeInstantiation>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstExprGroup {
    pub close_position: Position,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstExprIndexExpr {
    pub open_bracket: Position,
    pub close_bracket: Position,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstExprFunction<'ast> {
    pub attr_lists: Vec<CstAttrList>,
    pub function_keyword: Position,
    pub open_generics: Position,
    pub generics_commas: &'ast [Position],
    pub close_generics: Position,
    pub argument_annotation_colons: &'ast [Position],
    pub argument_commas: &'ast [Position],
    pub vararg_annotation_colon: Position,
    pub return_specifier: Position,
}

impl Default for CstExprFunction<'_> {
    fn default() -> Self {
        Self {
            attr_lists: Vec::new(),
            function_keyword: Position::missing(),
            open_generics: Position::missing(),
            generics_commas: &[],
            close_generics: Position::missing(),
            argument_annotation_colons: &[],
            argument_commas: &[],
            vararg_annotation_colon: Position::missing(),
            return_specifier: Position::missing(),
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CstAttrList {
    pub at_bracket_position: Position,
    pub close_bracket_position: Position,
    pub comma_positions: Vec<Position>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CstAttribute {
    Simple {
        has_at: bool,
    },
    Parametrized {
        open_paren_position: Option<Position>,
        close_paren_position: Option<Position>,
        argument_commas: Vec<Position>,
    },
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstExprTable {
    pub items: Vec<CstExprTableItem>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstExprTableItem {
    pub indexer_open: Option<Position>,
    pub indexer_close: Option<Position>,
    pub equals: Option<Position>,
    pub separator: Option<TableSeparator>,
    pub separator_position: Option<Position>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TableSeparator {
    Comma,
    Semicolon,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstExprOp {
    pub op: Position,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstExprTypeAssertion {
    pub op: Position,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct CstExprIfElse {
    pub then_position: Position,
    pub else_position: Position,
    pub is_else_if: bool,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstExprInterpString<'ast> {
    pub source_strings: Vec<AstString<'ast>>,
    pub string_positions: Vec<Position>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstExprExplicitTypeInstantiation {
    pub instantiation: CstTypeInstantiation,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstStatDo {
    pub stats_start: Position,
    pub end: Position,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstStatRepeat {
    pub until: Position,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstStatReturn {
    pub comma_positions: Vec<Position>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstStatLocal<'ast> {
    pub declaration_keyword_position: Position,
    pub variable_annotation_colons: &'ast [Position],
    pub variable_commas: &'ast [Position],
    pub value_commas: &'ast [Position],
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstStatFor {
    pub annotation_colon: Position,
    pub equals: Position,
    pub end_comma: Position,
    pub step_comma: Option<Position>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstStatForIn<'ast> {
    pub variable_annotation_colons: &'ast [Position],
    pub variable_commas: &'ast [Position],
    pub value_commas: &'ast [Position],
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstStatAssign<'ast> {
    pub variable_commas: &'ast [Position],
    pub equals: Position,
    pub value_commas: &'ast [Position],
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstStatCompoundAssign {
    pub op: Position,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstStatFunction {
    pub attr_lists: Vec<CstAttrList>,
    pub function_keyword: Position,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstStatLocalFunction {
    pub attr_lists: Vec<CstAttrList>,
    pub local_keyword: Position,
    pub function_keyword: Position,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstGenericType {
    pub default_equals: Option<Position>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstGenericTypePack {
    pub ellipsis: Position,
    pub default_equals: Option<Position>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstStatTypeAlias {
    pub type_keyword: Position,
    pub generics_open: Position,
    pub generics_commas: Vec<Position>,
    pub generics_close: Position,
    pub equals: Position,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstStatTypeFunction {
    pub type_keyword: Position,
    pub function_keyword: Position,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstTypeReference {
    pub prefix_dot: Option<Position>,
    pub open_parameters: Position,
    pub parameter_commas: Vec<Position>,
    pub close_parameters: Position,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstTypeGroup {
    pub close_position: Position,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstTypeTable<'ast> {
    pub items: Vec<CstTypeTableItem<'ast>>,
    pub is_array: bool,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstTypeTableItem<'ast> {
    pub kind: CstTypeTableItemKind,
    pub indexer_open: Position,
    pub indexer_close: Position,
    pub colon: Position,
    pub separator: Option<TableSeparator>,
    pub separator_position: Option<Position>,
    pub string_info: Option<CstExprConstantString<'ast>>,
    pub string_position: Position,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CstTypeTableItemKind {
    Indexer,
    Property,
    StringProperty,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstTypeFunction {
    pub open_generics: Position,
    pub generics_commas: Vec<Position>,
    pub close_generics: Position,
    pub open_arguments: Position,
    pub argument_name_colons: Vec<Option<Position>>,
    pub argument_commas: Vec<Position>,
    pub close_arguments: Position,
    pub return_arrow: Position,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstTypeTypeof {
    pub open: Position,
    pub close: Position,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstTypeUnion {
    pub leading: Option<Position>,
    pub separators: Vec<Position>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstTypeIntersection {
    pub leading: Option<Position>,
    pub separators: Vec<Position>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct CstTypeSingletonString<'ast> {
    pub source_string: AstString<'ast>,
    pub quote_style: CstStringQuoteStyle,
    pub block_depth: u32,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstTypePackExplicit {
    pub parentheses: Option<CstTypePackParentheses>,
    pub comma_positions: Vec<Position>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct CstTypePackParentheses {
    pub open: Position,
    pub close: Position,
}

#[derive(Debug, Clone, PartialEq)]
pub struct CstTypePackGeneric {
    pub ellipsis: Position,
}