darklua 0.18.0

Transform Lua scripts
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
use std::{convert::TryFrom, num::FpCategory};

use crate::nodes::{
    BinaryNumber, DecimalNumber, Expression, HexNumber, Identifier, NumberExpression,
    StringExpression, TableEntry, TableExpression, TableFieldEntry, TableTokens, Token, Trivia,
};

/// A literal expression in Luau.
///
/// Literal expressions are used in function attribute arguments
/// (e.g., `@[attr(true, 42, "text")]`).
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum LiteralExpression {
    /// The boolean literal `true`
    True(Option<Token>),
    /// The boolean literal `false`
    False(Option<Token>),
    /// The nil literal
    Nil(Option<Token>),
    /// A numeric literal (e.g., `42`, `3.14`)
    Number(NumberExpression),
    /// A string literal (e.g., `"hello"`, `[[text]]`)
    String(StringExpression),
    /// A table literal (e.g., `{ key = value }`)
    Table(Box<LiteralTable>),
}

impl LiteralExpression {
    /// Creates a new nil literal expression.
    pub fn nil() -> Self {
        Self::Nil(None)
    }
}

impl From<LiteralTable> for LiteralExpression {
    fn from(v: LiteralTable) -> Self {
        Self::Table(Box::new(v))
    }
}

impl From<StringExpression> for LiteralExpression {
    fn from(v: StringExpression) -> Self {
        Self::String(v)
    }
}

impl From<bool> for LiteralExpression {
    fn from(v: bool) -> Self {
        if v {
            Self::True(None)
        } else {
            Self::False(None)
        }
    }
}

impl TryFrom<f64> for LiteralExpression {
    type Error = &'static str;

    fn try_from(value: f64) -> Result<Self, Self::Error> {
        match value.classify() {
            FpCategory::Nan => Err("NaN is not a valid literal expression"),
            FpCategory::Infinite => Err("Infinity is not a valid literal expression"),
            FpCategory::Zero => {
                Ok(DecimalNumber::new(if value.is_sign_positive() {
                    0.0
                } else {
                    // if literal expression are allowed to have negative values in the
                    // future, we should return -0.0 here
                    0.0
                })
                .into())
            }
            FpCategory::Subnormal | FpCategory::Normal => {
                if value < 0.0 {
                    Err("Negative numbers are not a valid literal expression")
                } else if value < 0.1 {
                    let exponent = value.log10().floor();

                    Ok(DecimalNumber::new(value)
                        .with_exponent(exponent as i64, true)
                        .into())
                } else if value > 999.0 && (value / 100.0).fract() == 0.0 {
                    let mut exponent = value.log10().floor();
                    let mut power = 10_f64.powf(exponent);

                    while exponent > 2.0 && (value / power).fract() != 0.0 {
                        exponent -= 1.0;
                        power /= 10.0;
                    }

                    Ok(DecimalNumber::new(value)
                        .with_exponent(exponent as i64, true)
                        .into())
                } else {
                    Ok(DecimalNumber::new(value).into())
                }
            }
        }
    }
}

impl TryFrom<f32> for LiteralExpression {
    type Error = &'static str;

    fn try_from(value: f32) -> Result<Self, Self::Error> {
        LiteralExpression::try_from(value as f64)
    }
}

impl From<NumberExpression> for LiteralExpression {
    fn from(v: NumberExpression) -> Self {
        Self::Number(v)
    }
}

impl TryFrom<u64> for LiteralExpression {
    type Error = &'static str;

    fn try_from(value: u64) -> Result<Self, Self::Error> {
        LiteralExpression::try_from(value as f64)
    }
}

impl From<u32> for LiteralExpression {
    fn from(value: u32) -> Self {
        LiteralExpression::try_from(value as f64)
            .expect("converting a u32 to a literal number expression should never fail")
    }
}

impl From<u16> for LiteralExpression {
    fn from(value: u16) -> Self {
        LiteralExpression::try_from(value as f64)
            .expect("converting a u16 to a literal number expression should never fail")
    }
}

impl From<u8> for LiteralExpression {
    fn from(value: u8) -> Self {
        LiteralExpression::try_from(value as f64)
            .expect("converting a u8 to a literal number expression should never fail")
    }
}

impl TryFrom<i64> for LiteralExpression {
    type Error = &'static str;

