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
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
| | ;;; js.el --- Major mode for editing JavaScript -*- lexical-binding: t -*-
;; Copyright (C) 2008-2015 Free Software Foundation, Inc.
;; Author: Karl Landstrom <karl.landstrom@brgeight.se>
;; Daniel Colascione <dan.colascione@gmail.com>
;; Maintainer: Daniel Colascione <dan.colascione@gmail.com>
;; Version: 9
;; Date: 2009-07-25
;; Keywords: languages, javascript
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary
;; This is based on Karl Landstrom's barebones javascript-mode. This
;; is much more robust and works with cc-mode's comment filling
;; (mostly).
;;
;; The main features of this JavaScript mode are syntactic
;; highlighting (enabled with `font-lock-mode' or
;; `global-font-lock-mode'), automatic indentation and filling of
;; comments, C preprocessor fontification, and MozRepl integration.
;;
;; General Remarks:
;;
;; XXX: This mode assumes that block comments are not nested inside block
;; XXX: comments
;;
;; Exported names start with "js-"; private names start with
;; "js--".
;;; Code:
(require 'cc-mode)
(require 'newcomment)
(require 'thingatpt) ; forward-symbol etc
(require 'imenu)
(require 'moz nil t)
(require 'json nil t)
(require 'sgml-mode)
(eval-when-compile
(require 'cl-lib)
(require 'ido))
(defvar inferior-moz-buffer)
(defvar moz-repl-name)
(defvar ido-cur-list)
(defvar electric-layout-rules)
(declare-function ido-mode "ido")
(declare-function inferior-moz-process "ext:mozrepl" ())
;;; Constants
(defconst js--name-start-re "[a-zA-Z_$]"
"Regexp matching the start of a JavaScript identifier, without grouping.")
(defconst js--stmt-delim-chars "^;{}?:")
(defconst js--name-re (concat js--name-start-re
"\\(?:\\s_\\|\\sw\\)*")
"Regexp matching a JavaScript identifier, without grouping.")
(defconst js--objfield-re (concat js--name-re ":")
"Regexp matching the start of a JavaScript object field.")
(defconst js--dotted-name-re
(concat js--name-re "\\(?:\\." js--name-re "\\)*")
"Regexp matching a dot-separated sequence of JavaScript names.")
(defconst js--cpp-name-re js--name-re
"Regexp matching a C preprocessor name.")
(defconst js--opt-cpp-start "^\\s-*#\\s-*\\([[:alnum:]]+\\)"
"Regexp matching the prefix of a cpp directive.
This includes the directive name, or nil in languages without
preprocessor support. The first submatch surrounds the directive
name.")
(defconst js--plain-method-re
(concat "^\\s-*?\\(" js--dotted-name-re "\\)\\.prototype"
"\\.\\(" js--name-re "\\)\\s-*?=\\s-*?\\(function\\)\\_>")
"Regexp matching an explicit JavaScript prototype \"method\" declaration.
Group 1 is a (possibly-dotted) class name, group 2 is a method name,
and group 3 is the 'function' keyword.")
(defconst js--plain-class-re
(concat "^\\s-*\\(" js--dotted-name-re "\\)\\.prototype"
"\\s-*=\\s-*{")
"Regexp matching a JavaScript explicit prototype \"class\" declaration.
An example of this is \"Class.prototype = { method1: ...}\".")
;; var NewClass = BaseClass.extend(
(defconst js--mp-class-decl-re
(concat "^\\s-*var\\s-+"
"\\(" js--name-re "\\)"
"\\s-*=\\s-*"
"\\(" js--dotted-name-re
"\\)\\.extend\\(?:Final\\)?\\s-*(\\s-*{?\\s-*$"))
;; var NewClass = Class.create()
(defconst js--prototype-obsolete-class-decl-re
(concat "^\\s-*\\(?:var\\s-+\\)?"
"\\(" js--dotted-name-re "\\)"
"\\s-*=\\s-*Class\\.create()"))
(defconst js--prototype-objextend-class-decl-re-1
(concat "^\\s-*Object\\.extend\\s-*("
"\\(" js--dotted-name-re "\\)"
"\\s-*,\\s-*{"))
(defconst js--prototype-objextend-class-decl-re-2
(concat "^\\s-*\\(?:var\\s-+\\)?"
"\\(" js--dotted-name-re "\\)"
"\\s-*=\\s-*Object\\.extend\\s-*("))
;; var NewClass = Class.create({
(defconst js--prototype-class-decl-re
(concat "^\\s-*\\(?:var\\s-+\\)?"
"\\(" js--name-re "\\)"
"\\s-*=\\s-*Class\\.create\\s-*(\\s-*"
"\\(?:\\(" js--dotted-name-re "\\)\\s-*,\\s-*\\)?{?"))
;; Parent class name(s) (yes, multiple inheritance in JavaScript) are
;; matched with dedicated font-lock matchers
(defconst js--dojo-class-decl-re
(concat "^\\s-*dojo\\.declare\\s-*(\"\\(" js--dotted-name-re "\\)"))
(defconst js--extjs-class-decl-re-1
(concat "^\\s-*Ext\\.extend\\s-*("
"\\s-*\\(" js--dotted-name-re "\\)"
"\\s-*,\\s-*\\(" js--dotted-name-re "\\)")
"Regexp matching an ExtJS class declaration (style 1).")
(defconst js--extjs-class-decl-re-2
(concat "^\\s-*\\(?:var\\s-+\\)?"
"\\(" js--name-re "\\)"
"\\s-*=\\s-*Ext\\.extend\\s-*(\\s-*"
"\\(" js--dotted-name-re "\\)")
"Regexp matching an ExtJS class declaration (style 2).")
(defconst js--mochikit-class-re
(concat "^\\s-*MochiKit\\.Base\\.update\\s-*(\\s-*"
"\\(" js--dotted-name-re "\\)")
"Regexp matching a MochiKit class declaration.")
(defconst js--dummy-class-style
'(:name "[Automatically Generated Class]"))
(defconst js--class-styles
`((:name "Plain"
:class-decl ,js--plain-class-re
:prototype t
:contexts (toplevel)
:framework javascript)
(:name "MochiKit"
:class-decl ,js--mochikit-class-re
:prototype t
:contexts (toplevel)
:framework mochikit)
(:name "Prototype (Obsolete)"
:class-decl ,js--prototype-obsolete-class-decl-re
:contexts (toplevel)
:framework prototype)
(:name "Prototype (Modern)"
:class-decl ,js--prototype-class-decl-re
:contexts (toplevel)
:framework prototype)
(:name "Prototype (Object.extend)"
:class-decl ,js--prototype-objextend-class-decl-re-1
:prototype t
:contexts (toplevel)
:framework prototype)
(:name "Prototype (Object.extend) 2"
:class-decl ,js--prototype-objextend-class-decl-re-2
:prototype t
:contexts (toplevel)
:framework prototype)
(:name "Dojo"
:class-decl ,js--dojo-class-decl-re
:contexts (toplevel)
:framework dojo)
(:name "ExtJS (style 1)"
:class-decl ,js--extjs-class-decl-re-1
:prototype t
:contexts (toplevel)
:framework extjs)
(:name "ExtJS (style 2)"
:class-decl ,js--extjs-class-decl-re-2
:contexts (toplevel)
:framework extjs)
(:name "Merrill Press"
:class-decl ,js--mp-class-decl-re
:contexts (toplevel)
:framework merrillpress))
"List of JavaScript class definition styles.
A class definition style is a plist with the following keys:
:name is a human-readable name of the class type
:class-decl is a regular expression giving the start of the
class. Its first group must match the name of its class. If there
is a parent class, the second group should match, and it should be
the name of the class.
If :prototype is present and non-nil, the parser will merge
declarations for this constructs with others at the same lexical
level that have the same name. Otherwise, multiple definitions
will create multiple top-level entries. Don't use :prototype
unnecessarily: it has an associated cost in performance.
If :strip-prototype is present and non-nil, then if the class
name as matched contains
")
(defconst js--available-frameworks
(cl-loop for style in js--class-styles
for framework = (plist-get style :framework)
unless (memq framework available-frameworks)
collect framework into available-frameworks
finally return available-frameworks)
"List of available JavaScript frameworks symbols.")
(defconst js--function-heading-1-re
(concat
"^\\s-*function\\(?:\\s-\\|\\*\\)+\\(" js--name-re "\\)")
"Regexp matching the start of a JavaScript function header.
Match group 1 is the name of the function.")
(defconst js--function-heading-2-re
(concat
"^\\s-*\\(" js--name-re "\\)\\s-*:\\s-*function\\_>")
"Regexp matching the start of a function entry in an associative array.
Match group 1 is the name of the function.")
(defconst js--function-heading-3-re
(concat
"^\\s-*\\(?:var\\s-+\\)?\\(" js--dotted-name-re "\\)"
"\\s-*=\\s-*function\\_>")
"Regexp matching a line in the JavaScript form \"var MUMBLE = function\".
Match group 1 is MUMBLE.")
(defconst js--macro-decl-re
(concat "^\\s-*#\\s-*define\\s-+\\(" js--cpp-name-re "\\)\\s-*(")
"Regexp matching a CPP macro definition, up to the opening parenthesis.
Match group 1 is the name of the macro.")
(defun js--regexp-opt-symbol (list)
"Like `regexp-opt', but surround the result with `\\\\_<' and `\\\\_>'."
(concat "\\_<" (regexp-opt list t) "\\_>"))
(defconst js--keyword-re
(js--regexp-opt-symbol
'("abstract" "break" "case" "catch" "class" "const"
"continue" "debugger" "default" "delete" "do" "else"
"enum" "export" "extends" "final" "finally" "for"
"function" "goto" "if" "implements" "import" "in"
"instanceof" "interface" "native" "new" "package"
"private" "protected" "public" "return" "static"
"super" "switch" "synchronized" "throw"
"throws" "transient" "try" "typeof" "var" "void" "let"
"yield" "volatile" "while" "with"))
"Regexp matching any JavaScript keyword.")
(defconst js--basic-type-re
(js--regexp-opt-symbol
'("boolean" "byte" "char" "double" "float" "int" "long"
"short" "void"))
"Regular expression matching any predefined type in JavaScript.")
(defconst js--constant-re
(js--regexp-opt-symbol '("false" "null" "undefined"
"Infinity" "NaN"
"true" "arguments" "this"))
"Regular expression matching any future reserved words in JavaScript.")
(defconst js--font-lock-keywords-1
(list
"\\_<import\\_>"
(list js--function-heading-1-re 1 font-lock-function-name-face)
(list js--function-heading-2-re 1 font-lock-function-name-face))
"Level one font lock keywords for `js-mode'.")
(defconst js--font-lock-keywords-2
(append js--font-lock-keywords-1
(list (list js--keyword-re 1 font-lock-keyword-face)
(list "\\_<for\\_>"
"\\s-+\\(each\\)\\_>" nil nil
(list 1 'font-lock-keyword-face))
(cons js--basic-type-re font-lock-type-face)
(cons js--constant-re font-lock-constant-face)))
"Level two font lock keywords for `js-mode'.")
;; js--pitem is the basic building block of the lexical
;; database. When one refers to a real part of the buffer, the region
;; of text to which it refers is split into a conceptual header and
;; body. Consider the (very short) block described by a hypothetical
;; js--pitem:
;;
;; function foo(a,b,c) { return 42; }
;; ^ ^ ^
;; | | |
;; +- h-begin +- h-end +- b-end
;;
;; (Remember that these are buffer positions, and therefore point
;; between characters, not at them. An arrow drawn to a character
;; indicates the corresponding position is between that character and
;; the one immediately preceding it.)
;;
;; The header is the region of text [h-begin, h-end], and is
;; the text needed to unambiguously recognize the start of the
;; construct. If the entire header is not present, the construct is
;; not recognized at all. No other pitems may be nested inside the
;; header.
;;
;; The body is the region [h-end, b-end]. It may contain nested
;; js--pitem instances. The body of a pitem may be empty: in
;; that case, b-end is equal to header-end.
;;
;; The three points obey the following relationship:
;;
;; h-begin < h-end <= b-end
;;
;; We put a text property in the buffer on the character *before*
;; h-end, and if we see it, on the character *before* b-end.
;;
;; The text property for h-end, js--pstate, is actually a list
;; of all js--pitem instances open after the marked character.
;;
;; The text property for b-end, js--pend, is simply the
;; js--pitem that ends after the marked character. (Because
;; pitems always end when the paren-depth drops below a critical
;; value, and because we can only drop one level per character, only
;; one pitem may end at a given character.)
;;
;; In the structure below, we only store h-begin and (sometimes)
;; b-end. We can trivially and quickly find h-end by going to h-begin
;; and searching for an js--pstate text property. Since no other
;; js--pitem instances can be nested inside the header of a
;; pitem, the location after the character with this text property
;; must be h-end.
;;
;; js--pitem instances are never modified (with the exception
;; of the b-end field). Instead, modified copies are added at
;; subsequence parse points.
;; (The exception for b-end and its caveats is described below.)
;;
(cl-defstruct (js--pitem (:type list))
;; IMPORTANT: Do not alter the position of fields within the list.
;; Various bits of code depend on their positions, particularly
;; anything that manipulates the list of children.
;; List of children inside this pitem's body
(children nil :read-only t)
;; When we reach this paren depth after h-end, the pitem ends
(paren-depth nil :read-only t)
;; Symbol or class-style plist if this is a class
(type nil :read-only t)
;; See above
(h-begin nil :read-only t)
;; List of strings giving the parts of the name of this pitem (e.g.,
;; '("MyClass" "myMethod"), or t if this pitem is anonymous
(name nil :read-only t)
;; THIS FIELD IS MUTATED, and its value is shared by all copies of
;; this pitem: when we copy-and-modify pitem instances, we share
;; their tail structures, so all the copies actually have the same
;; terminating cons cell. We modify that shared cons cell directly.
;;
;; The field value is either a number (buffer location) or nil if
;; unknown.
;;
;; If the field's value is greater than `js--cache-end', the
;; value is stale and must be treated as if it were nil. Conversely,
;; if this field is nil, it is guaranteed that this pitem is open up
;; to at least `js--cache-end'. (This property is handy when
;; computing whether we're inside a given pitem.)
;;
(b-end nil))
;; The pitem we start parsing with.
(defconst js--initial-pitem
(make-js--pitem
:paren-depth most-negative-fixnum
:type 'toplevel))
;;; User Customization
(defgroup js nil
"Customization variables for JavaScript mode."
:tag "JavaScript"
:group 'languages)
(defcustom js-indent-level 4
"Number of spaces for each indentation step in `js-mode'."
:type 'integer
:safe 'integerp
:group 'js)
(defcustom js-expr-indent-offset 0
"Number of additional spaces for indenting continued expressions.
The value must be no less than minus `js-indent-level'."
:type 'integer
:safe 'integerp
:group 'js)
(defcustom js-paren-indent-offset 0
"Number of additional spaces for indenting expressions in parentheses.
The value must be no less than minus `js-indent-level'."
:type 'integer
:safe 'integerp
:group 'js
:version "24.1")
(defcustom js-square-indent-offset 0
"Number of additional spaces for indenting expressions in square braces.
The value must be no less than minus `js-indent-level'."
:type 'integer
:safe 'integerp
:group 'js
:version "24.1")
(defcustom js-curly-indent-offset 0
"Number of additional spaces for indenting expressions in curly braces.
The value must be no less than minus `js-indent-level'."
:type 'integer
:safe 'integerp
:group 'js
:version "24.1")
(defcustom js-switch-indent-offset 0
"Number of additional spaces for indenting the contents of a switch block.
The value must not be negative."
:type 'integer
:safe 'integerp
:group 'js
:version "24.4")
(defcustom js-flat-functions nil
"Treat nested functions as top-level functions in `js-mode'.
This applies to function movement, marking, and so on."
:type 'boolean
:group 'js)
(defcustom js-comment-lineup-func #'c-lineup-C-comments
"Lineup function for `cc-mode-style', for C comments in `js-mode'."
:type 'function
:group 'js)
(defcustom js-enabled-frameworks js--available-frameworks
"Frameworks recognized by `js-mode'.
To improve performance, you may turn off some frameworks you
seldom use, either globally or on a per-buffer basis."
:type (cons 'set (mapcar (lambda (x)
(list 'const x))
js--available-frameworks))
:group 'js)
(defcustom js-js-switch-tabs
(and (memq system-type '(darwin)) t)
"Whether `js-mode' should display tabs while selecting them.
This is useful only if the windowing system has a good mechanism
for preventing Firefox from stealing the keyboard focus."
:type 'boolean
:group 'js)
(defcustom js-js-tmpdir
"~/.emacs.d/js/js"
"Temporary directory used by `js-mode' to communicate with Mozilla.
This directory must be readable and writable by both Mozilla and Emacs."
:type 'directory
:group 'js)
(defcustom js-js-timeout 5
"Reply timeout for executing commands in Mozilla via `js-mode'.
The value is given in seconds. Increase this value if you are
getting timeout messages."
:type 'integer
:group 'js)
(defcustom js-indent-first-init nil
"Non-nil means specially indent the first variable declaration's initializer.
Normally, the first declaration's initializer is unindented, and
subsequent declarations have their identifiers aligned with it:
var o = {
foo: 3
};
var o = {
foo: 3
},
bar = 2;
If this option has the value t, indent the first declaration's
initializer by an additional level:
var o = {
foo: 3
};
var o = {
foo: 3
},
bar = 2;
If this option has the value `dynamic', if there is only one declaration,
don't indent the first one's initializer; otherwise, indent it.
var o = {
foo: 3
};
var o = {
foo: 3
},
bar = 2;"
:version "25.1"
:type '(choice (const nil) (const t) (const dynamic))
:safe 'symbolp
:group 'js)
;;; KeyMap
(defvar js-mode-map
(let ((keymap (make-sparse-keymap)))
(define-key keymap [(control ?c) (meta ?:)] #'js-eval)
(define-key keymap [(control ?c) (control ?j)] #'js-set-js-context)
(define-key keymap [(control meta ?x)] #'js-eval-defun)
(define-key keymap [(meta ?.)] #'js-find-symbol)
(easy-menu-define nil keymap "Javascript Menu"
'("Javascript"
["Select New Mozilla Context..." js-set-js-context
(fboundp #'inferior-moz-process)]
["Evaluate Expression in Mozilla Context..." js-eval
(fboundp #'inferior-moz-process)]
["Send Current Function to Mozilla..." js-eval-defun
(fboundp #'inferior-moz-process)]))
keymap)
"Keymap for `js-mode'.")
;;; Syntax table and parsing
(defvar js-mode-syntax-table
(let ((table (make-syntax-table)))
(c-populate-syntax-table table)
(modify-syntax-entry ?$ "_" table)
(modify-syntax-entry ?` "\"" table)
table)
"Syntax table for `js-mode'.")
(defvar js--quick-match-re nil
"Autogenerated regexp used by `js-mode' to match buffer constructs.")
(defvar js--quick-match-re-func nil
"Autogenerated regexp used by `js-mode' to match constructs and functions.")
(make-variable-buffer-local 'js--quick-match-re)
(make-variable-buffer-local 'js--quick-match-re-func)
(defvar js--cache-end 1
"Last valid buffer position for the `js-mode' function cache.")
(make-variable-buffer-local 'js--cache-end)
(defvar js--last-parse-pos nil
"Latest parse position reached by `js--ensure-cache'.")
(make-variable-buffer-local 'js--last-parse-pos)
(defvar js--state-at-last-parse-pos nil
"Parse state at `js--last-parse-pos'.")
(make-variable-buffer-local 'js--state-at-last-parse-pos)
(defun js--flatten-list (list)
(cl-loop for item in list
nconc (cond ((consp item)
(js--flatten-list item))
(item (list item)))))
(defun js--maybe-join (prefix separator suffix &rest list)
"Helper function for `js--update-quick-match-re'.
If LIST contains any element that is not nil, return its non-nil
elements, separated by SEPARATOR, prefixed by PREFIX, and ended
with SUFFIX as with `concat'. Otherwise, if LIST is empty, return
nil. If any element in LIST is itself a list, flatten that
element."
(setq list (js--flatten-list list))
(when list
(concat prefix (mapconcat #'identity list separator) suffix)))
(defun js--update-quick-match-re ()
"Internal function used by `js-mode' for caching buffer constructs.
This updates `js--quick-match-re', based on the current set of
enabled frameworks."
(setq js--quick-match-re
(js--maybe-join
"^[ \t]*\\(?:" "\\|" "\\)"
;; #define mumble
"#define[ \t]+[a-zA-Z_]"
(when (memq 'extjs js-enabled-frameworks)
"Ext\\.extend")
(when (memq 'prototype js-enabled-frameworks)
"Object\\.extend")
;; var mumble = THING (
(js--maybe-join
"\\(?:var[ \t]+\\)?[a-zA-Z_$0-9.]+[ \t]*=[ \t]*\\(?:"
"\\|"
"\\)[ \t]*("
(when (memq 'prototype js-enabled-frameworks)
"Class\\.create")
(when (memq 'extjs js-enabled-frameworks)
"Ext\\.extend")
(when (memq 'merrillpress js-enabled-frameworks)
"[a-zA-Z_$0-9]+\\.extend\\(?:Final\\)?"))
(when (memq 'dojo js-enabled-frameworks)
"dojo\\.declare[ \t]*(")
(when (memq 'mochikit js-enabled-frameworks)
"MochiKit\\.Base\\.update[ \t]*(")
;; mumble.prototypeTHING
(js--maybe-join
"[a-zA-Z_$0-9.]+\\.prototype\\(?:" "\\|" "\\)"
(when (memq 'javascript js-enabled-frameworks)
'( ;; foo.prototype.bar = function(
"\\.[a-zA-Z_$0-9]+[ \t]*=[ \t]*function[ \t]*("
;; mumble.prototype = {
"[ \t]*=[ \t]*{")))))
(setq js--quick-match-re-func
(concat "function\\|" js--quick-match-re)))
(defun js--forward-text-property (propname)
"Move over the next value of PROPNAME in the buffer.
If found, return that value and leave point after the character
having that value; otherwise, return nil and leave point at EOB."
(let ((next-value (get-text-property (point) propname)))
(if next-value
(forward-char)
(goto-char (next-single-property-change
(point) propname nil (point-max)))
(unless (eobp)
(setq next-value (get-text-property (point) propname))
(forward-char)))
next-value))
(defun js--backward-text-property (propname)
"Move over the previous value of PROPNAME in the buffer.
If found, return that value and leave point just before the
character that has that value, otherwise return nil and leave
point at BOB."
(unless (bobp)
(let ((prev-value (get-text-property (1- (point)) propname)))
(if prev-value
(backward-char)
(goto-char (previous-single-property-change
(point) propname nil (point-min)))
(unless (bobp)
(backward-char)
(setq prev-value (get-text-property (point) propname))))
prev-value)))
(defsubst js--forward-pstate ()
(js--forward-text-property 'js--pstate))
(defsubst js--backward-pstate ()
(js--backward-text-property 'js--pstate))
(defun js--pitem-goto-h-end (pitem)
(goto-char (js--pitem-h-begin pitem))
(js--forward-pstate))
(defun js--re-search-forward-inner (regexp &optional bound count)
"Helper function for `js--re-search-forward'."
(let ((parse)
str-terminator
(orig-macro-end (save-excursion
(when (js--beginning-of-macro)
(c-end-of-macro)
(point)))))
(while (> count 0)
(re-search-forward regexp bound)
(setq parse (syntax-ppss))
(cond ((setq str-terminator (nth 3 parse))
(when (eq str-terminator t)
(setq str-terminator ?/))
(re-search-forward
(concat "\\([^\\]\\|^\\)" (string str-terminator))
(point-at-eol) t))
((nth 7 parse)
(forward-line))
((or (nth 4 parse)
(and (eq (char-before) ?\/) (eq (char-after) ?\*)))
(re-search-forward "\\*/"))
((and (not (and orig-macro-end
(<= (point) orig-macro-end)))
(js--beginning-of-macro))
(c-end-of-macro))
(t
(setq count (1- count))))))
(point))
(defun js--re-search-forward (regexp &optional bound noerror count)
"Search forward, ignoring strings, cpp macros, and comments.
This function invokes `re-search-forward', but treats the buffer
as if strings, cpp macros, and comments have been removed.
If invoked while inside a macro, it treats the contents of the
macro as normal text."
(unless count (setq count 1))
(let ((saved-point (point))
(search-fun
(cond ((< count 0) (setq count (- count))
#'js--re-search-backward-inner)
((> count 0) #'js--re-search-forward-inner)
(t #'ignore))))
(condition-case err
(funcall search-fun regexp bound count)
(search-failed
(goto-char saved-point)
(unless noerror
(signal (car err) (cdr err)))))))
(defun js--re-search-backward-inner (regexp &optional bound count)
"Auxiliary function for `js--re-search-backward'."
(let ((parse)
str-terminator
(orig-macro-start
(save-excursion
(and (js--beginning-of-macro)
(point)))))
(while (> count 0)
(re-search-backward regexp bound)
(when (and (> (point) (point-min))
(save-excursion (backward-char) (looking-at "/[/*]")))
(forward-char))
(setq parse (syntax-ppss))
(cond ((setq str-terminator (nth 3 parse))
(when (eq str-terminator t)
(setq str-terminator ?/))
(re-search-backward
(concat "\\([^\\]\\|^\\)" (string str-terminator))
(point-at-bol) t))
((nth 7 parse)
(goto-char (nth 8 parse)))
((or (nth 4 parse)
(and (eq (char-before) ?/) (eq (char-after) ?*)))
(re-search-backward "/\\*"))
((and (not (and orig-macro-start
(>= (point) orig-macro-start)))
(js--beginning-of-macro)))
(t
(setq count (1- count))))))
(point))
(defun js--re-search-backward (regexp &optional bound noerror count)
"Search backward, ignoring strings, preprocessor macros, and comments.
This function invokes `re-search-backward' but treats the buffer
as if strings, preprocessor macros, and comments have been
removed.
If invoked while inside a macro, treat the macro as normal text."
(js--re-search-forward regexp bound noerror (if count (- count) -1)))
(defun js--forward-expression ()
"Move forward over a whole JavaScript expression.
This function doesn't move over expressions continued across
lines."
(cl-loop
;; non-continued case; simplistic, but good enough?
do (cl-loop until (or (eolp)
(progn
(forward-comment most-positive-fixnum)
(memq (char-after) '(?\, ?\; ?\] ?\) ?\}))))
do (forward-sexp))
while (and (eq (char-after) ?\n)
(save-excursion
(forward-char)
(js--continued-expression-p)))))
(defun js--forward-function-decl ()
"Move forward over a JavaScript function declaration.
This puts point at the 'function' keyword.
If this is a syntactically-correct non-expression function,
return the name of the function, or t if the name could not be
determined. Otherwise, return nil."
(cl-assert (looking-at "\\_<function\\_>"))
(let ((name t))
(forward-word)
(forward-comment most-positive-fixnum)
(when (eq (char-after) ?*)
(forward-char)
(forward-comment most-positive-fixnum))
(when (looking-at js--name-re)
(setq name (match-string-no-properties 0))
(goto-char (match-end 0)))
(forward-comment most-positive-fixnum)
(and (eq (char-after) ?\( )
(ignore-errors (forward-list) t)
(progn (forward-comment most-positive-fixnum)
(and (eq (char-after) ?{)
name)))))
(defun js--function-prologue-beginning (&optional pos)
"Return the start of the JavaScript function prologue containing POS.
A function prologue is everything from start of the definition up
to and including the opening brace. POS defaults to point.
If POS is not in a function prologue, return nil."
(let (prologue-begin)
(save-excursion
(if pos
(goto-char pos)
(setq pos (point)))
(when (save-excursion
(forward-line 0)
(or (looking-at js--function-heading-2-re)
(looking-at js--function-heading-3-re)))
(setq prologue-begin (match-beginning 1))
(when (<= prologue-begin pos)
(goto-char (match-end 0))))
(skip-syntax-backward "w_")
(and (or (looking-at "\\_<function\\_>")
(js--re-search-backward "\\_<function\\_>" nil t))
(save-match-data (goto-char (match-beginning 0))
(js--forward-function-decl))
(<= pos (point))
(or prologue-begin (match-beginning 0))))))
(defun js--beginning-of-defun-raw ()
"Helper function for `js-beginning-of-defun'.
Go to previous defun-beginning and return the parse state for it,
or nil if we went all the way back to bob and don't find
anything."
(js--ensure-cache)
(let (pstate)
(while (and (setq pstate (js--backward-pstate))
(not (eq 'function (js--pitem-type (car pstate))))))
(and (not (bobp)) pstate)))
(defun js--pstate-is-toplevel-defun (pstate)
"Helper function for `js--beginning-of-defun-nested'.
If PSTATE represents a non-empty top-level defun, return the
top-most pitem. Otherwise, return nil."
(cl-loop for pitem in pstate
with func-depth = 0
with func-pitem
if (eq 'function (js--pitem-type pitem))
do (cl-incf func-depth)
and do (setq func-pitem pitem)
finally return (if (eq func-depth 1) func-pitem)))
(defun js--beginning-of-defun-nested ()
"Helper function for `js--beginning-of-defun'.
Return the pitem of the function we went to the beginning of."
(or
;; Look for the smallest function that encloses point...
(cl-loop for pitem in (js--parse-state-at-point)
if (and (eq 'function (js--pitem-type pitem))
(js--inside-pitem-p pitem))
do (goto-char (js--pitem-h-begin pitem))
and return pitem)
;; ...and if that isn't found, look for the previous top-level
;; defun
(cl-loop for pstate = (js--backward-pstate)
while pstate
if (js--pstate-is-toplevel-defun pstate)
do (goto-char (js--pitem-h-begin it))
and return it)))
(defun js--beginning-of-defun-flat ()
"Helper function for `js-beginning-of-defun'."
(let ((pstate (js--beginning-of-defun-raw)))
(when pstate
(goto-char (js--pitem-h-begin (car pstate))))))
(defun js-beginning-of-defun (&optional arg)
"Value of `beginning-of-defun-function' for `js-mode'."
(setq arg (or arg 1))
(while (and (not (eobp)) (< arg 0))
(cl-incf arg)
(when (and (not js-flat-functions)
(or (eq (js-syntactic-context) 'function)
(js--function-prologue-beginning)))
(js-end-of-defun))
(if (js--re-search-forward
"\\_<function\\_>" nil t)
(goto-char (js--function-prologue-beginning))
(goto-char (point-max))))
(while (> arg 0)
(cl-decf arg)
;; If we're just past the end of a function, the user probably wants
;; to go to the beginning of *that* function
(when (eq (char-before) ?})
(backward-char))
(let ((prologue-begin (js--function-prologue-beginning)))
(cond ((and prologue-begin (< prologue-begin (point)))
(goto-char prologue-begin))
(js-flat-functions
(js--beginning-of-defun-flat))
(t
(js--beginning-of-defun-nested))))))
(defun js--flush-caches (&optional beg ignored)
"Flush the `js-mode' syntax cache after position BEG.
BEG defaults to `point-min', meaning to flush the entire cache."
(interactive)
(setq beg (or beg (save-restriction (widen) (point-min))))
(setq js--cache-end (min js--cache-end beg)))
(defmacro js--debug (&rest _arguments)
;; `(message ,@arguments)
)
(defun js--ensure-cache--pop-if-ended (open-items paren-depth)
(let ((top-item (car open-items)))
(when (<= paren-depth (js--pitem-paren-depth top-item))
(cl-assert (not (get-text-property (1- (point)) 'js-pend)))
(put-text-property (1- (point)) (point) 'js--pend top-item)
(setf (js--pitem-b-end top-item) (point))
(setq open-items
;; open-items must contain at least two items for this to
;; work, but because we push a dummy item to start with,
;; that assumption holds.
(cons (js--pitem-add-child (cl-second open-items) top-item)
(cddr open-items)))))
open-items)
(defmacro js--ensure-cache--update-parse ()
"Helper function for `js--ensure-cache'.
Update parsing information up to point, referring to parse,
prev-parse-point, goal-point, and open-items bound lexically in
the body of `js--ensure-cache'."
`(progn
(setq goal-point (point))
(goto-char prev-parse-point)
(while (progn
(setq open-items (js--ensure-cache--pop-if-ended
open-items (car parse)))
;; Make sure parse-partial-sexp doesn't stop because we *entered*
;; the given depth -- i.e., make sure we're deeper than the target
;; depth.
(cl-assert (> (nth 0 parse)
(js--pitem-paren-depth (car open-items))))
(setq parse (parse-partial-sexp
prev-parse-point goal-point
(js--pitem-paren-depth (car open-items))
nil parse))
;; (let ((overlay (make-overlay prev-parse-point (point))))
;; (overlay-put overlay 'face '(:background "red"))
;; (unwind-protect
;; (progn
;; (js--debug "parsed: %S" parse)
;; (sit-for 1))
;; (delete-overlay overlay)))
(setq prev-parse-point (point))
(< (point) goal-point)))
(setq open-items (js--ensure-cache--pop-if-ended
open-items (car parse)))))
(defun js--show-cache-at-point ()
(interactive)
(require 'pp)
(let ((prop (get-text-property (point) 'js--pstate)))
(with-output-to-temp-buffer "*Help*"
(pp prop))))
(defun js--split-name (string)
"Split a JavaScript name into its dot-separated parts.
This also removes any prototype parts from the split name
\(unless the name is just \"prototype\" to start with)."
(let ((name (save-match-data
(split-string string "\\." t))))
(unless (and (= (length name) 1)
(equal (car name) "prototype"))
(setq name (remove "prototype" name)))))
(defvar js--guess-function-name-start nil)
(defun js--guess-function-name (position)
"Guess the name of the JavaScript function at POSITION.
POSITION should be just after the end of the word \"function\".
Return the name of the function, or nil if the name could not be
guessed.
This function clobbers match data. If we find the preamble
begins earlier than expected while guessing the function name,
set `js--guess-function-name-start' to that position; otherwise,
set that variable to nil."
(setq js--guess-function-name-start nil)
(save-excursion
(goto-char position)
(forward-line 0)
(cond
((looking-at js--function-heading-3-re)
(and (eq (match-end 0) position)
(setq js--guess-function-name-start (match-beginning 1))
(match-string-no-properties 1)))
((looking-at js--function-heading-2-re)
(and (eq (match-end 0) position)
(setq js--guess-function-name-start (match-beginning 1))
(match-string-no-properties 1))))))
(defun js--clear-stale-cache ()
;; Clear any endings that occur after point
(let (end-prop)
(save-excursion
(while (setq end-prop (js--forward-text-property
'js--pend))
(setf (js--pitem-b-end end-prop) nil))))
;; Remove any cache properties after this point
(remove-text-properties (point) (point-max)
'(js--pstate t js--pend t)))
(defun js--ensure-cache (&optional limit)
"Ensures brace cache is valid up to the character before LIMIT.
LIMIT defaults to point."
(setq limit (or limit (point)))
(when (< js--cache-end limit)
(c-save-buffer-state
(open-items
parse
prev-parse-point
name
case-fold-search
filtered-class-styles
goal-point)
;; Figure out which class styles we need to look for
(setq filtered-class-styles
(cl-loop for style in js--class-styles
if (memq (plist-get style :framework)
js-enabled-frameworks)
collect style))
(save-excursion
(save-restriction
(widen)
;; Find last known good position
(goto-char js--cache-end)
(unless (bobp)
(setq open-items (get-text-property
(1- (point)) 'js--pstate))
(unless open-items
(goto-char (previous-single-property-change
(point) 'js--pstate nil (point-min)))
(unless (bobp)
(setq open-items (get-text-property (1- (point))
'js--pstate))
(cl-assert open-items))))
(unless open-items
;; Make a placeholder for the top-level definition
(setq open-items (list js--initial-pitem)))
(setq parse (syntax-ppss))
(setq prev-parse-point (point))
(js--clear-stale-cache)
(narrow-to-region (point-min) limit)
(cl-loop while (re-search-forward js--quick-match-re-func nil t)
for orig-match-start = (goto-char (match-beginning 0))
for orig-match-end = (match-end 0)
do (js--ensure-cache--update-parse)
for orig-depth = (nth 0 parse)
;; Each of these conditions should return non-nil if
;; we should add a new item and leave point at the end
;; of the new item's header (h-end in the
;; js--pitem diagram). This point is the one
;; after the last character we need to unambiguously
;; detect this construct. If one of these evaluates to
;; nil, the location of the point is ignored.
if (cond
;; In comment or string
((nth 8 parse) nil)
;; Regular function declaration
((and (looking-at "\\_<function\\_>")
(setq name (js--forward-function-decl)))
(when (eq name t)
(setq name (js--guess-function-name orig-match-end))
(if name
(when js--guess-function-name-start
(setq orig-match-start
js--guess-function-name-start))
(setq name t)))
(cl-assert (eq (char-after) ?{))
(forward-char)
(make-js--pitem
:paren-depth orig-depth
:h-begin orig-match-start
:type 'function
:name (if (eq name t)
name
(js--split-name name))))
;; Macro
((looking-at js--macro-decl-re)
;; Macros often contain unbalanced parentheses.
;; Make sure that h-end is at the textual end of
;; the macro no matter what the parenthesis say.
(c-end-of-macro)
(js--ensure-cache--update-parse)
(make-js--pitem
:paren-depth (nth 0 parse)
:h-begin orig-match-start
:type 'macro
:name (list (match-string-no-properties 1))))
;; "Prototype function" declaration
((looking-at js--plain-method-re)
(goto-char (match-beginning 3))
(when (save-match-data
(js--forward-function-decl))
(forward-char)
(make-js--pitem
:paren-depth orig-depth
:h-begin orig-match-start
:type 'function
:name (nconc (js--split-name
(match-string-no-properties 1))
(list (match-string-no-properties 2))))))
;; Class definition
((cl-loop
with syntactic-context =
(js--syntactic-context-from-pstate open-items)
for class-style in filtered-class-styles
if (and (memq syntactic-context
(plist-get class-style :contexts))
(looking-at (plist-get class-style
:class-decl)))
do (goto-char (match-end 0))
and return
(make-js--pitem
:paren-depth orig-depth
:h-begin orig-match-start
:type class-style
:name (js--split-name
(match-string-no-properties 1))))))
do (js--ensure-cache--update-parse)
and do (push it open-items)
and do (put-text-property
(1- (point)) (point) 'js--pstate open-items)
else do (goto-char orig-match-end))
(goto-char limit)
(js--ensure-cache--update-parse)
(setq js--cache-end limit)
(setq js--last-parse-pos limit)
(setq js--state-at-last-parse-pos open-items)
)))))
(defun js--end-of-defun-flat ()
"Helper function for `js-end-of-defun'."
(cl-loop while (js--re-search-forward "}" nil t)
do (js--ensure-cache)
if (get-text-property (1- (point)) 'js--pend)
if (eq 'function (js--pitem-type it))
return t
finally do (goto-char (point-max))))
(defun js--end-of-defun-nested ()
"Helper function for `js-end-of-defun'."
(message "test")
(let* (pitem
(this-end (save-excursion
(and (setq pitem (js--beginning-of-defun-nested))
(js--pitem-goto-h-end pitem)
(progn (backward-char)
(forward-list)
(point)))))
found)
(if (and this-end (< (point) this-end))
;; We're already inside a function; just go to its end.
(goto-char this-end)
;; Otherwise, go to the end of the next function...
(while (and (js--re-search-forward "\\_<function\\_>" nil t)
(not (setq found (progn
(goto-char (match-beginning 0))
(js--forward-function-decl))))))
(if found (forward-list)
;; ... or eob.
(goto-char (point-max))))))
(defun js-end-of-defun (&optional arg)
"Value of `end-of-defun-function' for `js-mode'."
(setq arg (or arg 1))
(while (and (not (bobp)) (< arg 0))
(cl-incf arg)
(js-beginning-of-defun)
(js-beginning-of-defun)
(unless (bobp)
(js-end-of-defun)))
(while (> arg 0)
(cl-decf arg)
;; look for function backward. if we're inside it, go to that
;; function's end. otherwise, search for the next function's end and
;; go there
(if js-flat-functions
(js--end-of-defun-flat)
;; if we're doing nested functions, see whether we're in the
;; prologue. If we are, go to the end of the function; otherwise,
;; call js--end-of-defun-nested to do the real work
(let ((prologue-begin (js--function-prologue-beginning)))
(cond ((and prologue-begin (<= prologue-begin (point)))
(goto-char prologue-begin)
(re-search-forward "\\_<function")
(goto-char (match-beginning 0))
(js--forward-function-decl)
(forward-list))
(t (js--end-of-defun-nested)))))))
(defun js--beginning-of-macro (&optional lim)
(let ((here (point)))
(save-restriction
(if lim (narrow-to-region lim (point-max)))
(beginning-of-line)
(while (eq (char-before (1- (point))) ?\\)
(forward-line -1))
(back-to-indentation)
(if (and (<= (point) here)
(looking-at js--opt-cpp-start))
t
(goto-char here)
nil))))
(defun js--backward-syntactic-ws (&optional lim)
"Simple implementation of `c-backward-syntactic-ws' for `js-mode'."
(save-restriction
(when lim (narrow-to-region lim (point-max)))
(let ((in-macro (save-excursion (js--beginning-of-macro)))
(pos (point)))
(while (progn (unless in-macro (js--beginning-of-macro))
(forward-comment most-negative-fixnum)
(/= (point)
(prog1
pos
(setq pos (point)))))))))
(defun js--forward-syntactic-ws (&optional lim)
"Simple implementation of `c-forward-syntactic-ws' for `js-mode'."
(save-restriction
(when lim (narrow-to-region (point-min) lim))
(let ((pos (point)))
(while (progn
(forward-comment most-positive-fixnum)
(when (eq (char-after) ?#)
(c-end-of-macro))
(/= (point)
(prog1
pos
(setq pos (point)))))))))
;; Like (up-list -1), but only considers lists that end nearby"
(defun js--up-nearby-list ()
(save-restriction
;; Look at a very small region so our computation time doesn't
;; explode in pathological cases.
(narrow-to-region (max (point-min) (- (point) 500)) (point))
(up-list -1)))
(defun js--inside-param-list-p ()
"Return non-nil if point is in a function parameter list."
(ignore-errors
(save-excursion
(js--up-nearby-list)
(and (looking-at "(")
(progn (forward-symbol -1)
(or (looking-at "function")
(progn (forward-symbol -1)
(looking-at "function"))))))))
(defun js--inside-dojo-class-list-p ()
"Return non-nil if point is in a Dojo multiple-inheritance class block."
(ignore-errors
(save-excursion
(js--up-nearby-list)
(let ((list-begin (point)))
(forward-line 0)
(and (looking-at js--dojo-class-decl-re)
(goto-char (match-end 0))
(looking-at "\"\\s-*,\\s-*\\[")
(eq (match-end 0) (1+ list-begin)))))))
;;; Font Lock
(defun js--make-framework-matcher (framework &rest regexps)
"Helper function for building `js--font-lock-keywords'.
Create a byte-compiled function for matching a concatenation of
REGEXPS, but only if FRAMEWORK is in `js-enabled-frameworks'."
(setq regexps (apply #'concat regexps))
(byte-compile
`(lambda (limit)
(when (memq (quote ,framework) js-enabled-frameworks)
(re-search-forward ,regexps limit t)))))
(defvar js--tmp-location nil)
(make-variable-buffer-local 'js--tmp-location)
(defun js--forward-destructuring-spec (&optional func)
"Move forward over a JavaScript destructuring spec.
If FUNC is supplied, call it with no arguments before every
variable name in the spec. Return true if this was actually a
spec. FUNC must preserve the match data."
(pcase (char-after)
(?\[
(forward-char)
(while
(progn
(forward-comment most-positive-fixnum)
(cond ((memq (char-after) '(?\[ ?\{))
(js--forward-destructuring-spec func))
((eq (char-after) ?,)
(forward-char)
t)
((looking-at js--name-re)
(and func (funcall func))
(goto-char (match-end 0))
t))))
(when (eq (char-after) ?\])
(forward-char)
t))
(?\{
(forward-char)
(forward-comment most-positive-fixnum)
(while
(when (looking-at js--objfield-re)
(goto-char (match-end 0))
(forward-comment most-positive-fixnum)
(and (cond ((memq (char-after) '(?\[ ?\{))
(js--forward-destructuring-spec func))
((looking-at js--name-re)
(and func (funcall func))
(goto-char (match-end 0))
t))
(progn (forward-comment most-positive-fixnum)
(when (eq (char-after) ?\,)
(forward-char)
(forward-comment most-positive-fixnum)
t)))))
(when (eq (char-after) ?\})
(forward-char)
t))))
(defun js--variable-decl-matcher (limit)
"Font-lock matcher for variable names in a variable declaration.
This is a cc-mode-style matcher that *always* fails, from the
point of view of font-lock. It applies highlighting directly with
`font-lock-apply-highlight'."
(condition-case nil
(save-restriction
(narrow-to-region (point-min) limit)
(let ((first t))
(forward-comment most-positive-fixnum)
(while
(and (or first
(when (eq (char-after) ?,)
(forward-char)
(forward-comment most-positive-fixnum)
t))
(cond ((looking-at js--name-re)
(font-lock-apply-highlight
'(0 font-lock-variable-name-face))
(goto-char (match-end 0)))
((save-excursion
(js--forward-destructuring-spec))
(js--forward-destructuring-spec
(lambda ()
(font-lock-apply-highlight
'(0 font-lock-variable-name-face)))))))
(forward-comment most-positive-fixnum)
(when (eq (char-after) ?=)
(forward-char)
(js--forward-expression)
(forward-comment most-positive-fixnum))
(setq first nil))))
;; Conditions to handle
(scan-error nil)
(end-of-buffer nil))
;; Matcher always "fails"
nil)
(defconst js--font-lock-keywords-3
`(
;; This goes before keywords-2 so it gets used preferentially
;; instead of the keywords in keywords-2. Don't use override
;; because that will override syntactic fontification too, which
;; will fontify commented-out directives as if they weren't
;; commented out.
,@cpp-font-lock-keywords ; from font-lock.el
,@js--font-lock-keywords-2
("\\.\\(prototype\\)\\_>"
(1 font-lock-constant-face))
;; Highlights class being declared, in parts
(js--class-decl-matcher
,(concat "\\(" js--name-re "\\)\\(?:\\.\\|.*$\\)")
(goto-char (match-beginning 1))
nil
(1 font-lock-type-face))
;; Highlights parent class, in parts, if available
(js--class-decl-matcher
,(concat "\\(" js--name-re "\\)\\(?:\\.\\|.*$\\)")
(if (match-beginning 2)
(progn
(setq js--tmp-location (match-end 2))
(goto-char js--tmp-location)
(insert "=")
(goto-char (match-beginning 2)))
(setq js--tmp-location nil)
(goto-char (point-at-eol)))
(when js--tmp-location
(save-excursion
(goto-char js--tmp-location)
(delete-char 1)))
(1 font-lock-type-face))
;; Highlights parent class
(js--class-decl-matcher
(2 font-lock-type-face nil t))
;; Dojo needs its own matcher to override the string highlighting
(,(js--make-framework-matcher
'dojo
"^\\s-*dojo\\.declare\\s-*(\""
"\\(" js--dotted-name-re "\\)"
"\\(?:\"\\s-*,\\s-*\\(" js--dotted-name-re "\\)\\)?")
(1 font-lock-type-face t)
(2 font-lock-type-face nil t))
;; Match Dojo base classes. Of course Mojo has to be different
;; from everything else under the sun...
(,(js--make-framework-matcher
'dojo
"^\\s-*dojo\\.declare\\s-*(\""
"\\(" js--dotted-name-re "\\)\"\\s-*,\\s-*\\[")
,(concat "[[,]\\s-*\\(" js--dotted-name-re "\\)\\s-*"
"\\(?:\\].*$\\)?")
(backward-char)
(end-of-line)
(1 font-lock-type-face))
;; continued Dojo base-class list
(,(js--make-framework-matcher
'dojo
"^\\s-*" js--dotted-name-re "\\s-*[],]")
,(concat "\\(" js--dotted-name-re "\\)"
"\\s-*\\(?:\\].*$\\)?")
(if (save-excursion (backward-char)
(js--inside-dojo-class-list-p))
(forward-symbol -1)
(end-of-line))
(end-of-line)
(1 font-lock-type-face))
;; variable declarations
,(list
(concat "\\_<\\(const\\|var\\|let\\)\\_>\\|" js--basic-type-re)
(list #'js--variable-decl-matcher nil nil nil))
;; class instantiation
,(list
(concat "\\_<new\\_>\\s-+\\(" js--dotted-name-re "\\)")
(list 1 'font-lock-type-face))
;; instanceof
,(list
(concat "\\_<instanceof\\_>\\s-+\\(" js--dotted-name-re "\\)")
(list 1 'font-lock-type-face))
;; formal parameters
,(list
(concat
"\\_<function\\_>\\(\\s-+" js--name-re "\\)?\\s-*(\\s-*"
js--name-start-re)
(list (concat "\\(" js--name-re "\\)\\(\\s-*).*\\)?")
'(backward-char)
'(end-of-line)
'(1 font-lock-variable-name-face)))
;; continued formal parameter list
,(list
(concat
"^\\s-*" js--name-re "\\s-*[,)]")
(list js--name-re
'(if (save-excursion (backward-char)
(js--inside-param-list-p))
(forward-symbol -1)
(end-of-line))
'(end-of-line)
'(0 font-lock-variable-name-face))))
"Level three font lock for `js-mode'.")
(defun js--inside-pitem-p (pitem)
"Return whether point is inside the given pitem's header or body."
(js--ensure-cache)
(cl-assert (js--pitem-h-begin pitem))
(cl-assert (js--pitem-paren-depth pitem))
(and (> (point) (js--pitem-h-begin pitem))
(or (null (js--pitem-b-end pitem))
(> (js--pitem-b-end pitem) (point)))))
(defun js--parse-state-at-point ()
"Parse the JavaScript program state at point.
Return a list of `js--pitem' instances that apply to point, most
specific first. In the worst case, the current toplevel instance
will be returned."
(save-excursion
(save-restriction
(widen)
(js--ensure-cache)
(let ((pstate (or (save-excursion
(js--backward-pstate))
(list js--initial-pitem))))
;; Loop until we either hit a pitem at BOB or pitem ends after
;; point (or at point if we're at eob)
(cl-loop for pitem = (car pstate)
until (or (eq (js--pitem-type pitem)
'toplevel)
(js--inside-pitem-p pitem))
do (pop pstate))
pstate))))
(defun js--syntactic-context-from-pstate (pstate)
"Return the JavaScript syntactic context corresponding to PSTATE."
(let ((type (js--pitem-type (car pstate))))
(cond ((memq type '(function macro))
type)
((consp type)
'class)
(t 'toplevel))))
(defun js-syntactic-context ()
"Return the JavaScript syntactic context at point.
When called interactively, also display a message with that
context."
(interactive)
(let* ((syntactic-context (js--syntactic-context-from-pstate
(js--parse-state-at-point))))
(when (called-interactively-p 'interactive)
(message "Syntactic context: %s" syntactic-context))
syntactic-context))
(defun js--class-decl-matcher (limit)
"Font lock function used by `js-mode'.
This performs fontification according to `js--class-styles'."
(cl-loop initially (js--ensure-cache limit)
while (re-search-forward js--quick-match-re limit t)
for orig-end = (match-end 0)
do (goto-char (match-beginning 0))
if (cl-loop for style in js--class-styles
for decl-re = (plist-get style :class-decl)
if (and (memq (plist-get style :framework)
js-enabled-frameworks)
(memq (js-syntactic-context)
(plist-get style :contexts))
decl-re
(looking-at decl-re))
do (goto-char (match-end 0))
and return t)
return t
else do (goto-char orig-end)))
(defconst js--font-lock-keywords
'(js--font-lock-keywords-3 js--font-lock-keywords-1
js--font-lock-keywords-2
js--font-lock-keywords-3)
"Font lock keywords for `js-mode'. See `font-lock-keywords'.")
(defconst js--syntax-propertize-regexp-syntax-table
(let ((st (make-char-table 'syntax-table (string-to-syntax "."))))
(modify-syntax-entry ?\[ "(]" st)
(modify-syntax-entry ?\] ")[" st)
(modify-syntax-entry ?\\ "\\" st)
st))
(defun js-syntax-propertize-regexp (end)
(let ((ppss (syntax-ppss)))
(when (eq (nth 3 ppss) ?/)
;; A /.../ regexp.
(while
(when (re-search-forward "\\(?:\\=\\|[^\\]\\)\\(?:\\\\\\\\\\)*/"
end 'move)
(if (nth 1 (with-syntax-table
js--syntax-propertize-regexp-syntax-table
(let ((parse-sexp-lookup-properties nil))
(parse-partial-sexp (nth 8 ppss) (point)))))
;; A / within a character class is not the end of a regexp.
t
(put-text-property (1- (point)) (point)
'syntax-table (string-to-syntax "\"/"))
nil))))))
(defun js-syntax-propertize (start end)
;; Javascript allows immediate regular expression objects, written /.../.
(goto-char start)
(js-syntax-propertize-regexp end)
(funcall
(syntax-propertize-rules
;; Distinguish /-division from /-regexp chars (and from /-comment-starter).
;; FIXME: Allow regexps after infix ops like + ...
;; https://developer.mozilla.org/en/JavaScript/Reference/Operators
;; We can probably just add +, -, !, <, >, %, ^, ~, |, &, ?, : at which
;; point I think only * and / would be missing which could also be added,
;; but need care to avoid affecting the // and */ comment markers.
("\\(?:^\\|[=([{,:;]\\|\\_<return\\_>\\)\\(?:[ \t]\\)*\\(/\\)[^/*]"
(1 (ignore
(forward-char -1)
(when (or (not (memq (char-after (match-beginning 0)) '(?\s ?\t)))
;; If the / is at the beginning of line, we have to check
;; the end of the previous text.
(save-excursion
(goto-char (match-beginning 0))
(forward-comment (- (point)))
(memq (char-before)
(eval-when-compile (append "=({[,:;" '(nil))))))
(put-text-property (match-beginning 1) (match-end 1)
'syntax-table (string-to-syntax "\"/"))
(js-syntax-propertize-regexp end))))))
(point) end))
(defconst js--prettify-symbols-alist
'(("=>" . ?⇒)
(">=" . ?≥)
("<=" . ?≤))
"Alist of symbol prettifications for JavaScript.")
;;; Indentation
(defconst js--possibly-braceless-keyword-re
(js--regexp-opt-symbol
'("catch" "do" "else" "finally" "for" "if" "try" "while" "with"
"each"))
"Regexp matching keywords optionally followed by an opening brace.")
(defconst js--declaration-keyword-re
(regexp-opt '("var" "let" "const") 'words)
"Regular expression matching variable declaration keywords.")
(defconst js--indent-operator-re
(concat "[-+*/%<>&^|?:.]\\([^-+*/]\\|$\\)\\|!?=\\|"
(js--regexp-opt-symbol '("in" "instanceof")))
"Regexp matching operators that affect indentation of continued expressions.")
(defun js--looking-at-operator-p ()
"Return non-nil if point is on a JavaScript operator, other than a comma."
(save-match-data
(and (looking-at js--indent-operator-re)
(or (not (eq (char-after) ?:))
(save-excursion
(and (js--re-search-backward "[?:{]\\|\\_<case\\_>" nil t)
(eq (char-after) ??))))
(not (and
(eq (char-after) ?*)
(looking-at (concat "\\* *" js--name-re " *("))
(save-excursion
(goto-char (1- (match-end 0)))
(let (forward-sexp-function) (forward-sexp))
(js--forward-syntactic-ws)
(eq (char-after) ?{)))))))
(defun js--continued-expression-p ()
"Return non-nil if the current line continues an expression."
(save-excursion
(back-to-indentation)
(or (js--looking-at-operator-p)
(and (js--re-search-backward "\n" nil t)
(progn
(skip-chars-backward " \t")
(or (bobp) (backward-char))
(and (> (point) (point-min))
(save-excursion (backward-char) (not (looking-at "[/*]/")))
(js--looking-at-operator-p)
(and (progn (backward-char)
(not (looking-at "+\\+\\|--\\|/[/*]"))))))))))
(defun js--end-of-do-while-loop-p ()
"Return non-nil if point is on the \"while\" of a do-while statement.
Otherwise, return nil. A braceless do-while statement spanning
several lines requires that the start of the loop is indented to
the same column as the current line."
(interactive)
(save-excursion
(save-match-data
(when (looking-at "\\s-*\\_<while\\_>")
(if (save-excursion
(skip-chars-backward "[ \t\n]*}")
(looking-at "[ \t\n]*}"))
(save-excursion
(backward-list) (forward-symbol -1) (looking-at "\\_<do\\_>"))
(js--re-search-backward "\\_<do\\_>" (point-at-bol) t)
(or (looking-at "\\_<do\\_>")
(let ((saved-indent (current-indentation)))
(while (and (js--re-search-backward "^\\s-*\\_<" nil t)
(/= (current-indentation) saved-indent)))
(and (looking-at "\\s-*\\_<do\\_>")
(not (js--re-search-forward
"\\_<while\\_>" (point-at-eol) t))
(= (current-indentation) saved-indent)))))))))
(defun js--ctrl-statement-indentation ()
"Helper function for `js--proper-indentation'.
Return the proper indentation of the current line if it starts
the body of a control statement without braces; otherwise, return
nil."
(save-excursion
(back-to-indentation)
(when (save-excursion
(and (not (eq (point-at-bol) (point-min)))
(not (looking-at "[{]"))
(js--re-search-backward "[[:graph:]]" nil t)
(progn
(or (eobp) (forward-char))
(when (= (char-before) ?\)) (backward-list))
(skip-syntax-backward " ")
(skip-syntax-backward "w_")
(looking-at js--possibly-braceless-keyword-re))
(not (js--end-of-do-while-loop-p))))
(save-excursion
(goto-char (match-beginning 0))
(+ (current-indentation) js-indent-level)))))
(defun js--get-c-offset (symbol anchor)
(let ((c-offsets-alist
(list (cons 'c js-comment-lineup-func))))
(c-get-syntactic-indentation (list (cons symbol anchor)))))
(defun js--same-line (pos)
(and (>= pos (point-at-bol))
(<= pos (point-at-eol))))
(defun js--multi-line-declaration-indentation ()
"Helper function for `js--proper-indentation'.
Return the proper indentation of the current line if it belongs to a declaration
statement spanning multiple lines; otherwise, return nil."
(let (at-opening-bracket)
(save-excursion
(back-to-indentation)
(when (not (looking-at js--declaration-keyword-re))
(when (looking-at js--indent-operator-re)
(goto-char (match-end 0)))
(while (and (not at-opening-bracket)
(not (bobp))
(let ((pos (point)))
(save-excursion
(js--backward-syntactic-ws)
(or (eq (char-before) ?,)
(and (not (eq (char-before) ?\;))
(prog2
(skip-syntax-backward ".")
(looking-at js--indent-operator-re)
(js--backward-syntactic-ws))
(not (eq (char-before) ?\;)))
(js--same-line pos)))))
(condition-case nil
(backward-sexp)
(scan-error (setq at-opening-bracket t))))
(when (looking-at js--declaration-keyword-re)
(goto-char (match-end 0))
(1+ (current-column)))))))
(defun js--indent-in-array-comp (bracket)
"Return non-nil if we think we're in an array comprehension.
In particular, return the buffer position of the first `for' kwd."
(let ((end (point)))
(save-excursion
(goto-char bracket)
(when (looking-at "\\[")
(forward-char 1)
(js--forward-syntactic-ws)
(if (looking-at "[[{]")
(let (forward-sexp-function) ; Use Lisp version.
(forward-sexp) ; Skip destructuring form.
(js--forward-syntactic-ws)
(if (and (/= (char-after) ?,) ; Regular array.
(looking-at "for"))
(match-beginning 0)))
;; To skip arbitrary expressions we need the parser,
;; so we'll just guess at it.
(if (and (> end (point)) ; Not empty literal.
(re-search-forward "[^,]]* \\(for\\) " end t)
;; Not inside comment or string literal.
(not (nth 8 (parse-partial-sexp bracket (point)))))
(match-beginning 1)))))))
(defun js--array-comp-indentation (bracket for-kwd)
(if (js--same-line for-kwd)
;; First continuation line.
(save-excursion
(goto-char bracket)
(forward-char 1)
(skip-chars-forward " \t")
(current-column))
(save-excursion
(goto-char for-kwd)
(current-column))))
(defun js--maybe-goto-declaration-keyword-end (parse-status)
"Helper function for `js--proper-indentation'.
Depending on the value of `js-indent-first-init', move
point to the end of a variable declaration keyword so that
indentation is aligned to that column."
(cond
((eq js-indent-first-init t)
(when (looking-at js--declaration-keyword-re)
(goto-char (1+ (match-end 0)))))
((eq js-indent-first-init 'dynamic)
(let ((bracket (nth 1 parse-status))
declaration-keyword-end
at-closing-bracket-p
comma-p)
(when (looking-at js--declaration-keyword-re)
(setq declaration-keyword-end (match-end 0))
(save-excursion
(goto-char bracket)
(setq at-closing-bracket-p
(condition-case nil
(progn
(forward-sexp)
t)
(error nil)))
(when at-closing-bracket-p
(while (forward-comment 1))
(setq comma-p (looking-at-p ","))))
(when comma-p
(goto-char (1+ declaration-keyword-end))))))))
(defun js--proper-indentation (parse-status)
"Return the proper indentation for the current line."
(save-excursion
(back-to-indentation)
(cond ((nth 4 parse-status) ; inside comment
(js--get-c-offset 'c (nth 8 parse-status)))
((nth 3 parse-status) 0) ; inside string
((eq (char-after) ?#) 0)
((save-excursion (js--beginning-of-macro)) 4)
;; Indent array comprehension continuation lines specially.
((let ((bracket (nth 1 parse-status))
beg)
(and bracket
(not (js--same-line bracket))
(setq beg (js--indent-in-array-comp bracket))
;; At or after the first loop?
(>= (point) beg)
(js--array-comp-indentation bracket beg))))
((js--ctrl-statement-indentation))
((js--multi-line-declaration-indentation))
((nth 1 parse-status)
;; A single closing paren/bracket should be indented at the
;; same level as the opening statement. Same goes for
;; "case" and "default".
(let ((same-indent-p (looking-at "[]})]"))
(switch-keyword-p (looking-at "default\\_>\\|case\\_>[^:]"))
(continued-expr-p (js--continued-expression-p)))
(goto-char (nth 1 parse-status)) ; go to the opening char
(if (looking-at "[({[]\\s-*\\(/[/*]\\|$\\)")
(progn ; nothing following the opening paren/bracket
(skip-syntax-backward " ")
(when (eq (char-before) ?\)) (backward-list))
(back-to-indentation)
(js--maybe-goto-declaration-keyword-end parse-status)
(let* ((in-switch-p (unless same-indent-p
(looking-at "\\_<switch\\_>")))
(same-indent-p (or same-indent-p
(and switch-keyword-p
in-switch-p)))
(indent
(cond (same-indent-p
(current-column))
(continued-expr-p
(+ (current-column) (* 2 js-indent-level)
js-expr-indent-offset))
(t
(+ (current-column) js-indent-level
(pcase (char-after (nth 1 parse-status))
(?\( js-paren-indent-offset)
(?\[ js-square-indent-offset)
(?\{ js-curly-indent-offset)))))))
(if in-switch-p
(+ indent js-switch-indent-offset)
indent)))
;; If there is something following the opening
;; paren/bracket, everything else should be indented at
;; the same level.
(unless same-indent-p
(forward-char)
(skip-chars-forward " \t"))
(current-column))))
((js--continued-expression-p)
(+ js-indent-level js-expr-indent-offset))
(t 0))))
;;; JSX Indentation
(defsubst js--jsx-find-before-tag ()
"Find where JSX starts.
Assume JSX appears in the following instances:
- Inside parentheses, when returned or as the first argument
to a function, and after a newline
- When assigned to variables or object properties, but only
on a single line
- As the N+1th argument to a function
This is an optimized version of (re-search-backward \"[(,]\n\"
nil t), except set point to the end of the match. This logic
executes up to the number of lines in the file, so it should be
really fast to reduce that impact."
(let (pos)
(while (and (> (point) (point-min))
(not (progn
(end-of-line 0)
(when (or (eq (char-before) 40) ; (
(eq (char-before) 44)) ; ,
(setq pos (1- (point))))))))
pos))
(defconst js--jsx-end-tag-re
(concat "</" sgml-name-re ">\\|/>")
"Find the end of a JSX element.")
(defconst js--jsx-after-tag-re "[),]"
"Find where JSX ends.
This complements the assumption of where JSX appears from
`js--jsx-before-tag-re', which see.")
(defun js--jsx-indented-element-p ()
"Determine if/how the current line should be indented as JSX.
Return `first' for the first JSXElement on its own line.
Return `nth' for subsequent lines of the first JSXElement.
Return `expression' for an embedded JS expression.
Return `after' for anything after the last JSXElement.
Return nil for non-JSX lines.
Currently, JSX indentation supports the following styles:
- Single-line elements (indented like normal JS):
var element = <div></div>;
- Multi-line elements (enclosed in parentheses):
function () {
return (
<div>
<div></div>
</div>
);
}
- Function arguments:
React.render(
<div></div>,
document.querySelector('.root')
);"
(let ((current-pos (point))
(current-line (line-number-at-pos))
last-pos
before-tag-pos before-tag-line
tag-start-pos tag-start-line
tag-end-pos tag-end-line
after-tag-line
parens paren type)
(save-excursion
(and
;; Determine if we're inside a jsx element
(progn
(end-of-line)
(while (and (not tag-start-pos)
(setq last-pos (js--jsx-find-before-tag)))
(while (forward-comment 1))
(when (= (char-after) 60) ; <
(setq before-tag-pos last-pos
tag-start-pos (point)))
(goto-char last-pos))
tag-start-pos)
(progn
(setq before-tag-line (line-number-at-pos before-tag-pos)
tag-start-line (line-number-at-pos tag-start-pos))
(and
;; A "before" line which also starts an element begins with js, so
;; indent it like js
(> current-line before-tag-line)
;; Only indent the jsx lines like jsx
(>= current-line tag-start-line)))
(cond
;; Analyze bounds if there are any
((progn
(while (and (not tag-end-pos)
(setq last-pos (re-search-forward js--jsx-end-tag-re nil t)))
(while (forward-comment 1))
(when (looking-at js--jsx-after-tag-re)
(setq tag-end-pos last-pos)))
tag-end-pos)
(setq tag-end-line (line-number-at-pos tag-end-pos)
after-tag-line (line-number-at-pos after-tag-line))
(or (and
;; Ensure we're actually within the bounds of the jsx
(<= current-line tag-end-line)
;; An "after" line which does not end an element begins with
;; js, so indent it like js
(<= current-line after-tag-line))
(and
;; Handle another case where there could be e.g. comments after
;; the element
(> current-line tag-end-line)
(< current-line after-tag-line)
(setq type 'after))))
;; They may not be any bounds (yet)
(t))
;; Check if we're inside an embedded multi-line js expression
(cond
((not type)
(goto-char current-pos)
(end-of-line)
(setq parens (nth 9 (syntax-ppss)))
(while (and parens (not type))
(setq paren (car parens))
(cond
((and (>= paren tag-start-pos)
;; Curly bracket indicates the start of an embedded expression
(= (char-after paren) 123) ; {
;; The first line of the expression is indented like sgml
(> current-line (line-number-at-pos paren))
;; Check if within a closing curly bracket (if any)
;; (exclusive, as the closing bracket is indented like sgml)
(cond
((progn
(goto-char paren)
(ignore-errors (let (forward-sexp-function)
(forward-sexp))))
(< current-line (line-number-at-pos)))
(t)))
;; Indicate this guy will be indented specially
(setq type 'expression))
(t (setq parens (cdr parens)))))
t)
(t))
(cond
(type)
;; Indent the first jsx thing like js so we can indent future jsx things
;; like sgml relative to the first thing
((= current-line tag-start-line) 'first)
('nth))))))
(defmacro js--as-sgml (&rest body)
"Execute BODY as if in sgml-mode."
`(with-syntax-table sgml-mode-syntax-table
(let (forward-sexp-function
parse-sexp-lookup-properties)
,@body)))
(defun js--expression-in-sgml-indent-line ()
"Indent the current line as JavaScript or SGML (whichever is farther)."
(let* (indent-col
(savep (point))
;; Don't whine about errors/warnings when we're indenting.
;; This has to be set before calling parse-partial-sexp below.
(inhibit-point-motion-hooks t)
(parse-status (save-excursion
(syntax-ppss (point-at-bol)))))
;; Don't touch multiline strings.
(unless (nth 3 parse-status)
(setq indent-col (save-excursion
(back-to-indentation)
(if (>= (point) savep) (setq savep nil))
(js--as-sgml (sgml-calculate-indent))))
(if (null indent-col)
'noindent
;; Use whichever indentation column is greater, such that the sgml
;; column is effectively a minimum
(setq indent-col (max (js--proper-indentation parse-status)
(+ indent-col js-indent-level)))
(if savep
(save-excursion (indent-line-to indent-col))
(indent-line-to indent-col))))))
(defun js-indent-line ()
"Indent the current line as JavaScript."
(interactive)
(let* ((parse-status
(save-excursion (syntax-ppss (point-at-bol))))
(offset (- (point) (save-excursion (back-to-indentation) (point)))))
(unless (nth 3 parse-status)
(indent-line-to (js--proper-indentation parse-status))
(when (> offset 0) (forward-char offset)))))
(defun js-jsx-indent-line ()
"Indent the current line as JSX (with SGML offsets).
i.e., customize JSX element indentation with `sgml-basic-offset',
`sgml-attribute-offset' et al."
(interactive)
(let ((indentation-type (js--jsx-indented-element-p)))
(cond
((eq indentation-type 'expression)
(js--expression-in-sgml-indent-line))
((or (eq indentation-type 'first)
(eq indentation-type 'after))
;; Don't treat this first thing as a continued expression (often a "<" or
;; ">" causes this misinterpretation)
(cl-letf (((symbol-function #'js--continued-expression-p) 'ignore))
(js-indent-line)))
((eq indentation-type 'nth)
(js--as-sgml (sgml-indent-line)))
(t (js-indent-line)))))
;;; Filling
(defvar js--filling-paragraph nil)
;; FIXME: Such redefinitions are bad style. We should try and use some other
;; way to get the same result.
(defadvice c-forward-sws (around js-fill-paragraph activate)
(if js--filling-paragraph
(setq ad-return-value (js--forward-syntactic-ws (ad-get-arg 0)))
ad-do-it))
(defadvice c-backward-sws (around js-fill-paragraph activate)
(if js--filling-paragraph
(setq ad-return-value (js--backward-syntactic-ws (ad-get-arg 0)))
ad-do-it))
(defadvice c-beginning-of-macro (around js-fill-paragraph activate)
(if js--filling-paragraph
(setq ad-return-value (js--beginning-of-macro (ad-get-arg 0)))
ad-do-it))
(defun js-c-fill-paragraph (&optional justify)
"Fill the paragraph with `c-fill-paragraph'."
(interactive "*P")
(let ((js--filling-paragraph t)
(fill-paragraph-function 'c-fill-paragraph))
(c-fill-paragraph justify)))
;;; Type database and Imenu
;; We maintain a cache of semantic information, i.e., the classes and
;; functions we've encountered so far. In order to avoid having to
;; re-parse the buffer on every change, we cache the parse state at
;; each interesting point in the buffer. Each parse state is a
;; modified copy of the previous one, or in the case of the first
;; parse state, the empty state.
;;
;; The parse state itself is just a stack of js--pitem
;; instances. It starts off containing one element that is never
;; closed, that is initially js--initial-pitem.
;;
(defun js--pitem-format (pitem)
(let ((name (js--pitem-name pitem))
(type (js--pitem-type pitem)))
(format "name:%S type:%S"
name
(if (atom type)
type
(plist-get type :name)))))
(defun js--make-merged-item (item child name-parts)
"Helper function for `js--splice-into-items'.
Return a new item that is the result of merging CHILD into
ITEM. NAME-PARTS is a list of parts of the name of CHILD
that we haven't consumed yet."
(js--debug "js--make-merged-item: {%s} into {%s}"
(js--pitem-format child)
(js--pitem-format item))
;; If the item we're merging into isn't a class, make it into one
(unless (consp (js--pitem-type item))
(js--debug "js--make-merged-item: changing dest into class")
(setq item (make-js--pitem
:children (list item)
;; Use the child's class-style if it's available
:type (if (atom (js--pitem-type child))
js--dummy-class-style
(js--pitem-type child))
:name (js--pitem-strname item))))
;; Now we can merge either a function or a class into a class
(cons (cond
((cdr name-parts)
(js--debug "js--make-merged-item: recursing")
;; if we have more name-parts to go before we get to the
;; bottom of the class hierarchy, call the merger
;; recursively
(js--splice-into-items (car item) child
(cdr name-parts)))
((atom (js--pitem-type child))
(js--debug "js--make-merged-item: straight merge")
;; Not merging a class, but something else, so just prepend
;; it
(cons child (car item)))
(t
;; Otherwise, merge the new child's items into those
;; of the new class
(js--debug "js--make-merged-item: merging class contents")
(append (car child) (car item))))
(cdr item)))
(defun js--pitem-strname (pitem)
"Last part of the name of PITEM, as a string or symbol."
(let ((name (js--pitem-name pitem)))
(if (consp name)
(car (last name))
name)))
(defun js--splice-into-items (items child name-parts)
"Splice CHILD into the `js--pitem' ITEMS at NAME-PARTS.
If a class doesn't exist in the tree, create it. Return
the new items list. NAME-PARTS is a list of strings given
the broken-down class name of the item to insert."
(let ((top-name (car name-parts))
(item-ptr items)
new-items last-new-item new-cons)
(js--debug "js--splice-into-items: name-parts: %S items:%S"
name-parts
(mapcar #'js--pitem-name items))
(cl-assert (stringp top-name))
(cl-assert (> (length top-name) 0))
;; If top-name isn't found in items, then we build a copy of items
;; and throw it away. But that's okay, since most of the time, we
;; *will* find an instance.
(while (and item-ptr
(cond ((equal (js--pitem-strname (car item-ptr)) top-name)
;; Okay, we found an entry with the right name. Splice
;; the merged item into the list...
(setq new-cons (cons (js--make-merged-item
(car item-ptr) child
name-parts)
(cdr item-ptr)))
(if last-new-item
(setcdr last-new-item new-cons)
(setq new-items new-cons))
;; ...and terminate the loop
nil)
(t
;; Otherwise, copy the current cons and move onto the
;; text. This is tricky; we keep track of the tail of
;; the list that begins with new-items in
;; last-new-item.
(setq new-cons (cons (car item-ptr) nil))
(if last-new-item
(setcdr last-new-item new-cons)
(setq new-items new-cons))
(setq last-new-item new-cons)
;; Go to the next cell in items
(setq item-ptr (cdr item-ptr))))))
(if item-ptr
;; Yay! We stopped because we found something, not because
;; we ran out of items to search. Just return the new
;; list.
(progn
(js--debug "search succeeded: %S" name-parts)
new-items)
;; We didn't find anything. If the child is a class and we don't
;; have any classes to drill down into, just push that class;
;; otherwise, make a fake class and carry on.
(js--debug "search failed: %S" name-parts)
(cons (if (cdr name-parts)
;; We have name-parts left to process. Make a fake
;; class for this particular part...
(make-js--pitem
;; ...and recursively digest the rest of the name
:children (js--splice-into-items
nil child (cdr name-parts))
:type js--dummy-class-style
:name top-name)
;; Otherwise, this is the only name we have, so stick
;; the item on the front of the list
child)
items))))
(defun js--pitem-add-child (pitem child)
"Copy `js--pitem' PITEM, and push CHILD onto its list of children."
(cl-assert (integerp (js--pitem-h-begin child)))
(cl-assert (if (consp (js--pitem-name child))
(cl-loop for part in (js--pitem-name child)
always (stringp part))
t))
;; This trick works because we know (based on our defstructs) that
;; the child list is always the first element, and so the second
;; element and beyond can be shared when we make our "copy".
(cons
(let ((name (js--pitem-name child))
(type (js--pitem-type child)))
(cond ((cdr-safe name) ; true if a list of at least two elements
;; Use slow path because we need class lookup
(js--splice-into-items (car pitem) child name))
((and (consp type)
(plist-get type :prototype))
;; Use slow path because we need class merging. We know
;; name is a list here because down in
;; `js--ensure-cache', we made sure to only add
;; class entries with lists for :name
(cl-assert (consp name))
(js--splice-into-items (car pitem) child name))
(t
;; Fast path
(cons child (car pitem)))))
(cdr pitem)))
(defun js--maybe-make-marker (location)
"Return a marker for LOCATION if `imenu-use-markers' is non-nil."
(if imenu-use-markers
(set-marker (make-marker) location)
location))
(defun js--pitems-to-imenu (pitems unknown-ctr)
"Convert PITEMS, a list of `js--pitem' structures, to imenu format."
(let (imenu-items pitem pitem-type pitem-name subitems)
(while (setq pitem (pop pitems))
(setq pitem-type (js--pitem-type pitem))
(setq pitem-name (js--pitem-strname pitem))
(when (eq pitem-name t)
(setq pitem-name (format "[unknown %s]"
(cl-incf (car unknown-ctr)))))
(cond
((memq pitem-type '(function macro))
(cl-assert (integerp (js--pitem-h-begin pitem)))
(push (cons pitem-name
(js--maybe-make-marker
(js--pitem-h-begin pitem)))
imenu-items))
((consp pitem-type) ; class definition
(setq subitems (js--pitems-to-imenu
(js--pitem-children pitem)
unknown-ctr))
(cond (subitems
(push (cons pitem-name subitems)
imenu-items))
((js--pitem-h-begin pitem)
(cl-assert (integerp (js--pitem-h-begin pitem)))
(setq subitems (list
(cons "[empty]"
(js--maybe-make-marker
(js--pitem-h-begin pitem)))))
(push (cons pitem-name subitems)
imenu-items))))
(t (error "Unknown item type: %S" pitem-type))))
imenu-items))
(defun js--imenu-create-index ()
"Return an imenu index for the current buffer."
(save-excursion
(save-restriction
(widen)
(goto-char (point-max))
(js--ensure-cache)
(cl-assert (or (= (point-min) (point-max))
(eq js--last-parse-pos (point))))
(when js--last-parse-pos
(let ((state js--state-at-last-parse-pos)
(unknown-ctr (cons -1 nil)))
;; Make sure everything is closed
(while (cdr state)
(setq state
(cons (js--pitem-add-child (cl-second state) (car state))
(cddr state))))
(cl-assert (= (length state) 1))
;; Convert the new-finalized state into what imenu expects
(js--pitems-to-imenu
(car (js--pitem-children state))
unknown-ctr))))))
;; Silence the compiler.
(defvar which-func-imenu-joiner-function)
(defun js--which-func-joiner (parts)
(mapconcat #'identity parts "."))
(defun js--imenu-to-flat (items prefix symbols)
(cl-loop for item in items
if (imenu--subalist-p item)
do (js--imenu-to-flat
(cdr item) (concat prefix (car item) ".")
symbols)
else
do (let* ((name (concat prefix (car item)))
(name2 name)
(ctr 0))
(while (gethash name2 symbols)
(setq name2 (format "%s<%d>" name (cl-incf ctr))))
(puthash name2 (cdr item) symbols))))
(defun js--get-all-known-symbols ()
"Return a hash table of all JavaScript symbols.
This searches all existing `js-mode' buffers. Each key is the
name of a symbol (possibly disambiguated with <N>, where N > 1),
and each value is a marker giving the location of that symbol."
(cl-loop with symbols = (make-hash-table :test 'equal)
with imenu-use-markers = t
for buffer being the buffers
for imenu-index = (with-current-buffer buffer
(when (derived-mode-p 'js-mode)
(js--imenu-create-index)))
do (js--imenu-to-flat imenu-index "" symbols)
finally return symbols))
(defvar js--symbol-history nil
"History of entered JavaScript symbols.")
(defun js--read-symbol (symbols-table prompt &optional initial-input)
"Helper function for `js-find-symbol'.
Read a symbol from SYMBOLS-TABLE, which is a hash table like the
one from `js--get-all-known-symbols', using prompt PROMPT and
initial input INITIAL-INPUT. Return a cons of (SYMBOL-NAME
. LOCATION), where SYMBOL-NAME is a string and LOCATION is a
marker."
(unless ido-mode
(ido-mode 1)
(ido-mode -1))
(let ((choice (ido-completing-read
prompt
(cl-loop for key being the hash-keys of symbols-table
collect key)
nil t initial-input 'js--symbol-history)))
(cons choice (gethash choice symbols-table))))
(defun js--guess-symbol-at-point ()
(let ((bounds (bounds-of-thing-at-point 'symbol)))
(when bounds
(save-excursion
(goto-char (car bounds))
(when (eq (char-before) ?.)
(backward-char)
(setf (car bounds) (point))))
(buffer-substring (car bounds) (cdr bounds)))))
(defvar find-tag-marker-ring) ; etags
;; etags loads ring.
(declare-function ring-insert "ring" (ring item))
(defun js-find-symbol (&optional arg)
"Read a JavaScript symbol and jump to it.
With a prefix argument, restrict symbols to those from the
current buffer. Pushes a mark onto the tag ring just like
`find-tag'."
(interactive "P")
(require 'etags)
(let (symbols marker)
(if (not arg)
(setq symbols (js--get-all-known-symbols))
(setq symbols (make-hash-table :test 'equal))
(js--imenu-to-flat (js--imenu-create-index)
"" symbols))
(setq marker (cdr (js--read-symbol
symbols "Jump to: "
(js--guess-symbol-at-point))))
(ring-insert find-tag-marker-ring (point-marker))
(switch-to-buffer (marker-buffer marker))
(push-mark)
(goto-char marker)))
;;; MozRepl integration
(define-error 'js-moz-bad-rpc "Mozilla RPC Error") ;; '(timeout error))
(define-error 'js-js-error "Javascript Error") ;; '(js-error error))
(defun js--wait-for-matching-output
(process regexp timeout &optional start)
"Wait TIMEOUT seconds for PROCESS to output a match for REGEXP.
On timeout, return nil. On success, return t with match data
set. If START is non-nil, look for output starting from START.
Otherwise, use the current value of `process-mark'."
(with-current-buffer (process-buffer process)
(cl-loop with start-pos = (or start
(marker-position (process-mark process)))
with end-time = (+ (float-time) timeout)
for time-left = (- end-time (float-time))
do (goto-char (point-max))
if (looking-back regexp start-pos) return t
while (> time-left 0)
do (accept-process-output process time-left nil t)
do (goto-char (process-mark process))
finally do (signal
'js-moz-bad-rpc
(list (format "Timed out waiting for output matching %S" regexp))))))
(cl-defstruct js--js-handle
;; Integer, mirrors the value we see in JS
(id nil :read-only t)
;; Process to which this thing belongs
(process nil :read-only t))
(defun js--js-handle-expired-p (x)
(not (eq (js--js-handle-process x)
(inferior-moz-process))))
(defvar js--js-references nil
"Maps Elisp JavaScript proxy objects to their JavaScript IDs.")
(defvar js--js-process nil
"The most recent MozRepl process object.")
(defvar js--js-gc-idle-timer nil
"Idle timer for cleaning up JS object references.")
(defvar js--js-last-gcs-done nil)
(defconst js--moz-interactor
(replace-regexp-in-string
"[ \n]+" " "
; */" Make Emacs happy
"(function(repl) {
repl.defineInteractor('js', {
onStart: function onStart(repl) {
if(!repl._jsObjects) {
repl._jsObjects = {};
repl._jsLastID = 0;
repl._jsGC = this._jsGC;
}
this._input = '';
},
_jsGC: function _jsGC(ids_in_use) {
var objects = this._jsObjects;
var keys = [];
var num_freed = 0;
for(var pn in objects) {
keys.push(Number(pn));
}
keys.sort(function(x, y) x - y);
ids_in_use.sort(function(x, y) x - y);
var i = 0;
var j = 0;
while(i < ids_in_use.length && j < keys.length) {
var id = ids_in_use[i++];
while(j < keys.length && keys[j] !== id) {
var k_id = keys[j++];
delete objects[k_id];
++num_freed;
}
++j;
}
while(j < keys.length) {
var k_id = keys[j++];
delete objects[k_id];
++num_freed;
}
return num_freed;
},
_mkArray: function _mkArray() {
var result = [];
for(var i = 0; i < arguments.length; ++i) {
result.push(arguments[i]);
}
return result;
},
_parsePropDescriptor: function _parsePropDescriptor(parts) {
if(typeof parts === 'string') {
parts = [ parts ];
}
var obj = parts[0];
var start = 1;
if(typeof obj === 'string') {
obj = window;
start = 0;
} else if(parts.length < 2) {
throw new Error('expected at least 2 arguments');
}
for(var i = start; i < parts.length - 1; ++i) {
obj = obj[parts[i]];
}
return [obj, parts[parts.length - 1]];
},
_getProp: function _getProp(/*...*/) {
if(arguments.length === 0) {
throw new Error('no arguments supplied to getprop');
}
if(arguments.length === 1 &&
(typeof arguments[0]) !== 'string')
{
return arguments[0];
}
var [obj, propname] = this._parsePropDescriptor(arguments);
return obj[propname];
},
_putProp: function _putProp(properties, value) {
var [obj, propname] = this._parsePropDescriptor(properties);
obj[propname] = value;
},
_delProp: function _delProp(propname) {
var [obj, propname] = this._parsePropDescriptor(arguments);
delete obj[propname];
},
_typeOf: function _typeOf(thing) {
return typeof thing;
},
_callNew: function(constructor) {
if(typeof constructor === 'string')
{
constructor = window[constructor];
} else if(constructor.length === 1 &&
typeof constructor[0] !== 'string')
{
constructor = constructor[0];
} else {
var [obj,propname] = this._parsePropDescriptor(constructor);
constructor = obj[propname];
}
/* Hacky, but should be robust */
var s = 'new constructor(';
for(var i = 1; i < arguments.length; ++i) {
if(i != 1) {
s += ',';
}
s += 'arguments[' + i + ']';
}
s += ')';
return eval(s);
},
_callEval: function(thisobj, js) {
return eval.call(thisobj, js);
},
getPrompt: function getPrompt(repl) {
return 'EVAL>'
},
_lookupObject: function _lookupObject(repl, id) {
if(typeof id === 'string') {
switch(id) {
case 'global':
return window;
case 'nil':
return null;
case 't':
return true;
case 'false':
return false;
case 'undefined':
return undefined;
case 'repl':
return repl;
case 'interactor':
return this;
case 'NaN':
return NaN;
case 'Infinity':
return Infinity;
case '-Infinity':
return -Infinity;
default:
throw new Error('No object with special id:' + id);
}
}
var ret = repl._jsObjects[id];
if(ret === undefined) {
throw new Error('No object with id:' + id + '(' + typeof id + ')');
}
return ret;
},
_findOrAllocateObject: function _findOrAllocateObject(repl, value) {
if(typeof value !== 'object' && typeof value !== 'function') {
throw new Error('_findOrAllocateObject called on non-object('
+ typeof(value) + '): '
+ value)
}
for(var id in repl._jsObjects) {
id = Number(id);
var obj = repl._jsObjects[id];
if(obj === value) {
return id;
}
}
var id = ++repl._jsLastID;
repl._jsObjects[id] = value;
return id;
},
_fixupList: function _fixupList(repl, list) {
for(var i = 0; i < list.length; ++i) {
if(list[i] instanceof Array) {
this._fixupList(repl, list[i]);
} else if(typeof list[i] === 'object') {
var obj = list[i];
if(obj.funcall) {
var parts = obj.funcall;
this._fixupList(repl, parts);
var [thisobj, func] = this._parseFunc(parts[0]);
list[i] = func.apply(thisobj, parts.slice(1));
} else if(obj.objid) {
list[i] = this._lookupObject(repl, obj.objid);
} else {
throw new Error('Unknown object type: ' + obj.toSource());
}
}
}
},
_parseFunc: function(func) {
var thisobj = null;
if(typeof func === 'string') {
func = window[func];
} else if(func instanceof Array) {
if(func.length === 1 && typeof func[0] !== 'string') {
func = func[0];
} else {
[thisobj, func] = this._parsePropDescriptor(func);
func = thisobj[func];
}
}
return [thisobj,func];
},
_encodeReturn: function(value, array_as_mv) {
var ret;
if(value === null) {
ret = ['special', 'null'];
} else if(value === true) {
ret = ['special', 'true'];
} else if(value === false) {
ret = ['special', 'false'];
} else if(value === undefined) {
ret = ['special', 'undefined'];
} else if(typeof value === 'number') {
if(isNaN(value)) {
ret = ['special', 'NaN'];
} else if(value === Infinity) {
ret = ['special', 'Infinity'];
} else if(value === -Infinity) {
ret = ['special', '-Infinity'];
} else {
ret = ['atom', value];
}
} else if(typeof value === 'string') {
ret = ['atom', value];
} else if(array_as_mv && value instanceof Array) {
ret = ['array', value.map(this._encodeReturn, this)];
} else {
ret = ['objid', this._findOrAllocateObject(repl, value)];
}
return ret;
},
_handleInputLine: function _handleInputLine(repl, line) {
var ret;
var array_as_mv = false;
try {
if(line[0] === '*') {
array_as_mv = true;
line = line.substring(1);
}
var parts = eval(line);
this._fixupList(repl, parts);
var [thisobj, func] = this._parseFunc(parts[0]);
ret = this._encodeReturn(
func.apply(thisobj, parts.slice(1)),
array_as_mv);
} catch(x) {
ret = ['error', x.toString() ];
}
var JSON = Components.classes['@mozilla.org/dom/json;1'].createInstance(Components.interfaces.nsIJSON);
repl.print(JSON.encode(ret));
repl._prompt();
},
handleInput: function handleInput(repl, chunk) {
this._input += chunk;
var match, line;
while(match = this._input.match(/.*\\n/)) {
line = match[0];
if(line === 'EXIT\\n') {
repl.popInteractor();
repl._prompt();
return;
}
this._input = this._input.substring(line.length);
this._handleInputLine(repl, line);
}
}
});
})
")
"String to set MozRepl up into a simple-minded evaluation mode.")
(defun js--js-encode-value (x)
"Marshall the given value for JS.
Strings and numbers are JSON-encoded. Lists (including nil) are
made into JavaScript array literals and their contents encoded
with `js--js-encode-value'."
(cond ((stringp x) (json-encode-string x))
((numberp x) (json-encode-number x))
((symbolp x) (format "{objid:%S}" (symbol-name x)))
((js--js-handle-p x)
(when (js--js-handle-expired-p x)
(error "Stale JS handle"))
(format "{objid:%s}" (js--js-handle-id x)))
((sequencep x)
(if (eq (car-safe x) 'js--funcall)
(format "{funcall:[%s]}"
(mapconcat #'js--js-encode-value (cdr x) ","))
(concat
"[" (mapconcat #'js--js-encode-value x ",") "]")))
(t
(error "Unrecognized item: %S" x))))
(defconst js--js-prompt-regexp "\\(repl[0-9]*\\)> $")
(defconst js--js-repl-prompt-regexp "^EVAL>$")
(defvar js--js-repl-depth 0)
(defun js--js-wait-for-eval-prompt ()
(js--wait-for-matching-output
(inferior-moz-process)
js--js-repl-prompt-regexp js-js-timeout
;; start matching against the beginning of the line in
;; order to catch a prompt that's only partially arrived
(save-excursion (forward-line 0) (point))))
;; Presumably "inferior-moz-process" loads comint.
(declare-function comint-send-string "comint" (process string))
(declare-function comint-send-input "comint"
(&optional no-newline artificial))
(defun js--js-enter-repl ()
(inferior-moz-process) ; called for side-effect
(with-current-buffer inferior-moz-buffer
(goto-char (point-max))
;; Do some initialization the first time we see a process
(unless (eq (inferior-moz-process) js--js-process)
(setq js--js-process (inferior-moz-process))
(setq js--js-references (make-hash-table :test 'eq :weakness t))
(setq js--js-repl-depth 0)
;; Send interactor definition
(comint-send-string js--js-process js--moz-interactor)
(comint-send-string js--js-process
(concat "(" moz-repl-name ")\n"))
(js--wait-for-matching-output
(inferior-moz-process) js--js-prompt-regexp
js-js-timeout))
;; Sanity check
(when (looking-back js--js-prompt-regexp
(save-excursion (forward-line 0) (point)))
(setq js--js-repl-depth 0))
(if (> js--js-repl-depth 0)
;; If js--js-repl-depth > 0, we *should* be seeing an
;; EVAL> prompt. If we don't, give Mozilla a chance to catch
;; up with us.
(js--js-wait-for-eval-prompt)
;; Otherwise, tell Mozilla to enter the interactor mode
(insert (match-string-no-properties 1)
".pushInteractor('js')")
(comint-send-input nil t)
(js--wait-for-matching-output
(inferior-moz-process) js--js-repl-prompt-regexp
js-js-timeout))
(cl-incf js--js-repl-depth)))
(defun js--js-leave-repl ()
(cl-assert (> js--js-repl-depth 0))
(when (= 0 (cl-decf js--js-repl-depth))
(with-current-buffer inferior-moz-buffer
(goto-char (point-max))
(js--js-wait-for-eval-prompt)
(insert "EXIT")
(comint-send-input nil t)
(js--wait-for-matching-output
(inferior-moz-process) js--js-prompt-regexp
js-js-timeout))))
(defsubst js--js-not (value)
(memq value '(nil null false undefined)))
(defsubst js--js-true (value)
(not (js--js-not value)))
(eval-and-compile
(defun js--optimize-arglist (arglist)
"Convert immediate js< and js! references to deferred ones."
(cl-loop for item in arglist
if (eq (car-safe item) 'js<)
collect (append (list 'list ''js--funcall
'(list 'interactor "_getProp"))
(js--optimize-arglist (cdr item)))
else if (eq (car-safe item) 'js>)
collect (append (list 'list ''js--funcall
'(list 'interactor "_putProp"))
(if (atom (cadr item))
(list (cadr item))
(list
(append
(list 'list ''js--funcall
'(list 'interactor "_mkArray"))
(js--optimize-arglist (cadr item)))))
(js--optimize-arglist (cddr item)))
else if (eq (car-safe item) 'js!)
collect (pcase-let ((`(,_ ,function . ,body) item))
(append (list 'list ''js--funcall
(if (consp function)
(cons 'list
(js--optimize-arglist function))
function))
(js--optimize-arglist body)))
else
collect item)))
(defmacro js--js-get-service (class-name interface-name)
`(js! ("Components" "classes" ,class-name "getService")
(js< "Components" "interfaces" ,interface-name)))
(defmacro js--js-create-instance (class-name interface-name)
`(js! ("Components" "classes" ,class-name "createInstance")
(js< "Components" "interfaces" ,interface-name)))
(defmacro js--js-qi (object interface-name)
`(js! (,object "QueryInterface")
(js< "Components" "interfaces" ,interface-name)))
(defmacro with-js (&rest forms)
"Run FORMS with the Mozilla repl set up for js commands.
Inside the lexical scope of `with-js', `js?', `js!',
`js-new', `js-eval', `js-list', `js<', `js>', `js-get-service',
`js-create-instance', and `js-qi' are defined."
`(progn
(js--js-enter-repl)
(unwind-protect
(cl-macrolet ((js? (&rest body) `(js--js-true ,@body))
(js! (function &rest body)
`(js--js-funcall
,(if (consp function)
(cons 'list
(js--optimize-arglist function))
function)
,@(js--optimize-arglist body)))
(js-new (function &rest body)
`(js--js-new
,(if (consp function)
(cons 'list
(js--optimize-arglist function))
function)
,@body))
(js-eval (thisobj js)
`(js--js-eval
,@(js--optimize-arglist
(list thisobj js))))
(js-list (&rest args)
`(js--js-list
,@(js--optimize-arglist args)))
(js-get-service (&rest args)
`(js--js-get-service
,@(js--optimize-arglist args)))
(js-create-instance (&rest args)
`(js--js-create-instance
,@(js--optimize-arglist args)))
(js-qi (&rest args)
`(js--js-qi
,@(js--optimize-arglist args)))
(js< (&rest body) `(js--js-get
,@(js--optimize-arglist body)))
(js> (props value)
`(js--js-funcall
'(interactor "_putProp")
,(if (consp props)
(cons 'list
(js--optimize-arglist props))
props)
,@(js--optimize-arglist (list value))
))
(js-handle? (arg) `(js--js-handle-p ,arg)))
,@forms)
(js--js-leave-repl))))
(defvar js--js-array-as-list nil
"Whether to listify any Array returned by a Mozilla function.
If nil, the whole Array is treated as a JS symbol.")
(defun js--js-decode-retval (result)
(pcase (intern (cl-first result))
(`atom (cl-second result))
(`special (intern (cl-second result)))
(`array
(mapcar #'js--js-decode-retval (cl-second result)))
(`objid
(or (gethash (cl-second result)
js--js-references)
(puthash (cl-second result)
(make-js--js-handle
:id (cl-second result)
:process (inferior-moz-process))
js--js-references)))
(`error (signal 'js-js-error (list (cl-second result))))
(x (error "Unmatched case in js--js-decode-retval: %S" x))))
(defvar comint-last-input-end)
(defun js--js-funcall (function &rest arguments)
"Call the Mozilla function FUNCTION with arguments ARGUMENTS.
If function is a string, look it up as a property on the global
object and use the global object for `this'.
If FUNCTION is a list with one element, use that element as the
function with the global object for `this', except that if that
single element is a string, look it up on the global object.
If FUNCTION is a list with more than one argument, use the list
up to the last value as a property descriptor and the last
argument as a function."
(with-js
(let ((argstr (js--js-encode-value
(cons function arguments))))
(with-current-buffer inferior-moz-buffer
;; Actual funcall
(when js--js-array-as-list
(insert "*"))
(insert argstr)
(comint-send-input nil t)
(js--wait-for-matching-output
(inferior-moz-process) "EVAL>"
js-js-timeout)
(goto-char comint-last-input-end)
;; Read the result
(let* ((json-array-type 'list)
(result (prog1 (json-read)
(goto-char (point-max)))))
(js--js-decode-retval result))))))
(defun js--js-new (constructor &rest arguments)
"Call CONSTRUCTOR as a constructor, with arguments ARGUMENTS.
CONSTRUCTOR is a JS handle, a string, or a list of these things."
(apply #'js--js-funcall
'(interactor "_callNew")
constructor arguments))
(defun js--js-eval (thisobj js)
(js--js-funcall '(interactor "_callEval") thisobj js))
(defun js--js-list (&rest arguments)
"Return a Lisp array resulting from evaluating each of ARGUMENTS."
(let ((js--js-array-as-list t))
(apply #'js--js-funcall '(interactor "_mkArray")
arguments)))
(defun js--js-get (&rest props)
(apply #'js--js-funcall '(interactor "_getProp") props))
(defun js--js-put (props value)
(js--js-funcall '(interactor "_putProp") props value))
(defun js-gc (&optional force)
"Tell the repl about any objects we don't reference anymore.
With argument, run even if no intervening GC has happened."
(interactive)
(when force
(setq js--js-last-gcs-done nil))
(let ((this-gcs-done gcs-done) keys num)
(when (and js--js-references
(boundp 'inferior-moz-buffer)
(buffer-live-p inferior-moz-buffer)
;; Don't bother running unless we've had an intervening
;; garbage collection; without a gc, nothing is deleted
;; from the weak hash table, so it's pointless telling
;; MozRepl about that references we still hold
(not (eq js--js-last-gcs-done this-gcs-done))
;; Are we looking at a normal prompt? Make sure not to
;; interrupt the user if he's doing something
(with-current-buffer inferior-moz-buffer
(save-excursion
(goto-char (point-max))
(looking-back js--js-prompt-regexp
(save-excursion (forward-line 0) (point))))))
(setq keys (cl-loop for x being the hash-keys
of js--js-references
collect x))
(setq num (js--js-funcall '(repl "_jsGC") (or keys [])))
(setq js--js-last-gcs-done this-gcs-done)
(when (called-interactively-p 'interactive)
(message "Cleaned %s entries" num))
num)))
(run-with-idle-timer 30 t #'js-gc)
(defun js-eval (js)
"Evaluate the JavaScript in JS and return JSON-decoded result."
(interactive "MJavascript to evaluate: ")
(with-js
(let* ((content-window (js--js-content-window
(js--get-js-context)))
(result (js-eval content-window js)))
(when (called-interactively-p 'interactive)
(message "%s" (js! "String" result)))
result)))
(defun js--get-tabs ()
"Enumerate all JavaScript contexts available.
Each context is a list:
(TITLE URL BROWSER TAB TABBROWSER) for content documents
(TITLE URL WINDOW) for windows
All tabs of a given window are grouped together. The most recent
window is first. Within each window, the tabs are returned
left-to-right."
(with-js
(let (windows)
(cl-loop with window-mediator = (js! ("Components" "classes"
"@mozilla.org/appshell/window-mediator;1"
"getService")
(js< "Components" "interfaces"
"nsIWindowMediator"))
with enumerator = (js! (window-mediator "getEnumerator") nil)
while (js? (js! (enumerator "hasMoreElements")))
for window = (js! (enumerator "getNext"))
for window-info = (js-list window
(js< window "document" "title")
(js! (window "location" "toString"))
(js< window "closed")
(js< window "windowState"))
unless (or (js? (cl-fourth window-info))
(eq (cl-fifth window-info) 2))
do (push window-info windows))
(cl-loop for window-info in windows
for window = (cl-first window-info)
collect (list (cl-second window-info)
(cl-third window-info)
window)
for gbrowser = (js< window "gBrowser")
if (js-handle? gbrowser)
nconc (cl-loop
for x below (js< gbrowser "browsers" "length")
collect (js-list (js< gbrowser
"browsers"
x
"contentDocument"
"title")
(js! (gbrowser
"browsers"
x
"contentWindow"
"location"
"toString"))
(js< gbrowser
"browsers"
x)
(js! (gbrowser
"tabContainer"
"childNodes"
"item")
x)
gbrowser))))))
(defvar js-read-tab-history nil)
(declare-function ido-chop "ido" (items elem))
(defun js--read-tab (prompt)
"Read a Mozilla tab with prompt PROMPT.
Return a cons of (TYPE . OBJECT). TYPE is either 'window or
'tab, and OBJECT is a JavaScript handle to a ChromeWindow or a
browser, respectively."
;; Prime IDO
(unless ido-mode
(ido-mode 1)
(ido-mode -1))
(with-js
(let ((tabs (js--get-tabs)) selected-tab-cname
selected-tab prev-hitab)
;; Disambiguate names
(setq tabs
(cl-loop with tab-names = (make-hash-table :test 'equal)
for tab in tabs
for cname = (format "%s (%s)"
(cl-second tab) (cl-first tab))
for num = (cl-incf (gethash cname tab-names -1))
if (> num 0)
do (setq cname (format "%s <%d>" cname num))
collect (cons cname tab)))
(cl-labels
((find-tab-by-cname
(cname)
(cl-loop for tab in tabs
if (equal (car tab) cname)
return (cdr tab)))
(mogrify-highlighting
(hitab unhitab)
;; Hack to reduce the number of
;; round-trips to mozilla
(let (cmds)
(cond
;; Highlighting tab
((cl-fourth hitab)
(push '(js! ((cl-fourth hitab) "setAttribute")
"style"
"color: red; font-weight: bold")
cmds)
;; Highlight window proper
(push '(js! ((cl-third hitab)
"setAttribute")
"style"
"border: 8px solid red")
cmds)
;; Select tab, when appropriate
(when js-js-switch-tabs
(push
'(js> ((cl-fifth hitab) "selectedTab") (cl-fourth hitab))
cmds)))
;; Highlighting whole window
((cl-third hitab)
(push '(js! ((cl-third hitab) "document"
"documentElement" "setAttribute")
"style"
(concat "-moz-appearance: none;"
"border: 8px solid red;"))
cmds)))
(cond
;; Unhighlighting tab
((cl-fourth unhitab)
(push '(js! ((cl-fourth unhitab) "setAttribute") "style" "")
cmds)
(push '(js! ((cl-third unhitab) "setAttribute") "style" "")
cmds))
;; Unhighlighting window
((cl-third unhitab)
(push '(js! ((cl-third unhitab) "document"
"documentElement" "setAttribute")
"style" "")
cmds)))
(eval (list 'with-js
(cons 'js-list (nreverse cmds))))))
(command-hook
()
(let* ((tab (find-tab-by-cname (car ido-matches))))
(mogrify-highlighting tab prev-hitab)
(setq prev-hitab tab)))
(setup-hook
()
;; Fiddle with the match list a bit: if our first match
;; is a tabbrowser window, rotate the match list until
;; the active tab comes up
(let ((matched-tab (find-tab-by-cname (car ido-matches))))
(when (and matched-tab
(null (cl-fourth matched-tab))
(equal "navigator:browser"
(js! ((cl-third matched-tab)
"document"
"documentElement"
"getAttribute")
"windowtype")))
(cl-loop with tab-to-match = (js< (cl-third matched-tab)
"gBrowser"
"selectedTab")
for match in ido-matches
for candidate-tab = (find-tab-by-cname match)
if (eq (cl-fourth candidate-tab) tab-to-match)
do (setq ido-cur-list
(ido-chop ido-cur-list match))
and return t)))
(add-hook 'post-command-hook #'command-hook t t)))
(unwind-protect
(setq selected-tab-cname
(let ((ido-minibuffer-setup-hook
(cons #'setup-hook ido-minibuffer-setup-hook)))
(ido-completing-read
prompt
(mapcar #'car tabs)
nil t nil
'js-read-tab-history)))
(when prev-hitab
(mogrify-highlighting nil prev-hitab)
(setq prev-hitab nil)))
(add-to-history 'js-read-tab-history selected-tab-cname)
(setq selected-tab (cl-loop for tab in tabs
if (equal (car tab) selected-tab-cname)
return (cdr tab)))
(cons (if (cl-fourth selected-tab) 'browser 'window)
(cl-third selected-tab))))))
(defun js--guess-eval-defun-info (pstate)
"Helper function for `js-eval-defun'.
Return a list (NAME . CLASSPARTS), where CLASSPARTS is a list of
strings making up the class name and NAME is the name of the
function part."
(cond ((and (= (length pstate) 3)
(eq (js--pitem-type (cl-first pstate)) 'function)
(= (length (js--pitem-name (cl-first pstate))) 1)
(consp (js--pitem-type (cl-second pstate))))
(append (js--pitem-name (cl-second pstate))
(list (cl-first (js--pitem-name (cl-first pstate))))))
((and (= (length pstate) 2)
(eq (js--pitem-type (cl-first pstate)) 'function))
(append
(butlast (js--pitem-name (cl-first pstate)))
(list (car (last (js--pitem-name (cl-first pstate)))))))
(t (error "Function not a toplevel defun or class member"))))
(defvar js--js-context nil
"The current JavaScript context.
This is a cons like the one returned from `js--read-tab'.
Change with `js-set-js-context'.")
(defconst js--js-inserter
"(function(func_info,func) {
func_info.unshift('window');
var obj = window;
for(var i = 1; i < func_info.length - 1; ++i) {
var next = obj[func_info[i]];
if(typeof next !== 'object' && typeof next !== 'function') {
next = obj.prototype && obj.prototype[func_info[i]];
if(typeof next !== 'object' && typeof next !== 'function') {
alert('Could not find ' + func_info.slice(0, i+1).join('.') +
' or ' + func_info.slice(0, i+1).join('.') + '.prototype');
return;
}
func_info.splice(i+1, 0, 'prototype');
++i;
}
}
obj[func_info[i]] = func;
alert('Successfully updated '+func_info.join('.'));
})")
(defun js-set-js-context (context)
"Set the JavaScript context to CONTEXT.
When called interactively, prompt for CONTEXT."
(interactive (list (js--read-tab "Javascript Context: ")))
(setq js--js-context context))
(defun js--get-js-context ()
"Return a valid JavaScript context.
If one hasn't been set, or if it's stale, prompt for a new one."
(with-js
(when (or (null js--js-context)
(js--js-handle-expired-p (cdr js--js-context))
(pcase (car js--js-context)
(`window (js? (js< (cdr js--js-context) "closed")))
(`browser (not (js? (js< (cdr js--js-context)
"contentDocument"))))
(x (error "Unmatched case in js--get-js-context: %S" x))))
(setq js--js-context (js--read-tab "Javascript Context: ")))
js--js-context))
(defun js--js-content-window (context)
(with-js
(pcase (car context)
(`window (cdr context))
(`browser (js< (cdr context)
"contentWindow" "wrappedJSObject"))
(x (error "Unmatched case in js--js-content-window: %S" x)))))
(defun js--make-nsilocalfile (path)
(with-js
(let ((file (js-create-instance "@mozilla.org/file/local;1"
"nsILocalFile")))
(js! (file "initWithPath") path)
file)))
(defun js--js-add-resource-alias (alias path)
(with-js
(let* ((io-service (js-get-service "@mozilla.org/network/io-service;1"
"nsIIOService"))
(res-prot (js! (io-service "getProtocolHandler") "resource"))
(res-prot (js-qi res-prot "nsIResProtocolHandler"))
(path-file (js--make-nsilocalfile path))
(path-uri (js! (io-service "newFileURI") path-file)))
(js! (res-prot "setSubstitution") alias path-uri))))
(cl-defun js-eval-defun ()
"Update a Mozilla tab using the JavaScript defun at point."
(interactive)
;; This function works by generating a temporary file that contains
;; the function we'd like to insert. We then use the elisp-js bridge
;; to command mozilla to load this file by inserting a script tag
;; into the document we set. This way, debuggers and such will have
;; a way to find the source of the just-inserted function.
;;
;; We delete the temporary file if there's an error, but otherwise
;; we add an unload event listener on the Mozilla side to delete the
;; file.
(save-excursion
(let (begin end pstate defun-info temp-name defun-body)
(js-end-of-defun)
(setq end (point))
(js--ensure-cache)
(js-beginning-of-defun)
(re-search-forward "\\_<function\\_>")
(setq begin (match-beginning 0))
(setq pstate (js--forward-pstate))
(when (or (null pstate)
(> (point) end))
(error "Could not locate function definition"))
(setq defun-info (js--guess-eval-defun-info pstate))
(let ((overlay (make-overlay begin end)))
(overlay-put overlay 'face 'highlight)
(unwind-protect
(unless (y-or-n-p (format "Send %s to Mozilla? "
(mapconcat #'identity defun-info ".")))
(message "") ; question message lingers until next command
(cl-return-from js-eval-defun))
(delete-overlay overlay)))
(setq defun-body (buffer-substring-no-properties begin end))
(make-directory js-js-tmpdir t)
;; (Re)register a Mozilla resource URL to point to the
;; temporary directory
(js--js-add-resource-alias "js" js-js-tmpdir)
(setq temp-name (make-temp-file (concat js-js-tmpdir
"/js-")
nil ".js"))
(unwind-protect
(with-js
(with-temp-buffer
(insert js--js-inserter)
(insert "(")
(insert (json-encode-list defun-info))
(insert ",\n")
(insert defun-body)
(insert "\n)")
(write-region (point-min) (point-max) temp-name
nil 1))
;; Give Mozilla responsibility for deleting this file
(let* ((content-window (js--js-content-window
(js--get-js-context)))
(content-document (js< content-window "document"))
(head (if (js? (js< content-document "body"))
;; Regular content
(js< (js! (content-document "getElementsByTagName")
"head")
0)
;; Chrome
(js< content-document "documentElement")))
(elem (js! (content-document "createElementNS")
"http://www.w3.org/1999/xhtml" "script")))
(js! (elem "setAttribute") "type" "text/javascript")
(js! (elem "setAttribute") "src"
(format "resource://js/%s"
(file-name-nondirectory temp-name)))
(js! (head "appendChild") elem)
(js! (content-window "addEventListener") "unload"
(js! ((js-new
"Function" "file"
"return function() { file.remove(false) }"))
(js--make-nsilocalfile temp-name))
'false)
(setq temp-name nil)
))
;; temp-name is set to nil on success
(when temp-name
(delete-file temp-name))))))
;;; Main Function
;;;###autoload
(define-derived-mode js-mode prog-mode "JavaScript"
"Major mode for editing JavaScript."
:group 'js
(setq-local indent-line-function 'js-indent-line)
(setq-local beginning-of-defun-function 'js-beginning-of-defun)
(setq-local end-of-defun-function 'js-end-of-defun)
(setq-local open-paren-in-column-0-is-defun-start nil)
(setq-local font-lock-defaults (list js--font-lock-keywords))
(setq-local syntax-propertize-function #'js-syntax-propertize)
(setq-local prettify-symbols-alist js--prettify-symbols-alist)
(setq-local parse-sexp-ignore-comments t)
(setq-local parse-sexp-lookup-properties t)
(setq-local which-func-imenu-joiner-function #'js--which-func-joiner)
;; Comments
(setq-local comment-start "// ")
(setq-local comment-end "")
(setq-local fill-paragraph-function 'js-c-fill-paragraph)
;; Parse cache
(add-hook 'before-change-functions #'js--flush-caches t t)
;; Frameworks
(js--update-quick-match-re)
;; Imenu
(setq imenu-case-fold-search nil)
(setq imenu-create-index-function #'js--imenu-create-index)
;; for filling, pretend we're cc-mode
(setq c-comment-prefix-regexp "//+\\|\\**"
c-paragraph-start "\\(@[[:alpha:]]+\\>\\|$\\)"
c-paragraph-separate "$"
c-block-comment-prefix "* "
c-line-comment-starter "//"
c-comment-start-regexp "/[*/]\\|\\s!"
comment-start-skip "\\(//+\\|/\\*+\\)\\s *")
(setq-local electric-indent-chars
(append "{}():;," electric-indent-chars)) ;FIXME: js2-mode adds "[]*".
(setq-local electric-layout-rules
'((?\; . after) (?\{ . after) (?\} . before)))
(let ((c-buffer-is-cc-mode t))
;; FIXME: These are normally set by `c-basic-common-init'. Should
;; we call it instead? (Bug#6071)
(make-local-variable 'paragraph-start)
(make-local-variable 'paragraph-separate)
(make-local-variable 'paragraph-ignore-fill-prefix)
(make-local-variable 'adaptive-fill-mode)
(make-local-variable 'adaptive-fill-regexp)
(c-setup-paragraph-variables))
;; Important to fontify the whole buffer syntactically! If we don't,
;; then we might have regular expression literals that aren't marked
;; as strings, which will screw up parse-partial-sexp, scan-lists,
;; etc. and produce maddening "unbalanced parenthesis" errors.
;; When we attempt to find the error and scroll to the portion of
;; the buffer containing the problem, JIT-lock will apply the
;; correct syntax to the regular expression literal and the problem
;; will mysteriously disappear.
;; FIXME: We should instead do this fontification lazily by adding
;; calls to syntax-propertize wherever it's really needed.
;;(syntax-propertize (point-max))
)
;;;###autoload
(define-derived-mode js-jsx-mode js-mode "JSX"
"Major mode for editing JSX.
To customize the indentation for this mode, set the SGML offset
variables (`sgml-basic-offset', `sgml-attribute-offset' et al)
locally, like so:
(defun set-jsx-indentation ()
(setq-local sgml-basic-offset js-indent-level))
(add-hook 'js-jsx-mode-hook #'set-jsx-indentation)"
:group 'js
(setq-local indent-line-function #'js-jsx-indent-line))
;;;###autoload (defalias 'javascript-mode 'js-mode)
(eval-after-load 'folding
'(when (fboundp 'folding-add-to-marks-list)
(folding-add-to-marks-list 'js-mode "// {{{" "// }}}" )))
;;;###autoload
(dolist (name (list "node" "nodejs" "gjs" "rhino"))
(add-to-list 'interpreter-mode-alist (cons (purecopy name) 'js-mode)))
(provide 'js)
;; js.el ends here
|