-
Notifications
You must be signed in to change notification settings - Fork 352
Expand file tree
/
Copy pathparser.lua
More file actions
1152 lines (953 loc) · 45.9 KB
/
Copy pathparser.lua
File metadata and controls
1152 lines (953 loc) · 45.9 KB
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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
--[[
Expression 2 Parser for Garry's Mod
Rewritten by Vurv
Notable changes:
* Now uses Nodes and NodeVariant rather than strings (Much faster and better for intellisense)
* Removed excessive use of functions / recursion as an optimization
* This no longer does any analysis based on the environment like whether a type is valid or not since a Parser shouldn't be doing that.
* Removed PEG-style grammar.
* Condensed from 1.7k LOC -> 1k LOC
]]
AddCSLuaFile()
local Trace, Warning, Error = E2Lib.Debug.Trace, E2Lib.Debug.Warning, E2Lib.Debug.Error
local Tokenizer = E2Lib.Tokenizer
local Token, TokenVariant = Tokenizer.Token, Tokenizer.Variant
local Keyword, Grammar, Operator = E2Lib.Keyword, E2Lib.Grammar, E2Lib.Operator
---@class Parser
---@field tokens Token[]
---@field ntokens integer
---@field index integer
---@field warnings Warning[]
---@field traces Trace[] # Stack of traces to push and pop
---@field delta_vars table<string, boolean>
---@field include_files string[]
local Parser = {}
Parser.__index = Parser
---@param tokens table?
function Parser.new(tokens)
return setmetatable({ tokens = tokens or {}, ntokens = tokens and #tokens or 0, index = 1, warnings = {}, traces = {}, cache = {} }, Parser)
end
E2Lib.Parser = Parser
---@class Node<T>: { data: T, variant: NodeVariant, trace: Trace }
---@field variant NodeVariant
---@field trace Trace
---@field data any
local Node = {}
Node.__index = Node
Parser.Node = Node
---@param variant NodeVariant
---@param data any
---@param trace Trace
---@return Node
function Node.new(variant, data, trace)
return setmetatable({ variant = variant, trace = trace, data = data }, Node)
end
---@enum NodeVariant
local NodeVariant = {
Block = 1,
--- Statements
If = 2, -- `if (1) {} elseif (1) {} else {}`
While = 3, -- `while (1) {}`, `do {} while(1)`
For = 4, -- `for (I = 1, 2, 3) {}`
Foreach = 5, -- `foreach(K, V = T) {}`
Break = 6, -- break
Continue = 7, -- `continue`
Return = 8, -- `return`
Increment = 9, -- `++`
Decrement = 10, -- `--`
CompoundAssignment = 11, -- `+=`, `-=`, `*=`, `/=`
Assignment = 12, -- `X = Y[2, number] = Z[2] = 5` or `local X = 5`
Const = 13, -- const X = 5
Switch = 14, -- `switch (<EXPR>) { case <EXPR>, <STMT>* default, <STMT*> }
Function = 15, -- `function test() {}`
Include = 16, -- #include "file"
Try = 17, -- try {} catch (Err) {}
--- Compile time constructs
Event = 18, -- event tick() {}
--- Expressions
ExprTernary = 19, -- `X ? Y : Z`
ExprDefault = 20, -- `X ?: Y`
ExprLogicalOp = 21, -- `|` `&` (Yes they are flipped.)
ExprBinaryOp = 22, -- `||` `&&` `^^`
ExprComparison = 23, -- `>` `<` `>=` `<=`
ExprEquals = 24, -- `==` `!=`
ExprBitShift = 25, -- `>>` `<<`
ExprArithmetic = 26, -- `+` `-` `*` `/` `^` `%`
ExprUnaryOp = 27, -- `-` `+` `!`
ExprMethodCall = 28, -- `<EXPR>:call()`
ExprIndex = 29, -- `<EXPR>[<EXPR>, <type>?]`
ExprGrouped = 30, -- (<EXPR>)
ExprCall = 31, -- `call()`
ExprDynCall = 32, -- `Var()`
ExprUnaryWire = 33, -- `~Var` `$Var` `->Var`
ExprArray = 34, -- `array(1, 2, 3)` or `array(1 = 2, 2 = 3)`
ExprTable = 35, -- `table(1, 2, 3)` or `table(1 = 2, "test" = 3)`
ExprFunction = 36, -- `function() {}`
ExprLiteral = 37, -- `"test"` `5e2` `4.023` `4j`
ExprIdent = 38, -- `Variable`
ExprConstant = 39, -- `_FOO`
}
Parser.Variant = NodeVariant
local NodeVariantLookup = {}
for var, i in pairs(NodeVariant) do
NodeVariantLookup[i] = var
end
function Node:debug()
return string.format("Node { variant = %s, data = %s, trace = %s }", NodeVariantLookup[self.variant], self.data, self.trace)
end
--- Returns whether the node is an expression variant.
function Node:isExpr()
return self.variant >= NodeVariant.ExprTernary
end
---@return string
function Node:instr()
return NodeVariantLookup[self.variant]
end
Node.__tostring = Node.debug
---@return boolean ok, Node|Error ast, table<string, boolean> dvars, string[] include_files, Parser self
function Parser.Execute(tokens)
local instance = Parser.new(tokens)
local ok, ast, dvars, include_files = xpcall(Parser.Process, E2Lib.errorHandler, instance, tokens)
return ok, ast, dvars, include_files, instance
end
function Parser:Eof() return self.index > self.ntokens end
function Parser:Peek() return self.tokens[self.index + 1] end
function Parser:At() return self.tokens[self.index] end
function Parser:Prev() return self.tokens[self.index - 1] end
function Parser:Consume(variant --[[@param variant TokenVariant]])
local token = self.tokens[self.index] --[[self:At() inline]]
if not token or token.variant ~= variant then return end
self.index = self.index + 1
return token
end
function Parser:ConsumeValue(variant --[[@param variant TokenVariant]], value --[[@param value any]])
local token = self.tokens[self.index]
if token == nil or token.variant ~= variant or token.value ~= value then return end
self.index = self.index + 1
return token
end
function Parser:ConsumeTailing(variant --[[@param variant TokenVariant]], value --[[@param value any]])
local token = self.tokens[self.index]
if token == nil or token.variant ~= variant or token.whitespaced then return end
if value ~= nil and token.value ~= value then return end
self.index = self.index + 1
return token
end
--- SAFETY: This works fine only assuming ConsumeLeading *always* passes a value which is true atm.
function Parser:ConsumeLeading(variant --[[@param variant TokenVariant]], value --[[@param value any]])
local token = self.tokens[self.index + 1] --[[self:Peek() inline]]
if token == nil or token.whitespaced then return end
local at = self.tokens[self.index]
if at.variant ~= variant or at.value ~= value then return end
self.index = self.index + 1
return at
end
---@param message string
---@param trace Trace?
---@param quick_fix { replace: string, at: Trace }[]?
function Parser:Error(message, trace, quick_fix)
error( Error.new( message, trace or self:Prev().trace, nil, quick_fix ), 2 )
end
---@param message string
---@param trace Trace?
---@param quick_fix { replace: string, at: Trace }[]?
function Parser:Warning(message, trace, quick_fix)
self.warnings[#self.warnings + 1] = Warning.new( message, trace or self:Prev().trace, quick_fix )
end
---@generic T
---@param v? T
---@param message string
---@param trace Trace?
---@return T
function Parser:Assert(v, message, trace)
if not v then error( Error.new( message, trace or self:Prev().trace ), 2 ) end
return v
end
---@return Node ast, table<string, boolean> dvars, string[] include_files
function Parser:Process(tokens)
self.index, self.tokens, self.ntokens, self.warnings, self.delta_vars, self.include_files, self.cache = 1, tokens, #tokens, {}, {}, {}, {}
local stmts = {}
if self:Eof() then return Node.new(NodeVariant.Block, stmts, Trace.new(0, 0, 0, 0)), self.delta_vars, self.include_files end
while true do
if self:ConsumeValue(TokenVariant.Grammar, Grammar.Comma) then
self:Error("Statement separator (,) must not appear multiple times")
end
local stmt = self:Stmt() or self:Expr()
stmts[#stmts + 1] = stmt
if self:Eof() then break end
if not self:ConsumeValue(TokenVariant.Grammar, Grammar.Comma) then
self:Assert(self:At().whitespaced, "Statements must be separated by comma (,) or whitespace", stmt.trace)
end
end
local trace = (#stmts ~= 0) and stmts[1].trace:stitch(stmts[#stmts].trace) or Trace.new(1, 1, 1, 1)
return Node.new(NodeVariant.Block, stmts, trace), self.delta_vars, self.include_files
end
--- Caches previously processed expressions to avoid insane recursion.
---@param i integer # The token index the node should be attached to
---@param n Node # The node tree to attach the token to
---@return Node # The same node that was passed to this function
function Parser:Cache(i, n)
self.cache[i] = { self.index, n }
return n
end
---@return Node
function Parser:Condition()
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.LParen), "Left parenthesis (() expected before condition")
local expr = self:Expr()
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.RParen), "Right parenthesis ()) missing, to close condition")
return expr
end
---@return Node?
function Parser:Stmt()
if self:ConsumeValue(TokenVariant.Keyword, Keyword.If) then
local cond, block = self:Condition(), self:Assert( self:Block(), "Expected block after if condition")
---@type { [1]: Node?, [2]: Node }[]
local chain = { {cond, block} }
while self:ConsumeValue(TokenVariant.Keyword, Keyword.Elseif) do
local cond, block = self:Condition(), self:Assert( self:Block(), "Expected block after elseif condition")
chain[#chain + 1] = { cond, block }
end
if self:ConsumeValue(TokenVariant.Keyword, Keyword.Else) then
chain[#chain + 1] = { nil, self:Assert( self:Block(), "Expected block after else keyword") }
end
return Node.new(NodeVariant.If, chain, cond.trace:stitch(self:Prev().trace))
end
if self:ConsumeValue(TokenVariant.Keyword, Keyword.While) then
local trace = self:Prev().trace
return Node.new(NodeVariant.While, { self:Condition(), self:Block(), false }, trace:stitch(self:Prev().trace))
end
if self:ConsumeValue(TokenVariant.Keyword, Keyword.For) then
local trace = self:Prev().trace
if not self:ConsumeValue(TokenVariant.Grammar, Grammar.LParen) then
self:Error("Left Parenthesis (() must appear before condition")
end
local var = self:Assert( self:Consume(TokenVariant.Ident), "Variable expected for numeric index" )
self:Assert( self:ConsumeValue(TokenVariant.Operator, Operator.Ass), "Assignment operator (=) expected to preceed variable" )
local start = self:Expr()
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.Comma), "Comma (,) expected after start value" )
local stop = self:Expr()
local step
if self:ConsumeValue(TokenVariant.Grammar, Grammar.Comma) then
step = self:Expr()
end
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.RParen), "Right parenthesis ()) missing, to close for statement" )
return Node.new(NodeVariant.For, { var, start, stop, step, self:Block() }, trace:stitch(self:Prev().trace))
end
if self:ConsumeValue(TokenVariant.Keyword, Keyword.Foreach) then
local trace = self:Prev().trace
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.LParen), "Left parenthesis (() missing after foreach statement" )
local key = self:Assert( self:Consume(TokenVariant.Ident), "Variable expected to hold the key" )
local key_type
if self:ConsumeValue(TokenVariant.Operator, Operator.Col) then
key_type = self:Assert(self:Type(), "Type expected after colon")
end
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.Comma), "Comma (,) expected after key variable" )
local value = self:Assert( self:Consume(TokenVariant.Ident), "Variable expected to hold the value" )
self:Assert( self:ConsumeValue(TokenVariant.Operator, Operator.Col), "Colon (:) expected to separate type from variable" )
local value_type = self:Assert(self:Type(), "Type expected after colon")
self:Assert( self:ConsumeValue(TokenVariant.Operator, Operator.Ass), "Equals sign (=) expected after value type to specify table" )
local table = self:Expr()
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.RParen), "Missing right parenthesis after foreach statement" )
return Node.new(NodeVariant.Foreach, { key, key_type, value, value_type, table, self:Block() }, trace:stitch(self:Prev().trace))
end
if self:ConsumeValue(TokenVariant.Keyword, Keyword.Break) then
return Node.new(NodeVariant.Break, nil, self:Prev().trace)
end
if self:ConsumeValue(TokenVariant.Keyword, Keyword.Continue) then
return Node.new(NodeVariant.Continue, nil, self:Prev().trace)
end
if self:ConsumeValue(TokenVariant.Keyword, Keyword.Return) then
local trace = self:Prev().trace
if self:ConsumeValue(TokenVariant.LowerIdent, "void") then
return Node.new(NodeVariant.Return, nil, trace:stitch(self:Prev().trace))
elseif self:ConsumeValue(TokenVariant.Grammar, Grammar.RCurly) then
self.index = self.index - 1
return Node.new(NodeVariant.Return, nil, trace)
else
return Node.new(NodeVariant.Return, self:Expr(), trace:stitch(self:At().trace))
end
end
local var = self:Consume(TokenVariant.Ident)
if var then
--- Increment / Decrement
if self:ConsumeTailing(TokenVariant.Operator, Operator.Inc) then
return Node.new(NodeVariant.Increment, var, var.trace:stitch(self:Prev().trace))
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Inc) then
self:Error("Increment operator (++) must not be preceded by whitespace")
end
if self:ConsumeTailing(TokenVariant.Operator, Operator.Dec) then
return Node.new(NodeVariant.Decrement, var, var.trace:stitch(self:Prev().trace))
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Dec) then
self:Error("Decrement operator (--) must not be preceded by whitespace")
end
--- Compound Assignment
if self:ConsumeValue(TokenVariant.Operator, Operator.Aadd) then
return Node.new(NodeVariant.CompoundAssignment, { var, Operator.Add, self:Expr() }, var.trace:stitch(self:Prev().trace))
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Asub) then
return Node.new(NodeVariant.CompoundAssignment, { var, Operator.Sub, self:Expr() }, var.trace:stitch(self:Prev().trace))
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Amul) then
return Node.new(NodeVariant.CompoundAssignment, { var, Operator.Mul, self:Expr() }, var.trace:stitch(self:Prev().trace))
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Adiv) then
return Node.new(NodeVariant.CompoundAssignment, { var, Operator.Div, self:Expr() }, var.trace:stitch(self:Prev().trace))
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Amod) then
return Node.new(NodeVariant.CompoundAssignment, { var, Operator.Mod, self:Expr() }, var.trace:stitch(self:Prev().trace))
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Aband) then
return Node.new(NodeVariant.CompoundAssignment, { var, Operator.Band, self:Expr() }, var.trace:stitch(self:Prev().trace))
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Abor) then
return Node.new(NodeVariant.CompoundAssignment, { var, Operator.Bor, self:Expr() }, var.trace:stitch(self:Prev().trace))
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Abxor) then
return Node.new(NodeVariant.CompoundAssignment, { var, Operator.Bxor, self:Expr() }, var.trace:stitch(self:Prev().trace))
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Abshr) then
return Node.new(NodeVariant.CompoundAssignment, { var, Operator.Bshr, self:Expr() }, var.trace:stitch(self:Prev().trace))
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Abshl) then
return Node.new(NodeVariant.CompoundAssignment, { var, Operator.Bshl, self:Expr() }, var.trace:stitch(self:Prev().trace))
end
-- Didn't match anything. Might be something else.
self.index = self.index - 1
end
if self:ConsumeValue(TokenVariant.Keyword, Keyword.Const) then
local trace = self:Prev().trace
local name = self:Assert(self:Consume(TokenVariant.Ident), "Expected variable name after const")
self:Assert( self:ConsumeValue(TokenVariant.Operator, Operator.Ass), "Expected = for constant declaration" )
local value = self:Assert(self:Expr(), "Expected expression for constant declaration")
return Node.new(NodeVariant.Const, { name, value }, trace:stitch(self:Prev().trace))
end
local is_local, var = self:ConsumeValue(TokenVariant.Keyword, Keyword.Local) or self:ConsumeValue(TokenVariant.Keyword, Keyword.Let), self:Consume(TokenVariant.Ident)
if not var then
self:Assert(not is_local, "Invalid operator (local) must be used for variable declaration.")
else
local revert, prev = self.index, self.index
local assignments = { { var, is_local and {} or self:Indices(), (is_local or var).trace:stitch(self:Prev().trace) } }
while self:ConsumeValue(TokenVariant.Operator, Operator.Ass) do
local ident = self:Consume(TokenVariant.Ident)
if ident then
prev = self.index
assignments[#assignments + 1] = { ident, self:Indices(), ident.trace:stitch(self:Prev().trace) }
else
return Node.new(NodeVariant.Assignment, { is_local, assignments, self:Expr() }, (is_local or var).trace:stitch(self:Prev().trace))
end
end
if #assignments == 1 then -- No assignment
self.index = revert - 1
else -- Last 'assignment' is the expression.
table.remove(assignments)
self.index = prev - 1
return Node.new(NodeVariant.Assignment, { is_local, assignments, self:Expr() }, (is_local or var).trace:stitch(self:Prev().trace))
end
end
-- Switch Case
if self:ConsumeValue(TokenVariant.Keyword, Keyword.Switch) then
local trace = self:Prev().trace
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.LParen), "Left parenthesis (() expected before switch condition" )
local expr = self:Expr()
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.RParen), "Right parenthesis ()) expected before switch condition" )
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.LCurly), "Left curly bracket ({) expected after switch condition" )
local cases, default = {}, nil
if not self:Eof() and not self:ConsumeValue(TokenVariant.Grammar, Grammar.RParen) then
self:Assert( self:ConsumeValue(TokenVariant.Keyword, Keyword.Case) or self:ConsumeValue(TokenVariant.Keyword, Keyword.Default), "Expected case or default in switch block" )
self.index = self.index - 1
while true do
local case, expr = self:ConsumeValue(TokenVariant.Keyword, Keyword.Case)
if case then
expr = self:Expr()
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.Comma), "Comma (,) expected after case condition" )
end
local default_ = self:ConsumeValue(TokenVariant.Keyword, Keyword.Default)
if default_ then
self:Assert(not default, "Only one default case (default:) may exist.")
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.Comma), "Comma (,) expected after default case" )
elseif not case then
break
end
if self:Eof() then
self:Error("Case block is missing after case declaration.")
end
local block --[=[@type Node[]]=] = {}
while true do
if self:ConsumeValue(TokenVariant.Keyword, Keyword.Case) or self:ConsumeValue(TokenVariant.Keyword, Keyword.Default) or self:ConsumeValue(TokenVariant.Grammar, Grammar.RCurly) then
self.index = self.index - 1
break
elseif self:ConsumeValue(TokenVariant.Grammar, Grammar.Comma) then
self:Error("Statement separator (,) must not appear multiple times")
elseif self:ConsumeValue(TokenVariant.Grammar, Grammar.RCurly) then
self:Error("Statement separator (,) must be suceeded by statement")
end
local stmt = self:Stmt() or self:Expr()
block[#block + 1] = stmt
if not self:ConsumeValue(TokenVariant.Grammar, Grammar.Comma) then
if self:Eof() then break end
if not self:At().whitespaced then
self:Error("Statements must be separated by comma (,) or whitespace", stmt.trace)
end
end
end
if default_ then
local trace = (#block ~= 0) and default_.trace:stitch(block[1].trace):stitch(block[#block].trace) or default_.trace
default = Node.new(NodeVariant.Block, block, trace)
else ---@cast case Token # Know it isn't nil since (if not case then break end) above
local trace = (#block ~= 0) and case.trace:stitch(block[1].trace):stitch(block[#block].trace) or case.trace
cases[#cases + 1] = { expr, Node.new(NodeVariant.Block, block, trace) }
end
end
end
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.RCurly), "Right curly bracket (}) missing, to close switch block")
return Node.new(NodeVariant.Switch, { expr, cases, default }, trace:stitch(self:Prev().trace))
end
-- Function definition
if self:ConsumeValue(TokenVariant.Keyword, Keyword.Function) then
local trace, type_or_name = self:Prev().trace, self:Assert( self:Type(), "Expected function return type or name after function keyword")
if self:ConsumeValue(TokenVariant.Operator, Operator.Col) then
-- function entity:xyz()
return Node.new(NodeVariant.Function, { nil, type_or_name, self:Assert(self:Consume(TokenVariant.LowerIdent), "Expected function name after colon (:)"), self:Parameters(), self:Block() }, trace:stitch(self:Prev().trace))
end
local meta_or_name = self:Consume(TokenVariant.LowerIdent)
if meta_or_name then
if self:ConsumeValue(TokenVariant.Operator, Operator.Col) then
-- function void entity:xyz()
return Node.new(NodeVariant.Function, { type_or_name, meta_or_name, self:Assert(self:Consume(TokenVariant.LowerIdent), "Expected function name after colon (:)"), self:Parameters(), self:Block() }, trace:stitch(self:Prev().trace))
else
-- function void test()
return Node.new(NodeVariant.Function, { type_or_name, nil, meta_or_name, self:Parameters(), self:Block() }, trace:stitch(self:Prev().trace))
end
else -- function test()
self:Assert( type_or_name.value ~= "function", "Identifier expected. \"function\" is a reserved keyword that cannot be used here", trace )
return Node.new(NodeVariant.Function, { nil, nil, type_or_name, self:Parameters(), self:Block() }, trace:stitch(self:Prev().trace))
end
end
-- #include
if self:ConsumeValue(TokenVariant.Keyword, Keyword["#Include"]) then
local trace, path = self:Prev().trace, self:Assert( self:Consume(TokenVariant.String), "include path (string) expected after #include")
self.include_files[#self.include_files + 1] = path.value
return Node.new(NodeVariant.Include, path.value, trace:stitch(path.trace))
end
-- Try catch
if self:ConsumeValue(TokenVariant.Keyword, Keyword.Try) then
local trace, stmt = self:Prev().trace, self:Block()
if self:ConsumeValue(TokenVariant.Keyword, Keyword.Catch) then
if not self:ConsumeValue(TokenVariant.Grammar, Grammar.LParen) then
self:Error("Left parenthesis (() expected after catch keyword")
end
local err_ident = self:Consume(TokenVariant.Ident)
if not err_ident then
self:Error("Variable expected after left parenthesis (() in catch statement")
end
local ty
if self:ConsumeValue(TokenVariant.Operator, Operator.Col) then
ty = self:Assert(self:Type(), "Expected type name after : for error value", trace)
end
if not self:ConsumeValue(TokenVariant.Grammar, Grammar.RParen) then
self:Error("Right parenthesis ()) missing, to close catch statement")
end
return Node.new(NodeVariant.Try, {stmt, err_ident, ty, self:Block()}, trace:stitch(self:Prev().trace))
else
self:Error("Try block must be followed by catch statement")
end
end
-- Do while
if self:ConsumeValue(TokenVariant.Keyword, Keyword.Do) then
local trace, block = self:Prev().trace, self:Block()
self:Assert( self:ConsumeValue(TokenVariant.Keyword, Keyword.While), "while expected after do and code block (do {...} )")
return Node.new(NodeVariant.While, { self:Condition(), block, true }, trace:stitch(self:Prev().trace))
end
-- Event
if self:ConsumeValue(TokenVariant.Keyword, Keyword.Event) then
local trace, name = self:Prev().trace, self:Assert( self:Consume(TokenVariant.LowerIdent), "Expected event name after 'event' keyword")
return Node.new(NodeVariant.Event, { name, self:Parameters(), self:Block() }, trace:stitch(self:Prev().trace))
end
end
---@return Token<string>?
function Parser:Type()
local type = self:Consume(TokenVariant.LowerIdent)
if type then
if type.value == "normal" then
self:Warning("Use of deprecated type [normal]", type.trace, { { at = type.trace, replace = "number" } })
type.value = "number"
end
else -- workaround to allow "function" as type while also being a keyword
local fn = self:ConsumeValue(TokenVariant.Keyword, Keyword.Function)
if fn then
fn.value, fn.variant = "function", TokenVariant.LowerIdent
return fn
end
end
return type
end
---@alias Index { [1]: Node, [2]: Token<string>?, [3]: Trace }
---@return Index[]
function Parser:Indices()
local indices = {}
while true do
local lsb = self:ConsumeTailing(TokenVariant.Grammar, Grammar.LSquare)
if not lsb then break end
local exp = self:Expr()
if self:ConsumeValue(TokenVariant.Grammar, Grammar.Comma) then
local type = self:Assert(self:Type(), "Indexing operator ([]) requires a valid type [X, t]")
local rsb = self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.RSquare), "Right square bracket (]) missing, to close indexing operator [X,t]" )
indices[#indices + 1] = { exp, type, lsb.trace:stitch(rsb.trace) }
elseif self:ConsumeTailing(TokenVariant.Grammar, Grammar.RSquare) then
indices[#indices + 1] = { exp, nil, lsb.trace:stitch(self:Prev().trace) }
else
self:Error("Indexing operator ([]) must not be preceded by whitespace")
end
end
return indices
end
function Parser:Block()
local lcb = self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.LCurly), "Left curly bracket ({) expected for block" )
local stmts = {}
if self:ConsumeValue(TokenVariant.Grammar, Grammar.RCurly) then
return Node.new(NodeVariant.Block, stmts, lcb.trace:stitch(self:Prev().trace))
end
if not self:Eof() then
while true do
if self:ConsumeValue(TokenVariant.Grammar, Grammar.Comma) then
self:Error("Statement separator (,) must not appear multiple times")
elseif self:ConsumeValue(TokenVariant.Grammar, Grammar.RCurly) then
self:Error("Statement separator (,) must be suceeded by statement")
end
stmts[#stmts + 1] = self:Stmt() or self:Expr()
if self:ConsumeValue(TokenVariant.Grammar, Grammar.RCurly) then
return Node.new(NodeVariant.Block, stmts, lcb.trace:stitch(self:Prev().trace))
end
if not self:ConsumeValue(TokenVariant.Grammar, Grammar.Comma) then
if self:Eof() then break end
self:Assert(self:At().whitespaced, "Statements must be separated by comma (,) or whitespace")
end
end
end
self:Error("Right curly bracket (}) missing, to close block")
end
--- `type` is nil in case of the default param type. (number)
---@alias Parameter { name: Token<string>, type: Token<string>?, variadic: boolean }
---@return Parameter[]?
function Parser:Parameters()
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.LParen), "Left parenthesis (() must appear for function parameters name")
local params = {}
if self:ConsumeValue(TokenVariant.Grammar, Grammar.RParen) then
return params
end
while true do
local variadic
if self:ConsumeValue(TokenVariant.Grammar, Grammar.LSquare) then
local temp = {}
repeat
temp[#temp + 1] = self:Assert(self:Consume(TokenVariant.Ident), "Expected parameter name")
until self:ConsumeValue(TokenVariant.Grammar, Grammar.RSquare)
local typ, len = nil, #params
if self:ConsumeValue(TokenVariant.Operator, Operator.Col) then
typ = self:Assert( self:Type(), "Expected type after colon (:)" )
else
self:Warning("You should explicitly mark the type of these parameters")
end
for k, name in ipairs(temp) do
params[len + k] = { name = name, type = typ, variadic = false }
end
else
variadic = self:ConsumeValue(TokenVariant.Operator, Operator.Spread)
local name, type = self:Assert(self:Consume(TokenVariant.Ident), "Expected parameter name")
if self:ConsumeValue(TokenVariant.Operator, Operator.Col) then
type = self:Assert(self:Type(), "Expected valid parameter type")
end
params[#params + 1] = { name = name, type = type, variadic = variadic ~= nil }
end
if variadic then
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.RParen), "Variadic parameter must be final in list" )
return params
elseif self:ConsumeValue(TokenVariant.Grammar, Grammar.Comma) then
elseif self:ConsumeValue(TokenVariant.Grammar, Grammar.RParen) then
return params
else
self:Error("Expected comma (,) to separate parameters")
end
end
end
function Parser:Expr(ignore_assign)
local starting_index = self.index
local cached = self.cache[starting_index]
if cached then self.index = cached[1] return cached[2] end
-- Error for compound operators in expression
if self:Consume(TokenVariant.Ident) then
if not ignore_assign and self:ConsumeValue(TokenVariant.Operator, Operator.Ass) then
self:Error("Assignment operator (=) must not be part of equation ( Did you mean == ? )")
end
if self:ConsumeValue(TokenVariant.Operator, Operator.Aadd) then
self:Error("Additive assignment operator (+=) must not be part of equation")
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Asub) then
self:Error("Subtractive assignment operator (-=) must not be part of equation")
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Amul) then
self:Error("Multiplicative assignment operator (*=) must not be part of equation")
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Adiv) then
self:Error("Divisive assignment operator (/=) must not be part of equation")
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Amod) then
self:Error("Modular assignment operator (%=) must not be part of equation")
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Aband) then
self:Error("Bitwise AND assignment operator (&&=) must not be part of equation")
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Abor) then
self:Error("Bitwise OR assignment operator (||=) must not be part of equation")
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Abxor) then
self:Error("Bitwise XOR assignment operator (^^=) must not be part of equation")
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Abshr) then
self:Error("Right bitwise shift assignment operator (>>=) must not be part of equation")
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Abshl) then
self:Error("Left bitwise shift assignment operator (<<=) must not be part of equation")
end
self.index = self.index - 1
end
-- Ternary or Default
local cond = self:Expr2()
if self:ConsumeValue(TokenVariant.Operator, Operator.Qsm) then
local if_true = self:Expr()
if not self:ConsumeValue(TokenVariant.Operator, Operator.Col) then -- perhaps we want to make sure there is space around this (method bug)
self:Error("Conditional operator (:) must appear after expression to complete conditional")
end
local if_false = self:Expr()
return self:Cache(starting_index, Node.new(NodeVariant.ExprTernary, { cond, if_true, if_false }, cond.trace:stitch(if_true.trace):stitch(if_false.trace)))
end
if self:ConsumeValue(TokenVariant.Operator, Operator.Def) then
local rhs = self:Expr()
return self:Cache(starting_index, Node.new(NodeVariant.ExprDefault, { cond, rhs }, cond.trace:stitch(rhs.trace)))
end
return self:Cache(starting_index, cond)
end
---@param func fun(self: Parser): Node
---@param variant NodeVariant
---@param tbl Operator[]
---@return Node
function Parser:RecurseLeft(func, variant, tbl)
local lhs, hit = func(self), true
while hit do
hit = false
for _, op in ipairs(tbl) do
if self:ConsumeValue(TokenVariant.Operator, op) then
local rhs = func(self)
hit, lhs = true, Node.new(variant, { lhs, op, rhs }, lhs.trace:stitch(rhs.trace))
break
end
end
end
return lhs
end
function Parser:Expr2()
return self:RecurseLeft(self.Expr3, NodeVariant.ExprLogicalOp, { Operator.Or })
end
function Parser:Expr3()
return self:RecurseLeft(self.Expr4, NodeVariant.ExprLogicalOp, { Operator.And })
end
function Parser:Expr4()
return self:RecurseLeft(self.Expr5, NodeVariant.ExprBinaryOp, { Operator.Bor })
end
function Parser:Expr5()
return self:RecurseLeft(self.Expr6, NodeVariant.ExprBinaryOp, { Operator.Band })
end
function Parser:Expr6()
return self:RecurseLeft(self.Expr7, NodeVariant.ExprBinaryOp, { Operator.Bxor })
end
function Parser:Expr7()
return self:RecurseLeft(self.Expr8, NodeVariant.ExprEquals, { Operator.Eq, Operator.Neq })
end
function Parser:Expr8()
return self:RecurseLeft(self.Expr9, NodeVariant.ExprComparison, { Operator.Gth, Operator.Lth, Operator.Geq, Operator.Leq })
end
function Parser:Expr9()
return self:RecurseLeft(self.Expr10, NodeVariant.ExprBitShift, { Operator.Bshr, Operator.Bshl })
end
function Parser:Expr10()
return self:RecurseLeft(self.Expr11, NodeVariant.ExprArithmetic, { Operator.Add, Operator.Sub })
end
function Parser:Expr11()
return self:RecurseLeft(self.Expr12, NodeVariant.ExprArithmetic, { Operator.Mul, Operator.Div, Operator.Mod })
end
function Parser:Expr12()
return self:RecurseLeft(self.Expr13, NodeVariant.ExprArithmetic, { Operator.Exp })
end
---@return Node
function Parser:Expr13()
if self:ConsumeLeading(TokenVariant.Operator, Operator.Add) then
return self:Expr14()
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Add) then
self:Error("Identity operator (+) must not be succeeded by whitespace")
end
if self:ConsumeLeading(TokenVariant.Operator, Operator.Sub) then
local trace, exp = self:Prev().trace, self:Expr14()
return Node.new(NodeVariant.ExprUnaryOp, { Operator.Sub, exp }, trace:stitch(exp.trace))
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Sub) then
self:Error("Negation operator (-) must not be succeeded by whitespace")
end
if self:ConsumeLeading(TokenVariant.Operator, Operator.Not) then
local trace, exp = self:Prev().trace, self:Expr13()
return Node.new(NodeVariant.ExprUnaryOp, { Operator.Not, exp }, trace:stitch(exp.trace))
elseif self:ConsumeValue(TokenVariant.Operator, Operator.Not) then
self:Error("Logical not operator (!) must not be succeeded by whitespace")
end
return self:Expr14()
end
---@return Node[]
function Parser:Arguments()
if not self:ConsumeTailing(TokenVariant.Grammar, Grammar.LParen) then
if self:ConsumeValue(TokenVariant.Grammar, Grammar.LParen) then
self:Error("Left parenthesis (() must not be preceded by whitespace")
else
self:Error("Left parenthesis (() must appear to start argument list")
end
end
local arguments = {}
if self:ConsumeValue(TokenVariant.Grammar, Grammar.RParen) then
return arguments
end
repeat
arguments[#arguments + 1] = self:Expr()
until not self:ConsumeValue(TokenVariant.Grammar, Grammar.Comma)
if not self:ConsumeValue(TokenVariant.Grammar, Grammar.RParen) then
self:Error("Right parenthesis ()) missing, to close argument list")
end
return arguments
end
---@param start_bracket Grammar
---@param end_bracket Grammar
---@return { [1]: Node, [2]: Node }[]?
function Parser:ArgumentsKV(start_bracket, end_bracket)
local before = self.index
if not self:ConsumeTailing(TokenVariant.Grammar, start_bracket) then
if self:ConsumeValue(TokenVariant.Grammar, start_bracket) then
self:Error("Bracket must not be preceded by whitespace")
else
self.index = before
return
end
end
if self:ConsumeValue(TokenVariant.Grammar, end_bracket) then
return {}
end
local first = self:Expr(true)
if not self:ConsumeValue(TokenVariant.Operator, Operator.Ass) then
self.index = before
return
else
local arguments = { { first, self:Expr() } }
if self:ConsumeValue(TokenVariant.Grammar, end_bracket) then
return arguments
end
while true do
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.Comma), "Expected comma (,) in between key value arguments" )
local key = self:Expr()
self:Assert( self:ConsumeValue(TokenVariant.Operator, Operator.Ass), "Assignment operator (=) missing, to complete expression" )
arguments[#arguments + 1] = {key, self:Expr()}
if self:ConsumeValue(TokenVariant.Grammar, end_bracket) then
return arguments
end
end
end
end
---@return Node
function Parser:Expr14()
local expr = self:Expr15()
while true do
if self:ConsumeTailing(TokenVariant.Operator, Operator.Col) then
local fn = self:ConsumeTailing(TokenVariant.LowerIdent)
if not fn then
if self:Consume(TokenVariant.LowerIdent) then
self:Error("Method operator (:) must not be preceded by whitespace")
else
self:Error("Method operator (:) must be followed by method name")
end
end
expr = Node.new(NodeVariant.ExprMethodCall, { expr, fn, self:Arguments() }, expr.trace:stitch(self:Prev().trace))
else
local indices = self:Indices()
if #indices > 0 then
expr = Node.new(NodeVariant.ExprIndex, { expr, indices }, expr.trace:stitch(self:Prev().trace))
elseif self:ConsumeValue(TokenVariant.Grammar, Grammar.LSquare) then
self:Error("Indexing operator ([]) must not be preceded by whitespace")
elseif self:ConsumeTailing(TokenVariant.Grammar, Grammar.LParen) then
self.index = self.index - 1
local args, typ = self:Arguments()
if self:ConsumeValue(TokenVariant.Grammar, Grammar.LSquare) then
typ = self:Assert(self:Type(), "Return type operator ([]) requires a lower case type [type]")
if not self:ConsumeValue(TokenVariant.Grammar, Grammar.RSquare) then
self:Error("Right square bracket (]) missing, to close return type operator [type]")
end
end
return Node.new(NodeVariant.ExprDynCall, { expr, args, typ }, expr.trace:stitch(self:Prev().trace))
else
break
end
end
end
return expr
end
---@return Node
function Parser:Expr15()
if self:ConsumeValue(TokenVariant.Grammar, Grammar.LParen) then
local expr = self:Expr()
self:Assert( self:ConsumeValue(TokenVariant.Grammar, Grammar.RParen), "Right parenthesis ()) missing, to close grouped equation" )
return expr
end
local fn = self:Consume(TokenVariant.LowerIdent)
if fn then
-- Transform key value
if fn.value == "array" then
return Node.new(NodeVariant.ExprArray, self:ArgumentsKV(Grammar.LParen, Grammar.RParen) or self:Arguments(), fn.trace:stitch(self:Prev().trace))
elseif fn.value == "table" then
return Node.new(NodeVariant.ExprTable, self:ArgumentsKV(Grammar.LParen, Grammar.RParen) or self:Arguments(), fn.trace:stitch(self:Prev().trace))
end
return Node.new(NodeVariant.ExprCall, { fn, self:Arguments() }, fn.trace:stitch(self:Prev().trace))
end
local fn = self:ConsumeValue(TokenVariant.Keyword, Keyword.Function)
if fn then
return Node.new(NodeVariant.ExprFunction, { self:Parameters(), self:Assert(self:Block(), "Expected block to follow function") }, fn.trace:stitch(self:Prev().trace))
end
-- Decimal / Hexadecimal / Binary numbers
local num = self:Consume(TokenVariant.Decimal) or self:Consume(TokenVariant.Hexadecimal) or self:Consume(TokenVariant.Binary)
if num then
return Node.new(NodeVariant.ExprLiteral, { "n", num.value }, num.trace)
end
-- Complex / Quaternion numbers
local adv_num = self:Consume(TokenVariant.Complex) or self:Consume(TokenVariant.Quat)
if adv_num then
local num, suffix = adv_num.value:match("^([-+e0-9.]*)(.*)$")
num = self:Assert(tonumber(num), "Malformed numeric literal")
local value, type
if suffix == "" then
value, type = num, "n"
elseif suffix == "i" then
value, type = {0, num}, "c"
elseif suffix == "j" then
value, type = {0, 0, num, 0}, "q"
elseif suffix == "k" then
value, type = {0, 0, 0, num}, "q"
else
self:Error("unrecognized numeric suffix " .. suffix)
end