    fn try_from(value: i64) -> Result<Self, Self::Error> {
        LiteralExpression::try_from(value as f64)
    }
}

impl TryFrom<i32> for LiteralExpression {
    type Error = &'static str;

    fn try_from(value: i32) -> Result<Self, Self::Error> {
        LiteralExpression::try_from(value as f64)
    }
}

impl TryFrom<i16> for LiteralExpression {
    type Error = &'static str;

    fn try_from(value: i16) -> Result<Self, Self::Error> {
        LiteralExpression::try_from(value as f64)
    }
}

impl TryFrom<i8> for LiteralExpression {
    type Error = &'static str;

    fn try_from(value: i8) -> Result<Self, Self::Error> {
        LiteralExpression::try_from(value as f64)
    }
}

impl From<DecimalNumber> for LiteralExpression {
    fn from(number: DecimalNumber) -> Self {
        Self::Number(NumberExpression::Decimal(number))
    }
}

impl From<HexNumber> for LiteralExpression {
    fn from(number: HexNumber) -> Self {
        Self::Number(NumberExpression::Hex(number))
    }
}

impl From<BinaryNumber> for LiteralExpression {
    fn from(number: BinaryNumber) -> Self {
        Self::Number(NumberExpression::Binary(number))
    }
}

impl<T: Into<LiteralExpression>> From<Option<T>> for LiteralExpression {
    fn from(value: Option<T>) -> Self {
        match value {
            None => Self::nil(),
            Some(value) => value.into(),
        }
    }
}

impl From<LiteralExpression> for Expression {
    fn from(literal: LiteralExpression) -> Self {
        match literal {
            LiteralExpression::True(token) => Self::True(token),
            LiteralExpression::False(token) => Self::False(token),
            LiteralExpression::Nil(token) => Self::Nil(token),
            LiteralExpression::Number(num) => Self::Number(num),
            LiteralExpression::String(string) => Self::String(string),
            LiteralExpression::Table(table) => Self::Table((*table).into()),
        }
    }
}

/// A literal table in Luau.
///
/// Table literals follow the syntax `{ entry1, entry2, key = value }`.
#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub struct LiteralTable {
    entries: Vec<LiteralTableEntry>,
    tokens: Option<TableTokens>,
}

impl LiteralTable {
    /// Creates a new literal table from a vector of entries.
    pub fn from_entries(entries: Vec<LiteralTableEntry>) -> Self {
        Self {
            entries,
            tokens: None,
        }
    }

    /// Adds an entry to this table.
    pub fn with_entry(mut self, entry: impl Into<LiteralTableEntry>) -> Self {
        self.entries.push(entry.into());
        self
    }

    /// Appends an entry to this table.
    pub fn append_entry(&mut self, entry: impl Into<LiteralTableEntry>) {
        self.entries.push(entry.into());
    }

    /// Appends a field entry to this table.
    pub fn append_field(&mut self, field: Identifier, value: impl Into<LiteralExpression>) {
        self.append_entry(LiteralTableEntry::Field(Box::new(LiteralTableFieldEntry {
            field,
            value: value.into(),
            token: None,
        })));
    }

    /// Appends an array value entry to this table.
    pub fn append_array_value(&mut self, value: impl Into<LiteralExpression>) {
        self.append_entry(LiteralTableEntry::Value(Box::new(value.into())));
    }

    /// Returns an iterator over the table entries.
    pub fn iter_entries(&self) -> impl Iterator<Item = &LiteralTableEntry> {
        self.entries.iter()
    }

    /// Returns a mutable iterator over the table entries.
    pub fn iter_mut_entries(&mut self) -> impl Iterator<Item = &mut LiteralTableEntry> {
        self.entries.iter_mut()
    }

    /// Attaches tokens to this table.
    pub fn with_tokens(mut self, tokens: TableTokens) -> Self {
        self.tokens = Some(tokens);
        self
    }

    /// Sets the tokens for this table.
    pub fn set_tokens(&mut self, tokens: TableTokens) {
        self.tokens = Some(tokens);
    }

    /// Returns the tokens for this table, if any.
    pub fn get_tokens(&self) -> Option<&TableTokens> {
        self.tokens.as_ref()
    }

    /// Returns the number of entries in this table.
    pub fn len(&self) -> usize {
        self.entries.len()
    }

