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
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
|
tokens:
- name: EOF
value: 1
comment: final token in the file
- name: MISSING
comment: "a token that was expected but not found"
- name: NOT_PROVIDED
comment: "a token that was not present but it is okay"
- name: AMPERSAND
comment: "&"
- name: AMPERSAND_AMPERSAND
comment: "&&"
- name: AMPERSAND_AMPERSAND_EQUAL
comment: "&&="
- name: AMPERSAND_DOT
comment: "&."
- name: AMPERSAND_EQUAL
comment: "&="
- name: BACKTICK
comment: "`"
- name: BACK_REFERENCE
comment: "a back reference"
- name: BANG
comment: "! or !@"
- name: BANG_EQUAL
comment: "!="
- name: BANG_TILDE
comment: "!~"
- name: BRACE_LEFT
comment: "{"
- name: BRACE_RIGHT
comment: "}"
- name: BRACKET_LEFT
comment: "["
- name: BRACKET_LEFT_ARRAY
comment: "[ for the beginning of an array"
- name: BRACKET_LEFT_RIGHT
comment: "[]"
- name: BRACKET_LEFT_RIGHT_EQUAL
comment: "[]="
- name: BRACKET_RIGHT
comment: "]"
- name: CARET
comment: "^"
- name: CARET_EQUAL
comment: "^="
- name: CHARACTER_LITERAL
comment: "a character literal"
- name: CLASS_VARIABLE
comment: "a class variable"
- name: COLON
comment: ":"
- name: COLON_COLON
comment: "::"
- name: COMMA
comment: ","
- name: COMMENT
comment: "a comment"
- name: CONSTANT
comment: "a constant"
- name: DOT
comment: "."
- name: DOT_DOT
comment: ".."
- name: DOT_DOT_DOT
comment: "..."
- name: EMBDOC_BEGIN
comment: "=begin"
- name: EMBDOC_END
comment: "=end"
- name: EMBDOC_LINE
comment: "a line inside of embedded documentation"
- name: EMBEXPR_BEGIN
comment: "#{"
- name: EMBEXPR_END
comment: "}"
- name: EMBVAR
comment: "#"
- name: EQUAL
comment: "="
- name: EQUAL_EQUAL
comment: "=="
- name: EQUAL_EQUAL_EQUAL
comment: "==="
- name: EQUAL_GREATER
comment: "=>"
- name: EQUAL_TILDE
comment: "=~"
- name: FLOAT
comment: "a floating point number"
- name: FLOAT_IMAGINARY
comment: "a floating pointer number with an imaginary suffix"
- name: FLOAT_RATIONAL
comment: "a floating pointer number with a rational suffix"
- name: FLOAT_RATIONAL_IMAGINARY
comment: "a floating pointer number with a rational and imaginary suffix"
- name: GLOBAL_VARIABLE
comment: "a global variable"
- name: GREATER
comment: ">"
- name: GREATER_EQUAL
comment: ">="
- name: GREATER_GREATER
comment: ">>"
- name: GREATER_GREATER_EQUAL
comment: ">>="
- name: HEREDOC_END
comment: "the end of a heredoc"
- name: HEREDOC_START
comment: "the start of a heredoc"
- name: IDENTIFIER
comment: "an identifier"
- name: IGNORED_NEWLINE
comment: "an ignored newline"
- name: INSTANCE_VARIABLE
comment: "an instance variable"
- name: INTEGER
comment: "an integer (any base)"
- name: INTEGER_IMAGINARY
comment: "an integer with an imaginary suffix"
- name: INTEGER_RATIONAL
comment: "an integer with a rational suffix"
- name: INTEGER_RATIONAL_IMAGINARY
comment: "an integer with a rational and imaginary suffix"
- name: KEYWORD_ALIAS
comment: "alias"
- name: KEYWORD_AND
comment: "and"
- name: KEYWORD_BEGIN
comment: "begin"
- name: KEYWORD_BEGIN_UPCASE
comment: "BEGIN"
- name: KEYWORD_BREAK
comment: "break"
- name: KEYWORD_CASE
comment: "case"
- name: KEYWORD_CLASS
comment: "class"
- name: KEYWORD_DEF
comment: "def"
- name: KEYWORD_DEFINED
comment: "defined?"
- name: KEYWORD_DO
comment: "do"
- name: KEYWORD_DO_LOOP
comment: "do keyword for a predicate in a while, until, or for loop"
- name: KEYWORD_ELSE
comment: "else"
- name: KEYWORD_ELSIF
comment: "elsif"
- name: KEYWORD_END
comment: "end"
- name: KEYWORD_END_UPCASE
comment: "END"
- name: KEYWORD_ENSURE
comment: "ensure"
- name: KEYWORD_FALSE
comment: "false"
- name: KEYWORD_FOR
comment: "for"
- name: KEYWORD_IF
comment: "if"
- name: KEYWORD_IF_MODIFIER
comment: "if in the modifier form"
- name: KEYWORD_IN
comment: "in"
- name: KEYWORD_MODULE
comment: "module"
- name: KEYWORD_NEXT
comment: "next"
- name: KEYWORD_NIL
comment: "nil"
- name: KEYWORD_NOT
comment: "not"
- name: KEYWORD_OR
comment: "or"
- name: KEYWORD_REDO
comment: "redo"
- name: KEYWORD_RESCUE
comment: "rescue"
- name: KEYWORD_RESCUE_MODIFIER
comment: "rescue in the modifier form"
- name: KEYWORD_RETRY
comment: "retry"
- name: KEYWORD_RETURN
comment: "return"
- name: KEYWORD_SELF
comment: "self"
- name: KEYWORD_SUPER
comment: "super"
- name: KEYWORD_THEN
comment: "then"
- name: KEYWORD_TRUE
comment: "true"
- name: KEYWORD_UNDEF
comment: "undef"
- name: KEYWORD_UNLESS
comment: "unless"
- name: KEYWORD_UNLESS_MODIFIER
comment: "unless in the modifier form"
- name: KEYWORD_UNTIL
comment: "until"
- name: KEYWORD_UNTIL_MODIFIER
comment: "until in the modifier form"
- name: KEYWORD_WHEN
comment: "when"
- name: KEYWORD_WHILE
comment: "while"
- name: KEYWORD_WHILE_MODIFIER
comment: "while in the modifier form"
- name: KEYWORD_YIELD
comment: "yield"
- name: KEYWORD___ENCODING__
comment: "__ENCODING__"
- name: KEYWORD___FILE__
comment: "__FILE__"
- name: KEYWORD___LINE__
comment: "__LINE__"
- name: LABEL
comment: "a label"
- name: LABEL_END
comment: "the end of a label"
- name: LAMBDA_BEGIN
comment: "{"
- name: LESS
comment: "<"
- name: LESS_EQUAL
comment: "<="
- name: LESS_EQUAL_GREATER
comment: "<=>"
- name: LESS_LESS
comment: "<<"
- name: LESS_LESS_EQUAL
comment: "<<="
- name: METHOD_NAME
comment: "a method name"
- name: MINUS
comment: "-"
- name: MINUS_EQUAL
comment: "-="
- name: MINUS_GREATER
comment: "->"
- name: NEWLINE
comment: "a newline character outside of other tokens"
- name: NUMBERED_REFERENCE
comment: "a numbered reference to a capture group in the previous regular expression match"
- name: PARENTHESIS_LEFT
comment: "("
- name: PARENTHESIS_LEFT_PARENTHESES
comment: "( for a parentheses node"
- name: PARENTHESIS_RIGHT
comment: ")"
- name: PERCENT
comment: "%"
- name: PERCENT_EQUAL
comment: "%="
- name: PERCENT_LOWER_I
comment: "%i"
- name: PERCENT_LOWER_W
comment: "%w"
- name: PERCENT_LOWER_X
comment: "%x"
- name: PERCENT_UPPER_I
comment: "%I"
- name: PERCENT_UPPER_W
comment: "%W"
- name: PIPE
comment: "|"
- name: PIPE_EQUAL
comment: "|="
- name: PIPE_PIPE
comment: "||"
- name: PIPE_PIPE_EQUAL
comment: "||="
- name: PLUS
comment: "+"
- name: PLUS_EQUAL
comment: "+="
- name: QUESTION_MARK
comment: "?"
- name: REGEXP_BEGIN
comment: "the beginning of a regular expression"
- name: REGEXP_END
comment: "the end of a regular expression"
- name: SEMICOLON
comment: ";"
- name: SLASH
comment: "/"
- name: SLASH_EQUAL
comment: "/="
- name: STAR
comment: "*"
- name: STAR_EQUAL
comment: "*="
- name: STAR_STAR
comment: "**"
- name: STAR_STAR_EQUAL
comment: "**="
- name: STRING_BEGIN
comment: "the beginning of a string"
- name: STRING_CONTENT
comment: "the contents of a string"
- name: STRING_END
comment: "the end of a string"
- name: SYMBOL_BEGIN
comment: "the beginning of a symbol"
- name: TILDE
comment: "~ or ~@"
- name: UAMPERSAND
comment: "unary &"
- name: UCOLON_COLON
comment: "unary ::"
- name: UDOT_DOT
comment: "unary .."
- name: UDOT_DOT_DOT
comment: "unary ..."
- name: UMINUS
comment: "-@"
- name: UMINUS_NUM
comment: "-@ for a number"
- name: UPLUS
comment: "+@"
- name: USTAR
comment: "unary *"
- name: USTAR_STAR
comment: "unary **"
- name: WORDS_SEP
comment: "a separator between words in a list"
- name: __END__
comment: "marker for the point in the file at which the parser should stop"
flags:
- name: ArgumentsNodeFlags
values:
- name: KEYWORD_SPLAT
comment: "if arguments contain keyword splat"
- name: CallNodeFlags
values:
- name: SAFE_NAVIGATION
comment: "&. operator"
- name: VARIABLE_CALL
comment: "a call that could have been a local variable"
- name: IntegerBaseFlags
values:
- name: BINARY
comment: "0b prefix"
- name: OCTAL
comment: "0o or 0 prefix"
- name: DECIMAL
comment: "0d or no prefix"
- name: HEXADECIMAL
comment: "0x prefix"
- name: LoopFlags
values:
- name: BEGIN_MODIFIER
comment: "a loop after a begin statement, so the body is executed first before the condition"
- name: RangeFlags
values:
- name: EXCLUDE_END
comment: "... operator"
- name: RegularExpressionFlags
values:
- name: IGNORE_CASE
comment: "i - ignores the case of characters when matching"
- name: EXTENDED
comment: "x - ignores whitespace and allows comments in regular expressions"
- name: MULTI_LINE
comment: "m - allows $ to match the end of lines within strings"
- name: ONCE
comment: "o - only interpolates values into the regular expression once"
- name: EUC_JP
comment: "e - forces the EUC-JP encoding"
- name: ASCII_8BIT
comment: "n - forces the ASCII-8BIT encoding"
- name: WINDOWS_31J
comment: "s - forces the Windows-31J encoding"
- name: UTF_8
comment: "u - forces the UTF-8 encoding"
- name: StringFlags
values:
- name: FROZEN
comment: "frozen by virtue of a `frozen_string_literal` comment"
nodes:
- name: AliasGlobalVariableNode
fields:
- name: new_name
type: node
- name: old_name
type: node
- name: keyword_loc
type: location
comment: |
Represents the use of the `alias` keyword to alias a global variable.
alias $foo $bar
^^^^^^^^^^^^^^^
- name: AliasMethodNode
fields:
- name: new_name
type: node
- name: old_name
type: node
- name: keyword_loc
type: location
comment: |
Represents the use of the `alias` keyword to alias a method.
alias foo bar
^^^^^^^^^^^^^
- name: AlternationPatternNode
fields:
- name: left
type: node
- name: right
type: node
- name: operator_loc
type: location
comment: |
Represents an alternation pattern in pattern matching.
foo => bar | baz
^^^^^^^^^
- name: AndNode
fields:
- name: left
type: node
- name: right
type: node
- name: operator_loc
type: location
comment: |
Represents the use of the `&&` operator or the `and` keyword.
left and right
^^^^^^^^^^^^^^
- name: ArgumentsNode
fields:
- name: arguments
type: node[]
- name: flags
type: flags
kind: ArgumentsNodeFlags
comment: |
Represents a set of arguments to a method or a keyword.
return foo, bar, baz
^^^^^^^^^^^^^
- name: ArrayNode
fields:
- name: elements
type: node[]
- name: opening_loc
type: location?
- name: closing_loc
type: location?
comment: |
Represents an array literal. This can be a regular array using brackets or
a special array using % like %w or %i.
[1, 2, 3]
^^^^^^^^^
- name: ArrayPatternNode
fields:
- name: constant
type: node?
- name: requireds
type: node[]
- name: rest
type: node?
- name: posts
type: node[]
- name: opening_loc
type: location?
- name: closing_loc
type: location?
comment: |
Represents an array pattern in pattern matching.
foo in 1, 2
^^^^^^^^^^^
foo in [1, 2]
^^^^^^^^^^^^^
foo in *1
^^^^^^^^^
foo in Bar[]
^^^^^^^^^^^^
foo in Bar[1, 2, 3]
^^^^^^^^^^^^^^^^^^^
- name: AssocNode
fields:
- name: key
type: node
- name: value
type: node?
- name: operator_loc
type: location?
comment: |
Represents a hash key/value pair.
{ a => b }
^^^^^^
- name: AssocSplatNode
fields:
- name: value
type: node?
- name: operator_loc
type: location
comment: |
Represents a splat in a hash literal.
{ **foo }
^^^^^
- name: BackReferenceReadNode
fields:
- name: name
type: constant
comment: |
Represents reading a reference to a field in the previous match.
$'
^^
- name: BeginNode
fields:
- name: begin_keyword_loc
type: location?
- name: statements
type: node?
kind: StatementsNode
- name: rescue_clause
type: node?
kind: RescueNode
- name: else_clause
type: node?
kind: ElseNode
- name: ensure_clause
type: node?
kind: EnsureNode
- name: end_keyword_loc
type: location?
newline: false
comment: |
Represents a begin statement.
begin
foo
end
^^^^^
- name: BlockArgumentNode
fields:
- name: expression
type: node?
- name: operator_loc
type: location
comment: |
Represents block method arguments.
bar(&args)
^^^^^^^^^^
- name: BlockLocalVariableNode
fields:
- name: name
type: constant
comment: |
Represents a block local variable.
a { |; b| }
^
- name: BlockNode
fields:
- name: locals
type: constant[]
- name: parameters
type: node?
kind: BlockParametersNode
- name: body
type: node?
- name: opening_loc
type: location
- name: closing_loc
type: location
comment: |
Represents a block of ruby code.
[1, 2, 3].each { |i| puts x }
^^^^^^^^^^^^^^
- name: BlockParameterNode
fields:
- name: name
type: constant?
- name: name_loc
type: location?
- name: operator_loc
type: location
comment: |
Represents a block parameter to a method, block, or lambda definition.
def a(&b)
^^
end
- name: BlockParametersNode
fields:
- name: parameters
type: node?
kind: ParametersNode
- name: locals
type: node[]
- name: opening_loc
type: location?
- name: closing_loc
type: location?
comment: |
Represents a block's parameters declaration.
-> (a, b = 1; local) { }
^^^^^^^^^^^^^^^^^
foo do |a, b = 1; local|
^^^^^^^^^^^^^^^^^
end
- name: BreakNode
fields:
- name: arguments
type: node?
kind: ArgumentsNode
- name: keyword_loc
type: location
comment: |
Represents the use of the `break` keyword.
break foo
^^^^^^^^^
- name: CallAndWriteNode
fields:
- name: receiver
type: node?
- name: call_operator_loc
type: location?
- name: message_loc
type: location?
- name: flags
type: flags
kind: CallNodeFlags
- name: read_name
type: constant
- name: write_name
type: constant
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents the use of the `&&=` operator on a call.
foo.bar &&= value
^^^^^^^^^^^^^^^^^
- name: CallNode
fields:
- name: receiver
type: node?
- name: call_operator_loc
type: location?
- name: message_loc
type: location?
- name: opening_loc
type: location?
- name: arguments
type: node?
kind: ArgumentsNode
- name: closing_loc
type: location?
- name: block
type: node?
- name: flags
type: flags
kind: CallNodeFlags
- name: name
type: constant
comment: |
Represents a method call, in all of the various forms that can take.
foo
^^^
foo()
^^^^^
+foo
^^^^
foo + bar
^^^^^^^^^
foo.bar
^^^^^^^
foo&.bar
^^^^^^^^
- name: CallOperatorWriteNode
fields:
- name: receiver
type: node?
- name: call_operator_loc
type: location?
- name: message_loc
type: location?
- name: flags
type: flags
kind: CallNodeFlags
- name: read_name
type: constant
- name: write_name
type: constant
- name: operator
type: constant
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents the use of an assignment operator on a call.
foo.bar += baz
^^^^^^^^^^^^^^
- name: CallOrWriteNode
fields:
- name: receiver
type: node?
- name: call_operator_loc
type: location?
- name: message_loc
type: location?
- name: flags
type: flags
kind: CallNodeFlags
- name: read_name
type: constant
- name: write_name
type: constant
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents the use of the `||=` operator on a call.
foo.bar ||= value
^^^^^^^^^^^^^^^^^
- name: CapturePatternNode
fields:
- name: value
type: node
- name: target
type: node
- name: operator_loc
type: location
comment: |
Represents assigning to a local variable in pattern matching.
foo => [bar => baz]
^^^^^^^^^^^^
- name: CaseNode
fields:
- name: predicate
type: node?
- name: conditions
type: node[]
- name: consequent
type: node?
kind: ElseNode
- name: case_keyword_loc
type: location
- name: end_keyword_loc
type: location
comment: |
Represents the use of a case statement.
case true
^^^^^^^^^
when false
end
- name: ClassNode
fields:
- name: locals
type: constant[]
- name: class_keyword_loc
type: location
- name: constant_path
type: node
- name: inheritance_operator_loc
type: location?
- name: superclass
type: node?
- name: body
type: node?
- name: end_keyword_loc
type: location
- name: name
type: constant
comment: |
Represents a class declaration involving the `class` keyword.
class Foo end
^^^^^^^^^^^^^
- name: ClassVariableAndWriteNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents the use of the `&&=` operator for assignment to a class variable.
@@target &&= value
^^^^^^^^^^^^^^^^
- name: ClassVariableOperatorWriteNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: operator_loc
type: location
- name: value
type: node
- name: operator
type: constant
comment: |
Represents assigning to a class variable using an operator that isn't `=`.
@@target += value
^^^^^^^^^^^^^^^^^
- name: ClassVariableOrWriteNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents the use of the `||=` operator for assignment to a class variable.
@@target ||= value
^^^^^^^^^^^^^^^^^^
- name: ClassVariableReadNode
fields:
- name: name
type: constant
comment: |
Represents referencing a class variable.
@@foo
^^^^^
- name: ClassVariableTargetNode
fields:
- name: name
type: constant
comment: |
Represents writing to a class variable in a context that doesn't have an explicit value.
@@foo, @@bar = baz
^^^^^ ^^^^^
- name: ClassVariableWriteNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: value
type: node
- name: operator_loc
type: location?
comment: |
Represents writing to a class variable.
@@foo = 1
^^^^^^^^^
- name: ConstantAndWriteNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents the use of the `&&=` operator for assignment to a constant.
Target &&= value
^^^^^^^^^^^^^^^^
- name: ConstantOperatorWriteNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: operator_loc
type: location
- name: value
type: node
- name: operator
type: constant
comment: |
Represents assigning to a constant using an operator that isn't `=`.
Target += value
^^^^^^^^^^^^^^^
- name: ConstantOrWriteNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents the use of the `||=` operator for assignment to a constant.
Target ||= value
^^^^^^^^^^^^^^^^
- name: ConstantPathAndWriteNode
fields:
- name: target
type: node
kind: ConstantPathNode
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents the use of the `&&=` operator for assignment to a constant path.
Parent::Child &&= value
^^^^^^^^^^^^^^^^^^^^^^^
- name: ConstantPathNode
fields:
- name: parent
type: node?
- name: child
type: node
- name: delimiter_loc
type: location
comment: |
Represents accessing a constant through a path of `::` operators.
Foo::Bar
^^^^^^^^
- name: ConstantPathOperatorWriteNode
fields:
- name: target
type: node
kind: ConstantPathNode
- name: operator_loc
type: location
- name: value
type: node
- name: operator
type: constant
comment: |
Represents assigning to a constant path using an operator that isn't `=`.
Parent::Child += value
^^^^^^^^^^^^^^^^^^^^^^
- name: ConstantPathOrWriteNode
fields:
- name: target
type: node
kind: ConstantPathNode
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents the use of the `||=` operator for assignment to a constant path.
Parent::Child ||= value
^^^^^^^^^^^^^^^^^^^^^^^
- name: ConstantPathTargetNode
fields:
- name: parent
type: node?
- name: child
type: node
- name: delimiter_loc
type: location
comment: |
Represents writing to a constant path in a context that doesn't have an explicit value.
Foo::Foo, Bar::Bar = baz
^^^^^^^^ ^^^^^^^^
- name: ConstantPathWriteNode
fields:
- name: target
type: node
kind: ConstantPathNode
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents writing to a constant path.
::Foo = 1
^^^^^^^^^
Foo::Bar = 1
^^^^^^^^^^^^
::Foo::Bar = 1
^^^^^^^^^^^^^^
- name: ConstantReadNode
fields:
- name: name
type: constant
comment: |
Represents referencing a constant.
Foo
^^^
- name: ConstantTargetNode
fields:
- name: name
type: constant
comment: |
Represents writing to a constant in a context that doesn't have an explicit value.
Foo, Bar = baz
^^^ ^^^
- name: ConstantWriteNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: value
type: node
- name: operator_loc
type: location
comment: |
Represents writing to a constant.
Foo = 1
^^^^^^^
- name: DefNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: receiver
type: node?
- name: parameters
type: node?
kind: ParametersNode
- name: body
type: node?
- name: locals
type: constant[]
- name: def_keyword_loc
type: location
- name: operator_loc
type: location?
- name: lparen_loc
type: location?
- name: rparen_loc
type: location?
- name: equal_loc
type: location?
- name: end_keyword_loc
type: location?
comment: |
Represents a method definition.
def method
end
^^^^^^^^^^
- name: DefinedNode
fields:
- name: lparen_loc
type: location?
- name: value
type: node
- name: rparen_loc
type: location?
- name: keyword_loc
type: location
comment: |
Represents the use of the `defined?` keyword.
defined?(a)
^^^^^^^^^^^
- name: ElseNode
fields:
- name: else_keyword_loc
type: location
- name: statements
type: node?
kind: StatementsNode
- name: end_keyword_loc
type: location?
comment: |
Represents an `else` clause in a `case`, `if`, or `unless` statement.
if a then b else c end
^^^^^^^^^^
- name: EmbeddedStatementsNode
fields:
- name: opening_loc
type: location
- name: statements
type: node?
kind: StatementsNode
- name: closing_loc
type: location
comment: |
Represents an interpolated set of statements.
"foo #{bar}"
^^^^^^
- name: EmbeddedVariableNode
fields:
- name: operator_loc
type: location
- name: variable
type: node
comment: |
Represents an interpolated variable.
"foo #@bar"
^^^^^
- name: EnsureNode
fields:
- name: ensure_keyword_loc
type: location
- name: statements
type: node?
kind: StatementsNode
- name: end_keyword_loc
type: location
comment: |
Represents an `ensure` clause in a `begin` statement.
begin
foo
ensure
^^^^^^
bar
end
- name: FalseNode
comment: |
Represents the use of the literal `false` keyword.
false
^^^^^
- name: FindPatternNode
fields:
- name: constant
type: node?
- name: left
type: node
- name: requireds
type: node[]
- name: right
type: node
- name: opening_loc
type: location?
- name: closing_loc
type: location?
comment: |
Represents a find pattern in pattern matching.
foo in *bar, baz, *qux
^^^^^^^^^^^^^^^^^^^^^^
foo in [*bar, baz, *qux]
^^^^^^^^^^^^^^^^^^^^^^^^
foo in Foo(*bar, baz, *qux)
^^^^^^^^^^^^^^^^^^^^^^^^^^^
- name: FlipFlopNode
fields:
- name: left
type: node?
- name: right
type: node?
- name: operator_loc
type: location
- name: flags
type: flags
kind: RangeFlags
comment: |
Represents the use of the `..` or `...` operators to create flip flops.
baz if foo .. bar
^^^^^^^^^^
- name: FloatNode
comment: |
Represents a floating point number literal.
1.0
^^^
- name: ForNode
fields:
- name: index
type: node
- name: collection
type: node
- name: statements
type: node?
kind: StatementsNode
- name: for_keyword_loc
type: location
- name: in_keyword_loc
type: location
- name: do_keyword_loc
type: location?
- name: end_keyword_loc
type: location
comment: |
Represents the use of the `for` keyword.
for i in a end
^^^^^^^^^^^^^^
- name: ForwardingArgumentsNode
comment: |
Represents forwarding all arguments to this method to another method.
def foo(...)
bar(...)
^^^^^^^^
end
- name: ForwardingParameterNode
comment: |
Represents the use of the forwarding parameter in a method, block, or lambda declaration.
def foo(...)
^^^
end
- name: ForwardingSuperNode
fields:
- name: block
type: node?
kind: BlockNode
comment: |
Represents the use of the `super` keyword without parentheses or arguments.
super
^^^^^
- name: GlobalVariableAndWriteNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents the use of the `&&=` operator for assignment to a global variable.
$target &&= value
^^^^^^^^^^^^^^^^^
- name: GlobalVariableOperatorWriteNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: operator_loc
type: location
- name: value
type: node
- name: operator
type: constant
comment: |
Represents assigning to a global variable using an operator that isn't `=`.
$target += value
^^^^^^^^^^^^^^^^
- name: GlobalVariableOrWriteNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents the use of the `||=` operator for assignment to a global variable.
$target ||= value
^^^^^^^^^^^^^^^^^
- name: GlobalVariableReadNode
fields:
- name: name
type: constant
comment: |
Represents referencing a global variable.
$foo
^^^^
- name: GlobalVariableTargetNode
fields:
- name: name
type: constant
comment: |
Represents writing to a global variable in a context that doesn't have an explicit value.
$foo, $bar = baz
^^^^ ^^^^
- name: GlobalVariableWriteNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: value
type: node
- name: operator_loc
type: location
comment: |
Represents writing to a global variable.
$foo = 1
^^^^^^^^
- name: HashNode
fields:
- name: opening_loc
type: location
- name: elements
type: node[]
- name: closing_loc
type: location
comment: |
Represents a hash literal.
{ a => b }
^^^^^^^^^^
- name: HashPatternNode
fields:
- name: constant
type: node?
- name: assocs
type: node[]
- name: kwrest
type: node?
- name: opening_loc
type: location?
- name: closing_loc
type: location?
comment: |
Represents a hash pattern in pattern matching.
foo => { a: 1, b: 2 }
^^^^^^^^^^^^^^
foo => { a: 1, b: 2, **c }
^^^^^^^^^^^^^^^^^^^
- name: IfNode
fields:
- name: if_keyword_loc
type: location?
- name: predicate
type: node
- name: statements
type: node?
kind: StatementsNode
- name: consequent
type: node?
- name: end_keyword_loc
type: location?
newline: predicate
comment: |
Represents the use of the `if` keyword, either in the block form or the modifier form.
bar if foo
^^^^^^^^^^
if foo then bar end
^^^^^^^^^^^^^^^^^^^
- name: ImaginaryNode
fields:
- name: numeric
type: node
comment: |
Represents an imaginary number literal.
1.0i
^^^^
- name: ImplicitNode
fields:
- name: value
type: node
comment: |
Represents a node that is implicitly being added to the tree but doesn't
correspond directly to a node in the source.
{ foo: }
^^^^
{ Foo: }
^^^^
- name: InNode
fields:
- name: pattern
type: node
- name: statements
type: node?
kind: StatementsNode
- name: in_loc
type: location
- name: then_loc
type: location?
comment: |
Represents the use of the `in` keyword in a case statement.
case a; in b then c end
^^^^^^^^^^^
- name: IndexAndWriteNode
fields:
- name: receiver
type: node?
- name: call_operator_loc
type: location?
- name: opening_loc
type: location
- name: arguments
type: node?
kind: ArgumentsNode
- name: closing_loc
type: location
- name: block
type: node?
- name: flags
type: flags
kind: CallNodeFlags
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents the use of the `&&=` operator on a call to the `[]` method.
foo.bar[baz] &&= value
^^^^^^^^^^^^^^^^^^^^^^
- name: IndexOperatorWriteNode
fields:
- name: receiver
type: node?
- name: call_operator_loc
type: location?
- name: opening_loc
type: location
- name: arguments
type: node?
kind: ArgumentsNode
- name: closing_loc
type: location
- name: block
type: node?
- name: flags
type: flags
kind: CallNodeFlags
- name: operator
type: constant
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents the use of an assignment operator on a call to `[]`.
foo.bar[baz] += value
^^^^^^^^^^^^^^^^^^^^^
- name: IndexOrWriteNode
fields:
- name: receiver
type: node?
- name: call_operator_loc
type: location?
- name: opening_loc
type: location
- name: arguments
type: node?
kind: ArgumentsNode
- name: closing_loc
type: location
- name: block
type: node?
- name: flags
type: flags
kind: CallNodeFlags
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents the use of the `||=` operator on a call to `[]`.
foo.bar[baz] ||= value
^^^^^^^^^^^^^^^^^^^^^^
- name: InstanceVariableAndWriteNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents the use of the `&&=` operator for assignment to an instance variable.
@target &&= value
^^^^^^^^^^^^^^^^^
- name: InstanceVariableOperatorWriteNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: operator_loc
type: location
- name: value
type: node
- name: operator
type: constant
comment: |
Represents assigning to an instance variable using an operator that isn't `=`.
@target += value
^^^^^^^^^^^^^^^^
- name: InstanceVariableOrWriteNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents the use of the `||=` operator for assignment to an instance variable.
@target ||= value
^^^^^^^^^^^^^^^^^
- name: InstanceVariableReadNode
fields:
- name: name
type: constant
comment: |
Represents referencing an instance variable.
@foo
^^^^
- name: InstanceVariableTargetNode
fields:
- name: name
type: constant
comment: |
Represents writing to an instance variable in a context that doesn't have an explicit value.
@foo, @bar = baz
^^^^ ^^^^
- name: InstanceVariableWriteNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: value
type: node
- name: operator_loc
type: location
comment: |
Represents writing to an instance variable.
@foo = 1
^^^^^^^^
- name: IntegerNode
fields:
- name: flags
type: flags
kind: IntegerBaseFlags
comment: |
Represents an integer number literal.
1
^
- name: InterpolatedMatchLastLineNode
fields:
- name: opening_loc
type: location
- name: parts
type: node[]
- name: closing_loc
type: location
- name: flags
type: flags
kind: RegularExpressionFlags
newline: parts
comment: |
Represents a regular expression literal that contains interpolation that
is being used in the predicate of a conditional to implicitly match
against the last line read by an IO object.
if /foo #{bar} baz/ then end
^^^^^^^^^^^^^^^^
- name: InterpolatedRegularExpressionNode
fields:
- name: opening_loc
type: location
- name: parts
type: node[]
- name: closing_loc
type: location
- name: flags
type: flags
kind: RegularExpressionFlags
newline: parts
comment: |
Represents a regular expression literal that contains interpolation.
/foo #{bar} baz/
^^^^^^^^^^^^^^^^
- name: InterpolatedStringNode
fields:
- name: opening_loc
type: location?
- name: parts
type: node[]
- name: closing_loc
type: location?
newline: parts
comment: |
Represents a string literal that contains interpolation.
"foo #{bar} baz"
^^^^^^^^^^^^^^^^
- name: InterpolatedSymbolNode
fields:
- name: opening_loc
type: location?
- name: parts
type: node[]
- name: closing_loc
type: location?
newline: parts
comment: |
Represents a symbol literal that contains interpolation.
:"foo #{bar} baz"
^^^^^^^^^^^^^^^^^
- name: InterpolatedXStringNode
fields:
- name: opening_loc
type: location
- name: parts
type: node[]
- name: closing_loc
type: location
newline: parts
comment: |
Represents an xstring literal that contains interpolation.
`foo #{bar} baz`
^^^^^^^^^^^^^^^^
- name: KeywordHashNode
fields:
- name: elements
type: node[]
comment: |
Represents a hash literal without opening and closing braces.
foo(a: b)
^^^^
- name: KeywordParameterNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: value
type: node?
comment: |
Represents a keyword parameter to a method, block, or lambda definition.
def a(b:)
^^
end
def a(b: 1)
^^^^
end
- name: KeywordRestParameterNode
fields:
- name: name
type: constant?
- name: name_loc
type: location?
- name: operator_loc
type: location
comment: |
Represents a keyword rest parameter to a method, block, or lambda definition.
def a(**b)
^^^
end
- name: LambdaNode
fields:
- name: locals
type: constant[]
- name: operator_loc
type: location
- name: opening_loc
type: location
- name: closing_loc
type: location
- name: parameters
type: node?
kind: BlockParametersNode
- name: body
type: node?
comment: |
Represents using a lambda literal (not the lambda method call).
->(value) { value * 2 }
^^^^^^^^^^^^^^^^^^^^^^^
- name: LocalVariableAndWriteNode
fields:
- name: name_loc
type: location
- name: operator_loc
type: location
- name: value
type: node
- name: name
type: constant
- name: depth
type: uint32
comment: |
Represents the use of the `&&=` operator for assignment to a local variable.
target &&= value
^^^^^^^^^^^^^^^^
- name: LocalVariableOperatorWriteNode
fields:
- name: name_loc
type: location
- name: operator_loc
type: location
- name: value
type: node
- name: name
type: constant
- name: operator
type: constant
- name: depth
type: uint32
comment: |
Represents assigning to a local variable using an operator that isn't `=`.
target += value
^^^^^^^^^^^^^^^
- name: LocalVariableOrWriteNode
fields:
- name: name_loc
type: location
- name: operator_loc
type: location
- name: value
type: node
- name: name
type: constant
- name: depth
type: uint32
comment: |
Represents the use of the `||=` operator for assignment to a local variable.
target ||= value
^^^^^^^^^^^^^^^^
- name: LocalVariableReadNode
fields:
- name: name
type: constant
- name: depth
type: uint32
comment: |
Represents reading a local variable. Note that this requires that a local
variable of the same name has already been written to in the same scope,
otherwise it is parsed as a method call.
foo
^^^
- name: LocalVariableTargetNode
fields:
- name: name
type: constant
- name: depth
type: uint32
comment: |
Represents writing to a local variable in a context that doesn't have an explicit value.
foo, bar = baz
^^^ ^^^
- name: LocalVariableWriteNode
fields:
- name: name
type: constant
- name: depth
type: uint32
- name: name_loc
type: location
- name: value
type: node
- name: operator_loc
type: location
comment: |
Represents writing to a local variable.
foo = 1
^^^^^^^
- name: MatchLastLineNode
fields:
- name: opening_loc
type: location
- name: content_loc
type: location
- name: closing_loc
type: location
- name: unescaped
type: string
- name: flags
type: flags
kind: RegularExpressionFlags
comment: |
Represents a regular expression literal used in the predicate of a
conditional to implicitly match against the last line read by an IO
object.
if /foo/i then end
^^^^^^
- name: MatchPredicateNode
fields:
- name: value
type: node
- name: pattern
type: node
- name: operator_loc
type: location
comment: |
Represents the use of the modifier `in` operator.
foo in bar
^^^^^^^^^^
- name: MatchRequiredNode
fields:
- name: value
type: node
- name: pattern
type: node
- name: operator_loc
type: location
comment: |
Represents the use of the `=>` operator.
foo => bar
^^^^^^^^^^
- name: MatchWriteNode
fields:
- name: call
type: node
kind: CallNode
- name: locals
type: constant[]
comment: |
Represents writing local variables using a regular expression match with
named capture groups.
/(?<foo>bar)/ =~ baz
^^^^^^^^^^^^^^^^^^^^
- name: MissingNode
comment: |
Represents a node that is missing from the source and results in a syntax
error.
- name: ModuleNode
fields:
- name: locals
type: constant[]
- name: module_keyword_loc
type: location
- name: constant_path
type: node
- name: body
type: node?
- name: end_keyword_loc
type: location
- name: name
type: constant
comment: |
Represents a module declaration involving the `module` keyword.
module Foo end
^^^^^^^^^^^^^^
- name: MultiTargetNode
fields:
- name: requireds
type: node[]
- name: rest
type: node?
- name: posts
type: node[]
- name: lparen_loc
type: location?
- name: rparen_loc
type: location?
comment: |
Represents a multi-target expression.
a, (b, c) = 1, 2, 3
^^^^^^
- name: MultiWriteNode
fields:
- name: requireds
type: node[]
- name: rest
type: node?
- name: posts
type: node[]
- name: lparen_loc
type: location?
- name: rparen_loc
type: location?
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents a write to a multi-target expression.
a, b, c = 1, 2, 3
^^^^^^^^^^^^^^^^^
- name: NextNode
fields:
- name: arguments
type: node?
kind: ArgumentsNode
- name: keyword_loc
type: location
comment: |
Represents the use of the `next` keyword.
next 1
^^^^^^
- name: NilNode
comment: |
Represents the use of the `nil` keyword.
nil
^^^
- name: NoKeywordsParameterNode
fields:
- name: operator_loc
type: location
- name: keyword_loc
type: location
comment: |
Represents the use of `**nil` inside method arguments.
def a(**nil)
^^^^^
end
- name: NumberedReferenceReadNode
fields:
- name: number
type: uint32
comment: |
Represents reading a numbered reference to a capture in the previous match.
$1
^^
- name: OptionalParameterNode
fields:
- name: name
type: constant
- name: name_loc
type: location
- name: operator_loc
type: location
- name: value
type: node
comment: |
Represents an optional parameter to a method, block, or lambda definition.
def a(b = 1)
^^^^^
end
- name: OrNode
fields:
- name: left
type: node
- name: right
type: node
- name: operator_loc
type: location
comment: |
Represents the use of the `||` operator or the `or` keyword.
left or right
^^^^^^^^^^^^^
- name: ParametersNode
fields:
- name: requireds
type: node[]
- name: optionals
type: node[]
- name: rest
type: node?
kind: RestParameterNode
- name: posts
type: node[]
- name: keywords
type: node[]
- name: keyword_rest
type: node?
- name: block
type: node?
kind: BlockParameterNode
comment: |
Represents the list of parameters on a method, block, or lambda definition.
def a(b, c, d)
^^^^^^^
end
- name: ParenthesesNode
fields:
- name: body
type: node?
- name: opening_loc
type: location
- name: closing_loc
type: location
newline: false
comment: |
Represents a parenthesized expression
(10 + 34)
^^^^^^^^^
- name: PinnedExpressionNode
fields:
- name: expression
type: node
- name: operator_loc
type: location
- name: lparen_loc
type: location
- name: rparen_loc
type: location
comment: |
Represents the use of the `^` operator for pinning an expression in a
pattern matching expression.
foo in ^(bar)
^^^^^^
- name: PinnedVariableNode
fields:
- name: variable
type: node
- name: operator_loc
type: location
comment: |
Represents the use of the `^` operator for pinning a variable in a pattern
matching expression.
foo in ^bar
^^^^
- name: PostExecutionNode
fields:
- name: statements
type: node?
kind: StatementsNode
- name: keyword_loc
type: location
- name: opening_loc
type: location
- name: closing_loc
type: location
comment: |
Represents the use of the `END` keyword.
END { foo }
^^^^^^^^^^^
- name: PreExecutionNode
fields:
- name: statements
type: node?
kind: StatementsNode
- name: keyword_loc
type: location
- name: opening_loc
type: location
- name: closing_loc
type: location
comment: |
Represents the use of the `BEGIN` keyword.
BEGIN { foo }
^^^^^^^^^^^^^
- name: ProgramNode
fields:
- name: locals
type: constant[]
- name: statements
type: node
kind: StatementsNode
comment: The top level node of any parse tree.
- name: RangeNode
fields:
- name: left
type: node?
- name: right
type: node?
- name: operator_loc
type: location
- name: flags
type: flags
kind: RangeFlags
comment: |
Represents the use of the `..` or `...` operators.
1..2
^^^^
c if a =~ /left/ ... b =~ /right/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- name: RationalNode
fields:
- name: numeric
type: node
comment: |
Represents a rational number literal.
1.0r
^^^^
- name: RedoNode
comment: |
Represents the use of the `redo` keyword.
redo
^^^^
- name: RegularExpressionNode
fields:
- name: opening_loc
type: location
- name: content_loc
type: location
- name: closing_loc
type: location
- name: unescaped
type: string
- name: flags
type: flags
kind: RegularExpressionFlags
comment: |
Represents a regular expression literal with no interpolation.
/foo/i
^^^^^^
- name: RequiredParameterNode
fields:
- name: name
type: constant
comment: |
Represents a required parameter to a method, block, or lambda definition.
def a(b)
^
end
- name: RescueModifierNode
fields:
- name: expression
type: node
- name: keyword_loc
type: location
- name: rescue_expression
type: node
newline: expression
comment: |
Represents an expression modified with a rescue.
foo rescue nil
^^^^^^^^^^^^^^
- name: RescueNode
fields:
- name: keyword_loc
type: location
- name: exceptions
type: node[]
- name: operator_loc
type: location?
- name: reference
type: node?
- name: statements
type: node?
kind: StatementsNode
- name: consequent
type: node?
kind: RescueNode
comment: |
Represents a rescue statement.
begin
rescue Foo, *splat, Bar => ex
^^^^^^
foo
end
`Foo, *splat, Bar` are in the `exceptions` field.
`ex` is in the `exception` field.
- name: RestParameterNode
fields:
- name: name
type: constant?
- name: name_loc
type: location?
- name: operator_loc
type: location
comment: |
Represents a rest parameter to a method, block, or lambda definition.
def a(*b)
^^
end
- name: RetryNode
comment: |
Represents the use of the `retry` keyword.
retry
^^^^^
- name: ReturnNode
fields:
- name: keyword_loc
type: location
- name: arguments
type: node?
kind: ArgumentsNode
comment: |
Represents the use of the `return` keyword.
return 1
^^^^^^^^
- name: SelfNode
comment: |
Represents the `self` keyword.
self
^^^^
- name: SingletonClassNode
fields:
- name: locals
type: constant[]
- name: class_keyword_loc
type: location
- name: operator_loc
type: location
- name: expression
type: node
- name: body
type: node?
- name: end_keyword_loc
type: location
comment: |
Represents a singleton class declaration involving the `class` keyword.
class << self end
^^^^^^^^^^^^^^^^^
- name: SourceEncodingNode
comment: |
Represents the use of the `__ENCODING__` keyword.
__ENCODING__
^^^^^^^^^^^^
- name: SourceFileNode
fields:
- name: filepath
type: string
comment: |
Represents the use of the `__FILE__` keyword.
__FILE__
^^^^^^^^
- name: SourceLineNode
comment: |
Represents the use of the `__LINE__` keyword.
__LINE__
^^^^^^^^
- name: SplatNode
fields:
- name: operator_loc
type: location
- name: expression
type: node?
comment: |
Represents the use of the splat operator.
[*a]
^^
- name: StatementsNode
fields:
- name: body
type: node[]
comment: |
Represents a set of statements contained within some scope.
foo; bar; baz
^^^^^^^^^^^^^
- name: StringConcatNode
fields:
- name: left
type: node
- name: right
type: node
comment: |
Represents the use of compile-time string concatenation.
"foo" "bar"
^^^^^^^^^^^
- name: StringNode
fields:
- name: flags
type: flags
kind: StringFlags
- name: opening_loc
type: location?
- name: content_loc
type: location
- name: closing_loc
type: location?
- name: unescaped
type: string
comment: |
Represents a string literal, a string contained within a `%w` list, or
plain string content within an interpolated string.
"foo"
^^^^^
%w[foo]
^^^
"foo #{bar} baz"
^^^^ ^^^^
- name: SuperNode
fields:
- name: keyword_loc
type: location
- name: lparen_loc
type: location?
- name: arguments
type: node?
kind: ArgumentsNode
- name: rparen_loc
type: location?
- name: block
type: node?
comment: |
Represents the use of the `super` keyword with parentheses or arguments.
super()
^^^^^^^
super foo, bar
^^^^^^^^^^^^^^
- name: SymbolNode
fields:
- name: opening_loc
type: location?
- name: value_loc
type: location?
- name: closing_loc
type: location?
- name: unescaped
type: string
comment: |
Represents a symbol literal or a symbol contained within a `%i` list.
:foo
^^^^
%i[foo]
^^^
- name: TrueNode
comment: |
Represents the use of the literal `true` keyword.
true
^^^^
- name: UndefNode
fields:
- name: names
type: node[]
- name: keyword_loc
type: location
comment: |
Represents the use of the `undef` keyword.
undef :foo, :bar, :baz
^^^^^^^^^^^^^^^^^^^^^^
- name: UnlessNode
fields:
- name: keyword_loc
type: location
- name: predicate
type: node
- name: statements
type: node?
kind: StatementsNode
- name: consequent
type: node?
kind: ElseNode
- name: end_keyword_loc
type: location?
newline: predicate
comment: |
Represents the use of the `unless` keyword, either in the block form or the modifier form.
bar unless foo
^^^^^^^^^^^^^^
unless foo then bar end
^^^^^^^^^^^^^^^^^^^^^^^
- name: UntilNode
fields:
- name: keyword_loc
type: location
- name: closing_loc
type: location?
- name: predicate
type: node
- name: statements
type: node?
kind: StatementsNode
- name: flags
type: flags
kind: LoopFlags
newline: predicate
comment: |
Represents the use of the `until` keyword, either in the block form or the modifier form.
bar until foo
^^^^^^^^^^^^^
until foo do bar end
^^^^^^^^^^^^^^^^^^^^
- name: WhenNode
fields:
- name: keyword_loc
type: location
- name: conditions
type: node[]
- name: statements
type: node?
kind: StatementsNode
comment: |
Represents the use of the `when` keyword within a case statement.
case true
when true
^^^^^^^^^
end
- name: WhileNode
fields:
- name: keyword_loc
type: location
- name: closing_loc
type: location?
- name: predicate
type: node
- name: statements
type: node?
kind: StatementsNode
- name: flags
type: flags
kind: LoopFlags
newline: predicate
comment: |
Represents the use of the `while` keyword, either in the block form or the modifier form.
bar while foo
^^^^^^^^^^^^^
while foo do bar end
^^^^^^^^^^^^^^^^^^^^
- name: XStringNode
fields:
- name: opening_loc
type: location
- name: content_loc
type: location
- name: closing_loc
type: location
- name: unescaped
type: string
comment: |
Represents an xstring literal with no interpolation.
`foo`
^^^^^
- name: YieldNode
fields:
- name: keyword_loc
type: location
- name: lparen_loc
type: location?
- name: arguments
type: node?
kind: ArgumentsNode
- name: rparen_loc
type: location?
comment: |
Represents the use of the `yield` keyword.
yield 1
^^^^^^^
|