• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

lunarmodules / luacheck / 24662353255

20 Apr 2026 10:48AM UTC coverage: 97.095% (+0.07%) from 97.027%
24662353255

push

github

web-flow
fix(ci): build LuaJIT using system malloc for lualanes tests (#144)

6318 of 6507 relevant lines covered (97.1%)

26928.88 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

99.44
/src/luacheck/parser.lua
1
local lexer = require "luacheck.lexer"
876✔
2
local utils = require "luacheck.utils"
876✔
3

4
local parser = {}
876✔
5

6
-- A table with range info, or simply range, has `line`, `offset`, and `end_offset` fields.
7
-- `line` is the line of the first character.
8
-- Parser state table has range info for the current token, and all AST
9
-- node tables have range info for themself, including parens around expressions
10
-- that are otherwise not reflected in the AST structure.
11

12
parser.SyntaxError = utils.class()
1,168✔
13

14
function parser.SyntaxError:__init(msg, range, prev_range)
1,752✔
15
   self.msg = msg
924✔
16
   self.line = range.line
924✔
17
   self.offset = range.offset
924✔
18
   self.end_offset = range.end_offset
924✔
19

20
   if prev_range then
924✔
21
      self.prev_line = prev_range.line
276✔
22
      self.prev_offset = prev_range.offset
276✔
23
      self.prev_end_offset = prev_range.end_offset
276✔
24
   end
25
end
26

27
function parser.syntax_error(msg, range, prev_range)
876✔
28
   error(parser.SyntaxError(msg, range, prev_range), 0)
1,232✔
29
end
30

31
local function mark_line_endings(state, token_type)
32
   for line = state.line, state.lexer.line - 1 do
77,214✔
33
      state.line_endings[line] = token_type
228✔
34
   end
35
end
36

37
local function skip_token(state)
38
   while true do
39
      local token, token_value, line, offset, error_end_offset = lexer.next_token(state.lexer)
80,748✔
40
      state.token = token
80,748✔
41
      state.token_value = token_value
80,748✔
42
      state.line = line
80,748✔
43
      state.offset = offset
80,748✔
44
      state.end_offset = error_end_offset or (state.lexer.offset - 1)
80,748✔
45

46
      if not token then
80,748✔
47
         parser.syntax_error(token_value, state)
12✔
48
      end
49

50
      if token == "short_comment" then
80,736✔
51
         state.comments[#state.comments + 1] = {
1,152✔
52
            contents = token_value,
1,152✔
53
            line = line,
1,152✔
54
            offset = offset,
1,152✔
55
            end_offset = state.end_offset
1,152✔
56
         }
1,152✔
57

58
         state.line_endings[line] = "comment"
1,152✔
59
      elseif token == "long_comment" then
79,584✔
60
         mark_line_endings(state, "comment")
104✔
61
      else
62
         if token ~= "eof" then
79,506✔
63
            mark_line_endings(state, "string")
76,908✔
64
            state.code_lines[line] = true
76,908✔
65
            state.code_lines[state.lexer.line] = true
76,908✔
66
         end
67

68
         return
79,506✔
69
      end
70
   end
71
end
72

73
local function token_name(token)
74
   return token == "name" and "identifier" or (token == "eof" and "<eof>" or ("'" .. token .. "'"))
738✔
75
end
76

77
local function parse_error(state, msg, prev_range, token_prefix, message_suffix)
78
   local token_repr
79

80
   if state.token == "eof" then
846✔
81
      token_repr = "<eof>"
288✔
82
   else
83
      token_repr = lexer.get_quoted_substring_or_line(state.lexer, state.line, state.offset, state.end_offset)
744✔
84
   end
85

86
   if token_prefix then
846✔
87
      token_repr = token_prefix .. " " .. token_repr
30✔
88
   end
89

90
   msg = msg .. " near " .. token_repr
846✔
91

92
   if message_suffix then
846✔
93
      msg = msg .. " " .. message_suffix
102✔
94
   end
95

96
   parser.syntax_error(msg, state, prev_range)
846✔
97
end
98

99
local function check_token(state, token)
100
   if state.token ~= token then
29,070✔
101
      parse_error(state, "expected " .. token_name(token))
344✔
102
   end
103
end
104

105
local function check_and_skip_token(state, token)
106
   check_token(state, token)
6,912✔
107
   skip_token(state)
6,768✔
108
end
109

110
local function test_and_skip_token(state, token)
111
   if state.token == token then
21,330✔
112
      skip_token(state)
4,626✔
113
      return true
4,614✔
114
   end
115
end
116

117
local function copy_range(range)
118
   return {
29,136✔
119
      line = range.line,
29,136✔
120
      offset = range.offset,
29,136✔
121
      end_offset = range.end_offset
29,136✔
122
   }
29,136✔
123
end
124

125
local new_state
126
local parse_block
127
local missing_closing_token_error
128

129
-- Attempt to guess a better location for missing `end` and `until` errors (usually they uselessly point to eof).
130
-- Guessed error token should be selected in such a way that inserting previously missing closing token
131
-- in front of it should fix the error or at least move its opening token forward.
132
-- The idea is to track the stack of opening tokens and their indentations.
133
-- For the first statement or closing token with the same or smaller indentation than the opening token
134
-- on the top of the stack:
135
-- * If it has the same indentation but is not the appropriate closing token for the opening one, pick it
136
--   as the guessed error location.
137
-- * If it has a lower indentation level, pick it as the guessed error location even it closes the opening token.
138
-- Example:
139
-- local function f()
140
--    <code>
141
--
142
--    if cond then                   <- `if` is the guessed opening token
143
--       <code>
144
--
145
--    <code not starting with `end`> <- first token on this line is the guessed error location
146
-- end
147
-- Another one:
148
-- local function g()
149
--    <code>
150
--
151
--    if cond then  <- `if` is the guessed opening token
152
--       <code>
153
--
154
-- end              <- `end` is the guessed error location
155

156
local opening_token_to_closing = {
876✔
157
   ["("] = ")",
584✔
158
   ["["] = "]",
584✔
159
   ["{"] = "}",
584✔
160
   ["do"] = "end",
584✔
161
   ["if"] = "end",
584✔
162
   ["else"] = "end",
584✔
163
   ["elseif"] = "end",
584✔
164
   ["while"] = "end",
584✔
165
   ["repeat"] = "until",
584✔
166
   ["for"] = "end",
584✔
167
   ["function"] = "end"
584✔
168
}
169

170
local function get_indentation(state, line)
171
   local ws_start, ws_end = state.lexer.src:find("^[ \t\v\f]*", state.lexer.line_offsets[line])
1,152✔
172
   return ws_end - ws_start
1,152✔
173
end
174

175
local UnpairedTokenGuesser = utils.class()
876✔
176

177
function UnpairedTokenGuesser:__init(state, error_opening_range, error_closing_token)
876✔
178
   self.old_state = state
204✔
179
   self.error_offset = state.offset
204✔
180
   self.error_opening_range = error_opening_range
204✔
181
   self.error_closing_token = error_closing_token
204✔
182
   self.opening_tokens_stack = utils.Stack()
272✔
183
end
184

185
function UnpairedTokenGuesser:guess()
876✔
186
   -- Need to reinitialize lexer (e.g. to skip shebang again).
187
   self.state = new_state(self.old_state.lexer.src)
272✔
188
   self.state.unpaired_token_guesser = self
204✔
189
   skip_token(self.state)
204✔
190
   parse_block(self.state)
204✔
191
   error("No syntax error in second parse", 0)
×
192
end
193

194
function UnpairedTokenGuesser:on_block_start(opening_token_range, opening_token)
876✔
195
   local token_wrapper = copy_range(opening_token_range)
468✔
196
   token_wrapper.token = opening_token
468✔
197
   token_wrapper.closing_token = opening_token_to_closing[opening_token]
468✔
198
   token_wrapper.eligible = token_wrapper.closing_token == self.error_closing_token
468✔
199
   token_wrapper.indentation = get_indentation(self.state, opening_token_range.line)
624✔
200
   self.opening_tokens_stack:push(token_wrapper)
468✔
201
end
202

203
function UnpairedTokenGuesser:set_guessed()
876✔
204
   -- Keep the first detected location.
205
   if self.guessed then
324✔
206
      return
174✔
207
   end
208

209
   self.guessed = self.opening_tokens_stack.top
150✔
210
   self.guessed.error_token = self.state.token
150✔
211
   self.guessed.error_range = copy_range(self.state)
200✔
212
end
213

214
function UnpairedTokenGuesser:check_token()
876✔
215
   local top = self.opening_tokens_stack.top
1,092✔
216

217
   if top and top.eligible and self.state.line > top.line then
1,092✔
218
      local token_indentation = get_indentation(self.state, self.state.line)
684✔
219

220
      if token_indentation < top.indentation then
684✔
221
         self:set_guessed()
176✔
222
      elseif token_indentation == top.indentation then
552✔
223
         local token = self.state.token
264✔
224

225
         if token ~= top.closing_token and
264✔
226
               ((top.token ~= "if" and top.token ~= "elseif") or (token ~= "elseif" and token ~= "else")) then
228✔
227
            self:set_guessed()
192✔
228
         end
229
      end
230
   end
231

232
   if self.state.offset == self.error_offset then
1,092✔
233
      if self.guessed and self.guessed.error_range.offset ~= self.state.offset then
204✔
234
         self.state.line = self.guessed.error_range.line
102✔
235
         self.state.offset = self.guessed.error_range.offset
102✔
236
         self.state.end_offset = self.guessed.error_range.end_offset
102✔
237
         self.state.token = self.guessed.error_token
102✔
238
         missing_closing_token_error(self.state, self.guessed, self.guessed.token, self.guessed.closing_token, true)
102✔
239
      end
240
   end
241
end
242

243
function UnpairedTokenGuesser:on_block_end()
876✔
244
   self:check_token()
420✔
245
   self.opening_tokens_stack:pop()
318✔
246

247
   if not self.opening_tokens_stack.top then
318✔
248
      -- Inserting an end token into a balanced sequence of tokens adds an error earlier than original one.
249
      self.guessed = nil
162✔
250
   end
251
end
252

253
function UnpairedTokenGuesser:on_statement()
876✔
254
   self:check_token()
672✔
255
end
256

257
function missing_closing_token_error(state, opening_range, opening_token, closing_token, is_guess)
730✔
258
   local msg = "expected " .. token_name(closing_token)
408✔
259

260
   if opening_range and opening_range.line ~= state.line then
306✔
261
      msg = msg .. " (to close " .. token_name(opening_token) .. " on line " .. tostring(opening_range.line) .. ")"
232✔
262
   end
263

264
   local token_prefix
265
   local message_suffix
266

267
   if is_guess then
306✔
268
      if state.token == closing_token then
102✔
269
         -- "expected 'end' near 'end'" seems confusing.
270
         token_prefix = "less indented"
30✔
271
      end
272

273
      message_suffix = "(indentation-based guess)"
102✔
274
   end
275

276
   parse_error(state, msg, opening_range, token_prefix, message_suffix)
306✔
277
end
278

279
local function check_closing_token(state, opening_range, opening_token)
280
   local closing_token = opening_token_to_closing[opening_token] or "eof"
15,510✔
281

282
   if state.token == closing_token then
15,510✔
283
      return
14,454✔
284
   end
285

286
   if (opening_token == "if" or opening_token == "elseif") and (state.token == "else" or state.token == "elseif") then
1,056✔
287
      return
648✔
288
   end
289

290
   if closing_token == "end" or closing_token == "until" then
408✔
291
      if not state.unpaired_token_guesser then
306✔
292
         UnpairedTokenGuesser(state, opening_range, closing_token):guess()
272✔
293
      end
294
   end
295

296
   missing_closing_token_error(state, opening_range, opening_token, closing_token)
204✔
297
end
298

299
local function check_and_skip_closing_token(state, opening_range, opening_token)
300
   check_closing_token(state, opening_range, opening_token)
8,628✔
301
   skip_token(state)
8,568✔
302
end
303

304
local function check_name(state)
305
   check_token(state, "name")
22,158✔
306
   return state.token_value
22,044✔
307
end
308

309
local function new_outer_node(range, tag, node)
310
   node = node or {}
29,316✔
311
   node.line = range.line
29,316✔
312
   node.offset = range.offset
29,316✔
313
   node.end_offset = range.end_offset
29,316✔
314
   node.tag = tag
29,316✔
315
   return node
29,316✔
316
end
317

318
local function new_inner_node(start_range, end_range, tag, node)
319
   node = node or {}
23,508✔
320
   node.line = start_range.line
23,508✔
321
   node.offset = start_range.offset
23,508✔
322
   node.end_offset = end_range.end_offset
23,508✔
323
   node.tag = tag
23,508✔
324
   return node
23,508✔
325
end
326

327
local parse_expression
328

329
local function parse_expression_list(state, list)
330
   list = list or {}
8,466✔
331

332
   repeat
333
      list[#list + 1] = parse_expression(state)
12,676✔
334
   until not test_and_skip_token(state, ",")
12,544✔
335

336
   return list
8,334✔
337
end
338

339
local function parse_id(state, tag)
340
   local ast_node = new_outer_node(state, tag or "Id")
21,924✔
341
   ast_node[1] = check_name(state)
29,200✔
342
   -- Skip name.
343
   skip_token(state)
21,828✔
344
   return ast_node
21,828✔
345
end
346

347
local function atom(tag)
348
   return function(state)
349
      local ast_node = new_outer_node(state, tag)
6,372✔
350
      ast_node[1] = state.token_value
6,372✔
351
      skip_token(state)
6,372✔
352
      return ast_node
6,372✔
353
   end
354
end
355

356
local simple_expressions = {}
876✔
357

358
simple_expressions.number = atom("Number")
1,168✔
359
simple_expressions.string = atom("String")
1,168✔
360
simple_expressions["nil"] = atom("Nil")
1,168✔
361
simple_expressions["true"] = atom("True")
1,168✔
362
simple_expressions["false"] = atom("False")
1,168✔
363
simple_expressions["..."] = atom("Dots")
1,168✔
364

365
simple_expressions["{"] = function(state)
366
   local start_range = copy_range(state)
1,002✔
367
   local ast_node = {}
1,002✔
368
   skip_token(state)
1,002✔
369

370
   repeat
371
      if state.token == "}" then
1,584✔
372
         break
357✔
373
      end
374

375
      local key_node, value_node
376
      local first_token_range = copy_range(state)
870✔
377

378
      if state.token == "name" then
870✔
379
         local name = state.token_value
750✔
380
         skip_token(state)  -- Skip name.
750✔
381

382
         if test_and_skip_token(state, "=") then
1,000✔
383
            -- `name` = `expr`.
384
            key_node = new_outer_node(first_token_range, "String", {name})
600✔
385
            value_node = parse_expression(state)
598✔
386
         else
387
            -- `name` is beginning of an expression in array part.
388
            -- Backtrack lexer to before name.
389
            state.lexer.line = first_token_range.line
300✔
390
            state.lexer.offset = first_token_range.offset
300✔
391
            skip_token(state)  -- Load name again.
300✔
392
            value_node = parse_expression(state)
400✔
393
         end
394
      elseif state.token == "[" then
120✔
395
         -- [ `expr` ] = `expr`.
396
         skip_token(state)
48✔
397
         key_node = parse_expression(state)
64✔
398
         check_and_skip_closing_token(state, first_token_range, "[")
48✔
399
         check_and_skip_token(state, "=")
36✔
400
         value_node = parse_expression(state)
48✔
401
      else
402
         -- Expression in array part.
403
         value_node = parse_expression(state)
90✔
404
      end
405

406
      if key_node then
834✔
407
         -- Pair.
408
         ast_node[#ast_node + 1] = new_inner_node(first_token_range, value_node, "Pair", {key_node, value_node})
640✔
409
      else
410
         -- Array part item.
411
         ast_node[#ast_node + 1] = value_node
354✔
412
      end
413
   until not (test_and_skip_token(state, ",") or test_and_skip_token(state, ";"))
1,204✔
414

415
   new_inner_node(start_range, state, "Table", ast_node)
966✔
416
   check_and_skip_closing_token(state, start_range, "{")
966✔
417
   return ast_node
954✔
418
end
419

420
-- Parses argument list and the statements.
421
local function parse_function(state, function_range)
422
   local paren_range = copy_range(state)
1,830✔
423
   check_and_skip_token(state, "(")
1,830✔
424
   local args = {}
1,800✔
425

426
   -- Are there arguments?
427
   if state.token ~= ")" then
1,800✔
428
      repeat
429
         if state.token == "name" then
1,044✔
430
            args[#args + 1] = parse_id(state)
1,032✔
431
         elseif state.token == "..." then
270✔
432
            args[#args + 1] = simple_expressions["..."](state)
336✔
433
            break
168✔
434
         else
435
            parse_error(state, "expected argument")
18✔
436
         end
437
      until not test_and_skip_token(state, ",")
1,032✔
438
   end
439

440
   check_and_skip_closing_token(state, paren_range, "(")
1,782✔
441
   local body = parse_block(state, function_range, "function")
1,764✔
442
   local end_range = copy_range(state)
1,674✔
443
   -- Skip "function".
444
   skip_token(state)
1,674✔
445
   return new_inner_node(function_range, end_range, "Function", {args, body, end_range = end_range})
1,674✔
446
end
447

448
simple_expressions["function"] = function(state)
449
   local function_range = copy_range(state)
396✔
450
   -- Skip "function".
451
   skip_token(state)
396✔
452
   return parse_function(state, function_range)
396✔
453
end
454

455
-- A call handler parses arguments of a call with given base node that determines resulting node start location,
456
-- given tag, and array to which the arguments should be appended.
457
local call_handlers = {}
876✔
458

459
call_handlers["("] = function(state, base_node, tag, node)
460
   local paren_range = copy_range(state)
4,320✔
461
   -- Skip "(".
462
   skip_token(state)
4,320✔
463

464
   if state.token ~= ")" then
4,320✔
465
      parse_expression_list(state, node)
2,820✔
466
   end
467

468
   new_inner_node(base_node, state, tag, node)
4,314✔
469
   check_and_skip_closing_token(state, paren_range, "(")
4,314✔
470
   return node
4,302✔
471
end
472

473
call_handlers["{"] = function(state, base_node, tag, node)
474
   local arg_node = simple_expressions[state.token](state)
336✔
475
   node[#node + 1] = arg_node
336✔
476
   return new_inner_node(base_node, arg_node, tag, node)
336✔
477
end
478

479
call_handlers.string = call_handlers["{"]
876✔
480

481
local suffix_handlers = {}
876✔
482

483
suffix_handlers["."] = function(state, base_node)
484
   -- Skip ".".
485
   skip_token(state)
1,908✔
486
   local index_node = parse_id(state, "String")
1,908✔
487
   return new_inner_node(base_node, index_node, "Index", {base_node, index_node})
1,908✔
488
end
489

490
suffix_handlers["["] = function(state, base_node)
491
   local bracket_range = copy_range(state)
1,002✔
492
   -- Skip "[".
493
   skip_token(state)
1,002✔
494
   local index_node = parse_expression(state)
1,002✔
495
   local ast_node = new_inner_node(base_node, state, "Index", {base_node, index_node})
1,002✔
496
   check_and_skip_closing_token(state, bracket_range, "[")
1,002✔
497
   return ast_node
1,002✔
498
end
499

500
suffix_handlers[":"] = function(state, base_node)
501
   -- Skip ":".
502
   skip_token(state)
570✔
503
   local method_name = parse_id(state, "String")
570✔
504
   local call_handler = call_handlers[state.token]
564✔
505

506
   if not call_handler then
564✔
507
      parse_error(state, "expected method arguments")
6✔
508
   end
509

510
   return call_handler(state, base_node, "Invoke", {base_node, method_name})
558✔
511
end
512

513
suffix_handlers["("] = function(state, base_node)
514
   return call_handlers[state.token](state, base_node, "Call", {base_node})
4,098✔
515
end
516

517
suffix_handlers["{"] = suffix_handlers["("]
876✔
518
suffix_handlers.string = suffix_handlers["("]
876✔
519

520
local function parse_simple_expression(state, kind, no_literals)
521
   local expression
522

523
   if state.token == "(" then
21,648✔
524
      local paren_range = copy_range(state)
534✔
525
      skip_token(state)
534✔
526
      local inner_expression = parse_expression(state)
534✔
527
      expression = new_inner_node(paren_range, state, "Paren", {inner_expression})
688✔
528
      check_and_skip_closing_token(state, paren_range, "(")
686✔
529
   elseif state.token == "name" then
21,114✔
530
      expression = parse_id(state)
18,256✔
531
   else
532
      local literal_handler = simple_expressions[state.token]
7,422✔
533

534
      if not literal_handler or no_literals then
7,422✔
535
         parse_error(state, "expected " .. (kind or "expression"))
240✔
536
      end
537

538
      return literal_handler(state)
7,182✔
539
   end
540

541
   while true do
542
      local suffix_handler = suffix_handlers[state.token]
21,750✔
543

544
      if suffix_handler then
21,750✔
545
         expression = suffix_handler(state, expression)
10,094✔
546
      else
547
         return expression
14,172✔
548
      end
549
   end
550
end
551

552
local unary_operators = {
876✔
553
   ["not"] = "not",
584✔
554
   ["-"] = "unm",
584✔
555
   ["~"] = "bnot",
584✔
556
   ["#"] = "len"
584✔
557
}
558

559
local unary_priority = 12
876✔
560

561
local binary_operators = {
876✔
562
   ["+"] = "add", ["-"] = "sub",
584✔
563
   ["*"] = "mul", ["%"] = "mod",
584✔
564
   ["^"] = "pow",
584✔
565
   ["/"] = "div", ["//"] = "idiv",
584✔
566
   ["&"] = "band", ["|"] = "bor", ["~"] = "bxor",
584✔
567
   ["<<"] = "shl", [">>"] = "shr",
584✔
568
   [".."] = "concat",
584✔
569
   ["~="] = "ne", ["=="] = "eq",
584✔
570
   ["<"] = "lt", ["<="] = "le",
584✔
571
   [">"] = "gt", [">="] = "ge",
584✔
572
   ["and"] = "and", ["or"] = "or"
584✔
573
}
574

575
local compound_operators = {
876✔
576
   ["+"] = "add", ["-"] = "sub",
584✔
577
   ["*"] = "mul", ["%"] = "mod",
584✔
578
   ["^"] = "pow",
584✔
579
   ["/"] = "div", ["//"] = "idiv",
584✔
580
   ["&"] = "band", ["|"] = "bor", ["~"] = "bxor",
584✔
581
   ["<<"] = "shl", [">>"] = "shr",
584✔
582
   [".."] = "concat"
584✔
583
}
584

585
local left_priorities = {
876✔
586
   add = 10, sub = 10,
584✔
587
   mul = 11, mod = 11,
584✔
588
   pow = 14,
584✔
589
   div = 11, idiv = 11,
584✔
590
   band = 6, bor = 4, bxor = 5,
584✔
591
   shl = 7, shr = 7,
584✔
592
   concat = 9,
584✔
593
   ne = 3, eq = 3,
584✔
594
   lt = 3, le = 3,
584✔
595
   gt = 3, ge = 3,
584✔
596
   ["and"] = 2, ["or"] = 1
584✔
597
}
598

599
local right_priorities = {
876✔
600
   add = 10, sub = 10,
584✔
601
   mul = 11, mod = 11,
584✔
602
   pow = 13,
584✔
603
   div = 11, idiv = 11,
584✔
604
   band = 6, bor = 4, bxor = 5,
584✔
605
   shl = 7, shr = 7,
584✔
606
   concat = 8,
584✔
607
   ne = 3, eq = 3,
584✔
608
   lt = 3, le = 3,
584✔
609
   gt = 3, ge = 3,
584✔
610
   ["and"] = 2, ["or"] = 1
584✔
611
}
612

613
local function parse_subexpression(state, limit, kind)
614
   local expression
615
   local unary_operator = unary_operators[state.token]
16,896✔
616

617
   if unary_operator then
16,896✔
618
      local operator_range = copy_range(state)
408✔
619
      -- Skip operator.
620
      skip_token(state)
408✔
621
      local operand = parse_subexpression(state, unary_priority)
408✔
622
      expression = new_inner_node(operator_range, operand, "Op", {unary_operator, operand})
544✔
623
   else
624
      expression = parse_simple_expression(state, kind)
21,912✔
625
   end
626

627
   -- Expand while operators have priorities higher than `limit`.
628
   while true do
629
      local binary_operator = binary_operators[state.token]
18,864✔
630

631
      if not binary_operator or left_priorities[binary_operator] <= limit then
18,864✔
632
         break
201✔
633
      end
634

635
       -- Skip operator.
636
      skip_token(state)
2,184✔
637
      -- Read subexpression with higher priority.
638
      local subexpression = parse_subexpression(state, right_priorities[binary_operator])
2,184✔
639
      expression = new_inner_node(expression, subexpression, "Op", {binary_operator, expression, subexpression})
2,912✔
640
   end
641

642
   return expression
16,680✔
643
end
644

645
function parse_expression(state, kind)
730✔
646
   return parse_subexpression(state, 0, kind)
14,304✔
647
end
648

649
local statements = {}
876✔
650

651
statements["if"] = function(state)
652
   local start_range = copy_range(state)
1,140✔
653
   -- Skip "if".
654
   skip_token(state)
1,140✔
655
   local ast_node = {}
1,140✔
656

657
   -- The loop is entered after skipping "if" or "elseif".
658
   -- Block start token info is set to the last skipped "if", "elseif", or "else" token.
659
   local block_start_token = "if"
1,140✔
660
   local block_start_range = start_range
1,140✔
661

662
   while true do
663
      ast_node[#ast_node + 1] = parse_expression(state, "condition")
1,840✔
664
      -- Add range of the "then" token to the block statement array.
665
      local branch_range = copy_range(state)
1,362✔
666
      check_and_skip_token(state, "then")
1,362✔
667
      ast_node[#ast_node + 1] = parse_block(state, block_start_range, block_start_token, branch_range)
1,774✔
668

669
      if state.token == "else" then
1,290✔
670
         branch_range = copy_range(state)
536✔
671
         block_start_token = "else"
402✔
672
         block_start_range = branch_range
402✔
673
         skip_token(state)
402✔
674
         ast_node[#ast_node + 1] = parse_block(state, block_start_range, block_start_token, branch_range)
520✔
675
         break
236✔
676
      elseif state.token == "elseif" then
888✔
677
         block_start_token = "elseif"
246✔
678
         block_start_range = copy_range(state)
328✔
679
         skip_token(state)
328✔
680
      else
681
         break
682
      end
683
   end
684

685
   new_inner_node(start_range, state, "If", ast_node)
996✔
686
   -- Skip "end".
687
   skip_token(state)
996✔
688
   return ast_node
996✔
689
end
690

691
statements["while"] = function(state)
692
   local start_range = copy_range(state)
312✔
693
   -- Skip "while".
694
   skip_token(state)
312✔
695
   local condition = parse_expression(state, "condition")
312✔
696
   check_and_skip_token(state, "do")
300✔
697
   local block = parse_block(state, start_range, "while")
288✔
698
   local ast_node = new_inner_node(start_range, state, "While", {condition, block})
240✔
699
   -- Skip "end".
700
   skip_token(state)
240✔
701
   return ast_node
240✔
702
end
703

704
statements["do"] = function(state)
705
   local start_range = copy_range(state)
522✔
706
   -- Skip "do".
707
   skip_token(state)
522✔
708
   local block = parse_block(state, start_range, "do")
522✔
709
   local ast_node = new_inner_node(start_range, state, "Do", block)
342✔
710
   -- Skip "end".
711
   skip_token(state)
342✔
712
   return ast_node
342✔
713
end
714

715
statements["for"] = function(state)
716
   local start_range = copy_range(state)
546✔
717
   -- Skip "for".
718
   skip_token(state)
546✔
719

720
   local ast_node = {}
546✔
721
   local tag
722
   local first_var = parse_id(state)
546✔
723

724
   if state.token == "=" then
522✔
725
      -- Numeric "for" loop.
726
      tag = "Fornum"
234✔
727
      -- Skip "=".
728
      skip_token(state)
234✔
729
      ast_node[1] = first_var
234✔
730
      ast_node[2] = parse_expression(state)
312✔
731
      check_and_skip_token(state, ",")
234✔
732
      ast_node[3] = parse_expression(state)
304✔
733

734
      if test_and_skip_token(state, ",") then
304✔
735
         ast_node[4] = parse_expression(state)
56✔
736
      end
737

738
      check_and_skip_token(state, "do")
228✔
739
      ast_node[#ast_node + 1] = parse_block(state, start_range, "for")
288✔
740
   elseif state.token == "," or state.token == "in" then
288✔
741
      -- Generic "for" loop.
742
      tag = "Forin"
276✔
743

744
      local iter_vars = {first_var}
276✔
745
      while test_and_skip_token(state, ",") do
680✔
746
         iter_vars[#iter_vars + 1] = parse_id(state)
312✔
747
      end
748

749
      ast_node[1] = iter_vars
276✔
750
      check_and_skip_token(state, "in")
276✔
751
      ast_node[2] = parse_expression_list(state)
366✔
752
      check_and_skip_token(state, "do")
270✔
753
      ast_node[3] = parse_block(state, start_range, "for")
356✔
754
   else
755
      parse_error(state, "expected '=', ',' or 'in'")
12✔
756
   end
757

758
   new_inner_node(start_range, state, tag, ast_node)
456✔
759
   -- Skip "end".
760
   skip_token(state)
456✔
761
   return ast_node
456✔
762
end
763

764
statements["repeat"] = function(state)
765
   local start_range = copy_range(state)
180✔
766
   -- Skip "repeat".
767
   skip_token(state)
180✔
768
   local block = parse_block(state, start_range, "repeat")
180✔
769
   -- Skip "until".
770
   skip_token(state)
120✔
771
   local condition = parse_expression(state, "condition")
120✔
772
   return new_inner_node(start_range, condition, "Repeat", {block, condition})
114✔
773
end
774

775
statements["function"] = function(state)
776
   local start_range = copy_range(state)
768✔
777
   -- Skip "function".
778
   skip_token(state)
768✔
779
   local lhs = parse_id(state)
768✔
780
   local implicit_self_range
781

782
   while (not implicit_self_range) and (state.token == "." or state.token == ":") do
1,158✔
783
      implicit_self_range = (state.token == ":") and copy_range(state)
512✔
784
      -- Skip "." or ":".
785
      skip_token(state)
426✔
786
      local index_node = parse_id(state, "String")
426✔
787
      lhs = new_inner_node(lhs, index_node, "Index", {lhs, index_node})
560✔
788
   end
789

790
   local function_node = parse_function(state, start_range)
732✔
791

792
   if implicit_self_range then
636✔
793
      -- Insert implicit "self" argument.
794
      local self_arg = new_outer_node(implicit_self_range, "Id", {"self", implicit = true})
246✔
795
      table.insert(function_node[1], 1, self_arg)
246✔
796
   end
797

798
   return new_inner_node(start_range, function_node, "Set", {{lhs}, {function_node}})
636✔
799
end
800

801
statements["local"] = function(state)
802
   local start_range = copy_range(state)
2,676✔
803
   -- Skip "local".
804
   skip_token(state)
2,676✔
805

806
   if state.token == "function" then
2,676✔
807
      -- Local function.
808
      local function_range = copy_range(state)
708✔
809
      -- Skip "function".
810
      skip_token(state)
708✔
811
      local var = parse_id(state)
708✔
812
      local function_node = parse_function(state, function_range)
702✔
813
      return new_inner_node(start_range, function_node, "Localrec", {{var}, {function_node}})
648✔
814
   end
815

816
   -- Local definition, potentially with assignment.
817
   local lhs = {}
1,968✔
818
   local rhs
819

820
   repeat
821
      lhs[#lhs + 1] = parse_id(state)
3,056✔
822

823
      -- Check if a Lua 5.4 attribute is present
824
      if state.token == "<" then
2,274✔
825
         -- For now, just consume and ignore it.
826
         skip_token(state)
42✔
827
         check_name(state)
42✔
828
         skip_token(state)
42✔
829
         check_and_skip_token(state, ">")
42✔
830
      end
831
   until not test_and_skip_token(state, ",")
3,024✔
832

833
   if test_and_skip_token(state, "=") then
2,580✔
834
      rhs = parse_expression_list(state)
1,892✔
835
   end
836

837
   return new_inner_node(start_range, rhs and rhs[#rhs] or lhs[#lhs], "Local", {lhs, rhs})
1,914✔
838
end
839

840
statements["::"] = function(state)
841
   local start_range = copy_range(state)
126✔
842
   -- Skip "::".
843
   skip_token(state)
126✔
844
   local name = check_name(state)
126✔
845
   -- Skip label name.
846
   skip_token(state)
114✔
847
   local ast_node = new_inner_node(start_range, state, "Label", {name})
114✔
848
   check_and_skip_token(state, "::")
114✔
849
   return ast_node
114✔
850
end
851

852
local closing_tokens = utils.array_to_set({"end", "eof", "else", "elseif", "until"})
876✔
853

854
statements["return"] = function(state)
855
   local start_range = copy_range(state)
1,962✔
856
   -- Skip "return".
857
   skip_token(state)
1,962✔
858

859
   if closing_tokens[state.token] or state.token == ";" then
1,962✔
860
      -- No return values.
861
      return new_outer_node(start_range, "Return")
168✔
862
   else
863
      local returns = parse_expression_list(state)
1,794✔
864
      return new_inner_node(start_range, returns[#returns], "Return", returns)
1,716✔
865
   end
866
end
867

868
statements["break"] = function(state)
869
   local ast_node = new_outer_node(state, "Break")
96✔
870
   -- Skip "break".
871
   skip_token(state)
96✔
872
   return ast_node
96✔
873
end
874

875
statements["goto"] = function(state)
876
   local start_range = copy_range(state)
66✔
877
   -- Skip "goto".
878
   skip_token(state)
66✔
879
   local name = check_name(state)
66✔
880
   local ast_node = new_outer_node(start_range, "Goto", {name})
60✔
881
   -- Skip label name.
882
   skip_token(state)
60✔
883
   return ast_node
60✔
884
end
885

886
local function parse_expression_statement(state)
887
   local lhs
888
   local start_range = copy_range(state)
4,920✔
889

890
   -- Handle lhs of an assignment or a single expression.
891
   repeat
892
      local item_start_range = lhs and copy_range(state) or start_range
5,240✔
893
      local expected = lhs and "identifier or field" or "statement"
5,160✔
894
      local primary_expression = parse_simple_expression(state, expected, true)
5,160✔
895

896
      if primary_expression.tag == "Paren" then
5,028✔
897
         -- (expr) in lhs is invalid.
898
         parser.syntax_error("expected " .. expected .. " near '('", item_start_range)
12✔
899
      end
900

901
      if primary_expression.tag == "Call" or primary_expression.tag == "Invoke" then
5,016✔
902
         if lhs then
2,556✔
903
            -- The is an assignment, and a call is not valid in lhs.
904
            parse_error(state, "expected call or indexing")
6✔
905
         else
906
            -- This is a call.
907
            return primary_expression
2,550✔
908
         end
909
      end
910

911
      -- This is an assignment.
912
      lhs = lhs or {}
2,460✔
913
      lhs[#lhs + 1] = primary_expression
2,460✔
914
   until not test_and_skip_token(state, ",")
3,280✔
915

916
   local compound_operator = compound_operators[state.token]
2,220✔
917
   if compound_operator then
2,220✔
918
      -- This is an assignment in the form `lhs op= rhs`.
919

920
      if #lhs ~= 1 then
72✔
921
         -- Multiple lhs values are not valid
922
         parse_error(state, "compound assignment not allowed on tuples near " .. compound_operator .. "=")
×
923
      end
924

925
      -- Skip operator.
926
      skip_token(state)
72✔
927
      check_and_skip_token(state, "=")
72✔
928

929
      local rhs = parse_expression_list(state)
72✔
930
      if #rhs ~= 1 then
72✔
931
         parse_error(state, "compound assignment not allowed on tuples near " .. compound_operator .. "=")
×
932
      end
933

934
      return new_inner_node(start_range, rhs[1], "OpSet", {lhs, rhs, compound_operator})
72✔
935
   else
936
      -- This is an assignment in the form `lhs = rhs`.
937
      check_and_skip_token(state, "=")
2,148✔
938
      local rhs = parse_expression_list(state)
2,082✔
939
      return new_inner_node(start_range, rhs[#rhs], "Set", {lhs, rhs})
2,052✔
940
   end
941
end
942

943
local function parse_statement(state)
944
   return (statements[state.token] or parse_expression_statement)(state)
13,314✔
945
end
946

947
function parse_block(state, opening_token_range, opening_token, block)
730✔
948
   local unpaired_token_guesser = state.unpaired_token_guesser
8,124✔
949

950
   if unpaired_token_guesser and opening_token then
8,124✔
951
      unpaired_token_guesser:on_block_start(opening_token_range, opening_token)
468✔
952
   end
953

954
   block = block or {}
8,124✔
955
   local after_statement = false
8,124✔
956

957
   while not closing_tokens[state.token] do
18,648✔
958
      local first_token = state.token
13,548✔
959

960
      if first_token == ";" then
13,548✔
961
         if not after_statement then
234✔
962
            table.insert(state.hanging_semicolons, copy_range(state))
64✔
963
         end
964

965
         -- Skip ";".
966
         skip_token(state)
234✔
967
         -- Further semicolons are considered hanging.
968
         after_statement = false
234✔
969
      else
970
         if unpaired_token_guesser then
13,314✔
971
            unpaired_token_guesser:on_statement()
672✔
972
         end
973

974
         local statement = parse_statement(state)
13,314✔
975
         after_statement = true
12,174✔
976
         block[#block + 1] = statement
12,174✔
977

978
         if statement.tag == "Return" then
12,174✔
979
            -- "return" must be the last statement.
980
            -- However, one ";" after it is allowed.
981
            test_and_skip_token(state, ";")
1,884✔
982
            break
1,256✔
983
         end
984
      end
985
   end
986

987
   if unpaired_token_guesser and opening_token then
6,984✔
988
      unpaired_token_guesser:on_block_end()
420✔
989
   end
990

991
   check_closing_token(state, opening_token_range, opening_token)
6,882✔
992

993
   return block
6,534✔
994
end
995

996
function new_state(src, line_offsets, line_lengths)
730✔
997
   return {
3,132✔
998
      lexer = lexer.new_state(src, line_offsets, line_lengths),
4,176✔
999
      -- Set of line numbers containing code.
1000
      code_lines = {},
3,132✔
1001
      -- Maps line numbers to "comment", "string", or nil based on whether the line ending is within a token
1002
      line_endings = {},
3,132✔
1003
      -- Array of {contents = string} with range info.
1004
      comments = {},
3,132✔
1005
       -- Array of ranges of semicolons not following a statement.
1006
      hanging_semicolons = {}
3,132✔
1007
   }
3,132✔
1008
end
1009

1010
-- Parses source characters.
1011
-- Returns AST (in almost MetaLua format), array of comments - tables {contents = string} with range info,
1012
-- set of line numbers containing code, map of types of tokens wrapping line endings (nil, "string", or "comment"),
1013
-- array of ranges of hanging semicolons (not after statements), array of line start offsets, array of line lengths.
1014
-- The last two tables can be passed as arguments to be filled.
1015
-- On error throws an instance of parser.SyntaxError: table {msg = msg, prev_range = prev_range?} with range info,
1016
-- prev_range may refer to some extra relevant location.
1017
function parser.parse(src, line_offsets, line_lengths)
876✔
1018
   local state = new_state(src, line_offsets, line_lengths)
2,928✔
1019
   skip_token(state)
2,928✔
1020
   local ast = parse_block(state)
2,928✔
1021
   return ast, state.comments, state.code_lines, state.line_endings, state.hanging_semicolons,
2,058✔
1022
      state.lexer.line_offsets, state.lexer.line_lengths
2,058✔
1023
end
1024

1025
return parser
876✔
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc