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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
|
package parser
import (
"bytes"
_ "embed"
"encoding/json"
"fmt"
"go/ast"
"go/format"
"go/parser"
"go/token"
goToken "go/token"
"io"
"strconv"
"strings"
"text/template"
"urubu/driver/lexer"
spec "urubu/spec/grammar"
)
type Grammar interface {
// InitialState returns the initial state of a parser.
InitialState() int
// StartProduction returns the start production of grammar.
StartProduction() int
// Action returns an ACTION entry corresponding to a (state, terminal symbol) pair.
Action(state int, terminal int) int
// GoTo returns a GOTO entry corresponding to a (state, non-terminal symbol) pair.
GoTo(state int, lhs int) int
// ErrorTrapperState returns true when a state can shift the error symbol.
ErrorTrapperState(state int) bool
// LHS returns a LHS symbol of a production.
LHS(prod int) int
// AlternativeSymbolCount returns a symbol count of p production.
AlternativeSymbolCount(prod int) int
// RecoverProduction returns true when a production has the recover directive.
RecoverProduction(prod int) bool
// NonTerminal retuns a string representaion of a non-terminal symbol.
NonTerminal(nonTerminal int) string
// TerminalCount returns a terminal symbol count of grammar.
TerminalCount() int
// SkipTerminal returns true when a terminal symbol must be skipped on syntax analysis.
SkipTerminal(terminal int) bool
// EOF returns the EOF symbol.
EOF() int
// Error returns the error symbol.
Error() int
// Terminal retuns a string representaion of a terminal symbol.
Terminal(terminal int) string
// ASTAction returns an AST action entries.
ASTAction(prod int) []int
}
type VToken interface {
// TerminalID returns a terminal ID.
TerminalID() int
// Lexeme returns a lexeme.
Lexeme() []byte
// EOF returns true when a token represents EOF.
EOF() bool
// Invalid returns true when a token is invalid.
Invalid() bool
// BytePosition returns (position, length) pair.
// `position` is a byte position where a token appears and `length` is a length in bytes.
BytePosition() (int, int)
// Position returns (row, column) pair.
Position() (int, int)
}
type TokenStream interface {
Next() (VToken, error)
}
type SyntaxError struct {
Row int
Col int
Message string
Token VToken
ExpectedTerminals []string
}
type ParserOption func(p *Parser) error
// DisableLAC disables LAC (lookahead correction). LAC is enabled by default.
func DisableLAC() ParserOption {
return func(p *Parser) error {
p.disableLAC = true
return nil
}
}
func SemanticAction(semAct SemanticActionSet) ParserOption {
return func(p *Parser) error {
p.semAct = semAct
return nil
}
}
type Parser struct {
toks TokenStream
gram Grammar
stateStack *stateStack
semAct SemanticActionSet
disableLAC bool
onError bool
shiftCount int
synErrs []*SyntaxError
}
func NewParser(toks TokenStream, gram Grammar, opts ...ParserOption) (*Parser, error) {
p := &Parser{
toks: toks,
gram: gram,
stateStack: &stateStack{},
}
for _, opt := range opts {
err := opt(p)
if err != nil {
return nil, err
}
}
return p, nil
}
func (p *Parser) Parse() error {
p.stateStack.push(p.gram.InitialState())
tok, err := p.nextToken()
if err != nil {
return err
}
ACTION_LOOP:
for {
act := p.lookupAction(tok)
switch {
case act < 0: // Shift
nextState := act * -1
recovered := false
if p.onError {
p.shiftCount++
// When the parser performs shift three times, the parser recovers from the error state.
if p.shiftCount >= 3 {
p.onError = false
p.shiftCount = 0
recovered = true
}
}
p.shift(nextState)
if p.semAct != nil {
p.semAct.Shift(tok, recovered)
}
tok, err = p.nextToken()
if err != nil {
return err
}
case act > 0: // Reduce
prodNum := act
recovered := false
if p.onError && p.gram.RecoverProduction(prodNum) {
p.onError = false
p.shiftCount = 0
recovered = true
}
accepted := p.reduce(prodNum)
if accepted {
if p.semAct != nil {
p.semAct.Accept()
}
return nil
}
if p.semAct != nil {
p.semAct.Reduce(prodNum, recovered)
}
default: // Error
if p.onError {
tok, err = p.nextToken()
if err != nil {
return err
}
if tok.EOF() {
if p.semAct != nil {
p.semAct.MissError(tok)
}
return nil
}
continue ACTION_LOOP
}
row, col := tok.Position()
p.synErrs = append(p.synErrs, &SyntaxError{
Row: row,
Col: col,
Message: "unexpected token",
Token: tok,
ExpectedTerminals: p.searchLookahead(p.stateStack.top()),
})
count, ok := p.trapError()
if !ok {
if p.semAct != nil {
p.semAct.MissError(tok)
}
return nil
}
p.onError = true
p.shiftCount = 0
act, err := p.lookupActionOnError()
if err != nil {
return err
}
p.shift(act * -1)
if p.semAct != nil {
p.semAct.TrapAndShiftError(tok, count)
}
}
}
}
// validateLookahead validates whether `term` is a valid lookahead in the current context. When `term` is valid,
// this method returns `true`.
func (p *Parser) validateLookahead(term int) bool {
p.stateStack.enableExploratoryMode()
defer p.stateStack.disableExploratoryMode()
for {
act := p.gram.Action(p.stateStack.topExploratorily(), term)
switch {
case act < 0: // Shift
return true
case act > 0: // Reduce
prodNum := act
lhs := p.gram.LHS(prodNum)
if lhs == p.gram.LHS(p.gram.StartProduction()) {
return true
}
n := p.gram.AlternativeSymbolCount(prodNum)
p.stateStack.popExploratorily(n)
state := p.gram.GoTo(p.stateStack.topExploratorily(), lhs)
p.stateStack.pushExploratorily(state)
default: // Error
return false
}
}
}
func (p *Parser) nextToken() (VToken, error) {
for {
// We don't have to check whether the token is invalid because the kind ID of the invalid token is 0,
// and the parsing table doesn't have an entry corresponding to the kind ID 0. Thus we can detect
// a syntax error because the parser cannot find an entry corresponding to the invalid token.
tok, err := p.toks.Next()
if err != nil {
return nil, err
}
if p.gram.SkipTerminal(tok.TerminalID()) {
continue
}
return tok, nil
}
}
func (p *Parser) tokenToTerminal(tok VToken) int {
if tok.EOF() {
return p.gram.EOF()
}
return tok.TerminalID()
}
func (p *Parser) lookupAction(tok VToken) int {
if !p.disableLAC {
term := p.tokenToTerminal(tok)
if !p.validateLookahead(term) {
return 0
}
}
return p.gram.Action(p.stateStack.top(), p.tokenToTerminal(tok))
}
func (p *Parser) lookupActionOnError() (int, error) {
act := p.gram.Action(p.stateStack.top(), p.gram.Error())
if act >= 0 {
return 0, fmt.Errorf("an entry must be a shift action by the error symbol; entry: %v, state: %v, symbol: %v", act, p.stateStack.top(), p.gram.Terminal(p.gram.Error()))
}
return act, nil
}
func (p *Parser) shift(nextState int) {
p.stateStack.push(nextState)
}
func (p *Parser) reduce(prodNum int) bool {
lhs := p.gram.LHS(prodNum)
if lhs == p.gram.LHS(p.gram.StartProduction()) {
return true
}
n := p.gram.AlternativeSymbolCount(prodNum)
p.stateStack.pop(n)
nextState := p.gram.GoTo(p.stateStack.top(), lhs)
p.stateStack.push(nextState)
return false
}
func (p *Parser) trapError() (int, bool) {
count := 0
for {
if p.gram.ErrorTrapperState(p.stateStack.top()) {
return count, true
}
if p.stateStack.top() != p.gram.InitialState() {
p.stateStack.pop(1)
count++
} else {
return 0, false
}
}
}
func (p *Parser) SyntaxErrors() []*SyntaxError {
return p.synErrs
}
func (p *Parser) searchLookahead(state int) []string {
kinds := []string{}
termCount := p.gram.TerminalCount()
for term := 0; term < termCount; term++ {
if p.disableLAC {
if p.gram.Action(p.stateStack.top(), term) == 0 {
continue
}
} else {
if !p.validateLookahead(term) {
continue
}
}
// We don't add the error symbol to the look-ahead symbols because users cannot input the error symbol
// intentionally.
if term == p.gram.Error() {
continue
}
kinds = append(kinds, p.gram.Terminal(term))
}
return kinds
}
type stateStack struct {
items []int
itemsExp []int
}
func (s *stateStack) enableExploratoryMode() {
s.itemsExp = make([]int, len(s.items))
copy(s.itemsExp, s.items)
}
func (s *stateStack) disableExploratoryMode() {
s.itemsExp = nil
}
func (s *stateStack) top() int {
return s.items[len(s.items)-1]
}
func (s *stateStack) topExploratorily() int {
return s.itemsExp[len(s.itemsExp)-1]
}
func (s *stateStack) push(state int) {
s.items = append(s.items, state)
}
func (s *stateStack) pushExploratorily(state int) {
s.itemsExp = append(s.itemsExp, state)
}
func (s *stateStack) pop(n int) {
s.items = s.items[:len(s.items)-n]
}
func (s *stateStack) popExploratorily(n int) {
s.itemsExp = s.itemsExp[:len(s.itemsExp)-n]
}
// SemanticActionSet is a set of semantic actions a parser calls.
type SemanticActionSet interface {
// Shift runs when the parser shifts a symbol onto a state stack. `tok` is a token corresponding to the symbol.
// When the parser recovered from an error state by shifting the token, `recovered` is true.
Shift(tok VToken, recovered bool)
// Reduce runs when the parser reduces an RHS of a production to its LHS. `prodNum` is a number of the production.
// When the parser recovered from an error state by reducing the production, `recovered` is true.
Reduce(prodNum int, recovered bool)
// Accept runs when the parser accepts an input.
Accept()
// TrapAndShiftError runs when the parser traps a syntax error and shifts a error symbol onto the state stack.
// `cause` is a token that caused a syntax error. `popped` is the number of frames that the parser discards
// from the state stack.
// Unlike `Shift` function, this function doesn't take a token to be shifted as an argument because a token
// corresponding to the error symbol doesn't exist.
TrapAndShiftError(cause VToken, popped int)
// MissError runs when the parser fails to trap a syntax error. `cause` is a token that caused a syntax error.
MissError(cause VToken)
}
var _ SemanticActionSet = &SyntaxTreeActionSet{}
// SyntaxTreeNode is a node of a syntax tree. A node type used in SyntaxTreeActionSet must implement SyntaxTreeNode interface.
type SyntaxTreeNode interface {
// ChildCount returns a child count of a node. A parser calls this method to know the child count to be expanded by an `#ast`
// directive with `...` operator.
ChildCount() int
// ExpandChildren returns children of a node. A parser calls this method to fetch the children to be expanded by an `#ast`
// directive with `...` operator.
ExpandChildren() []SyntaxTreeNode
}
var _ SyntaxTreeNode = &Node{}
// SyntaxTreeBuilder allows you to construct a syntax tree containing arbitrary user-defined node types.
// The parser uses SyntaxTreeBuilder interface as a part of semantic actions via SyntaxTreeActionSet interface.
type SyntaxTreeBuilder interface {
Shift(kindName string, tok VToken) SyntaxTreeNode
ShiftError(kindName string) SyntaxTreeNode
Reduce(kindName string, children []SyntaxTreeNode) SyntaxTreeNode
Accept(f SyntaxTreeNode)
}
var _ SyntaxTreeBuilder = &DefaultSyntaxTreeBuilder{}
// DefaultSyntaxTreeBuilder is a implementation of SyntaxTreeBuilder.
type DefaultSyntaxTreeBuilder struct {
tree *Node
}
// NewDefaultSyntaxTreeBuilder returns a new DefaultSyntaxTreeBuilder.
func NewDefaultSyntaxTreeBuilder() *DefaultSyntaxTreeBuilder {
return &DefaultSyntaxTreeBuilder{}
}
// Shift is a implementation of SyntaxTreeBuilder.Shift.
func (b *DefaultSyntaxTreeBuilder) Shift(kindName string, tok VToken) SyntaxTreeNode {
bytePos, byteLen := tok.BytePosition()
row, col := tok.Position()
return &Node{
Type: NodeTypeTerminal,
KindName: kindName,
Text: string(tok.Lexeme()),
BytePos: bytePos,
ByteLen: byteLen,
Row: row,
Col: col,
}
}
// ShiftError is a implementation of SyntaxTreeBuilder.ShiftError.
func (b *DefaultSyntaxTreeBuilder) ShiftError(kindName string) SyntaxTreeNode {
return &Node{
Type: NodeTypeError,
KindName: kindName,
}
}
// Reduce is a implementation of SyntaxTreeBuilder.Reduce.
func (b *DefaultSyntaxTreeBuilder) Reduce(kindName string, children []SyntaxTreeNode) SyntaxTreeNode {
cNodes := make([]*Node, len(children))
for i, c := range children {
cNodes[i] = c.(*Node)
}
return &Node{
Type: NodeTypeNonTerminal,
KindName: kindName,
Children: cNodes,
}
}
// Accept is a implementation of SyntaxTreeBuilder.Accept.
func (b *DefaultSyntaxTreeBuilder) Accept(f SyntaxTreeNode) {
b.tree = f.(*Node)
}
// Tree returns a syntax tree when the parser has accepted an input. If a syntax error occurs, the return value is nil.
func (b *DefaultSyntaxTreeBuilder) Tree() *Node {
return b.tree
}
// SyntaxTreeActionSet is a implementation of SemanticActionSet interface and constructs a syntax tree.
type SyntaxTreeActionSet struct {
gram Grammar
builder SyntaxTreeBuilder
semStack *semanticStack
disableASTAction bool
}
// NewASTActionSet returns a new SyntaxTreeActionSet that constructs an AST (Abstract Syntax Tree).
// When grammar `gram` contains `#ast` directives, the new SyntaxTreeActionSet this function returns interprets them.
func NewASTActionSet(gram Grammar, builder SyntaxTreeBuilder) *SyntaxTreeActionSet {
return &SyntaxTreeActionSet{
gram: gram,
builder: builder,
semStack: newSemanticStack(),
}
}
// NewCSTTActionSet returns a new SyntaxTreeActionSet that constructs a CST (Concrete Syntax Tree).
// Even if grammar `gram` contains `#ast` directives, the new SyntaxTreeActionSet this function returns ignores them.
func NewCSTActionSet(gram Grammar, builder SyntaxTreeBuilder) *SyntaxTreeActionSet {
return &SyntaxTreeActionSet{
gram: gram,
builder: builder,
semStack: newSemanticStack(),
disableASTAction: true,
}
}
// Shift is a implementation of SemanticActionSet.Shift method.
func (a *SyntaxTreeActionSet) Shift(tok VToken, recovered bool) {
term := a.tokenToTerminal(tok)
a.semStack.push(a.builder.Shift(a.gram.Terminal(term), tok))
}
// Reduce is a implementation of SemanticActionSet.Reduce method.
func (a *SyntaxTreeActionSet) Reduce(prodNum int, recovered bool) {
lhs := a.gram.LHS(prodNum)
// When an alternative is empty, `n` will be 0, and `handle` will be empty slice.
n := a.gram.AlternativeSymbolCount(prodNum)
handle := a.semStack.pop(n)
var astAct []int
if !a.disableASTAction {
astAct = a.gram.ASTAction(prodNum)
}
var children []SyntaxTreeNode
if astAct != nil {
// Count the number of children in advance to avoid frequent growth in a slice for children.
{
l := 0
for _, e := range astAct {
if e > 0 {
l++
} else {
offset := e*-1 - 1
l += handle[offset].ChildCount()
}
}
children = make([]SyntaxTreeNode, l)
}
p := 0
for _, e := range astAct {
if e > 0 {
offset := e - 1
children[p] = handle[offset]
p++
} else {
offset := e*-1 - 1
for _, c := range handle[offset].ExpandChildren() {
children[p] = c
p++
}
}
}
} else {
// If an alternative has no AST action, a driver generates
// a node with the same structure as a CST.
children = handle
}
a.semStack.push(a.builder.Reduce(a.gram.NonTerminal(lhs), children))
}
// Accept is a implementation of SemanticActionSet.Accept method.
func (a *SyntaxTreeActionSet) Accept() {
top := a.semStack.pop(1)
a.builder.Accept(top[0])
}
// TrapAndShiftError is a implementation of SemanticActionSet.TrapAndShiftError method.
func (a *SyntaxTreeActionSet) TrapAndShiftError(cause VToken, popped int) {
a.semStack.pop(popped)
a.semStack.push(a.builder.ShiftError(a.gram.Terminal(a.gram.Error())))
}
// MissError is a implementation of SemanticActionSet.MissError method.
func (a *SyntaxTreeActionSet) MissError(cause VToken) {
}
func (a *SyntaxTreeActionSet) tokenToTerminal(tok VToken) int {
if tok.EOF() {
return a.gram.EOF()
}
return tok.TerminalID()
}
type semanticStack struct {
frames []SyntaxTreeNode
}
func newSemanticStack() *semanticStack {
return &semanticStack{
frames: make([]SyntaxTreeNode, 0, 100),
}
}
func (s *semanticStack) push(f SyntaxTreeNode) {
s.frames = append(s.frames, f)
}
func (s *semanticStack) pop(n int) []SyntaxTreeNode {
fs := s.frames[len(s.frames)-n:]
s.frames = s.frames[:len(s.frames)-n]
return fs
}
type NodeType int
const (
NodeTypeError = 0
NodeTypeTerminal = 1
NodeTypeNonTerminal = 2
)
// Node is a implementation of SyntaxTreeNode interface.
type Node struct {
Type NodeType
KindName string
Text string
BytePos int
ByteLen int
Row int
Col int
Children []*Node
}
func (n *Node) MarshalJSON() ([]byte, error) {
switch n.Type {
case NodeTypeError:
return json.Marshal(struct {
Type NodeType `json:"type"`
KindName string `json:"kind_name"`
}{
Type: n.Type,
KindName: n.KindName,
})
case NodeTypeTerminal:
if n.KindName == "" {
return json.Marshal(struct {
Type NodeType `json:"type"`
Text string `json:"text"`
Row int `json:"row"`
Col int `json:"col"`
}{
Type: n.Type,
Text: n.Text,
Row: n.Row,
Col: n.Col,
})
}
return json.Marshal(struct {
Type NodeType `json:"type"`
KindName string `json:"kind_name"`
Text string `json:"text"`
Row int `json:"row"`
Col int `json:"col"`
}{
Type: n.Type,
KindName: n.KindName,
Text: n.Text,
Row: n.Row,
Col: n.Col,
})
case NodeTypeNonTerminal:
return json.Marshal(struct {
Type NodeType `json:"type"`
KindName string `json:"kind_name"`
Children []*Node `json:"children"`
}{
Type: n.Type,
KindName: n.KindName,
Children: n.Children,
})
default:
return nil, fmt.Errorf("invalid node type: %v", n.Type)
}
}
// ChildCount is a implementation of SyntaxTreeNode.ChildCount.
func (n *Node) ChildCount() int {
return len(n.Children)
}
// ExpandChildren is a implementation of SyntaxTreeNode.ExpandChildren.
func (n *Node) ExpandChildren() []SyntaxTreeNode {
fs := make([]SyntaxTreeNode, len(n.Children))
for i, n := range n.Children {
fs[i] = n
}
return fs
}
// PrintTree prints a syntax tree whose root is `node`.
func PrintTree(w io.Writer, node *Node) {
printTree(w, node, "", "")
}
func printTree(w io.Writer, node *Node, ruledLine string, childRuledLinePrefix string) {
if node == nil {
return
}
switch node.Type {
case NodeTypeError:
fmt.Fprintf(w, "%v%v\n", ruledLine, node.KindName)
case NodeTypeTerminal:
fmt.Fprintf(w, "%v%v %v\n", ruledLine, node.KindName, strconv.Quote(node.Text))
case NodeTypeNonTerminal:
fmt.Fprintf(w, "%v%v\n", ruledLine, node.KindName)
num := len(node.Children)
for i, child := range node.Children {
var line string
if num > 1 && i < num-1 {
line = "├─ "
} else {
line = "└─ "
}
var prefix string
if i >= num-1 {
prefix = " "
} else {
prefix = "│ "
}
printTree(w, child, childRuledLinePrefix+line, childRuledLinePrefix+prefix)
}
}
}
type grammarImpl struct {
g *spec.CompiledGrammar
}
func NewGrammar(g *spec.CompiledGrammar) *grammarImpl {
return &grammarImpl{
g: g,
}
}
func (g *grammarImpl) InitialState() int {
return g.g.Syntactic.InitialState
}
func (g *grammarImpl) StartProduction() int {
return g.g.Syntactic.StartProduction
}
func (g *grammarImpl) RecoverProduction(prod int) bool {
return g.g.Syntactic.RecoverProductions[prod] != 0
}
func (g *grammarImpl) Action(state int, terminal int) int {
return g.g.Syntactic.Action[state*g.g.Syntactic.TerminalCount+terminal]
}
func (g *grammarImpl) GoTo(state int, lhs int) int {
return g.g.Syntactic.GoTo[state*g.g.Syntactic.NonTerminalCount+lhs]
}
func (g *grammarImpl) AlternativeSymbolCount(prod int) int {
return g.g.Syntactic.AlternativeSymbolCounts[prod]
}
func (g *grammarImpl) TerminalCount() int {
return g.g.Syntactic.TerminalCount
}
func (g *grammarImpl) SkipTerminal(terminal int) bool {
return g.g.Syntactic.TerminalSkip[terminal] == 1
}
func (g *grammarImpl) ErrorTrapperState(state int) bool {
return g.g.Syntactic.ErrorTrapperStates[state] != 0
}
func (g *grammarImpl) NonTerminal(nonTerminal int) string {
return g.g.Syntactic.NonTerminals[nonTerminal]
}
func (g *grammarImpl) LHS(prod int) int {
return g.g.Syntactic.LHSSymbols[prod]
}
func (g *grammarImpl) EOF() int {
return g.g.Syntactic.EOFSymbol
}
func (g *grammarImpl) Error() int {
return g.g.Syntactic.ErrorSymbol
}
func (g *grammarImpl) Terminal(terminal int) string {
return g.g.Syntactic.Terminals[terminal]
}
func (g *grammarImpl) ASTAction(prod int) []int {
return g.g.ASTAction.Entries[prod]
}
// go:embed parser.go
var parserCoreSrc string
// go:embed semantic_action.go
var semActSrc string
func GenParser(cgram *spec.CompiledGrammar, pkgName string) ([]byte, error) {
var parserSrc string
{
fset := goToken.NewFileSet()
f, err := parser.ParseFile(fset, "parser.go", parserCoreSrc, parser.ParseComments)
if err != nil {
return nil, err
}
var b strings.Builder
err = format.Node(&b, fset, f)
if err != nil {
return nil, err
}
parserSrc = b.String()
}
var grammarSrc string
{
t, err := template.New("").Funcs(genGrammarTemplateFuncs(cgram)).Parse(grammarSrcTmplate)
if err != nil {
return nil, err
}
var b strings.Builder
err = t.Execute(&b, map[string]interface{}{
"initialState": cgram.Syntactic.InitialState,
"startProduction": cgram.Syntactic.StartProduction,
"terminalCount": cgram.Syntactic.TerminalCount,
"nonTerminalCount": cgram.Syntactic.NonTerminalCount,
"eofSymbol": cgram.Syntactic.EOFSymbol,
"errorSymbol": cgram.Syntactic.ErrorSymbol,
})
if err != nil {
return nil, err
}
grammarSrc = b.String()
}
var lexerSrc string
{
t, err := template.New("").Funcs(genLexerTemplateFuncs(cgram)).Parse(lexerSrcTmplate)
if err != nil {
return nil, err
}
var b strings.Builder
err = t.Execute(&b, nil)
if err != nil {
return nil, err
}
lexerSrc = b.String()
}
var src string
{
tmpl := `// Code generated by vartan-go. DO NOT EDIT.
{{ .parserSrc }}
{{ .grammarSrc }}
{{ .lexerSrc }}
`
t, err := template.New("").Parse(tmpl)
if err != nil {
return nil, err
}
var b strings.Builder
err = t.Execute(&b, map[string]string{
"parserSrc": parserSrc,
"grammarSrc": grammarSrc,
"lexerSrc": lexerSrc,
})
if err != nil {
return nil, err
}
src = b.String()
}
fset := goToken.NewFileSet()
f, err := parser.ParseFile(fset, "", src, parser.ParseComments)
if err != nil {
return nil, err
}
f.Name = ast.NewIdent(pkgName)
// Complete an import statement.
for _, d := range f.Decls {
gd, ok := d.(*ast.GenDecl)
if !ok || gd.Tok != token.IMPORT {
continue
}
gd.Specs = append(gd.Specs, &ast.ImportSpec{
Path: &ast.BasicLit{
Value: `"io"`,
},
})
break
}
var b bytes.Buffer
err = format.Node(&b, fset, f)
if err != nil {
return nil, err
}
return b.Bytes(), nil
}
const grammarSrcTmplate = `
type grammarImpl struct {
recoverProductions []int
action []int
goTo []int
alternativeSymbolCounts []int
errorTrapperStates []int
nonTerminals []string
lhsSymbols []int
terminals []string
terminalSkip []int
astActions [][]int
}
func NewGrammar() *grammarImpl {
return &grammarImpl{
recoverProductions: {{ genRecoverProductions }},
action: {{ genAction }},
goTo: {{ genGoTo }},
alternativeSymbolCounts: {{ genAlternativeSymbolCounts }},
errorTrapperStates: {{ genErrorTrapperStates }},
nonTerminals: {{ genNonTerminals }},
lhsSymbols: {{ genLHSSymbols }},
terminals: {{ genTerminals }},
terminalSkip: {{ genTerminalSkip }},
astActions: {{ genASTActions }},
}
}
func (g *grammarImpl) InitialState() int {
return {{ .initialState }}
}
func (g *grammarImpl) StartProduction() int {
return {{ .startProduction }}
}
func (g *grammarImpl) RecoverProduction(prod int) bool {
return g.recoverProductions[prod] != 0
}
func (g *grammarImpl) Action(state int, terminal int) int {
return g.action[state*{{ .terminalCount }}+terminal]
}
func (g *grammarImpl) GoTo(state int, lhs int) int {
return g.goTo[state*{{ .nonTerminalCount }}+lhs]
}
func (g *grammarImpl) AlternativeSymbolCount(prod int) int {
return g.alternativeSymbolCounts[prod]
}
func (g *grammarImpl) TerminalCount() int {
return {{ .terminalCount }}
}
func (g *grammarImpl) SkipTerminal(terminal int) bool {
return g.terminalSkip[terminal] == 1
}
func (g *grammarImpl) ErrorTrapperState(state int) bool {
return g.errorTrapperStates[state] != 0
}
func (g *grammarImpl) NonTerminal(nonTerminal int) string {
return g.nonTerminals[nonTerminal]
}
func (g *grammarImpl) LHS(prod int) int {
return g.lhsSymbols[prod]
}
func (g *grammarImpl) EOF() int {
return {{ .eofSymbol }}
}
func (g *grammarImpl) Error() int {
return {{ .errorSymbol }}
}
func (g *grammarImpl) Terminal(terminal int) string {
return g.terminals[terminal]
}
func (g *grammarImpl) ASTAction(prod int) []int {
return g.astActions[prod]
}
`
func genGrammarTemplateFuncs(cgram *spec.CompiledGrammar) template.FuncMap {
return template.FuncMap{
"genRecoverProductions": func() string {
var b strings.Builder
fmt.Fprintf(&b, "[]int{\n")
c := 1
for _, v := range cgram.Syntactic.RecoverProductions {
fmt.Fprintf(&b, "%v, ", v)
if c == 20 {
fmt.Fprintf(&b, "\n")
c = 1
} else {
c++
}
}
if c > 1 {
fmt.Fprintf(&b, "\n")
}
fmt.Fprintf(&b, "}")
return b.String()
},
"genAction": func() string {
var b strings.Builder
fmt.Fprintf(&b, "[]int{\n")
c := 1
for _, v := range cgram.Syntactic.Action {
fmt.Fprintf(&b, "%v, ", v)
if c == 20 {
fmt.Fprintf(&b, "\n")
c = 1
} else {
c++
}
}
if c > 1 {
fmt.Fprintf(&b, "\n")
}
fmt.Fprintf(&b, "}")
return b.String()
},
"genGoTo": func() string {
var b strings.Builder
fmt.Fprintf(&b, "[]int{\n")
c := 1
for _, v := range cgram.Syntactic.GoTo {
fmt.Fprintf(&b, "%v, ", v)
if c == 20 {
fmt.Fprintf(&b, "\n")
c = 1
} else {
c++
}
}
if c > 1 {
fmt.Fprintf(&b, "\n")
}
fmt.Fprintf(&b, "}")
return b.String()
},
"genAlternativeSymbolCounts": func() string {
var b strings.Builder
fmt.Fprintf(&b, "[]int{\n")
c := 1
for _, v := range cgram.Syntactic.AlternativeSymbolCounts {
fmt.Fprintf(&b, "%v, ", v)
if c == 20 {
fmt.Fprintf(&b, "\n")
c = 1
} else {
c++
}
}
if c > 1 {
fmt.Fprintf(&b, "\n")
}
fmt.Fprintf(&b, "}")
return b.String()
},
"genErrorTrapperStates": func() string {
var b strings.Builder
fmt.Fprintf(&b, "[]int{\n")
c := 1
for _, v := range cgram.Syntactic.ErrorTrapperStates {
fmt.Fprintf(&b, "%v, ", v)
if c == 20 {
fmt.Fprintf(&b, "\n")
c = 1
} else {
c++
}
}
if c > 1 {
fmt.Fprintf(&b, "\n")
}
fmt.Fprintf(&b, "}")
return b.String()
},
"genNonTerminals": func() string {
var b strings.Builder
fmt.Fprintf(&b, "[]string{\n")
for _, v := range cgram.Syntactic.NonTerminals {
fmt.Fprintf(&b, "%v,\n", strconv.Quote(v))
}
fmt.Fprintf(&b, "}")
return b.String()
},
"genLHSSymbols": func() string {
var b strings.Builder
fmt.Fprintf(&b, "[]int{\n")
c := 1
for _, v := range cgram.Syntactic.LHSSymbols {
fmt.Fprintf(&b, "%v, ", v)
if c == 20 {
fmt.Fprintf(&b, "\n")
c = 1
} else {
c++
}
}
if c > 1 {
fmt.Fprintf(&b, "\n")
}
fmt.Fprintf(&b, "}")
return b.String()
},
"genTerminals": func() string {
var b strings.Builder
fmt.Fprintf(&b, "[]string{\n")
for _, v := range cgram.Syntactic.Terminals {
fmt.Fprintf(&b, "%v,\n", strconv.Quote(v))
}
fmt.Fprintf(&b, "}")
return b.String()
},
"genTerminalSkip": func() string {
var b strings.Builder
fmt.Fprintf(&b, "[]int{\n")
c := 1
for _, v := range cgram.Syntactic.TerminalSkip {
fmt.Fprintf(&b, "%v, ", v)
if c == 20 {
fmt.Fprintf(&b, "\n")
c = 1
} else {
c++
}
}
if c > 1 {
fmt.Fprintf(&b, "\n")
}
fmt.Fprintf(&b, "}")
return b.String()
},
"genASTActions": func() string {
var b strings.Builder
fmt.Fprintf(&b, "[][]int{\n")
for _, entries := range cgram.ASTAction.Entries {
if len(entries) == 0 {
fmt.Fprintf(&b, "nil,\n")
continue
}
fmt.Fprintf(&b, "{\n")
c := 1
for _, v := range entries {
fmt.Fprintf(&b, "%v, ", v)
if c == 20 {
fmt.Fprintf(&b, "\n")
c = 1
} else {
c++
}
}
if c > 1 {
fmt.Fprintf(&b, "\n")
}
fmt.Fprintf(&b, "},\n")
}
fmt.Fprintf(&b, "}")
return b.String()
},
}
}
const lexerSrcTmplate = `
type vToken struct {
terminalID int
tok *Token
}
func (t *vToken) TerminalID() int {
return t.terminalID
}
func (t *vToken) Lexeme() []byte {
return t.tok.Lexeme
}
func (t *vToken) EOF() bool {
return t.tok.EOF
}
func (t *vToken) Invalid() bool {
return t.tok.Invalid
}
func (t *vToken) BytePosition() (int, int) {
return t.tok.BytePos, t.tok.ByteLen
}
func (t *vToken) Position() (int, int) {
return t.tok.Row, t.tok.Col
}
var kindToTerminal = {{ genKindToTerminal }}
type tokenStream struct {
lex *Lexer
kindToTerminal []int
}
func NewTokenStream(src io.Reader) (*tokenStream, error) {
lex, err := NewLexer(NewLexSpec(), src)
if err != nil {
return nil, err
}
return &tokenStream{
lex: lex,
}, nil
}
func (t *tokenStream) Next() (VToken, error) {
tok, err := t.lex.Next()
if err != nil {
return nil, err
}
return &vToken{
terminalID: kindToTerminal[tok.KindID],
tok: tok,
}, nil
}
`
func genLexerTemplateFuncs(cgram *spec.CompiledGrammar) template.FuncMap {
return template.FuncMap{
"genKindToTerminal": func() string {
var b strings.Builder
fmt.Fprintf(&b, "[]int{\n")
c := 1
for _, v := range cgram.Syntactic.KindToTerminal {
fmt.Fprintf(&b, "%v, ", v)
if c == 20 {
fmt.Fprintf(&b, "\n")
c = 1
} else {
c++
}
}
if c > 1 {
fmt.Fprintf(&b, "\n")
}
fmt.Fprintf(&b, "}")
return b.String()
},
}
}
func GenSemanticAction(pkgName string) ([]byte, error) {
var src string
{
tmpl := `// Code generated by vartan-go. DO NOT EDIT.
{{ .semActSrc }}
`
t, err := template.New("").Parse(tmpl)
if err != nil {
return nil, err
}
var b strings.Builder
err = t.Execute(&b, map[string]string{
"semActSrc": semActSrc,
})
if err != nil {
return nil, err
}
src = b.String()
}
fset := goToken.NewFileSet()
f, err := parser.ParseFile(fset, "", src, parser.ParseComments)
if err != nil {
return nil, err
}
f.Name = ast.NewIdent(pkgName)
var b bytes.Buffer
err = format.Node(&b, fset, f)
if err != nil {
return nil, err
}
return b.Bytes(), nil
}
type vToken struct {
terminalID int
tok *lexer.Token
}
func (t *vToken) TerminalID() int {
return t.terminalID
}
func (t *vToken) Lexeme() []byte {
return t.tok.Lexeme
}
func (t *vToken) EOF() bool {
return t.tok.EOF
}
func (t *vToken) Invalid() bool {
return t.tok.Invalid
}
func (t *vToken) BytePosition() (int, int) {
return t.tok.BytePos, t.tok.ByteLen
}
func (t *vToken) Position() (int, int) {
return t.tok.Row, t.tok.Col
}
type tokenStream struct {
lex *lexer.Lexer
kindToTerminal []int
}
func NewTokenStream(g *spec.CompiledGrammar, src io.Reader) (TokenStream, error) {
lex, err := lexer.NewLexer(lexer.NewLexSpec(g.Lexical), src)
if err != nil {
return nil, err
}
return &tokenStream{
lex: lex,
kindToTerminal: g.Syntactic.KindToTerminal,
}, nil
}
func (l *tokenStream) Next() (VToken, error) {
tok, err := l.lex.Next()
if err != nil {
return nil, err
}
return &vToken{
terminalID: l.kindToTerminal[tok.KindID],
tok: tok,
}, nil
}
|