    /// Returns whether this table is empty.
    pub fn is_empty(&self) -> bool {
        self.entries.is_empty()
    }

    super::impl_token_fns!(iter = [tokens, entries]);
}

/// An entry in a literal table.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum LiteralTableEntry {
    /// A named field entry (e.g., `{ field = value }`)
    Field(Box<LiteralTableFieldEntry>),
    /// A value entry for array-like tables (e.g., `{ value }`)
    Value(Box<LiteralExpression>),
}

impl LiteralTableEntry {
    /// Creates a value entry from a literal expression.
    pub fn from_value(value: impl Into<LiteralExpression>) -> Self {
        Self::Value(Box::new(value.into()))
    }

    /// Clears all comments from the tokens in this node.
    pub fn clear_comments(&mut self) {
        match self {
            Self::Field(entry) => entry.clear_comments(),
            Self::Value(_value) => {}
        }
    }

    /// Clears all whitespaces information from the tokens in this node.
    pub fn clear_whitespaces(&mut self) {
        match self {
            Self::Field(entry) => entry.clear_whitespaces(),
            Self::Value(_value) => {}
        }
    }

    pub(crate) fn replace_referenced_tokens(&mut self, code: &str) {
        match self {
            Self::Field(entry) => entry.replace_referenced_tokens(code),
            Self::Value(_value) => {}
        }
    }

    pub(crate) fn shift_token_line(&mut self, amount: isize) {
        match self {
            Self::Field(entry) => entry.shift_token_line(amount),
            Self::Value(_value) => {}
        }
    }

    pub(crate) fn filter_comments(&mut self, filter: impl Fn(&Trivia) -> bool) {
        match self {
            Self::Field(entry) => entry.filter_comments(filter),
            Self::Value(_value) => {}
        }
    }
}

impl From<LiteralTableFieldEntry> for LiteralTableEntry {
    fn from(v: LiteralTableFieldEntry) -> Self {
        Self::Field(Box::new(v))
    }
}

impl From<LiteralExpression> for LiteralTableEntry {
    fn from(v: LiteralExpression) -> Self {
        Self::Value(Box::new(v))
    }
}

/// A field entry in a literal table.
///
/// Represents a named field assignment: `{ field = value }`.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct LiteralTableFieldEntry {
    field: Identifier,
    value: LiteralExpression,
    token: Option<Token>,
}

impl LiteralTableFieldEntry {
    /// Attaches a token to this field entry for the `=` symbol.
    pub fn with_token(mut self, token: Token) -> Self {
        self.token = Some(token);
        self
    }

    /// Sets the token for this field entry's `=` symbol.
    pub fn set_token(&mut self, token: Token) {
        self.token = Some(token);
    }

    /// Returns the token for this field entry's `=` symbol, if any.
    pub fn get_token(&self) -> Option<&Token> {
        self.token.as_ref()
    }

    /// Returns the field name.
    pub fn get_field(&self) -> &Identifier {
        &self.field
    }

    /// Returns a mutable reference to the field name.
    pub fn mutate_field(&mut self) -> &mut Identifier {
        &mut self.field
    }

    /// Returns the field value.
    pub fn get_value(&self) -> &LiteralExpression {
        &self.value
    }

    /// Returns a mutable reference to the field value.
    pub fn mutate_value(&mut self) -> &mut LiteralExpression {
        &mut self.value
    }

    /// Returns a mutable reference to the token for this field entry's `=` symbol, if any.
    pub fn mutate_token(&mut self) -> Option<&mut Token> {
        self.token.as_mut()
    }

    super::impl_token_fns!(
        target = [field]
        iter = [token]
    );
}

impl From<LiteralTable> for TableExpression {
    fn from(literal_table: LiteralTable) -> Self {
        let entries = literal_table
            .entries
            .into_iter()
            .map(|entry| match entry {
                LiteralTableEntry::Field(field) => {
                    let field = *field;
                    TableEntry::Field(Box::new(TableFieldEntry::new(
                        field.field,
                        Expression::from(field.value),
                    )))
                }
                LiteralTableEntry::Value(value) => {
                    TableEntry::Value(Box::new(Expression::from(*value)))
                }
            })
            .collect();

        let mut table = TableExpression::new(entries);
        if let Some(tokens) = literal_table.tokens {
            table.set_tokens(tokens);
        }
        table
    }
}