summaryrefslogtreecommitdiffstats
path: root/dom/bindings/Codegen.py
blob: 809a680d70ccb1a24798f53b1e6b3907bc66cd20 (plain)
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
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472
13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
13677
13678
13679
13680
13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
13744
13745
13746
13747
13748
13749
13750
13751
13752
13753
13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
13853
13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
13869
13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
13880
13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
13916
13917
13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
14024
14025
14026
14027
14028
14029
14030
14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
14066
14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
14083
14084
14085
14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
14167
14168
14169
14170
14171
14172
14173
14174
14175
14176
14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
14244
14245
14246
14247
14248
14249
14250
14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
14294
14295
14296
14297
14298
14299
14300
14301
14302
14303
14304
14305
14306
14307
14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
14322
14323
14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365
14366
14367
14368
14369
14370
14371
14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
14413
14414
14415
14416
14417
14418
14419
14420
14421
14422
14423
14424
14425
14426
14427
14428
14429
14430
14431
14432
14433
14434
14435
14436
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
14499
14500
14501
14502
14503
14504
14505
14506
14507
14508
14509
14510
14511
14512
14513
14514
14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
14529
14530
14531
14532
14533
14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578
14579
14580
14581
14582
14583
14584
14585
14586
14587
14588
14589
14590
14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622
14623
14624
14625
14626
14627
14628
14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
14645
14646
14647
14648
14649
14650
14651
14652
14653
14654
14655
14656
14657
14658
14659
14660
14661
14662
14663
14664
14665
14666
14667
14668
14669
14670
14671
14672
14673
14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
14684
14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
14708
14709
14710
14711
14712
14713
14714
14715
14716
14717
14718
14719
14720
14721
14722
14723
14724
14725
14726
14727
14728
14729
14730
14731
14732
14733
14734
14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
14746
14747
14748
14749
14750
14751
14752
14753
14754
14755
14756
14757
14758
14759
14760
14761
14762
14763
14764
14765
14766
14767
14768
14769
14770
14771
14772
14773
14774
14775
14776
14777
14778
14779
14780
14781
14782
14783
14784
14785
14786
14787
14788
14789
14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
14825
14826
14827
14828
14829
14830
14831
14832
14833
14834
14835
14836
14837
14838
14839
14840
14841
14842
14843
14844
14845
14846
14847
14848
14849
14850
14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862
14863
14864
14865
14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
14876
14877
14878
14879
14880
14881
14882
14883
14884
14885
14886
14887
14888
14889
14890
14891
14892
14893
14894
14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
14905
14906
14907
14908
14909
14910
14911
14912
14913
14914
14915
14916
14917
14918
14919
14920
14921
14922
14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
14951
14952
14953
14954
14955
14956
14957
14958
14959
14960
14961
14962
14963
14964
14965
14966
14967
14968
14969
14970
14971
14972
14973
14974
14975
14976
14977
14978
14979
14980
14981
14982
14983
14984
14985
14986
14987
14988
14989
14990
14991
14992
14993
14994
14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015
15016
15017
15018
15019
15020
15021
15022
15023
15024
15025
15026
15027
15028
15029
15030
15031
15032
15033
15034
15035
15036
15037
15038
15039
15040
15041
15042
15043
15044
15045
15046
15047
15048
15049
15050
15051
15052
15053
15054
15055
15056
15057
15058
15059
15060
15061
15062
15063
15064
15065
15066
15067
15068
15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079
15080
15081
15082
15083
15084
15085
15086
15087
15088
15089
15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
15103
15104
15105
15106
15107
15108
15109
15110
15111
15112
15113
15114
15115
15116
15117
15118
15119
15120
15121
15122
15123
15124
15125
15126
15127
15128
15129
15130
15131
15132
15133
15134
15135
15136
15137
15138
15139
15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
15168
15169
15170
15171
15172
15173
15174
15175
15176
15177
15178
15179
15180
15181
15182
15183
15184
15185
15186
15187
15188
15189
15190
15191
15192
15193
15194
15195
15196
15197
15198
15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
15240
15241
15242
15243
15244
15245
15246
15247
15248
15249
15250
15251
15252
15253
15254
15255
15256
15257
15258
15259
15260
15261
15262
15263
15264
15265
15266
15267
15268
15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
15309
15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
15330
15331
15332
15333
15334
15335
15336
15337
15338
15339
15340
15341
15342
15343
15344
15345
15346
15347
15348
15349
15350
15351
15352
15353
15354
15355
15356
15357
15358
15359
15360
15361
15362
15363
15364
15365
15366
15367
15368
15369
15370
15371
15372
15373
15374
15375
15376
15377
15378
15379
15380
15381
15382
15383
15384
15385
15386
15387
15388
15389
15390
15391
15392
15393
15394
15395
15396
15397
15398
15399
15400
15401
15402
15403
15404
15405
15406
15407
15408
15409
15410
15411
15412
15413
15414
15415
15416
15417
15418
15419
15420
15421
15422
15423
15424
15425
15426
15427
15428
15429
15430
15431
15432
15433
15434
15435
15436
15437
15438
15439
15440
15441
15442
15443
15444
15445
15446
15447
15448
15449
15450
15451
15452
15453
15454
15455
15456
15457
15458
15459
15460
15461
15462
15463
15464
15465
15466
15467
15468
15469
15470
15471
15472
15473
15474
15475
15476
15477
15478
15479
15480
15481
15482
15483
15484
15485
15486
15487
15488
15489
15490
15491
15492
15493
15494
15495
15496
15497
15498
15499
15500
15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
15511
15512
15513
15514
15515
15516
15517
15518
15519
15520
15521
15522
15523
15524
15525
15526
15527
15528
15529
15530
15531
15532
15533
15534
15535
15536
15537
15538
15539
15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
15555
15556
15557
15558
15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
15589
15590
15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626
15627
15628
15629
15630
15631
15632
15633
15634
15635
15636
15637
15638
15639
15640
15641
15642
15643
15644
15645
15646
15647
15648
15649
15650
15651
15652
15653
15654
15655
15656
15657
15658
15659
15660
15661
15662
15663
15664
15665
15666
15667
15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
15722
15723
15724
15725
15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
15742
15743
15744
15745
15746
15747
15748
15749
15750
15751
15752
15753
15754
15755
15756
15757
15758
15759
15760
15761
15762
15763
15764
15765
15766
15767
15768
15769
15770
15771
15772
15773
15774
15775
15776
15777
15778
15779
15780
15781
15782
15783
15784
15785
15786
15787
15788
15789
15790
15791
15792
15793
15794
15795
15796
15797
15798
15799
15800
15801
15802
15803
15804
15805
15806
15807
15808
15809
15810
15811
15812
15813
15814
15815
15816
15817
15818
15819
15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
15853
15854
15855
15856
15857
15858
15859
15860
15861
15862
15863
15864
15865
15866
15867
15868
15869
15870
15871
15872
15873
15874
15875
15876
15877
15878
15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
15892
15893
15894
15895
15896
15897
15898
15899
15900
15901
15902
15903
15904
15905
15906
15907
15908
15909
15910
15911
15912
15913
15914
15915
15916
15917
15918
15919
15920
15921
15922
15923
15924
15925
15926
15927
15928
15929
15930
15931
15932
15933
15934
15935
15936
15937
15938
15939
15940
15941
15942
15943
15944
15945
15946
15947
15948
15949
15950
15951
15952
15953
15954
15955
15956
15957
15958
15959
15960
15961
15962
15963
15964
15965
15966
15967
15968
15969
15970
15971
15972
15973
15974
15975
15976
15977
15978
15979
15980
15981
15982
15983
15984
15985
15986
15987
15988
15989
15990
15991
15992
15993
15994
15995
15996
15997
15998
15999
16000
16001
16002
16003
16004
16005
16006
16007
16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
16024
16025
16026
16027
16028
16029
16030
16031
16032
16033
16034
16035
16036
16037
16038
16039
16040
16041
16042
16043
16044
16045
16046
16047
16048
16049
16050
16051
16052
16053
16054
16055
16056
16057
16058
16059
16060
16061
16062
16063
16064
16065
16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
16079
16080
16081
16082
16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
16110
16111
16112
16113
16114
16115
16116
16117
16118
16119
16120
16121
16122
16123
16124
16125
16126
16127
16128
16129
16130
16131
16132
16133
16134
16135
16136
16137
16138
16139
16140
16141
16142
16143
16144
16145
16146
16147
16148
16149
16150
16151
16152
16153
16154
16155
16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
16166
16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
16178
16179
16180
16181
16182
16183
16184
16185
16186
16187
16188
16189
16190
16191
16192
16193
16194
16195
16196
16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
16210
16211
16212
16213
16214
16215
16216
16217
16218
16219
16220
16221
16222
16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
16238
16239
16240
16241
16242
16243
16244
16245
16246
16247
16248
16249
16250
16251
16252
16253
16254
16255
16256
16257
16258
16259
16260
16261
16262
16263
16264
16265
16266
16267
16268
16269
16270
16271
16272
16273
16274
16275
16276
16277
16278
16279
16280
16281
16282
16283
16284
16285
16286
16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
16305
16306
16307
16308
16309
16310
16311
16312
16313
16314
16315
16316
16317
16318
16319
16320
16321
16322
16323
16324
16325
16326
16327
16328
16329
16330
16331
16332
16333
16334
16335
16336
16337
16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
16349
16350
16351
16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
16369
16370
16371
16372
16373
16374
16375
16376
16377
16378
16379
16380
16381
16382
16383
16384
16385
16386
16387
16388
16389
16390
16391
16392
16393
16394
16395
16396
16397
16398
16399
16400
16401
16402
16403
16404
16405
16406
16407
16408
16409
16410
16411
16412
16413
16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
16424
16425
16426
16427
16428
16429
16430
16431
16432
16433
16434
16435
16436
16437
16438
16439
16440
16441
16442
16443
16444
16445
16446
16447
16448
16449
16450
16451
16452
16453
16454
16455
16456
16457
16458
16459
16460
16461
16462
16463
16464
16465
16466
16467
16468
16469
16470
16471
16472
16473
16474
16475
16476
16477
16478
16479
16480
16481
16482
16483
16484
16485
16486
16487
16488
16489
16490
16491
16492
16493
16494
16495
16496
16497
16498
16499
16500
16501
16502
16503
16504
16505
16506
16507
16508
16509
16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
16522
16523
16524
16525
16526
16527
16528
16529
16530
16531
16532
16533
16534
16535
16536
16537
16538
16539
16540
16541
16542
16543
16544
16545
16546
16547
16548
16549
16550
16551
16552
16553
16554
16555
16556
16557
16558
16559
16560
16561
16562
16563
16564
16565
16566
16567
16568
16569
16570
16571
16572
16573
16574
16575
16576
16577
16578
16579
16580
16581
16582
16583
16584
16585
16586
16587
16588
16589
16590
16591
16592
16593
16594
16595
16596
16597
16598
16599
16600
16601
16602
16603
16604
16605
16606
16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
16619
16620
16621
16622
16623
16624
16625
16626
16627
16628
16629
16630
16631
16632
16633
16634
16635
16636
16637
16638
16639
16640
16641
16642
16643
16644
16645
16646
16647
16648
16649
16650
16651
16652
16653
16654
16655
16656
16657
16658
16659
16660
16661
16662
16663
16664
16665
16666
16667
16668
16669
16670
16671
16672
16673
16674
16675
16676
16677
16678
16679
16680
16681
16682
16683
16684
16685
16686
16687
16688
16689
16690
16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
16704
16705
16706
16707
16708
16709
16710
16711
16712
16713
16714
16715
16716
16717
16718
16719
16720
16721
16722
16723
16724
16725
16726
16727
16728
16729
16730
16731
16732
16733
16734
16735
16736
16737
16738
16739
16740
16741
16742
16743
16744
16745
16746
16747
16748
16749
16750
16751
16752
16753
16754
16755
16756
16757
16758
16759
16760
16761
16762
16763
16764
16765
16766
16767
16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782
16783
16784
16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
16795
16796
16797
16798
16799
16800
16801
16802
16803
16804
16805
16806
16807
16808
16809
16810
16811
16812
16813
16814
16815
16816
16817
16818
16819
16820
16821
16822
16823
16824
16825
16826
16827
16828
16829
16830
16831
16832
16833
16834
16835
16836
16837
16838
16839
16840
16841
16842
16843
16844
16845
16846
16847
16848
16849
16850
16851
16852
16853
16854
16855
16856
16857
16858
16859
16860
16861
16862
16863
16864
16865
16866
16867
16868
16869
16870
16871
16872
16873
16874
16875
16876
16877
16878
16879
16880
16881
16882
16883
16884
16885
16886
16887
16888
16889
16890
16891
16892
16893
16894
16895
16896
16897
16898
16899
16900
16901
16902
16903
16904
16905
16906
16907
16908
16909
16910
16911
16912
16913
16914
16915
16916
16917
16918
16919
16920
16921
16922
16923
16924
16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
16940
16941
16942
16943
16944
16945
16946
16947
16948
16949
16950
16951
16952
16953
16954
16955
16956
16957
16958
16959
16960
16961
16962
16963
16964
16965
16966
16967
16968
16969
16970
16971
16972
16973
16974
16975
16976
16977
16978
16979
16980
16981
16982
16983
16984
16985
16986
16987
16988
16989
16990
16991
16992
16993
16994
16995
16996
16997
16998
16999
17000
17001
17002
17003
17004
17005
17006
17007
17008
17009
17010
17011
17012
17013
17014
17015
17016
17017
17018
17019
17020
17021
17022
17023
17024
17025
17026
17027
17028
17029
17030
17031
17032
17033
17034
17035
17036
17037
17038
17039
17040
17041
17042
17043
17044
17045
17046
17047
17048
17049
17050
17051
17052
17053
17054
17055
17056
17057
17058
17059
17060
17061
17062
17063
17064
17065
17066
17067
17068
17069
17070
17071
17072
17073
17074
17075
17076
17077
17078
17079
17080
17081
17082
17083
17084
17085
17086
17087
17088
17089
17090
17091
17092
17093
17094
17095
17096
17097
17098
17099
17100
17101
17102
17103
17104
17105
17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
17127
17128
17129
17130
17131
17132
17133
17134
17135
17136
17137
17138
17139
17140
17141
17142
17143
17144
17145
17146
17147
17148
17149
17150
17151
17152
17153
17154
17155
17156
17157
17158
17159
17160
17161
17162
17163
17164
17165
17166
17167
17168
17169
17170
17171
17172
17173
17174
17175
17176
17177
17178
17179
17180
17181
17182
17183
17184
17185
17186
17187
17188
17189
17190
17191
17192
17193
17194
17195
17196
17197
17198
17199
17200
17201
17202
17203
17204
17205
17206
17207
17208
17209
17210
17211
17212
17213
17214
17215
17216
17217
17218
17219
17220
17221
17222
17223
17224
17225
17226
17227
17228
17229
17230
17231
17232
17233
17234
17235
17236
17237
17238
17239
17240
17241
17242
17243
17244
17245
17246
17247
17248
17249
17250
17251
17252
17253
17254
17255
17256
17257
17258
17259
17260
17261
17262
17263
17264
17265
17266
17267
17268
17269
17270
17271
17272
17273
17274
17275
17276
17277
17278
17279
17280
17281
17282
17283
17284
17285
17286
17287
17288
17289
17290
17291
17292
17293
17294
17295
17296
17297
17298
17299
17300
17301
17302
17303
17304
17305
17306
17307
17308
17309
17310
17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
17325
17326
17327
17328
17329
17330
17331
17332
17333
17334
17335
17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
17349
17350
17351
17352
17353
17354
17355
17356
17357
17358
17359
17360
17361
17362
17363
17364
17365
17366
17367
17368
17369
17370
17371
17372
17373
17374
17375
17376
17377
17378
17379
17380
17381
17382
17383
17384
17385
17386
17387
17388
17389
17390
17391
17392
17393
17394
17395
17396
17397
17398
17399
17400
17401
17402
17403
17404
17405
17406
17407
17408
17409
17410
17411
17412
17413
17414
17415
17416
17417
17418
17419
17420
17421
17422
17423
17424
17425
17426
17427
17428
17429
17430
17431
17432
17433
17434
17435
17436
17437
17438
17439
17440
17441
17442
17443
17444
17445
17446
17447
17448
17449
17450
17451
17452
17453
17454
17455
17456
17457
17458
17459
17460
17461
17462
17463
17464
17465
17466
17467
17468
17469
17470
17471
17472
17473
17474
17475
17476
17477
17478
17479
17480
17481
17482
17483
17484
17485
17486
17487
17488
17489
17490
17491
17492
17493
17494
17495
17496
17497
17498
17499
17500
17501
17502
17503
17504
17505
17506
17507
17508
17509
17510
17511
17512
17513
17514
17515
17516
17517
17518
17519
17520
17521
17522
17523
17524
17525
17526
17527
17528
17529
17530
17531
17532
17533
17534
17535
17536
17537
17538
17539
17540
17541
17542
17543
17544
17545
17546
17547
17548
17549
17550
17551
17552
17553
17554
17555
17556
17557
17558
17559
17560
17561
17562
17563
17564
17565
17566
17567
17568
17569
17570
17571
17572
17573
17574
17575
17576
17577
17578
17579
17580
17581
17582
17583
17584
17585
17586
17587
17588
17589
17590
17591
17592
17593
17594
17595
17596
17597
17598
17599
17600
17601
17602
17603
17604
17605
17606
17607
17608
17609
17610
17611
17612
17613
17614
17615
17616
17617
17618
17619
17620
17621
17622
17623
17624
17625
17626
17627
17628
17629
17630
17631
17632
17633
17634
17635
17636
17637
17638
17639
17640
17641
17642
17643
17644
17645
17646
17647
17648
17649
17650
17651
17652
17653
17654
17655
17656
17657
17658
17659
17660
17661
17662
17663
17664
17665
17666
17667
17668
17669
17670
17671
17672
17673
17674
17675
17676
17677
17678
17679
17680
17681
17682
17683
17684
17685
17686
17687
17688
17689
17690
17691
17692
17693
17694
17695
17696
17697
17698
17699
17700
17701
17702
17703
17704
17705
17706
17707
17708
17709
17710
17711
17712
17713
17714
17715
17716
17717
17718
17719
17720
17721
17722
17723
17724
17725
17726
17727
17728
17729
17730
17731
17732
17733
17734
17735
17736
17737
17738
17739
17740
17741
17742
17743
17744
17745
17746
17747
17748
17749
17750
17751
17752
17753
17754
17755
17756
17757
17758
17759
17760
17761
17762
17763
17764
17765
17766
17767
17768
17769
17770
17771
17772
17773
17774
17775
17776
17777
17778
17779
17780
17781
17782
17783
17784
17785
17786
17787
17788
17789
17790
17791
17792
17793
17794
17795
17796
17797
17798
17799
17800
17801
17802
17803
17804
17805
17806
17807
17808
17809
17810
17811
17812
17813
17814
17815
17816
17817
17818
17819
17820
17821
17822
17823
17824
17825
17826
17827
17828
17829
17830
17831
17832
17833
17834
17835
17836
17837
17838
17839
17840
17841
17842
17843
17844
17845
17846
17847
17848
17849
17850
17851
17852
17853
17854
17855
17856
17857
17858
17859
17860
17861
17862
17863
17864
17865
17866
17867
17868
17869
17870
17871
17872
17873
17874
17875
17876
17877
17878
17879
17880
17881
17882
17883
17884
17885
17886
17887
17888
17889
17890
17891
17892
17893
17894
17895
17896
17897
17898
17899
17900
17901
17902
17903
17904
17905
17906
17907
17908
17909
17910
17911
17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
17924
17925
17926
17927
17928
17929
17930
17931
17932
17933
17934
17935
17936
17937
17938
17939
17940
17941
17942
17943
17944
17945
17946
17947
17948
17949
17950
17951
17952
17953
17954
17955
17956
17957
17958
17959
17960
17961
17962
17963
17964
17965
17966
17967
17968
17969
17970
17971
17972
17973
17974
17975
17976
17977
17978
17979
17980
17981
17982
17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
17995
17996
17997
17998
17999
18000
18001
18002
18003
18004
18005
18006
18007
18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
18040
18041
18042
18043
18044
18045
18046
18047
18048
18049
18050
18051
18052
18053
18054
18055
18056
18057
18058
18059
18060
18061
18062
18063
18064
18065
18066
18067
18068
18069
18070
18071
18072
18073
18074
18075
18076
18077
18078
18079
18080
18081
18082
18083
18084
18085
18086
18087
18088
18089
18090
18091
18092
18093
18094
18095
18096
18097
18098
18099
18100
18101
18102
18103
18104
18105
18106
18107
18108
18109
18110
18111
18112
18113
18114
18115
18116
18117
18118
18119
18120
18121
18122
18123
18124
18125
18126
18127
18128
18129
18130
18131
18132
18133
18134
18135
18136
18137
18138
18139
18140
18141
18142
18143
18144
18145
18146
18147
18148
18149
18150
18151
18152
18153
18154
18155
18156
18157
18158
18159
18160
18161
18162
18163
18164
18165
18166
18167
18168
18169
18170
18171
18172
18173
18174
18175
18176
18177
18178
18179
18180
18181
18182
18183
18184
18185
18186
18187
18188
18189
18190
18191
18192
18193
18194
18195
18196
18197
18198
18199
18200
18201
18202
18203
18204
18205
18206
18207
18208
18209
18210
18211
18212
18213
18214
18215
18216
18217
18218
18219
18220
18221
18222
18223
18224
18225
18226
18227
18228
18229
18230
18231
18232
18233
18234
18235
18236
18237
18238
18239
18240
18241
18242
18243
18244
18245
18246
18247
18248
18249
18250
18251
18252
18253
18254
18255
18256
18257
18258
18259
18260
18261
18262
18263
18264
18265
18266
18267
18268
18269
18270
18271
18272
18273
18274
18275
18276
18277
18278
18279
18280
18281
18282
18283
18284
18285
18286
18287
18288
18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
18299
18300
18301
18302
18303
18304
18305
18306
18307
18308
18309
18310
18311
18312
18313
18314
18315
18316
18317
18318
18319
18320
18321
18322
18323
18324
18325
18326
18327
18328
18329
18330
18331
18332
18333
18334
18335
18336
18337
18338
18339
18340
18341
18342
18343
18344
18345
18346
18347
18348
18349
18350
18351
18352
18353
18354
18355
18356
18357
18358
18359
18360
18361
18362
18363
18364
18365
18366
18367
18368
18369
18370
18371
18372
18373
18374
18375
18376
18377
18378
18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
18392
18393
18394
18395
18396
18397
18398
18399
18400
18401
18402
18403
18404
18405
18406
18407
18408
18409
18410
18411
18412
18413
18414
18415
18416
18417
18418
18419
18420
18421
18422
18423
18424
18425
18426
18427
18428
18429
18430
18431
18432
18433
18434
18435
18436
18437
18438
18439
18440
18441
18442
18443
18444
18445
18446
18447
18448
18449
18450
18451
18452
18453
18454
18455
18456
18457
18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
18473
18474
18475
18476
18477
18478
18479
18480
18481
18482
18483
18484
18485
18486
18487
18488
18489
18490
18491
18492
18493
18494
18495
18496
18497
18498
18499
18500
18501
18502
18503
18504
18505
18506
18507
18508
18509
18510
18511
18512
18513
18514
18515
18516
18517
18518
18519
18520
18521
18522
18523
18524
18525
18526
18527
18528
18529
18530
18531
18532
18533
18534
18535
18536
18537
18538
18539
18540
18541
18542
18543
18544
18545
18546
18547
18548
18549
18550
18551
18552
18553
18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
18586
18587
18588
18589
18590
18591
18592
18593
18594
18595
18596
18597
18598
18599
18600
18601
18602
18603
18604
18605
18606
18607
18608
18609
18610
18611
18612
18613
18614
18615
18616
18617
18618
18619
18620
18621
18622
18623
18624
18625
18626
18627
18628
18629
18630
18631
18632
18633
18634
18635
18636
18637
18638
18639
18640
18641
18642
18643
18644
18645
18646
18647
18648
18649
18650
18651
18652
18653
18654
18655
18656
18657
18658
18659
18660
18661
18662
18663
18664
18665
18666
18667
18668
18669
18670
18671
18672
18673
18674
18675
18676
18677
18678
18679
18680
18681
18682
18683
18684
18685
18686
18687
18688
18689
18690
18691
18692
18693
18694
18695
18696
18697
18698
18699
18700
18701
18702
18703
18704
18705
18706
18707
18708
18709
18710
18711
18712
18713
18714
18715
18716
18717
18718
18719
18720
18721
18722
18723
18724
18725
18726
18727
18728
18729
18730
18731
18732
18733
18734
18735
18736
18737
18738
18739
18740
18741
18742
18743
18744
18745
18746
18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
18763
18764
18765
18766
18767
18768
18769
18770
18771
18772
18773
18774
18775
18776
18777
18778
18779
18780
18781
18782
18783
18784
18785
18786
18787
18788
18789
18790
18791
18792
18793
18794
18795
18796
18797
18798
18799
18800
18801
18802
18803
18804
18805
18806
18807
18808
18809
18810
18811
18812
18813
18814
18815
18816
18817
18818
18819
18820
18821
18822
18823
18824
18825
18826
18827
18828
18829
18830
18831
18832
18833
18834
18835
18836
18837
18838
18839
18840
18841
18842
18843
18844
18845
18846
18847
18848
18849
18850
18851
18852
18853
18854
18855
18856
18857
18858
18859
18860
18861
18862
18863
18864
18865
18866
18867
18868
18869
18870
18871
18872
18873
18874
18875
18876
18877
18878
18879
18880
18881
18882
18883
18884
18885
18886
18887
18888
18889
18890
18891
18892
18893
18894
18895
18896
18897
18898
18899
18900
18901
18902
18903
18904
18905
18906
18907
18908
18909
18910
18911
18912
18913
18914
18915
18916
18917
18918
18919
18920
18921
18922
18923
18924
18925
18926
18927
18928
18929
18930
18931
18932
18933
18934
18935
18936
18937
18938
18939
18940
18941
18942
18943
18944
18945
18946
18947
18948
18949
18950
18951
18952
18953
18954
18955
18956
18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
18983
18984
18985
18986
18987
18988
18989
18990
18991
18992
18993
18994
18995
18996
18997
18998
18999
19000
19001
19002
19003
19004
19005
19006
19007
19008
19009
19010
19011
19012
19013
19014
19015
19016
19017
19018
19019
19020
19021
19022
19023
19024
19025
19026
19027
19028
19029
19030
19031
19032
19033
19034
19035
19036
19037
19038
19039
19040
19041
19042
19043
19044
19045
19046
19047
19048
19049
19050
19051
19052
19053
19054
19055
19056
19057
19058
19059
19060
19061
19062
19063
19064
19065
19066
19067
19068
19069
19070
19071
19072
19073
19074
19075
19076
19077
19078
19079
19080
19081
19082
19083
19084
19085
19086
19087
19088
19089
19090
19091
19092
19093
19094
19095
19096
19097
19098
19099
19100
19101
19102
19103
19104
19105
19106
19107
19108
19109
19110
19111
19112
19113
19114
19115
19116
19117
19118
19119
19120
19121
19122
19123
19124
19125
19126
19127
19128
19129
19130
19131
19132
19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
19155
19156
19157
19158
19159
19160
19161
19162
19163
19164
19165
19166
19167
19168
19169
19170
19171
19172
19173
19174
19175
19176
19177
19178
19179
19180
19181
19182
19183
19184
19185
19186
19187
19188
19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
19203
19204
19205
19206
19207
19208
19209
19210
19211
19212
19213
19214
19215
19216
19217
19218
19219
19220
19221
19222
19223
19224
19225
19226
19227
19228
19229
19230
19231
19232
19233
19234
19235
19236
19237
19238
19239
19240
19241
19242
19243
19244
19245
19246
19247
19248
19249
19250
19251
19252
19253
19254
19255
19256
19257
19258
19259
19260
19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
19277
19278
19279
19280
19281
19282
19283
19284
19285
19286
19287
19288
19289
19290
19291
19292
19293
19294
19295
19296
19297
19298
19299
19300
19301
19302
19303
19304
19305
19306
19307
19308
19309
19310
19311
19312
19313
19314
19315
19316
19317
19318
19319
19320
19321
19322
19323
19324
19325
19326
19327
19328
19329
19330
19331
19332
19333
19334
19335
19336
19337
19338
19339
19340
19341
19342
19343
19344
19345
19346
19347
19348
19349
19350
19351
19352
19353
19354
19355
19356
19357
19358
19359
19360
19361
19362
19363
19364
19365
19366
19367
19368
19369
19370
19371
19372
19373
19374
19375
19376
19377
19378
19379
19380
19381
19382
19383
19384
19385
19386
19387
19388
19389
19390
19391
19392
19393
19394
19395
19396
19397
19398
19399
19400
19401
19402
19403
19404
19405
19406
19407
19408
19409
19410
19411
19412
19413
19414
19415
19416
19417
19418
19419
19420
19421
19422
19423
19424
19425
19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
19441
19442
19443
19444
19445
19446
19447
19448
19449
19450
19451
19452
19453
19454
19455
19456
19457
19458
19459
19460
19461
19462
19463
19464
19465
19466
19467
19468
19469
19470
19471
19472
19473
19474
19475
19476
19477
19478
19479
19480
19481
19482
19483
19484
19485
19486
19487
19488
19489
19490
19491
19492
19493
19494
19495
19496
19497
19498
19499
19500
19501
19502
19503
19504
19505
19506
19507
19508
19509
19510
19511
19512
19513
19514
19515
19516
19517
19518
19519
19520
19521
19522
19523
19524
19525
19526
19527
19528
19529
19530
19531
19532
19533
19534
19535
19536
19537
19538
19539
19540
19541
19542
19543
19544
19545
19546
19547
19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
19561
19562
19563
19564
19565
19566
19567
19568
19569
19570
19571
19572
19573
19574
19575
19576
19577
19578
19579
19580
19581
19582
19583
19584
19585
19586
19587
19588
19589
19590
19591
19592
19593
19594
19595
19596
19597
19598
19599
19600
19601
19602
19603
19604
19605
19606
19607
19608
19609
19610
19611
19612
19613
19614
19615
19616
19617
19618
19619
19620
19621
19622
19623
19624
19625
19626
19627
19628
19629
19630
19631
19632
19633
19634
19635
19636
19637
19638
19639
19640
19641
19642
19643
19644
19645
19646
19647
19648
19649
19650
19651
19652
19653
19654
19655
19656
19657
19658
19659
19660
19661
19662
19663
19664
19665
19666
19667
19668
19669
19670
19671
19672
19673
19674
19675
19676
19677
19678
19679
19680
19681
19682
19683
19684
19685
19686
19687
19688
19689
19690
19691
19692
19693
19694
19695
19696
19697
19698
19699
19700
19701
19702
19703
19704
19705
19706
19707
19708
19709
19710
19711
19712
19713
19714
19715
19716
19717
19718
19719
19720
19721
19722
19723
19724
19725
19726
19727
19728
19729
19730
19731
19732
19733
19734
19735
19736
19737
19738
19739
19740
19741
19742
19743
19744
19745
19746
19747
19748
19749
19750
19751
19752
19753
19754
19755
19756
19757
19758
19759
19760
19761
19762
19763
19764
19765
19766
19767
19768
19769
19770
19771
19772
19773
19774
19775
19776
19777
19778
19779
19780
19781
19782
19783
19784
19785
19786
19787
19788
19789
19790
19791
19792
19793
19794
19795
19796
19797
19798
19799
19800
19801
19802
19803
19804
19805
19806
19807
19808
19809
19810
19811
19812
19813
19814
19815
19816
19817
19818
19819
19820
19821
19822
19823
19824
19825
19826
19827
19828
19829
19830
19831
19832
19833
19834
19835
19836
19837
19838
19839
19840
19841
19842
19843
19844
19845
19846
19847
19848
19849
19850
19851
19852
19853
19854
19855
19856
19857
19858
19859
19860
19861
19862
19863
19864
19865
19866
19867
19868
19869
19870
19871
19872
19873
19874
19875
19876
19877
19878
19879
19880
19881
19882
19883
19884
19885
19886
19887
19888
19889
19890
19891
19892
19893
19894
19895
19896
19897
19898
19899
19900
19901
19902
19903
19904
19905
19906
19907
19908
19909
19910
19911
19912
19913
19914
19915
19916
19917
19918
19919
19920
19921
19922
19923
19924
19925
19926
19927
19928
19929
19930
19931
19932
19933
19934
19935
19936
19937
19938
19939
19940
19941
19942
19943
19944
19945
19946
19947
19948
19949
19950
19951
19952
19953
19954
19955
19956
19957
19958
19959
19960
19961
19962
19963
19964
19965
19966
19967
19968
19969
19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
19985
19986
19987
19988
19989
19990
19991
19992
19993
19994
19995
19996
19997
19998
19999
20000
20001
20002
20003
20004
20005
20006
20007
20008
20009
20010
20011
20012
20013
20014
20015
20016
20017
20018
20019
20020
20021
20022
20023
20024
20025
20026
20027
20028
20029
20030
20031
20032
20033
20034
20035
20036
20037
20038
20039
20040
20041
20042
20043
20044
20045
20046
20047
20048
20049
20050
20051
20052
20053
20054
20055
20056
20057
20058
20059
20060
20061
20062
20063
20064
20065
20066
20067
20068
20069
20070
20071
20072
20073
20074
20075
20076
20077
20078
20079
20080
20081
20082
20083
20084
20085
20086
20087
20088
20089
20090
20091
20092
20093
20094
20095
20096
20097
20098
20099
20100
20101
20102
20103
20104
20105
20106
20107
20108
20109
20110
20111
20112
20113
20114
20115
20116
20117
20118
20119
20120
20121
20122
20123
20124
20125
20126
20127
20128
20129
20130
20131
20132
20133
20134
20135
20136
20137
20138
20139
20140
20141
20142
20143
20144
20145
20146
20147
20148
20149
20150
20151
20152
20153
20154
20155
20156
20157
20158
20159
20160
20161
20162
20163
20164
20165
20166
20167
20168
20169
20170
20171
20172
20173
20174
20175
20176
20177
20178
20179
20180
20181
20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
20213
20214
20215
20216
20217
20218
20219
20220
20221
20222
20223
20224
20225
20226
20227
20228
20229
20230
20231
20232
20233
20234
20235
20236
20237
20238
20239
20240
20241
20242
20243
20244
20245
20246
20247
20248
20249
20250
20251
20252
20253
20254
20255
20256
20257
20258
20259
20260
20261
20262
20263
20264
20265
20266
20267
20268
20269
20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
20284
20285
20286
20287
20288
20289
20290
20291
20292
20293
20294
20295
20296
20297
20298
20299
20300
20301
20302
20303
20304
20305
20306
20307
20308
20309
20310
20311
20312
20313
20314
20315
20316
20317
20318
20319
20320
20321
20322
20323
20324
20325
20326
20327
20328
20329
20330
20331
20332
20333
20334
20335
20336
20337
20338
20339
20340
20341
20342
20343
20344
20345
20346
20347
20348
20349
20350
20351
20352
20353
20354
20355
20356
20357
20358
20359
20360
20361
20362
20363
20364
20365
20366
20367
20368
20369
20370
20371
20372
20373
20374
20375
20376
20377
20378
20379
20380
20381
20382
20383
20384
20385
20386
20387
20388
20389
20390
20391
20392
20393
20394
20395
20396
20397
20398
20399
20400
20401
20402
20403
20404
20405
20406
20407
20408
20409
20410
20411
20412
20413
20414
20415
20416
20417
20418
20419
20420
20421
20422
20423
20424
20425
20426
20427
20428
20429
20430
20431
20432
20433
20434
20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
20469
20470
20471
20472
20473
20474
20475
20476
20477
20478
20479
20480
20481
20482
20483
20484
20485
20486
20487
20488
20489
20490
20491
20492
20493
20494
20495
20496
20497
20498
20499
20500
20501
20502
20503
20504
20505
20506
20507
20508
20509
20510
20511
20512
20513
20514
20515
20516
20517
20518
20519
20520
20521
20522
20523
20524
20525
20526
20527
20528
20529
20530
20531
20532
20533
20534
20535
20536
20537
20538
20539
20540
20541
20542
20543
20544
20545
20546
20547
20548
20549
20550
20551
20552
20553
20554
20555
20556
20557
20558
20559
20560
20561
20562
20563
20564
20565
20566
20567
20568
20569
20570
20571
20572
20573
20574
20575
20576
20577
20578
20579
20580
20581
20582
20583
20584
20585
20586
20587
20588
20589
20590
20591
20592
20593
20594
20595
20596
20597
20598
20599
20600
20601
20602
20603
20604
20605
20606
20607
20608
20609
20610
20611
20612
20613
20614
20615
20616
20617
20618
20619
20620
20621
20622
20623
20624
20625
20626
20627
20628
20629
20630
20631
20632
20633
20634
20635
20636
20637
20638
20639
20640
20641
20642
20643
20644
20645
20646
20647
20648
20649
20650
20651
20652
20653
20654
20655
20656
20657
20658
20659
20660
20661
20662
20663
20664
20665
20666
20667
20668
20669
20670
20671
20672
20673
20674
20675
20676
20677
20678
20679
20680
20681
20682
20683
20684
20685
20686
20687
20688
20689
20690
20691
20692
20693
20694
20695
20696
20697
20698
20699
20700
20701
20702
20703
20704
20705
20706
20707
20708
20709
20710
20711
20712
20713
20714
20715
20716
20717
20718
20719
20720
20721
20722
20723
20724
20725
20726
20727
20728
20729
20730
20731
20732
20733
20734
20735
20736
20737
20738
20739
20740
20741
20742
20743
20744
20745
20746
20747
20748
20749
20750
20751
20752
20753
20754
20755
20756
20757
20758
20759
20760
20761
20762
20763
20764
20765
20766
20767
20768
20769
20770
20771
20772
20773
20774
20775
20776
20777
20778
20779
20780
20781
20782
20783
20784
20785
20786
20787
20788
20789
20790
20791
20792
20793
20794
20795
20796
20797
20798
20799
20800
20801
20802
20803
20804
20805
20806
20807
20808
20809
20810
20811
20812
20813
20814
20815
20816
20817
20818
20819
20820
20821
20822
20823
20824
20825
20826
20827
20828
20829
20830
20831
20832
20833
20834
20835
20836
20837
20838
20839
20840
20841
20842
20843
20844
20845
20846
20847
20848
20849
20850
20851
20852
20853
20854
20855
20856
20857
20858
20859
20860
20861
20862
20863
20864
20865
20866
20867
20868
20869
20870
20871
20872
20873
20874
20875
20876
20877
20878
20879
20880
20881
20882
20883
20884
20885
20886
20887
20888
20889
20890
20891
20892
20893
20894
20895
20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
20917
20918
20919
20920
20921
20922
20923
20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
21077
21078
21079
21080
21081
21082
21083
21084
21085
21086
21087
21088
21089
21090
21091
21092
21093
21094
21095
21096
21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
21115
21116
21117
21118
21119
21120
21121
21122
21123
21124
21125
21126
21127
21128
21129
21130
21131
21132
21133
21134
21135
21136
21137
21138
21139
21140
21141
21142
21143
21144
21145
21146
21147
21148
21149
21150
21151
21152
21153
21154
21155
21156
21157
21158
21159
21160
21161
21162
21163
21164
21165
21166
21167
21168
21169
21170
21171
21172
21173
21174
21175
21176
21177
21178
21179
21180
21181
21182
21183
21184
21185
21186
21187
21188
21189
21190
21191
21192
21193
21194
21195
21196
21197
21198
21199
21200
21201
21202
21203
21204
21205
21206
21207
21208
21209
21210
21211
21212
21213
21214
21215
21216
21217
21218
21219
21220
21221
21222
21223
21224
21225
21226
21227
21228
21229
21230
21231
21232
21233
21234
21235
21236
21237
21238
21239
21240
21241
21242
21243
21244
21245
21246
21247
21248
21249
21250
21251
21252
21253
21254
21255
21256
21257
21258
21259
21260
21261
21262
21263
21264
21265
21266
21267
21268
21269
21270
21271
21272
21273
21274
21275
21276
21277
21278
21279
21280
21281
21282
21283
21284
21285
21286
21287
21288
21289
21290
21291
21292
21293
21294
21295
21296
21297
21298
21299
21300
21301
21302
21303
21304
21305
21306
21307
21308
21309
21310
21311
21312
21313
21314
21315
21316
21317
21318
21319
21320
21321
21322
21323
21324
21325
21326
21327
21328
21329
21330
21331
21332
21333
21334
21335
21336
21337
21338
21339
21340
21341
21342
21343
21344
21345
21346
21347
21348
21349
21350
21351
21352
21353
21354
21355
21356
21357
21358
21359
21360
21361
21362
21363
21364
21365
21366
21367
21368
21369
21370
21371
21372
21373
21374
21375
21376
21377
21378
21379
21380
21381
21382
21383
21384
21385
21386
21387
21388
21389
21390
21391
21392
21393
21394
21395
21396
21397
21398
21399
21400
21401
21402
21403
21404
21405
21406
21407
21408
21409
21410
21411
21412
21413
21414
21415
21416
21417
21418
21419
21420
21421
21422
21423
21424
21425
21426
21427
21428
21429
21430
21431
21432
21433
21434
21435
21436
21437
21438
21439
21440
21441
21442
21443
21444
21445
21446
21447
21448
21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
21476
21477
21478
21479
21480
21481
21482
21483
21484
21485
21486
21487
21488
21489
21490
21491
21492
21493
21494
21495
21496
21497
21498
21499
21500
21501
21502
21503
21504
21505
21506
21507
21508
21509
21510
21511
21512
21513
21514
21515
21516
21517
21518
21519
21520
21521
21522
21523
21524
21525
21526
21527
21528
21529
21530
21531
21532
21533
21534
21535
21536
21537
21538
21539
21540
21541
21542
21543
21544
21545
21546
21547
21548
21549
21550
21551
21552
21553
21554
21555
21556
21557
21558
21559
21560
21561
21562
21563
21564
21565
21566
21567
21568
21569
21570
21571
21572
21573
21574
21575
21576
21577
21578
21579
21580
21581
21582
21583
21584
21585
21586
21587
21588
21589
21590
21591
21592
21593
21594
21595
21596
21597
21598
21599
21600
21601
21602
21603
21604
21605
21606
21607
21608
21609
21610
21611
21612
21613
21614
21615
21616
21617
21618
21619
21620
21621
21622
21623
21624
21625
21626
21627
21628
21629
21630
21631
21632
21633
21634
21635
21636
21637
21638
21639
21640
21641
21642
21643
21644
21645
21646
21647
21648
21649
21650
21651
21652
21653
21654
21655
21656
21657
21658
21659
21660
21661
21662
21663
21664
21665
21666
21667
21668
21669
21670
21671
21672
21673
21674
21675
21676
21677
21678
21679
21680
21681
21682
21683
21684
21685
21686
21687
21688
21689
21690
21691
21692
21693
21694
21695
21696
21697
21698
21699
21700
21701
21702
21703
21704
21705
21706
21707
21708
21709
21710
21711
21712
21713
21714
21715
21716
21717
21718
21719
21720
21721
21722
21723
21724
21725
21726
21727
21728
21729
21730
21731
21732
21733
21734
21735
21736
21737
21738
21739
21740
21741
21742
21743
21744
21745
21746
21747
21748
21749
21750
21751
21752
21753
21754
21755
21756
21757
21758
21759
21760
21761
21762
21763
21764
21765
21766
21767
21768
21769
21770
21771
21772
21773
21774
21775
21776
21777
21778
21779
21780
21781
21782
21783
21784
21785
21786
21787
21788
21789
21790
21791
21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
21806
21807
21808
21809
21810
21811
21812
21813
21814
21815
21816
21817
21818
21819
21820
21821
21822
21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
21872
21873
21874
21875
21876
21877
21878
21879
21880
21881
21882
21883
21884
21885
21886
21887
21888
21889
21890
21891
21892
21893
21894
21895
21896
21897
21898
21899
21900
21901
21902
21903
21904
21905
21906
21907
21908
21909
21910
21911
21912
21913
21914
21915
21916
21917
21918
21919
21920
21921
21922
21923
21924
21925
21926
21927
21928
21929
21930
21931
21932
21933
21934
21935
21936
21937
21938
21939
21940
21941
21942
21943
21944
21945
21946
21947
21948
21949
21950
21951
21952
21953
21954
21955
21956
21957
21958
21959
21960
21961
21962
21963
21964
21965
21966
21967
21968
21969
21970
21971
21972
21973
21974
21975
21976
21977
21978
21979
21980
21981
21982
21983
21984
21985
21986
21987
21988
21989
21990
21991
21992
21993
21994
21995
21996
21997
21998
21999
22000
22001
22002
22003
22004
22005
22006
22007
22008
22009
22010
22011
22012
22013
22014
22015
22016
22017
22018
22019
22020
22021
22022
22023
22024
22025
22026
22027
22028
22029
22030
22031
22032
22033
22034
22035
22036
22037
22038
22039
22040
22041
22042
22043
22044
22045
22046
22047
22048
22049
22050
22051
22052
22053
22054
22055
22056
22057
22058
22059
22060
22061
22062
22063
22064
22065
22066
22067
22068
22069
22070
22071
22072
22073
22074
22075
22076
22077
22078
22079
22080
22081
22082
22083
22084
22085
22086
22087
22088
22089
22090
22091
22092
22093
22094
22095
22096
22097
22098
22099
22100
22101
22102
22103
22104
22105
22106
22107
22108
22109
22110
22111
22112
22113
22114
22115
22116
22117
22118
22119
22120
22121
22122
22123
22124
22125
22126
22127
22128
22129
22130
22131
22132
22133
22134
22135
22136
22137
22138
22139
22140
22141
22142
22143
22144
22145
22146
22147
22148
22149
22150
22151
22152
22153
22154
22155
22156
22157
22158
22159
22160
22161
22162
22163
22164
22165
22166
22167
22168
22169
22170
22171
22172
22173
22174
22175
22176
22177
22178
22179
22180
22181
22182
22183
22184
22185
22186
22187
22188
22189
22190
22191
22192
22193
22194
22195
22196
22197
22198
22199
22200
22201
22202
22203
22204
22205
22206
22207
22208
22209
22210
22211
22212
22213
22214
22215
22216
22217
22218
22219
22220
22221
22222
22223
22224
22225
22226
22227
22228
22229
22230
22231
22232
22233
22234
22235
22236
22237
22238
22239
22240
22241
22242
22243
22244
22245
22246
22247
22248
22249
22250
22251
22252
22253
22254
22255
22256
22257
22258
22259
22260
22261
22262
22263
22264
22265
22266
22267
22268
22269
22270
22271
22272
22273
22274
22275
22276
22277
22278
22279
22280
22281
22282
22283
22284
22285
22286
22287
22288
22289
22290
22291
22292
22293
22294
22295
22296
22297
22298
22299
22300
22301
22302
22303
22304
22305
22306
22307
22308
22309
22310
22311
22312
22313
22314
22315
22316
22317
22318
22319
22320
22321
22322
22323
22324
22325
22326
22327
22328
22329
22330
22331
22332
22333
22334
22335
22336
22337
22338
22339
22340
22341
22342
22343
22344
22345
22346
22347
22348
22349
22350
22351
22352
22353
22354
22355
22356
22357
22358
22359
22360
22361
22362
22363
22364
22365
22366
22367
22368
22369
22370
22371
22372
22373
22374
22375
22376
22377
22378
22379
22380
22381
22382
22383
22384
22385
22386
22387
22388
22389
22390
22391
22392
22393
22394
22395
22396
22397
22398
22399
22400
22401
22402
22403
22404
22405
22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
22447
22448
22449
22450
22451
22452
22453
22454
22455
22456
22457
22458
22459
22460
22461
22462
22463
22464
22465
22466
22467
22468
22469
22470
22471
22472
22473
22474
22475
22476
22477
22478
22479
22480
22481
22482
22483
22484
22485
22486
22487
22488
22489
22490
22491
22492
22493
22494
22495
22496
22497
22498
22499
22500
22501
22502
22503
22504
22505
22506
22507
22508
22509
22510
22511
22512
22513
22514
22515
22516
22517
22518
22519
22520
22521
22522
22523
22524
22525
22526
22527
22528
22529
22530
22531
22532
22533
22534
22535
22536
22537
22538
22539
22540
22541
22542
22543
22544
22545
22546
22547
22548
22549
22550
22551
22552
22553
22554
22555
22556
22557
22558
22559
22560
22561
22562
22563
22564
22565
22566
22567
22568
22569
22570
22571
22572
22573
22574
22575
22576
22577
22578
22579
22580
22581
22582
22583
22584
22585
22586
22587
22588
22589
22590
22591
22592
22593
22594
22595
22596
22597
22598
22599
22600
22601
22602
22603
22604
22605
22606
22607
22608
22609
22610
22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
22628
22629
22630
22631
22632
22633
22634
22635
22636
22637
22638
22639
22640
22641
22642
22643
22644
22645
22646
22647
22648
22649
22650
22651
22652
22653
22654
22655
22656
22657
22658
22659
22660
22661
22662
22663
22664
22665
22666
22667
22668
22669
22670
22671
22672
22673
22674
22675
22676
22677
22678
22679
22680
22681
22682
22683
22684
22685
22686
22687
22688
22689
22690
22691
22692
22693
22694
22695
22696
22697
22698
22699
22700
22701
22702
22703
22704
22705
22706
22707
22708
22709
22710
22711
22712
22713
22714
22715
22716
22717
22718
22719
22720
22721
22722
22723
22724
22725
22726
22727
22728
22729
22730
22731
22732
22733
22734
22735
22736
22737
22738
22739
22740
22741
22742
22743
22744
22745
22746
22747
22748
22749
22750
22751
22752
22753
22754
22755
22756
22757
22758
22759
22760
22761
22762
22763
22764
22765
22766
22767
22768
22769
22770
22771
22772
22773
22774
22775
22776
22777
22778
22779
22780
22781
22782
22783
22784
22785
22786
22787
22788
22789
22790
22791
22792
22793
22794
22795
22796
22797
22798
22799
22800
22801
22802
22803
22804
22805
22806
22807
22808
22809
22810
22811
22812
22813
22814
22815
22816
22817
22818
22819
22820
22821
22822
22823
22824
22825
22826
22827
22828
22829
22830
22831
22832
22833
22834
22835
22836
22837
22838
22839
22840
22841
22842
22843
22844
22845
22846
22847
22848
22849
22850
22851
22852
22853
22854
22855
22856
22857
22858
22859
22860
22861
22862
22863
22864
22865
22866
22867
22868
22869
22870
22871
22872
22873
22874
22875
22876
22877
22878
22879
22880
22881
22882
22883
22884
22885
22886
22887
22888
22889
22890
22891
22892
22893
22894
22895
22896
22897
22898
22899
22900
22901
22902
22903
22904
22905
22906
22907
22908
22909
22910
22911
22912
22913
22914
22915
22916
22917
22918
22919
22920
22921
22922
22923
22924
22925
22926
22927
22928
22929
22930
22931
22932
22933
22934
22935
22936
22937
22938
22939
22940
22941
22942
22943
22944
22945
22946
22947
22948
22949
22950
22951
22952
22953
22954
22955
22956
22957
22958
22959
22960
22961
22962
22963
22964
22965
22966
22967
22968
22969
22970
22971
22972
22973
22974
22975
22976
22977
22978
22979
22980
22981
22982
22983
22984
22985
22986
22987
22988
22989
22990
22991
22992
22993
22994
22995
22996
22997
22998
22999
23000
23001
23002
23003
23004
23005
23006
23007
23008
23009
23010
23011
23012
23013
23014
23015
23016
23017
23018
23019
23020
23021
23022
23023
23024
23025
23026
23027
23028
23029
23030
23031
23032
23033
23034
23035
23036
23037
23038
23039
23040
23041
23042
23043
23044
23045
23046
23047
23048
23049
23050
23051
23052
23053
23054
23055
23056
23057
23058
23059
23060
23061
23062
23063
23064
23065
23066
23067
23068
23069
23070
23071
23072
23073
23074
23075
23076
23077
23078
23079
23080
23081
23082
23083
23084
23085
23086
23087
23088
23089
23090
23091
23092
23093
23094
23095
23096
23097
23098
23099
23100
23101
23102
23103
23104
23105
23106
23107
23108
23109
23110
23111
23112
23113
23114
23115
23116
23117
23118
23119
23120
23121
23122
23123
23124
23125
23126
23127
23128
23129
23130
23131
23132
23133
23134
23135
23136
23137
23138
23139
23140
23141
23142
23143
23144
23145
23146
23147
23148
23149
23150
23151
23152
23153
23154
23155
23156
23157
23158
23159
23160
23161
23162
23163
23164
23165
23166
23167
23168
23169
23170
23171
23172
23173
23174
23175
23176
23177
23178
23179
23180
23181
23182
23183
23184
23185
23186
23187
23188
23189
23190
23191
23192
23193
23194
23195
23196
23197
23198
23199
23200
23201
23202
23203
23204
23205
23206
23207
23208
23209
23210
23211
23212
23213
23214
23215
23216
23217
23218
23219
23220
23221
23222
23223
23224
23225
23226
23227
23228
23229
23230
23231
23232
23233
23234
23235
23236
23237
23238
23239
23240
23241
23242
23243
23244
23245
23246
23247
23248
23249
23250
23251
23252
23253
23254
23255
23256
23257
23258
23259
23260
23261
23262
23263
23264
23265
23266
23267
23268
23269
23270
23271
23272
23273
23274
23275
23276
23277
23278
23279
23280
23281
23282
23283
23284
23285
23286
23287
23288
23289
23290
23291
23292
23293
23294
23295
23296
23297
23298
23299
23300
23301
23302
23303
23304
23305
23306
23307
23308
23309
23310
23311
23312
23313
23314
23315
23316
23317
23318
23319
23320
23321
23322
23323
23324
23325
23326
23327
23328
23329
23330
23331
23332
23333
23334
23335
23336
23337
23338
23339
23340
23341
23342
23343
23344
23345
23346
23347
23348
23349
23350
23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
23368
23369
23370
23371
23372
23373
23374
23375
23376
23377
23378
23379
23380
23381
23382
23383
23384
23385
23386
23387
23388
23389
23390
23391
23392
23393
23394
23395
23396
23397
23398
23399
23400
23401
23402
23403
23404
23405
23406
23407
23408
23409
23410
23411
23412
23413
23414
23415
23416
23417
23418
23419
23420
23421
23422
23423
23424
23425
23426
23427
23428
23429
23430
23431
23432
23433
23434
23435
23436
23437
23438
23439
23440
23441
23442
23443
23444
23445
23446
23447
23448
23449
23450
23451
23452
23453
23454
23455
23456
23457
23458
23459
23460
23461
23462
23463
23464
23465
23466
23467
23468
23469
23470
23471
23472
23473
23474
23475
23476
23477
23478
23479
23480
23481
23482
23483
23484
23485
23486
23487
23488
23489
23490
23491
23492
23493
23494
23495
23496
23497
23498
23499
23500
23501
23502
23503
23504
23505
23506
23507
23508
23509
23510
23511
23512
23513
23514
23515
23516
23517
23518
23519
23520
23521
23522
23523
23524
23525
23526
23527
23528
23529
23530
23531
23532
23533
23534
23535
23536
23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
23556
23557
23558
23559
23560
23561
23562
23563
23564
23565
23566
23567
23568
23569
23570
23571
23572
23573
23574
23575
23576
23577
23578
23579
23580
23581
23582
23583
23584
23585
23586
23587
23588
23589
23590
23591
23592
23593
23594
23595
23596
23597
23598
23599
23600
23601
23602
23603
23604
23605
23606
23607
23608
23609
23610
23611
23612
23613
23614
23615
23616
23617
23618
23619
23620
23621
23622
23623
23624
23625
23626
23627
23628
23629
23630
23631
23632
23633
23634
23635
23636
23637
23638
23639
23640
23641
23642
23643
23644
23645
23646
23647
23648
23649
23650
23651
23652
23653
23654
23655
23656
23657
23658
23659
23660
23661
23662
23663
23664
23665
23666
23667
23668
23669
23670
23671
23672
23673
23674
23675
23676
23677
23678
23679
23680
23681
23682
23683
23684
23685
23686
23687
23688
23689
23690
23691
23692
23693
23694
23695
23696
23697
23698
23699
23700
23701
23702
23703
23704
23705
23706
23707
23708
23709
23710
23711
23712
23713
23714
23715
23716
23717
23718
23719
23720
23721
23722
23723
23724
23725
23726
23727
23728
23729
23730
23731
23732
23733
23734
23735
23736
23737
23738
23739
23740
23741
23742
23743
23744
23745
23746
23747
23748
23749
23750
23751
23752
23753
23754
23755
23756
23757
23758
23759
23760
23761
23762
23763
23764
23765
23766
23767
23768
23769
23770
23771
23772
23773
23774
23775
23776
23777
23778
23779
23780
23781
23782
23783
23784
23785
23786
23787
23788
23789
23790
23791
23792
23793
23794
23795
23796
23797
23798
23799
23800
23801
23802
23803
23804
23805
23806
23807
23808
23809
23810
23811
23812
23813
23814
23815
23816
23817
23818
23819
23820
23821
23822
23823
23824
23825
23826
23827
23828
23829
23830
23831
23832
23833
23834
23835
23836
23837
23838
23839
23840
23841
23842
23843
23844
23845
23846
23847
23848
23849
23850
23851
23852
23853
23854
23855
23856
23857
23858
23859
23860
23861
23862
23863
23864
23865
23866
23867
23868
23869
23870
23871
23872
23873
23874
23875
23876
23877
23878
23879
23880
23881
23882
23883
23884
23885
23886
23887
23888
23889
23890
23891
23892
23893
23894
23895
23896
23897
23898
23899
23900
23901
23902
23903
23904
23905
23906
23907
23908
23909
23910
23911
23912
23913
23914
23915
23916
23917
23918
23919
23920
23921
23922
23923
23924
23925
23926
23927
23928
23929
23930
23931
23932
23933
23934
23935
23936
23937
23938
23939
23940
23941
23942
23943
23944
23945
23946
23947
23948
23949
23950
23951
23952
23953
23954
23955
23956
23957
23958
23959
23960
23961
23962
23963
23964
23965
23966
23967
23968
23969
23970
23971
23972
23973
23974
23975
23976
23977
23978
23979
23980
23981
23982
23983
23984
23985
23986
23987
23988
23989
23990
23991
23992
23993
23994
23995
23996
23997
23998
23999
24000
24001
24002
24003
24004
24005
24006
24007
24008
24009
24010
24011
24012
24013
24014
24015
24016
24017
24018
24019
24020
24021
24022
24023
24024
24025
24026
24027
24028
24029
24030
24031
24032
24033
24034
24035
24036
24037
24038
24039
24040
24041
24042
24043
24044
24045
24046
24047
24048
24049
24050
24051
24052
24053
24054
24055
24056
24057
24058
24059
24060
24061
24062
24063
24064
24065
24066
24067
24068
24069
24070
24071
24072
24073
24074
24075
24076
24077
24078
24079
24080
24081
24082
24083
24084
24085
24086
24087
24088
24089
24090
24091
24092
24093
24094
24095
24096
24097
24098
24099
24100
24101
24102
24103
24104
24105
24106
24107
24108
24109
24110
24111
24112
24113
24114
24115
24116
24117
24118
24119
24120
24121
24122
24123
24124
24125
24126
24127
24128
24129
24130
24131
24132
24133
24134
24135
24136
24137
24138
24139
24140
24141
24142
24143
24144
24145
24146
24147
24148
24149
24150
24151
24152
24153
24154
24155
24156
24157
24158
24159
24160
24161
24162
24163
24164
24165
24166
24167
24168
24169
24170
24171
24172
24173
24174
24175
24176
24177
24178
24179
24180
24181
24182
24183
24184
24185
24186
24187
24188
24189
24190
24191
24192
24193
24194
24195
24196
24197
24198
24199
24200
24201
24202
24203
24204
24205
24206
24207
24208
24209
24210
24211
24212
24213
24214
24215
24216
24217
24218
24219
24220
24221
24222
24223
24224
24225
24226
24227
24228
24229
24230
24231
24232
24233
24234
24235
24236
24237
24238
24239
24240
24241
24242
24243
24244
24245
24246
24247
24248
24249
24250
24251
24252
24253
24254
24255
24256
24257
24258
24259
24260
24261
24262
24263
24264
24265
24266
24267
24268
24269
24270
24271
24272
24273
24274
24275
24276
24277
24278
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this file,
# You can obtain one at http://mozilla.org/MPL/2.0/.

# Common codegen classes.

import functools
import math
import os
import re
import string
import textwrap

import six
from Configuration import (
    Descriptor,
    MemberIsLegacyUnforgeable,
    NoSuchDescriptorError,
    getAllTypes,
    getTypesFromCallback,
    getTypesFromDescriptor,
    getTypesFromDictionary,
)
from perfecthash import PerfectHash
from WebIDL import (
    BuiltinTypes,
    IDLAttribute,
    IDLBuiltinType,
    IDLDefaultDictionaryValue,
    IDLDictionary,
    IDLEmptySequenceValue,
    IDLInterfaceMember,
    IDLNullValue,
    IDLSequenceType,
    IDLType,
    IDLUndefinedValue,
)

AUTOGENERATED_WARNING_COMMENT = (
    "/* THIS FILE IS AUTOGENERATED BY Codegen.py - DO NOT EDIT */\n\n"
)
AUTOGENERATED_WITH_SOURCE_WARNING_COMMENT = (
    "/* THIS FILE IS AUTOGENERATED FROM %s BY Codegen.py - DO NOT EDIT */\n\n"
)
ADDPROPERTY_HOOK_NAME = "_addProperty"
GETWRAPPERCACHE_HOOK_NAME = "_getWrapperCache"
FINALIZE_HOOK_NAME = "_finalize"
OBJECT_MOVED_HOOK_NAME = "_objectMoved"
CONSTRUCT_HOOK_NAME = "_constructor"
LEGACYCALLER_HOOK_NAME = "_legacycaller"
RESOLVE_HOOK_NAME = "_resolve"
MAY_RESOLVE_HOOK_NAME = "_mayResolve"
NEW_ENUMERATE_HOOK_NAME = "_newEnumerate"
ENUM_ENTRY_VARIABLE_NAME = "strings"
INSTANCE_RESERVED_SLOTS = 1

# This size is arbitrary. It is a power of 2 to make using it as a modulo
# operand cheap, and is usually around 1/3-1/5th of the set size (sometimes
# smaller for very large sets).
GLOBAL_NAMES_PHF_SIZE = 256


def memberReservedSlot(member, descriptor):
    return (
        "(DOM_INSTANCE_RESERVED_SLOTS + %d)"
        % member.slotIndices[descriptor.interface.identifier.name]
    )


def memberXrayExpandoReservedSlot(member, descriptor):
    return (
        "(xpc::JSSLOT_EXPANDO_COUNT + %d)"
        % member.slotIndices[descriptor.interface.identifier.name]
    )


def mayUseXrayExpandoSlots(descriptor, attr):
    assert not attr.getExtendedAttribute("NewObject")
    # For attributes whose type is a Gecko interface we always use
    # slots on the reflector for caching.  Also, for interfaces that
    # don't want Xrays we obviously never use the Xray expando slot.
    return descriptor.wantsXrays and not attr.type.isGeckoInterface()


def toStringBool(arg):
    """
    Converts IDL/Python Boolean (True/False) to C++ Boolean (true/false)
    """
    return str(not not arg).lower()


def toBindingNamespace(arg):
    return arg + "_Binding"


def isTypeCopyConstructible(type):
    # Nullable and sequence stuff doesn't affect copy-constructibility
    type = type.unroll()
    return (
        type.isUndefined()
        or type.isPrimitive()
        or type.isString()
        or type.isEnum()
        or (type.isUnion() and CGUnionStruct.isUnionCopyConstructible(type))
        or (
            type.isDictionary()
            and CGDictionary.isDictionaryCopyConstructible(type.inner)
        )
        or
        # Interface types are only copy-constructible if they're Gecko
        # interfaces.  SpiderMonkey interfaces are not copy-constructible
        # because of rooting issues.
        (type.isInterface() and type.isGeckoInterface())
    )


class CycleCollectionUnsupported(TypeError):
    def __init__(self, message):
        TypeError.__init__(self, message)


def idlTypeNeedsCycleCollection(type):
    type = type.unroll()  # Takes care of sequences and nullables
    if (
        (type.isPrimitive() and type.tag() in builtinNames)
        or type.isUndefined()
        or type.isEnum()
        or type.isString()
        or type.isAny()
        or type.isObject()
        or type.isSpiderMonkeyInterface()
    ):
        return False
    elif type.isCallback() or type.isPromise() or type.isGeckoInterface():
        return True
    elif type.isUnion():
        return any(idlTypeNeedsCycleCollection(t) for t in type.flatMemberTypes)
    elif type.isRecord():
        if idlTypeNeedsCycleCollection(type.inner):
            raise CycleCollectionUnsupported(
                "Cycle collection for type %s is not supported" % type
            )
        return False
    elif type.isDictionary():
        return CGDictionary.dictionaryNeedsCycleCollection(type.inner)
    else:
        raise CycleCollectionUnsupported(
            "Don't know whether to cycle-collect type %s" % type
        )


def idlTypeNeedsCallContext(type, descriptor=None, allowTreatNonCallableAsNull=False):
    """
    Returns whether the given type needs error reporting via a
    BindingCallContext for JS-to-C++ conversions.  This will happen when the
    conversion can throw an exception due to logic in the IDL spec or
    Gecko-specific security checks.  In particular, a type needs a
    BindingCallContext if and only if the JS-to-C++ conversion for that type can
    end up calling ThrowErrorMessage.

    For some types this depends on the descriptor (e.g. because we do certain
    checks only for some kinds of interfaces).

    The allowTreatNonCallableAsNull optimization is there so we can avoid
    generating an unnecessary BindingCallContext for all the event handler
    attribute setters.

    """
    while True:
        if type.isSequence():
            # Sequences can always throw "not an object"
            return True
        if type.nullable():
            # treatNonObjectAsNull() and treatNonCallableAsNull() are
            # only sane things to test on nullable types, so do that now.
            if (
                allowTreatNonCallableAsNull
                and type.isCallback()
                and (type.treatNonObjectAsNull() or type.treatNonCallableAsNull())
            ):
                # This can't throw. so never needs a method description.
                return False
            type = type.inner
        else:
            break

    if type.isUndefined():
        # Clearly doesn't need a method description; we can only get here from
        # CGHeaders trying to decide whether to include the method description
        # header.
        return False
    # The float check needs to come before the isPrimitive() check,
    # because floats are primitives too.
    if type.isFloat():
        # Floats can throw if restricted.
        return not type.isUnrestricted()
    if type.isPrimitive() and type.tag() in builtinNames:
        # Numbers can throw if enforcing range.
        return type.hasEnforceRange()
    if type.isEnum():
        # Can throw on invalid value.
        return True
    if type.isString():
        # Can throw if it's a ByteString
        return type.isByteString()
    if type.isAny():
        # JS-implemented interfaces do extra security checks so need a
        # method description here.  If we have no descriptor, this
        # might be JS-implemented thing, so it will do the security
        # check and we need the method description.
        return not descriptor or descriptor.interface.isJSImplemented()
    if type.isPromise():
        # JS-to-Promise conversion won't cause us to throw any
        # specific exceptions, so does not need a method description.
        return False
    if (
        type.isObject()
        or type.isInterface()
        or type.isCallback()
        or type.isDictionary()
        or type.isRecord()
        or type.isObservableArray()
    ):
        # These can all throw if a primitive is passed in, at the very least.
        # There are some rare cases when we know we have an object, but those
        # are not worth the complexity of optimizing for.
        #
        # Note that we checked the [LegacyTreatNonObjectAsNull] case already when
        # unwrapping nullables.
        return True
    if type.isUnion():
        # Can throw if a type not in the union is passed in.
        return True
    raise TypeError("Don't know whether type '%s' needs a method description" % type)


# TryPreserveWrapper uses the addProperty hook to preserve the wrapper of
# non-nsISupports cycle collected objects, so if wantsAddProperty is changed
# to not cover that case then TryPreserveWrapper will need to be changed.
def wantsAddProperty(desc):
    return desc.concrete and desc.wrapperCache and not desc.isGlobal()


def wantsGetWrapperCache(desc):
    return (
        desc.concrete and desc.wrapperCache and not desc.isGlobal() and not desc.proxy
    )


# We'll want to insert the indent at the beginnings of lines, but we
# don't want to indent empty lines.  So only indent lines that have a
# non-newline character on them.
lineStartDetector = re.compile("^(?=[^\n#])", re.MULTILINE)


def indent(s, indentLevel=2):
    """
    Indent C++ code.

    Weird secret feature: this doesn't indent lines that start with # (such as
    #include lines or #ifdef/#endif).
    """
    if s == "":
        return s
    return re.sub(lineStartDetector, indentLevel * " ", s)


# dedent() and fill() are often called on the same string multiple
# times.  We want to memoize their return values so we don't keep
# recomputing them all the time.
def memoize(fn):
    """
    Decorator to memoize a function of one argument.  The cache just
    grows without bound.
    """
    cache = {}

    @functools.wraps(fn)
    def wrapper(arg):
        retval = cache.get(arg)
        if retval is None:
            retval = cache[arg] = fn(arg)
        return retval

    return wrapper


@memoize
def dedent(s):
    """
    Remove all leading whitespace from s, and remove a blank line
    at the beginning.
    """
    if s.startswith("\n"):
        s = s[1:]
    return textwrap.dedent(s)


# This works by transforming the fill()-template to an equivalent
# string.Template.
fill_multiline_substitution_re = re.compile(r"( *)\$\*{(\w+)}(\n)?")


find_substitutions = re.compile(r"\${")


@memoize
def compile_fill_template(template):
    """
    Helper function for fill().  Given the template string passed to fill(),
    do the reusable part of template processing and return a pair (t,
    argModList) that can be used every time fill() is called with that
    template argument.

    argsModList is list of tuples that represent modifications to be
    made to args.  Each modification has, in order: i) the arg name,
    ii) the modified name, iii) the indent depth.
    """
    t = dedent(template)
    assert t.endswith("\n") or "\n" not in t
    argModList = []

    def replace(match):
        """
        Replaces a line like '  $*{xyz}\n' with '${xyz_n}',
        where n is the indent depth, and add a corresponding entry to
        argModList.

        Note that this needs to close over argModList, so it has to be
        defined inside compile_fill_template().
        """
        indentation, name, nl = match.groups()
        depth = len(indentation)

        # Check that $*{xyz} appears by itself on a line.
        prev = match.string[: match.start()]
        if (prev and not prev.endswith("\n")) or nl is None:
            raise ValueError(
                "Invalid fill() template: $*{%s} must appear by itself on a line" % name
            )

        # Now replace this whole line of template with the indented equivalent.
        modified_name = name + "_" + str(depth)
        argModList.append((name, modified_name, depth))
        return "${" + modified_name + "}"

    t = re.sub(fill_multiline_substitution_re, replace, t)
    if not re.search(find_substitutions, t):
        raise TypeError("Using fill() when dedent() would do.")
    return (string.Template(t), argModList)


def fill(template, **args):
    """
    Convenience function for filling in a multiline template.

    `fill(template, name1=v1, name2=v2)` is a lot like
    `string.Template(template).substitute({"name1": v1, "name2": v2})`.

    However, it's shorter, and has a few nice features:

      * If `template` is indented, fill() automatically dedents it!
        This makes code using fill() with Python's multiline strings
        much nicer to look at.

      * If `template` starts with a blank line, fill() strips it off.
        (Again, convenient with multiline strings.)

      * fill() recognizes a special kind of substitution
        of the form `$*{name}`.

        Use this to paste in, and automatically indent, multiple lines.
        (Mnemonic: The `*` is for "multiple lines").

        A `$*` substitution must appear by itself on a line, with optional
        preceding indentation (spaces only). The whole line is replaced by the
        corresponding keyword argument, indented appropriately.  If the
        argument is an empty string, no output is generated, not even a blank
        line.
    """

    t, argModList = compile_fill_template(template)
    # Now apply argModList to args
    for (name, modified_name, depth) in argModList:
        if not (args[name] == "" or args[name].endswith("\n")):
            raise ValueError(
                "Argument %s with value %r is missing a newline" % (name, args[name])
            )
        args[modified_name] = indent(args[name], depth)

    return t.substitute(args)


class CGThing:
    """
    Abstract base class for things that spit out code.
    """

    def __init__(self):
        pass  # Nothing for now

    def declare(self):
        """Produce code for a header file."""
        assert False  # Override me!

    def define(self):
        """Produce code for a cpp file."""
        assert False  # Override me!

    def deps(self):
        """Produce the deps for a pp file"""
        assert False  # Override me!


class CGStringTable(CGThing):
    """
    Generate a function accessor for a WebIDL string table, using the existing
    concatenated names string and mapping indexes to offsets in that string:

    const char *accessorName(unsigned int index) {
      static const uint16_t offsets = { ... };
      return BindingName(offsets[index]);
    }

    This is more efficient than the more natural:

    const char *table[] = {
      ...
    };

    The uint16_t offsets are smaller than the pointer equivalents, and the
    concatenated string requires no runtime relocations.
    """

    def __init__(self, accessorName, strings, static=False):
        CGThing.__init__(self)
        self.accessorName = accessorName
        self.strings = strings
        self.static = static

    def declare(self):
        if self.static:
            return ""
        return "const char *%s(unsigned int aIndex);\n" % self.accessorName

    def define(self):
        offsets = []
        for s in self.strings:
            offsets.append(BindingNamesOffsetEnum(s))
        return fill(
            """
            ${static}const char *${name}(unsigned int aIndex)
            {
              static const BindingNamesOffset offsets[] = {
                $*{offsets}
              };
              return BindingName(offsets[aIndex]);
            }
            """,
            static="static " if self.static else "",
            name=self.accessorName,
            offsets="".join("BindingNamesOffset::%s,\n" % o for o in offsets),
        )


class CGNativePropertyHooks(CGThing):
    """
    Generate a NativePropertyHooks for a given descriptor
    """

    def __init__(self, descriptor, properties):
        CGThing.__init__(self)
        assert descriptor.wantsXrays
        self.descriptor = descriptor
        self.properties = properties

    def declare(self):
        return ""

    def define(self):
        deleteNamedProperty = "nullptr"
        if (
            self.descriptor.concrete
            and self.descriptor.proxy
            and not self.descriptor.isMaybeCrossOriginObject()
        ):
            resolveOwnProperty = "binding_detail::ResolveOwnProperty"
            enumerateOwnProperties = "binding_detail::EnumerateOwnProperties"
            if self.descriptor.needsXrayNamedDeleterHook():
                deleteNamedProperty = "DeleteNamedProperty"
        elif self.descriptor.needsXrayResolveHooks():
            resolveOwnProperty = "ResolveOwnPropertyViaResolve"
            enumerateOwnProperties = "EnumerateOwnPropertiesViaGetOwnPropertyNames"
        else:
            resolveOwnProperty = "nullptr"
            enumerateOwnProperties = "nullptr"
        if self.properties.hasNonChromeOnly():
            regular = "sNativeProperties.Upcast()"
        else:
            regular = "nullptr"
        if self.properties.hasChromeOnly():
            chrome = "sChromeOnlyNativeProperties.Upcast()"
        else:
            chrome = "nullptr"
        constructorID = "constructors::id::"
        if self.descriptor.interface.hasInterfaceObject():
            constructorID += self.descriptor.name
        else:
            constructorID += "_ID_Count"
        prototypeID = "prototypes::id::"
        if self.descriptor.interface.hasInterfacePrototypeObject():
            prototypeID += self.descriptor.name
        else:
            prototypeID += "_ID_Count"

        if self.descriptor.wantsXrayExpandoClass:
            expandoClass = "&sXrayExpandoObjectClass"
        else:
            expandoClass = "&DefaultXrayExpandoObjectClass"

        return fill(
            """
            bool sNativePropertiesInited = false;
            const NativePropertyHooks sNativePropertyHooks = {
              ${resolveOwnProperty},
              ${enumerateOwnProperties},
              ${deleteNamedProperty},
              { ${regular}, ${chrome}, &sNativePropertiesInited },
              ${prototypeID},
              ${constructorID},
              ${expandoClass}
            };
            """,
            resolveOwnProperty=resolveOwnProperty,
            enumerateOwnProperties=enumerateOwnProperties,
            deleteNamedProperty=deleteNamedProperty,
            regular=regular,
            chrome=chrome,
            prototypeID=prototypeID,
            constructorID=constructorID,
            expandoClass=expandoClass,
        )


def NativePropertyHooks(descriptor):
    return (
        "&sEmptyNativePropertyHooks"
        if not descriptor.wantsXrays
        else "&sNativePropertyHooks"
    )


def DOMClass(descriptor):
    protoList = ["prototypes::id::" + proto for proto in descriptor.prototypeNameChain]
    # Pad out the list to the right length with _ID_Count so we
    # guarantee that all the lists are the same length.  _ID_Count
    # is never the ID of any prototype, so it's safe to use as
    # padding.
    protoList.extend(
        ["prototypes::id::_ID_Count"]
        * (descriptor.config.maxProtoChainLength - len(protoList))
    )

    if descriptor.interface.isSerializable():
        serializer = "Serialize"
    else:
        serializer = "nullptr"

    if wantsGetWrapperCache(descriptor):
        wrapperCacheGetter = GETWRAPPERCACHE_HOOK_NAME
    else:
        wrapperCacheGetter = "nullptr"

    if descriptor.hasOrdinaryObjectPrototype:
        getProto = "JS::GetRealmObjectPrototypeHandle"
    else:
        getProto = "GetProtoObjectHandle"

    return fill(
        """
          { ${protoChain} },
          std::is_base_of_v<nsISupports, ${nativeType}>,
          ${hooks},
          FindAssociatedGlobalForNative<${nativeType}>::Get,
          ${getProto},
          GetCCParticipant<${nativeType}>::Get(),
          ${serializer},
          ${wrapperCacheGetter}
        """,
        protoChain=", ".join(protoList),
        nativeType=descriptor.nativeType,
        hooks=NativePropertyHooks(descriptor),
        serializer=serializer,
        wrapperCacheGetter=wrapperCacheGetter,
        getProto=getProto,
    )


def InstanceReservedSlots(descriptor):
    slots = INSTANCE_RESERVED_SLOTS + descriptor.interface.totalMembersInSlots
    if descriptor.isMaybeCrossOriginObject():
        # We need a slot for the cross-origin holder too.
        if descriptor.interface.hasChildInterfaces():
            raise TypeError(
                "We don't support non-leaf cross-origin interfaces "
                "like %s" % descriptor.interface.identifier.name
            )
        slots += 1
    return slots


class CGDOMJSClass(CGThing):
    """
    Generate a DOMJSClass for a given descriptor
    """

    def __init__(self, descriptor):
        CGThing.__init__(self)
        self.descriptor = descriptor

    def declare(self):
        return ""

    def define(self):
        callHook = (
            LEGACYCALLER_HOOK_NAME
            if self.descriptor.operations["LegacyCaller"]
            else "nullptr"
        )
        objectMovedHook = (
            OBJECT_MOVED_HOOK_NAME if self.descriptor.wrapperCache else "nullptr"
        )
        slotCount = InstanceReservedSlots(self.descriptor)
        classFlags = "JSCLASS_IS_DOMJSCLASS | JSCLASS_FOREGROUND_FINALIZE | "
        if self.descriptor.isGlobal():
            classFlags += (
                "JSCLASS_DOM_GLOBAL | JSCLASS_GLOBAL_FLAGS_WITH_SLOTS(DOM_GLOBAL_SLOTS)"
            )
            traceHook = "JS_GlobalObjectTraceHook"
            reservedSlots = "JSCLASS_GLOBAL_APPLICATION_SLOTS"
        else:
            classFlags += "JSCLASS_HAS_RESERVED_SLOTS(%d)" % slotCount
            traceHook = "nullptr"
            reservedSlots = slotCount
        if self.descriptor.interface.hasProbablyShortLivingWrapper():
            if not self.descriptor.wrapperCache:
                raise TypeError(
                    "Need a wrapper cache to support nursery "
                    "allocation of DOM objects"
                )
            classFlags += " | JSCLASS_SKIP_NURSERY_FINALIZE"

        if self.descriptor.interface.getExtendedAttribute("NeedResolve"):
            resolveHook = RESOLVE_HOOK_NAME
            mayResolveHook = MAY_RESOLVE_HOOK_NAME
            newEnumerateHook = NEW_ENUMERATE_HOOK_NAME
        elif self.descriptor.isGlobal():
            resolveHook = "mozilla::dom::ResolveGlobal"
            mayResolveHook = "mozilla::dom::MayResolveGlobal"
            newEnumerateHook = "mozilla::dom::EnumerateGlobal"
        else:
            resolveHook = "nullptr"
            mayResolveHook = "nullptr"
            newEnumerateHook = "nullptr"

        return fill(
            """
            static const JSClassOps sClassOps = {
              ${addProperty}, /* addProperty */
              nullptr,               /* delProperty */
              nullptr,               /* enumerate */
              ${newEnumerate}, /* newEnumerate */
              ${resolve}, /* resolve */
              ${mayResolve}, /* mayResolve */
              ${finalize}, /* finalize */
              ${call}, /* call */
              nullptr,               /* construct */
              ${trace}, /* trace */
            };

            static const js::ClassExtension sClassExtension = {
              ${objectMoved} /* objectMovedOp */
            };

            static const DOMJSClass sClass = {
              { "${name}",
                ${flags},
                &sClassOps,
                JS_NULL_CLASS_SPEC,
                &sClassExtension,
                JS_NULL_OBJECT_OPS
              },
              $*{descriptor}
            };
            static_assert(${instanceReservedSlots} == DOM_INSTANCE_RESERVED_SLOTS,
                          "Must have the right minimal number of reserved slots.");
            static_assert(${reservedSlots} >= ${slotCount},
                          "Must have enough reserved slots.");
            """,
            name=self.descriptor.interface.getClassName(),
            flags=classFlags,
            addProperty=ADDPROPERTY_HOOK_NAME
            if wantsAddProperty(self.descriptor)
            else "nullptr",
            newEnumerate=newEnumerateHook,
            resolve=resolveHook,
            mayResolve=mayResolveHook,
            finalize=FINALIZE_HOOK_NAME,
            call=callHook,
            trace=traceHook,
            objectMoved=objectMovedHook,
            descriptor=DOMClass(self.descriptor),
            instanceReservedSlots=INSTANCE_RESERVED_SLOTS,
            reservedSlots=reservedSlots,
            slotCount=slotCount,
        )


class CGDOMProxyJSClass(CGThing):
    """
    Generate a DOMJSClass for a given proxy descriptor
    """

    def __init__(self, descriptor):
        CGThing.__init__(self)
        self.descriptor = descriptor

    def declare(self):
        return ""

    def define(self):
        slotCount = InstanceReservedSlots(self.descriptor)
        # We need one reserved slot (DOM_OBJECT_SLOT).
        flags = ["JSCLASS_IS_DOMJSCLASS", "JSCLASS_HAS_RESERVED_SLOTS(%d)" % slotCount]
        # We don't use an IDL annotation for JSCLASS_EMULATES_UNDEFINED because
        # we don't want people ever adding that to any interface other than
        # HTMLAllCollection.  So just hardcode it here.
        if self.descriptor.interface.identifier.name == "HTMLAllCollection":
            flags.append("JSCLASS_EMULATES_UNDEFINED")
        return fill(
            """
            static const DOMJSClass sClass = {
              PROXY_CLASS_DEF("${name}",
                              ${flags}),
              $*{descriptor}
            };
            """,
            name=self.descriptor.interface.identifier.name,
            flags=" | ".join(flags),
            descriptor=DOMClass(self.descriptor),
        )


class CGXrayExpandoJSClass(CGThing):
    """
    Generate a JSClass for an Xray expando object.  This is only
    needed if we have members in slots (for [Cached] or [StoreInSlot]
    stuff).
    """

    def __init__(self, descriptor):
        assert descriptor.interface.totalMembersInSlots != 0
        assert descriptor.wantsXrays
        assert descriptor.wantsXrayExpandoClass
        CGThing.__init__(self)
        self.descriptor = descriptor

    def declare(self):
        return ""

    def define(self):
        return fill(
            """
            // This may allocate too many slots, because we only really need
            // slots for our non-interface-typed members that we cache.  But
            // allocating slots only for those would make the slot index
            // computations much more complicated, so let's do this the simple
            // way for now.
            DEFINE_XRAY_EXPANDO_CLASS(static, sXrayExpandoObjectClass, ${memberSlots});
            """,
            memberSlots=self.descriptor.interface.totalMembersInSlots,
        )


def PrototypeIDAndDepth(descriptor):
    prototypeID = "prototypes::id::"
    if descriptor.interface.hasInterfacePrototypeObject():
        prototypeID += descriptor.interface.identifier.name
        depth = "PrototypeTraits<%s>::Depth" % prototypeID
    else:
        prototypeID += "_ID_Count"
        depth = "0"
    return (prototypeID, depth)


def InterfacePrototypeObjectProtoGetter(descriptor):
    """
    Returns a tuple with two elements:

        1) The name of the function to call to get the prototype to use for the
           interface prototype object as a JSObject*.

        2) The name of the function to call to get the prototype to use for the
           interface prototype object as a JS::Handle<JSObject*> or None if no
           such function exists.
    """
    parentProtoName = descriptor.parentPrototypeName
    if descriptor.hasNamedPropertiesObject:
        protoGetter = "GetNamedPropertiesObject"
        protoHandleGetter = None
    elif parentProtoName is None:
        if descriptor.interface.getExtendedAttribute("ExceptionClass"):
            protoGetter = "JS::GetRealmErrorPrototype"
        elif descriptor.interface.isIteratorInterface():
            protoGetter = "JS::GetRealmIteratorPrototype"
        elif descriptor.interface.isAsyncIteratorInterface():
            protoGetter = "JS::GetRealmAsyncIteratorPrototype"
        else:
            protoGetter = "JS::GetRealmObjectPrototype"
        protoHandleGetter = None
    else:
        prefix = toBindingNamespace(parentProtoName)
        protoGetter = prefix + "::GetProtoObject"
        protoHandleGetter = prefix + "::GetProtoObjectHandle"

    return (protoGetter, protoHandleGetter)


class CGPrototypeJSClass(CGThing):
    def __init__(self, descriptor, properties):
        CGThing.__init__(self)
        self.descriptor = descriptor
        self.properties = properties

    def declare(self):
        # We're purely for internal consumption
        return ""

    def define(self):
        prototypeID, depth = PrototypeIDAndDepth(self.descriptor)
        slotCount = "DOM_INTERFACE_PROTO_SLOTS_BASE"
        # Globals handle unforgeables directly in Wrap() instead of
        # via a holder.
        if (
            self.descriptor.hasLegacyUnforgeableMembers
            and not self.descriptor.isGlobal()
        ):
            slotCount += (
                " + 1 /* slot for the JSObject holding the unforgeable properties */"
            )
        (protoGetter, _) = InterfacePrototypeObjectProtoGetter(self.descriptor)
        type = (
            "eGlobalInterfacePrototype"
            if self.descriptor.isGlobal()
            else "eInterfacePrototype"
        )
        return fill(
            """
            static const DOMIfaceAndProtoJSClass sPrototypeClass = {
              {
                "${name}Prototype",
                JSCLASS_IS_DOMIFACEANDPROTOJSCLASS | JSCLASS_HAS_RESERVED_SLOTS(${slotCount}),
                JS_NULL_CLASS_OPS,
                JS_NULL_CLASS_SPEC,
                JS_NULL_CLASS_EXT,
                JS_NULL_OBJECT_OPS
              },
              ${type},
              false,
              ${prototypeID},
              ${depth},
              ${hooks},
              nullptr,
              ${protoGetter}
            };
            """,
            name=self.descriptor.interface.getClassName(),
            slotCount=slotCount,
            type=type,
            hooks=NativePropertyHooks(self.descriptor),
            prototypeID=prototypeID,
            depth=depth,
            protoGetter=protoGetter,
        )


def InterfaceObjectProtoGetter(descriptor, forXrays=False):
    """
    Returns a tuple with two elements:

        1) The name of the function to call to get the prototype to use for the
           interface object as a JSObject*.

        2) The name of the function to call to get the prototype to use for the
           interface prototype as a JS::Handle<JSObject*> or None if no such
           function exists.
    """
    parentInterface = descriptor.interface.parent
    if parentInterface:
        assert not descriptor.interface.isNamespace()
        parentIfaceName = parentInterface.identifier.name
        parentDesc = descriptor.getDescriptor(parentIfaceName)
        prefix = toBindingNamespace(parentDesc.name)
        protoGetter = prefix + "::GetConstructorObject"
        protoHandleGetter = prefix + "::GetConstructorObjectHandle"
    elif descriptor.interface.isNamespace():
        if forXrays or not descriptor.interface.getExtendedAttribute("ProtoObjectHack"):
            protoGetter = "JS::GetRealmObjectPrototype"
        else:
            protoGetter = "GetHackedNamespaceProtoObject"
        protoHandleGetter = None
    else:
        protoGetter = "JS::GetRealmFunctionPrototype"
        protoHandleGetter = None
    return (protoGetter, protoHandleGetter)


class CGInterfaceObjectJSClass(CGThing):
    def __init__(self, descriptor, properties):
        CGThing.__init__(self)
        self.descriptor = descriptor
        self.properties = properties

    def declare(self):
        # We're purely for internal consumption
        return ""

    def define(self):
        if self.descriptor.interface.ctor():
            assert not self.descriptor.interface.isNamespace()
            ctorname = CONSTRUCT_HOOK_NAME
        elif self.descriptor.interface.isNamespace():
            ctorname = "nullptr"
        else:
            ctorname = "ThrowingConstructor"
        needsHasInstance = self.descriptor.interface.hasInterfacePrototypeObject()

        prototypeID, depth = PrototypeIDAndDepth(self.descriptor)
        slotCount = "DOM_INTERFACE_SLOTS_BASE"
        if len(self.descriptor.interface.legacyFactoryFunctions) > 0:
            slotCount += " + %i /* slots for the legacy factory functions */" % len(
                self.descriptor.interface.legacyFactoryFunctions
            )
        (protoGetter, _) = InterfaceObjectProtoGetter(self.descriptor, forXrays=True)

        if ctorname == "ThrowingConstructor":
            ret = ""
            classOpsPtr = "&sBoringInterfaceObjectClassClassOps"
        elif ctorname == "nullptr":
            ret = ""
            classOpsPtr = "JS_NULL_CLASS_OPS"
        else:
            ret = fill(
                """
                static const JSClassOps sInterfaceObjectClassOps = {
                    nullptr,               /* addProperty */
                    nullptr,               /* delProperty */
                    nullptr,               /* enumerate */
                    nullptr,               /* newEnumerate */
                    nullptr,               /* resolve */
                    nullptr,               /* mayResolve */
                    nullptr,               /* finalize */
                    ${ctorname}, /* call */
                    ${ctorname}, /* construct */
                    nullptr,               /* trace */
                };

                """,
                ctorname=ctorname,
            )
            classOpsPtr = "&sInterfaceObjectClassOps"

        if self.descriptor.interface.isNamespace():
            classString = self.descriptor.interface.getExtendedAttribute("ClassString")
            if classString is None:
                classString = self.descriptor.interface.identifier.name
            else:
                classString = classString[0]
            funToString = "nullptr"
            objectOps = "JS_NULL_OBJECT_OPS"
        else:
            classString = "Function"
            funToString = (
                '"function %s() {\\n    [native code]\\n}"'
                % self.descriptor.interface.identifier.name
            )
            # We need non-default ObjectOps so we can actually make
            # use of our funToString.
            objectOps = "&sInterfaceObjectClassObjectOps"

        ret = ret + fill(
            """
            static const DOMIfaceAndProtoJSClass sInterfaceObjectClass = {
              {
                "${classString}",
                JSCLASS_IS_DOMIFACEANDPROTOJSCLASS | JSCLASS_HAS_RESERVED_SLOTS(${slotCount}),
                ${classOpsPtr},
                JS_NULL_CLASS_SPEC,
                JS_NULL_CLASS_EXT,
                ${objectOps}
              },
              ${type},
              ${needsHasInstance},
              ${prototypeID},
              ${depth},
              ${hooks},
              ${funToString},
              ${protoGetter}
            };
            """,
            classString=classString,
            slotCount=slotCount,
            classOpsPtr=classOpsPtr,
            hooks=NativePropertyHooks(self.descriptor),
            objectOps=objectOps,
            type="eNamespace"
            if self.descriptor.interface.isNamespace()
            else "eInterface",
            needsHasInstance=toStringBool(needsHasInstance),
            prototypeID=prototypeID,
            depth=depth,
            funToString=funToString,
            protoGetter=protoGetter,
        )
        return ret


class CGList(CGThing):
    """
    Generate code for a list of GCThings.  Just concatenates them together, with
    an optional joiner string.  "\n" is a common joiner.
    """

    def __init__(self, children, joiner=""):
        CGThing.__init__(self)
        # Make a copy of the kids into a list, because if someone passes in a
        # generator we won't be able to both declare and define ourselves, or
        # define ourselves more than once!
        self.children = list(children)
        self.joiner = joiner

    def append(self, child):
        self.children.append(child)

    def prepend(self, child):
        self.children.insert(0, child)

    def extend(self, kids):
        self.children.extend(kids)

    def join(self, iterable):
        return self.joiner.join(s for s in iterable if len(s) > 0)

    def declare(self):
        return self.join(
            child.declare() for child in self.children if child is not None
        )

    def define(self):
        return self.join(child.define() for child in self.children if child is not None)

    def deps(self):
        deps = set()
        for child in self.children:
            if child is None:
                continue
            deps = deps.union(child.deps())
        return deps

    def __len__(self):
        return len(self.children)


class CGGeneric(CGThing):
    """
    A class that spits out a fixed string into the codegen.  Can spit out a
    separate string for the declaration too.
    """

    def __init__(self, define="", declare=""):
        self.declareText = declare
        self.defineText = define

    def declare(self):
        return self.declareText

    def define(self):
        return self.defineText

    def deps(self):
        return set()


class CGIndenter(CGThing):
    """
    A class that takes another CGThing and generates code that indents that
    CGThing by some number of spaces.  The default indent is two spaces.
    """

    def __init__(self, child, indentLevel=2, declareOnly=False):
        assert isinstance(child, CGThing)
        CGThing.__init__(self)
        self.child = child
        self.indentLevel = indentLevel
        self.declareOnly = declareOnly

    def declare(self):
        return indent(self.child.declare(), self.indentLevel)

    def define(self):
        defn = self.child.define()
        if self.declareOnly:
            return defn
        else:
            return indent(defn, self.indentLevel)


class CGWrapper(CGThing):
    """
    Generic CGThing that wraps other CGThings with pre and post text.
    """

    def __init__(
        self,
        child,
        pre="",
        post="",
        declarePre=None,
        declarePost=None,
        definePre=None,
        definePost=None,
        declareOnly=False,
        defineOnly=False,
        reindent=False,
    ):
        CGThing.__init__(self)
        self.child = child
        self.declarePre = declarePre or pre
        self.declarePost = declarePost or post
        self.definePre = definePre or pre
        self.definePost = definePost or post
        self.declareOnly = declareOnly
        self.defineOnly = defineOnly
        self.reindent = reindent

    def declare(self):
        if self.defineOnly:
            return ""
        decl = self.child.declare()
        if self.reindent:
            decl = self.reindentString(decl, self.declarePre)
        return self.declarePre + decl + self.declarePost

    def define(self):
        if self.declareOnly:
            return ""
        defn = self.child.define()
        if self.reindent:
            defn = self.reindentString(defn, self.definePre)
        return self.definePre + defn + self.definePost

    @staticmethod
    def reindentString(stringToIndent, widthString):
        # We don't use lineStartDetector because we don't want to
        # insert whitespace at the beginning of our _first_ line.
        # Use the length of the last line of width string, in case
        # it is a multiline string.
        lastLineWidth = len(widthString.splitlines()[-1])
        return stripTrailingWhitespace(
            stringToIndent.replace("\n", "\n" + (" " * lastLineWidth))
        )

    def deps(self):
        return self.child.deps()


class CGIfWrapper(CGList):
    def __init__(self, child, condition):
        CGList.__init__(
            self,
            [
                CGWrapper(
                    CGGeneric(condition), pre="if (", post=") {\n", reindent=True
                ),
                CGIndenter(child),
                CGGeneric("}\n"),
            ],
        )


class CGIfElseWrapper(CGList):
    def __init__(self, condition, ifTrue, ifFalse):
        CGList.__init__(
            self,
            [
                CGWrapper(
                    CGGeneric(condition), pre="if (", post=") {\n", reindent=True
                ),
                CGIndenter(ifTrue),
                CGGeneric("} else {\n"),
                CGIndenter(ifFalse),
                CGGeneric("}\n"),
            ],
        )


class CGElseChain(CGThing):
    """
    Concatenate if statements in an if-else-if-else chain.
    """

    def __init__(self, children):
        self.children = [c for c in children if c is not None]

    def declare(self):
        assert False

    def define(self):
        if not self.children:
            return ""
        s = self.children[0].define()
        assert s.endswith("\n")
        for child in self.children[1:]:
            code = child.define()
            assert code.startswith("if") or code.startswith("{")
            assert code.endswith("\n")
            s = s.rstrip() + " else " + code
        return s


class CGTemplatedType(CGWrapper):
    def __init__(self, templateName, child, isConst=False, isReference=False):
        if isinstance(child, list):
            child = CGList(child, ", ")
        const = "const " if isConst else ""
        pre = "%s%s<" % (const, templateName)
        ref = "&" if isReference else ""
        post = ">%s" % ref
        CGWrapper.__init__(self, child, pre=pre, post=post)


class CGNamespace(CGThing):
    """
    Generates namespace block that wraps other CGThings.
    """

    def __init__(self, namespace, child):
        CGThing.__init__(self)
        self.child = child
        self.pre = "namespace %s {\n" % namespace
        self.post = "} // namespace %s\n" % namespace

    def declare(self):
        decl = self.child.declare()
        if len(decl.strip()) == 0:
            return ""
        return self.pre + decl + self.post

    def define(self):
        defn = self.child.define()
        if len(defn.strip()) == 0:
            return ""
        return self.pre + defn + self.post

    def deps(self):
        return self.child.deps()

    @staticmethod
    def build(namespaces, child):
        """
        Static helper method to build multiple wrapped namespaces.
        """
        if not namespaces:
            return CGWrapper(child)
        return CGNamespace("::".join(namespaces), child)


class CGIncludeGuard(CGWrapper):
    """
    Generates include guards for a header.
    """

    def __init__(self, prefix, child):
        """|prefix| is the filename without the extension."""
        define = "mozilla_dom_%s_h" % prefix
        CGWrapper.__init__(
            self,
            child,
            declarePre="#ifndef %s\n#define %s\n\n" % (define, define),
            declarePost="\n#endif // %s\n" % define,
        )


class CGHeaders(CGWrapper):
    """
    Generates the appropriate include statements.
    """

    def __init__(
        self,
        descriptors,
        dictionaries,
        callbacks,
        callbackDescriptors,
        declareIncludes,
        defineIncludes,
        prefix,
        child,
        config=None,
        jsImplementedDescriptors=[],
    ):
        """
        Builds a set of includes to cover |descriptors|.

        Also includes the files in |declareIncludes| in the header
        file and the files in |defineIncludes| in the .cpp.

        |prefix| contains the basename of the file that we generate include
        statements for.
        """

        # Determine the filenames for which we need headers.
        interfaceDeps = [d.interface for d in descriptors]
        ancestors = []
        for iface in interfaceDeps:
            if iface.parent:
                # We're going to need our parent's prototype, to use as the
                # prototype of our prototype object.
                ancestors.append(iface.parent)
                # And if we have an interface object, we'll need the nearest
                # ancestor with an interface object too, so we can use its
                # interface object as the proto of our interface object.
                if iface.hasInterfaceObject():
                    parent = iface.parent
                    while parent and not parent.hasInterfaceObject():
                        parent = parent.parent
                    if parent:
                        ancestors.append(parent)
        interfaceDeps.extend(ancestors)

        # Include parent interface headers needed for default toJSON code.
        jsonInterfaceParents = []
        for desc in descriptors:
            if not desc.hasDefaultToJSON:
                continue
            parent = desc.interface.parent
            while parent:
                parentDesc = desc.getDescriptor(parent.identifier.name)
                if parentDesc.hasDefaultToJSON:
                    jsonInterfaceParents.append(parentDesc.interface)
                parent = parent.parent
        interfaceDeps.extend(jsonInterfaceParents)

        bindingIncludes = set(self.getDeclarationFilename(d) for d in interfaceDeps)

        # Grab all the implementation declaration files we need.
        implementationIncludes = set(
            d.headerFile for d in descriptors if d.needsHeaderInclude()
        )

        # Now find all the things we'll need as arguments because we
        # need to wrap or unwrap them.
        bindingHeaders = set()
        declareIncludes = set(declareIncludes)

        def addHeadersForType(typeAndPossibleOriginType):
            """
            Add the relevant headers for this type.  We use its origin type, if
            passed, to decide what to do with interface types.
            """
            t, originType = typeAndPossibleOriginType
            isFromDictionary = originType and originType.isDictionary()
            isFromCallback = originType and originType.isCallback()
            # Dictionaries have members that need to be actually
            # declared, not just forward-declared.
            # Callbacks have nullable union arguments that need to be actually
            # declared, not just forward-declared.
            if isFromDictionary:
                headerSet = declareIncludes
            elif isFromCallback and t.nullable() and t.isUnion():
                headerSet = declareIncludes
            else:
                headerSet = bindingHeaders
            # Strip off outer layers and add headers they might require.  (This
            # is conservative: only nullable non-pointer types need Nullable.h;
            # only sequences or observable arrays outside unions need
            # ForOfIterator.h; only functions that return, and attributes that
            # are, sequences or observable arrays in interfaces need Array.h, &c.)
            unrolled = t
            while True:
                if idlTypeNeedsCallContext(unrolled):
                    bindingHeaders.add("mozilla/dom/BindingCallContext.h")
                if unrolled.nullable():
                    headerSet.add("mozilla/dom/Nullable.h")
                elif unrolled.isSequence() or unrolled.isObservableArray():
                    bindingHeaders.add("js/Array.h")
                    bindingHeaders.add("js/ForOfIterator.h")
                    if unrolled.isObservableArray():
                        bindingHeaders.add("mozilla/dom/ObservableArrayProxyHandler.h")
                else:
                    break
                unrolled = unrolled.inner
            if unrolled.isUnion():
                headerSet.add(self.getUnionDeclarationFilename(config, unrolled))
                for t in unrolled.flatMemberTypes:
                    addHeadersForType((t, None))
            elif unrolled.isPromise():
                # See comment in the isInterface() case for why we add
                # Promise.h to headerSet, not bindingHeaders.
                headerSet.add("mozilla/dom/Promise.h")
                # We need ToJSValue to do the Promise to JS conversion.
                bindingHeaders.add("mozilla/dom/ToJSValue.h")
            elif unrolled.isInterface():
                if unrolled.isSpiderMonkeyInterface():
                    bindingHeaders.add("jsfriendapi.h")
                    if jsImplementedDescriptors:
                        # Since we can't forward-declare typed array types
                        # (because they're typedefs), we have to go ahead and
                        # just include their header if we need to have functions
                        # taking references to them declared in that header.
                        headerSet = declareIncludes
                    headerSet.add("mozilla/dom/TypedArray.h")
                else:
                    try:
                        typeDesc = config.getDescriptor(unrolled.inner.identifier.name)
                    except NoSuchDescriptorError:
                        return
                    # Dictionaries with interface members rely on the
                    # actual class definition of that interface member
                    # being visible in the binding header, because they
                    # store them in RefPtr and have inline
                    # constructors/destructors.
                    #
                    # XXXbz maybe dictionaries with interface members
                    # should just have out-of-line constructors and
                    # destructors?
                    headerSet.add(typeDesc.headerFile)
            elif unrolled.isDictionary():
                headerSet.add(self.getDeclarationFilename(unrolled.inner))
                # And if it needs rooting, we need RootedDictionary too
                if typeNeedsRooting(unrolled):
                    headerSet.add("mozilla/dom/RootedDictionary.h")
            elif unrolled.isCallback():
                headerSet.add(self.getDeclarationFilename(unrolled.callback))
            elif unrolled.isFloat() and not unrolled.isUnrestricted():
                # Restricted floats are tested for finiteness
                bindingHeaders.add("mozilla/FloatingPoint.h")
                bindingHeaders.add("mozilla/dom/PrimitiveConversions.h")
            elif unrolled.isEnum():
                filename = self.getDeclarationFilename(unrolled.inner)
                declareIncludes.add(filename)
            elif unrolled.isPrimitive():
                bindingHeaders.add("mozilla/dom/PrimitiveConversions.h")
            elif unrolled.isRecord():
                if isFromDictionary or jsImplementedDescriptors:
                    declareIncludes.add("mozilla/dom/Record.h")
                else:
                    bindingHeaders.add("mozilla/dom/Record.h")
                # Also add headers for the type the record is
                # parametrized over, if needed.
                addHeadersForType((t.inner, originType if isFromDictionary else None))

        for t in getAllTypes(
            descriptors + callbackDescriptors, dictionaries, callbacks
        ):
            addHeadersForType(t)

        def addHeaderForFunc(func, desc):
            if func is None:
                return
            # Include the right class header, which we can only do
            # if this is a class member function.
            if desc is not None and not desc.headerIsDefault:
                # An explicit header file was provided, assume that we know
                # what we're doing.
                return

            if "::" in func:
                # Strip out the function name and convert "::" to "/"
                bindingHeaders.add("/".join(func.split("::")[:-1]) + ".h")

        # Now for non-callback descriptors make sure we include any
        # headers needed by Func declarations and other things like that.
        for desc in descriptors:
            # If this is an iterator or an async iterator interface generated
            # for a separate iterable interface, skip generating type includes,
            # as we have what we need in IterableIterator.h
            if (
                desc.interface.isIteratorInterface()
                or desc.interface.isAsyncIteratorInterface()
            ):
                continue

            for m in desc.interface.members:
                addHeaderForFunc(PropertyDefiner.getStringAttr(m, "Func"), desc)
                staticTypeOverride = PropertyDefiner.getStringAttr(
                    m, "StaticClassOverride"
                )
                if staticTypeOverride:
                    bindingHeaders.add("/".join(staticTypeOverride.split("::")) + ".h")
            # getExtendedAttribute() returns a list, extract the entry.
            funcList = desc.interface.getExtendedAttribute("Func")
            if funcList is not None:
                addHeaderForFunc(funcList[0], desc)

            if desc.interface.maplikeOrSetlikeOrIterable:
                # We need ToJSValue.h for maplike/setlike type conversions
                bindingHeaders.add("mozilla/dom/ToJSValue.h")
                # Add headers for the key and value types of the
                # maplike/setlike/iterable, since they'll be needed for
                # convenience functions
                if desc.interface.maplikeOrSetlikeOrIterable.hasKeyType():
                    addHeadersForType(
                        (desc.interface.maplikeOrSetlikeOrIterable.keyType, None)
                    )
                if desc.interface.maplikeOrSetlikeOrIterable.hasValueType():
                    addHeadersForType(
                        (desc.interface.maplikeOrSetlikeOrIterable.valueType, None)
                    )

        for d in dictionaries:
            if d.parent:
                declareIncludes.add(self.getDeclarationFilename(d.parent))
            bindingHeaders.add(self.getDeclarationFilename(d))
            for m in d.members:
                addHeaderForFunc(PropertyDefiner.getStringAttr(m, "Func"), None)
            # No need to worry about Func on members of ancestors, because that
            # will happen automatically in whatever files those ancestors live
            # in.

        for c in callbacks:
            bindingHeaders.add(self.getDeclarationFilename(c))

        for c in callbackDescriptors:
            bindingHeaders.add(self.getDeclarationFilename(c.interface))

        if len(callbacks) != 0:
            # We need CallbackFunction to serve as our parent class
            declareIncludes.add("mozilla/dom/CallbackFunction.h")
            # And we need ToJSValue.h so we can wrap "this" objects
            declareIncludes.add("mozilla/dom/ToJSValue.h")

        if len(callbackDescriptors) != 0 or len(jsImplementedDescriptors) != 0:
            # We need CallbackInterface to serve as our parent class
            declareIncludes.add("mozilla/dom/CallbackInterface.h")
            # And we need ToJSValue.h so we can wrap "this" objects
            declareIncludes.add("mozilla/dom/ToJSValue.h")

        # Also need to include the headers for ancestors of
        # JS-implemented interfaces.
        for jsImplemented in jsImplementedDescriptors:
            jsParent = jsImplemented.interface.parent
            if jsParent:
                parentDesc = jsImplemented.getDescriptor(jsParent.identifier.name)
                declareIncludes.add(parentDesc.jsImplParentHeader)

        # Now make sure we're not trying to include the header from inside itself
        declareIncludes.discard(prefix + ".h")

        # Let the machinery do its thing.
        def _includeString(includes):
            def headerName(include):
                # System headers are specified inside angle brackets.
                if include.startswith("<"):
                    return include
                # Non-system headers need to be placed in quotes.
                return '"%s"' % include

            return "".join(["#include %s\n" % headerName(i) for i in includes]) + "\n"

        CGWrapper.__init__(
            self,
            child,
            declarePre=_includeString(sorted(declareIncludes)),
            definePre=_includeString(
                sorted(
                    set(defineIncludes)
                    | bindingIncludes
                    | bindingHeaders
                    | implementationIncludes
                )
            ),
        )

    @staticmethod
    def getDeclarationFilename(decl):
        # Use our local version of the header, not the exported one, so that
        # test bindings, which don't export, will work correctly.
        basename = os.path.basename(decl.filename())
        return basename.replace(".webidl", "Binding.h")

    @staticmethod
    def getUnionDeclarationFilename(config, unionType):
        assert unionType.isUnion()
        assert unionType.unroll() == unionType
        # If a union is "defined" in multiple files, it goes in UnionTypes.h.
        if len(config.filenamesPerUnion[unionType.name]) > 1:
            return "mozilla/dom/UnionTypes.h"
        # If a union is defined by a built-in typedef, it also goes in
        # UnionTypes.h.
        assert len(config.filenamesPerUnion[unionType.name]) == 1
        if "<unknown>" in config.filenamesPerUnion[unionType.name]:
            return "mozilla/dom/UnionTypes.h"
        return CGHeaders.getDeclarationFilename(unionType)


def SortedDictValues(d):
    """
    Returns a list of values from the dict sorted by key.
    """
    return [v for k, v in sorted(d.items())]


def UnionsForFile(config, webIDLFile):
    """
    Returns a list of union types for all union types that are only used in
    webIDLFile. If webIDLFile is None this will return the list of tuples for
    union types that are used in more than one WebIDL file.
    """
    return config.unionsPerFilename.get(webIDLFile, [])


def UnionTypes(unionTypes, config):
    """
    The unionTypes argument should be a list of union types. This is typically
    the list generated by UnionsForFile.

    Returns a tuple containing a set of header filenames to include in
    the header for the types in unionTypes, a set of header filenames to
    include in the implementation file for the types in unionTypes, a set
    of tuples containing a type declaration and a boolean if the type is a
    struct for member types of the union, a list of traverse methods,
    unlink methods and a list of union types. These last three lists only
    contain unique union types.
    """

    headers = set()
    implheaders = set()
    declarations = set()
    unionStructs = dict()
    traverseMethods = dict()
    unlinkMethods = dict()

    for t in unionTypes:
        name = str(t)
        if name not in unionStructs:
            unionStructs[name] = t

            def addHeadersForType(f):
                if f.nullable():
                    headers.add("mozilla/dom/Nullable.h")
                isSequence = f.isSequence()
                if isSequence:
                    # Dealing with sequences requires for-of-compatible
                    # iteration.
                    implheaders.add("js/ForOfIterator.h")
                    # Sequences can always throw "not an object" exceptions.
                    implheaders.add("mozilla/dom/BindingCallContext.h")
                    if typeNeedsRooting(f):
                        headers.add("mozilla/dom/RootedSequence.h")
                f = f.unroll()
                if idlTypeNeedsCallContext(f):
                    implheaders.add("mozilla/dom/BindingCallContext.h")
                if f.isPromise():
                    headers.add("mozilla/dom/Promise.h")
                    # We need ToJSValue to do the Promise to JS conversion.
                    headers.add("mozilla/dom/ToJSValue.h")
                elif f.isInterface():
                    if f.isSpiderMonkeyInterface():
                        headers.add("js/RootingAPI.h")
                        headers.add("js/Value.h")
                        headers.add("mozilla/dom/TypedArray.h")
                    else:
                        try:
                            typeDesc = config.getDescriptor(f.inner.identifier.name)
                        except NoSuchDescriptorError:
                            return
                        if typeDesc.interface.isCallback() or isSequence:
                            # Callback interfaces always use strong refs, so
                            # we need to include the right header to be able
                            # to Release() in our inlined code.
                            #
                            # Similarly, sequences always contain strong
                            # refs, so we'll need the header to handler
                            # those.
                            headers.add(typeDesc.headerFile)
                        elif typeDesc.interface.identifier.name == "WindowProxy":
                            # In UnionTypes.h we need to see the declaration of the
                            # WindowProxyHolder that we use to store the WindowProxy, so
                            # we have its sizeof and know how big to make our union.
                            headers.add(typeDesc.headerFile)
                        else:
                            declarations.add((typeDesc.nativeType, False))
                            implheaders.add(typeDesc.headerFile)
                elif f.isDictionary():
                    # For a dictionary, we need to see its declaration in
                    # UnionTypes.h so we have its sizeof and know how big to
                    # make our union.
                    headers.add(CGHeaders.getDeclarationFilename(f.inner))
                    # And if it needs rooting, we need RootedDictionary too
                    if typeNeedsRooting(f):
                        headers.add("mozilla/dom/RootedDictionary.h")
                elif f.isFloat() and not f.isUnrestricted():
                    # Restricted floats are tested for finiteness
                    implheaders.add("mozilla/FloatingPoint.h")
                    implheaders.add("mozilla/dom/PrimitiveConversions.h")
                elif f.isEnum():
                    # Need to see the actual definition of the enum,
                    # unfortunately.
                    headers.add(CGHeaders.getDeclarationFilename(f.inner))
                elif f.isPrimitive():
                    implheaders.add("mozilla/dom/PrimitiveConversions.h")
                elif f.isCallback():
                    # Callbacks always use strong refs, so we need to include
                    # the right header to be able to Release() in our inlined
                    # code.
                    headers.add(CGHeaders.getDeclarationFilename(f.callback))
                elif f.isRecord():
                    headers.add("mozilla/dom/Record.h")
                    # And add headers for the type we're parametrized over
                    addHeadersForType(f.inner)
                    # And if it needs rooting, we need RootedRecord too
                    if typeNeedsRooting(f):
                        headers.add("mozilla/dom/RootedRecord.h")

            implheaders.add(CGHeaders.getUnionDeclarationFilename(config, t))
            for f in t.flatMemberTypes:
                assert not f.nullable()
                addHeadersForType(f)

            if idlTypeNeedsCycleCollection(t):
                declarations.add(
                    ("mozilla::dom::%s" % CGUnionStruct.unionTypeName(t, True), False)
                )
                traverseMethods[name] = CGCycleCollectionTraverseForOwningUnionMethod(t)
                unlinkMethods[name] = CGCycleCollectionUnlinkForOwningUnionMethod(t)

    # The order of items in CGList is important.
    # Since the union structs friend the unlinkMethods, the forward-declaration
    # for these methods should come before the class declaration. Otherwise
    # some compilers treat the friend declaration as a forward-declaration in
    # the class scope.
    return (
        headers,
        implheaders,
        declarations,
        SortedDictValues(traverseMethods),
        SortedDictValues(unlinkMethods),
        SortedDictValues(unionStructs),
    )


class Argument:
    """
    A class for outputting the type and name of an argument
    """

    def __init__(self, argType, name, default=None):
        self.argType = argType
        self.name = name
        self.default = default

    def declare(self):
        string = self.argType + " " + self.name
        if self.default is not None:
            string += " = " + self.default
        return string

    def define(self):
        return self.argType + " " + self.name


class CGAbstractMethod(CGThing):
    """
    An abstract class for generating code for a method.  Subclasses
    should override definition_body to create the actual code.

    descriptor is the descriptor for the interface the method is associated with

    name is the name of the method as a string

    returnType is the IDLType of the return value

    args is a list of Argument objects

    inline should be True to generate an inline method, whose body is
    part of the declaration.

    alwaysInline should be True to generate an inline method annotated with
    MOZ_ALWAYS_INLINE.

    static should be True to generate a static method, which only has
    a definition.

    If templateArgs is not None it should be a list of strings containing
    template arguments, and the function will be templatized using those
    arguments.

    canRunScript should be True to generate a MOZ_CAN_RUN_SCRIPT annotation.

    signatureOnly should be True to only declare the signature (either in
                  the header, or if static is True in the cpp file).
    """

    def __init__(
        self,
        descriptor,
        name,
        returnType,
        args,
        inline=False,
        alwaysInline=False,
        static=False,
        templateArgs=None,
        canRunScript=False,
        signatureOnly=False,
    ):
        CGThing.__init__(self)
        self.descriptor = descriptor
        self.name = name
        self.returnType = returnType
        self.args = args
        self.inline = inline
        self.alwaysInline = alwaysInline
        self.static = static
        self.templateArgs = templateArgs
        self.canRunScript = canRunScript
        self.signatureOnly = signatureOnly

    def _argstring(self, declare):
        return ", ".join([a.declare() if declare else a.define() for a in self.args])

    def _template(self):
        if self.templateArgs is None:
            return ""
        return "template <%s>\n" % ", ".join(self.templateArgs)

    def _decorators(self):
        decorators = []
        if self.canRunScript:
            decorators.append("MOZ_CAN_RUN_SCRIPT")
        if self.alwaysInline:
            decorators.append("MOZ_ALWAYS_INLINE")
        elif self.inline:
            decorators.append("inline")
        if self.static:
            decorators.append("static")
        decorators.append(self.returnType)
        maybeNewline = " " if self.inline else "\n"
        return " ".join(decorators) + maybeNewline

    def signature(self):
        return "%s%s%s(%s);\n" % (
            self._template(),
            self._decorators(),
            self.name,
            self._argstring(True),
        )

    def declare(self):
        if self.static:
            return ""
        if self.inline:
            return self._define(True)
        return self.signature()

    def indent_body(self, body):
        """
        Indent the code returned by self.definition_body(). Most classes
        simply indent everything two spaces. This is here for
        CGRegisterProtos, which needs custom indentation.
        """
        return indent(body)

    def _define(self, fromDeclare=False):
        return (
            self.definition_prologue(fromDeclare)
            + self.indent_body(self.definition_body())
            + self.definition_epilogue()
        )

    def define(self):
        if self.signatureOnly:
            if self.static:
                # self.static makes us not output anything in the header, so output the signature here.
                return self.signature()
            return ""
        return "" if (self.inline and not self.static) else self._define()

    def definition_prologue(self, fromDeclare):
        error_reporting_label = self.error_reporting_label()
        if error_reporting_label:
            # We're going to want a BindingCallContext.  Rename our JSContext*
            # arg accordingly.
            i = 0
            while i < len(self.args):
                arg = self.args[i]
                if arg.argType == "JSContext*":
                    cxname = arg.name
                    self.args[i] = Argument(arg.argType, "cx_", arg.default)
                    break
                i += 1
            if i == len(self.args):
                raise TypeError("Must have a JSContext* to create a BindingCallContext")

        prologue = "%s%s%s(%s)\n{\n" % (
            self._template(),
            self._decorators(),
            self.name,
            self._argstring(fromDeclare),
        )
        if error_reporting_label:
            prologue += indent(
                fill(
                    """
                BindingCallContext ${cxname}(cx_, "${label}");
                """,
                    cxname=cxname,
                    label=error_reporting_label,
                )
            )

        profiler_label = self.auto_profiler_label()
        if profiler_label:
            prologue += indent(profiler_label) + "\n"

        return prologue

    def definition_epilogue(self):
        return "}\n"

    def definition_body(self):
        assert False  # Override me!

    """
    Override this method to return a pair of (descriptive string, name of a
    JSContext* variable) in order to generate a profiler label for this method.
    """

    def auto_profiler_label(self):
        return None  # Override me!

    """
    Override this method to return a string to be used as the label for a
    BindingCallContext.  If this does not return None, one of the arguments of
    this method must be of type 'JSContext*'.  Its name will be replaced with
    'cx_' and a BindingCallContext named 'cx' will be instantiated with the
    given label.
    """

    def error_reporting_label(self):
        return None  # Override me!


class CGAbstractStaticMethod(CGAbstractMethod):
    """
    Abstract base class for codegen of implementation-only (no
    declaration) static methods.
    """

    def __init__(self, descriptor, name, returnType, args, canRunScript=False):
        CGAbstractMethod.__init__(
            self,
            descriptor,
            name,
            returnType,
            args,
            inline=False,
            static=True,
            canRunScript=canRunScript,
        )


class CGAbstractClassHook(CGAbstractStaticMethod):
    """
    Meant for implementing JSClass hooks, like Finalize or Trace. Does very raw
    'this' unwrapping as it assumes that the unwrapped type is always known.
    """

    def __init__(self, descriptor, name, returnType, args):
        CGAbstractStaticMethod.__init__(self, descriptor, name, returnType, args)

    def definition_body_prologue(self):
        return "%s* self = UnwrapPossiblyNotInitializedDOMObject<%s>(obj);\n" % (
            self.descriptor.nativeType,
            self.descriptor.nativeType,
        )

    def definition_body(self):
        return self.definition_body_prologue() + self.generate_code()

    def generate_code(self):
        assert False  # Override me!


class CGAddPropertyHook(CGAbstractClassHook):
    """
    A hook for addProperty, used to preserve our wrapper from GC.
    """

    def __init__(self, descriptor):
        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "obj"),
            Argument("JS::Handle<jsid>", "id"),
            Argument("JS::Handle<JS::Value>", "val"),
        ]
        CGAbstractClassHook.__init__(
            self, descriptor, ADDPROPERTY_HOOK_NAME, "bool", args
        )

    def generate_code(self):
        assert self.descriptor.wrapperCache
        # This hook is also called by TryPreserveWrapper on non-nsISupports
        # cycle collected objects, so if addProperty is ever changed to do
        # anything more or less than preserve the wrapper, TryPreserveWrapper
        # will need to be changed.
        return dedent(
            """
            // We don't want to preserve if we don't have a wrapper, and we
            // obviously can't preserve if we're not initialized.
            if (self && self->GetWrapperPreserveColor()) {
              PreserveWrapper(self);
            }
            return true;
            """
        )


class CGGetWrapperCacheHook(CGAbstractClassHook):
    """
    A hook for GetWrapperCache, used by HasReleasedWrapper to get the
    nsWrapperCache pointer for a non-nsISupports object.
    """

    def __init__(self, descriptor):
        args = [Argument("JS::Handle<JSObject*>", "obj")]
        CGAbstractClassHook.__init__(
            self, descriptor, GETWRAPPERCACHE_HOOK_NAME, "nsWrapperCache*", args
        )

    def generate_code(self):
        assert self.descriptor.wrapperCache
        return dedent(
            """
            return self;
            """
        )


def finalizeHook(descriptor, hookName, gcx, obj):
    finalize = "JS::SetReservedSlot(%s, DOM_OBJECT_SLOT, JS::UndefinedValue());\n" % obj
    if descriptor.interface.getExtendedAttribute("LegacyOverrideBuiltIns"):
        finalize += fill(
            """
            // Either our proxy created an expando object or not.  If it did,
            // then we would have preserved ourselves, and hence if we're going
            // away so is our C++ object and we should reset its expando value.
            // It's possible that in this situation the C++ object's reflector
            // pointer has been nulled out, but if not it's pointing to us.  If
            // our proxy did _not_ create an expando object then it's possible
            // that we're no longer the reflector for our C++ object (and
            // incremental finalization is finally getting to us), and that in
            // the meantime the new reflector has created an expando object.
            // In that case we do NOT want to clear the expando pointer in the
            // C++ object.
            //
            // It's important to do this before we ClearWrapper, of course.
            JSObject* reflector = self->GetWrapperMaybeDead();
            if (!reflector || reflector == ${obj}) {
              self->mExpandoAndGeneration.expando = JS::UndefinedValue();
            }
            """,
            obj=obj,
        )
    for m in descriptor.interface.members:
        if m.isAttr() and m.type.isObservableArray():
            finalize += fill(
                """
                {
                  JS::Value val = JS::GetReservedSlot(obj, ${slot});
                  if (!val.isUndefined()) {
                    JSObject* obj = &val.toObject();
                    js::SetProxyReservedSlot(obj, OBSERVABLE_ARRAY_DOM_INTERFACE_SLOT, JS::UndefinedValue());
                  }
                }
                """,
                slot=memberReservedSlot(m, descriptor),
            )
    if descriptor.wrapperCache:
        finalize += "ClearWrapper(self, self, %s);\n" % obj
    if descriptor.isGlobal():
        finalize += "mozilla::dom::FinalizeGlobal(%s, %s);\n" % (gcx, obj)
    finalize += fill(
        """
        if (size_t mallocBytes = BindingJSObjectMallocBytes(self)) {
          JS::RemoveAssociatedMemory(${obj}, mallocBytes,
                                     JS::MemoryUse::DOMBinding);
        }
        """,
        obj=obj,
    )
    finalize += "AddForDeferredFinalization<%s>(self);\n" % descriptor.nativeType
    return CGIfWrapper(CGGeneric(finalize), "self")


class CGClassFinalizeHook(CGAbstractClassHook):
    """
    A hook for finalize, used to release our native object.
    """

    def __init__(self, descriptor):
        args = [Argument("JS::GCContext*", "gcx"), Argument("JSObject*", "obj")]
        CGAbstractClassHook.__init__(self, descriptor, FINALIZE_HOOK_NAME, "void", args)

    def generate_code(self):
        return finalizeHook(
            self.descriptor, self.name, self.args[0].name, self.args[1].name
        ).define()


def objectMovedHook(descriptor, hookName, obj, old):
    assert descriptor.wrapperCache
    return fill(
        """
        if (self) {
          UpdateWrapper(self, self, ${obj}, ${old});
        }

        return 0;
        """,
        obj=obj,
        old=old,
    )


class CGClassObjectMovedHook(CGAbstractClassHook):
    """
    A hook for objectMovedOp, used to update the wrapper cache when an object it
    is holding moves.
    """

    def __init__(self, descriptor):
        args = [Argument("JSObject*", "obj"), Argument("JSObject*", "old")]
        CGAbstractClassHook.__init__(
            self, descriptor, OBJECT_MOVED_HOOK_NAME, "size_t", args
        )

    def generate_code(self):
        return objectMovedHook(
            self.descriptor, self.name, self.args[0].name, self.args[1].name
        )


def JSNativeArguments():
    return [
        Argument("JSContext*", "cx"),
        Argument("unsigned", "argc"),
        Argument("JS::Value*", "vp"),
    ]


class CGClassConstructor(CGAbstractStaticMethod):
    """
    JS-visible constructor for our objects
    """

    def __init__(self, descriptor, ctor, name=CONSTRUCT_HOOK_NAME):
        CGAbstractStaticMethod.__init__(
            self, descriptor, name, "bool", JSNativeArguments()
        )
        self._ctor = ctor

    def define(self):
        if not self._ctor:
            return ""
        return CGAbstractStaticMethod.define(self)

    def definition_body(self):
        return self.generate_code()

    def generate_code(self):
        if self._ctor.isHTMLConstructor():
            # We better have a prototype object.  Otherwise our proto
            # id won't make sense.
            assert self.descriptor.interface.hasInterfacePrototypeObject()
            # We also better have a constructor object, if this is
            # getting called!
            assert self.descriptor.interface.hasInterfaceObject()
            # We can't just pass null for the CreateInterfaceObjects callback,
            # because our newTarget might be in a different compartment, in
            # which case we'll need to look up constructor objects in that
            # compartment.
            return fill(
                """
                return HTMLConstructor(cx, argc, vp,
                                       constructors::id::${name},
                                       prototypes::id::${name},
                                       CreateInterfaceObjects);
                """,
                name=self.descriptor.name,
            )

        # If the interface is already SecureContext, notify getConditionList to skip that check,
        # because the constructor won't be exposed in non-secure contexts to start with.
        alreadySecureContext = self.descriptor.interface.getExtendedAttribute(
            "SecureContext"
        )

        # We want to throw if any of the conditions returned by getConditionList are false.
        conditionsCheck = ""
        rawConditions = getRawConditionList(
            self._ctor, "cx", "obj", alreadySecureContext
        )
        if len(rawConditions) > 0:
            notConditions = " ||\n".join("!" + cond for cond in rawConditions)
            failedCheckAction = CGGeneric("return ThrowingConstructor(cx, argc, vp);\n")
            conditionsCheck = (
                CGIfWrapper(failedCheckAction, notConditions).define() + "\n"
            )

        # Additionally, we want to throw if a caller does a bareword invocation
        # of a constructor without |new|.
        ctorName = GetConstructorNameForReporting(self.descriptor, self._ctor)

        preamble = fill(
            """
            JS::CallArgs args = JS::CallArgsFromVp(argc, vp);
            JS::Rooted<JSObject*> obj(cx, &args.callee());
            $*{conditionsCheck}
            if (!args.isConstructing()) {
              return ThrowConstructorWithoutNew(cx, "${ctorName}");
            }

            JS::Rooted<JSObject*> desiredProto(cx);
            if (!GetDesiredProto(cx, args,
                                 prototypes::id::${name},
                                 CreateInterfaceObjects,
                                 &desiredProto)) {
              return false;
            }
            """,
            conditionsCheck=conditionsCheck,
            ctorName=ctorName,
            name=self.descriptor.name,
        )

        name = self._ctor.identifier.name
        nativeName = MakeNativeName(self.descriptor.binaryNameFor(name, True))
        callGenerator = CGMethodCall(
            nativeName, True, self.descriptor, self._ctor, isConstructor=True
        )
        return preamble + "\n" + callGenerator.define()

    def auto_profiler_label(self):
        return fill(
            """
            AUTO_PROFILER_LABEL_DYNAMIC_FAST(
              "${ctorName}", "constructor", DOM, cx,
              uint32_t(js::ProfilingStackFrame::Flags::RELEVANT_FOR_JS));
            """,
            ctorName=GetConstructorNameForReporting(self.descriptor, self._ctor),
        )

    def error_reporting_label(self):
        return CGSpecializedMethod.error_reporting_label_helper(
            self.descriptor, self._ctor, isConstructor=True
        )


def LegacyFactoryFunctionName(m):
    return "_" + m.identifier.name


class CGLegacyFactoryFunctions(CGThing):
    def __init__(self, descriptor):
        self.descriptor = descriptor
        CGThing.__init__(self)

    def declare(self):
        return ""

    def define(self):
        if len(self.descriptor.interface.legacyFactoryFunctions) == 0:
            return ""

        constructorID = "constructors::id::"
        if self.descriptor.interface.hasInterfaceObject():
            constructorID += self.descriptor.name
        else:
            constructorID += "_ID_Count"

        namedConstructors = ""
        for n in self.descriptor.interface.legacyFactoryFunctions:
            namedConstructors += (
                '{ "%s", { %s, &sLegacyFactoryFunctionNativePropertyHooks }, %i },\n'
                % (n.identifier.name, LegacyFactoryFunctionName(n), methodLength(n))
            )

        return fill(
            """
            bool sLegacyFactoryFunctionNativePropertiesInited = true;
            const NativePropertyHooks sLegacyFactoryFunctionNativePropertyHooks = {
                nullptr,
                nullptr,
                nullptr,
                { nullptr, nullptr, &sLegacyFactoryFunctionNativePropertiesInited },
                prototypes::id::${name},
                ${constructorID},
                nullptr
            };

            static const LegacyFactoryFunction namedConstructors[] = {
              $*{namedConstructors}
              { nullptr, { nullptr, nullptr }, 0 }
            };
            """,
            name=self.descriptor.name,
            constructorID=constructorID,
            namedConstructors=namedConstructors,
        )


def isChromeOnly(m):
    return m.getExtendedAttribute("ChromeOnly")


def prefIdentifier(pref):
    return pref.replace(".", "_").replace("-", "_")


def prefHeader(pref):
    return "mozilla/StaticPrefs_%s.h" % pref.partition(".")[0]


class MemberCondition:
    """
    An object representing the condition for a member to actually be
    exposed.  Any of the arguments can be None.  If not
    None, they should have the following types:

    pref: The name of the preference.
    func: The name of the function.
    secureContext: A bool indicating whether a secure context is required.
    nonExposedGlobals: A set of names of globals.  Can be empty, in which case
                       it's treated the same way as None.
    trial: The name of the origin trial.
    """

    def __init__(
        self,
        pref=None,
        func=None,
        secureContext=False,
        nonExposedGlobals=None,
        trial=None,
    ):
        assert pref is None or isinstance(pref, str)
        assert func is None or isinstance(func, str)
        assert trial is None or isinstance(trial, str)
        assert isinstance(secureContext, bool)
        assert nonExposedGlobals is None or isinstance(nonExposedGlobals, set)
        self.pref = pref
        if self.pref:
            identifier = prefIdentifier(self.pref)
            self.prefFuncIndex = "WebIDLPrefIndex::" + identifier
        else:
            self.prefFuncIndex = "WebIDLPrefIndex::NoPref"

        self.secureContext = secureContext

        def toFuncPtr(val):
            if val is None:
                return "nullptr"
            return "&" + val

        self.func = toFuncPtr(func)

        if nonExposedGlobals:
            # Nonempty set
            self.nonExposedGlobals = " | ".join(
                map(lambda g: "GlobalNames::%s" % g, sorted(nonExposedGlobals))
            )
        else:
            self.nonExposedGlobals = "0"

        if trial:
            self.trial = "OriginTrial::" + trial
        else:
            self.trial = "OriginTrial(0)"

    def __eq__(self, other):
        return (
            self.pref == other.pref
            and self.func == other.func
            and self.secureContext == other.secureContext
            and self.nonExposedGlobals == other.nonExposedGlobals
            and self.trial == other.trial
        )

    def __ne__(self, other):
        return not self.__eq__(other)

    def hasDisablers(self):
        return (
            self.pref is not None
            or self.secureContext
            or self.func != "nullptr"
            or self.nonExposedGlobals != "0"
            or self.trial != "OriginTrial(0)"
        )


class PropertyDefiner:
    """
    A common superclass for defining things on prototype objects.

    Subclasses should implement generateArray to generate the actual arrays of
    things we're defining.  They should also set self.chrome to the list of
    things only exposed to chrome and self.regular to the list of things exposed
    to both chrome and web pages.
    """

    def __init__(self, descriptor, name):
        self.descriptor = descriptor
        self.name = name

    def hasChromeOnly(self):
        return len(self.chrome) > 0

    def hasNonChromeOnly(self):
        return len(self.regular) > 0

    def variableName(self, chrome):
        if chrome:
            if self.hasChromeOnly():
                return "sChrome" + self.name
        else:
            if self.hasNonChromeOnly():
                return "s" + self.name
        return "nullptr"

    def usedForXrays(self):
        return self.descriptor.wantsXrays

    def length(self, chrome):
        return len(self.chrome) if chrome else len(self.regular)

    def __str__(self):
        # We only need to generate id arrays for things that will end
        # up used via ResolveProperty or EnumerateProperties.
        str = self.generateArray(self.regular, self.variableName(False))
        if self.hasChromeOnly():
            str += self.generateArray(self.chrome, self.variableName(True))
        return str

    @staticmethod
    def getStringAttr(member, name):
        attr = member.getExtendedAttribute(name)
        if attr is None:
            return None
        # It's a list of strings
        assert len(attr) == 1
        assert attr[0] is not None
        return attr[0]

    @staticmethod
    def getControllingCondition(interfaceMember, descriptor):
        interface = descriptor.interface
        nonExposureSet = interface.exposureSet - interfaceMember.exposureSet

        trial = PropertyDefiner.getStringAttr(interfaceMember, "Trial")
        if trial and interface.identifier.name in ["Window", "Document"]:
            raise TypeError(
                "[Trial] not yet supported for %s.%s, see bug 1757935"
                % (interface.identifier.name, interfaceMember.identifier.name)
            )

        return MemberCondition(
            PropertyDefiner.getStringAttr(interfaceMember, "Pref"),
            PropertyDefiner.getStringAttr(interfaceMember, "Func"),
            interfaceMember.getExtendedAttribute("SecureContext") is not None,
            nonExposureSet,
            trial,
        )

    @staticmethod
    def generatePrefableArrayValues(
        array,
        descriptor,
        specFormatter,
        specTerminator,
        getCondition,
        getDataTuple,
        switchToCondition=None,
    ):
        """
        This method generates an array of spec entries for interface members. It returns
          a tuple containing the array of spec entries and the maximum of the number of
          spec entries per condition.

        array is an array of interface members.

        descriptor is the descriptor for the interface that array contains members of.

        specFormatter is a function that takes a single argument, a tuple,
          and returns a string, a spec array entry.

        specTerminator is a terminator for the spec array (inserted every time
          our controlling pref changes and at the end of the array).

        getCondition is a callback function that takes an array entry and
          returns the corresponding MemberCondition.

        getDataTuple is a callback function that takes an array entry and
          returns a tuple suitable to be passed to specFormatter.

        switchToCondition is a function that takes a MemberCondition and an array of
          previously generated spec entries. If None is passed for this function then all
          the interface members should return the same value from getCondition.
        """

        def unsupportedSwitchToCondition(condition, specs):
            # If no specs have been added yet then this is just the first call to
            # switchToCondition that we call to avoid putting a specTerminator at the
            # front of the list.
            if len(specs) == 0:
                return
            raise "Not supported"

        if switchToCondition is None:
            switchToCondition = unsupportedSwitchToCondition

        specs = []
        numSpecsInCurPrefable = 0
        maxNumSpecsInPrefable = 0

        # So we won't put a specTerminator at the very front of the list:
        lastCondition = getCondition(array[0], descriptor)

        switchToCondition(lastCondition, specs)

        for member in array:
            curCondition = getCondition(member, descriptor)
            if lastCondition != curCondition:
                # Terminate previous list
                specs.append(specTerminator)
                if numSpecsInCurPrefable > maxNumSpecsInPrefable:
                    maxNumSpecsInPrefable = numSpecsInCurPrefable
                numSpecsInCurPrefable = 0
                # And switch to our new condition
                switchToCondition(curCondition, specs)
                lastCondition = curCondition
            # And the actual spec
            specs.append(specFormatter(getDataTuple(member, descriptor)))
            numSpecsInCurPrefable += 1
        if numSpecsInCurPrefable > maxNumSpecsInPrefable:
            maxNumSpecsInPrefable = numSpecsInCurPrefable
        specs.append(specTerminator)

        return (specs, maxNumSpecsInPrefable)

    def generatePrefableArray(
        self,
        array,
        name,
        specFormatter,
        specTerminator,
        specType,
        getCondition,
        getDataTuple,
    ):
        """
        This method generates our various arrays.

        array is an array of interface members as passed to generateArray

        name is the name as passed to generateArray

        specFormatter is a function that takes a single argument, a tuple,
          and returns a string, a spec array entry

        specTerminator is a terminator for the spec array (inserted every time
          our controlling pref changes and at the end of the array)

        specType is the actual typename of our spec

        getCondition is a callback function that takes an array entry and
          returns the corresponding MemberCondition.

        getDataTuple is a callback function that takes an array entry and
          returns a tuple suitable to be passed to specFormatter.
        """

        # We want to generate a single list of specs, but with specTerminator
        # inserted at every point where the pref name controlling the member
        # changes.  That will make sure the order of the properties as exposed
        # on the interface and interface prototype objects does not change when
        # pref control is added to members while still allowing us to define all
        # the members in the smallest number of JSAPI calls.
        assert len(array) != 0

        disablers = []
        prefableSpecs = []

        disablersTemplate = dedent(
            """
            static const PrefableDisablers %s_disablers%d = {
              %s, %s, %s, %s, %s
            };
            """
        )
        prefableWithDisablersTemplate = "  { &%s_disablers%d, &%s_specs[%d] }"
        prefableWithoutDisablersTemplate = "  { nullptr, &%s_specs[%d] }"

        def switchToCondition(condition, specs):
            # Set up pointers to the new sets of specs inside prefableSpecs
            if condition.hasDisablers():
                prefableSpecs.append(
                    prefableWithDisablersTemplate % (name, len(specs), name, len(specs))
                )
                disablers.append(
                    disablersTemplate
                    % (
                        name,
                        len(specs),
                        condition.prefFuncIndex,
                        condition.nonExposedGlobals,
                        toStringBool(condition.secureContext),
                        condition.trial,
                        condition.func,
                    )
                )
            else:
                prefableSpecs.append(
                    prefableWithoutDisablersTemplate % (name, len(specs))
                )

        specs, maxNumSpecsInPrefable = self.generatePrefableArrayValues(
            array,
            self.descriptor,
            specFormatter,
            specTerminator,
            getCondition,
            getDataTuple,
            switchToCondition,
        )
        prefableSpecs.append("  { nullptr, nullptr }")

        specType = "const " + specType
        arrays = fill(
            """
            static ${specType} ${name}_specs[] = {
            ${specs}
            };

            ${disablers}
            static const Prefable<${specType}> ${name}[] = {
            ${prefableSpecs}
            };

            """,
            specType=specType,
            name=name,
            disablers="\n".join(disablers),
            specs=",\n".join(specs),
            prefableSpecs=",\n".join(prefableSpecs),
        )

        if self.usedForXrays():
            arrays = fill(
                """
                $*{arrays}
                static_assert(${numPrefableSpecs} <= 1ull << NUM_BITS_PROPERTY_INFO_PREF_INDEX,
                    "We have a prefable index that is >= (1 << NUM_BITS_PROPERTY_INFO_PREF_INDEX)");
                static_assert(${maxNumSpecsInPrefable} <= 1ull << NUM_BITS_PROPERTY_INFO_SPEC_INDEX,
                    "We have a spec index that is >= (1 << NUM_BITS_PROPERTY_INFO_SPEC_INDEX)");

                """,
                arrays=arrays,
                # Minus 1 because there's a list terminator in prefableSpecs.
                numPrefableSpecs=len(prefableSpecs) - 1,
                maxNumSpecsInPrefable=maxNumSpecsInPrefable,
            )

        return arrays


# The length of a method is the minimum of the lengths of the
# argument lists of all its overloads.
def overloadLength(arguments):
    i = len(arguments)
    while i > 0 and arguments[i - 1].optional:
        i -= 1
    return i


def methodLength(method):
    signatures = method.signatures()
    return min(overloadLength(arguments) for retType, arguments in signatures)


def clearableCachedAttrs(descriptor):
    return (
        m
        for m in descriptor.interface.members
        if m.isAttr() and
        # Constants should never need clearing!
        m.dependsOn != "Nothing" and m.slotIndices is not None
    )


def MakeClearCachedValueNativeName(member):
    return "ClearCached%sValue" % MakeNativeName(member.identifier.name)


def IDLToCIdentifier(name):
    return name.replace("-", "_")


def EnumerabilityFlags(member):
    if member.getExtendedAttribute("NonEnumerable"):
        return "0"
    return "JSPROP_ENUMERATE"


class MethodDefiner(PropertyDefiner):
    """
    A class for defining methods on a prototype object.
    """

    def __init__(self, descriptor, name, crossOriginOnly, static, unforgeable=False):
        assert not (static and unforgeable)
        PropertyDefiner.__init__(self, descriptor, name)

        # FIXME https://bugzilla.mozilla.org/show_bug.cgi?id=772822
        #       We should be able to check for special operations without an
        #       identifier. For now we check if the name starts with __

        # Ignore non-static methods for interfaces without a proto object
        if descriptor.interface.hasInterfacePrototypeObject() or static:
            methods = [
                m
                for m in descriptor.interface.members
                if m.isMethod()
                and m.isStatic() == static
                and MemberIsLegacyUnforgeable(m, descriptor) == unforgeable
                and (
                    not crossOriginOnly or m.getExtendedAttribute("CrossOriginCallable")
                )
                and not m.isIdentifierLess()
                and not m.getExtendedAttribute("Unexposed")
            ]
        else:
            methods = []
        self.chrome = []
        self.regular = []
        for m in methods:
            method = self.methodData(m, descriptor)

            if m.isStatic():
                method["nativeName"] = CppKeywords.checkMethodName(
                    IDLToCIdentifier(m.identifier.name)
                )

            if isChromeOnly(m):
                self.chrome.append(method)
            else:
                self.regular.append(method)

        # TODO: Once iterable is implemented, use tiebreak rules instead of
        # failing. Also, may be more tiebreak rules to implement once spec bug
        # is resolved.
        # https://www.w3.org/Bugs/Public/show_bug.cgi?id=28592
        def hasIterator(methods, regular):
            return any("@@iterator" in m.aliases for m in methods) or any(
                "@@iterator" == r["name"] for r in regular
            )

        # Check whether we need to output an @@iterator due to having an indexed
        # getter.  We only do this while outputting non-static and
        # non-unforgeable methods, since the @@iterator function will be
        # neither.
        if not static and not unforgeable and descriptor.supportsIndexedProperties():
            if hasIterator(methods, self.regular):
                raise TypeError(
                    "Cannot have indexed getter/attr on "
                    "interface %s with other members "
                    "that generate @@iterator, such as "
                    "maplike/setlike or aliased functions."
                    % self.descriptor.interface.identifier.name
                )
            self.regular.append(
                {
                    "name": "@@iterator",
                    "methodInfo": False,
                    "selfHostedName": "$ArrayValues",
                    "length": 0,
                    "flags": "0",  # Not enumerable, per spec.
                    "condition": MemberCondition(),
                }
            )

        # Generate the keys/values/entries aliases for value iterables.
        maplikeOrSetlikeOrIterable = descriptor.interface.maplikeOrSetlikeOrIterable
        if (
            not static
            and not unforgeable
            and maplikeOrSetlikeOrIterable
            and maplikeOrSetlikeOrIterable.isIterable()
            and maplikeOrSetlikeOrIterable.isValueIterator()
        ):
            # Add our keys/values/entries/forEach
            self.regular.append(
                {
                    "name": "keys",
                    "methodInfo": False,
                    "selfHostedName": "ArrayKeys",
                    "length": 0,
                    "flags": "JSPROP_ENUMERATE",
                    "condition": PropertyDefiner.getControllingCondition(
                        maplikeOrSetlikeOrIterable, descriptor
                    ),
                }
            )
            self.regular.append(
                {
                    "name": "values",
                    "methodInfo": False,
                    "selfHostedName": "$ArrayValues",
                    "length": 0,
                    "flags": "JSPROP_ENUMERATE",
                    "condition": PropertyDefiner.getControllingCondition(
                        maplikeOrSetlikeOrIterable, descriptor
                    ),
                }
            )
            self.regular.append(
                {
                    "name": "entries",
                    "methodInfo": False,
                    "selfHostedName": "ArrayEntries",
                    "length": 0,
                    "flags": "JSPROP_ENUMERATE",
                    "condition": PropertyDefiner.getControllingCondition(
                        maplikeOrSetlikeOrIterable, descriptor
                    ),
                }
            )
            self.regular.append(
                {
                    "name": "forEach",
                    "methodInfo": False,
                    "selfHostedName": "ArrayForEach",
                    "length": 1,
                    "flags": "JSPROP_ENUMERATE",
                    "condition": PropertyDefiner.getControllingCondition(
                        maplikeOrSetlikeOrIterable, descriptor
                    ),
                }
            )

        if not static:
            stringifier = descriptor.operations["Stringifier"]
            if stringifier and unforgeable == MemberIsLegacyUnforgeable(
                stringifier, descriptor
            ):
                toStringDesc = {
                    "name": GetWebExposedName(stringifier, descriptor),
                    "nativeName": stringifier.identifier.name,
                    "length": 0,
                    "flags": "JSPROP_ENUMERATE",
                    "condition": PropertyDefiner.getControllingCondition(
                        stringifier, descriptor
                    ),
                }
                if isChromeOnly(stringifier):
                    self.chrome.append(toStringDesc)
                else:
                    self.regular.append(toStringDesc)
            if unforgeable and descriptor.interface.getExtendedAttribute(
                "LegacyUnforgeable"
            ):
                # Synthesize our valueOf method
                self.regular.append(
                    {
                        "name": "valueOf",
                        "selfHostedName": "Object_valueOf",
                        "methodInfo": False,
                        "length": 0,
                        "flags": "0",  # readonly/permanent added automatically.
                        "condition": MemberCondition(),
                    }
                )

        if descriptor.interface.isJSImplemented():
            if static:
                if descriptor.interface.hasInterfaceObject():
                    self.chrome.append(
                        {
                            "name": "_create",
                            "nativeName": ("%s::_Create" % descriptor.name),
                            "methodInfo": False,
                            "length": 2,
                            "flags": "0",
                            "condition": MemberCondition(),
                        }
                    )

        self.unforgeable = unforgeable

        if static:
            if not descriptor.interface.hasInterfaceObject():
                # static methods go on the interface object
                assert not self.hasChromeOnly() and not self.hasNonChromeOnly()
        else:
            if not descriptor.interface.hasInterfacePrototypeObject():
                # non-static methods go on the interface prototype object
                assert not self.hasChromeOnly() and not self.hasNonChromeOnly()

    @staticmethod
    def methodData(m, descriptor, overrideFlags=None):
        return {
            "name": m.identifier.name,
            "methodInfo": not m.isStatic(),
            "length": methodLength(m),
            "flags": EnumerabilityFlags(m)
            if (overrideFlags is None)
            else overrideFlags,
            "condition": PropertyDefiner.getControllingCondition(m, descriptor),
            "allowCrossOriginThis": m.getExtendedAttribute("CrossOriginCallable"),
            "returnsPromise": m.returnsPromise(),
            "hasIteratorAlias": "@@iterator" in m.aliases,
        }

    @staticmethod
    def formatSpec(fields):
        if fields[0].startswith("@@"):
            fields = (fields[0][2:],) + fields[1:]
            return "  JS_SYM_FNSPEC(%s, %s, %s, %s, %s, %s)" % fields
        return '  JS_FNSPEC("%s", %s, %s, %s, %s, %s)' % fields

    @staticmethod
    def specData(m, descriptor, unforgeable=False):
        def flags(m, unforgeable):
            unforgeable = " | JSPROP_PERMANENT | JSPROP_READONLY" if unforgeable else ""
            return m["flags"] + unforgeable

        if "selfHostedName" in m:
            selfHostedName = '"%s"' % m["selfHostedName"]
            assert not m.get("methodInfo", True)
            accessor = "nullptr"
            jitinfo = "nullptr"
        else:
            selfHostedName = "nullptr"
            # When defining symbols, function name may not match symbol name
            methodName = m.get("methodName", m["name"])
            accessor = m.get("nativeName", IDLToCIdentifier(methodName))
            if m.get("methodInfo", True):
                if m.get("returnsPromise", False):
                    exceptionPolicy = "ConvertExceptionsToPromises"
                else:
                    exceptionPolicy = "ThrowExceptions"

                # Cast this in case the methodInfo is a
                # JSTypedMethodJitInfo.
                jitinfo = (
                    "reinterpret_cast<const JSJitInfo*>(&%s_methodinfo)" % accessor
                )
                if m.get("allowCrossOriginThis", False):
                    accessor = (
                        "(GenericMethod<CrossOriginThisPolicy, %s>)" % exceptionPolicy
                    )
                elif descriptor.interface.hasDescendantWithCrossOriginMembers:
                    accessor = (
                        "(GenericMethod<MaybeCrossOriginObjectThisPolicy, %s>)"
                        % exceptionPolicy
                    )
                elif descriptor.interface.isOnGlobalProtoChain():
                    accessor = (
                        "(GenericMethod<MaybeGlobalThisPolicy, %s>)" % exceptionPolicy
                    )
                else:
                    accessor = "(GenericMethod<NormalThisPolicy, %s>)" % exceptionPolicy
            else:
                if m.get("returnsPromise", False):
                    jitinfo = "&%s_methodinfo" % accessor
                    accessor = "StaticMethodPromiseWrapper"
                else:
                    jitinfo = "nullptr"

        return (
            m["name"],
            accessor,
            jitinfo,
            m["length"],
            flags(m, unforgeable),
            selfHostedName,
        )

    @staticmethod
    def condition(m, d):
        return m["condition"]

    def generateArray(self, array, name):
        if len(array) == 0:
            return ""

        return self.generatePrefableArray(
            array,
            name,
            self.formatSpec,
            "  JS_FS_END",
            "JSFunctionSpec",
            self.condition,
            functools.partial(self.specData, unforgeable=self.unforgeable),
        )


class AttrDefiner(PropertyDefiner):
    def __init__(self, descriptor, name, crossOriginOnly, static, unforgeable=False):
        assert not (static and unforgeable)
        PropertyDefiner.__init__(self, descriptor, name)
        self.name = name
        # Ignore non-static attributes for interfaces without a proto object
        if descriptor.interface.hasInterfacePrototypeObject() or static:
            idlAttrs = [
                m
                for m in descriptor.interface.members
                if m.isAttr()
                and m.isStatic() == static
                and MemberIsLegacyUnforgeable(m, descriptor) == unforgeable
                and (
                    not crossOriginOnly
                    or m.getExtendedAttribute("CrossOriginReadable")
                    or m.getExtendedAttribute("CrossOriginWritable")
                )
            ]
        else:
            idlAttrs = []

        attributes = []
        for attr in idlAttrs:
            attributes.extend(self.attrData(attr, unforgeable))
        self.chrome = [m for m in attributes if isChromeOnly(m["attr"])]
        self.regular = [m for m in attributes if not isChromeOnly(m["attr"])]
        self.static = static

        if static:
            if not descriptor.interface.hasInterfaceObject():
                # static attributes go on the interface object
                assert not self.hasChromeOnly() and not self.hasNonChromeOnly()
        else:
            if not descriptor.interface.hasInterfacePrototypeObject():
                # non-static attributes go on the interface prototype object
                assert not self.hasChromeOnly() and not self.hasNonChromeOnly()

    @staticmethod
    def attrData(attr, unforgeable=False, overrideFlags=None):
        if overrideFlags is None:
            permanent = " | JSPROP_PERMANENT" if unforgeable else ""
            flags = EnumerabilityFlags(attr) + permanent
        else:
            flags = overrideFlags
        return (
            {"name": name, "attr": attr, "flags": flags}
            for name in [attr.identifier.name] + attr.bindingAliases
        )

    @staticmethod
    def condition(m, d):
        return PropertyDefiner.getControllingCondition(m["attr"], d)

    @staticmethod
    def specData(entry, descriptor, static=False, crossOriginOnly=False):
        def getter(attr):
            if crossOriginOnly and not attr.getExtendedAttribute("CrossOriginReadable"):
                return "nullptr, nullptr"
            if static:
                if attr.type.isPromise():
                    raise TypeError(
                        "Don't know how to handle "
                        "static Promise-returning "
                        "attribute %s.%s" % (descriptor.name, attr.identifier.name)
                    )
                accessor = "get_" + IDLToCIdentifier(attr.identifier.name)
                jitinfo = "nullptr"
            else:
                if attr.type.isPromise():
                    exceptionPolicy = "ConvertExceptionsToPromises"
                else:
                    exceptionPolicy = "ThrowExceptions"

                if attr.hasLegacyLenientThis():
                    if attr.getExtendedAttribute("CrossOriginReadable"):
                        raise TypeError(
                            "Can't handle lenient cross-origin "
                            "readable attribute %s.%s"
                            % (descriptor.name, attr.identifier.name)
                        )
                    if descriptor.interface.hasDescendantWithCrossOriginMembers:
                        accessor = (
                            "GenericGetter<MaybeCrossOriginObjectLenientThisPolicy, %s>"
                            % exceptionPolicy
                        )
                    else:
                        accessor = (
                            "GenericGetter<LenientThisPolicy, %s>" % exceptionPolicy
                        )
                elif attr.getExtendedAttribute("CrossOriginReadable"):
                    accessor = (
                        "GenericGetter<CrossOriginThisPolicy, %s>" % exceptionPolicy
                    )
                elif descriptor.interface.hasDescendantWithCrossOriginMembers:
                    accessor = (
                        "GenericGetter<MaybeCrossOriginObjectThisPolicy, %s>"
                        % exceptionPolicy
                    )
                elif descriptor.interface.isOnGlobalProtoChain():
                    accessor = (
                        "GenericGetter<MaybeGlobalThisPolicy, %s>" % exceptionPolicy
                    )
                else:
                    accessor = "GenericGetter<NormalThisPolicy, %s>" % exceptionPolicy
                jitinfo = "&%s_getterinfo" % IDLToCIdentifier(attr.identifier.name)
            return "%s, %s" % (accessor, jitinfo)

        def setter(attr):
            if (
                attr.readonly
                and attr.getExtendedAttribute("PutForwards") is None
                and attr.getExtendedAttribute("Replaceable") is None
                and attr.getExtendedAttribute("LegacyLenientSetter") is None
            ):
                return "nullptr, nullptr"
            if crossOriginOnly and not attr.getExtendedAttribute("CrossOriginWritable"):
                return "nullptr, nullptr"
            if static:
                accessor = "set_" + IDLToCIdentifier(attr.identifier.name)
                jitinfo = "nullptr"
            else:
                if attr.hasLegacyLenientThis():
                    if attr.getExtendedAttribute("CrossOriginWritable"):
                        raise TypeError(
                            "Can't handle lenient cross-origin "
                            "writable attribute %s.%s"
                            % (descriptor.name, attr.identifier.name)
                        )
                    if descriptor.interface.hasDescendantWithCrossOriginMembers:
                        accessor = (
                            "GenericSetter<MaybeCrossOriginObjectLenientThisPolicy>"
                        )
                    else:
                        accessor = "GenericSetter<LenientThisPolicy>"
                elif attr.getExtendedAttribute("CrossOriginWritable"):
                    accessor = "GenericSetter<CrossOriginThisPolicy>"
                elif descriptor.interface.hasDescendantWithCrossOriginMembers:
                    accessor = "GenericSetter<MaybeCrossOriginObjectThisPolicy>"
                elif descriptor.interface.isOnGlobalProtoChain():
                    accessor = "GenericSetter<MaybeGlobalThisPolicy>"
                else:
                    accessor = "GenericSetter<NormalThisPolicy>"
                jitinfo = "&%s_setterinfo" % IDLToCIdentifier(attr.identifier.name)
            return "%s, %s" % (accessor, jitinfo)

        name, attr, flags = entry["name"], entry["attr"], entry["flags"]
        return (name, flags, getter(attr), setter(attr))

    @staticmethod
    def formatSpec(fields):
        return '  JSPropertySpec::nativeAccessors("%s", %s, %s, %s)' % fields

    def generateArray(self, array, name):
        if len(array) == 0:
            return ""

        return self.generatePrefableArray(
            array,
            name,
            self.formatSpec,
            "  JS_PS_END",
            "JSPropertySpec",
            self.condition,
            functools.partial(self.specData, static=self.static),
        )


class ConstDefiner(PropertyDefiner):
    """
    A class for definining constants on the interface object
    """

    def __init__(self, descriptor, name):
        PropertyDefiner.__init__(self, descriptor, name)
        self.name = name
        constants = [m for m in descriptor.interface.members if m.isConst()]
        self.chrome = [m for m in constants if isChromeOnly(m)]
        self.regular = [m for m in constants if not isChromeOnly(m)]

    def generateArray(self, array, name):
        if len(array) == 0:
            return ""

        def specData(const, descriptor):
            return (const.identifier.name, convertConstIDLValueToJSVal(const.value))

        return self.generatePrefableArray(
            array,
            name,
            lambda fields: '  { "%s", %s }' % fields,
            "  { 0, JS::UndefinedValue() }",
            "ConstantSpec",
            PropertyDefiner.getControllingCondition,
            specData,
        )


class PropertyArrays:
    def __init__(self, descriptor, crossOriginOnly=False):
        self.staticMethods = MethodDefiner(
            descriptor, "StaticMethods", crossOriginOnly, static=True
        )
        self.staticAttrs = AttrDefiner(
            descriptor, "StaticAttributes", crossOriginOnly, static=True
        )
        self.methods = MethodDefiner(
            descriptor, "Methods", crossOriginOnly, static=False
        )
        self.attrs = AttrDefiner(
            descriptor, "Attributes", crossOriginOnly, static=False
        )
        self.unforgeableMethods = MethodDefiner(
            descriptor,
            "UnforgeableMethods",
            crossOriginOnly,
            static=False,
            unforgeable=True,
        )
        self.unforgeableAttrs = AttrDefiner(
            descriptor,
            "UnforgeableAttributes",
            crossOriginOnly,
            static=False,
            unforgeable=True,
        )
        self.consts = ConstDefiner(descriptor, "Constants")

    @staticmethod
    def arrayNames():
        return [
            "staticMethods",
            "staticAttrs",
            "methods",
            "attrs",
            "unforgeableMethods",
            "unforgeableAttrs",
            "consts",
        ]

    def hasChromeOnly(self):
        return any(getattr(self, a).hasChromeOnly() for a in self.arrayNames())

    def hasNonChromeOnly(self):
        return any(getattr(self, a).hasNonChromeOnly() for a in self.arrayNames())

    def __str__(self):
        define = ""
        for array in self.arrayNames():
            define += str(getattr(self, array))
        return define


class CGConstDefinition(CGThing):
    """
    Given a const member of an interface, return the C++ static const definition
    for the member. Should be part of the interface namespace in the header
    file.
    """

    def __init__(self, member):
        assert (
            member.isConst()
            and member.value.type.isPrimitive()
            and not member.value.type.nullable()
        )

        name = CppKeywords.checkMethodName(IDLToCIdentifier(member.identifier.name))
        tag = member.value.type.tag()
        value = member.value.value
        if tag == IDLType.Tags.bool:
            value = toStringBool(member.value.value)
        self.const = "static const %s %s = %s;" % (builtinNames[tag], name, value)

    def declare(self):
        return self.const

    def define(self):
        return ""

    def deps(self):
        return []


class CGNativeProperties(CGList):
    def __init__(self, descriptor, properties):
        def generateNativeProperties(name, chrome):
            def check(p):
                return p.hasChromeOnly() if chrome else p.hasNonChromeOnly()

            nativePropsInts = []
            nativePropsPtrs = []
            nativePropsDuos = []

            duosOffset = 0
            idsOffset = 0
            for array in properties.arrayNames():
                propertyArray = getattr(properties, array)
                if check(propertyArray):
                    varName = propertyArray.variableName(chrome)
                    bitfields = "true,  %d /* %s */" % (duosOffset, varName)
                    duosOffset += 1
                    nativePropsInts.append(CGGeneric(bitfields))

                    if propertyArray.usedForXrays():
                        ids = "&%s_propertyInfos[%d]" % (name, idsOffset)
                        idsOffset += propertyArray.length(chrome)
                    else:
                        ids = "nullptr"
                    duo = "{ %s, %s }" % (varName, ids)
                    nativePropsDuos.append(CGGeneric(duo))
                else:
                    bitfields = "false, 0"
                    nativePropsInts.append(CGGeneric(bitfields))

            iteratorAliasIndex = -1
            for index, item in enumerate(properties.methods.regular):
                if item.get("hasIteratorAlias"):
                    iteratorAliasIndex = index
                    break
            nativePropsInts.append(CGGeneric(str(iteratorAliasIndex)))

            nativePropsDuos = [
                CGWrapper(
                    CGIndenter(CGList(nativePropsDuos, ",\n")), pre="{\n", post="\n}"
                )
            ]

            pre = "static const NativePropertiesN<%d> %s = {\n" % (duosOffset, name)
            post = "\n};\n"
            if descriptor.wantsXrays:
                pre = fill(
                    """
                    static uint16_t ${name}_sortedPropertyIndices[${size}];
                    static PropertyInfo ${name}_propertyInfos[${size}];

                    $*{pre}
                    """,
                    name=name,
                    size=idsOffset,
                    pre=pre,
                )
                if iteratorAliasIndex > 0:
                    # The iteratorAliasMethodIndex is a signed integer, so the
                    # max value it can store is 2^(nbits-1)-1.
                    post = fill(
                        """
                        $*{post}
                        static_assert(${iteratorAliasIndex} < 1ull << (CHAR_BIT * sizeof(${name}.iteratorAliasMethodIndex) - 1),
                            "We have an iterator alias index that is oversized");
                        """,
                        post=post,
                        iteratorAliasIndex=iteratorAliasIndex,
                        name=name,
                    )
                post = fill(
                    """
                    $*{post}
                    static_assert(${propertyInfoCount} < 1ull << (CHAR_BIT * sizeof(${name}.propertyInfoCount)),
                        "We have a property info count that is oversized");
                    """,
                    post=post,
                    propertyInfoCount=idsOffset,
                    name=name,
                )
                nativePropsInts.append(CGGeneric("%d" % idsOffset))
                nativePropsPtrs.append(CGGeneric("%s_sortedPropertyIndices" % name))
            else:
                nativePropsInts.append(CGGeneric("0"))
                nativePropsPtrs.append(CGGeneric("nullptr"))
            nativeProps = nativePropsInts + nativePropsPtrs + nativePropsDuos
            return CGWrapper(CGIndenter(CGList(nativeProps, ",\n")), pre=pre, post=post)

        nativeProperties = []
        if properties.hasNonChromeOnly():
            nativeProperties.append(
                generateNativeProperties("sNativeProperties", False)
            )
        if properties.hasChromeOnly():
            nativeProperties.append(
                generateNativeProperties("sChromeOnlyNativeProperties", True)
            )

        CGList.__init__(self, nativeProperties, "\n")

    def declare(self):
        return ""

    def define(self):
        return CGList.define(self)


class CGCollectJSONAttributesMethod(CGAbstractMethod):
    """
    Generate the CollectJSONAttributes method for an interface descriptor
    """

    def __init__(self, descriptor, toJSONMethod):
        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "obj"),
            Argument("%s*" % descriptor.nativeType, "self"),
            Argument("JS::Rooted<JSObject*>&", "result"),
        ]
        CGAbstractMethod.__init__(
            self, descriptor, "CollectJSONAttributes", "bool", args, canRunScript=True
        )
        self.toJSONMethod = toJSONMethod

    def definition_body(self):
        ret = ""
        interface = self.descriptor.interface
        toJSONCondition = PropertyDefiner.getControllingCondition(
            self.toJSONMethod, self.descriptor
        )
        needUnwrappedObj = False
        for m in interface.members:
            if m.isAttr() and not m.isStatic() and m.type.isJSONType():
                getAndDefine = fill(
                    """
                    JS::Rooted<JS::Value> temp(cx);
                    if (!get_${name}(cx, obj, self, JSJitGetterCallArgs(&temp))) {
                      return false;
                    }
                    if (!JS_DefineProperty(cx, result, "${name}", temp, JSPROP_ENUMERATE)) {
                      return false;
                    }
                    """,
                    name=IDLToCIdentifier(m.identifier.name),
                )
                # Make sure we don't include things which are supposed to be
                # disabled.  Things that either don't have disablers or whose
                # disablers match the disablers for our toJSON method can't
                # possibly be disabled, but other things might be.
                condition = PropertyDefiner.getControllingCondition(m, self.descriptor)
                if condition.hasDisablers() and condition != toJSONCondition:
                    needUnwrappedObj = True
                    ret += fill(
                        """
                        // This is unfortunately a linear scan through sAttributes, but we
                        // only do it for things which _might_ be disabled, which should
                        // help keep the performance problems down.
                        if (IsGetterEnabled(cx, unwrappedObj, (JSJitGetterOp)get_${name}, sAttributes)) {
                          $*{getAndDefine}
                        }
                        """,
                        name=IDLToCIdentifier(m.identifier.name),
                        getAndDefine=getAndDefine,
                    )
                else:
                    ret += fill(
                        """
                        { // scope for "temp"
                          $*{getAndDefine}
                        }
                        """,
                        getAndDefine=getAndDefine,
                    )
        ret += "return true;\n"

        if needUnwrappedObj:
            # If we started allowing cross-origin objects here, we'd need to
            # use CheckedUnwrapDynamic and figure out whether it makes sense.
            # But in practice no one is trying to add toJSON methods to those,
            # so let's just guard against it.
            assert not self.descriptor.isMaybeCrossOriginObject()
            ret = fill(
                """
                JS::Rooted<JSObject*> unwrappedObj(cx, js::CheckedUnwrapStatic(obj));
                if (!unwrappedObj) {
                  // How did that happen?  We managed to get called with that
                  // object as "this"!  Just give up on sanity.
                  return false;
                }

                $*{ret}
                """,
                ret=ret,
            )

        return ret


class CGCreateInterfaceObjectsMethod(CGAbstractMethod):
    """
    Generate the CreateInterfaceObjects method for an interface descriptor.

    properties should be a PropertyArrays instance.
    """

    def __init__(
        self, descriptor, properties, haveUnscopables, haveLegacyWindowAliases, static
    ):
        args = [
            Argument("JSContext*", "aCx"),
            Argument("JS::Handle<JSObject*>", "aGlobal"),
            Argument("ProtoAndIfaceCache&", "aProtoAndIfaceCache"),
            Argument("bool", "aDefineOnGlobal"),
        ]
        CGAbstractMethod.__init__(
            self, descriptor, "CreateInterfaceObjects", "void", args, static=static
        )
        self.properties = properties
        self.haveUnscopables = haveUnscopables
        self.haveLegacyWindowAliases = haveLegacyWindowAliases

    def definition_body(self):
        (protoGetter, protoHandleGetter) = InterfacePrototypeObjectProtoGetter(
            self.descriptor
        )
        if protoHandleGetter is None:
            parentProtoType = "Rooted"
            getParentProto = "aCx, " + protoGetter
        else:
            parentProtoType = "Handle"
            getParentProto = protoHandleGetter
        getParentProto = getParentProto + "(aCx)"

        (protoGetter, protoHandleGetter) = InterfaceObjectProtoGetter(self.descriptor)
        if protoHandleGetter is None:
            getConstructorProto = "aCx, " + protoGetter
            constructorProtoType = "Rooted"
        else:
            getConstructorProto = protoHandleGetter
            constructorProtoType = "Handle"
        getConstructorProto += "(aCx)"

        needInterfaceObject = self.descriptor.interface.hasInterfaceObject()
        needInterfacePrototypeObject = (
            self.descriptor.interface.hasInterfacePrototypeObject()
        )

        # if we don't need to create anything, why are we generating this?
        assert needInterfaceObject or needInterfacePrototypeObject

        getParentProto = fill(
            """
            JS::${type}<JSObject*> parentProto(${getParentProto});
            if (!parentProto) {
              return;
            }
            """,
            type=parentProtoType,
            getParentProto=getParentProto,
        )

        getConstructorProto = fill(
            """
            JS::${type}<JSObject*> constructorProto(${getConstructorProto});
            if (!constructorProto) {
              return;
            }
            """,
            type=constructorProtoType,
            getConstructorProto=getConstructorProto,
        )

        if self.descriptor.interface.ctor():
            constructArgs = methodLength(self.descriptor.interface.ctor())
            isConstructorChromeOnly = isChromeOnly(self.descriptor.interface.ctor())
        else:
            constructArgs = 0
            isConstructorChromeOnly = False
        if len(self.descriptor.interface.legacyFactoryFunctions) > 0:
            namedConstructors = "namedConstructors"
        else:
            namedConstructors = "nullptr"

        if needInterfacePrototypeObject:
            protoClass = "&sPrototypeClass.mBase"
            protoCache = (
                "&aProtoAndIfaceCache.EntrySlotOrCreate(prototypes::id::%s)"
                % self.descriptor.name
            )
            parentProto = "parentProto"
            getParentProto = CGGeneric(getParentProto)
        else:
            protoClass = "nullptr"
            protoCache = "nullptr"
            parentProto = "nullptr"
            getParentProto = None

        if needInterfaceObject:
            interfaceClass = "&sInterfaceObjectClass.mBase"
            interfaceCache = (
                "&aProtoAndIfaceCache.EntrySlotOrCreate(constructors::id::%s)"
                % self.descriptor.name
            )
            getConstructorProto = CGGeneric(getConstructorProto)
            constructorProto = "constructorProto"
        else:
            # We don't have slots to store the legacy factory functions.
            assert len(self.descriptor.interface.legacyFactoryFunctions) == 0
            interfaceClass = "nullptr"
            interfaceCache = "nullptr"
            getConstructorProto = None
            constructorProto = "nullptr"

        isGlobal = self.descriptor.isGlobal() is not None
        if self.properties.hasNonChromeOnly():
            properties = "sNativeProperties.Upcast()"
        else:
            properties = "nullptr"
        if self.properties.hasChromeOnly():
            chromeProperties = "sChromeOnlyNativeProperties.Upcast()"
        else:
            chromeProperties = "nullptr"

        # We use getClassName here. This should be the right thing to pass as
        # the name argument to CreateInterfaceObjects. This is generally the
        # interface identifier, except for the synthetic interfaces created for
        # the default iterator objects. If needInterfaceObject is true then
        # we'll use the name to install a property on the global object, so
        # there shouldn't be any spaces in the name.
        name = self.descriptor.interface.getClassName()
        assert not (needInterfaceObject and " " in name)

        call = fill(
            """
            JS::Heap<JSObject*>* protoCache = ${protoCache};
            JS::Heap<JSObject*>* interfaceCache = ${interfaceCache};
            dom::CreateInterfaceObjects(aCx, aGlobal, ${parentProto},
                                        ${protoClass}, protoCache,
                                        ${constructorProto}, ${interfaceClass}, ${constructArgs}, ${isConstructorChromeOnly}, ${namedConstructors},
                                        interfaceCache,
                                        ${properties},
                                        ${chromeProperties},
                                        "${name}", aDefineOnGlobal,
                                        ${unscopableNames},
                                        ${isGlobal},
                                        ${legacyWindowAliases},
                                        ${isNamespace});
            """,
            protoClass=protoClass,
            parentProto=parentProto,
            protoCache=protoCache,
            constructorProto=constructorProto,
            interfaceClass=interfaceClass,
            constructArgs=constructArgs,
            isConstructorChromeOnly=toStringBool(isConstructorChromeOnly),
            namedConstructors=namedConstructors,
            interfaceCache=interfaceCache,
            properties=properties,
            chromeProperties=chromeProperties,
            name=name,
            unscopableNames="unscopableNames" if self.haveUnscopables else "nullptr",
            isGlobal=toStringBool(isGlobal),
            legacyWindowAliases="legacyWindowAliases"
            if self.haveLegacyWindowAliases
            else "nullptr",
            isNamespace=toStringBool(self.descriptor.interface.isNamespace()),
        )

        # If we fail after here, we must clear interface and prototype caches
        # using this code: intermediate failure must not expose the interface in
        # partially-constructed state.  Note that every case after here needs an
        # interface prototype object.
        failureCode = dedent(
            """
            *protoCache = nullptr;
            if (interfaceCache) {
              *interfaceCache = nullptr;
            }
            return;
            """
        )

        needProtoVar = False

        aliasedMembers = [
            m for m in self.descriptor.interface.members if m.isMethod() and m.aliases
        ]
        if aliasedMembers:
            assert needInterfacePrototypeObject

            def defineAlias(alias):
                if alias == "@@iterator" or alias == "@@asyncIterator":
                    name = alias[2:]

                    symbolJSID = (
                        "JS::GetWellKnownSymbolKey(aCx, JS::SymbolCode::%s)" % name
                    )
                    prop = "%sId" % name
                    getSymbolJSID = CGGeneric(
                        fill(
                            "JS::Rooted<jsid> ${prop}(aCx, ${symbolJSID});",
                            prop=prop,
                            symbolJSID=symbolJSID,
                        )
                    )
                    defineFn = "JS_DefinePropertyById"
                    enumFlags = "0"  # Not enumerable, per spec.
                elif alias.startswith("@@"):
                    raise TypeError(
                        "Can't handle any well-known Symbol other than @@iterator and @@asyncIterator"
                    )
                else:
                    getSymbolJSID = None
                    defineFn = "JS_DefineProperty"
                    prop = '"%s"' % alias
                    # XXX If we ever create non-enumerable properties that can
                    #     be aliased, we should consider making the aliases
                    #     match the enumerability of the property being aliased.
                    enumFlags = "JSPROP_ENUMERATE"
                return CGList(
                    [
                        getSymbolJSID,
                        CGGeneric(
                            fill(
                                """
                        if (!${defineFn}(aCx, proto, ${prop}, aliasedVal, ${enumFlags})) {
                          $*{failureCode}
                        }
                        """,
                                defineFn=defineFn,
                                prop=prop,
                                enumFlags=enumFlags,
                                failureCode=failureCode,
                            )
                        ),
                    ],
                    "\n",
                )

            def defineAliasesFor(m):
                return CGList(
                    [
                        CGGeneric(
                            fill(
                                """
                        if (!JS_GetProperty(aCx, proto, \"${prop}\", &aliasedVal)) {
                          $*{failureCode}
                        }
                        """,
                                failureCode=failureCode,
                                prop=m.identifier.name,
                            )
                        )
                    ]
                    + [defineAlias(alias) for alias in sorted(m.aliases)]
                )

            defineAliases = CGList(
                [
                    CGGeneric(
                        dedent(
                            """
                    // Set up aliases on the interface prototype object we just created.
                    """
                        )
                    ),
                    CGGeneric("JS::Rooted<JS::Value> aliasedVal(aCx);\n\n"),
                ]
                + [
                    defineAliasesFor(m)
                    for m in sorted(aliasedMembers, key=lambda m: m.identifier.name)
                ]
            )
            needProtoVar = True
        else:
            defineAliases = None

        # Globals handle unforgeables directly in Wrap() instead of
        # via a holder.
        if (
            self.descriptor.hasLegacyUnforgeableMembers
            and not self.descriptor.isGlobal()
        ):
            assert needInterfacePrototypeObject

            # We want to use the same JSClass and prototype as the object we'll
            # end up defining the unforgeable properties on in the end, so that
            # we can use JS_InitializePropertiesFromCompatibleNativeObject to do
            # a fast copy.  In the case of proxies that's null, because the
            # expando object is a vanilla object, but in the case of other DOM
            # objects it's whatever our class is.
            if self.descriptor.proxy:
                holderClass = "nullptr"
                holderProto = "nullptr"
            else:
                holderClass = "sClass.ToJSClass()"
                holderProto = "proto"
                needProtoVar = True
            createUnforgeableHolder = CGGeneric(
                fill(
                    """
                JS::Rooted<JSObject*> unforgeableHolder(
                    aCx, JS_NewObjectWithoutMetadata(aCx, ${holderClass}, ${holderProto}));
                if (!unforgeableHolder) {
                  $*{failureCode}
                }
                """,
                    holderProto=holderProto,
                    holderClass=holderClass,
                    failureCode=failureCode,
                )
            )
            defineUnforgeables = InitUnforgeablePropertiesOnHolder(
                self.descriptor, self.properties, failureCode
            )
            createUnforgeableHolder = CGList(
                [createUnforgeableHolder, defineUnforgeables]
            )

            installUnforgeableHolder = CGGeneric(
                dedent(
                    """
                if (*protoCache) {
                  JS::SetReservedSlot(*protoCache, DOM_INTERFACE_PROTO_SLOTS_BASE,
                                      JS::ObjectValue(*unforgeableHolder));
                }
                """
                )
            )

            unforgeableHolderSetup = CGList(
                [createUnforgeableHolder, installUnforgeableHolder], "\n"
            )
        else:
            unforgeableHolderSetup = None

        # FIXME Unclear whether this is needed for hasOrdinaryObjectPrototype
        if (
            self.descriptor.interface.isOnGlobalProtoChain()
            and needInterfacePrototypeObject
            and not self.descriptor.hasOrdinaryObjectPrototype
        ):
            makeProtoPrototypeImmutable = CGGeneric(
                fill(
                    """
                {
                  bool succeeded;
                  if (!JS_SetImmutablePrototype(aCx, proto, &succeeded)) {
                    $*{failureCode}
                  }

                  MOZ_ASSERT(succeeded,
                             "making a fresh prototype object's [[Prototype]] "
                             "immutable can internally fail, but it should "
                             "never be unsuccessful");
                }
                """,
                    protoCache=protoCache,
                    failureCode=failureCode,
                )
            )
            needProtoVar = True
        else:
            makeProtoPrototypeImmutable = None

        if needProtoVar:
            defineProtoVar = CGGeneric(
                fill(
                    """
                JS::AssertObjectIsNotGray(*protoCache);
                JS::Handle<JSObject*> proto = JS::Handle<JSObject*>::fromMarkedLocation(protoCache->address());
                if (!proto) {
                  $*{failureCode}
                }
                """,
                    failureCode=failureCode,
                )
            )
        else:
            defineProtoVar = None
        return CGList(
            [
                getParentProto,
                getConstructorProto,
                CGGeneric(call),
                defineProtoVar,
                defineAliases,
                unforgeableHolderSetup,
                makeProtoPrototypeImmutable,
            ],
            "\n",
        ).define()


class CGGetProtoObjectHandleMethod(CGAbstractMethod):
    """
    A method for getting the interface prototype object.
    """

    def __init__(self, descriptor, static, signatureOnly=False):
        CGAbstractMethod.__init__(
            self,
            descriptor,
            "GetProtoObjectHandle",
            "JS::Handle<JSObject*>",
            [Argument("JSContext*", "aCx")],
            inline=True,
            static=static,
            signatureOnly=signatureOnly,
        )

    def definition_body(self):
        return fill(
            """
            /* Get the interface prototype object for this class.  This will create the
               object as needed. */
            return GetPerInterfaceObjectHandle(aCx, prototypes::id::${name},
                                               &CreateInterfaceObjects,
                                               /* aDefineOnGlobal = */ true);

            """,
            name=self.descriptor.name,
        )


class CGGetProtoObjectMethod(CGAbstractMethod):
    """
    A method for getting the interface prototype object.
    """

    def __init__(self, descriptor):
        CGAbstractMethod.__init__(
            self,
            descriptor,
            "GetProtoObject",
            "JSObject*",
            [Argument("JSContext*", "aCx")],
        )

    def definition_body(self):
        return "return GetProtoObjectHandle(aCx);\n"


class CGGetConstructorObjectHandleMethod(CGAbstractMethod):
    """
    A method for getting the interface constructor object.
    """

    def __init__(self, descriptor):
        CGAbstractMethod.__init__(
            self,
            descriptor,
            "GetConstructorObjectHandle",
            "JS::Handle<JSObject*>",
            [
                Argument("JSContext*", "aCx"),
                Argument("bool", "aDefineOnGlobal", "true"),
            ],
            inline=True,
        )

    def definition_body(self):
        return fill(
            """
            /* Get the interface object for this class.  This will create the object as
               needed. */

            return GetPerInterfaceObjectHandle(aCx, constructors::id::${name},
                                               &CreateInterfaceObjects,
                                               aDefineOnGlobal);
            """,
            name=self.descriptor.name,
        )


class CGGetConstructorObjectMethod(CGAbstractMethod):
    """
    A method for getting the interface constructor object.
    """

    def __init__(self, descriptor):
        CGAbstractMethod.__init__(
            self,
            descriptor,
            "GetConstructorObject",
            "JSObject*",
            [Argument("JSContext*", "aCx")],
        )

    def definition_body(self):
        return "return GetConstructorObjectHandle(aCx);\n"


class CGGetNamedPropertiesObjectMethod(CGAbstractStaticMethod):
    def __init__(self, descriptor):
        args = [Argument("JSContext*", "aCx")]
        CGAbstractStaticMethod.__init__(
            self, descriptor, "GetNamedPropertiesObject", "JSObject*", args
        )

    def definition_body(self):
        parentProtoName = self.descriptor.parentPrototypeName
        if parentProtoName is None:
            getParentProto = ""
            parentProto = "nullptr"
        else:
            getParentProto = fill(
                """
                JS::Rooted<JSObject*> parentProto(aCx, ${parent}::GetProtoObjectHandle(aCx));
                if (!parentProto) {
                  return nullptr;
                }
                """,
                parent=toBindingNamespace(parentProtoName),
            )
            parentProto = "parentProto"
        return fill(
            """
            /* Make sure our global is sane.  Hopefully we can remove this sometime */
            JSObject* global = JS::CurrentGlobalOrNull(aCx);
            if (!(JS::GetClass(global)->flags & JSCLASS_DOM_GLOBAL)) {
              return nullptr;
            }

            /* Check to see whether the named properties object has already been created */
            ProtoAndIfaceCache& protoAndIfaceCache = *GetProtoAndIfaceCache(global);

            JS::Heap<JSObject*>& namedPropertiesObject = protoAndIfaceCache.EntrySlotOrCreate(namedpropertiesobjects::id::${ifaceName});
            if (!namedPropertiesObject) {
              $*{getParentProto}
              namedPropertiesObject = ${nativeType}::CreateNamedPropertiesObject(aCx, ${parentProto});
              DebugOnly<const DOMIfaceAndProtoJSClass*> clasp =
                DOMIfaceAndProtoJSClass::FromJSClass(JS::GetClass(namedPropertiesObject));
              MOZ_ASSERT(clasp->mType == eNamedPropertiesObject,
                         "Expected ${nativeType}::CreateNamedPropertiesObject to return a named properties object");
              MOZ_ASSERT(clasp->mNativeHooks,
                         "The named properties object for ${nativeType} should have NativePropertyHooks.");
              MOZ_ASSERT(!clasp->mNativeHooks->mResolveOwnProperty,
                         "Shouldn't resolve the properties of the named properties object for ${nativeType} for Xrays.");
              MOZ_ASSERT(!clasp->mNativeHooks->mEnumerateOwnProperties,
                         "Shouldn't enumerate the properties of the named properties object for ${nativeType} for Xrays.");
            }
            return namedPropertiesObject.get();
            """,
            getParentProto=getParentProto,
            ifaceName=self.descriptor.name,
            parentProto=parentProto,
            nativeType=self.descriptor.nativeType,
        )


def getRawConditionList(idlobj, cxName, objName, ignoreSecureContext=False):
    """
    Get the list of conditions for idlobj (to be used in "is this enabled"
    checks).  This will be returned as a CGList with " &&\n" as the separator,
    for readability.

    objName is the name of the object that we're working with, because some of
    our test functions want that.

    ignoreSecureContext is used only for constructors in which the WebIDL interface
    itself is already marked as [SecureContext]. There is no need to do the work twice.
    """
    conditions = []
    pref = idlobj.getExtendedAttribute("Pref")
    if pref:
        assert isinstance(pref, list) and len(pref) == 1
        conditions.append("StaticPrefs::%s()" % prefIdentifier(pref[0]))
    if isChromeOnly(idlobj):
        conditions.append("nsContentUtils::ThreadsafeIsSystemCaller(%s)" % cxName)
    func = idlobj.getExtendedAttribute("Func")
    if func:
        assert isinstance(func, list) and len(func) == 1
        conditions.append("%s(%s, %s)" % (func[0], cxName, objName))
    trial = idlobj.getExtendedAttribute("Trial")
    if trial:
        assert isinstance(trial, list) and len(trial) == 1
        conditions.append(
            "OriginTrials::IsEnabled(%s, %s, OriginTrial::%s)"
            % (cxName, objName, trial[0])
        )
    if not ignoreSecureContext and idlobj.getExtendedAttribute("SecureContext"):
        conditions.append(
            "mozilla::dom::IsSecureContextOrObjectIsFromSecureContext(%s, %s)"
            % (cxName, objName)
        )
    return conditions


def getConditionList(idlobj, cxName, objName, ignoreSecureContext=False):
    """
    Get the list of conditions from getRawConditionList
    See comment on getRawConditionList above for more info about arguments.

    The return value is a possibly-empty conjunctive CGList of conditions.
    """
    conditions = getRawConditionList(idlobj, cxName, objName, ignoreSecureContext)
    return CGList((CGGeneric(cond) for cond in conditions), " &&\n")


class CGConstructorEnabled(CGAbstractMethod):
    """
    A method for testing whether we should be exposing this interface object.
    This can perform various tests depending on what conditions are specified
    on the interface.
    """

    def __init__(self, descriptor):
        CGAbstractMethod.__init__(
            self,
            descriptor,
            "ConstructorEnabled",
            "bool",
            [Argument("JSContext*", "aCx"), Argument("JS::Handle<JSObject*>", "aObj")],
        )

    def definition_body(self):
        body = CGList([], "\n")

        iface = self.descriptor.interface

        if not iface.isExposedInWindow():
            exposedInWindowCheck = dedent(
                """
                MOZ_ASSERT(!NS_IsMainThread(), "Why did we even get called?");
                """
            )
            body.append(CGGeneric(exposedInWindowCheck))

        if iface.isExposedInSomeButNotAllWorkers():
            workerGlobals = sorted(iface.getWorkerExposureSet())
            workerCondition = CGList(
                (
                    CGGeneric('strcmp(name, "%s")' % workerGlobal)
                    for workerGlobal in workerGlobals
                ),
                " && ",
            )
            exposedInWorkerCheck = fill(
                """
                const char* name = JS::GetClass(aObj)->name;
                if (${workerCondition}) {
                  return false;
                }
                """,
                workerCondition=workerCondition.define(),
            )
            exposedInWorkerCheck = CGGeneric(exposedInWorkerCheck)
            if iface.isExposedInWindow():
                exposedInWorkerCheck = CGIfWrapper(
                    exposedInWorkerCheck, "!NS_IsMainThread()"
                )
            body.append(exposedInWorkerCheck)

        conditions = getConditionList(iface, "aCx", "aObj")

        # We should really have some conditions
        assert len(body) or len(conditions)

        conditionsWrapper = ""
        if len(conditions):
            conditionsWrapper = CGWrapper(
                conditions, pre="return ", post=";\n", reindent=True
            )
        else:
            conditionsWrapper = CGGeneric("return true;\n")

        body.append(conditionsWrapper)
        return body.define()


def StructuredCloneTag(name):
    return "SCTAG_DOM_%s" % name.upper()


class CGSerializer(CGAbstractStaticMethod):
    """
    Implementation of serialization for things marked [Serializable].
    This gets stored in our DOMJSClass, so it can be static.

    The caller is expected to pass in the object whose DOMJSClass it
    used to get the serializer.
    """

    def __init__(self, descriptor):
        args = [
            Argument("JSContext*", "aCx"),
            Argument("JSStructuredCloneWriter*", "aWriter"),
            Argument("JS::Handle<JSObject*>", "aObj"),
        ]
        CGAbstractStaticMethod.__init__(self, descriptor, "Serialize", "bool", args)

    def definition_body(self):
        return fill(
            """
            MOZ_ASSERT(IsDOMObject(aObj), "Non-DOM object passed");
            MOZ_ASSERT(GetDOMClass(aObj)->mSerializer == &Serialize,
                       "Wrong object passed");
            return JS_WriteUint32Pair(aWriter, ${tag}, 0) &&
                   UnwrapDOMObject<${type}>(aObj)->WriteStructuredClone(aCx, aWriter);
            """,
            tag=StructuredCloneTag(self.descriptor.name),
            type=self.descriptor.nativeType,
        )


class CGDeserializer(CGAbstractMethod):
    """
    Implementation of deserialization for things marked [Serializable].
    This will need to be accessed from WebIDLSerializable, so can't be static.
    """

    def __init__(self, descriptor):
        args = [
            Argument("JSContext*", "aCx"),
            Argument("nsIGlobalObject*", "aGlobal"),
            Argument("JSStructuredCloneReader*", "aReader"),
        ]
        CGAbstractMethod.__init__(self, descriptor, "Deserialize", "JSObject*", args)

    def definition_body(self):
        # WrapObject has different signatures depending on whether
        # the object is wrappercached.
        if self.descriptor.wrapperCache:
            wrapCall = dedent(
                """
                result = obj->WrapObject(aCx, nullptr);
                if (!result) {
                  return nullptr;
                }
                """
            )
        else:
            wrapCall = dedent(
                """
                if (!obj->WrapObject(aCx, nullptr, &result)) {
                  return nullptr;
                }
                """
            )

        return fill(
            """
            // Protect the result from a moving GC in ~RefPtr
            JS::Rooted<JSObject*> result(aCx);
            {  // Scope for the RefPtr
              RefPtr<${type}> obj = ${type}::ReadStructuredClone(aCx, aGlobal, aReader);
              if (!obj) {
                return nullptr;
              }
              $*{wrapCall}
            }
            return result;
            """,
            type=self.descriptor.nativeType,
            wrapCall=wrapCall,
        )


def CreateBindingJSObject(descriptor):
    objDecl = "BindingJSObjectCreator<%s> creator(aCx);\n" % descriptor.nativeType

    # We don't always need to root obj, but there are a variety
    # of cases where we do, so for simplicity, just always root it.
    if descriptor.proxy:
        if descriptor.interface.getExtendedAttribute("LegacyOverrideBuiltIns"):
            assert not descriptor.isMaybeCrossOriginObject()
            create = dedent(
                """
                aObject->mExpandoAndGeneration.expando.setUndefined();
                JS::Rooted<JS::Value> expandoValue(aCx, JS::PrivateValue(&aObject->mExpandoAndGeneration));
                creator.CreateProxyObject(aCx, &sClass.mBase, DOMProxyHandler::getInstance(),
                                          proto, /* aLazyProto = */ false, aObject,
                                          expandoValue, aReflector);
                """
            )
        else:
            if descriptor.isMaybeCrossOriginObject():
                proto = "nullptr"
                lazyProto = "true"
            else:
                proto = "proto"
                lazyProto = "false"
            create = fill(
                """
                creator.CreateProxyObject(aCx, &sClass.mBase, DOMProxyHandler::getInstance(),
                                          ${proto}, /* aLazyProto = */ ${lazyProto},
                                          aObject, JS::UndefinedHandleValue, aReflector);
                """,
                proto=proto,
                lazyProto=lazyProto,
            )
    else:
        create = dedent(
            """
            creator.CreateObject(aCx, sClass.ToJSClass(), proto, aObject, aReflector);
            """
        )
    return (
        objDecl
        + create
        + dedent(
            """
        if (!aReflector) {
          return false;
        }
        """
        )
    )


def InitUnforgeablePropertiesOnHolder(
    descriptor, properties, failureCode, holderName="unforgeableHolder"
):
    """
    Define the unforgeable properties on the unforgeable holder for
    the interface represented by descriptor.

    properties is a PropertyArrays instance.

    """
    assert (
        properties.unforgeableAttrs.hasNonChromeOnly()
        or properties.unforgeableAttrs.hasChromeOnly()
        or properties.unforgeableMethods.hasNonChromeOnly()
        or properties.unforgeableMethods.hasChromeOnly()
    )

    unforgeables = []

    defineUnforgeableAttrs = fill(
        """
        if (!DefineLegacyUnforgeableAttributes(aCx, ${holderName}, %s)) {
          $*{failureCode}
        }
        """,
        failureCode=failureCode,
        holderName=holderName,
    )
    defineUnforgeableMethods = fill(
        """
        if (!DefineLegacyUnforgeableMethods(aCx, ${holderName}, %s)) {
          $*{failureCode}
        }
        """,
        failureCode=failureCode,
        holderName=holderName,
    )

    unforgeableMembers = [
        (defineUnforgeableAttrs, properties.unforgeableAttrs),
        (defineUnforgeableMethods, properties.unforgeableMethods),
    ]
    for (template, array) in unforgeableMembers:
        if array.hasNonChromeOnly():
            unforgeables.append(CGGeneric(template % array.variableName(False)))
        if array.hasChromeOnly():
            unforgeables.append(
                CGIfWrapper(
                    CGGeneric(template % array.variableName(True)),
                    "nsContentUtils::ThreadsafeIsSystemCaller(aCx)",
                )
            )

    if descriptor.interface.getExtendedAttribute("LegacyUnforgeable"):
        # We do our undefined toPrimitive here, not as a regular property
        # because we don't have a concept of value props anywhere in IDL.
        unforgeables.append(
            CGGeneric(
                fill(
                    """
            JS::Rooted<JS::PropertyKey> toPrimitive(aCx,
              JS::GetWellKnownSymbolKey(aCx, JS::SymbolCode::toPrimitive));
            if (!JS_DefinePropertyById(aCx, ${holderName}, toPrimitive,
                                       JS::UndefinedHandleValue,
                                       JSPROP_READONLY | JSPROP_PERMANENT)) {
              $*{failureCode}
            }
            """,
                    failureCode=failureCode,
                    holderName=holderName,
                )
            )
        )

    return CGWrapper(CGList(unforgeables), pre="\n")


def CopyUnforgeablePropertiesToInstance(descriptor, failureCode):
    """
    Copy the unforgeable properties from the unforgeable holder for
    this interface to the instance object we have.
    """
    assert not descriptor.isGlobal()

    if not descriptor.hasLegacyUnforgeableMembers:
        return ""

    copyCode = [
        CGGeneric(
            dedent(
                """
            // Important: do unforgeable property setup after we have handed
            // over ownership of the C++ object to obj as needed, so that if
            // we fail and it ends up GCed it won't have problems in the
            // finalizer trying to drop its ownership of the C++ object.
            """
            )
        )
    ]

    # For proxies, we want to define on the expando object, not directly on the
    # reflector, so we can make sure we don't get confused by named getters.
    if descriptor.proxy:
        copyCode.append(
            CGGeneric(
                fill(
                    """
            JS::Rooted<JSObject*> expando(aCx,
              DOMProxyHandler::EnsureExpandoObject(aCx, aReflector));
            if (!expando) {
              $*{failureCode}
            }
            """,
                    failureCode=failureCode,
                )
            )
        )
        obj = "expando"
    else:
        obj = "aReflector"

    copyCode.append(
        CGGeneric(
            fill(
                """
        JS::Rooted<JSObject*> unforgeableHolder(aCx,
          &JS::GetReservedSlot(canonicalProto, DOM_INTERFACE_PROTO_SLOTS_BASE).toObject());
        if (!JS_InitializePropertiesFromCompatibleNativeObject(aCx, ${obj}, unforgeableHolder)) {
          $*{failureCode}
        }
        """,
                obj=obj,
                failureCode=failureCode,
            )
        )
    )

    return CGWrapper(CGList(copyCode), pre="\n").define()


def AssertInheritanceChain(descriptor):
    # We can skip the reinterpret_cast check for the descriptor's nativeType
    # if aObject is a pointer of that type.
    asserts = fill(
        """
        static_assert(std::is_same_v<decltype(aObject), ${nativeType}*>);
        """,
        nativeType=descriptor.nativeType,
    )
    iface = descriptor.interface
    while iface.parent:
        iface = iface.parent
        desc = descriptor.getDescriptor(iface.identifier.name)
        asserts += (
            "MOZ_ASSERT(static_cast<%s*>(aObject) == \n"
            "           reinterpret_cast<%s*>(aObject),\n"
            '           "Multiple inheritance for %s is broken.");\n'
            % (desc.nativeType, desc.nativeType, desc.nativeType)
        )
    asserts += "MOZ_ASSERT(ToSupportsIsCorrect(aObject));\n"
    return asserts


def InitMemberSlots(descriptor, failureCode):
    """
    Initialize member slots on our JS object if we're supposed to have some.

    Note that this is called after the SetWrapper() call in the
    wrapperCache case, since that can affect how our getters behave
    and we plan to invoke them here.  So if we fail, we need to
    ClearWrapper.
    """
    if not descriptor.interface.hasMembersInSlots():
        return ""
    return fill(
        """
        if (!UpdateMemberSlots(aCx, aReflector, aObject)) {
          $*{failureCode}
        }
        """,
        failureCode=failureCode,
    )


def DeclareProto(descriptor, noGivenProto=False):
    """
    Declare the canonicalProto and proto we have for our wrapping operation.
    """
    getCanonical = dedent(
        """
        JS::Handle<JSObject*> ${canonicalProto} = GetProtoObjectHandle(aCx);
        if (!${canonicalProto}) {
          return false;
        }
        """
    )

    if noGivenProto:
        return fill(getCanonical, canonicalProto="proto")

    getCanonical = fill(getCanonical, canonicalProto="canonicalProto")

    preamble = getCanonical + dedent(
        """
        JS::Rooted<JSObject*> proto(aCx);
        """
    )
    if descriptor.isMaybeCrossOriginObject():
        return preamble + dedent(
            """
            MOZ_ASSERT(!aGivenProto,
                       "Shouldn't have constructors on cross-origin objects");
            // Set proto to canonicalProto to avoid preserving our wrapper if
            // we don't have to.
            proto = canonicalProto;
            """
        )

    return preamble + dedent(
        """
        if (aGivenProto) {
          proto = aGivenProto;
          // Unfortunately, while aGivenProto was in the compartment of aCx
          // coming in, we changed compartments to that of "parent" so may need
          // to wrap the proto here.
          if (js::GetContextCompartment(aCx) != JS::GetCompartment(proto)) {
            if (!JS_WrapObject(aCx, &proto)) {
              return false;
            }
          }
        } else {
          proto = canonicalProto;
        }
        """
    )


class CGWrapWithCacheMethod(CGAbstractMethod):
    """
    Create a wrapper JSObject for a given native that implements nsWrapperCache.
    """

    def __init__(self, descriptor):
        assert descriptor.interface.hasInterfacePrototypeObject()
        args = [
            Argument("JSContext*", "aCx"),
            Argument(descriptor.nativeType + "*", "aObject"),
            Argument("nsWrapperCache*", "aCache"),
            Argument("JS::Handle<JSObject*>", "aGivenProto"),
            Argument("JS::MutableHandle<JSObject*>", "aReflector"),
        ]
        CGAbstractMethod.__init__(self, descriptor, "Wrap", "bool", args)

    def definition_body(self):
        failureCode = dedent(
            """
            aCache->ReleaseWrapper(aObject);
            aCache->ClearWrapper();
            return false;
            """
        )

        if self.descriptor.proxy:
            finalize = "DOMProxyHandler::getInstance()->finalize"
        else:
            finalize = FINALIZE_HOOK_NAME

        return fill(
            """
            static_assert(!std::is_base_of_v<NonRefcountedDOMObject, ${nativeType}>,
                          "Shouldn't have wrappercached things that are not refcounted.");
            $*{assertInheritance}
            MOZ_ASSERT_IF(aGivenProto, js::IsObjectInContextCompartment(aGivenProto, aCx));
            MOZ_ASSERT(!aCache->GetWrapper(),
                       "You should probably not be using Wrap() directly; use "
                       "GetOrCreateDOMReflector instead");

            MOZ_ASSERT(ToSupportsIsOnPrimaryInheritanceChain(aObject, aCache),
                       "nsISupports must be on our primary inheritance chain");

            // If the wrapper cache contains a dead reflector then finalize that
            // now, ensuring that the finalizer for the old reflector always
            // runs before the new reflector is created and attached. This
            // avoids the awkward situation where there are multiple reflector
            // objects that contain pointers to the same native.

            if (JSObject* oldReflector = aCache->GetWrapperMaybeDead()) {
              ${finalize}(nullptr /* unused */, oldReflector);
              MOZ_ASSERT(!aCache->GetWrapperMaybeDead());
            }

            JS::Rooted<JSObject*> global(aCx, FindAssociatedGlobal(aCx, aObject->GetParentObject()));
            if (!global) {
              return false;
            }
            MOZ_ASSERT(JS_IsGlobalObject(global));
            JS::AssertObjectIsNotGray(global);

            // That might have ended up wrapping us already, due to the wonders
            // of XBL.  Check for that, and bail out as needed.
            aReflector.set(aCache->GetWrapper());
            if (aReflector) {
            #ifdef DEBUG
              AssertReflectorHasGivenProto(aCx, aReflector, aGivenProto);
            #endif // DEBUG
              return true;
            }

            JSAutoRealm ar(aCx, global);
            $*{declareProto}

            $*{createObject}

            aCache->SetWrapper(aReflector);
            $*{unforgeable}
            $*{slots}
            creator.InitializationSucceeded();

            MOZ_ASSERT(aCache->GetWrapperPreserveColor() &&
                       aCache->GetWrapperPreserveColor() == aReflector);
            // If proto != canonicalProto, we have to preserve our wrapper;
            // otherwise we won't be able to properly recreate it later, since
            // we won't know what proto to use.  Note that we don't check
            // aGivenProto here, since it's entirely possible (and even
            // somewhat common) to have a non-null aGivenProto which is the
            // same as canonicalProto.
            if (proto != canonicalProto) {
              PreserveWrapper(aObject);
            }

            return true;
            """,
            nativeType=self.descriptor.nativeType,
            assertInheritance=AssertInheritanceChain(self.descriptor),
            declareProto=DeclareProto(self.descriptor),
            createObject=CreateBindingJSObject(self.descriptor),
            unforgeable=CopyUnforgeablePropertiesToInstance(
                self.descriptor, failureCode
            ),
            slots=InitMemberSlots(self.descriptor, failureCode),
            finalize=finalize,
        )


class CGWrapMethod(CGAbstractMethod):
    def __init__(self, descriptor):
        # XXX can we wrap if we don't have an interface prototype object?
        assert descriptor.interface.hasInterfacePrototypeObject()
        args = [
            Argument("JSContext*", "aCx"),
            Argument("T*", "aObject"),
            Argument("JS::Handle<JSObject*>", "aGivenProto"),
        ]
        CGAbstractMethod.__init__(
            self,
            descriptor,
            "Wrap",
            "JSObject*",
            args,
            inline=True,
            templateArgs=["class T"],
        )

    def definition_body(self):
        return dedent(
            """
            JS::Rooted<JSObject*> reflector(aCx);
            return Wrap(aCx, aObject, aObject, aGivenProto, &reflector) ? reflector.get() : nullptr;
            """
        )


class CGWrapNonWrapperCacheMethod(CGAbstractMethod):
    """
    Create a wrapper JSObject for a given native that does not implement
    nsWrapperCache.
    """

    def __init__(self, descriptor, static=False, signatureOnly=False):
        # XXX can we wrap if we don't have an interface prototype object?
        assert descriptor.interface.hasInterfacePrototypeObject()
        self.noGivenProto = (
            descriptor.interface.isIteratorInterface()
            or descriptor.interface.isAsyncIteratorInterface()
        )
        args = [
            Argument("JSContext*", "aCx"),
            Argument(descriptor.nativeType + "*", "aObject"),
        ]
        if not self.noGivenProto:
            args.append(Argument("JS::Handle<JSObject*>", "aGivenProto"))
        args.append(Argument("JS::MutableHandle<JSObject*>", "aReflector"))
        CGAbstractMethod.__init__(
            self,
            descriptor,
            "Wrap",
            "bool",
            args,
            static=static,
            signatureOnly=signatureOnly,
        )

    def definition_body(self):
        failureCode = "return false;\n"

        declareProto = DeclareProto(self.descriptor, noGivenProto=self.noGivenProto)
        if self.noGivenProto:
            assertGivenProto = ""
        else:
            assertGivenProto = dedent(
                """
                MOZ_ASSERT_IF(aGivenProto, js::IsObjectInContextCompartment(aGivenProto, aCx));
                """
            )
        return fill(
            """
            $*{assertions}
            $*{assertGivenProto}

            JS::Rooted<JSObject*> global(aCx, JS::CurrentGlobalOrNull(aCx));
            $*{declareProto}

            $*{createObject}

            $*{unforgeable}

            $*{slots}

            creator.InitializationSucceeded();
            return true;
            """,
            assertions=AssertInheritanceChain(self.descriptor),
            assertGivenProto=assertGivenProto,
            declareProto=declareProto,
            createObject=CreateBindingJSObject(self.descriptor),
            unforgeable=CopyUnforgeablePropertiesToInstance(
                self.descriptor, failureCode
            ),
            slots=InitMemberSlots(self.descriptor, failureCode),
        )


class CGWrapGlobalMethod(CGAbstractMethod):
    """
    Create a wrapper JSObject for a global.  The global must implement
    nsWrapperCache.

    properties should be a PropertyArrays instance.
    """

    def __init__(self, descriptor, properties):
        assert descriptor.interface.hasInterfacePrototypeObject()
        args = [
            Argument("JSContext*", "aCx"),
            Argument(descriptor.nativeType + "*", "aObject"),
            Argument("nsWrapperCache*", "aCache"),
            Argument("JS::RealmOptions&", "aOptions"),
            Argument("JSPrincipals*", "aPrincipal"),
            Argument("bool", "aInitStandardClasses"),
            Argument("JS::MutableHandle<JSObject*>", "aReflector"),
        ]
        CGAbstractMethod.__init__(self, descriptor, "Wrap", "bool", args)
        self.descriptor = descriptor
        self.properties = properties

    def definition_body(self):
        if self.properties.hasNonChromeOnly():
            properties = "sNativeProperties.Upcast()"
        else:
            properties = "nullptr"
        if self.properties.hasChromeOnly():
            chromeProperties = "nsContentUtils::ThreadsafeIsSystemCaller(aCx) ? sChromeOnlyNativeProperties.Upcast() : nullptr"
        else:
            chromeProperties = "nullptr"

        failureCode = dedent(
            """
            aCache->ReleaseWrapper(aObject);
            aCache->ClearWrapper();
            return false;
            """
        )

        if self.descriptor.hasLegacyUnforgeableMembers:
            unforgeable = InitUnforgeablePropertiesOnHolder(
                self.descriptor, self.properties, failureCode, "aReflector"
            ).define()
        else:
            unforgeable = ""

        if self.descriptor.hasOrdinaryObjectPrototype:
            getProto = "JS::GetRealmObjectPrototypeHandle"
        else:
            getProto = "GetProtoObjectHandle"
        return fill(
            """
            $*{assertions}
            MOZ_ASSERT(ToSupportsIsOnPrimaryInheritanceChain(aObject, aCache),
                       "nsISupports must be on our primary inheritance chain");

            if (!CreateGlobal<${nativeType}, ${getProto}>(aCx,
                                             aObject,
                                             aCache,
                                             sClass.ToJSClass(),
                                             aOptions,
                                             aPrincipal,
                                             aInitStandardClasses,
                                             aReflector)) {
              $*{failureCode}
            }

            // aReflector is a new global, so has a new realm.  Enter it
            // before doing anything with it.
            JSAutoRealm ar(aCx, aReflector);

            if (!DefineProperties(aCx, aReflector, ${properties}, ${chromeProperties})) {
              $*{failureCode}
            }
            $*{unforgeable}

            $*{slots}

            return true;
            """,
            assertions=AssertInheritanceChain(self.descriptor),
            nativeType=self.descriptor.nativeType,
            getProto=getProto,
            properties=properties,
            chromeProperties=chromeProperties,
            failureCode=failureCode,
            unforgeable=unforgeable,
            slots=InitMemberSlots(self.descriptor, failureCode),
        )


class CGUpdateMemberSlotsMethod(CGAbstractStaticMethod):
    def __init__(self, descriptor):
        args = [
            Argument("JSContext*", "aCx"),
            Argument("JS::Handle<JSObject*>", "aWrapper"),
            Argument(descriptor.nativeType + "*", "aObject"),
        ]
        CGAbstractStaticMethod.__init__(
            self, descriptor, "UpdateMemberSlots", "bool", args
        )

    def definition_body(self):
        body = "JS::Rooted<JS::Value> temp(aCx);\n" "JSJitGetterCallArgs args(&temp);\n"
        for m in self.descriptor.interface.members:
            if m.isAttr() and m.getExtendedAttribute("StoreInSlot"):
                # Skip doing this for the "window" and "self" attributes on the
                # Window interface, because those can't be gotten safely until
                # we have hooked it up correctly to the outer window.  The
                # window code handles doing the get itself.
                if self.descriptor.interface.identifier.name == "Window" and (
                    m.identifier.name == "window" or m.identifier.name == "self"
                ):
                    continue
                body += fill(
                    """

                    static_assert(${slot} < JS::shadow::Object::MAX_FIXED_SLOTS,
                                  "Not enough fixed slots to fit '${interface}.${member}.  Ion's visitGetDOMMemberV/visitGetDOMMemberT assume StoreInSlot things are all in fixed slots.");
                    if (!get_${member}(aCx, aWrapper, aObject, args)) {
                      return false;
                    }
                    // Getter handled setting our reserved slots
                    """,
                    slot=memberReservedSlot(m, self.descriptor),
                    interface=self.descriptor.interface.identifier.name,
                    member=m.identifier.name,
                )

        body += "\nreturn true;\n"
        return body


class CGClearCachedValueMethod(CGAbstractMethod):
    def __init__(self, descriptor, member):
        self.member = member
        # If we're StoreInSlot, we'll need to call the getter
        if member.getExtendedAttribute("StoreInSlot"):
            args = [Argument("JSContext*", "aCx")]
            returnType = "bool"
        else:
            args = []
            returnType = "void"
        args.append(Argument(descriptor.nativeType + "*", "aObject"))
        name = MakeClearCachedValueNativeName(member)
        CGAbstractMethod.__init__(self, descriptor, name, returnType, args)

    def definition_body(self):
        slotIndex = memberReservedSlot(self.member, self.descriptor)
        if self.member.getExtendedAttribute("StoreInSlot"):
            # We have to root things and save the old value in case
            # regetting fails, so we can restore it.
            declObj = "JS::Rooted<JSObject*> obj(aCx);\n"
            noopRetval = " true"
            saveMember = (
                "JS::Rooted<JS::Value> oldValue(aCx, JS::GetReservedSlot(obj, %s));\n"
                % slotIndex
            )
            regetMember = fill(
                """
                JS::Rooted<JS::Value> temp(aCx);
                JSJitGetterCallArgs args(&temp);
                JSAutoRealm ar(aCx, obj);
                if (!get_${name}(aCx, obj, aObject, args)) {
                  JS::SetReservedSlot(obj, ${slotIndex}, oldValue);
                  return false;
                }
                return true;
                """,
                name=self.member.identifier.name,
                slotIndex=slotIndex,
            )
        else:
            declObj = "JSObject* obj;\n"
            noopRetval = ""
            saveMember = ""
            regetMember = ""

        if self.descriptor.wantsXrays:
            clearXrayExpandoSlots = fill(
                """
                xpc::ClearXrayExpandoSlots(obj, ${xraySlotIndex});
                """,
                xraySlotIndex=memberXrayExpandoReservedSlot(
                    self.member, self.descriptor
                ),
            )
        else:
            clearXrayExpandoSlots = ""

        return fill(
            """
            $*{declObj}
            obj = aObject->GetWrapper();
            if (!obj) {
              return${noopRetval};
            }
            $*{saveMember}
            JS::SetReservedSlot(obj, ${slotIndex}, JS::UndefinedValue());
            $*{clearXrayExpandoSlots}
            $*{regetMember}
            """,
            declObj=declObj,
            noopRetval=noopRetval,
            saveMember=saveMember,
            slotIndex=slotIndex,
            clearXrayExpandoSlots=clearXrayExpandoSlots,
            regetMember=regetMember,
        )


class CGCrossOriginProperties(CGThing):
    def __init__(self, descriptor):
        attrs = []
        chromeOnlyAttrs = []
        methods = []
        chromeOnlyMethods = []
        for m in descriptor.interface.members:
            if m.isAttr() and (
                m.getExtendedAttribute("CrossOriginReadable")
                or m.getExtendedAttribute("CrossOriginWritable")
            ):
                if m.isStatic():
                    raise TypeError(
                        "Don't know how to deal with static method %s"
                        % m.identifier.name
                    )
                if PropertyDefiner.getControllingCondition(
                    m, descriptor
                ).hasDisablers():
                    raise TypeError(
                        "Don't know how to deal with disabler for %s"
                        % m.identifier.name
                    )
                if len(m.bindingAliases) > 0:
                    raise TypeError(
                        "Don't know how to deal with aliases for %s" % m.identifier.name
                    )
                if m.getExtendedAttribute("ChromeOnly") is not None:
                    chromeOnlyAttrs.extend(AttrDefiner.attrData(m, overrideFlags="0"))
                else:
                    attrs.extend(AttrDefiner.attrData(m, overrideFlags="0"))
            elif m.isMethod() and m.getExtendedAttribute("CrossOriginCallable"):
                if m.isStatic():
                    raise TypeError(
                        "Don't know how to deal with static method %s"
                        % m.identifier.name
                    )
                if PropertyDefiner.getControllingCondition(
                    m, descriptor
                ).hasDisablers():
                    raise TypeError(
                        "Don't know how to deal with disabler for %s"
                        % m.identifier.name
                    )
                if len(m.aliases) > 0:
                    raise TypeError(
                        "Don't know how to deal with aliases for %s" % m.identifier.name
                    )
                if m.getExtendedAttribute("ChromeOnly") is not None:
                    chromeOnlyMethods.append(
                        MethodDefiner.methodData(
                            m, descriptor, overrideFlags="JSPROP_READONLY"
                        )
                    )
                else:
                    methods.append(
                        MethodDefiner.methodData(
                            m, descriptor, overrideFlags="JSPROP_READONLY"
                        )
                    )

        if len(attrs) > 0:
            self.attributeSpecs, _ = PropertyDefiner.generatePrefableArrayValues(
                attrs,
                descriptor,
                AttrDefiner.formatSpec,
                "  JS_PS_END\n",
                AttrDefiner.condition,
                functools.partial(AttrDefiner.specData, crossOriginOnly=True),
            )
        else:
            self.attributeSpecs = [" JS_PS_END\n"]
        if len(methods) > 0:
            self.methodSpecs, _ = PropertyDefiner.generatePrefableArrayValues(
                methods,
                descriptor,
                MethodDefiner.formatSpec,
                "  JS_FS_END\n",
                MethodDefiner.condition,
                MethodDefiner.specData,
            )
        else:
            self.methodSpecs = ["  JS_FS_END\n"]

        if len(chromeOnlyAttrs) > 0:
            (
                self.chromeOnlyAttributeSpecs,
                _,
            ) = PropertyDefiner.generatePrefableArrayValues(
                chromeOnlyAttrs,
                descriptor,
                AttrDefiner.formatSpec,
                "  JS_PS_END\n",
                AttrDefiner.condition,
                functools.partial(AttrDefiner.specData, crossOriginOnly=True),
            )
        else:
            self.chromeOnlyAttributeSpecs = []
        if len(chromeOnlyMethods) > 0:
            self.chromeOnlyMethodSpecs, _ = PropertyDefiner.generatePrefableArrayValues(
                chromeOnlyMethods,
                descriptor,
                MethodDefiner.formatSpec,
                "  JS_FS_END\n",
                MethodDefiner.condition,
                MethodDefiner.specData,
            )
        else:
            self.chromeOnlyMethodSpecs = []

    def declare(self):
        return dedent(
            """
            extern const CrossOriginProperties sCrossOriginProperties;
            """
        )

    def define(self):
        def defineChromeOnly(name, specs, specType):
            if len(specs) == 0:
                return ("", "nullptr")
            name = "sChromeOnlyCrossOrigin" + name
            define = fill(
                """
                static const ${specType} ${name}[] = {
                  $*{specs}
                };
                """,
                specType=specType,
                name=name,
                specs=",\n".join(specs),
            )
            return (define, name)

        chromeOnlyAttributes = defineChromeOnly(
            "Attributes", self.chromeOnlyAttributeSpecs, "JSPropertySpec"
        )
        chromeOnlyMethods = defineChromeOnly(
            "Methods", self.chromeOnlyMethodSpecs, "JSFunctionSpec"
        )
        return fill(
            """
            static const JSPropertySpec sCrossOriginAttributes[] = {
              $*{attributeSpecs}
            };
            static const JSFunctionSpec sCrossOriginMethods[] = {
              $*{methodSpecs}
            };
            $*{chromeOnlyAttributeSpecs}
            $*{chromeOnlyMethodSpecs}
            const CrossOriginProperties sCrossOriginProperties = {
              sCrossOriginAttributes,
              sCrossOriginMethods,
              ${chromeOnlyAttributes},
              ${chromeOnlyMethods}
            };
            """,
            attributeSpecs=",\n".join(self.attributeSpecs),
            methodSpecs=",\n".join(self.methodSpecs),
            chromeOnlyAttributeSpecs=chromeOnlyAttributes[0],
            chromeOnlyMethodSpecs=chromeOnlyMethods[0],
            chromeOnlyAttributes=chromeOnlyAttributes[1],
            chromeOnlyMethods=chromeOnlyMethods[1],
        )


class CGCycleCollectionTraverseForOwningUnionMethod(CGAbstractMethod):
    """
    ImplCycleCollectionUnlink for owning union type.
    """

    def __init__(self, type):
        self.type = type
        args = [
            Argument("nsCycleCollectionTraversalCallback&", "aCallback"),
            Argument("%s&" % CGUnionStruct.unionTypeName(type, True), "aUnion"),
            Argument("const char*", "aName"),
            Argument("uint32_t", "aFlags", "0"),
        ]
        CGAbstractMethod.__init__(
            self, None, "ImplCycleCollectionTraverse", "void", args
        )

    def deps(self):
        return self.type.getDeps()

    def definition_body(self):
        memberNames = [
            getUnionMemberName(t)
            for t in self.type.flatMemberTypes
            if idlTypeNeedsCycleCollection(t)
        ]
        assert memberNames

        conditionTemplate = "aUnion.Is%s()"
        functionCallTemplate = (
            'ImplCycleCollectionTraverse(aCallback, aUnion.GetAs%s(), "m%s", aFlags);\n'
        )

        ifStaments = (
            CGIfWrapper(CGGeneric(functionCallTemplate % (m, m)), conditionTemplate % m)
            for m in memberNames
        )

        return CGElseChain(ifStaments).define()


class CGCycleCollectionUnlinkForOwningUnionMethod(CGAbstractMethod):
    """
    ImplCycleCollectionUnlink for owning union type.
    """

    def __init__(self, type):
        self.type = type
        args = [Argument("%s&" % CGUnionStruct.unionTypeName(type, True), "aUnion")]
        CGAbstractMethod.__init__(self, None, "ImplCycleCollectionUnlink", "void", args)

    def deps(self):
        return self.type.getDeps()

    def definition_body(self):
        return "aUnion.Uninit();\n"


builtinNames = {
    IDLType.Tags.bool: "bool",
    IDLType.Tags.int8: "int8_t",
    IDLType.Tags.int16: "int16_t",
    IDLType.Tags.int32: "int32_t",
    IDLType.Tags.int64: "int64_t",
    IDLType.Tags.uint8: "uint8_t",
    IDLType.Tags.uint16: "uint16_t",
    IDLType.Tags.uint32: "uint32_t",
    IDLType.Tags.uint64: "uint64_t",
    IDLType.Tags.unrestricted_float: "float",
    IDLType.Tags.float: "float",
    IDLType.Tags.unrestricted_double: "double",
    IDLType.Tags.double: "double",
}

numericSuffixes = {
    IDLType.Tags.int8: "",
    IDLType.Tags.uint8: "",
    IDLType.Tags.int16: "",
    IDLType.Tags.uint16: "",
    IDLType.Tags.int32: "",
    IDLType.Tags.uint32: "U",
    IDLType.Tags.int64: "LL",
    IDLType.Tags.uint64: "ULL",
    IDLType.Tags.unrestricted_float: "F",
    IDLType.Tags.float: "F",
    IDLType.Tags.unrestricted_double: "",
    IDLType.Tags.double: "",
}


def numericValue(t, v):
    if t == IDLType.Tags.unrestricted_double or t == IDLType.Tags.unrestricted_float:
        typeName = builtinNames[t]
        if v == float("inf"):
            return "mozilla::PositiveInfinity<%s>()" % typeName
        if v == float("-inf"):
            return "mozilla::NegativeInfinity<%s>()" % typeName
        if math.isnan(v):
            return "mozilla::UnspecifiedNaN<%s>()" % typeName
    return "%s%s" % (v, numericSuffixes[t])


class CastableObjectUnwrapper:
    """
    A class for unwrapping an object stored in a JS Value (or
    MutableHandle<Value> or Handle<Value>) named by the "source" and
    "mutableSource" arguments based on the passed-in descriptor and storing it
    in a variable called by the name in the "target" argument.  The "source"
    argument should be able to produce a Value or Handle<Value>; the
    "mutableSource" argument should be able to produce a MutableHandle<Value>

    codeOnFailure is the code to run if unwrapping fails.

    If isCallbackReturnValue is "JSImpl" and our descriptor is also
    JS-implemented, fall back to just creating the right object if what we
    have isn't one already.
    """

    def __init__(
        self,
        descriptor,
        source,
        mutableSource,
        target,
        codeOnFailure,
        exceptionCode=None,
        isCallbackReturnValue=False,
    ):
        self.substitution = {
            "type": descriptor.nativeType,
            "protoID": "prototypes::id::" + descriptor.name,
            "target": target,
            "codeOnFailure": codeOnFailure,
            "source": source,
            "mutableSource": mutableSource,
        }

        if isCallbackReturnValue == "JSImpl" and descriptor.interface.isJSImplemented():
            exceptionCode = exceptionCode or codeOnFailure
            self.substitution["codeOnFailure"] = fill(
                """
                // Be careful to not wrap random DOM objects here, even if
                // they're wrapped in opaque security wrappers for some reason.
                // XXXbz Wish we could check for a JS-implemented object
                // that already has a content reflection...
                if (!IsDOMObject(js::UncheckedUnwrap(&${source}.toObject()))) {
                  nsCOMPtr<nsIGlobalObject> contentGlobal;
                  JS::Rooted<JSObject*> callback(cx, CallbackOrNull());
                  if (!callback ||
                      !GetContentGlobalForJSImplementedObject(cx, callback, getter_AddRefs(contentGlobal))) {
                    $*{exceptionCode}
                  }
                  JS::Rooted<JSObject*> jsImplSourceObj(cx, &${source}.toObject());
                  MOZ_RELEASE_ASSERT(!js::IsWrapper(jsImplSourceObj),
                                     "Don't return JS implementations from other compartments");
                  JS::Rooted<JSObject*> jsImplSourceGlobal(cx, JS::GetNonCCWObjectGlobal(jsImplSourceObj));
                  ${target} = new ${type}(jsImplSourceObj, jsImplSourceGlobal, contentGlobal);
                } else {
                  $*{codeOnFailure}
                }
                """,
                exceptionCode=exceptionCode,
                **self.substitution,
            )
        else:
            self.substitution["codeOnFailure"] = codeOnFailure

    def __str__(self):
        substitution = self.substitution.copy()
        substitution["codeOnFailure"] %= {
            "securityError": "rv == NS_ERROR_XPC_SECURITY_MANAGER_VETO"
        }
        return fill(
            """
            {
              // Our JSContext should be in the right global to do unwrapping in.
              nsresult rv = UnwrapObject<${protoID}, ${type}>(${mutableSource}, ${target}, cx);
              if (NS_FAILED(rv)) {
                $*{codeOnFailure}
              }
            }
            """,
            **substitution,
        )


class FailureFatalCastableObjectUnwrapper(CastableObjectUnwrapper):
    """
    As CastableObjectUnwrapper, but defaulting to throwing if unwrapping fails
    """

    def __init__(
        self,
        descriptor,
        source,
        mutableSource,
        target,
        exceptionCode,
        isCallbackReturnValue,
        sourceDescription,
    ):
        CastableObjectUnwrapper.__init__(
            self,
            descriptor,
            source,
            mutableSource,
            target,
            'cx.ThrowErrorMessage<MSG_DOES_NOT_IMPLEMENT_INTERFACE>("%s", "%s");\n'
            "%s"
            % (sourceDescription, descriptor.interface.identifier.name, exceptionCode),
            exceptionCode,
            isCallbackReturnValue,
        )


def getCallbackConversionInfo(
    type, idlObject, isMember, isCallbackReturnValue, isOptional
):
    """
    Returns a tuple containing the declType, declArgs, and basic
    conversion for the given callback type, with the given callback
    idl object in the given context (isMember/isCallbackReturnValue/isOptional).
    """
    name = idlObject.identifier.name

    # We can't use fast callbacks if isOptional because then we get an
    # Optional<RootedCallback> thing, which is not transparent to consumers.
    useFastCallback = (
        (not isMember or isMember == "Union")
        and not isCallbackReturnValue
        and not isOptional
    )
    if useFastCallback:
        name = "binding_detail::Fast%s" % name
        rootArgs = ""
        args = "&${val}.toObject(), JS::CurrentGlobalOrNull(cx)"
    else:
        rootArgs = dedent(
            """
            JS::Rooted<JSObject*> tempRoot(cx, &${val}.toObject());
            JS::Rooted<JSObject*> tempGlobalRoot(cx, JS::CurrentGlobalOrNull(cx));
            """
        )
        args = "cx, tempRoot, tempGlobalRoot, GetIncumbentGlobal()"

    if type.nullable() or isCallbackReturnValue:
        declType = CGGeneric("RefPtr<%s>" % name)
    else:
        declType = CGGeneric("OwningNonNull<%s>" % name)

    if useFastCallback:
        declType = CGTemplatedType("RootedCallback", declType)
        declArgs = "cx"
    else:
        declArgs = None

    conversion = fill(
        """
        { // scope for tempRoot and tempGlobalRoot if needed
          $*{rootArgs}
          $${declName} = new ${name}(${args});
        }
        """,
        rootArgs=rootArgs,
        name=name,
        args=args,
    )
    return (declType, declArgs, conversion)


class JSToNativeConversionInfo:
    """
    An object representing information about a JS-to-native conversion.
    """

    def __init__(
        self,
        template,
        declType=None,
        holderType=None,
        dealWithOptional=False,
        declArgs=None,
        holderArgs=None,
    ):
        """
        template: A string representing the conversion code.  This will have
                  template substitution performed on it as follows:

          ${val} is a handle to the JS::Value in question
          ${maybeMutableVal} May be a mutable handle to the JS::Value in
                             question. This is only OK to use if ${val} is
                             known to not be undefined.
          ${holderName} replaced by the holder's name, if any
          ${declName} replaced by the declaration's name
          ${haveValue} replaced by an expression that evaluates to a boolean
                       for whether we have a JS::Value.  Only used when
                       defaultValue is not None or when True is passed for
                       checkForValue to instantiateJSToNativeConversion.
                       This expression may not be already-parenthesized, so if
                       you use it with && or || make sure to put parens
                       around it.
          ${passedToJSImpl} replaced by an expression that evaluates to a boolean
                            for whether this value is being passed to a JS-
                            implemented interface.

        declType: A CGThing representing the native C++ type we're converting
                  to.  This is allowed to be None if the conversion code is
                  supposed to be used as-is.

        holderType: A CGThing representing the type of a "holder" which will
                    hold a possible reference to the C++ thing whose type we
                    returned in declType, or  None if no such holder is needed.

        dealWithOptional: A boolean indicating whether the caller has to do
                          optional-argument handling.  This should only be set
                          to true if the JS-to-native conversion is being done
                          for an optional argument or dictionary member with no
                          default value and if the returned template expects
                          both declType and holderType to be wrapped in
                          Optional<>, with ${declName} and ${holderName}
                          adjusted to point to the Value() of the Optional, and
                          Construct() calls to be made on the Optional<>s as
                          needed.

        declArgs: If not None, the arguments to pass to the ${declName}
                  constructor.  These will have template substitution performed
                  on them so you can use things like ${val}.  This is a
                  single string, not a list of strings.

        holderArgs: If not None, the arguments to pass to the ${holderName}
                    constructor.  These will have template substitution
                    performed on them so you can use things like ${val}.
                    This is a single string, not a list of strings.

        ${declName} must be in scope before the code from 'template' is entered.

        If holderType is not None then ${holderName} must be in scope before
        the code from 'template' is entered.
        """
        assert isinstance(template, str)
        assert declType is None or isinstance(declType, CGThing)
        assert holderType is None or isinstance(holderType, CGThing)
        self.template = template
        self.declType = declType
        self.holderType = holderType
        self.dealWithOptional = dealWithOptional
        self.declArgs = declArgs
        self.holderArgs = holderArgs


def getHandleDefault(defaultValue):
    tag = defaultValue.type.tag()
    if tag in numericSuffixes:
        # Some numeric literals require a suffix to compile without warnings
        return numericValue(tag, defaultValue.value)
    assert tag == IDLType.Tags.bool
    return toStringBool(defaultValue.value)


def handleDefaultStringValue(defaultValue, method):
    """
    Returns a string which ends up calling 'method' with a (char_t*, length)
    pair that sets this string default value.  This string is suitable for
    passing as the second argument of handleDefault.
    """
    assert (
        defaultValue.type.isDOMString()
        or defaultValue.type.isUSVString()
        or defaultValue.type.isUTF8String()
        or defaultValue.type.isByteString()
    )
    # There shouldn't be any non-ASCII or embedded nulls in here; if
    # it ever sneaks in we will need to think about how to properly
    # represent that in the C++.
    assert all(ord(c) < 128 and ord(c) > 0 for c in defaultValue.value)
    if defaultValue.type.isByteString() or defaultValue.type.isUTF8String():
        prefix = ""
    else:
        prefix = "u"
    return fill(
        """
        ${method}(${prefix}"${value}");
        """,
        method=method,
        prefix=prefix,
        value=defaultValue.value,
    )


def recordKeyType(recordType):
    assert recordType.keyType.isString()
    if recordType.keyType.isByteString() or recordType.keyType.isUTF8String():
        return "nsCString"
    return "nsString"


def recordKeyDeclType(recordType):
    return CGGeneric(recordKeyType(recordType))


def initializerForType(type):
    """
    Get the right initializer for the given type for a data location where we
    plan to then initialize it from a JS::Value.  Some types need to always be
    initialized even before we start the JS::Value-to-IDL-value conversion.

    Returns a string or None if no initialization is needed.
    """
    if type.isObject():
        return "nullptr"
    # We could probably return CGDictionary.getNonInitializingCtorArg() for the
    # dictionary case, but code outside DictionaryBase subclasses can't use
    # that, so we can't do it across the board.
    return None


# If this function is modified, modify CGNativeMember.getArg and
# CGNativeMember.getRetvalInfo accordingly.  The latter cares about the decltype
# and holdertype we end up using, because it needs to be able to return the code
# that will convert those to the actual return value of the callback function.
def getJSToNativeConversionInfo(
    type,
    descriptorProvider,
    failureCode=None,
    isDefinitelyObject=False,
    isMember=False,
    isOptional=False,
    invalidEnumValueFatal=True,
    defaultValue=None,
    isNullOrUndefined=False,
    isKnownMissing=False,
    exceptionCode=None,
    lenientFloatCode=None,
    allowTreatNonCallableAsNull=False,
    isCallbackReturnValue=False,
    sourceDescription="value",
    nestingLevel="",
):
    """
    Get a template for converting a JS value to a native object based on the
    given type and descriptor.  If failureCode is given, then we're actually
    testing whether we can convert the argument to the desired type.  That
    means that failures to convert due to the JS value being the wrong type of
    value need to use failureCode instead of throwing exceptions.  Failures to
    convert that are due to JS exceptions (from toString or valueOf methods) or
    out of memory conditions need to throw exceptions no matter what
    failureCode is.  However what actually happens when throwing an exception
    can be controlled by exceptionCode.  The only requirement on that is that
    exceptionCode must end up doing a return, and every return from this
    function must happen via exceptionCode if exceptionCode is not None.

    If isDefinitelyObject is True, that means we have a value and the value
    tests true for isObject(), so we have no need to recheck that.

    If isNullOrUndefined is True, that means we have a value and the value
    tests true for isNullOrUndefined(), so we have no need to recheck that.

    If isKnownMissing is True, that means that we are known-missing, and for
    cases when we have a default value we only need to output the default value.

    if isMember is not False, we're being converted from a property of some JS
    object, not from an actual method argument, so we can't rely on our jsval
    being rooted or outliving us in any way.  Callers can pass "Dictionary",
    "Variadic", "Sequence", "Union", or "OwningUnion" to indicate that the conversion
    is for something that is a dictionary member, a variadic argument, a sequence,
    an union, or an owning union respectively.
    XXX Once we swtich *Rooter to Rooted* for Record and Sequence type entirely,
        we could remove "Union" from isMember.

    If isOptional is true, then we are doing conversion of an optional
    argument with no default value.

    invalidEnumValueFatal controls whether an invalid enum value conversion
    attempt will throw (if true) or simply return without doing anything (if
    false).

    If defaultValue is not None, it's the IDL default value for this conversion

    If isEnforceRange is true, we're converting an integer and throwing if the
    value is out of range.

    If isClamp is true, we're converting an integer and clamping if the
    value is out of range.

    If isAllowShared is false, we're converting a buffer source and throwing if
    it is a SharedArrayBuffer or backed by a SharedArrayBuffer.

    If lenientFloatCode is not None, it should be used in cases when
    we're a non-finite float that's not unrestricted.

    If allowTreatNonCallableAsNull is true, then [TreatNonCallableAsNull] and
    [LegacyTreatNonObjectAsNull] extended attributes on nullable callback functions
    will be honored.

    If isCallbackReturnValue is "JSImpl" or "Callback", then the declType may be
    adjusted to make it easier to return from a callback.  Since that type is
    never directly observable by any consumers of the callback code, this is OK.
    Furthermore, if isCallbackReturnValue is "JSImpl", that affects the behavior
    of the FailureFatalCastableObjectUnwrapper conversion; this is used for
    implementing auto-wrapping of JS-implemented return values from a
    JS-implemented interface.

    sourceDescription is a description of what this JS value represents, to be
    used in error reporting.  Callers should assume that it might get placed in
    the middle of a sentence.  If it ends up at the beginning of a sentence, its
    first character will be automatically uppercased.

    The return value from this function is a JSToNativeConversionInfo.
    """
    # If we have a defaultValue then we're not actually optional for
    # purposes of what we need to be declared as.
    assert defaultValue is None or not isOptional

    # Also, we should not have a defaultValue if we know we're an object
    assert not isDefinitelyObject or defaultValue is None

    # And we can't both be an object and be null or undefined
    assert not isDefinitelyObject or not isNullOrUndefined

    isClamp = type.hasClamp()
    isEnforceRange = type.hasEnforceRange()
    isAllowShared = type.hasAllowShared()

    # If exceptionCode is not set, we'll just rethrow the exception we got.
    # Note that we can't just set failureCode to exceptionCode, because setting
    # failureCode will prevent pending exceptions from being set in cases when
    # they really should be!
    if exceptionCode is None:
        exceptionCode = "return false;\n"

    # Unfortunately, .capitalize() on a string will lowercase things inside the
    # string, which we do not want.
    def firstCap(string):
        return string[0].upper() + string[1:]

    # Helper functions for dealing with failures due to the JS value being the
    # wrong type of value
    def onFailureNotAnObject(failureCode):
        return CGGeneric(
            failureCode
            or (
                'cx.ThrowErrorMessage<MSG_NOT_OBJECT>("%s");\n'
                "%s" % (firstCap(sourceDescription), exceptionCode)
            )
        )

    def onFailureBadType(failureCode, typeName):
        return CGGeneric(
            failureCode
            or (
                'cx.ThrowErrorMessage<MSG_DOES_NOT_IMPLEMENT_INTERFACE>("%s", "%s");\n'
                "%s" % (firstCap(sourceDescription), typeName, exceptionCode)
            )
        )

    # It's a failure in the committed-to conversion, not a failure to match up
    # to a type, so we don't want to use failureCode in here. We want to just
    # throw an exception unconditionally.
    def onFailureIsShared():
        return CGGeneric(
            'cx.ThrowErrorMessage<MSG_TYPEDARRAY_IS_SHARED>("%s");\n'
            "%s" % (firstCap(sourceDescription), exceptionCode)
        )

    def onFailureIsLarge():
        return CGGeneric(
            'cx.ThrowErrorMessage<MSG_TYPEDARRAY_IS_LARGE>("%s");\n'
            "%s" % (firstCap(sourceDescription), exceptionCode)
        )

    def onFailureNotCallable(failureCode):
        return CGGeneric(
            failureCode
            or (
                'cx.ThrowErrorMessage<MSG_NOT_CALLABLE>("%s");\n'
                "%s" % (firstCap(sourceDescription), exceptionCode)
            )
        )

    # A helper function for handling default values.  Takes a template
    # body and the C++ code to set the default value and wraps the
    # given template body in handling for the default value.
    def handleDefault(template, setDefault):
        if defaultValue is None:
            return template
        if isKnownMissing:
            return fill(
                """
                {
                  // scope for any temporaries our default value setting needs.
                  $*{setDefault}
                }
                """,
                setDefault=setDefault,
            )
        return fill(
            """
            if ($${haveValue}) {
              $*{templateBody}
            } else {
              $*{setDefault}
            }
            """,
            templateBody=template,
            setDefault=setDefault,
        )

    # A helper function for wrapping up the template body for
    # possibly-nullable objecty stuff
    def wrapObjectTemplate(templateBody, type, codeToSetNull, failureCode=None):
        if isNullOrUndefined and type.nullable():
            # Just ignore templateBody and set ourselves to null.
            # Note that we don't have to worry about default values
            # here either, since we already examined this value.
            return codeToSetNull

        if not isDefinitelyObject:
            # Handle the non-object cases by wrapping up the whole
            # thing in an if cascade.
            if type.nullable():
                elifLine = "} else if (${val}.isNullOrUndefined()) {\n"
                elifBody = codeToSetNull
            else:
                elifLine = ""
                elifBody = ""

            # Note that $${val} below expands to ${val}. This string is
            # used as a template later, and val will be filled in then.
            templateBody = fill(
                """
                if ($${val}.isObject()) {
                  $*{templateBody}
                $*{elifLine}
                  $*{elifBody}
                } else {
                  $*{failureBody}
                }
                """,
                templateBody=templateBody,
                elifLine=elifLine,
                elifBody=elifBody,
                failureBody=onFailureNotAnObject(failureCode).define(),
            )

            if isinstance(defaultValue, IDLNullValue):
                assert type.nullable()  # Parser should enforce this
                templateBody = handleDefault(templateBody, codeToSetNull)
            elif isinstance(defaultValue, IDLEmptySequenceValue):
                # Our caller will handle it
                pass
            else:
                assert defaultValue is None

        return templateBody

    # A helper function for converting things that look like a JSObject*.
    def handleJSObjectType(
        type, isMember, failureCode, exceptionCode, sourceDescription
    ):
        if not isMember or isMember == "Union":
            if isOptional:
                # We have a specialization of Optional that will use a
                # Rooted for the storage here.
                declType = CGGeneric("JS::Handle<JSObject*>")
            else:
                declType = CGGeneric("JS::Rooted<JSObject*>")
            declArgs = "cx"
        else:
            assert isMember in (
                "Sequence",
                "Variadic",
                "Dictionary",
                "OwningUnion",
                "Record",
            )
            # We'll get traced by the sequence or dictionary or union tracer
            declType = CGGeneric("JSObject*")
            declArgs = None
        templateBody = "${declName} = &${val}.toObject();\n"

        # For JS-implemented APIs, we refuse to allow passing objects that the
        # API consumer does not subsume. The extra parens around
        # ($${passedToJSImpl}) suppress unreachable code warnings when
        # $${passedToJSImpl} is the literal `false`.  But Apple is shipping a
        # buggy clang (clang 3.9) in Xcode 8.3, so there even the parens are not
        # enough.  So we manually disable some warnings in clang.
        if (
            not isinstance(descriptorProvider, Descriptor)
            or descriptorProvider.interface.isJSImplemented()
        ):
            templateBody = (
                fill(
                    """
                #ifdef __clang__
                #pragma clang diagnostic push
                #pragma clang diagnostic ignored "-Wunreachable-code"
                #pragma clang diagnostic ignored "-Wunreachable-code-return"
                #endif // __clang__
                if (($${passedToJSImpl}) && !CallerSubsumes($${val})) {
                  cx.ThrowErrorMessage<MSG_PERMISSION_DENIED_TO_PASS_ARG>("${sourceDescription}");
                  $*{exceptionCode}
                }
                #ifdef __clang__
                #pragma clang diagnostic pop
                #endif // __clang__
                """,
                    sourceDescription=sourceDescription,
                    exceptionCode=exceptionCode,
                )
                + templateBody
            )

        setToNullCode = "${declName} = nullptr;\n"
        template = wrapObjectTemplate(templateBody, type, setToNullCode, failureCode)
        return JSToNativeConversionInfo(
            template, declType=declType, dealWithOptional=isOptional, declArgs=declArgs
        )

    def incrementNestingLevel():
        if nestingLevel == "":
            return 1
        return nestingLevel + 1

    assert not (isEnforceRange and isClamp)  # These are mutually exclusive

    if type.isSequence() or type.isObservableArray():
        assert not isEnforceRange and not isClamp and not isAllowShared

        if failureCode is None:
            notSequence = (
                'cx.ThrowErrorMessage<MSG_CONVERSION_ERROR>("%s", "%s");\n'
                "%s"
                % (
                    firstCap(sourceDescription),
                    "sequence" if type.isSequence() else "observable array",
                    exceptionCode,
                )
            )
        else:
            notSequence = failureCode

        nullable = type.nullable()
        # Be very careful not to change "type": we need it later
        if nullable:
            elementType = type.inner.inner
        else:
            elementType = type.inner

        # We want to use auto arrays if we can, but we have to be careful with
        # reallocation behavior for arrays.  In particular, if we use auto
        # arrays for sequences and have a sequence of elements which are
        # themselves sequences or have sequences as members, we have a problem.
        # In that case, resizing the outermost AutoTArray to the right size
        # will memmove its elements, but AutoTArrays are not memmovable and
        # hence will end up with pointers to bogus memory, which is bad.  To
        # deal with this, we typically map WebIDL sequences to our Sequence
        # type, which is in fact memmovable.  The one exception is when we're
        # passing in a sequence directly as an argument without any sort of
        # optional or nullable complexity going on.  In that situation, we can
        # use an AutoSequence instead.  We have to keep using Sequence in the
        # nullable and optional cases because we don't want to leak the
        # AutoSequence type to consumers, which would be unavoidable with
        # Nullable<AutoSequence> or Optional<AutoSequence>.
        if (
            (isMember and isMember != "Union")
            or isOptional
            or nullable
            or isCallbackReturnValue
        ):
            sequenceClass = "Sequence"
        else:
            sequenceClass = "binding_detail::AutoSequence"

        # XXXbz we can't include the index in the sourceDescription, because
        # we don't really have a way to pass one in dynamically at runtime...
        elementInfo = getJSToNativeConversionInfo(
            elementType,
            descriptorProvider,
            isMember="Sequence",
            exceptionCode=exceptionCode,
            lenientFloatCode=lenientFloatCode,
            isCallbackReturnValue=isCallbackReturnValue,
            sourceDescription="element of %s" % sourceDescription,
            nestingLevel=incrementNestingLevel(),
        )
        if elementInfo.dealWithOptional:
            raise TypeError("Shouldn't have optional things in sequences")
        if elementInfo.holderType is not None:
            raise TypeError("Shouldn't need holders for sequences")

        typeName = CGTemplatedType(sequenceClass, elementInfo.declType)
        sequenceType = typeName.define()

        if isMember == "Union" and typeNeedsRooting(type):
            assert not nullable
            typeName = CGTemplatedType(
                "binding_detail::RootedAutoSequence", elementInfo.declType
            )
        elif nullable:
            typeName = CGTemplatedType("Nullable", typeName)

        if nullable:
            arrayRef = "${declName}.SetValue()"
        else:
            arrayRef = "${declName}"

        elementConversion = string.Template(elementInfo.template).substitute(
            {
                "val": "temp" + str(nestingLevel),
                "maybeMutableVal": "&temp" + str(nestingLevel),
                "declName": "slot" + str(nestingLevel),
                # We only need holderName here to handle isExternal()
                # interfaces, which use an internal holder for the
                # conversion even when forceOwningType ends up true.
                "holderName": "tempHolder" + str(nestingLevel),
                "passedToJSImpl": "${passedToJSImpl}",
            }
        )

        elementInitializer = initializerForType(elementType)
        if elementInitializer is None:
            elementInitializer = ""
        else:
            elementInitializer = elementInitializer + ", "

        # NOTE: Keep this in sync with variadic conversions as needed
        templateBody = fill(
            """
            JS::ForOfIterator iter${nestingLevel}(cx);
            if (!iter${nestingLevel}.init($${val}, JS::ForOfIterator::AllowNonIterable)) {
              $*{exceptionCode}
            }
            if (!iter${nestingLevel}.valueIsIterable()) {
              $*{notSequence}
            }
            ${sequenceType} &arr${nestingLevel} = ${arrayRef};
            JS::Rooted<JS::Value> temp${nestingLevel}(cx);
            while (true) {
              bool done${nestingLevel};
              if (!iter${nestingLevel}.next(&temp${nestingLevel}, &done${nestingLevel})) {
                $*{exceptionCode}
              }
              if (done${nestingLevel}) {
                break;
              }
              ${elementType}* slotPtr${nestingLevel} = arr${nestingLevel}.AppendElement(${elementInitializer}mozilla::fallible);
              if (!slotPtr${nestingLevel}) {
                JS_ReportOutOfMemory(cx);
                $*{exceptionCode}
              }
              ${elementType}& slot${nestingLevel} = *slotPtr${nestingLevel};
              $*{elementConversion}
            }
            """,
            exceptionCode=exceptionCode,
            notSequence=notSequence,
            sequenceType=sequenceType,
            arrayRef=arrayRef,
            elementType=elementInfo.declType.define(),
            elementConversion=elementConversion,
            elementInitializer=elementInitializer,
            nestingLevel=str(nestingLevel),
        )

        templateBody = wrapObjectTemplate(
            templateBody, type, "${declName}.SetNull();\n", notSequence
        )
        if isinstance(defaultValue, IDLEmptySequenceValue):
            if type.nullable():
                codeToSetEmpty = "${declName}.SetValue();\n"
            else:
                codeToSetEmpty = (
                    "/* ${declName} array is already empty; nothing to do */\n"
                )
            templateBody = handleDefault(templateBody, codeToSetEmpty)

        declArgs = None
        holderType = None
        holderArgs = None
        # Sequence arguments that might contain traceable things need
        # to get traced
        if typeNeedsRooting(elementType):
            if not isMember:
                holderType = CGTemplatedType("SequenceRooter", elementInfo.declType)
                # If our sequence is nullable, this will set the Nullable to be
                # not-null, but that's ok because we make an explicit SetNull() call
                # on it as needed if our JS value is actually null.
                holderArgs = "cx, &%s" % arrayRef
            elif isMember == "Union":
                declArgs = "cx"

        return JSToNativeConversionInfo(
            templateBody,
            declType=typeName,
            declArgs=declArgs,
            holderType=holderType,
            dealWithOptional=isOptional,
            holderArgs=holderArgs,
        )

    if type.isRecord():
        assert not isEnforceRange and not isClamp and not isAllowShared
        if failureCode is None:
            notRecord = 'cx.ThrowErrorMessage<MSG_NOT_OBJECT>("%s");\n' "%s" % (
                firstCap(sourceDescription),
                exceptionCode,
            )
        else:
            notRecord = failureCode

        nullable = type.nullable()
        # Be very careful not to change "type": we need it later
        if nullable:
            recordType = type.inner
        else:
            recordType = type
        valueType = recordType.inner

        valueInfo = getJSToNativeConversionInfo(
            valueType,
            descriptorProvider,
            isMember="Record",
            exceptionCode=exceptionCode,
            lenientFloatCode=lenientFloatCode,
            isCallbackReturnValue=isCallbackReturnValue,
            sourceDescription="value in %s" % sourceDescription,
            nestingLevel=incrementNestingLevel(),
        )
        if valueInfo.dealWithOptional:
            raise TypeError("Shouldn't have optional things in record")
        if valueInfo.holderType is not None:
            raise TypeError("Shouldn't need holders for record")

        declType = CGTemplatedType(
            "Record", [recordKeyDeclType(recordType), valueInfo.declType]
        )
        typeName = declType.define()

        if isMember == "Union" and typeNeedsRooting(type):
            assert not nullable
            declType = CGTemplatedType(
                "RootedRecord", [recordKeyDeclType(recordType), valueInfo.declType]
            )
        elif nullable:
            declType = CGTemplatedType("Nullable", declType)

        if nullable:
            recordRef = "${declName}.SetValue()"
        else:
            recordRef = "${declName}"

        valueConversion = string.Template(valueInfo.template).substitute(
            {
                "val": "temp",
                "maybeMutableVal": "&temp",
                "declName": "slot",
                # We only need holderName here to handle isExternal()
                # interfaces, which use an internal holder for the
                # conversion even when forceOwningType ends up true.
                "holderName": "tempHolder",
                "passedToJSImpl": "${passedToJSImpl}",
            }
        )

        keyType = recordKeyType(recordType)
        if recordType.keyType.isJSString():
            raise TypeError(
                "Have do deal with JSString record type, but don't know how"
            )
        if recordType.keyType.isByteString() or recordType.keyType.isUTF8String():
            hashKeyType = "nsCStringHashKey"
            if recordType.keyType.isByteString():
                keyConversionFunction = "ConvertJSValueToByteString"
            else:
                keyConversionFunction = "ConvertJSValueToString"

        else:
            hashKeyType = "nsStringHashKey"
            if recordType.keyType.isDOMString():
                keyConversionFunction = "ConvertJSValueToString"
            else:
                assert recordType.keyType.isUSVString()
                keyConversionFunction = "ConvertJSValueToUSVString"

        templateBody = fill(
            """
            auto& recordEntries = ${recordRef}.Entries();

            JS::Rooted<JSObject*> recordObj(cx, &$${val}.toObject());
            JS::RootedVector<jsid> ids(cx);
            if (!js::GetPropertyKeys(cx, recordObj,
                                     JSITER_OWNONLY | JSITER_HIDDEN | JSITER_SYMBOLS, &ids)) {
              $*{exceptionCode}
            }
            if (!recordEntries.SetCapacity(ids.length(), mozilla::fallible)) {
              JS_ReportOutOfMemory(cx);
              $*{exceptionCode}
            }
            JS::Rooted<JS::Value> propNameValue(cx);
            JS::Rooted<JS::Value> temp(cx);
            JS::Rooted<jsid> curId(cx);
            JS::Rooted<JS::Value> idVal(cx);
            // Use a hashset to keep track of ids seen, to avoid
            // introducing nasty O(N^2) behavior scanning for them all the
            // time.  Ideally we'd use a data structure with O(1) lookup
            // _and_ ordering for the MozMap, but we don't have one lying
            // around.
            nsTHashtable<${hashKeyType}> idsSeen;
            for (size_t i = 0; i < ids.length(); ++i) {
              curId = ids[i];

              JS::Rooted<mozilla::Maybe<JS::PropertyDescriptor>> desc(cx);
              if (!JS_GetOwnPropertyDescriptorById(cx, recordObj, curId,
                                                   &desc)) {
                $*{exceptionCode}
              }

              if (desc.isNothing() || !desc->enumerable()) {
                continue;
              }

              idVal = js::IdToValue(curId);
              ${keyType} propName;
              // This will just throw if idVal is a Symbol, like the spec says
              // to do.
              if (!${keyConversionFunction}(cx, idVal, "key of ${sourceDescription}", propName)) {
                $*{exceptionCode}
              }

              if (!JS_GetPropertyById(cx, recordObj, curId, &temp)) {
                $*{exceptionCode}
              }

              ${typeName}::EntryType* entry;
              if (!idsSeen.EnsureInserted(propName)) {
                // Find the existing entry.
                auto idx = recordEntries.IndexOf(propName);
                MOZ_ASSERT(idx != recordEntries.NoIndex,
                           "Why is it not found?");
                // Now blow it away to make it look like it was just added
                // to the array, because it's not obvious that it's
                // safe to write to its already-initialized mValue via our
                // normal codegen conversions.  For example, the value
                // could be a union and this would change its type, but
                // codegen assumes we won't do that.
                entry = recordEntries.ReconstructElementAt(idx);
              } else {
                // Safe to do an infallible append here, because we did a
                // SetCapacity above to the right capacity.
                entry = recordEntries.AppendElement();
              }
              entry->mKey = propName;
              ${valueType}& slot = entry->mValue;
              $*{valueConversion}
            }
            """,
            exceptionCode=exceptionCode,
            recordRef=recordRef,
            hashKeyType=hashKeyType,
            keyType=keyType,
            keyConversionFunction=keyConversionFunction,
            sourceDescription=sourceDescription,
            typeName=typeName,
            valueType=valueInfo.declType.define(),
            valueConversion=valueConversion,
        )

        templateBody = wrapObjectTemplate(
            templateBody, type, "${declName}.SetNull();\n", notRecord
        )

        declArgs = None
        holderType = None
        holderArgs = None
        # record arguments that might contain traceable things need
        # to get traced
        if not isMember and isCallbackReturnValue:
            # Go ahead and just convert directly into our actual return value
            declType = CGWrapper(declType, post="&")
            declArgs = "aRetVal"
        elif typeNeedsRooting(valueType):
            if not isMember:
                holderType = CGTemplatedType(
                    "RecordRooter", [recordKeyDeclType(recordType), valueInfo.declType]
                )
                # If our record is nullable, this will set the Nullable to be
                # not-null, but that's ok because we make an explicit SetNull() call
                # on it as needed if our JS value is actually null.
                holderArgs = "cx, &%s" % recordRef
            elif isMember == "Union":
                declArgs = "cx"

        return JSToNativeConversionInfo(
            templateBody,
            declType=declType,
            declArgs=declArgs,
            holderType=holderType,
            dealWithOptional=isOptional,
            holderArgs=holderArgs,
        )

    if type.isUnion():
        nullable = type.nullable()
        if nullable:
            type = type.inner

        isOwningUnion = (isMember and isMember != "Union") or isCallbackReturnValue
        unionArgumentObj = "${declName}"
        if nullable:
            if isOptional and not isOwningUnion:
                unionArgumentObj += ".Value()"
            # If we're owning, we're a Nullable, which hasn't been told it has
            # a value.  Otherwise we're an already-constructed Maybe.
            unionArgumentObj += ".SetValue()"

        templateBody = CGIfWrapper(
            CGGeneric(exceptionCode),
            '!%s.Init(cx, ${val}, "%s", ${passedToJSImpl})'
            % (unionArgumentObj, firstCap(sourceDescription)),
        )

        if type.hasNullableType:
            assert not nullable
            # Make sure to handle a null default value here
            if defaultValue and isinstance(defaultValue, IDLNullValue):
                assert defaultValue.type == type
                templateBody = CGIfElseWrapper(
                    "!(${haveValue})",
                    CGGeneric("%s.SetNull();\n" % unionArgumentObj),
                    templateBody,
                )

        typeName = CGUnionStruct.unionTypeDecl(type, isOwningUnion)
        argumentTypeName = typeName + "Argument"
        if nullable:
            typeName = "Nullable<" + typeName + " >"

        declType = CGGeneric(typeName)
        if isOwningUnion:
            holderType = None
        else:
            holderType = CGGeneric(argumentTypeName)
            if nullable:
                holderType = CGTemplatedType("Maybe", holderType)

        # If we're isOptional and not nullable the normal optional handling will
        # handle lazy construction of our holder.  If we're nullable and not
        # owning we do it all by hand because we do not want our holder
        # constructed if we're null.  But if we're owning we don't have a
        # holder anyway, so we can do the normal Optional codepath.
        declLoc = "${declName}"
        constructDecl = None
        if nullable:
            if isOptional and not isOwningUnion:
                declType = CGTemplatedType("Optional", declType)
                constructDecl = CGGeneric("${declName}.Construct();\n")
                declLoc = "${declName}.Value()"

        if not isMember and isCallbackReturnValue:
            declType = CGWrapper(declType, post="&")
            declArgs = "aRetVal"
        else:
            declArgs = None

        if (
            defaultValue
            and not isinstance(defaultValue, IDLNullValue)
            and not isinstance(defaultValue, IDLDefaultDictionaryValue)
        ):
            tag = defaultValue.type.tag()

            if tag in numericSuffixes or tag is IDLType.Tags.bool:
                defaultStr = getHandleDefault(defaultValue)
                # Make sure we actually construct the thing inside the nullable.
                value = declLoc + (".SetValue()" if nullable else "")
                name = getUnionMemberName(defaultValue.type)
                default = CGGeneric(
                    "%s.RawSetAs%s() = %s;\n" % (value, name, defaultStr)
                )
            elif isinstance(defaultValue, IDLEmptySequenceValue):
                name = getUnionMemberName(defaultValue.type)
                # Make sure we actually construct the thing inside the nullable.
                value = declLoc + (".SetValue()" if nullable else "")
                if not isOwningUnion and typeNeedsRooting(defaultValue.type):
                    ctorArgs = "cx"
                else:
                    ctorArgs = ""
                # It's enough to set us to the right type; that will
                # create an empty array, which is all we need here.
                default = CGGeneric("%s.RawSetAs%s(%s);\n" % (value, name, ctorArgs))
            elif defaultValue.type.isEnum():
                name = getUnionMemberName(defaultValue.type)
                # Make sure we actually construct the thing inside the nullable.
                value = declLoc + (".SetValue()" if nullable else "")
                default = CGGeneric(
                    "%s.RawSetAs%s() = %s::%s;\n"
                    % (
                        value,
                        name,
                        defaultValue.type.inner.identifier.name,
                        getEnumValueName(defaultValue.value),
                    )
                )
            else:
                default = CGGeneric(
                    handleDefaultStringValue(
                        defaultValue, "%s.SetStringLiteral" % unionArgumentObj
                    )
                )

            templateBody = CGIfElseWrapper("!(${haveValue})", default, templateBody)

        if nullable:
            assert not type.hasNullableType
            if defaultValue:
                if isinstance(defaultValue, IDLNullValue):
                    extraConditionForNull = "!(${haveValue}) || "
                else:
                    extraConditionForNull = "(${haveValue}) && "
            else:
                extraConditionForNull = ""

            hasUndefinedType = any(t.isUndefined() for t in type.flatMemberTypes)
            assert not hasUndefinedType or defaultValue is None

            nullTest = (
                "${val}.isNull()" if hasUndefinedType else "${val}.isNullOrUndefined()"
            )
            templateBody = CGIfElseWrapper(
                extraConditionForNull + nullTest,
                CGGeneric("%s.SetNull();\n" % declLoc),
                templateBody,
            )
        elif (
            not type.hasNullableType
            and defaultValue
            and isinstance(defaultValue, IDLDefaultDictionaryValue)
        ):
            assert type.hasDictionaryType()
            assert defaultValue.type.isDictionary()
            if not isOwningUnion and typeNeedsRooting(defaultValue.type):
                ctorArgs = "cx"
            else:
                ctorArgs = ""
            initDictionaryWithNull = CGIfWrapper(
                CGGeneric("return false;\n"),
                (
                    '!%s.RawSetAs%s(%s).Init(cx, JS::NullHandleValue, "Member of %s")'
                    % (
                        declLoc,
                        getUnionMemberName(defaultValue.type),
                        ctorArgs,
                        type.prettyName(),
                    )
                ),
            )
            templateBody = CGIfElseWrapper(
                "!(${haveValue})", initDictionaryWithNull, templateBody
            )

        templateBody = CGList([constructDecl, templateBody])

        return JSToNativeConversionInfo(
            templateBody.define(),
            declType=declType,
            declArgs=declArgs,
            dealWithOptional=isOptional and (not nullable or isOwningUnion),
        )

    if type.isPromise():
        assert not type.nullable()
        assert defaultValue is None

        # We always have to hold a strong ref to Promise here, because
        # Promise::resolve returns an addrefed thing.
        argIsPointer = isCallbackReturnValue
        if argIsPointer:
            declType = CGGeneric("RefPtr<Promise>")
        else:
            declType = CGGeneric("OwningNonNull<Promise>")

        # Per spec, what we're supposed to do is take the original
        # Promise.resolve and call it with the original Promise as this
        # value to make a Promise out of whatever value we actually have
        # here.  The question is which global we should use.  There are
        # several cases to consider:
        #
        # 1) Normal call to API with a Promise argument.  This is a case the
        #    spec covers, and we should be using the current Realm's
        #    Promise.  That means the current compartment.
        # 2) Call to API with a Promise argument over Xrays.  In practice,
        #    this sort of thing seems to be used for giving an API
        #    implementation a way to wait for conclusion of an asyc
        #    operation, _not_ to expose the Promise to content code.  So we
        #    probably want to allow callers to use such an API in a
        #    "natural" way, by passing chrome-side promises; indeed, that
        #    may be all that the caller has to represent their async
        #    operation.  That means we really need to do the
        #    Promise.resolve() in the caller (chrome) compartment: if we do
        #    it in the content compartment, we will try to call .then() on
        #    the chrome promise while in the content compartment, which will
        #    throw and we'll just get a rejected Promise.  Note that this is
        #    also the reason why a caller who has a chrome Promise
        #    representing an async operation can't itself convert it to a
        #    content-side Promise (at least not without some serious
        #    gyrations).
        # 3) Promise return value from a callback or callback interface.
        #    Per spec, this should use the Realm of the callback object.  In
        #    our case, that's the compartment of the underlying callback,
        #    not the current compartment (which may be the compartment of
        #    some cross-compartment wrapper around said callback).
        # 4) Return value from a JS-implemented interface.  In this case we
        #    have a problem.  Our current compartment is the compartment of
        #    the JS implementation.  But if the JS implementation returned
        #    a page-side Promise (which is a totally sane thing to do, and
        #    in fact the right thing to do given that this return value is
        #    going right to content script) then we don't want to
        #    Promise.resolve with our current compartment Promise, because
        #    that will wrap it up in a chrome-side Promise, which is
        #    decidedly _not_ what's desired here.  So in that case we
        #    should really unwrap the return value and use the global of
        #    the result.  CheckedUnwrapStatic should be good enough for that;
        #    if it fails, then we're failing unwrap while in a
        #    system-privileged compartment, so presumably we have a dead
        #    object wrapper.  Just error out.  Do NOT fall back to using
        #    the current compartment instead: that will return a
        #    system-privileged rejected (because getting .then inside
        #    resolve() failed) Promise to the caller, which they won't be
        #    able to touch.  That's not helpful.  If we error out, on the
        #    other hand, they will get a content-side rejected promise.
        #    Same thing if the value returned is not even an object.
        if isCallbackReturnValue == "JSImpl":
            # Case 4 above.  Note that globalObj defaults to the current
            # compartment global.  Note that we don't use $*{exceptionCode}
            # here because that will try to aRv.Throw(NS_ERROR_UNEXPECTED)
            # which we don't really want here.
            assert exceptionCode == "aRv.Throw(NS_ERROR_UNEXPECTED);\nreturn nullptr;\n"
            getPromiseGlobal = fill(
                """
                if (!$${val}.isObject()) {
                  aRv.ThrowTypeError<MSG_NOT_OBJECT>("${sourceDescription}");
                  return nullptr;
                }
                JSObject* unwrappedVal = js::CheckedUnwrapStatic(&$${val}.toObject());
                if (!unwrappedVal) {
                  // A slight lie, but not much of one, for a dead object wrapper.
                  aRv.ThrowTypeError<MSG_NOT_OBJECT>("${sourceDescription}");
                  return nullptr;
                }
                globalObj = JS::GetNonCCWObjectGlobal(unwrappedVal);
                """,
                sourceDescription=sourceDescription,
            )
        elif isCallbackReturnValue == "Callback":
            getPromiseGlobal = dedent(
                """
                // We basically want our entry global here.  Play it safe
                // and use GetEntryGlobal() to get it, with whatever
                // principal-clamping it ends up doing.
                globalObj = GetEntryGlobal()->GetGlobalJSObject();
                """
            )
        else:
            getPromiseGlobal = dedent(
                """
                globalObj = JS::CurrentGlobalOrNull(cx);
                """
            )

        templateBody = fill(
            """
            { // Scope for our GlobalObject, FastErrorResult, JSAutoRealm,
              // etc.

              JS::Rooted<JSObject*> globalObj(cx);
              $*{getPromiseGlobal}
              JSAutoRealm ar(cx, globalObj);
              GlobalObject promiseGlobal(cx, globalObj);
              if (promiseGlobal.Failed()) {
                $*{exceptionCode}
              }

              JS::Rooted<JS::Value> valueToResolve(cx, $${val});
              if (!JS_WrapValue(cx, &valueToResolve)) {
                $*{exceptionCode}
              }
              binding_detail::FastErrorResult promiseRv;
              nsCOMPtr<nsIGlobalObject> global =
                do_QueryInterface(promiseGlobal.GetAsSupports());
              if (!global) {
                promiseRv.Throw(NS_ERROR_UNEXPECTED);
                MOZ_ALWAYS_TRUE(promiseRv.MaybeSetPendingException(cx));
                $*{exceptionCode}
              }
              $${declName} = Promise::Resolve(global, cx, valueToResolve,
                                              promiseRv);
              if (promiseRv.MaybeSetPendingException(cx)) {
                $*{exceptionCode}
              }
            }
            """,
            getPromiseGlobal=getPromiseGlobal,
            exceptionCode=exceptionCode,
        )

        return JSToNativeConversionInfo(
            templateBody, declType=declType, dealWithOptional=isOptional
        )

    if type.isGeckoInterface():
        assert not isEnforceRange and not isClamp and not isAllowShared

        descriptor = descriptorProvider.getDescriptor(
            type.unroll().inner.identifier.name
        )

        assert descriptor.nativeType != "JSObject"

        if descriptor.interface.isCallback():
            (declType, declArgs, conversion) = getCallbackConversionInfo(
                type, descriptor.interface, isMember, isCallbackReturnValue, isOptional
            )
            template = wrapObjectTemplate(
                conversion, type, "${declName} = nullptr;\n", failureCode
            )
            return JSToNativeConversionInfo(
                template,
                declType=declType,
                declArgs=declArgs,
                dealWithOptional=isOptional,
            )

        if descriptor.interface.identifier.name == "WindowProxy":
            declType = CGGeneric("mozilla::dom::WindowProxyHolder")
            if type.nullable():
                declType = CGTemplatedType("Nullable", declType)
                windowProxyHolderRef = "${declName}.SetValue()"
            else:
                windowProxyHolderRef = "${declName}"

            failureCode = onFailureBadType(
                failureCode, descriptor.interface.identifier.name
            ).define()
            templateBody = fill(
                """
                JS::Rooted<JSObject*> source(cx, &$${val}.toObject());
                if (NS_FAILED(UnwrapWindowProxyArg(cx, source, ${windowProxyHolderRef}))) {
                    $*{onFailure}
                }
                """,
                windowProxyHolderRef=windowProxyHolderRef,
                onFailure=failureCode,
            )
            templateBody = wrapObjectTemplate(
                templateBody, type, "${declName}.SetNull();\n", failureCode
            )
            return JSToNativeConversionInfo(
                templateBody, declType=declType, dealWithOptional=isOptional
            )

        # This is an interface that we implement as a concrete class
        # or an XPCOM interface.

        # Allow null pointers for nullable types and old-binding classes, and
        # use an RefPtr or raw pointer for callback return values to make
        # them easier to return.
        argIsPointer = (
            type.nullable() or type.unroll().inner.isExternal() or isCallbackReturnValue
        )

        # Sequence and dictionary members, as well as owning unions (which can
        # appear here as return values in JS-implemented interfaces) have to
        # hold a strong ref to the thing being passed down.  Those all set
        # isMember.
        #
        # Also, callback return values always end up addrefing anyway, so there
        # is no point trying to avoid it here and it makes other things simpler
        # since we can assume the return value is a strong ref.
        assert not descriptor.interface.isCallback()
        forceOwningType = (isMember and isMember != "Union") or isCallbackReturnValue

        typeName = descriptor.nativeType
        typePtr = typeName + "*"

        # Compute a few things:
        #  - declType is the type we want to return as the first element of our
        #    tuple.
        #  - holderType is the type we want to return as the third element
        #    of our tuple.

        # Set up some sensible defaults for these things insofar as we can.
        holderType = None
        if argIsPointer:
            if forceOwningType:
                declType = "RefPtr<" + typeName + ">"
            else:
                declType = typePtr
        else:
            if forceOwningType:
                declType = "OwningNonNull<" + typeName + ">"
            else:
                declType = "NonNull<" + typeName + ">"

        templateBody = ""
        if forceOwningType:
            templateBody += fill(
                """
                static_assert(IsRefcounted<${typeName}>::value, "We can only store refcounted classes.");
                """,
                typeName=typeName,
            )

        if not descriptor.interface.isExternal():
            if failureCode is not None:
                templateBody += str(
                    CastableObjectUnwrapper(
                        descriptor,
                        "${val}",
                        "${maybeMutableVal}",
                        "${declName}",
                        failureCode,
                    )
                )
            else:
                templateBody += str(
                    FailureFatalCastableObjectUnwrapper(
                        descriptor,
                        "${val}",
                        "${maybeMutableVal}",
                        "${declName}",
                        exceptionCode,
                        isCallbackReturnValue,
                        firstCap(sourceDescription),
                    )
                )
        else:
            # External interface.  We always have a holder for these, because we
            # don't actually know whether we have to addref when unwrapping or not.
            # So we just pass an getter_AddRefs(RefPtr) to XPConnect and if we'll
            # need a release it'll put a non-null pointer in there.
            if forceOwningType:
                # Don't return a holderType in this case; our declName
                # will just own stuff.
                templateBody += "RefPtr<" + typeName + "> ${holderName};\n"
            else:
                holderType = "RefPtr<" + typeName + ">"
            templateBody += (
                "JS::Rooted<JSObject*> source(cx, &${val}.toObject());\n"
                + "if (NS_FAILED(UnwrapArg<"
                + typeName
                + ">(cx, source, getter_AddRefs(${holderName})))) {\n"
            )
            templateBody += CGIndenter(
                onFailureBadType(failureCode, descriptor.interface.identifier.name)
            ).define()
            templateBody += "}\n" "MOZ_ASSERT(${holderName});\n"

            # And store our value in ${declName}
            templateBody += "${declName} = ${holderName};\n"

        # Just pass failureCode, not onFailureBadType, here, so we'll report
        # the thing as not an object as opposed to not implementing whatever
        # our interface is.
        templateBody = wrapObjectTemplate(
            templateBody, type, "${declName} = nullptr;\n", failureCode
        )

        declType = CGGeneric(declType)
        if holderType is not None:
            holderType = CGGeneric(holderType)
        return JSToNativeConversionInfo(
            templateBody,
            declType=declType,
            holderType=holderType,
            dealWithOptional=isOptional,
        )

    if type.isSpiderMonkeyInterface():
        assert not isEnforceRange and not isClamp
        name = type.unroll().name  # unroll() because it may be nullable
        interfaceType = CGGeneric(name)
        declType = interfaceType
        if type.nullable():
            declType = CGTemplatedType("Nullable", declType)
            objRef = "${declName}.SetValue()"
        else:
            objRef = "${declName}"

        # Again, this is a bit strange since we are actually building a
        # template string here. ${objRef} and $*{badType} below are filled in
        # right now; $${val} expands to ${val}, to be filled in later.
        template = fill(
            """
            if (!${objRef}.Init(&$${val}.toObject())) {
              $*{badType}
            }
            """,
            objRef=objRef,
            badType=onFailureBadType(failureCode, type.name).define(),
        )
        if type.isBufferSource():
            if type.isArrayBuffer():
                isSharedMethod = "JS::IsSharedArrayBufferObject"
                isLargeMethod = "JS::IsLargeArrayBufferMaybeShared"
            else:
                assert type.isArrayBufferView() or type.isTypedArray()
                isSharedMethod = "JS::IsArrayBufferViewShared"
                isLargeMethod = "JS::IsLargeArrayBufferView"
            if not isAllowShared:
                template += fill(
                    """
                    if (${isSharedMethod}(${objRef}.Obj())) {
                      $*{badType}
                    }
                    """,
                    isSharedMethod=isSharedMethod,
                    objRef=objRef,
                    badType=onFailureIsShared().define(),
                )
            # For now reject large (> 2 GB) ArrayBuffers and ArrayBufferViews.
            # Supporting this will require changing dom::TypedArray and
            # consumers.
            template += fill(
                """
                if (${isLargeMethod}(${objRef}.Obj())) {
                  $*{badType}
                }
                """,
                isLargeMethod=isLargeMethod,
                objRef=objRef,
                badType=onFailureIsLarge().define(),
            )
        template = wrapObjectTemplate(
            template, type, "${declName}.SetNull();\n", failureCode
        )
        if not isMember or isMember == "Union":
            # This is a bit annoying.  In a union we don't want to have a
            # holder, since unions don't support that.  But if we're optional we
            # want to have a holder, so that the callee doesn't see
            # Optional<RootedSpiderMonkeyInterface<InterfaceType>>.  So do a
            # holder if we're optional and use a RootedSpiderMonkeyInterface
            # otherwise.
            if isOptional:
                holderType = CGTemplatedType(
                    "SpiderMonkeyInterfaceRooter", interfaceType
                )
                # If our SpiderMonkey interface is nullable, this will set the
                # Nullable to be not-null, but that's ok because we make an
                # explicit SetNull() call on it as needed if our JS value is
                # actually null.  XXXbz Because "Maybe" takes const refs for
                # constructor arguments, we can't pass a reference here; have
                # to pass a pointer.
                holderArgs = "cx, &%s" % objRef
                declArgs = None
            else:
                holderType = None
                holderArgs = None
                declType = CGTemplatedType("RootedSpiderMonkeyInterface", declType)
                declArgs = "cx"
        else:
            holderType = None
            holderArgs = None
            declArgs = None
        return JSToNativeConversionInfo(
            template,
            declType=declType,
            holderType=holderType,
            dealWithOptional=isOptional,
            declArgs=declArgs,
            holderArgs=holderArgs,
        )

    if type.isJSString():
        assert not isEnforceRange and not isClamp and not isAllowShared
        if type.nullable():
            raise TypeError("Nullable JSString not supported")

        declArgs = "cx"
        if isMember:
            raise TypeError("JSString not supported as member")
        else:
            declType = "JS::Rooted<JSString*>"

        if isOptional:
            raise TypeError("JSString not supported as optional")
        templateBody = fill(
            """
                if (!($${declName} = ConvertJSValueToJSString(cx, $${val}))) {
                  $*{exceptionCode}
                }
                """,
            exceptionCode=exceptionCode,
        )

        if defaultValue is not None:
            assert not isinstance(defaultValue, IDLNullValue)
            defaultCode = fill(
                """
                static const char data[] = { ${data} };
                $${declName} = JS_NewStringCopyN(cx, data, ArrayLength(data) - 1);
                if (!$${declName}) {
                    $*{exceptionCode}
                }
                """,
                data=", ".join(
                    ["'" + char + "'" for char in defaultValue.value] + ["0"]
                ),
                exceptionCode=exceptionCode,
            )

            templateBody = handleDefault(templateBody, defaultCode)
        return JSToNativeConversionInfo(
            templateBody, declType=CGGeneric(declType), declArgs=declArgs
        )

    if type.isDOMString() or type.isUSVString() or type.isUTF8String():
        assert not isEnforceRange and not isClamp and not isAllowShared

        treatAs = {
            "Default": "eStringify",
            "EmptyString": "eEmpty",
            "Null": "eNull",
        }
        if type.nullable():
            # For nullable strings null becomes a null string.
            treatNullAs = "Null"
            # For nullable strings undefined also becomes a null string.
            undefinedBehavior = "eNull"
        else:
            undefinedBehavior = "eStringify"
            if type.legacyNullToEmptyString:
                treatNullAs = "EmptyString"
            else:
                treatNullAs = "Default"
        nullBehavior = treatAs[treatNullAs]

        def getConversionCode(varName):
            normalizeCode = ""
            if type.isUSVString():
                normalizeCode = fill(
                    """
                    if (!NormalizeUSVString(${var})) {
                      JS_ReportOutOfMemory(cx);
                      $*{exceptionCode}
                    }
                    """,
                    var=varName,
                    exceptionCode=exceptionCode,
                )

            conversionCode = fill(
                """
                if (!ConvertJSValueToString(cx, $${val}, ${nullBehavior}, ${undefinedBehavior}, ${varName})) {
                  $*{exceptionCode}
                }
                $*{normalizeCode}
                """,
                nullBehavior=nullBehavior,
                undefinedBehavior=undefinedBehavior,
                varName=varName,
                exceptionCode=exceptionCode,
                normalizeCode=normalizeCode,
            )

            if defaultValue is None:
                return conversionCode

            if isinstance(defaultValue, IDLNullValue):
                assert type.nullable()
                defaultCode = "%s.SetIsVoid(true);\n" % varName
            else:
                defaultCode = handleDefaultStringValue(
                    defaultValue, "%s.AssignLiteral" % varName
                )
            return handleDefault(conversionCode, defaultCode)

        if isMember and isMember != "Union":
            # Convert directly into the ns[C]String member we have.
            if type.isUTF8String():
                declType = "nsCString"
            else:
                declType = "nsString"
            return JSToNativeConversionInfo(
                getConversionCode("${declName}"),
                declType=CGGeneric(declType),
                dealWithOptional=isOptional,
            )

        if isOptional:
            if type.isUTF8String():
                declType = "Optional<nsACString>"
                holderType = CGGeneric("binding_detail::FakeString<char>")
            else:
                declType = "Optional<nsAString>"
                holderType = CGGeneric("binding_detail::FakeString<char16_t>")
            conversionCode = "%s" "${declName} = &${holderName};\n" % getConversionCode(
                "${holderName}"
            )
        else:
            if type.isUTF8String():
                declType = "binding_detail::FakeString<char>"
            else:
                declType = "binding_detail::FakeString<char16_t>"
            holderType = None
            conversionCode = getConversionCode("${declName}")

        # No need to deal with optional here; we handled it already
        return JSToNativeConversionInfo(
            conversionCode, declType=CGGeneric(declType), holderType=holderType
        )

    if type.isByteString():
        assert not isEnforceRange and not isClamp and not isAllowShared

        nullable = toStringBool(type.nullable())

        conversionCode = fill(
            """
            if (!ConvertJSValueToByteString(cx, $${val}, ${nullable}, "${sourceDescription}", $${declName})) {
              $*{exceptionCode}
            }
            """,
            nullable=nullable,
            sourceDescription=sourceDescription,
            exceptionCode=exceptionCode,
        )

        if defaultValue is not None:
            if isinstance(defaultValue, IDLNullValue):
                assert type.nullable()
                defaultCode = "${declName}.SetIsVoid(true);\n"
            else:
                defaultCode = handleDefaultStringValue(
                    defaultValue, "${declName}.AssignLiteral"
                )
            conversionCode = handleDefault(conversionCode, defaultCode)

        return JSToNativeConversionInfo(
            conversionCode, declType=CGGeneric("nsCString"), dealWithOptional=isOptional
        )

    if type.isEnum():
        assert not isEnforceRange and not isClamp and not isAllowShared

        enumName = type.unroll().inner.identifier.name
        declType = CGGeneric(enumName)
        if type.nullable():
            declType = CGTemplatedType("Nullable", declType)
            declType = declType.define()
            enumLoc = "${declName}.SetValue()"
        else:
            enumLoc = "${declName}"
            declType = declType.define()

        if invalidEnumValueFatal:
            handleInvalidEnumValueCode = "MOZ_ASSERT(index >= 0);\n"
        else:
            # invalidEnumValueFatal is false only for attributes.  So we won't
            # have a non-default exceptionCode here unless attribute "arg
            # conversion" code starts passing in an exceptionCode.  At which
            # point we'll need to figure out what that even means.
            assert exceptionCode == "return false;\n"
            handleInvalidEnumValueCode = dedent(
                """
                if (index < 0) {
                  return true;
                }
                """
            )

        template = fill(
            """
            {
              int index;
              if (!FindEnumStringIndex<${invalidEnumValueFatal}>(cx, $${val}, ${values}, "${enumtype}", "${sourceDescription}", &index)) {
                $*{exceptionCode}
              }
              $*{handleInvalidEnumValueCode}
              ${enumLoc} = static_cast<${enumtype}>(index);
            }
            """,
            enumtype=enumName,
            values=enumName + "Values::" + ENUM_ENTRY_VARIABLE_NAME,
            invalidEnumValueFatal=toStringBool(invalidEnumValueFatal),
            handleInvalidEnumValueCode=handleInvalidEnumValueCode,
            exceptionCode=exceptionCode,
            enumLoc=enumLoc,
            sourceDescription=sourceDescription,
        )

        setNull = "${declName}.SetNull();\n"

        if type.nullable():
            template = CGIfElseWrapper(
                "${val}.isNullOrUndefined()", CGGeneric(setNull), CGGeneric(template)
            ).define()

        if defaultValue is not None:
            if isinstance(defaultValue, IDLNullValue):
                assert type.nullable()
                template = handleDefault(template, setNull)
            else:
                assert defaultValue.type.tag() == IDLType.Tags.domstring
                template = handleDefault(
                    template,
                    (
                        "%s = %s::%s;\n"
                        % (enumLoc, enumName, getEnumValueName(defaultValue.value))
                    ),
                )
        return JSToNativeConversionInfo(
            template, declType=CGGeneric(declType), dealWithOptional=isOptional
        )

    if type.isCallback():
        assert not isEnforceRange and not isClamp and not isAllowShared
        assert not type.treatNonCallableAsNull() or type.nullable()
        assert not type.treatNonObjectAsNull() or type.nullable()
        assert not type.treatNonObjectAsNull() or not type.treatNonCallableAsNull()

        callback = type.unroll().callback
        name = callback.identifier.name
        (declType, declArgs, conversion) = getCallbackConversionInfo(
            type, callback, isMember, isCallbackReturnValue, isOptional
        )

        if allowTreatNonCallableAsNull and type.treatNonCallableAsNull():
            haveCallable = "JS::IsCallable(&${val}.toObject())"
            if not isDefinitelyObject:
                haveCallable = "${val}.isObject() && " + haveCallable
            if defaultValue is not None:
                assert isinstance(defaultValue, IDLNullValue)
                haveCallable = "(${haveValue}) && " + haveCallable
            template = (
                ("if (%s) {\n" % haveCallable) + conversion + "} else {\n"
                "  ${declName} = nullptr;\n"
                "}\n"
            )
        elif allowTreatNonCallableAsNull and type.treatNonObjectAsNull():
            if not isDefinitelyObject:
                haveObject = "${val}.isObject()"
                if defaultValue is not None:
                    assert isinstance(defaultValue, IDLNullValue)
                    haveObject = "(${haveValue}) && " + haveObject
                template = CGIfElseWrapper(
                    haveObject,
                    CGGeneric(conversion),
                    CGGeneric("${declName} = nullptr;\n"),
                ).define()
            else:
                template = conversion
        else:
            template = wrapObjectTemplate(
                "if (JS::IsCallable(&${val}.toObject())) {\n"
                + conversion
                + "} else {\n"
                + indent(onFailureNotCallable(failureCode).define())
                + "}\n",
                type,
                "${declName} = nullptr;\n",
                failureCode,
            )
        return JSToNativeConversionInfo(
            template, declType=declType, declArgs=declArgs, dealWithOptional=isOptional
        )

    if type.isAny():
        assert not isEnforceRange and not isClamp and not isAllowShared

        declArgs = None
        if isMember in ("Variadic", "Sequence", "Dictionary", "Record"):
            # Rooting is handled by the sequence and dictionary tracers.
            declType = "JS::Value"
        else:
            assert not isMember
            declType = "JS::Rooted<JS::Value>"
            declArgs = "cx"

        assert not isOptional
        templateBody = "${declName} = ${val};\n"

        # For JS-implemented APIs, we refuse to allow passing objects that the
        # API consumer does not subsume. The extra parens around
        # ($${passedToJSImpl}) suppress unreachable code warnings when
        # $${passedToJSImpl} is the literal `false`.  But Apple is shipping a
        # buggy clang (clang 3.9) in Xcode 8.3, so there even the parens are not
        # enough.  So we manually disable some warnings in clang.
        if (
            not isinstance(descriptorProvider, Descriptor)
            or descriptorProvider.interface.isJSImplemented()
        ):
            templateBody = (
                fill(
                    """
                #ifdef __clang__
                #pragma clang diagnostic push
                #pragma clang diagnostic ignored "-Wunreachable-code"
                #pragma clang diagnostic ignored "-Wunreachable-code-return"
                #endif // __clang__
                if (($${passedToJSImpl}) && !CallerSubsumes($${val})) {
                  cx.ThrowErrorMessage<MSG_PERMISSION_DENIED_TO_PASS_ARG>("${sourceDescription}");
                  $*{exceptionCode}
                }
                #ifdef __clang__
                #pragma clang diagnostic pop
                #endif // __clang__
                """,
                    sourceDescription=sourceDescription,
                    exceptionCode=exceptionCode,
                )
                + templateBody
            )

        # We may not have a default value if we're being converted for
        # a setter, say.
        if defaultValue:
            if isinstance(defaultValue, IDLNullValue):
                defaultHandling = "${declName} = JS::NullValue();\n"
            else:
                assert isinstance(defaultValue, IDLUndefinedValue)
                defaultHandling = "${declName} = JS::UndefinedValue();\n"
            templateBody = handleDefault(templateBody, defaultHandling)
        return JSToNativeConversionInfo(
            templateBody, declType=CGGeneric(declType), declArgs=declArgs
        )

    if type.isObject():
        assert not isEnforceRange and not isClamp and not isAllowShared
        return handleJSObjectType(
            type, isMember, failureCode, exceptionCode, sourceDescription
        )

    if type.isDictionary():
        # There are no nullable dictionary-typed arguments or dictionary-typed
        # dictionary members.
        assert (
            not type.nullable()
            or isCallbackReturnValue
            or (isMember and isMember != "Dictionary")
        )
        # All optional dictionary-typed arguments always have default values,
        # but dictionary-typed dictionary members can be optional.
        assert not isOptional or isMember == "Dictionary"
        # In the callback return value case we never have to worry
        # about a default value; we always have a value.
        assert not isCallbackReturnValue or defaultValue is None

        typeName = CGDictionary.makeDictionaryName(type.unroll().inner)
        if (not isMember or isMember == "Union") and not isCallbackReturnValue:
            # Since we're not a member and not nullable or optional, no one will
            # see our real type, so we can do the fast version of the dictionary
            # that doesn't pre-initialize members.
            typeName = "binding_detail::Fast" + typeName

        declType = CGGeneric(typeName)

        # We do manual default value handling here, because we actually do want
        # a jsval, and we only handle the default-dictionary case (which we map
        # into initialization with the JS value `null`) anyway
        # NOTE: if isNullOrUndefined or isDefinitelyObject are true,
        # we know we have a value, so we don't have to worry about the
        # default value.
        if (
            not isNullOrUndefined
            and not isDefinitelyObject
            and defaultValue is not None
        ):
            assert isinstance(defaultValue, IDLDefaultDictionaryValue)
            # Initializing from JS null does the right thing to give
            # us a default-initialized dictionary.
            val = "(${haveValue}) ? ${val} : JS::NullHandleValue"
        else:
            val = "${val}"

        dictLoc = "${declName}"
        if type.nullable():
            dictLoc += ".SetValue()"

        if type.unroll().inner.needsConversionFromJS:
            args = "cx, %s, " % val
        else:
            # We can end up in this case if a dictionary that does not need
            # conversion from JS has a dictionary-typed member with a default
            # value of {}.
            args = ""
        conversionCode = fill(
            """
            if (!${dictLoc}.Init(${args}"${desc}", $${passedToJSImpl})) {
              $*{exceptionCode}
            }
            """,
            dictLoc=dictLoc,
            args=args,
            desc=firstCap(sourceDescription),
            exceptionCode=exceptionCode,
        )

        if failureCode is not None:
            # This means we're part of an overload or union conversion, and
            # should simply skip stuff if our value is not convertible to
            # dictionary, instead of trying and throwing.  If we're either
            # isDefinitelyObject or isNullOrUndefined then we're convertible to
            # dictionary and don't need to check here.
            if isDefinitelyObject or isNullOrUndefined:
                template = conversionCode
            else:
                template = fill(
                    """
                    if (!IsConvertibleToDictionary(${val})) {
                      $*{failureCode}
                    }
                    $*{conversionCode}
                    """,
                    val=val,
                    failureCode=failureCode,
                    conversionCode=conversionCode,
                )
        else:
            template = conversionCode

        if type.nullable():
            declType = CGTemplatedType("Nullable", declType)
            template = CGIfElseWrapper(
                "${val}.isNullOrUndefined()",
                CGGeneric("${declName}.SetNull();\n"),
                CGGeneric(template),
            ).define()

        # Dictionary arguments that might contain traceable things need to get
        # traced
        if (not isMember or isMember == "Union") and isCallbackReturnValue:
            # Go ahead and just convert directly into our actual return value
            declType = CGWrapper(declType, post="&")
            declArgs = "aRetVal"
        elif (not isMember or isMember == "Union") and typeNeedsRooting(type):
            declType = CGTemplatedType("RootedDictionary", declType)
            declArgs = "cx"
        else:
            declArgs = None

        return JSToNativeConversionInfo(
            template, declType=declType, declArgs=declArgs, dealWithOptional=isOptional
        )

    if type.isUndefined():
        assert not isOptional
        # This one only happens for return values, and its easy: Just
        # ignore the jsval.
        return JSToNativeConversionInfo("")

    if not type.isPrimitive():
        raise TypeError("Need conversion for argument type '%s'" % str(type))

    typeName = builtinNames[type.tag()]

    conversionBehavior = "eDefault"
    if isEnforceRange:
        assert type.isInteger()
        conversionBehavior = "eEnforceRange"
    elif isClamp:
        assert type.isInteger()
        conversionBehavior = "eClamp"

    alwaysNull = False
    if type.nullable():
        declType = CGGeneric("Nullable<" + typeName + ">")
        writeLoc = "${declName}.SetValue()"
        readLoc = "${declName}.Value()"
        nullCondition = "${val}.isNullOrUndefined()"
        if defaultValue is not None and isinstance(defaultValue, IDLNullValue):
            nullCondition = "!(${haveValue}) || " + nullCondition
            if isKnownMissing:
                alwaysNull = True
                template = dedent(
                    """
                    ${declName}.SetNull();
                    """
                )
        if not alwaysNull:
            template = fill(
                """
                if (${nullCondition}) {
                  $${declName}.SetNull();
                } else if (!ValueToPrimitive<${typeName}, ${conversionBehavior}>(cx, $${val}, "${sourceDescription}", &${writeLoc})) {
                  $*{exceptionCode}
                }
                """,
                nullCondition=nullCondition,
                typeName=typeName,
                conversionBehavior=conversionBehavior,
                sourceDescription=firstCap(sourceDescription),
                writeLoc=writeLoc,
                exceptionCode=exceptionCode,
            )
    else:
        assert defaultValue is None or not isinstance(defaultValue, IDLNullValue)
        writeLoc = "${declName}"
        readLoc = writeLoc
        template = fill(
            """
            if (!ValueToPrimitive<${typeName}, ${conversionBehavior}>(cx, $${val}, "${sourceDescription}", &${writeLoc})) {
              $*{exceptionCode}
            }
            """,
            typeName=typeName,
            conversionBehavior=conversionBehavior,
            sourceDescription=firstCap(sourceDescription),
            writeLoc=writeLoc,
            exceptionCode=exceptionCode,
        )
        declType = CGGeneric(typeName)

    if type.isFloat() and not type.isUnrestricted() and not alwaysNull:
        if lenientFloatCode is not None:
            nonFiniteCode = lenientFloatCode
        else:
            nonFiniteCode = 'cx.ThrowErrorMessage<MSG_NOT_FINITE>("%s");\n' "%s" % (
                firstCap(sourceDescription),
                exceptionCode,
            )

        # We're appending to an if-block brace, so strip trailing whitespace
        # and add an extra space before the else.
        template = template.rstrip()
        template += fill(
            """
             else if (!std::isfinite(${readLoc})) {
              $*{nonFiniteCode}
            }
            """,
            readLoc=readLoc,
            nonFiniteCode=nonFiniteCode,
        )

    if (
        defaultValue is not None
        and
        # We already handled IDLNullValue, so just deal with the other ones
        not isinstance(defaultValue, IDLNullValue)
    ):
        tag = defaultValue.type.tag()
        defaultStr = getHandleDefault(defaultValue)
        template = handleDefault(template, "%s = %s;\n" % (writeLoc, defaultStr))

    return JSToNativeConversionInfo(
        template, declType=declType, dealWithOptional=isOptional
    )


def instantiateJSToNativeConversion(info, replacements, checkForValue=False):
    """
    Take a JSToNativeConversionInfo as returned by getJSToNativeConversionInfo
    and a set of replacements as required by the strings in such an object, and
    generate code to convert into stack C++ types.

    If checkForValue is True, then the conversion will get wrapped in
    a check for ${haveValue}.
    """
    templateBody, declType, holderType, dealWithOptional = (
        info.template,
        info.declType,
        info.holderType,
        info.dealWithOptional,
    )

    if dealWithOptional and not checkForValue:
        raise TypeError("Have to deal with optional things, but don't know how")
    if checkForValue and declType is None:
        raise TypeError(
            "Need to predeclare optional things, so they will be "
            "outside the check for big enough arg count!"
        )

    # We can't precompute our holder constructor arguments, since
    # those might depend on ${declName}, which we change below.  Just
    # compute arguments at the point when we need them as we go.
    def getArgsCGThing(args):
        return CGGeneric(string.Template(args).substitute(replacements))

    result = CGList([])
    # Make a copy of "replacements" since we may be about to start modifying it
    replacements = dict(replacements)
    originalDeclName = replacements["declName"]
    if declType is not None:
        if dealWithOptional:
            replacements["declName"] = "%s.Value()" % originalDeclName
            declType = CGTemplatedType("Optional", declType)
            declCtorArgs = None
        elif info.declArgs is not None:
            declCtorArgs = CGWrapper(getArgsCGThing(info.declArgs), pre="(", post=")")
        else:
            declCtorArgs = None
        result.append(
            CGList(
                [
                    declType,
                    CGGeneric(" "),
                    CGGeneric(originalDeclName),
                    declCtorArgs,
                    CGGeneric(";\n"),
                ]
            )
        )

    originalHolderName = replacements["holderName"]
    if holderType is not None:
        if dealWithOptional:
            replacements["holderName"] = "%s.ref()" % originalHolderName
            holderType = CGTemplatedType("Maybe", holderType)
            holderCtorArgs = None
        elif info.holderArgs is not None:
            holderCtorArgs = CGWrapper(
                getArgsCGThing(info.holderArgs), pre="(", post=")"
            )
        else:
            holderCtorArgs = None
        result.append(
            CGList(
                [
                    holderType,
                    CGGeneric(" "),
                    CGGeneric(originalHolderName),
                    holderCtorArgs,
                    CGGeneric(";\n"),
                ]
            )
        )

    if "maybeMutableVal" not in replacements:
        replacements["maybeMutableVal"] = replacements["val"]

    conversion = CGGeneric(string.Template(templateBody).substitute(replacements))

    if checkForValue:
        if dealWithOptional:
            declConstruct = CGIndenter(
                CGGeneric(
                    "%s.Construct(%s);\n"
                    % (
                        originalDeclName,
                        getArgsCGThing(info.declArgs).define() if info.declArgs else "",
                    )
                )
            )
            if holderType is not None:
                holderConstruct = CGIndenter(
                    CGGeneric(
                        "%s.emplace(%s);\n"
                        % (
                            originalHolderName,
                            getArgsCGThing(info.holderArgs).define()
                            if info.holderArgs
                            else "",
                        )
                    )
                )
            else:
                holderConstruct = None
        else:
            declConstruct = None
            holderConstruct = None

        conversion = CGList(
            [
                CGGeneric(
                    string.Template("if (${haveValue}) {\n").substitute(replacements)
                ),
                declConstruct,
                holderConstruct,
                CGIndenter(conversion),
                CGGeneric("}\n"),
            ]
        )

    result.append(conversion)
    return result


def convertConstIDLValueToJSVal(value):
    if isinstance(value, IDLNullValue):
        return "JS::NullValue()"
    if isinstance(value, IDLUndefinedValue):
        return "JS::UndefinedValue()"
    tag = value.type.tag()
    if tag in [
        IDLType.Tags.int8,
        IDLType.Tags.uint8,
        IDLType.Tags.int16,
        IDLType.Tags.uint16,
        IDLType.Tags.int32,
    ]:
        return "JS::Int32Value(%s)" % (value.value)
    if tag == IDLType.Tags.uint32:
        return "JS::NumberValue(%sU)" % (value.value)
    if tag in [IDLType.Tags.int64, IDLType.Tags.uint64]:
        return "JS::CanonicalizedDoubleValue(%s)" % numericValue(tag, value.value)
    if tag == IDLType.Tags.bool:
        return "JS::BooleanValue(%s)" % (toStringBool(value.value))
    if tag in [IDLType.Tags.float, IDLType.Tags.double]:
        return "JS::CanonicalizedDoubleValue(%s)" % (value.value)
    raise TypeError("Const value of unhandled type: %s" % value.type)


class CGArgumentConverter(CGThing):
    """
    A class that takes an IDL argument object and its index in the
    argument list and generates code to unwrap the argument to the
    right native type.

    argDescription is a description of the argument for error-reporting
    purposes.  Callers should assume that it might get placed in the middle of a
    sentence.  If it ends up at the beginning of a sentence, its first character
    will be automatically uppercased.
    """

    def __init__(
        self,
        argument,
        index,
        descriptorProvider,
        argDescription,
        member,
        invalidEnumValueFatal=True,
        lenientFloatCode=None,
    ):
        CGThing.__init__(self)
        self.argument = argument
        self.argDescription = argDescription
        assert not argument.defaultValue or argument.optional

        replacer = {"index": index, "argc": "args.length()"}
        self.replacementVariables = {
            "declName": "arg%d" % index,
            "holderName": ("arg%d" % index) + "_holder",
            "obj": "obj",
            "passedToJSImpl": toStringBool(
                isJSImplementedDescriptor(descriptorProvider)
            ),
        }
        # If we have a method generated by the maplike/setlike portion of an
        # interface, arguments can possibly be undefined, but will need to be
        # converted to the key/value type of the backing object. In this case,
        # use .get() instead of direct access to the argument. This won't
        # matter for iterable since generated functions for those interface
        # don't take arguments.
        if member.isMethod() and member.isMaplikeOrSetlikeOrIterableMethod():
            self.replacementVariables["val"] = string.Template(
                "args.get(${index})"
            ).substitute(replacer)
            self.replacementVariables["maybeMutableVal"] = string.Template(
                "args[${index}]"
            ).substitute(replacer)
        else:
            self.replacementVariables["val"] = string.Template(
                "args[${index}]"
            ).substitute(replacer)
        haveValueCheck = string.Template("args.hasDefined(${index})").substitute(
            replacer
        )
        self.replacementVariables["haveValue"] = haveValueCheck
        self.descriptorProvider = descriptorProvider
        if self.argument.canHaveMissingValue():
            self.argcAndIndex = replacer
        else:
            self.argcAndIndex = None
        self.invalidEnumValueFatal = invalidEnumValueFatal
        self.lenientFloatCode = lenientFloatCode

    def define(self):
        typeConversion = getJSToNativeConversionInfo(
            self.argument.type,
            self.descriptorProvider,
            isOptional=(self.argcAndIndex is not None and not self.argument.variadic),
            invalidEnumValueFatal=self.invalidEnumValueFatal,
            defaultValue=self.argument.defaultValue,
            lenientFloatCode=self.lenientFloatCode,
            isMember="Variadic" if self.argument.variadic else False,
            allowTreatNonCallableAsNull=self.argument.allowTreatNonCallableAsNull(),
            sourceDescription=self.argDescription,
        )

        if not self.argument.variadic:
            return instantiateJSToNativeConversion(
                typeConversion, self.replacementVariables, self.argcAndIndex is not None
            ).define()

        # Variadic arguments get turned into a sequence.
        if typeConversion.dealWithOptional:
            raise TypeError("Shouldn't have optional things in variadics")
        if typeConversion.holderType is not None:
            raise TypeError("Shouldn't need holders for variadics")

        replacer = dict(self.argcAndIndex, **self.replacementVariables)
        replacer["seqType"] = CGTemplatedType(
            "AutoSequence", typeConversion.declType
        ).define()
        if typeNeedsRooting(self.argument.type):
            rooterDecl = (
                "SequenceRooter<%s> ${holderName}(cx, &${declName});\n"
                % typeConversion.declType.define()
            )
        else:
            rooterDecl = ""
        replacer["elemType"] = typeConversion.declType.define()

        replacer["elementInitializer"] = initializerForType(self.argument.type) or ""

        # NOTE: Keep this in sync with sequence conversions as needed
        variadicConversion = string.Template(
            "${seqType} ${declName};\n"
            + rooterDecl
            + dedent(
                """
                if (${argc} > ${index}) {
                  if (!${declName}.SetCapacity(${argc} - ${index}, mozilla::fallible)) {
                    JS_ReportOutOfMemory(cx);
                    return false;
                  }
                  for (uint32_t variadicArg = ${index}; variadicArg < ${argc}; ++variadicArg) {
                    // OK to do infallible append here, since we ensured capacity already.
                    ${elemType}& slot = *${declName}.AppendElement(${elementInitializer});
                """
            )
        ).substitute(replacer)

        val = string.Template("args[variadicArg]").substitute(replacer)
        variadicConversion += indent(
            string.Template(typeConversion.template).substitute(
                {
                    "val": val,
                    "maybeMutableVal": val,
                    "declName": "slot",
                    # We only need holderName here to handle isExternal()
                    # interfaces, which use an internal holder for the
                    # conversion even when forceOwningType ends up true.
                    "holderName": "tempHolder",
                    # Use the same ${obj} as for the variadic arg itself
                    "obj": replacer["obj"],
                    "passedToJSImpl": toStringBool(
                        isJSImplementedDescriptor(self.descriptorProvider)
                    ),
                }
            ),
            4,
        )

        variadicConversion += "  }\n" "}\n"
        return variadicConversion


def getMaybeWrapValueFuncForType(type):
    if type.isJSString():
        return "MaybeWrapStringValue"
    # Callbacks might actually be DOM objects; nothing prevents a page from
    # doing that.
    if type.isCallback() or type.isCallbackInterface() or type.isObject():
        if type.nullable():
            return "MaybeWrapObjectOrNullValue"
        return "MaybeWrapObjectValue"
    # SpiderMonkey interfaces are never DOM objects.  Neither are sequences or
    # dictionaries, since those are always plain JS objects.
    if type.isSpiderMonkeyInterface() or type.isDictionary() or type.isSequence():
        if type.nullable():
            return "MaybeWrapNonDOMObjectOrNullValue"
        return "MaybeWrapNonDOMObjectValue"
    if type.isAny():
        return "MaybeWrapValue"

    # For other types, just go ahead an fall back on MaybeWrapValue for now:
    # it's always safe to do, and shouldn't be particularly slow for any of
    # them
    return "MaybeWrapValue"


sequenceWrapLevel = 0
recordWrapLevel = 0


def getWrapTemplateForType(
    type,
    descriptorProvider,
    result,
    successCode,
    returnsNewObject,
    exceptionCode,
    spiderMonkeyInterfacesAreStructs,
    isConstructorRetval=False,
):
    """
    Reflect a C++ value stored in "result", of IDL type "type" into JS.  The
    "successCode" is the code to run once we have successfully done the
    conversion and must guarantee that execution of the conversion template
    stops once the successCode has executed (e.g. by doing a 'return', or by
    doing a 'break' if the entire conversion template is inside a block that
    the 'break' will exit).

    If spiderMonkeyInterfacesAreStructs is true, then if the type is a
    SpiderMonkey interface, "result" is one of the
    dom::SpiderMonkeyInterfaceObjectStorage subclasses, not a JSObject*.

    The resulting string should be used with string.Template.  It
    needs the following keys when substituting:

      jsvalHandle: something that can be passed to methods taking a
                   JS::MutableHandle<JS::Value>.  This can be a
                   JS::MutableHandle<JS::Value> or a JS::Rooted<JS::Value>*.
      jsvalRef: something that can have .address() called on it to get a
                JS::Value* and .set() called on it to set it to a JS::Value.
                This can be a JS::MutableHandle<JS::Value> or a
                JS::Rooted<JS::Value>.
      obj: a JS::Handle<JSObject*>.

    Returns (templateString, infallibility of conversion template)
    """
    if successCode is None:
        successCode = "return true;\n"

    def setUndefined():
        return _setValue("", setter="setUndefined")

    def setNull():
        return _setValue("", setter="setNull")

    def setInt32(value):
        return _setValue(value, setter="setInt32")

    def setString(value):
        return _setValue(value, wrapAsType=type, setter="setString")

    def setObject(value, wrapAsType=None):
        return _setValue(value, wrapAsType=wrapAsType, setter="setObject")

    def setObjectOrNull(value, wrapAsType=None):
        return _setValue(value, wrapAsType=wrapAsType, setter="setObjectOrNull")

    def setUint32(value):
        return _setValue(value, setter="setNumber")

    def setDouble(value):
        return _setValue("JS_NumberValue(%s)" % value)

    def setBoolean(value):
        return _setValue(value, setter="setBoolean")

    def _setValue(value, wrapAsType=None, setter="set"):
        """
        Returns the code to set the jsval to value.

        If wrapAsType is not None, then will wrap the resulting value using the
        function that getMaybeWrapValueFuncForType(wrapAsType) returns.
        Otherwise, no wrapping will be done.
        """
        if wrapAsType is None:
            tail = successCode
        else:
            tail = fill(
                """
                if (!${maybeWrap}(cx, $${jsvalHandle})) {
                  $*{exceptionCode}
                }
                $*{successCode}
                """,
                maybeWrap=getMaybeWrapValueFuncForType(wrapAsType),
                exceptionCode=exceptionCode,
                successCode=successCode,
            )
        return ("${jsvalRef}.%s(%s);\n" % (setter, value)) + tail

    def wrapAndSetPtr(wrapCall, failureCode=None):
        """
        Returns the code to set the jsval by calling "wrapCall". "failureCode"
        is the code to run if calling "wrapCall" fails
        """
        if failureCode is None:
            failureCode = exceptionCode
        return fill(
            """
            if (!${wrapCall}) {
              $*{failureCode}
            }
            $*{successCode}
            """,
            wrapCall=wrapCall,
            failureCode=failureCode,
            successCode=successCode,
        )

    if type is None or type.isUndefined():
        return (setUndefined(), True)

    if (type.isSequence() or type.isRecord()) and type.nullable():
        # These are both wrapped in Nullable<>
        recTemplate, recInfall = getWrapTemplateForType(
            type.inner,
            descriptorProvider,
            "%s.Value()" % result,
            successCode,
            returnsNewObject,
            exceptionCode,
            spiderMonkeyInterfacesAreStructs,
        )
        code = fill(
            """

            if (${result}.IsNull()) {
              $*{setNull}
            }
            $*{recTemplate}
            """,
            result=result,
            setNull=setNull(),
            recTemplate=recTemplate,
        )
        return code, recInfall

    if type.isSequence():
        # Now do non-nullable sequences.  Our success code is just to break to
        # where we set the element in the array.  Note that we bump the
        # sequenceWrapLevel around this call so that nested sequence conversions
        # will use different iteration variables.
        global sequenceWrapLevel
        index = "sequenceIdx%d" % sequenceWrapLevel
        sequenceWrapLevel += 1
        innerTemplate = wrapForType(
            type.inner,
            descriptorProvider,
            {
                "result": "%s[%s]" % (result, index),
                "successCode": "break;\n",
                "jsvalRef": "tmp",
                "jsvalHandle": "&tmp",
                "returnsNewObject": returnsNewObject,
                "exceptionCode": exceptionCode,
                "obj": "returnArray",
                "spiderMonkeyInterfacesAreStructs": spiderMonkeyInterfacesAreStructs,
            },
        )
        sequenceWrapLevel -= 1
        code = fill(
            """

            uint32_t length = ${result}.Length();
            JS::Rooted<JSObject*> returnArray(cx, JS::NewArrayObject(cx, length));
            if (!returnArray) {
              $*{exceptionCode}
            }
            // Scope for 'tmp'
            {
              JS::Rooted<JS::Value> tmp(cx);
              for (uint32_t ${index} = 0; ${index} < length; ++${index}) {
                // Control block to let us common up the JS_DefineElement calls when there
                // are different ways to succeed at wrapping the object.
                do {
                  $*{innerTemplate}
                } while (false);
                if (!JS_DefineElement(cx, returnArray, ${index}, tmp,
                                      JSPROP_ENUMERATE)) {
                  $*{exceptionCode}
                }
              }
            }
            $*{set}
            """,
            result=result,
            exceptionCode=exceptionCode,
            index=index,
            innerTemplate=innerTemplate,
            set=setObject("*returnArray"),
        )

        return (code, False)

    if type.isRecord():
        # Now do non-nullable record.  Our success code is just to break to
        # where we define the property on the object.  Note that we bump the
        # recordWrapLevel around this call so that nested record conversions
        # will use different temp value names.
        global recordWrapLevel
        valueName = "recordValue%d" % recordWrapLevel
        recordWrapLevel += 1
        innerTemplate = wrapForType(
            type.inner,
            descriptorProvider,
            {
                "result": valueName,
                "successCode": "break;\n",
                "jsvalRef": "tmp",
                "jsvalHandle": "&tmp",
                "returnsNewObject": returnsNewObject,
                "exceptionCode": exceptionCode,
                "obj": "returnObj",
                "spiderMonkeyInterfacesAreStructs": spiderMonkeyInterfacesAreStructs,
            },
        )
        recordWrapLevel -= 1
        if type.keyType.isByteString():
            # There is no length-taking JS_DefineProperty.  So to keep
            # things sane with embedded nulls, we want to byte-inflate
            # to an nsAString.  The only byte-inflation function we
            # have around is AppendASCIItoUTF16, which luckily doesn't
            # assert anything about the input being ASCII.
            expandedKeyDecl = "NS_ConvertASCIItoUTF16 expandedKey(entry.mKey);\n"
            keyName = "expandedKey"
        elif type.keyType.isUTF8String():
            # We do the same as above for utf8 strings. We could do better if
            # we had a DefineProperty API that takes utf-8 property names.
            expandedKeyDecl = "NS_ConvertUTF8toUTF16 expandedKey(entry.mKey);\n"
            keyName = "expandedKey"
        else:
            expandedKeyDecl = ""
            keyName = "entry.mKey"

        code = fill(
            """

            JS::Rooted<JSObject*> returnObj(cx, JS_NewPlainObject(cx));
            if (!returnObj) {
              $*{exceptionCode}
            }
            // Scope for 'tmp'
            {
              JS::Rooted<JS::Value> tmp(cx);
              for (auto& entry : ${result}.Entries()) {
                auto& ${valueName} = entry.mValue;
                // Control block to let us common up the JS_DefineUCProperty calls when there
                // are different ways to succeed at wrapping the value.
                do {
                  $*{innerTemplate}
                } while (false);
                $*{expandedKeyDecl}
                if (!JS_DefineUCProperty(cx, returnObj,
                                         ${keyName}.BeginReading(),
                                         ${keyName}.Length(), tmp,
                                         JSPROP_ENUMERATE)) {
                  $*{exceptionCode}
                }
              }
            }
            $*{set}
            """,
            result=result,
            exceptionCode=exceptionCode,
            valueName=valueName,
            innerTemplate=innerTemplate,
            expandedKeyDecl=expandedKeyDecl,
            keyName=keyName,
            set=setObject("*returnObj"),
        )

        return (code, False)

    if type.isPromise():
        assert not type.nullable()
        # The use of ToJSValue here is a bit annoying because the Promise
        # version is not inlined.  But we can't put an inline version in either
        # ToJSValue.h or BindingUtils.h, because Promise.h includes ToJSValue.h
        # and that includes BindingUtils.h, so we'd get an include loop if
        # either of those headers included Promise.h.  And trying to write the
        # conversion by hand here is pretty annoying because we have to handle
        # the various RefPtr, rawptr, NonNull, etc cases, which ToJSValue will
        # handle for us.  So just eat the cost of the function call.
        return (wrapAndSetPtr("ToJSValue(cx, %s, ${jsvalHandle})" % result), False)

    if type.isGeckoInterface() and not type.isCallbackInterface():
        descriptor = descriptorProvider.getDescriptor(
            type.unroll().inner.identifier.name
        )
        if type.nullable():
            if descriptor.interface.identifier.name == "WindowProxy":
                template, infal = getWrapTemplateForType(
                    type.inner,
                    descriptorProvider,
                    "%s.Value()" % result,
                    successCode,
                    returnsNewObject,
                    exceptionCode,
                    spiderMonkeyInterfacesAreStructs,
                )
                return (
                    "if (%s.IsNull()) {\n" % result
                    + indent(setNull())
                    + "}\n"
                    + template,
                    infal,
                )

            wrappingCode = "if (!%s) {\n" % (result) + indent(setNull()) + "}\n"
        else:
            wrappingCode = ""

        if not descriptor.interface.isExternal():
            if descriptor.wrapperCache:
                wrapMethod = "GetOrCreateDOMReflector"
                wrapArgs = "cx, %s, ${jsvalHandle}" % result
            else:
                wrapMethod = "WrapNewBindingNonWrapperCachedObject"
                wrapArgs = "cx, ${obj}, %s, ${jsvalHandle}" % result
            if isConstructorRetval:
                wrapArgs += ", desiredProto"
            wrap = "%s(%s)" % (wrapMethod, wrapArgs)
            # Can only fail to wrap as a new-binding object if they already
            # threw an exception.
            failed = "MOZ_ASSERT(JS_IsExceptionPending(cx));\n" + exceptionCode
        else:
            if descriptor.notflattened:
                getIID = "&NS_GET_IID(%s), " % descriptor.nativeType
            else:
                getIID = ""
            wrap = "WrapObject(cx, %s, %s${jsvalHandle})" % (result, getIID)
            failed = None

        wrappingCode += wrapAndSetPtr(wrap, failed)
        return (wrappingCode, False)

    if type.isJSString():
        return (setString(result), False)

    if type.isDOMString() or type.isUSVString():
        if type.nullable():
            return (
                wrapAndSetPtr("xpc::StringToJsval(cx, %s, ${jsvalHandle})" % result),
                False,
            )
        else:
            return (
                wrapAndSetPtr(
                    "xpc::NonVoidStringToJsval(cx, %s, ${jsvalHandle})" % result
                ),
                False,
            )

    if type.isByteString():
        if type.nullable():
            return (
                wrapAndSetPtr("ByteStringToJsval(cx, %s, ${jsvalHandle})" % result),
                False,
            )
        else:
            return (
                wrapAndSetPtr(
                    "NonVoidByteStringToJsval(cx, %s, ${jsvalHandle})" % result
                ),
                False,
            )

    if type.isUTF8String():
        if type.nullable():
            return (
                wrapAndSetPtr("UTF8StringToJsval(cx, %s, ${jsvalHandle})" % result),
                False,
            )
        else:
            return (
                wrapAndSetPtr(
                    "NonVoidUTF8StringToJsval(cx, %s, ${jsvalHandle})" % result
                ),
                False,
            )

    if type.isEnum():
        if type.nullable():
            resultLoc = "%s.Value()" % result
        else:
            resultLoc = result
        conversion = fill(
            """
            if (!ToJSValue(cx, ${result}, $${jsvalHandle})) {
              $*{exceptionCode}
            }
            $*{successCode}
            """,
            result=resultLoc,
            exceptionCode=exceptionCode,
            successCode=successCode,
        )

        if type.nullable():
            conversion = CGIfElseWrapper(
                "%s.IsNull()" % result, CGGeneric(setNull()), CGGeneric(conversion)
            ).define()
        return conversion, False

    if type.isCallback() or type.isCallbackInterface():
        # Callbacks can store null if we nuked the compartments their
        # objects lived in.
        wrapCode = setObjectOrNull(
            "GetCallbackFromCallbackObject(cx, %(result)s)", wrapAsType=type
        )
        if type.nullable():
            wrapCode = (
                "if (%(result)s) {\n"
                + indent(wrapCode)
                + "} else {\n"
                + indent(setNull())
                + "}\n"
            )
        wrapCode = wrapCode % {"result": result}
        return wrapCode, False

    if type.isAny():
        # See comments in GetOrCreateDOMReflector explaining why we need
        # to wrap here.
        # NB: _setValue(..., type-that-is-any) calls JS_WrapValue(), so is fallible
        head = "JS::ExposeValueToActiveJS(%s);\n" % result
        return (head + _setValue(result, wrapAsType=type), False)

    if type.isObject() or (
        type.isSpiderMonkeyInterface() and not spiderMonkeyInterfacesAreStructs
    ):
        # See comments in GetOrCreateDOMReflector explaining why we need
        # to wrap here.
        if type.nullable():
            toValue = "%s"
            setter = setObjectOrNull
            head = """if (%s) {
              JS::ExposeObjectToActiveJS(%s);
            }
            """ % (
                result,
                result,
            )
        else:
            toValue = "*%s"
            setter = setObject
            head = "JS::ExposeObjectToActiveJS(%s);\n" % result
        # NB: setObject{,OrNull}(..., some-object-type) calls JS_WrapValue(), so is fallible
        return (head + setter(toValue % result, wrapAsType=type), False)

    if type.isObservableArray():
        # This first argument isn't used at all for now, the attribute getter
        # for ObservableArray type are generated in getObservableArrayGetterBody
        # instead.
        return "", False

    if not (
        type.isUnion()
        or type.isPrimitive()
        or type.isDictionary()
        or (type.isSpiderMonkeyInterface() and spiderMonkeyInterfacesAreStructs)
    ):
        raise TypeError("Need to learn to wrap %s" % type)

    if type.nullable():
        recTemplate, recInfal = getWrapTemplateForType(
            type.inner,
            descriptorProvider,
            "%s.Value()" % result,
            successCode,
            returnsNewObject,
            exceptionCode,
            spiderMonkeyInterfacesAreStructs,
        )
        return (
            "if (%s.IsNull()) {\n" % result + indent(setNull()) + "}\n" + recTemplate,
            recInfal,
        )

    if type.isSpiderMonkeyInterface():
        assert spiderMonkeyInterfacesAreStructs
        # See comments in GetOrCreateDOMReflector explaining why we need
        # to wrap here.
        # NB: setObject(..., some-object-type) calls JS_WrapValue(), so is fallible
        return (setObject("*%s.Obj()" % result, wrapAsType=type), False)

    if type.isUnion():
        return (wrapAndSetPtr("%s.ToJSVal(cx, ${obj}, ${jsvalHandle})" % result), False)

    if type.isDictionary():
        return (
            wrapAndSetPtr("%s.ToObjectInternal(cx, ${jsvalHandle})" % result),
            False,
        )

    tag = type.tag()

    if tag in [
        IDLType.Tags.int8,
        IDLType.Tags.uint8,
        IDLType.Tags.int16,
        IDLType.Tags.uint16,
        IDLType.Tags.int32,
    ]:
        return (setInt32("int32_t(%s)" % result), True)

    elif tag in [
        IDLType.Tags.int64,
        IDLType.Tags.uint64,
        IDLType.Tags.unrestricted_float,
        IDLType.Tags.float,
        IDLType.Tags.unrestricted_double,
        IDLType.Tags.double,
    ]:
        # XXXbz will cast to double do the "even significand" thing that webidl
        # calls for for 64-bit ints?  Do we care?
        return (setDouble("double(%s)" % result), True)

    elif tag == IDLType.Tags.uint32:
        return (setUint32(result), True)

    elif tag == IDLType.Tags.bool:
        return (setBoolean(result), True)

    else:
        raise TypeError("Need to learn to wrap primitive: %s" % type)


def wrapForType(type, descriptorProvider, templateValues):
    """
    Reflect a C++ value of IDL type "type" into JS.  TemplateValues is a dict
    that should contain:

      * 'jsvalRef': something that can have .address() called on it to get a
                    JS::Value* and .set() called on it to set it to a JS::Value.
                    This can be a JS::MutableHandle<JS::Value> or a
                    JS::Rooted<JS::Value>.
      * 'jsvalHandle': something that can be passed to methods taking a
                       JS::MutableHandle<JS::Value>.  This can be a
                       JS::MutableHandle<JS::Value> or a JS::Rooted<JS::Value>*.
      * 'obj' (optional): the name of the variable that contains the JSObject to
                          use as a scope when wrapping, if not supplied 'obj'
                          will be used as the name
      * 'result' (optional): the name of the variable in which the C++ value is
                             stored, if not supplied 'result' will be used as
                             the name
      * 'successCode' (optional): the code to run once we have successfully
                                  done the conversion, if not supplied 'return
                                  true;' will be used as the code.  The
                                  successCode must ensure that once it runs no
                                  more of the conversion template will be
                                  executed (e.g. by doing a 'return' or 'break'
                                  as appropriate).
      * 'returnsNewObject' (optional): If true, we're wrapping for the return
                                       value of a [NewObject] method.  Assumed
                                       false if not set.
      * 'exceptionCode' (optional): Code to run when a JS exception is thrown.
                                    The default is "return false;".  The code
                                    passed here must return.
      * 'isConstructorRetval' (optional): If true, we're wrapping a constructor
                                          return value.
    """
    wrap = getWrapTemplateForType(
        type,
        descriptorProvider,
        templateValues.get("result", "result"),
        templateValues.get("successCode", None),
        templateValues.get("returnsNewObject", False),
        templateValues.get("exceptionCode", "return false;\n"),
        templateValues.get("spiderMonkeyInterfacesAreStructs", False),
        isConstructorRetval=templateValues.get("isConstructorRetval", False),
    )[0]

    defaultValues = {"obj": "obj"}
    return string.Template(wrap).substitute(defaultValues, **templateValues)


def infallibleForMember(member, type, descriptorProvider):
    """
    Determine the fallibility of changing a C++ value of IDL type "type" into
    JS for the given attribute. Apart from returnsNewObject, all the defaults
    are used, since the fallbility does not change based on the boolean values,
    and the template will be discarded.

    CURRENT ASSUMPTIONS:
        We assume that successCode for wrapping up return values cannot contain
        failure conditions.
    """
    return getWrapTemplateForType(
        type,
        descriptorProvider,
        "result",
        None,
        memberReturnsNewObject(member),
        "return false;\n",
        False,
    )[1]


def leafTypeNeedsCx(type, retVal):
    return (
        type.isAny()
        or type.isObject()
        or type.isJSString()
        or (retVal and type.isSpiderMonkeyInterface())
    )


def leafTypeNeedsScopeObject(type, retVal):
    return retVal and type.isSpiderMonkeyInterface()


def leafTypeNeedsRooting(type):
    return leafTypeNeedsCx(type, False) or type.isSpiderMonkeyInterface()


def typeNeedsRooting(type):
    return typeMatchesLambda(type, lambda t: leafTypeNeedsRooting(t))


def typeNeedsCx(type, retVal=False):
    return typeMatchesLambda(type, lambda t: leafTypeNeedsCx(t, retVal))


def typeNeedsScopeObject(type, retVal=False):
    return typeMatchesLambda(type, lambda t: leafTypeNeedsScopeObject(t, retVal))


def typeMatchesLambda(type, func):
    if type is None:
        return False
    if type.nullable():
        return typeMatchesLambda(type.inner, func)
    if type.isSequence() or type.isRecord():
        return typeMatchesLambda(type.inner, func)
    if type.isUnion():
        return any(typeMatchesLambda(t, func) for t in type.unroll().flatMemberTypes)
    if type.isDictionary():
        return dictionaryMatchesLambda(type.inner, func)
    return func(type)


def dictionaryMatchesLambda(dictionary, func):
    return any(typeMatchesLambda(m.type, func) for m in dictionary.members) or (
        dictionary.parent and dictionaryMatchesLambda(dictionary.parent, func)
    )


# Whenever this is modified, please update CGNativeMember.getRetvalInfo as
# needed to keep the types compatible.
def getRetvalDeclarationForType(returnType, descriptorProvider, isMember=False):
    """
    Returns a tuple containing five things:

    1) A CGThing for the type of the return value, or None if there is no need
       for a return value.

    2) A value indicating the kind of ourparam to pass the value as.  Valid
       options are None to not pass as an out param at all, "ref" (to pass a
       reference as an out param), and "ptr" (to pass a pointer as an out
       param).

    3) A CGThing for a tracer for the return value, or None if no tracing is
       needed.

    4) An argument string to pass to the retval declaration
       constructor or None if there are no arguments.

    5) The name of a function that needs to be called with the return value
       before using it, or None if no function needs to be called.
    """
    if returnType is None or returnType.isUndefined():
        # Nothing to declare
        return None, None, None, None, None
    if returnType.isPrimitive() and returnType.tag() in builtinNames:
        result = CGGeneric(builtinNames[returnType.tag()])
        if returnType.nullable():
            result = CGTemplatedType("Nullable", result)
        return result, None, None, None, None
    if returnType.isJSString():
        if isMember:
            raise TypeError("JSString not supported as return type member")
        return CGGeneric("JS::Rooted<JSString*>"), "ptr", None, "cx", None
    if returnType.isDOMString() or returnType.isUSVString():
        if isMember:
            return CGGeneric("nsString"), "ref", None, None, None
        return CGGeneric("DOMString"), "ref", None, None, None
    if returnType.isByteString() or returnType.isUTF8String():
        if isMember:
            return CGGeneric("nsCString"), "ref", None, None, None
        return CGGeneric("nsAutoCString"), "ref", None, None, None
    if returnType.isEnum():
        result = CGGeneric(returnType.unroll().inner.identifier.name)
        if returnType.nullable():
            result = CGTemplatedType("Nullable", result)
        return result, None, None, None, None
    if returnType.isGeckoInterface() or returnType.isPromise():
        if returnType.isGeckoInterface():
            typeName = returnType.unroll().inner.identifier.name
            if typeName == "WindowProxy":
                result = CGGeneric("WindowProxyHolder")
                if returnType.nullable():
                    result = CGTemplatedType("Nullable", result)
                return result, None, None, None, None

            typeName = descriptorProvider.getDescriptor(typeName).nativeType
        else:
            typeName = "Promise"
        if isMember:
            conversion = None
            result = CGGeneric("StrongPtrForMember<%s>" % typeName)
        else:
            conversion = CGGeneric("StrongOrRawPtr<%s>" % typeName)
            result = CGGeneric("auto")
        return result, None, None, None, conversion
    if returnType.isCallback():
        name = returnType.unroll().callback.identifier.name
        return CGGeneric("RefPtr<%s>" % name), None, None, None, None
    if returnType.isAny():
        if isMember:
            return CGGeneric("JS::Value"), None, None, None, None
        return CGGeneric("JS::Rooted<JS::Value>"), "ptr", None, "cx", None
    if returnType.isObject() or returnType.isSpiderMonkeyInterface():
        if isMember:
            return CGGeneric("JSObject*"), None, None, None, None
        return CGGeneric("JS::Rooted<JSObject*>"), "ptr", None, "cx", None
    if returnType.isSequence():
        nullable = returnType.nullable()
        if nullable:
            returnType = returnType.inner
        result, _, _, _, _ = getRetvalDeclarationForType(
            returnType.inner, descriptorProvider, isMember="Sequence"
        )
        # While we have our inner type, set up our rooter, if needed
        if not isMember and typeNeedsRooting(returnType):
            rooter = CGGeneric(
                "SequenceRooter<%s > resultRooter(cx, &result);\n" % result.define()
            )
        else:
            rooter = None
        result = CGTemplatedType("nsTArray", result)
        if nullable:
            result = CGTemplatedType("Nullable", result)
        return result, "ref", rooter, None, None
    if returnType.isRecord():
        nullable = returnType.nullable()
        if nullable:
            returnType = returnType.inner
        result, _, _, _, _ = getRetvalDeclarationForType(
            returnType.inner, descriptorProvider, isMember="Record"
        )
        # While we have our inner type, set up our rooter, if needed
        if not isMember and typeNeedsRooting(returnType):
            rooter = CGGeneric(
                "RecordRooter<%s> resultRooter(cx, &result);\n"
                % ("nsString, " + result.define())
            )
        else:
            rooter = None
        result = CGTemplatedType("Record", [recordKeyDeclType(returnType), result])
        if nullable:
            result = CGTemplatedType("Nullable", result)
        return result, "ref", rooter, None, None
    if returnType.isDictionary():
        nullable = returnType.nullable()
        dictName = CGDictionary.makeDictionaryName(returnType.unroll().inner)
        result = CGGeneric(dictName)
        if not isMember and typeNeedsRooting(returnType):
            if nullable:
                result = CGTemplatedType("NullableRootedDictionary", result)
            else:
                result = CGTemplatedType("RootedDictionary", result)
            resultArgs = "cx"
        else:
            if nullable:
                result = CGTemplatedType("Nullable", result)
            resultArgs = None
        return result, "ref", None, resultArgs, None
    if returnType.isUnion():
        result = CGGeneric(CGUnionStruct.unionTypeName(returnType.unroll(), True))
        if not isMember and typeNeedsRooting(returnType):
            if returnType.nullable():
                result = CGTemplatedType("NullableRootedUnion", result)
            else:
                result = CGTemplatedType("RootedUnion", result)
            resultArgs = "cx"
        else:
            if returnType.nullable():
                result = CGTemplatedType("Nullable", result)
            resultArgs = None
        return result, "ref", None, resultArgs, None
    raise TypeError("Don't know how to declare return value for %s" % returnType)


def needCx(returnType, arguments, extendedAttributes, considerTypes, static=False):
    return (
        not static
        and considerTypes
        and (
            typeNeedsCx(returnType, True) or any(typeNeedsCx(a.type) for a in arguments)
        )
        or "implicitJSContext" in extendedAttributes
    )


def needScopeObject(
    returnType, arguments, extendedAttributes, isWrapperCached, considerTypes, isMember
):
    """
    isMember should be true if we're dealing with an attribute
    annotated as [StoreInSlot].
    """
    return (
        considerTypes
        and not isWrapperCached
        and (
            (not isMember and typeNeedsScopeObject(returnType, True))
            or any(typeNeedsScopeObject(a.type) for a in arguments)
        )
    )


def callerTypeGetterForDescriptor(descriptor):
    if descriptor.interface.isExposedInAnyWorker():
        systemCallerGetter = "nsContentUtils::ThreadsafeIsSystemCaller"
    else:
        systemCallerGetter = "nsContentUtils::IsSystemCaller"
    return "%s(cx) ? CallerType::System : CallerType::NonSystem" % systemCallerGetter


class CGCallGenerator(CGThing):
    """
    A class to generate an actual call to a C++ object.  Assumes that the C++
    object is stored in a variable whose name is given by the |object| argument.

    needsCallerType is a boolean indicating whether the call should receive
    a PrincipalType for the caller.

    needsErrorResult is a boolean indicating whether the call should be
    fallible and thus needs ErrorResult parameter.

    resultVar: If the returnType is not void, then the result of the call is
    stored in a C++ variable named by resultVar. The caller is responsible for
    declaring the result variable. If the caller doesn't care about the result
    value, resultVar can be omitted.

    context: The context string to pass to MaybeSetPendingException.
    """

    def __init__(
        self,
        needsErrorResult,
        needsCallerType,
        isChromeOnly,
        arguments,
        argsPre,
        returnType,
        extendedAttributes,
        descriptor,
        nativeMethodName,
        static,
        object="self",
        argsPost=[],
        resultVar=None,
        context="nullptr",
    ):
        CGThing.__init__(self)

        (
            result,
            resultOutParam,
            resultRooter,
            resultArgs,
            resultConversion,
        ) = getRetvalDeclarationForType(returnType, descriptor)

        args = CGList([CGGeneric(arg) for arg in argsPre], ", ")
        for a, name in arguments:
            arg = CGGeneric(name)

            # Now constify the things that need it
            def needsConst(a):
                if a.type.isDictionary():
                    return True
                if a.type.isSequence():
                    return True
                if a.type.isRecord():
                    return True
                # isObject() types are always a JS::Rooted, whether
                # nullable or not, and it turns out a const JS::Rooted
                # is not very helpful at all (in particular, it won't
                # even convert to a JS::Handle).
                # XXX bz Well, why not???
                if a.type.nullable() and not a.type.isObject():
                    return True
                if a.type.isString():
                    return True
                if a.canHaveMissingValue():
                    # This will need an Optional or it's a variadic;
                    # in both cases it should be const.
                    return True
                if a.type.isUnion():
                    return True
                if a.type.isSpiderMonkeyInterface():
                    return True
                return False

            if needsConst(a):
                arg = CGWrapper(arg, pre="Constify(", post=")")
            # And convert NonNull<T> to T&
            if (
                (a.type.isGeckoInterface() or a.type.isCallback() or a.type.isPromise())
                and not a.type.nullable()
            ) or a.type.isDOMString():
                arg = CGWrapper(arg, pre="NonNullHelper(", post=")")

            # If it's a refcounted object, let the static analysis know it's
            # alive for the duration of the call.
            if a.type.isGeckoInterface() or a.type.isCallback():
                arg = CGWrapper(arg, pre="MOZ_KnownLive(", post=")")

            args.append(arg)

        needResultDecl = False

        # Build up our actual call
        self.cgRoot = CGList([])

        # Return values that go in outparams go here
        if resultOutParam is not None:
            if resultVar is None:
                needResultDecl = True
                resultVar = "result"
            if resultOutParam == "ref":
                args.append(CGGeneric(resultVar))
            else:
                assert resultOutParam == "ptr"
                args.append(CGGeneric("&" + resultVar))

        needsSubjectPrincipal = "needsSubjectPrincipal" in extendedAttributes
        if needsSubjectPrincipal:
            needsNonSystemPrincipal = (
                "needsNonSystemSubjectPrincipal" in extendedAttributes
            )
            if needsNonSystemPrincipal:
                checkPrincipal = dedent(
                    """
                    if (principal->IsSystemPrincipal()) {
                      principal = nullptr;
                    }
                    """
                )
            else:
                checkPrincipal = ""

            getPrincipal = fill(
                """
                JS::Realm* realm = js::GetContextRealm(cx);
                MOZ_ASSERT(realm);
                JSPrincipals* principals = JS::GetRealmPrincipals(realm);
                nsIPrincipal* principal = nsJSPrincipals::get(principals);
                ${checkPrincipal}
                """,
                checkPrincipal=checkPrincipal,
            )

            if descriptor.interface.isExposedInAnyWorker():
                self.cgRoot.append(
                    CGGeneric(
                        fill(
                            """
                    Maybe<nsIPrincipal*> subjectPrincipal;
                    if (NS_IsMainThread()) {
                      $*{getPrincipal}
                      subjectPrincipal.emplace(principal);
                    }
                    """,
                            getPrincipal=getPrincipal,
                        )
                    )
                )
                subjectPrincipalArg = "subjectPrincipal"
            else:
                if needsNonSystemPrincipal:
                    principalType = "nsIPrincipal*"
                    subjectPrincipalArg = "subjectPrincipal"
                else:
                    principalType = "NonNull<nsIPrincipal>"
                    subjectPrincipalArg = "NonNullHelper(subjectPrincipal)"

                self.cgRoot.append(
                    CGGeneric(
                        fill(
                            """
                    ${principalType} subjectPrincipal;
                    {
                      $*{getPrincipal}
                      subjectPrincipal = principal;
                    }
                    """,
                            principalType=principalType,
                            getPrincipal=getPrincipal,
                        )
                    )
                )

            args.append(CGGeneric("MOZ_KnownLive(%s)" % subjectPrincipalArg))

        if needsCallerType:
            if isChromeOnly:
                args.append(CGGeneric("SystemCallerGuarantee()"))
            else:
                args.append(CGGeneric(callerTypeGetterForDescriptor(descriptor)))

        canOOM = "canOOM" in extendedAttributes
        if needsErrorResult:
            args.append(CGGeneric("rv"))
        elif canOOM:
            args.append(CGGeneric("OOMReporter::From(rv)"))
        args.extend(CGGeneric(arg) for arg in argsPost)

        call = CGGeneric(nativeMethodName)
        if not static:
            call = CGWrapper(call, pre="%s->" % object)
        call = CGList([call, CGWrapper(args, pre="(", post=")")])
        if returnType is None or returnType.isUndefined() or resultOutParam is not None:
            assert resultConversion is None
            call = CGList(
                [
                    CGWrapper(
                        call,
                        pre=(
                            "// NOTE: This assert does NOT call the function.\n"
                            "static_assert(std::is_void_v<decltype("
                        ),
                        post=')>, "Should be returning void here");',
                    ),
                    call,
                ],
                "\n",
            )
        elif resultConversion is not None:
            call = CGList([resultConversion, CGWrapper(call, pre="(", post=")")])
        if resultVar is None and result is not None:
            needResultDecl = True
            resultVar = "result"

        if needResultDecl:
            if resultArgs is not None:
                resultArgsStr = "(%s)" % resultArgs
            else:
                resultArgsStr = ""
            result = CGWrapper(result, post=(" %s%s" % (resultVar, resultArgsStr)))
            if resultOutParam is None and resultArgs is None:
                call = CGList([result, CGWrapper(call, pre="(", post=")")])
            else:
                self.cgRoot.append(CGWrapper(result, post=";\n"))
                if resultOutParam is None:
                    call = CGWrapper(call, pre=resultVar + " = ")
            if resultRooter is not None:
                self.cgRoot.append(resultRooter)
        elif result is not None:
            assert resultOutParam is None
            call = CGWrapper(call, pre=resultVar + " = ")

        call = CGWrapper(call, post=";\n")
        self.cgRoot.append(call)

        if needsErrorResult or canOOM:
            self.cgRoot.prepend(CGGeneric("FastErrorResult rv;\n"))
            self.cgRoot.append(
                CGGeneric(
                    fill(
                        """
                if (MOZ_UNLIKELY(rv.MaybeSetPendingException(cx, ${context}))) {
                  return false;
                }
                """,
                        context=context,
                    )
                )
            )

        self.cgRoot.append(CGGeneric("MOZ_ASSERT(!JS_IsExceptionPending(cx));\n"))

    def define(self):
        return self.cgRoot.define()


def getUnionMemberName(type):
    # Promises can't be in unions, because they're not distinguishable
    # from anything else.
    assert not type.isPromise()
    if type.isGeckoInterface():
        return type.inner.identifier.name
    if type.isEnum():
        return type.inner.identifier.name
    return type.name


# A counter for making sure that when we're wrapping up things in
# nested sequences we don't use the same variable name to iterate over
# different sequences.
sequenceWrapLevel = 0
recordWrapLevel = 0


def wrapTypeIntoCurrentCompartment(type, value, isMember=True):
    """
    Take the thing named by "value" and if it contains "any",
    "object", or spidermonkey-interface types inside return a CGThing
    that will wrap them into the current compartment.
    """
    if type.isAny():
        assert not type.nullable()
        if isMember:
            value = "JS::MutableHandle<JS::Value>::fromMarkedLocation(&%s)" % value
        else:
            value = "&" + value
        return CGGeneric(
            "if (!JS_WrapValue(cx, %s)) {\n" "  return false;\n" "}\n" % value
        )

    if type.isObject():
        if isMember:
            value = "JS::MutableHandle<JSObject*>::fromMarkedLocation(&%s)" % value
        else:
            value = "&" + value
        return CGGeneric(
            "if (!JS_WrapObject(cx, %s)) {\n" "  return false;\n" "}\n" % value
        )

    if type.isSpiderMonkeyInterface():
        origValue = value
        if type.nullable():
            value = "%s.Value()" % value
        wrapCode = CGGeneric(
            "if (!%s.WrapIntoNewCompartment(cx)) {\n" "  return false;\n" "}\n" % value
        )
        if type.nullable():
            wrapCode = CGIfWrapper(wrapCode, "!%s.IsNull()" % origValue)
        return wrapCode

    if type.isSequence():
        origValue = value
        origType = type
        if type.nullable():
            type = type.inner
            value = "%s.Value()" % value
        global sequenceWrapLevel
        index = "indexName%d" % sequenceWrapLevel
        sequenceWrapLevel += 1
        wrapElement = wrapTypeIntoCurrentCompartment(
            type.inner, "%s[%s]" % (value, index)
        )
        sequenceWrapLevel -= 1
        if not wrapElement:
            return None
        wrapCode = CGWrapper(
            CGIndenter(wrapElement),
            pre=(
                "for (uint32_t %s = 0; %s < %s.Length(); ++%s) {\n"
                % (index, index, value, index)
            ),
            post="}\n",
        )
        if origType.nullable():
            wrapCode = CGIfWrapper(wrapCode, "!%s.IsNull()" % origValue)
        return wrapCode

    if type.isRecord():
        origType = type
        if type.nullable():
            type = type.inner
            recordRef = "%s.Value()" % value
        else:
            recordRef = value
        global recordWrapLevel
        entryRef = "mapEntry%d" % recordWrapLevel
        recordWrapLevel += 1
        wrapElement = wrapTypeIntoCurrentCompartment(type.inner, "%s.mValue" % entryRef)
        recordWrapLevel -= 1
        if not wrapElement:
            return None
        wrapCode = CGWrapper(
            CGIndenter(wrapElement),
            pre=("for (auto& %s : %s.Entries()) {\n" % (entryRef, recordRef)),
            post="}\n",
        )
        if origType.nullable():
            wrapCode = CGIfWrapper(wrapCode, "!%s.IsNull()" % value)
        return wrapCode

    if type.isDictionary():
        assert not type.nullable()
        myDict = type.inner
        memberWraps = []
        while myDict:
            for member in myDict.members:
                memberWrap = wrapArgIntoCurrentCompartment(
                    member,
                    "%s.%s"
                    % (value, CGDictionary.makeMemberName(member.identifier.name)),
                )
                if memberWrap:
                    memberWraps.append(memberWrap)
            myDict = myDict.parent
        return CGList(memberWraps) if len(memberWraps) != 0 else None

    if type.isUnion():
        memberWraps = []
        if type.nullable():
            type = type.inner
            value = "%s.Value()" % value
        for member in type.flatMemberTypes:
            memberName = getUnionMemberName(member)
            memberWrap = wrapTypeIntoCurrentCompartment(
                member, "%s.GetAs%s()" % (value, memberName)
            )
            if memberWrap:
                memberWrap = CGIfWrapper(memberWrap, "%s.Is%s()" % (value, memberName))
                memberWraps.append(memberWrap)
        return CGList(memberWraps, "else ") if len(memberWraps) != 0 else None

    if (
        type.isUndefined()
        or type.isString()
        or type.isPrimitive()
        or type.isEnum()
        or type.isGeckoInterface()
        or type.isCallback()
        or type.isPromise()
    ):
        # All of these don't need wrapping.
        return None

    raise TypeError(
        "Unknown type; we don't know how to wrap it in constructor "
        "arguments: %s" % type
    )


def wrapArgIntoCurrentCompartment(arg, value, isMember=True):
    """
    As wrapTypeIntoCurrentCompartment but handles things being optional
    """
    origValue = value
    isOptional = arg.canHaveMissingValue()
    if isOptional:
        value = value + ".Value()"
    wrap = wrapTypeIntoCurrentCompartment(arg.type, value, isMember)
    if wrap and isOptional:
        wrap = CGIfWrapper(wrap, "%s.WasPassed()" % origValue)
    return wrap


def needsContainsHack(m):
    return m.getExtendedAttribute("ReturnValueNeedsContainsHack")


def needsCallerType(m):
    return m.getExtendedAttribute("NeedsCallerType")


class CGPerSignatureCall(CGThing):
    """
    This class handles the guts of generating code for a particular
    call signature.  A call signature consists of four things:

    1) A return type, which can be None to indicate that there is no
       actual return value (e.g. this is an attribute setter) or an
       IDLType if there's an IDL type involved (including |void|).
    2) An argument list, which is allowed to be empty.
    3) A name of a native method to call.
    4) Whether or not this method is static. Note that this only controls how
       the method is called (|self->nativeMethodName(...)| vs
       |nativeMethodName(...)|).

    We also need to know whether this is a method or a getter/setter
    to do error reporting correctly.

    The idlNode parameter can be either a method or an attr. We can query
    |idlNode.identifier| in both cases, so we can be agnostic between the two.

    dontSetSlot should be set to True if the value should not be cached in a
    slot (even if the attribute is marked as StoreInSlot or Cached in the
    WebIDL).
    """

    # XXXbz For now each entry in the argument list is either an
    # IDLArgument or a FakeArgument, but longer-term we may want to
    # have ways of flagging things like JSContext* or optional_argc in
    # there.

    def __init__(
        self,
        returnType,
        arguments,
        nativeMethodName,
        static,
        descriptor,
        idlNode,
        argConversionStartsAt=0,
        getter=False,
        setter=False,
        isConstructor=False,
        useCounterName=None,
        resultVar=None,
        objectName="obj",
        dontSetSlot=False,
        extendedAttributes=None,
    ):
        assert idlNode.isMethod() == (not getter and not setter)
        assert idlNode.isAttr() == (getter or setter)
        # Constructors are always static
        assert not isConstructor or static

        CGThing.__init__(self)
        self.returnType = returnType
        self.descriptor = descriptor
        self.idlNode = idlNode
        if extendedAttributes is None:
            extendedAttributes = descriptor.getExtendedAttributes(
                idlNode, getter=getter, setter=setter
            )
        self.extendedAttributes = extendedAttributes
        self.arguments = arguments
        self.argCount = len(arguments)
        self.isConstructor = isConstructor
        self.setSlot = (
            not dontSetSlot and idlNode.isAttr() and idlNode.slotIndices is not None
        )
        cgThings = []

        deprecated = idlNode.getExtendedAttribute("Deprecated") or (
            idlNode.isStatic()
            and descriptor.interface.getExtendedAttribute("Deprecated")
        )
        if deprecated:
            cgThings.append(
                CGGeneric(
                    dedent(
                        """
                DeprecationWarning(cx, obj, DeprecatedOperations::e%s);
                """
                        % deprecated[0]
                    )
                )
            )

        lenientFloatCode = None
        if idlNode.getExtendedAttribute("LenientFloat") is not None and (
            setter or idlNode.isMethod()
        ):
            cgThings.append(
                CGGeneric(
                    dedent(
                        """
                bool foundNonFiniteFloat = false;
                """
                    )
                )
            )
            lenientFloatCode = "foundNonFiniteFloat = true;\n"

        argsPre = []
        if idlNode.isStatic():
            # If we're a constructor, "obj" may not be a function, so calling
            # XrayAwareCalleeGlobal() on it is not safe.  Of course in the
            # constructor case either "obj" is an Xray or we're already in the
            # content compartment, not the Xray compartment, so just
            # constructing the GlobalObject from "obj" is fine.
            if isConstructor:
                objForGlobalObject = "obj"
            else:
                objForGlobalObject = "xpc::XrayAwareCalleeGlobal(obj)"
            cgThings.append(
                CGGeneric(
                    fill(
                        """
                GlobalObject global(cx, ${obj});
                if (global.Failed()) {
                  return false;
                }

                """,
                        obj=objForGlobalObject,
                    )
                )
            )
            argsPre.append("global")

        # For JS-implemented interfaces we do not want to base the
        # needsCx decision on the types involved, just on our extended
        # attributes. Also, JSContext is not needed for the static case
        # since GlobalObject already contains the context.
        needsCx = needCx(
            returnType,
            arguments,
            self.extendedAttributes,
            not descriptor.interface.isJSImplemented(),
            static,
        )
        if needsCx:
            argsPre.append("cx")

        needsUnwrap = False
        argsPost = []
        runConstructorInCallerCompartment = descriptor.interface.getExtendedAttribute(
            "RunConstructorInCallerCompartment"
        )
        if isConstructor and not runConstructorInCallerCompartment:
            needsUnwrap = True
            needsUnwrappedVar = False
            unwrappedVar = "obj"
            if descriptor.interface.isJSImplemented():
                # We need the desired proto in our constructor, because the
                # constructor will actually construct our reflector.
                argsPost.append("desiredProto")
        elif descriptor.interface.isJSImplemented():
            if not idlNode.isStatic():
                needsUnwrap = True
                needsUnwrappedVar = True
                argsPost.append(
                    "(unwrappedObj ? js::GetNonCCWObjectRealm(*unwrappedObj) : js::GetContextRealm(cx))"
                )
        elif needScopeObject(
            returnType,
            arguments,
            self.extendedAttributes,
            descriptor.wrapperCache,
            True,
            idlNode.getExtendedAttribute("StoreInSlot"),
        ):
            # If we ever end up with APIs like this on cross-origin objects,
            # figure out how the CheckedUnwrapDynamic bits should work.  Chances
            # are, just calling it with "cx" is fine...  For now, though, just
            # assert that it does not matter.
            assert not descriptor.isMaybeCrossOriginObject()
            # The scope object should always be from the relevant
            # global.  Make sure to unwrap it as needed.
            cgThings.append(
                CGGeneric(
                    dedent(
                        """
                JS::Rooted<JSObject*> unwrappedObj(cx, js::CheckedUnwrapStatic(obj));
                // Caller should have ensured that "obj" can be unwrapped already.
                MOZ_DIAGNOSTIC_ASSERT(unwrappedObj);
                """
                    )
                )
            )
            argsPre.append("unwrappedObj")

        if needsUnwrap and needsUnwrappedVar:
            # We cannot assign into obj because it's a Handle, not a
            # MutableHandle, so we need a separate Rooted.
            cgThings.append(CGGeneric("Maybe<JS::Rooted<JSObject*> > unwrappedObj;\n"))
            unwrappedVar = "unwrappedObj.ref()"

        if idlNode.isMethod() and idlNode.isLegacycaller():
            # If we can have legacycaller with identifier, we can't
            # just use the idlNode to determine whether we're
            # generating code for the legacycaller or not.
            assert idlNode.isIdentifierLess()
            # Pass in our thisVal
            argsPre.append("args.thisv()")

        if idlNode.isMethod():
            argDescription = "argument %(index)d"
        elif setter:
            argDescription = "value being assigned"
        else:
            assert self.argCount == 0

        if needsUnwrap:
            # It's very important that we construct our unwrappedObj, if we need
            # to do it, before we might start setting up Rooted things for our
            # arguments, so that we don't violate the stack discipline Rooted
            # depends on.
            cgThings.append(
                CGGeneric("bool objIsXray = xpc::WrapperFactory::IsXrayWrapper(obj);\n")
            )
            if needsUnwrappedVar:
                cgThings.append(
                    CGIfWrapper(
                        CGGeneric("unwrappedObj.emplace(cx, obj);\n"), "objIsXray"
                    )
                )

        for i in range(argConversionStartsAt, self.argCount):
            cgThings.append(
                CGArgumentConverter(
                    arguments[i],
                    i,
                    self.descriptor,
                    argDescription % {"index": i + 1},
                    idlNode,
                    invalidEnumValueFatal=not setter,
                    lenientFloatCode=lenientFloatCode,
                )
            )

        # Now that argument processing is done, enforce the LenientFloat stuff
        if lenientFloatCode:
            if setter:
                foundNonFiniteFloatBehavior = "return true;\n"
            else:
                assert idlNode.isMethod()
                foundNonFiniteFloatBehavior = dedent(
                    """
                    args.rval().setUndefined();
                    return true;
                    """
                )
            cgThings.append(
                CGGeneric(
                    fill(
                        """
                if (foundNonFiniteFloat) {
                  $*{returnSteps}
                }
                """,
                        returnSteps=foundNonFiniteFloatBehavior,
                    )
                )
            )

        if needsUnwrap:
            # Something depends on having the unwrapped object, so unwrap it now.
            xraySteps = []
            # XXXkhuey we should be able to MOZ_ASSERT that ${obj} is
            # not null.
            xraySteps.append(
                CGGeneric(
                    fill(
                        """
                    // Since our object is an Xray, we can just CheckedUnwrapStatic:
                    // we know Xrays have no dynamic unwrap behavior.
                    ${obj} = js::CheckedUnwrapStatic(${obj});
                    if (!${obj}) {
                      return false;
                    }
                    """,
                        obj=unwrappedVar,
                    )
                )
            )
            if isConstructor:
                # If we're called via an xray, we need to enter the underlying
                # object's compartment and then wrap up all of our arguments into
                # that compartment as needed.  This is all happening after we've
                # already done the conversions from JS values to WebIDL (C++)
                # values, so we only need to worry about cases where there are 'any'
                # or 'object' types, or other things that we represent as actual
                # JSAPI types, present.  Effectively, we're emulating a
                # CrossCompartmentWrapper, but working with the C++ types, not the
                # original list of JS::Values.
                cgThings.append(CGGeneric("Maybe<JSAutoRealm> ar;\n"))
                xraySteps.append(CGGeneric("ar.emplace(cx, obj);\n"))
                xraySteps.append(
                    CGGeneric(
                        dedent(
                            """
                    if (!JS_WrapObject(cx, &desiredProto)) {
                      return false;
                    }
                    """
                        )
                    )
                )
                xraySteps.extend(
                    wrapArgIntoCurrentCompartment(arg, argname, isMember=False)
                    for arg, argname in self.getArguments()
                )

            cgThings.append(CGIfWrapper(CGList(xraySteps), "objIsXray"))

        if idlNode.getExtendedAttribute("CEReactions") is not None and not getter:
            cgThings.append(
                CGGeneric(
                    dedent(
                        """
                Maybe<AutoCEReaction> ceReaction;
                DocGroup* docGroup = self->GetDocGroup();
                if (docGroup) {
                  ceReaction.emplace(docGroup->CustomElementReactionsStack(), cx);
                }
                """
                    )
                )
            )

        # If this is a method that was generated by a maplike/setlike
        # interface, use the maplike/setlike generator to fill in the body.
        # Otherwise, use CGCallGenerator to call the native method.
        if idlNode.isMethod() and idlNode.isMaplikeOrSetlikeOrIterableMethod():
            if (
                idlNode.maplikeOrSetlikeOrIterable.isMaplike()
                or idlNode.maplikeOrSetlikeOrIterable.isSetlike()
            ):
                cgThings.append(
                    CGMaplikeOrSetlikeMethodGenerator(
                        descriptor,
                        idlNode.maplikeOrSetlikeOrIterable,
                        idlNode.identifier.name,
                    )
                )
            else:
                cgThings.append(
                    CGIterableMethodGenerator(
                        descriptor,
                        idlNode.identifier.name,
                        self.getArgumentNames(),
                    )
                )
        elif idlNode.isAttr() and idlNode.type.isObservableArray():
            assert setter
            cgThings.append(CGObservableArraySetterGenerator(descriptor, idlNode))
        else:
            context = GetLabelForErrorReporting(descriptor, idlNode, isConstructor)
            if getter:
                context = context + " getter"
            elif setter:
                context = context + " setter"
            # Callee expects a quoted string for the context if
            # there's a context.
            context = '"%s"' % context

            if idlNode.isMethod() and idlNode.getExtendedAttribute("WebExtensionStub"):
                [
                    nativeMethodName,
                    argsPre,
                    args,
                ] = self.processWebExtensionStubAttribute(idlNode, cgThings)
            else:
                args = self.getArguments()

            cgThings.append(
                CGCallGenerator(
                    self.needsErrorResult(),
                    needsCallerType(idlNode),
                    isChromeOnly(idlNode),
                    args,
                    argsPre,
                    returnType,
                    self.extendedAttributes,
                    descriptor,
                    nativeMethodName,
                    static,
                    # We know our "self" must be being kept alive; otherwise we have
                    # a serious problem.  In common cases it's just an argument and
                    # we're MOZ_CAN_RUN_SCRIPT, but in some cases it's on the stack
                    # and being kept alive via references from JS.
                    object="MOZ_KnownLive(self)",
                    argsPost=argsPost,
                    resultVar=resultVar,
                    context=context,
                )
            )

        if useCounterName:
            # Generate a telemetry call for when [UseCounter] is used.
            windowCode = fill(
                """
                SetUseCounter(obj, eUseCounter_${useCounterName});
                """,
                useCounterName=useCounterName,
            )
            workerCode = fill(
                """
                SetUseCounter(UseCounterWorker::${useCounterName});
                """,
                useCounterName=useCounterName,
            )
            code = ""
            if idlNode.isExposedInWindow() and idlNode.isExposedInAnyWorker():
                code += fill(
                    """
                    if (NS_IsMainThread()) {
                      ${windowCode}
                    } else {
                      ${workerCode}
                    }
                    """,
                    windowCode=windowCode,
                    workerCode=workerCode,
                )
            elif idlNode.isExposedInWindow():
                code += windowCode
            elif idlNode.isExposedInAnyWorker():
                code += workerCode

            cgThings.append(CGGeneric(code))

        self.cgRoot = CGList(cgThings)

    def getArgumentNames(self):
        return ["arg" + str(i) for i in range(len(self.arguments))]

    def getArguments(self):
        return list(zip(self.arguments, self.getArgumentNames()))

    def processWebExtensionStubAttribute(self, idlNode, cgThings):
        nativeMethodName = "CallWebExtMethod"
        stubNameSuffix = idlNode.getExtendedAttribute("WebExtensionStub")
        if isinstance(stubNameSuffix, list):
            nativeMethodName += stubNameSuffix[0]

        argsLength = len(self.getArguments())
        singleVariadicArg = argsLength == 1 and self.getArguments()[0][0].variadic

        # If the method signature does only include a single variadic arguments,
        # then `arg0` is already a Sequence of JS values and we can pass that
        # to the WebExtensions Stub method as is.
        if singleVariadicArg:
            argsPre = [
                "cx",
                'u"%s"_ns' % idlNode.identifier.name,
                "Constify(%s)" % "arg0",
            ]
            args = []
            return [nativeMethodName, argsPre, args]

        argsPre = [
            "cx",
            'u"%s"_ns' % idlNode.identifier.name,
            "Constify(%s)" % "args_sequence",
        ]
        args = []

        # Determine the maximum number of elements of the js values sequence argument,
        # skipping the last optional callback argument if any:
        #
        # if this WebExtensions API method does expect a last optional callback argument,
        # then it is the callback parameter supported for chrome-compatibility
        # reasons, and we want it as a separate argument passed to the WebExtension
        # stub method and skip it from the js values sequence including all other
        # arguments.
        maxArgsSequenceLen = argsLength
        if argsLength > 0:
            lastArg = self.getArguments()[argsLength - 1]
            isCallback = lastArg[0].type.tag() == IDLType.Tags.callback
            if isCallback and lastArg[0].optional:
                argsPre.append(
                    "MOZ_KnownLive(NonNullHelper(Constify(%s)))" % lastArg[1]
                )
                maxArgsSequenceLen = argsLength - 1

        cgThings.append(
            CGGeneric(
                dedent(
                    fill(
                        """
            // Collecting all args js values into the single sequence argument
            // passed to the webextensions stub method.
            //
            // NOTE: The stub method will receive the original non-normalized js values,
            // but those arguments will still be normalized on the main thread by the
            // WebExtensions API request handler using the same JSONSchema defnition
            // used by the non-webIDL webextensions API bindings.
            AutoSequence<JS::Value> args_sequence;
            SequenceRooter<JS::Value> args_sequence_holder(cx, &args_sequence);

            // maximum number of arguments expected by the WebExtensions API method
            // excluding the last optional chrome-compatible callback argument (which
            // is being passed to the stub method as a separate additional argument).
            uint32_t maxArgsSequenceLen = ${maxArgsSequenceLen};

            uint32_t sequenceArgsLen = args.length() <= maxArgsSequenceLen ?
              args.length() : maxArgsSequenceLen;

            if (sequenceArgsLen > 0) {
              if (!args_sequence.SetCapacity(sequenceArgsLen, mozilla::fallible)) {
                JS_ReportOutOfMemory(cx);
                return false;
              }
              for (uint32_t argIdx = 0; argIdx < sequenceArgsLen; ++argIdx) {
                // OK to do infallible append here, since we ensured capacity already.
                JS::Value& slot = *args_sequence.AppendElement();
                slot = args[argIdx];
              }
            }
            """,
                        maxArgsSequenceLen=maxArgsSequenceLen,
                    )
                )
            )
        )

        return [nativeMethodName, argsPre, args]

    def needsErrorResult(self):
        return "needsErrorResult" in self.extendedAttributes

    def wrap_return_value(self):
        wrapCode = ""

        returnsNewObject = memberReturnsNewObject(self.idlNode)
        if returnsNewObject and (
            self.returnType.isGeckoInterface() or self.returnType.isPromise()
        ):
            wrapCode += dedent(
                """
                static_assert(!std::is_pointer_v<decltype(result)>,
                              "NewObject implies that we need to keep the object alive with a strong reference.");
                """
            )

        if self.setSlot:
            # For attributes in slots, we want to do some
            # post-processing once we've wrapped them.
            successCode = "break;\n"
        else:
            successCode = None

        resultTemplateValues = {
            "jsvalRef": "args.rval()",
            "jsvalHandle": "args.rval()",
            "returnsNewObject": returnsNewObject,
            "isConstructorRetval": self.isConstructor,
            "successCode": successCode,
            # 'obj' in this dictionary is the thing whose compartment we are
            # trying to do the to-JS conversion in.  We're going to put that
            # thing in a variable named "conversionScope" if setSlot is true.
            # Otherwise, just use "obj" for lack of anything better.
            "obj": "conversionScope" if self.setSlot else "obj",
        }

        wrapCode += wrapForType(self.returnType, self.descriptor, resultTemplateValues)

        if self.setSlot:
            if self.idlNode.isStatic():
                raise TypeError(
                    "Attribute %s.%s is static, so we don't have a useful slot "
                    "to cache it in, because we don't have support for that on "
                    "interface objects.  See "
                    "https://bugzilla.mozilla.org/show_bug.cgi?id=1363870"
                    % (
                        self.descriptor.interface.identifier.name,
                        self.idlNode.identifier.name,
                    )
                )

            # When using a slot on the Xray expando, we need to make sure that
            # our initial conversion to a JS::Value is done in the caller
            # compartment.  When using a slot on our reflector, we want to do
            # the conversion in the compartment of that reflector (that is,
            # slotStorage).  In both cases we want to make sure that we finally
            # set up args.rval() to be in the caller compartment.  We also need
            # to make sure that the conversion steps happen inside a do/while
            # that they can break out of on success.
            #
            # Of course we always have to wrap the value into the slotStorage
            # compartment before we store it in slotStorage.

            # postConversionSteps are the steps that run while we're still in
            # the compartment we do our conversion in but after we've finished
            # the initial conversion into args.rval().
            postConversionSteps = ""
            if needsContainsHack(self.idlNode):
                # Define a .contains on the object that has the same value as
                # .includes; needed for backwards compat in extensions as we
                # migrate some DOMStringLists to FrozenArray.
                postConversionSteps += dedent(
                    """
                    if (args.rval().isObject() && nsContentUtils::ThreadsafeIsSystemCaller(cx)) {
                      JS::Rooted<JSObject*> rvalObj(cx, &args.rval().toObject());
                      JS::Rooted<JS::Value> includesVal(cx);
                      if (!JS_GetProperty(cx, rvalObj, "includes", &includesVal) ||
                          !JS_DefineProperty(cx, rvalObj, "contains", includesVal, JSPROP_ENUMERATE)) {
                        return false;
                      }
                    }

                    """
                )
            if self.idlNode.getExtendedAttribute("Frozen"):
                assert (
                    self.idlNode.type.isSequence() or self.idlNode.type.isDictionary()
                )
                freezeValue = CGGeneric(
                    "JS::Rooted<JSObject*> rvalObj(cx, &args.rval().toObject());\n"
                    "if (!JS_FreezeObject(cx, rvalObj)) {\n"
                    "  return false;\n"
                    "}\n"
                )
                if self.idlNode.type.nullable():
                    freezeValue = CGIfWrapper(freezeValue, "args.rval().isObject()")
                postConversionSteps += freezeValue.define()

            # slotStorageSteps are steps that run once we have entered the
            # slotStorage compartment.
            slotStorageSteps = fill(
                """
                // Make a copy so that we don't do unnecessary wrapping on args.rval().
                JS::Rooted<JS::Value> storedVal(cx, args.rval());
                if (!${maybeWrap}(cx, &storedVal)) {
                  return false;
                }
                JS::SetReservedSlot(slotStorage, slotIndex, storedVal);
                """,
                maybeWrap=getMaybeWrapValueFuncForType(self.idlNode.type),
            )

            checkForXray = mayUseXrayExpandoSlots(self.descriptor, self.idlNode)

            # For the case of Cached attributes, go ahead and preserve our
            # wrapper if needed.  We need to do this because otherwise the
            # wrapper could get garbage-collected and the cached value would
            # suddenly disappear, but the whole premise of cached values is that
            # they never change without explicit action on someone's part.  We
            # don't do this for StoreInSlot, since those get dealt with during
            # wrapper setup, and failure would involve us trying to clear an
            # already-preserved wrapper.
            if (
                self.idlNode.getExtendedAttribute("Cached")
                and self.descriptor.wrapperCache
            ):
                preserveWrapper = dedent(
                    """
                    PreserveWrapper(self);
                    """
                )
                if checkForXray:
                    preserveWrapper = fill(
                        """
                        if (!isXray) {
                          // In the Xray case we don't need to do this, because getting the
                          // expando object already preserved our wrapper.
                          $*{preserveWrapper}
                        }
                        """,
                        preserveWrapper=preserveWrapper,
                    )
                slotStorageSteps += preserveWrapper

            if checkForXray:
                # In the Xray case we use the current global as conversion
                # scope, as explained in the big compartment/conversion comment
                # above.
                conversionScope = "isXray ? JS::CurrentGlobalOrNull(cx) : slotStorage"
            else:
                conversionScope = "slotStorage"

            wrapCode = fill(
                """
                {
                  JS::Rooted<JSObject*> conversionScope(cx, ${conversionScope});
                  JSAutoRealm ar(cx, conversionScope);
                  do { // block we break out of when done wrapping
                    $*{wrapCode}
                  } while (false);
                  $*{postConversionSteps}
                }
                { // And now store things in the realm of our slotStorage.
                  JSAutoRealm ar(cx, slotStorage);
                  $*{slotStorageSteps}
                }
                // And now make sure args.rval() is in the caller realm.
                return ${maybeWrap}(cx, args.rval());
                """,
                conversionScope=conversionScope,
                wrapCode=wrapCode,
                postConversionSteps=postConversionSteps,
                slotStorageSteps=slotStorageSteps,
                maybeWrap=getMaybeWrapValueFuncForType(self.idlNode.type),
            )
        return wrapCode

    def define(self):
        return self.cgRoot.define() + self.wrap_return_value()


class CGSwitch(CGList):
    """
    A class to generate code for a switch statement.

    Takes three constructor arguments: an expression, a list of cases,
    and an optional default.

    Each case is a CGCase.  The default is a CGThing for the body of
    the default case, if any.
    """

    def __init__(self, expression, cases, default=None):
        CGList.__init__(self, [CGIndenter(c) for c in cases])
        self.prepend(CGGeneric("switch (" + expression + ") {\n"))
        if default is not None:
            self.append(
                CGIndenter(
                    CGWrapper(CGIndenter(default), pre="default: {\n", post="}\n")
                )
            )

        self.append(CGGeneric("}\n"))


class CGCase(CGList):
    """
    A class to generate code for a case statement.

    Takes three constructor arguments: an expression, a CGThing for
    the body (allowed to be None if there is no body), and an optional
    argument for whether add a break, add fallthrough annotation or add nothing
    (defaulting to add a break).
    """

    ADD_BREAK = 0
    ADD_FALLTHROUGH = 1
    DONT_ADD_BREAK = 2

    def __init__(self, expression, body, breakOrFallthrough=ADD_BREAK):
        CGList.__init__(self, [])

        assert (
            breakOrFallthrough == CGCase.ADD_BREAK
            or breakOrFallthrough == CGCase.ADD_FALLTHROUGH
            or breakOrFallthrough == CGCase.DONT_ADD_BREAK
        )

        self.append(CGGeneric("case " + expression + ": {\n"))
        bodyList = CGList([body])
        if breakOrFallthrough == CGCase.ADD_FALLTHROUGH:
            bodyList.append(CGGeneric("[[fallthrough]];\n"))
        elif breakOrFallthrough == CGCase.ADD_BREAK:
            bodyList.append(CGGeneric("break;\n"))
        self.append(CGIndenter(bodyList))
        self.append(CGGeneric("}\n"))


class CGMethodCall(CGThing):
    """
    A class to generate selection of a method signature from a set of
    signatures and generation of a call to that signature.
    """

    def __init__(
        self, nativeMethodName, static, descriptor, method, isConstructor=False
    ):
        CGThing.__init__(self)

        methodName = GetLabelForErrorReporting(descriptor, method, isConstructor)
        argDesc = "argument %d"

        if method.getExtendedAttribute("UseCounter"):
            useCounterName = methodName.replace(".", "_").replace(" ", "_")
        else:
            useCounterName = None

        if method.isStatic():
            nativeType = descriptor.nativeType
            staticTypeOverride = PropertyDefiner.getStringAttr(
                method, "StaticClassOverride"
            )
            if staticTypeOverride:
                nativeType = staticTypeOverride
            nativeMethodName = "%s::%s" % (nativeType, nativeMethodName)

        def requiredArgCount(signature):
            arguments = signature[1]
            if len(arguments) == 0:
                return 0
            requiredArgs = len(arguments)
            while requiredArgs and arguments[requiredArgs - 1].optional:
                requiredArgs -= 1
            return requiredArgs

        def getPerSignatureCall(signature, argConversionStartsAt=0):
            return CGPerSignatureCall(
                signature[0],
                signature[1],
                nativeMethodName,
                static,
                descriptor,
                method,
                argConversionStartsAt=argConversionStartsAt,
                isConstructor=isConstructor,
                useCounterName=useCounterName,
            )

        signatures = method.signatures()
        if len(signatures) == 1:
            # Special case: we can just do a per-signature method call
            # here for our one signature and not worry about switching
            # on anything.
            signature = signatures[0]
            self.cgRoot = CGList([getPerSignatureCall(signature)])
            requiredArgs = requiredArgCount(signature)

            # Skip required arguments check for maplike/setlike interfaces, as
            # they can have arguments which are not passed, and are treated as
            # if undefined had been explicitly passed.
            if requiredArgs > 0 and not method.isMaplikeOrSetlikeOrIterableMethod():
                code = fill(
                    """
                    if (!args.requireAtLeast(cx, "${methodName}", ${requiredArgs})) {
                      return false;
                    }
                    """,
                    requiredArgs=requiredArgs,
                    methodName=methodName,
                )
                self.cgRoot.prepend(CGGeneric(code))
            return

        # Need to find the right overload
        maxArgCount = method.maxArgCount
        allowedArgCounts = method.allowedArgCounts

        argCountCases = []
        for argCountIdx, argCount in enumerate(allowedArgCounts):
            possibleSignatures = method.signaturesForArgCount(argCount)

            # Try to optimize away cases when the next argCount in the list
            # will have the same code as us; if it does, we can fall through to
            # that case.
            if argCountIdx + 1 < len(allowedArgCounts):
                nextPossibleSignatures = method.signaturesForArgCount(
                    allowedArgCounts[argCountIdx + 1]
                )
            else:
                nextPossibleSignatures = None
            if possibleSignatures == nextPossibleSignatures:
                # Same set of signatures means we better have the same
                # distinguishing index.  So we can in fact just fall through to
                # the next case here.
                assert len(possibleSignatures) == 1 or (
                    method.distinguishingIndexForArgCount(argCount)
                    == method.distinguishingIndexForArgCount(
                        allowedArgCounts[argCountIdx + 1]
                    )
                )
                argCountCases.append(
                    CGCase(str(argCount), None, CGCase.ADD_FALLTHROUGH)
                )
                continue

            if len(possibleSignatures) == 1:
                # easy case!
                signature = possibleSignatures[0]
                argCountCases.append(
                    CGCase(str(argCount), getPerSignatureCall(signature))
                )
                continue

            distinguishingIndex = method.distinguishingIndexForArgCount(argCount)

            def distinguishingArgument(signature):
                args = signature[1]
                if distinguishingIndex < len(args):
                    return args[distinguishingIndex]
                assert args[-1].variadic
                return args[-1]

            def distinguishingType(signature):
                return distinguishingArgument(signature).type

            for sig in possibleSignatures:
                # We should not have "any" args at distinguishingIndex,
                # since we have multiple possible signatures remaining,
                # but "any" is never distinguishable from anything else.
                assert not distinguishingType(sig).isAny()
                # We can't handle unions at the distinguishing index.
                if distinguishingType(sig).isUnion():
                    raise TypeError(
                        "No support for unions as distinguishing "
                        "arguments yet: %s" % distinguishingArgument(sig).location
                    )
                # We don't support variadics as the distinguishingArgument yet.
                # If you want to add support, consider this case:
                #
                #   undefined(long... foo);
                #   undefined(long bar, Int32Array baz);
                #
                # in which we have to convert argument 0 to long before picking
                # an overload... but all the variadic stuff needs to go into a
                # single array in case we pick that overload, so we have to have
                # machinery for converting argument 0 to long and then either
                # placing it in the variadic bit or not.  Or something.  We may
                # be able to loosen this restriction if the variadic arg is in
                # fact at distinguishingIndex, perhaps.  Would need to
                # double-check.
                if distinguishingArgument(sig).variadic:
                    raise TypeError(
                        "No support for variadics as distinguishing "
                        "arguments yet: %s" % distinguishingArgument(sig).location
                    )

            # Convert all our arguments up to the distinguishing index.
            # Doesn't matter which of the possible signatures we use, since
            # they all have the same types up to that point; just use
            # possibleSignatures[0]
            caseBody = [
                CGArgumentConverter(
                    possibleSignatures[0][1][i],
                    i,
                    descriptor,
                    argDesc % (i + 1),
                    method,
                )
                for i in range(0, distinguishingIndex)
            ]

            # Select the right overload from our set.
            distinguishingArg = "args[%d]" % distinguishingIndex

            def tryCall(
                signature, indent, isDefinitelyObject=False, isNullOrUndefined=False
            ):
                assert not isDefinitelyObject or not isNullOrUndefined
                assert isDefinitelyObject or isNullOrUndefined
                if isDefinitelyObject:
                    failureCode = "break;\n"
                else:
                    failureCode = None
                type = distinguishingType(signature)
                # The argument at index distinguishingIndex can't possibly be
                # unset here, because we've already checked that argc is large
                # enough that we can examine this argument.  But note that we
                # still want to claim that optional arguments are optional, in
                # case undefined was passed in.
                argIsOptional = distinguishingArgument(signature).canHaveMissingValue()
                testCode = instantiateJSToNativeConversion(
                    getJSToNativeConversionInfo(
                        type,
                        descriptor,
                        failureCode=failureCode,
                        isDefinitelyObject=isDefinitelyObject,
                        isNullOrUndefined=isNullOrUndefined,
                        isOptional=argIsOptional,
                        sourceDescription=(argDesc % (distinguishingIndex + 1)),
                    ),
                    {
                        "declName": "arg%d" % distinguishingIndex,
                        "holderName": ("arg%d" % distinguishingIndex) + "_holder",
                        "val": distinguishingArg,
                        "obj": "obj",
                        "haveValue": "args.hasDefined(%d)" % distinguishingIndex,
                        "passedToJSImpl": toStringBool(
                            isJSImplementedDescriptor(descriptor)
                        ),
                    },
                    checkForValue=argIsOptional,
                )
                caseBody.append(CGIndenter(testCode, indent))

                # If we got this far, we know we unwrapped to the right
                # C++ type, so just do the call.  Start conversion with
                # distinguishingIndex + 1, since we already converted
                # distinguishingIndex.
                caseBody.append(
                    CGIndenter(
                        getPerSignatureCall(signature, distinguishingIndex + 1), indent
                    )
                )

            def hasConditionalConversion(type):
                """
                Return whether the argument conversion for this type will be
                conditional on the type of incoming JS value.  For example, for
                interface types the conversion is conditional on the incoming
                value being isObject().

                For the types for which this returns false, we do not have to
                output extra isUndefined() or isNullOrUndefined() cases, because
                null/undefined values will just fall through into our
                unconditional conversion.
                """
                if type.isString() or type.isEnum():
                    return False
                if type.isBoolean():
                    distinguishingTypes = (
                        distinguishingType(s) for s in possibleSignatures
                    )
                    return any(
                        t.isString() or t.isEnum() or t.isNumeric()
                        for t in distinguishingTypes
                    )
                if type.isNumeric():
                    distinguishingTypes = (
                        distinguishingType(s) for s in possibleSignatures
                    )
                    return any(t.isString() or t.isEnum() for t in distinguishingTypes)
                return True

            def needsNullOrUndefinedCase(type):
                """
                Return true if the type needs a special isNullOrUndefined() case
                """
                return (
                    type.nullable() and hasConditionalConversion(type)
                ) or type.isDictionary()

            # First check for undefined and optional distinguishing arguments
            # and output a special branch for that case.  Note that we don't
            # use distinguishingArgument here because we actualy want to
            # exclude variadic arguments.  Also note that we skip this check if
            # we plan to output a isNullOrUndefined() special case for this
            # argument anyway, since that will subsume our isUndefined() check.
            # This is safe, because there can be at most one nullable
            # distinguishing argument, so if we're it we'll definitely get
            # picked up by the nullable handling.  Also, we can skip this check
            # if the argument has an unconditional conversion later on.
            undefSigs = [
                s
                for s in possibleSignatures
                if distinguishingIndex < len(s[1])
                and s[1][distinguishingIndex].optional
                and hasConditionalConversion(s[1][distinguishingIndex].type)
                and not needsNullOrUndefinedCase(s[1][distinguishingIndex].type)
            ]
            # Can't have multiple signatures with an optional argument at the
            # same index.
            assert len(undefSigs) < 2
            if len(undefSigs) > 0:
                caseBody.append(
                    CGGeneric("if (%s.isUndefined()) {\n" % distinguishingArg)
                )
                tryCall(undefSigs[0], 2, isNullOrUndefined=True)
                caseBody.append(CGGeneric("}\n"))

            # Next, check for null or undefined.  That means looking for
            # nullable arguments at the distinguishing index and outputting a
            # separate branch for them.  But if the nullable argument has an
            # unconditional conversion, we don't need to do that.  The reason
            # for that is that at most one argument at the distinguishing index
            # is nullable (since two nullable arguments are not
            # distinguishable), and null/undefined values will always fall
            # through to the unconditional conversion we have, if any, since
            # they will fail whatever the conditions on the input value are for
            # our other conversions.
            nullOrUndefSigs = [
                s
                for s in possibleSignatures
                if needsNullOrUndefinedCase(distinguishingType(s))
            ]
            # Can't have multiple nullable types here
            assert len(nullOrUndefSigs) < 2
            if len(nullOrUndefSigs) > 0:
                caseBody.append(
                    CGGeneric("if (%s.isNullOrUndefined()) {\n" % distinguishingArg)
                )
                tryCall(nullOrUndefSigs[0], 2, isNullOrUndefined=True)
                caseBody.append(CGGeneric("}\n"))

            # Now check for distinguishingArg being various kinds of objects.
            # The spec says to check for the following things in order:
            # 1)  A platform object that's not a platform array object, being
            #     passed to an interface or "object" arg.
            # 2)  A callable object being passed to a callback or "object" arg.
            # 3)  An iterable object being passed to a sequence arg.
            # 4)  Any object being passed to a array or callback interface or
            #     dictionary or "object" arg.

            # First grab all the overloads that have a non-callback interface
            # (which includes SpiderMonkey interfaces) at the distinguishing
            # index.  We can also include the ones that have an "object" here,
            # since if those are present no other object-typed argument will
            # be.
            objectSigs = [
                s
                for s in possibleSignatures
                if (
                    distinguishingType(s).isObject()
                    or distinguishingType(s).isNonCallbackInterface()
                )
            ]

            # And all the overloads that take callbacks
            objectSigs.extend(
                s for s in possibleSignatures if distinguishingType(s).isCallback()
            )

            # And all the overloads that take sequences
            objectSigs.extend(
                s for s in possibleSignatures if distinguishingType(s).isSequence()
            )

            # Now append all the overloads that take a dictionary or callback
            # interface or record.  There should be only one of these!
            genericObjectSigs = [
                s
                for s in possibleSignatures
                if (
                    distinguishingType(s).isDictionary()
                    or distinguishingType(s).isRecord()
                    or distinguishingType(s).isCallbackInterface()
                )
            ]
            assert len(genericObjectSigs) <= 1
            objectSigs.extend(genericObjectSigs)

            # There might be more than one thing in objectSigs; we need to check
            # which ones we unwrap to.
            if len(objectSigs) > 0:
                # Here it's enough to guard on our argument being an object.
                # The code for unwrapping non-callback interfaces, spiderMonkey
                # interfaces, and sequences will just bail out and move
                # on to the next overload if the object fails to unwrap
                # correctly, while "object" accepts any object anyway.  We
                # could even not do the isObject() check up front here, but in
                # cases where we have multiple object overloads it makes sense
                # to do it only once instead of for each overload.  That will
                # also allow the unwrapping test to skip having to do codegen
                # for the null-or-undefined case, which we already handled
                # above.
                caseBody.append(CGGeneric("if (%s.isObject()) {\n" % distinguishingArg))
                for sig in objectSigs:
                    caseBody.append(CGIndenter(CGGeneric("do {\n")))
                    # Indent by 4, since we need to indent further
                    # than our "do" statement
                    tryCall(sig, 4, isDefinitelyObject=True)
                    caseBody.append(CGIndenter(CGGeneric("} while (false);\n")))

                caseBody.append(CGGeneric("}\n"))

            # Now we only have to consider booleans, numerics, and strings.  If
            # we only have one of them, then we can just output it.  But if not,
            # then we need to output some of the cases conditionally: if we have
            # a string overload, then boolean and numeric are conditional, and
            # if not then boolean is conditional if we have a numeric overload.
            def findUniqueSignature(filterLambda):
                sigs = [s for s in possibleSignatures if filterLambda(s)]
                assert len(sigs) < 2
                if len(sigs) > 0:
                    return sigs[0]
                return None

            stringSignature = findUniqueSignature(
                lambda s: (
                    distinguishingType(s).isString() or distinguishingType(s).isEnum()
                )
            )
            numericSignature = findUniqueSignature(
                lambda s: distinguishingType(s).isNumeric()
            )
            booleanSignature = findUniqueSignature(
                lambda s: distinguishingType(s).isBoolean()
            )

            if stringSignature or numericSignature:
                booleanCondition = "%s.isBoolean()"
            else:
                booleanCondition = None

            if stringSignature:
                numericCondition = "%s.isNumber()"
            else:
                numericCondition = None

            def addCase(sig, condition):
                sigCode = getPerSignatureCall(sig, distinguishingIndex)
                if condition:
                    sigCode = CGIfWrapper(sigCode, condition % distinguishingArg)
                caseBody.append(sigCode)

            if booleanSignature:
                addCase(booleanSignature, booleanCondition)
            if numericSignature:
                addCase(numericSignature, numericCondition)
            if stringSignature:
                addCase(stringSignature, None)

            if not booleanSignature and not numericSignature and not stringSignature:
                # Just throw; we have no idea what we're supposed to
                # do with this.
                caseBody.append(
                    CGGeneric(
                        'return cx.ThrowErrorMessage<MSG_OVERLOAD_RESOLUTION_FAILED>("%d", "%d");\n'
                        % (distinguishingIndex + 1, argCount)
                    )
                )

            argCountCases.append(CGCase(str(argCount), CGList(caseBody)))

        overloadCGThings = []
        overloadCGThings.append(
            CGGeneric(
                "unsigned argcount = std::min(args.length(), %du);\n" % maxArgCount
            )
        )
        overloadCGThings.append(
            CGSwitch(
                "argcount",
                argCountCases,
                CGGeneric(
                    dedent(
                        """
                         // Using nsPrintfCString here would require including that
                         // header.  Let's not worry about it.
                         nsAutoCString argCountStr;
                         argCountStr.AppendPrintf("%u", args.length());
                         return cx.ThrowErrorMessage<MSG_INVALID_OVERLOAD_ARGCOUNT>(argCountStr.get());
                         """
                    )
                ),
            )
        )
        overloadCGThings.append(
            CGGeneric(
                'MOZ_CRASH("We have an always-returning default case");\n'
                "return false;\n"
            )
        )
        self.cgRoot = CGList(overloadCGThings)

    def define(self):
        return self.cgRoot.define()


class CGGetterCall(CGPerSignatureCall):
    """
    A class to generate a native object getter call for a particular IDL
    getter.
    """

    def __init__(
        self,
        returnType,
        nativeMethodName,
        descriptor,
        attr,
        dontSetSlot=False,
        extendedAttributes=None,
    ):
        if attr.getExtendedAttribute("UseCounter"):
            useCounterName = "%s_%s_getter" % (
                descriptor.interface.identifier.name,
                attr.identifier.name,
            )
        else:
            useCounterName = None
        if attr.isStatic():
            nativeMethodName = "%s::%s" % (descriptor.nativeType, nativeMethodName)
        CGPerSignatureCall.__init__(
            self,
            returnType,
            [],
            nativeMethodName,
            attr.isStatic(),
            descriptor,
            attr,
            getter=True,
            useCounterName=useCounterName,
            dontSetSlot=dontSetSlot,
            extendedAttributes=extendedAttributes,
        )


class FakeIdentifier:
    def __init__(self, name):
        self.name = name


class FakeArgument:
    """
    A class that quacks like an IDLArgument.  This is used to make
    setters look like method calls or for special operations.
    """

    def __init__(self, type, name="arg", allowTreatNonCallableAsNull=False):
        self.type = type
        self.optional = False
        self.variadic = False
        self.defaultValue = None
        self._allowTreatNonCallableAsNull = allowTreatNonCallableAsNull

        self.identifier = FakeIdentifier(name)

    def allowTreatNonCallableAsNull(self):
        return self._allowTreatNonCallableAsNull

    def canHaveMissingValue(self):
        return False


class CGSetterCall(CGPerSignatureCall):
    """
    A class to generate a native object setter call for a particular IDL
    setter.
    """

    def __init__(self, argType, nativeMethodName, descriptor, attr):
        if attr.getExtendedAttribute("UseCounter"):
            useCounterName = "%s_%s_setter" % (
                descriptor.interface.identifier.name,
                attr.identifier.name,
            )
        else:
            useCounterName = None
        if attr.isStatic():
            nativeMethodName = "%s::%s" % (descriptor.nativeType, nativeMethodName)
        CGPerSignatureCall.__init__(
            self,
            None,
            [FakeArgument(argType, allowTreatNonCallableAsNull=True)],
            nativeMethodName,
            attr.isStatic(),
            descriptor,
            attr,
            setter=True,
            useCounterName=useCounterName,
        )

    def wrap_return_value(self):
        attr = self.idlNode
        clearSlot = ""
        if self.descriptor.wrapperCache and attr.slotIndices is not None:
            if attr.getExtendedAttribute("StoreInSlot"):
                clearSlot = "%s(cx, self);\n" % MakeClearCachedValueNativeName(
                    self.idlNode
                )
            elif attr.getExtendedAttribute("Cached"):
                clearSlot = "%s(self);\n" % MakeClearCachedValueNativeName(self.idlNode)

        # We have no return value
        return "\n" "%s" "return true;\n" % clearSlot


class CGAbstractBindingMethod(CGAbstractStaticMethod):
    """
    Common class to generate some of our class hooks.  This will generate the
    function declaration, get a reference to the JS object for our binding
    object (which might be an argument of the class hook or something we get
    from a JS::CallArgs), and unwrap into the right C++ type. Subclasses are
    expected to override the generate_code function to do the rest of the work.
    This function should return a CGThing which is already properly indented.

    getThisObj should be code for getting a JSObject* for the binding
    object.  "" can be passed in if the binding object is already stored in
    'obj'.

    callArgs should be code for getting a JS::CallArgs into a variable
    called 'args'.  This can be "" if there is already such a variable
    around or if the body does not need a JS::CallArgs.

    """

    def __init__(
        self,
        descriptor,
        name,
        args,
        getThisObj,
        callArgs="JS::CallArgs args = JS::CallArgsFromVp(argc, vp);\n",
    ):
        CGAbstractStaticMethod.__init__(
            self, descriptor, name, "bool", args, canRunScript=True
        )

        # This can't ever happen, because we only use this for class hooks.
        self.unwrapFailureCode = fill(
            """
            MOZ_CRASH("Unexpected object in '${name}' hook");
            return false;
            """,
            name=name,
        )

        if getThisObj == "":
            self.getThisObj = None
        else:
            self.getThisObj = CGGeneric(
                "JS::Rooted<JSObject*> obj(cx, %s);\n" % getThisObj
            )
        self.callArgs = callArgs

    def definition_body(self):
        body = self.callArgs
        if self.getThisObj is not None:
            body += self.getThisObj.define() + "\n"
        body += "%s* self;\n" % self.descriptor.nativeType
        body += dedent(
            """
            JS::Rooted<JS::Value> rootSelf(cx, JS::ObjectValue(*obj));
            """
        )

        body += str(
            CastableObjectUnwrapper(
                self.descriptor, "rootSelf", "&rootSelf", "self", self.unwrapFailureCode
            )
        )

        return body + self.generate_code().define()

    def generate_code(self):
        assert False  # Override me


class CGAbstractStaticBindingMethod(CGAbstractStaticMethod):
    """
    Common class to generate the JSNatives for all our static methods, getters
    and setters.  This will generate the function declaration and unwrap the
    global object.  Subclasses are expected to override the generate_code
    function to do the rest of the work.  This function should return a
    CGThing which is already properly indented.
    """

    def __init__(self, descriptor, name):
        CGAbstractStaticMethod.__init__(
            self, descriptor, name, "bool", JSNativeArguments(), canRunScript=True
        )

    def definition_body(self):
        # Make sure that "obj" is in the same compartment as "cx", since we'll
        # later use it to wrap return values.
        unwrap = dedent(
            """
            JS::CallArgs args = JS::CallArgsFromVp(argc, vp);
            JS::Rooted<JSObject*> obj(cx, &args.callee());

            """
        )
        return unwrap + self.generate_code().define()

    def generate_code(self):
        assert False  # Override me


def MakeNativeName(name):
    return name[0].upper() + IDLToCIdentifier(name[1:])


def GetWebExposedName(idlObject, descriptor):
    if idlObject == descriptor.operations["Stringifier"]:
        return "toString"
    name = idlObject.identifier.name
    if name == "__namedsetter":
        return "named setter"
    if name == "__namedgetter":
        return "named getter"
    if name == "__indexedsetter":
        return "indexed setter"
    if name == "__indexedgetter":
        return "indexed getter"
    if name == "__legacycaller":
        return "legacy caller"
    return name


def GetConstructorNameForReporting(descriptor, ctor):
    # Figure out the name of our constructor for reporting purposes.
    # For unnamed webidl constructors, identifier.name is "constructor" but
    # the name JS sees is the interface name; for legacy factory functions
    # identifier.name is the actual name.
    ctorName = ctor.identifier.name
    if ctorName == "constructor":
        return descriptor.interface.identifier.name
    return ctorName


def GetLabelForErrorReporting(descriptor, idlObject, isConstructor):
    """
    descriptor is the descriptor for the interface involved

    idlObject is the method (regular or static), attribute (regular or
    static), or constructor (named or not) involved.

    isConstructor is true if idlObject is a constructor and false otherwise.
    """
    if isConstructor:
        return "%s constructor" % GetConstructorNameForReporting(descriptor, idlObject)

    namePrefix = descriptor.interface.identifier.name
    name = GetWebExposedName(idlObject, descriptor)
    if " " in name:
        # It's got a space already, so just space-separate.
        return "%s %s" % (namePrefix, name)

    return "%s.%s" % (namePrefix, name)


class CGSpecializedMethod(CGAbstractStaticMethod):
    """
    A class for generating the C++ code for a specialized method that the JIT
    can call with lower overhead.
    """

    def __init__(self, descriptor, method):
        self.method = method
        name = CppKeywords.checkMethodName(IDLToCIdentifier(method.identifier.name))
        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "obj"),
            Argument("void*", "void_self"),
            Argument("const JSJitMethodCallArgs&", "args"),
        ]
        CGAbstractStaticMethod.__init__(
            self, descriptor, name, "bool", args, canRunScript=True
        )

    def definition_body(self):
        nativeName = CGSpecializedMethod.makeNativeName(self.descriptor, self.method)
        call = CGMethodCall(
            nativeName, self.method.isStatic(), self.descriptor, self.method
        ).define()
        prefix = ""
        if self.method.getExtendedAttribute("CrossOriginCallable"):
            for signature in self.method.signatures():
                # non-undefined signatures would require us to deal with remote proxies for the
                # return value here.
                if not signature[0].isUndefined():
                    raise TypeError(
                        "We don't support a method marked as CrossOriginCallable "
                        "with non-undefined return type"
                    )
            prototypeID, _ = PrototypeIDAndDepth(self.descriptor)
            prefix = fill(
                """
                // CrossOriginThisPolicy::UnwrapThisObject stores a ${nativeType}::RemoteProxy in void_self
                // if obj is a proxy with a RemoteObjectProxy handler for the right type, or else it stores
                // a ${nativeType}. If we get here from the JIT (without going through UnwrapThisObject) we
                // know void_self contains a ${nativeType}; we don't have special cases in the JIT to deal
                // with remote object proxies.
                if (IsRemoteObjectProxy(obj, ${prototypeID})) {
                    auto* self = static_cast<${nativeType}::RemoteProxy*>(void_self);
                    $*{call}
                }
                """,
                prototypeID=prototypeID,
                nativeType=self.descriptor.nativeType,
                call=call,
            )
        return prefix + fill(
            """
            auto* self = static_cast<${nativeType}*>(void_self);
            $*{call}
            """,
            nativeType=self.descriptor.nativeType,
            call=call,
        )

    def auto_profiler_label(self):
        interface_name = self.descriptor.interface.identifier.name
        method_name = self.method.identifier.name
        return fill(
            """
            AUTO_PROFILER_LABEL_DYNAMIC_FAST(
              "${interface_name}", "${method_name}", DOM, cx,
              uint32_t(js::ProfilingStackFrame::Flags::STRING_TEMPLATE_METHOD) |
              uint32_t(js::ProfilingStackFrame::Flags::RELEVANT_FOR_JS));
            """,
            interface_name=interface_name,
            method_name=method_name,
        )

    @staticmethod
    def should_have_method_description(descriptor, idlMethod):
        """
        Returns whether the given IDL method (static, non-static, constructor)
        should have a method description declaration, for use in error
        reporting.
        """
        # If a method has overloads, it needs a method description, because it
        # can throw MSG_INVALID_OVERLOAD_ARGCOUNT at the very least.
        if len(idlMethod.signatures()) != 1:
            return True

        # Methods with only one signature need a method description if one of
        # their args needs it.
        sig = idlMethod.signatures()[0]
        args = sig[1]
        return any(
            idlTypeNeedsCallContext(
                arg.type,
                descriptor,
                allowTreatNonCallableAsNull=arg.allowTreatNonCallableAsNull(),
            )
            for arg in args
        )

    @staticmethod
    def error_reporting_label_helper(descriptor, idlMethod, isConstructor):
        """
        Returns the method description to use for error reporting for the given
        IDL method.  Used to implement common error_reporting_label() functions
        across different classes.
        """
        if not CGSpecializedMethod.should_have_method_description(
            descriptor, idlMethod
        ):
            return None
        return GetLabelForErrorReporting(descriptor, idlMethod, isConstructor)

    def error_reporting_label(self):
        return CGSpecializedMethod.error_reporting_label_helper(
            self.descriptor, self.method, isConstructor=False
        )

    @staticmethod
    def makeNativeName(descriptor, method):
        if method.underlyingAttr:
            return CGSpecializedGetter.makeNativeName(descriptor, method.underlyingAttr)
        name = method.identifier.name
        return MakeNativeName(descriptor.binaryNameFor(name, method.isStatic()))


class CGMethodPromiseWrapper(CGAbstractStaticMethod):
    """
    A class for generating a wrapper around another method that will
    convert exceptions to promises.
    """

    def __init__(self, descriptor, methodToWrap):
        self.method = methodToWrap
        name = self.makeName(methodToWrap.name)
        args = list(methodToWrap.args)
        CGAbstractStaticMethod.__init__(
            self, descriptor, name, "bool", args, canRunScript=True
        )

    def definition_body(self):
        return fill(
            """
            bool ok = ${methodName}(${args});
            if (ok) {
              return true;
            }
            return ConvertExceptionToPromise(cx, args.rval());
            """,
            methodName=self.method.name,
            args=", ".join(arg.name for arg in self.args),
        )

    @staticmethod
    def makeName(methodName):
        return methodName + "_promiseWrapper"


class CGDefaultToJSONMethod(CGSpecializedMethod):
    def __init__(self, descriptor, method):
        assert method.isDefaultToJSON()
        CGSpecializedMethod.__init__(self, descriptor, method)

    def definition_body(self):
        ret = fill(
            """
            auto* self = static_cast<${nativeType}*>(void_self);
            JS::Rooted<JSObject*> result(cx, JS_NewPlainObject(cx));
            if (!result) {
              return false;
            }
            """,
            nativeType=self.descriptor.nativeType,
        )

        jsonDescriptors = [self.descriptor]
        interface = self.descriptor.interface.parent
        while interface:
            descriptor = self.descriptor.getDescriptor(interface.identifier.name)
            if descriptor.hasDefaultToJSON:
                jsonDescriptors.append(descriptor)
            interface = interface.parent

        # Iterate the array in reverse: oldest ancestor first
        for descriptor in jsonDescriptors[::-1]:
            ret += fill(
                """
                if (!${parentclass}::CollectJSONAttributes(cx, obj, MOZ_KnownLive(self), result)) {
                  return false;
                }
                """,
                parentclass=toBindingNamespace(descriptor.name),
            )
        ret += "args.rval().setObject(*result);\n" "return true;\n"
        return ret


class CGLegacyCallHook(CGAbstractBindingMethod):
    """
    Call hook for our object
    """

    def __init__(self, descriptor):
        self._legacycaller = descriptor.operations["LegacyCaller"]
        # Our "self" is actually the callee in this case, not the thisval.
        CGAbstractBindingMethod.__init__(
            self,
            descriptor,
            LEGACYCALLER_HOOK_NAME,
            JSNativeArguments(),
            getThisObj="&args.callee()",
        )

    def define(self):
        if not self._legacycaller:
            return ""
        return CGAbstractBindingMethod.define(self)

    def generate_code(self):
        name = self._legacycaller.identifier.name
        nativeName = MakeNativeName(self.descriptor.binaryNameFor(name, False))
        return CGMethodCall(nativeName, False, self.descriptor, self._legacycaller)

    def error_reporting_label(self):
        # Should act like methods.
        return CGSpecializedMethod.error_reporting_label_helper(
            self.descriptor, self._legacycaller, isConstructor=False
        )


class CGResolveHook(CGAbstractClassHook):
    """
    Resolve hook for objects that have the NeedResolve extended attribute.
    """

    def __init__(self, descriptor):
        assert descriptor.interface.getExtendedAttribute("NeedResolve")

        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "obj"),
            Argument("JS::Handle<jsid>", "id"),
            Argument("bool*", "resolvedp"),
        ]
        CGAbstractClassHook.__init__(self, descriptor, RESOLVE_HOOK_NAME, "bool", args)

    def generate_code(self):
        return dedent(
            """
            JS::Rooted<mozilla::Maybe<JS::PropertyDescriptor>> desc(cx);
            if (!self->DoResolve(cx, obj, id, &desc)) {
              return false;
            }
            if (desc.isNothing()) {
              return true;
            }
            // If desc.value() is undefined, then the DoResolve call
            // has already defined it on the object.  Don't try to also
            // define it.
            MOZ_ASSERT(desc->isDataDescriptor());
            if (!desc->value().isUndefined()) {
              JS::Rooted<JS::PropertyDescriptor> defineDesc(cx, *desc);
              defineDesc.setResolving(true);
              if (!JS_DefinePropertyById(cx, obj, id, defineDesc)) {
                return false;
              }
            }
            *resolvedp = true;
            return true;
            """
        )

    def definition_body(self):
        if self.descriptor.isGlobal():
            # Resolve standard classes
            prefix = dedent(
                """
                if (!ResolveGlobal(cx, obj, id, resolvedp)) {
                  return false;
                }
                if (*resolvedp) {
                  return true;
                }

                """
            )
        else:
            prefix = ""
        return prefix + CGAbstractClassHook.definition_body(self)


class CGMayResolveHook(CGAbstractStaticMethod):
    """
    Resolve hook for objects that have the NeedResolve extended attribute.
    """

    def __init__(self, descriptor):
        assert descriptor.interface.getExtendedAttribute("NeedResolve")

        args = [
            Argument("const JSAtomState&", "names"),
            Argument("jsid", "id"),
            Argument("JSObject*", "maybeObj"),
        ]
        CGAbstractStaticMethod.__init__(
            self, descriptor, MAY_RESOLVE_HOOK_NAME, "bool", args
        )

    def definition_body(self):
        if self.descriptor.isGlobal():
            # Check whether this would resolve as a standard class.
            prefix = dedent(
                """
                if (MayResolveGlobal(names, id, maybeObj)) {
                  return true;
                }

                """
            )
        else:
            prefix = ""
        return prefix + "return %s::MayResolve(id);\n" % self.descriptor.nativeType


class CGEnumerateHook(CGAbstractBindingMethod):
    """
    Enumerate hook for objects with custom hooks.
    """

    def __init__(self, descriptor):
        assert descriptor.interface.getExtendedAttribute("NeedResolve")

        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "obj"),
            Argument("JS::MutableHandleVector<jsid>", "properties"),
            Argument("bool", "enumerableOnly"),
        ]
        # Our "self" is actually the "obj" argument in this case, not the thisval.
        CGAbstractBindingMethod.__init__(
            self, descriptor, NEW_ENUMERATE_HOOK_NAME, args, getThisObj="", callArgs=""
        )

    def generate_code(self):
        return CGGeneric(
            dedent(
                """
            FastErrorResult rv;
            self->GetOwnPropertyNames(cx, properties, enumerableOnly, rv);
            if (rv.MaybeSetPendingException(cx)) {
              return false;
            }
            return true;
            """
            )
        )

    def definition_body(self):
        if self.descriptor.isGlobal():
            # Enumerate standard classes
            prefix = dedent(
                """
                if (!EnumerateGlobal(cx, obj, properties, enumerableOnly)) {
                  return false;
                }

                """
            )
        else:
            prefix = ""
        return prefix + CGAbstractBindingMethod.definition_body(self)


class CppKeywords:
    """
    A class for checking if method names declared in webidl
    are not in conflict with C++ keywords.
    """

    keywords = frozenset(
        [
            "alignas",
            "alignof",
            "and",
            "and_eq",
            "asm",
            "assert",
            "auto",
            "bitand",
            "bitor",
            "bool",
            "break",
            "case",
            "catch",
            "char",
            "char16_t",
            "char32_t",
            "class",
            "compl",
            "const",
            "constexpr",
            "const_cast",
            "continue",
            "decltype",
            "default",
            "delete",
            "do",
            "double",
            "dynamic_cast",
            "else",
            "enum",
            "explicit",
            "export",
            "extern",
            "false",
            "final",
            "float",
            "for",
            "friend",
            "goto",
            "if",
            "inline",
            "int",
            "long",
            "mutable",
            "namespace",
            "new",
            "noexcept",
            "not",
            "not_eq",
            "nullptr",
            "operator",
            "or",
            "or_eq",
            "override",
            "private",
            "protected",
            "public",
            "register",
            "reinterpret_cast",
            "return",
            "short",
            "signed",
            "sizeof",
            "static",
            "static_assert",
            "static_cast",
            "struct",
            "switch",
            "template",
            "this",
            "thread_local",
            "throw",
            "true",
            "try",
            "typedef",
            "typeid",
            "typename",
            "union",
            "unsigned",
            "using",
            "virtual",
            "void",
            "volatile",
            "wchar_t",
            "while",
            "xor",
            "xor_eq",
        ]
    )

    @staticmethod
    def checkMethodName(name):
        # Double '_' because 'assert' and '_assert' cannot be used in MS2013 compiler.
        # Bug 964892 and bug 963560.
        if name in CppKeywords.keywords:
            name = "_" + name + "_"
        return name


class CGStaticMethod(CGAbstractStaticBindingMethod):
    """
    A class for generating the C++ code for an IDL static method.
    """

    def __init__(self, descriptor, method):
        self.method = method
        name = CppKeywords.checkMethodName(IDLToCIdentifier(method.identifier.name))
        CGAbstractStaticBindingMethod.__init__(self, descriptor, name)

    def generate_code(self):
        nativeName = CGSpecializedMethod.makeNativeName(self.descriptor, self.method)
        return CGMethodCall(nativeName, True, self.descriptor, self.method)

    def auto_profiler_label(self):
        interface_name = self.descriptor.interface.identifier.name
        method_name = self.method.identifier.name
        return fill(
            """
            AUTO_PROFILER_LABEL_DYNAMIC_FAST(
              "${interface_name}", "${method_name}", DOM, cx,
              uint32_t(js::ProfilingStackFrame::Flags::STRING_TEMPLATE_METHOD) |
              uint32_t(js::ProfilingStackFrame::Flags::RELEVANT_FOR_JS));
            """,
            interface_name=interface_name,
            method_name=method_name,
        )

    def error_reporting_label(self):
        return CGSpecializedMethod.error_reporting_label_helper(
            self.descriptor, self.method, isConstructor=False
        )


class CGSpecializedGetter(CGAbstractStaticMethod):
    """
    A class for generating the code for a specialized attribute getter
    that the JIT can call with lower overhead.
    """

    def __init__(self, descriptor, attr):
        self.attr = attr
        name = "get_" + IDLToCIdentifier(attr.identifier.name)
        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "obj"),
            Argument("void*", "void_self"),
            Argument("JSJitGetterCallArgs", "args"),
        ]
        # StoreInSlot attributes have their getters called from Wrap().  We
        # really hope they can't run script, and don't want to annotate Wrap()
        # methods as doing that anyway, so let's not annotate them as
        # MOZ_CAN_RUN_SCRIPT.
        CGAbstractStaticMethod.__init__(
            self,
            descriptor,
            name,
            "bool",
            args,
            canRunScript=not attr.getExtendedAttribute("StoreInSlot"),
        )

    def definition_body(self):
        prefix = fill(
            """
            auto* self = static_cast<${nativeType}*>(void_self);
            """,
            nativeType=self.descriptor.nativeType,
        )

        if self.attr.isMaplikeOrSetlikeAttr():
            assert not self.attr.getExtendedAttribute("CrossOriginReadable")
            # If the interface is maplike/setlike, there will be one getter
            # method for the size property of the backing object. Due to having
            # to unpack the backing object from the slot, this requires its own
            # generator.
            return prefix + getMaplikeOrSetlikeSizeGetterBody(
                self.descriptor, self.attr
            )

        if self.attr.type.isObservableArray():
            assert not self.attr.getExtendedAttribute("CrossOriginReadable")
            # If the attribute is observableArray, due to having to unpack the
            # backing object from the slot, this requires its own generator.
            return prefix + getObservableArrayGetterBody(self.descriptor, self.attr)

        nativeName = CGSpecializedGetter.makeNativeName(self.descriptor, self.attr)
        type = self.attr.type
        if self.attr.getExtendedAttribute("CrossOriginReadable"):
            remoteType = type
            extendedAttributes = self.descriptor.getExtendedAttributes(
                self.attr, getter=True
            )
            if (
                remoteType.isGeckoInterface()
                and not remoteType.unroll().inner.isExternal()
                and remoteType.unroll().inner.getExtendedAttribute("ChromeOnly") is None
            ):
                # We'll use a JSObject. It might make more sense to use remoteType's
                # RemoteProxy, but it's not easy to construct a type for that from here.
                remoteType = BuiltinTypes[IDLBuiltinType.Types.object]
                if "needsErrorResult" not in extendedAttributes:
                    extendedAttributes.append("needsErrorResult")
            prototypeID, _ = PrototypeIDAndDepth(self.descriptor)
            prefix = (
                fill(
                    """
                if (IsRemoteObjectProxy(obj, ${prototypeID})) {
                    ${nativeType}::RemoteProxy* self = static_cast<${nativeType}::RemoteProxy*>(void_self);
                    $*{call}
                }
            """,
                    prototypeID=prototypeID,
                    nativeType=self.descriptor.nativeType,
                    call=CGGetterCall(
                        remoteType,
                        nativeName,
                        self.descriptor,
                        self.attr,
                        dontSetSlot=True,
                        extendedAttributes=extendedAttributes,
                    ).define(),
                )
                + prefix
            )

        if self.attr.slotIndices is not None:
            # We're going to store this return value in a slot on some object,
            # to cache it.  The question is, which object?  For dictionary and
            # sequence return values, we want to use a slot on the Xray expando
            # if we're called via Xrays, and a slot on our reflector otherwise.
            # On the other hand, when dealing with some interfacce types
            # (e.g. window.document) we want to avoid calling the getter more
            # than once.  In the case of window.document, it's because the
            # getter can start returning null, which would get hidden in the
            # non-Xray case by the fact that it's [StoreOnSlot], so the cached
            # version is always around.
            #
            # The upshot is that we use the reflector slot for any getter whose
            # type is a gecko interface, whether we're called via Xrays or not.
            # Since [Cached] and [StoreInSlot] cannot be used with "NewObject",
            # we know that in the interface type case the returned object is
            # wrappercached.  So creating Xrays to it is reasonable.
            if mayUseXrayExpandoSlots(self.descriptor, self.attr):
                prefix += fill(
                    """
                    // Have to either root across the getter call or reget after.
                    bool isXray;
                    JS::Rooted<JSObject*> slotStorage(cx, GetCachedSlotStorageObject(cx, obj, &isXray));
                    if (!slotStorage) {
                      return false;
                    }
                    const size_t slotIndex = isXray ? ${xraySlotIndex} : ${slotIndex};
                    """,
                    xraySlotIndex=memberXrayExpandoReservedSlot(
                        self.attr, self.descriptor
                    ),
                    slotIndex=memberReservedSlot(self.attr, self.descriptor),
                )
            else:
                prefix += fill(
                    """
                    // Have to either root across the getter call or reget after.
                    JS::Rooted<JSObject*> slotStorage(cx, js::UncheckedUnwrap(obj, /* stopAtWindowProxy = */ false));
                    MOZ_ASSERT(IsDOMObject(slotStorage));
                    const size_t slotIndex = ${slotIndex};
                    """,
                    slotIndex=memberReservedSlot(self.attr, self.descriptor),
                )

            prefix += fill(
                """
                MOZ_ASSERT(JSCLASS_RESERVED_SLOTS(JS::GetClass(slotStorage)) > slotIndex);
                {
                  // Scope for cachedVal
                  JS::Value cachedVal = JS::GetReservedSlot(slotStorage, slotIndex);
                  if (!cachedVal.isUndefined()) {
                    args.rval().set(cachedVal);
                    // The cached value is in the compartment of slotStorage,
                    // so wrap into the caller compartment as needed.
                    return ${maybeWrap}(cx, args.rval());
                  }
                }

                """,
                maybeWrap=getMaybeWrapValueFuncForType(self.attr.type),
            )

        return (
            prefix + CGGetterCall(type, nativeName, self.descriptor, self.attr).define()
        )

    def auto_profiler_label(self):
        interface_name = self.descriptor.interface.identifier.name
        attr_name = self.attr.identifier.name
        return fill(
            """
            AUTO_PROFILER_LABEL_DYNAMIC_FAST(
              "${interface_name}", "${attr_name}", DOM, cx,
              uint32_t(js::ProfilingStackFrame::Flags::STRING_TEMPLATE_GETTER) |
              uint32_t(js::ProfilingStackFrame::Flags::RELEVANT_FOR_JS));
            """,
            interface_name=interface_name,
            attr_name=attr_name,
        )

    def error_reporting_label(self):
        # Getters never need a BindingCallContext.
        return None

    @staticmethod
    def makeNativeName(descriptor, attr):
        name = attr.identifier.name
        nativeName = MakeNativeName(descriptor.binaryNameFor(name, attr.isStatic()))
        _, resultOutParam, _, _, _ = getRetvalDeclarationForType(attr.type, descriptor)
        extendedAttrs = descriptor.getExtendedAttributes(attr, getter=True)
        canFail = "needsErrorResult" in extendedAttrs or "canOOM" in extendedAttrs
        if resultOutParam or attr.type.nullable() or canFail:
            nativeName = "Get" + nativeName
        return nativeName


class CGGetterPromiseWrapper(CGAbstractStaticMethod):
    """
    A class for generating a wrapper around another getter that will
    convert exceptions to promises.
    """

    def __init__(self, descriptor, getterToWrap):
        self.getter = getterToWrap
        name = self.makeName(getterToWrap.name)
        args = list(getterToWrap.args)
        CGAbstractStaticMethod.__init__(
            self, descriptor, name, "bool", args, canRunScript=True
        )

    def definition_body(self):
        return fill(
            """
            bool ok = ${getterName}(${args});
            if (ok) {
              return true;
            }
            return ConvertExceptionToPromise(cx, args.rval());
            """,
            getterName=self.getter.name,
            args=", ".join(arg.name for arg in self.args),
        )

    @staticmethod
    def makeName(getterName):
        return getterName + "_promiseWrapper"


class CGStaticGetter(CGAbstractStaticBindingMethod):
    """
    A class for generating the C++ code for an IDL static attribute getter.
    """

    def __init__(self, descriptor, attr):
        self.attr = attr
        name = "get_" + IDLToCIdentifier(attr.identifier.name)
        CGAbstractStaticBindingMethod.__init__(self, descriptor, name)

    def generate_code(self):
        nativeName = CGSpecializedGetter.makeNativeName(self.descriptor, self.attr)
        return CGGetterCall(self.attr.type, nativeName, self.descriptor, self.attr)

    def auto_profiler_label(self):
        interface_name = self.descriptor.interface.identifier.name
        attr_name = self.attr.identifier.name
        return fill(
            """
            AUTO_PROFILER_LABEL_DYNAMIC_FAST(
              "${interface_name}", "${attr_name}", DOM, cx,
              uint32_t(js::ProfilingStackFrame::Flags::STRING_TEMPLATE_GETTER) |
              uint32_t(js::ProfilingStackFrame::Flags::RELEVANT_FOR_JS));
            """,
            interface_name=interface_name,
            attr_name=attr_name,
        )

    def error_reporting_label(self):
        # Getters never need a BindingCallContext.
        return None


class CGSpecializedSetter(CGAbstractStaticMethod):
    """
    A class for generating the code for a specialized attribute setter
    that the JIT can call with lower overhead.
    """

    def __init__(self, descriptor, attr):
        self.attr = attr
        name = "set_" + IDLToCIdentifier(attr.identifier.name)
        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "obj"),
            Argument("void*", "void_self"),
            Argument("JSJitSetterCallArgs", "args"),
        ]
        CGAbstractStaticMethod.__init__(
            self, descriptor, name, "bool", args, canRunScript=True
        )

    def definition_body(self):
        nativeName = CGSpecializedSetter.makeNativeName(self.descriptor, self.attr)
        type = self.attr.type
        call = CGSetterCall(type, nativeName, self.descriptor, self.attr).define()
        prefix = ""
        if self.attr.getExtendedAttribute("CrossOriginWritable"):
            if type.isGeckoInterface() and not type.unroll().inner.isExternal():
                # a setter taking a Gecko interface would require us to deal with remote
                # proxies for the value here.
                raise TypeError(
                    "We don't support the setter of %s marked as "
                    "CrossOriginWritable because it takes a Gecko interface "
                    "as the value",
                    self.attr.identifier.name,
                )
            prototypeID, _ = PrototypeIDAndDepth(self.descriptor)
            prefix = fill(
                """
                if (IsRemoteObjectProxy(obj, ${prototypeID})) {
                    auto* self = static_cast<${nativeType}::RemoteProxy*>(void_self);
                    $*{call}
                }
                """,
                prototypeID=prototypeID,
                nativeType=self.descriptor.nativeType,
                call=call,
            )

        return prefix + fill(
            """
            auto* self = static_cast<${nativeType}*>(void_self);
            $*{call}
            """,
            nativeType=self.descriptor.nativeType,
            call=call,
        )

    def auto_profiler_label(self):
        interface_name = self.descriptor.interface.identifier.name
        attr_name = self.attr.identifier.name
        return fill(
            """
            AUTO_PROFILER_LABEL_DYNAMIC_FAST(
              "${interface_name}", "${attr_name}", DOM, cx,
              uint32_t(js::ProfilingStackFrame::Flags::STRING_TEMPLATE_SETTER) |
              uint32_t(js::ProfilingStackFrame::Flags::RELEVANT_FOR_JS));
            """,
            interface_name=interface_name,
            attr_name=attr_name,
        )

    @staticmethod
    def error_reporting_label_helper(descriptor, attr):
        # Setters need a BindingCallContext if the type of the attribute needs
        # one.
        if not idlTypeNeedsCallContext(
            attr.type, descriptor, allowTreatNonCallableAsNull=True
        ):
            return None
        return (
            GetLabelForErrorReporting(descriptor, attr, isConstructor=False) + " setter"
        )

    def error_reporting_label(self):
        return CGSpecializedSetter.error_reporting_label_helper(
            self.descriptor, self.attr
        )

    @staticmethod
    def makeNativeName(descriptor, attr):
        name = attr.identifier.name
        return "Set" + MakeNativeName(descriptor.binaryNameFor(name, attr.isStatic()))


class CGStaticSetter(CGAbstractStaticBindingMethod):
    """
    A class for generating the C++ code for an IDL static attribute setter.
    """

    def __init__(self, descriptor, attr):
        self.attr = attr
        name = "set_" + IDLToCIdentifier(attr.identifier.name)
        CGAbstractStaticBindingMethod.__init__(self, descriptor, name)

    def generate_code(self):
        nativeName = CGSpecializedSetter.makeNativeName(self.descriptor, self.attr)
        checkForArg = CGGeneric(
            fill(
                """
            if (!args.requireAtLeast(cx, "${name} setter", 1)) {
              return false;
            }
            """,
                name=self.attr.identifier.name,
            )
        )
        call = CGSetterCall(self.attr.type, nativeName, self.descriptor, self.attr)
        return CGList([checkForArg, call])

    def auto_profiler_label(self):
        interface_name = self.descriptor.interface.identifier.name
        attr_name = self.attr.identifier.name
        return fill(
            """
            AUTO_PROFILER_LABEL_DYNAMIC_FAST(
              "${interface_name}", "${attr_name}", DOM, cx,
              uint32_t(js::ProfilingStackFrame::Flags::STRING_TEMPLATE_SETTER) |
              uint32_t(js::ProfilingStackFrame::Flags::RELEVANT_FOR_JS));
            """,
            interface_name=interface_name,
            attr_name=attr_name,
        )

    def error_reporting_label(self):
        return CGSpecializedSetter.error_reporting_label_helper(
            self.descriptor, self.attr
        )


class CGSpecializedForwardingSetter(CGSpecializedSetter):
    """
    A class for generating the code for a specialized attribute setter with
    PutForwards that the JIT can call with lower overhead.
    """

    def __init__(self, descriptor, attr):
        CGSpecializedSetter.__init__(self, descriptor, attr)

    def definition_body(self):
        attrName = self.attr.identifier.name
        forwardToAttrName = self.attr.getExtendedAttribute("PutForwards")[0]
        # JS_GetProperty and JS_SetProperty can only deal with ASCII
        assert all(ord(c) < 128 for c in attrName)
        assert all(ord(c) < 128 for c in forwardToAttrName)
        return fill(
            """
            JS::Rooted<JS::Value> v(cx);
            if (!JS_GetProperty(cx, obj, "${attr}", &v)) {
              return false;
            }

            if (!v.isObject()) {
              return cx.ThrowErrorMessage<MSG_NOT_OBJECT>("${interface}.${attr}");
            }

            JS::Rooted<JSObject*> targetObj(cx, &v.toObject());
            return JS_SetProperty(cx, targetObj, "${forwardToAttrName}", args[0]);
            """,
            attr=attrName,
            interface=self.descriptor.interface.identifier.name,
            forwardToAttrName=forwardToAttrName,
        )

    def error_reporting_label(self):
        # We always need to be able to throw.
        return (
            GetLabelForErrorReporting(self.descriptor, self.attr, isConstructor=False)
            + " setter"
        )


class CGSpecializedReplaceableSetter(CGSpecializedSetter):
    """
    A class for generating the code for a specialized attribute setter with
    Replaceable that the JIT can call with lower overhead.
    """

    def __init__(self, descriptor, attr):
        CGSpecializedSetter.__init__(self, descriptor, attr)

    def definition_body(self):
        attrName = self.attr.identifier.name
        # JS_DefineProperty can only deal with ASCII
        assert all(ord(c) < 128 for c in attrName)
        return (
            'return JS_DefineProperty(cx, obj, "%s", args[0], JSPROP_ENUMERATE);\n'
            % attrName
        )

    def error_reporting_label(self):
        # We never throw directly.
        return None


class CGSpecializedLenientSetter(CGSpecializedSetter):
    """
    A class for generating the code for a specialized attribute setter with
    LenientSetter that the JIT can call with lower overhead.
    """

    def __init__(self, descriptor, attr):
        CGSpecializedSetter.__init__(self, descriptor, attr)

    def definition_body(self):
        attrName = self.attr.identifier.name
        # JS_DefineProperty can only deal with ASCII
        assert all(ord(c) < 128 for c in attrName)
        return dedent(
            """
            DeprecationWarning(cx, obj, DeprecatedOperations::eLenientSetter);
            return true;
            """
        )

    def error_reporting_label(self):
        # We never throw; that's the whole point.
        return None


def memberReturnsNewObject(member):
    return member.getExtendedAttribute("NewObject") is not None


class CGMemberJITInfo(CGThing):
    """
    A class for generating the JITInfo for a property that points to
    our specialized getter and setter.
    """

    def __init__(self, descriptor, member):
        self.member = member
        self.descriptor = descriptor

    def declare(self):
        return ""

    def defineJitInfo(
        self,
        infoName,
        opName,
        opType,
        infallible,
        movable,
        eliminatable,
        aliasSet,
        alwaysInSlot,
        lazilyInSlot,
        slotIndex,
        returnTypes,
        args,
    ):
        """
        aliasSet is a JSJitInfo::AliasSet value, without the "JSJitInfo::" bit.

        args is None if we don't want to output argTypes for some
        reason (e.g. we have overloads or we're not a method) and
        otherwise an iterable of the arguments for this method.
        """
        assert (
            not movable or aliasSet != "AliasEverything"
        )  # Can't move write-aliasing things
        assert (
            not alwaysInSlot or movable
        )  # Things always in slots had better be movable
        assert (
            not eliminatable or aliasSet != "AliasEverything"
        )  # Can't eliminate write-aliasing things
        assert (
            not alwaysInSlot or eliminatable
        )  # Things always in slots had better be eliminatable

        def jitInfoInitializer(isTypedMethod):
            initializer = fill(
                """
                {
                  { ${opName} },
                  { prototypes::id::${name} },
                  { PrototypeTraits<prototypes::id::${name}>::Depth },
                  JSJitInfo::${opType},
                  JSJitInfo::${aliasSet}, /* aliasSet.  Not relevant for setters. */
                  ${returnType},  /* returnType.  Not relevant for setters. */
                  ${isInfallible},  /* isInfallible. False in setters. */
                  ${isMovable},  /* isMovable.  Not relevant for setters. */
                  ${isEliminatable}, /* isEliminatable.  Not relevant for setters. */
                  ${isAlwaysInSlot}, /* isAlwaysInSlot.  Only relevant for getters. */
                  ${isLazilyCachedInSlot}, /* isLazilyCachedInSlot.  Only relevant for getters. */
                  ${isTypedMethod},  /* isTypedMethod.  Only relevant for methods. */
                  ${slotIndex}   /* Reserved slot index, if we're stored in a slot, else 0. */
                }
                """,
                opName=opName,
                name=self.descriptor.name,
                opType=opType,
                aliasSet=aliasSet,
                returnType=functools.reduce(
                    CGMemberJITInfo.getSingleReturnType, returnTypes, ""
                ),
                isInfallible=toStringBool(infallible),
                isMovable=toStringBool(movable),
                isEliminatable=toStringBool(eliminatable),
                isAlwaysInSlot=toStringBool(alwaysInSlot),
                isLazilyCachedInSlot=toStringBool(lazilyInSlot),
                isTypedMethod=toStringBool(isTypedMethod),
                slotIndex=slotIndex,
            )
            return initializer.rstrip()

        slotAssert = fill(
            """
            static_assert(${slotIndex} <= JSJitInfo::maxSlotIndex, "We won't fit");
            static_assert(${slotIndex} < ${classReservedSlots}, "There is no slot for us");
            """,
            slotIndex=slotIndex,
            classReservedSlots=INSTANCE_RESERVED_SLOTS
            + self.descriptor.interface.totalMembersInSlots,
        )
        if args is not None:
            argTypes = "%s_argTypes" % infoName
            args = [CGMemberJITInfo.getJSArgType(arg.type) for arg in args]
            args.append("JSJitInfo::ArgTypeListEnd")
            argTypesDecl = "static const JSJitInfo::ArgType %s[] = { %s };\n" % (
                argTypes,
                ", ".join(args),
            )
            return fill(
                """
                $*{argTypesDecl}
                static const JSTypedMethodJitInfo ${infoName} = {
                ${jitInfo},
                  ${argTypes}
                };
                $*{slotAssert}
                """,
                argTypesDecl=argTypesDecl,
                infoName=infoName,
                jitInfo=indent(jitInfoInitializer(True)),
                argTypes=argTypes,
                slotAssert=slotAssert,
            )

        # Unexposed things are meant to be used from C++ directly, so we make
        # their jitinfo non-static.  That way C++ can get at it.
        if self.member.getExtendedAttribute("Unexposed"):
            storageClass = "extern"
        else:
            storageClass = "static"

        return fill(
            """
            ${storageClass} const JSJitInfo ${infoName} = ${jitInfo};
            $*{slotAssert}
            """,
            storageClass=storageClass,
            infoName=infoName,
            jitInfo=jitInfoInitializer(False),
            slotAssert=slotAssert,
        )

    def define(self):
        if self.member.isAttr():
            getterinfo = "%s_getterinfo" % IDLToCIdentifier(self.member.identifier.name)
            name = IDLToCIdentifier(self.member.identifier.name)
            if self.member.type.isPromise():
                name = CGGetterPromiseWrapper.makeName(name)
            getter = "get_%s" % name
            extendedAttrs = self.descriptor.getExtendedAttributes(
                self.member, getter=True
            )
            getterinfal = "needsErrorResult" not in extendedAttrs

            # At this point getterinfal is true if our getter either can't throw
            # at all, or can only throw OOM.  In both cases, it's safe to move,
            # or dead-code-eliminate, the getter, because throwing OOM is not
            # semantically meaningful, so code can't rely on it happening.  Note
            # that this makes the behavior consistent for OOM thrown from the
            # getter itself and OOM thrown from the to-JS conversion of the
            # return value (see the "canOOM" and "infallibleForMember" checks
            # below).
            movable = self.mayBeMovable() and getterinfal
            eliminatable = self.mayBeEliminatable() and getterinfal
            aliasSet = self.aliasSet()

            # Now we have to set getterinfal to whether we can _really_ ever
            # throw, from the point of view of the JS engine.
            getterinfal = (
                getterinfal
                and "canOOM" not in extendedAttrs
                and infallibleForMember(self.member, self.member.type, self.descriptor)
            )
            isAlwaysInSlot = self.member.getExtendedAttribute("StoreInSlot")

            if self.member.slotIndices is not None:
                assert (
                    isAlwaysInSlot
                    or self.member.getExtendedAttribute("Cached")
                    or self.member.type.isObservableArray()
                )
                isLazilyCachedInSlot = not isAlwaysInSlot
                slotIndex = memberReservedSlot(self.member, self.descriptor)
                # We'll statically assert that this is not too big in
                # CGUpdateMemberSlotsMethod, in the case when
                # isAlwaysInSlot is true.
            else:
                isLazilyCachedInSlot = False
                slotIndex = "0"

            result = self.defineJitInfo(
                getterinfo,
                getter,
                "Getter",
                getterinfal,
                movable,
                eliminatable,
                aliasSet,
                isAlwaysInSlot,
                isLazilyCachedInSlot,
                slotIndex,
                [self.member.type],
                None,
            )
            if (
                not self.member.readonly
                or self.member.getExtendedAttribute("PutForwards") is not None
                or self.member.getExtendedAttribute("Replaceable") is not None
                or self.member.getExtendedAttribute("LegacyLenientSetter") is not None
            ):
                setterinfo = "%s_setterinfo" % IDLToCIdentifier(
                    self.member.identifier.name
                )
                # Actually a JSJitSetterOp, but JSJitGetterOp is first in the
                # union.
                setter = "(JSJitGetterOp)set_%s" % IDLToCIdentifier(
                    self.member.identifier.name
                )
                # Setters are always fallible, since they have to do a typed unwrap.
                result += self.defineJitInfo(
                    setterinfo,
                    setter,
                    "Setter",
                    False,
                    False,
                    False,
                    "AliasEverything",
                    False,
                    False,
                    "0",
                    [BuiltinTypes[IDLBuiltinType.Types.undefined]],
                    None,
                )
            return result
        if self.member.isMethod():
            methodinfo = "%s_methodinfo" % IDLToCIdentifier(self.member.identifier.name)
            name = CppKeywords.checkMethodName(
                IDLToCIdentifier(self.member.identifier.name)
            )
            if self.member.returnsPromise():
                name = CGMethodPromiseWrapper.makeName(name)
            # Actually a JSJitMethodOp, but JSJitGetterOp is first in the union.
            method = "(JSJitGetterOp)%s" % name

            # Methods are infallible if they are infallible, have no arguments
            # to unwrap, and have a return type that's infallible to wrap up for
            # return.
            sigs = self.member.signatures()
            if len(sigs) != 1:
                # Don't handle overloading.  If there's more than one signature,
                # one of them must take arguments.
                methodInfal = False
                args = None
                movable = False
                eliminatable = False
            else:
                sig = sigs[0]
                # For methods that affect nothing, it's OK to set movable to our
                # notion of infallible on the C++ side, without considering
                # argument conversions, since argument conversions that can
                # reliably throw would be effectful anyway and the jit doesn't
                # move effectful things.
                extendedAttrs = self.descriptor.getExtendedAttributes(self.member)
                hasInfallibleImpl = "needsErrorResult" not in extendedAttrs
                # At this point hasInfallibleImpl is true if our method either
                # can't throw at all, or can only throw OOM.  In both cases, it
                # may be safe to move, or dead-code-eliminate, the method,
                # because throwing OOM is not semantically meaningful, so code
                # can't rely on it happening.  Note that this makes the behavior
                # consistent for OOM thrown from the method itself and OOM
                # thrown from the to-JS conversion of the return value (see the
                # "canOOM" and "infallibleForMember" checks below).
                movable = self.mayBeMovable() and hasInfallibleImpl
                eliminatable = self.mayBeEliminatable() and hasInfallibleImpl
                # XXXbz can we move the smarts about fallibility due to arg
                # conversions into the JIT, using our new args stuff?
                if len(sig[1]) != 0 or not infallibleForMember(
                    self.member, sig[0], self.descriptor
                ):
                    # We have arguments or our return-value boxing can fail
                    methodInfal = False
                else:
                    methodInfal = hasInfallibleImpl and "canOOM" not in extendedAttrs
                # For now, only bother to output args if we're side-effect-free.
                if self.member.affects == "Nothing":
                    args = sig[1]
                else:
                    args = None

            aliasSet = self.aliasSet()
            result = self.defineJitInfo(
                methodinfo,
                method,
                "Method",
                methodInfal,
                movable,
                eliminatable,
                aliasSet,
                False,
                False,
                "0",
                [s[0] for s in sigs],
                args,
            )
            return result
        raise TypeError("Illegal member type to CGPropertyJITInfo")

    def mayBeMovable(self):
        """
        Returns whether this attribute or method may be movable, just
        based on Affects/DependsOn annotations.
        """
        affects = self.member.affects
        dependsOn = self.member.dependsOn
        assert affects in IDLInterfaceMember.AffectsValues
        assert dependsOn in IDLInterfaceMember.DependsOnValues
        # Things that are DependsOn=DeviceState are not movable, because we
        # don't want them coalesced with each other or loop-hoisted, since
        # their return value can change even if nothing is going on from our
        # point of view.
        return affects == "Nothing" and (
            dependsOn != "Everything" and dependsOn != "DeviceState"
        )

    def mayBeEliminatable(self):
        """
        Returns whether this attribute or method may be eliminatable, just
        based on Affects/DependsOn annotations.
        """
        # dependsOn shouldn't affect this decision at all, except in jitinfo we
        # have no way to express "Depends on everything, affects nothing",
        # because we only have three alias set values: AliasNone ("depends on
        # nothing, affects nothing"), AliasDOMSets ("depends on DOM sets,
        # affects nothing"), AliasEverything ("depends on everything, affects
        # everything").  So the [Affects=Nothing, DependsOn=Everything] case
        # gets encoded as AliasEverything and defineJitInfo asserts that if our
        # alias state is AliasEverything then we're not eliminatable (because it
        # thinks we might have side-effects at that point).  Bug 1155796 is
        # tracking possible solutions for this.
        affects = self.member.affects
        dependsOn = self.member.dependsOn
        assert affects in IDLInterfaceMember.AffectsValues
        assert dependsOn in IDLInterfaceMember.DependsOnValues
        return affects == "Nothing" and dependsOn != "Everything"

    def aliasSet(self):
        """
        Returns the alias set to store in the jitinfo.  This may not be the
        effective alias set the JIT uses, depending on whether we have enough
        information about our args to allow the JIT to prove that effectful
        argument conversions won't happen.
        """
        dependsOn = self.member.dependsOn
        assert dependsOn in IDLInterfaceMember.DependsOnValues

        if dependsOn == "Nothing" or dependsOn == "DeviceState":
            assert self.member.affects == "Nothing"
            return "AliasNone"

        if dependsOn == "DOMState":
            assert self.member.affects == "Nothing"
            return "AliasDOMSets"

        return "AliasEverything"

    @staticmethod
    def getJSReturnTypeTag(t):
        if t.nullable():
            # Sometimes it might return null, sometimes not
            return "JSVAL_TYPE_UNKNOWN"
        if t.isUndefined():
            # No return, every time
            return "JSVAL_TYPE_UNDEFINED"
        if t.isSequence():
            return "JSVAL_TYPE_OBJECT"
        if t.isRecord():
            return "JSVAL_TYPE_OBJECT"
        if t.isPromise():
            return "JSVAL_TYPE_OBJECT"
        if t.isGeckoInterface():
            return "JSVAL_TYPE_OBJECT"
        if t.isString():
            return "JSVAL_TYPE_STRING"
        if t.isEnum():
            return "JSVAL_TYPE_STRING"
        if t.isCallback():
            return "JSVAL_TYPE_OBJECT"
        if t.isAny():
            # The whole point is to return various stuff
            return "JSVAL_TYPE_UNKNOWN"
        if t.isObject():
            return "JSVAL_TYPE_OBJECT"
        if t.isSpiderMonkeyInterface():
            return "JSVAL_TYPE_OBJECT"
        if t.isUnion():
            u = t.unroll()
            if u.hasNullableType:
                # Might be null or not
                return "JSVAL_TYPE_UNKNOWN"
            return functools.reduce(
                CGMemberJITInfo.getSingleReturnType, u.flatMemberTypes, ""
            )
        if t.isDictionary():
            return "JSVAL_TYPE_OBJECT"
        if t.isObservableArray():
            return "JSVAL_TYPE_OBJECT"
        if not t.isPrimitive():
            raise TypeError("No idea what type " + str(t) + " is.")
        tag = t.tag()
        if tag == IDLType.Tags.bool:
            return "JSVAL_TYPE_BOOLEAN"
        if tag in [
            IDLType.Tags.int8,
            IDLType.Tags.uint8,
            IDLType.Tags.int16,
            IDLType.Tags.uint16,
            IDLType.Tags.int32,
        ]:
            return "JSVAL_TYPE_INT32"
        if tag in [
            IDLType.Tags.int64,
            IDLType.Tags.uint64,
            IDLType.Tags.unrestricted_float,
            IDLType.Tags.float,
            IDLType.Tags.unrestricted_double,
            IDLType.Tags.double,
        ]:
            # These all use JS_NumberValue, which can return int or double.
            # But TI treats "double" as meaning "int or double", so we're
            # good to return JSVAL_TYPE_DOUBLE here.
            return "JSVAL_TYPE_DOUBLE"
        if tag != IDLType.Tags.uint32:
            raise TypeError("No idea what type " + str(t) + " is.")
        # uint32 is sometimes int and sometimes double.
        return "JSVAL_TYPE_DOUBLE"

    @staticmethod
    def getSingleReturnType(existingType, t):
        type = CGMemberJITInfo.getJSReturnTypeTag(t)
        if existingType == "":
            # First element of the list; just return its type
            return type

        if type == existingType:
            return existingType
        if (type == "JSVAL_TYPE_DOUBLE" and existingType == "JSVAL_TYPE_INT32") or (
            existingType == "JSVAL_TYPE_DOUBLE" and type == "JSVAL_TYPE_INT32"
        ):
            # Promote INT32 to DOUBLE as needed
            return "JSVAL_TYPE_DOUBLE"
        # Different types
        return "JSVAL_TYPE_UNKNOWN"

    @staticmethod
    def getJSArgType(t):
        assert not t.isUndefined()
        if t.nullable():
            # Sometimes it might return null, sometimes not
            return (
                "JSJitInfo::ArgType(JSJitInfo::Null | %s)"
                % CGMemberJITInfo.getJSArgType(t.inner)
            )
        if t.isSequence():
            return "JSJitInfo::Object"
        if t.isPromise():
            return "JSJitInfo::Object"
        if t.isGeckoInterface():
            return "JSJitInfo::Object"
        if t.isString():
            return "JSJitInfo::String"
        if t.isEnum():
            return "JSJitInfo::String"
        if t.isCallback():
            return "JSJitInfo::Object"
        if t.isAny():
            # The whole point is to return various stuff
            return "JSJitInfo::Any"
        if t.isObject():
            return "JSJitInfo::Object"
        if t.isSpiderMonkeyInterface():
            return "JSJitInfo::Object"
        if t.isUnion():
            u = t.unroll()
            type = "JSJitInfo::Null" if u.hasNullableType else ""
            return "JSJitInfo::ArgType(%s)" % functools.reduce(
                CGMemberJITInfo.getSingleArgType, u.flatMemberTypes, type
            )
        if t.isDictionary():
            return "JSJitInfo::Object"
        if not t.isPrimitive():
            raise TypeError("No idea what type " + str(t) + " is.")
        tag = t.tag()
        if tag == IDLType.Tags.bool:
            return "JSJitInfo::Boolean"
        if tag in [
            IDLType.Tags.int8,
            IDLType.Tags.uint8,
            IDLType.Tags.int16,
            IDLType.Tags.uint16,
            IDLType.Tags.int32,
        ]:
            return "JSJitInfo::Integer"
        if tag in [
            IDLType.Tags.int64,
            IDLType.Tags.uint64,
            IDLType.Tags.unrestricted_float,
            IDLType.Tags.float,
            IDLType.Tags.unrestricted_double,
            IDLType.Tags.double,
        ]:
            # These all use JS_NumberValue, which can return int or double.
            # But TI treats "double" as meaning "int or double", so we're
            # good to return JSVAL_TYPE_DOUBLE here.
            return "JSJitInfo::Double"
        if tag != IDLType.Tags.uint32:
            raise TypeError("No idea what type " + str(t) + " is.")
        # uint32 is sometimes int and sometimes double.
        return "JSJitInfo::Double"

    @staticmethod
    def getSingleArgType(existingType, t):
        type = CGMemberJITInfo.getJSArgType(t)
        if existingType == "":
            # First element of the list; just return its type
            return type

        if type == existingType:
            return existingType
        return "%s | %s" % (existingType, type)


class CGStaticMethodJitinfo(CGGeneric):
    """
    A class for generating the JITInfo for a promise-returning static method.
    """

    def __init__(self, method):
        CGGeneric.__init__(
            self,
            "\n"
            "static const JSJitInfo %s_methodinfo = {\n"
            "  { (JSJitGetterOp)%s },\n"
            "  { prototypes::id::_ID_Count }, { 0 }, JSJitInfo::StaticMethod,\n"
            "  JSJitInfo::AliasEverything, JSVAL_TYPE_OBJECT, false, false,\n"
            "  false, false, 0\n"
            "};\n"
            % (
                IDLToCIdentifier(method.identifier.name),
                CppKeywords.checkMethodName(IDLToCIdentifier(method.identifier.name)),
            ),
        )


def getEnumValueName(value):
    # Some enum values can be empty strings.  Others might have weird
    # characters in them.  Deal with the former by returning "_empty",
    # deal with possible name collisions from that by throwing if the
    # enum value is actually "_empty", and throw on any value
    # containing non-ASCII chars for now. Replace all chars other than
    # [0-9A-Za-z_] with '_'.
    if re.match("[^\x20-\x7E]", value):
        raise SyntaxError('Enum value "' + value + '" contains non-ASCII characters')
    if re.match("^[0-9]", value):
        value = "_" + value
    value = re.sub(r"[^0-9A-Za-z_]", "_", value)
    if re.match("^_[A-Z]|__", value):
        raise SyntaxError('Enum value "' + value + '" is reserved by the C++ spec')
    if value == "_empty":
        raise SyntaxError('"_empty" is not an IDL enum value we support yet')
    if value == "":
        return "_empty"
    nativeName = MakeNativeName(value)
    if nativeName == "EndGuard_":
        raise SyntaxError(
            'Enum value "' + value + '" cannot be used because it'
            " collides with our internal EndGuard_ value.  Please"
            " rename our internal EndGuard_ to something else"
        )
    return nativeName


class CGEnumToJSValue(CGAbstractMethod):
    def __init__(self, enum):
        enumType = enum.identifier.name
        self.stringsArray = enumType + "Values::" + ENUM_ENTRY_VARIABLE_NAME
        CGAbstractMethod.__init__(
            self,
            None,
            "ToJSValue",
            "bool",
            [
                Argument("JSContext*", "aCx"),
                Argument(enumType, "aArgument"),
                Argument("JS::MutableHandle<JS::Value>", "aValue"),
            ],
        )

    def definition_body(self):
        return fill(
            """
            MOZ_ASSERT(uint32_t(aArgument) < ArrayLength(${strings}));
            JSString* resultStr =
              JS_NewStringCopyN(aCx, ${strings}[uint32_t(aArgument)].value,
                                ${strings}[uint32_t(aArgument)].length);
            if (!resultStr) {
              return false;
            }
            aValue.setString(resultStr);
            return true;
            """,
            strings=self.stringsArray,
        )


class CGEnum(CGThing):
    def __init__(self, enum):
        CGThing.__init__(self)
        self.enum = enum
        entryDecl = fill(
            """
            extern const EnumEntry ${entry_array}[${entry_count}];

            static constexpr size_t Count = ${real_entry_count};

            // Our "${entry_array}" contains an extra entry with a null string.
            static_assert(mozilla::ArrayLength(${entry_array}) - 1 == Count,
                          "Mismatch between enum strings and enum count");

            static_assert(static_cast<size_t>(${name}::EndGuard_) == Count,
                          "Mismatch between enum value and enum count");

            inline auto GetString(${name} stringId) {
              MOZ_ASSERT(static_cast<${type}>(stringId) < Count);
              const EnumEntry& entry = ${entry_array}[static_cast<${type}>(stringId)];
              return Span<const char>{entry.value, entry.length};
            }
            """,
            entry_array=ENUM_ENTRY_VARIABLE_NAME,
            entry_count=self.nEnumStrings(),
            # -1 because nEnumStrings() includes a string for EndGuard_
            real_entry_count=self.nEnumStrings() - 1,
            name=self.enum.identifier.name,
            type=self.underlyingType(),
        )
        strings = CGNamespace(
            self.stringsNamespace(),
            CGGeneric(
                declare=entryDecl,
                define=fill(
                    """
                          extern const EnumEntry ${name}[${count}] = {
                            $*{entries}
                            { nullptr, 0 }
                          };
                          """,
                    name=ENUM_ENTRY_VARIABLE_NAME,
                    count=self.nEnumStrings(),
                    entries="".join(
                        '{"%s", %d},\n' % (val, len(val)) for val in self.enum.values()
                    ),
                ),
            ),
        )
        toJSValue = CGEnumToJSValue(enum)
        self.cgThings = CGList([strings, toJSValue], "\n")

    def stringsNamespace(self):
        return self.enum.identifier.name + "Values"

    def nEnumStrings(self):
        return len(self.enum.values()) + 1

    def underlyingType(self):
        count = self.nEnumStrings()
        if count <= 256:
            return "uint8_t"
        if count <= 65536:
            return "uint16_t"
        raise ValueError(
            "Enum " + self.enum.identifier.name + " has more than 65536 values"
        )

    def declare(self):
        decl = fill(
            """
            enum class ${name} : ${ty} {
              $*{enums}
              EndGuard_
            };
            """,
            name=self.enum.identifier.name,
            ty=self.underlyingType(),
            enums=",\n".join(map(getEnumValueName, self.enum.values())) + ",\n",
        )

        return decl + "\n" + self.cgThings.declare()

    def define(self):
        return self.cgThings.define()

    def deps(self):
        return self.enum.getDeps()


def getUnionAccessorSignatureType(type, descriptorProvider):
    """
    Returns the types that are used in the getter and setter signatures for
    union types
    """
    # Flat member types have already unwrapped nullables.
    assert not type.nullable()

    # Promise types can never appear in unions, because Promise is not
    # distinguishable from anything.
    assert not type.isPromise()

    if type.isSequence() or type.isRecord():
        if type.isSequence():
            wrapperType = "Sequence"
        else:
            wrapperType = "Record"
        # We don't use the returned template here, so it's OK to just pass no
        # sourceDescription.
        elementInfo = getJSToNativeConversionInfo(
            type.inner, descriptorProvider, isMember=wrapperType
        )
        if wrapperType == "Sequence":
            innerType = elementInfo.declType
        else:
            innerType = [recordKeyDeclType(type), elementInfo.declType]

        return CGTemplatedType(wrapperType, innerType, isConst=True, isReference=True)

    # Nested unions are unwrapped automatically into our flatMemberTypes.
    assert not type.isUnion()

    if type.isGeckoInterface():
        descriptor = descriptorProvider.getDescriptor(
            type.unroll().inner.identifier.name
        )
        typeName = CGGeneric(descriptor.nativeType)
        if not type.unroll().inner.isExternal():
            typeName = CGWrapper(typeName, post="&")
        elif descriptor.interface.identifier.name == "WindowProxy":
            typeName = CGGeneric("WindowProxyHolder const&")
        else:
            # Allow null pointers for old-binding classes.
            typeName = CGWrapper(typeName, post="*")
        return typeName

    if type.isSpiderMonkeyInterface():
        typeName = CGGeneric(type.name)
        return CGWrapper(typeName, post=" const &")

    if type.isJSString():
        raise TypeError("JSString not supported in unions")

    if type.isDOMString() or type.isUSVString():
        return CGGeneric("const nsAString&")

    if type.isUTF8String():
        return CGGeneric("const nsACString&")

    if type.isByteString():
        return CGGeneric("const nsCString&")

    if type.isEnum():
        return CGGeneric(type.inner.identifier.name)

    if type.isCallback():
        return CGGeneric("%s&" % type.unroll().callback.identifier.name)

    if type.isAny():
        return CGGeneric("JS::Value")

    if type.isObject():
        return CGGeneric("JSObject*")

    if type.isDictionary():
        return CGGeneric("const %s&" % type.inner.identifier.name)

    if not type.isPrimitive():
        raise TypeError("Need native type for argument type '%s'" % str(type))

    return CGGeneric(builtinNames[type.tag()])


def getUnionTypeTemplateVars(unionType, type, descriptorProvider, isMember=False):
    assert not type.isUndefined()
    assert not isMember or isMember in ("Union", "OwningUnion")

    ownsMembers = isMember == "OwningUnion"
    name = getUnionMemberName(type)
    holderName = "m" + name + "Holder"

    # By the time tryNextCode is invoked, we're guaranteed the union has been
    # constructed as some type, since we've been trying to convert into the
    # corresponding member.
    tryNextCode = fill(
        """
        Destroy${name}();
        tryNext = true;
        return true;
        """,
        name=name,
    )

    sourceDescription = "%s branch of %s" % (type.prettyName(), unionType.prettyName())

    conversionInfo = getJSToNativeConversionInfo(
        type,
        descriptorProvider,
        failureCode=tryNextCode,
        isDefinitelyObject=not type.isDictionary(),
        isMember=isMember,
        sourceDescription=sourceDescription,
    )

    ctorNeedsCx = conversionInfo.declArgs == "cx"
    ctorArgs = "cx" if ctorNeedsCx else ""

    structType = conversionInfo.declType.define()
    externalType = getUnionAccessorSignatureType(type, descriptorProvider).define()

    if type.isObject():
        if ownsMembers:
            setValue = "mValue.mObject.SetValue(obj);"
        else:
            setValue = "mValue.mObject.SetValue(cx, obj);"

        body = fill(
            """
            MOZ_ASSERT(mType == eUninitialized);
            ${setValue}
            mType = eObject;
            """,
            setValue=setValue,
        )

        # It's a bit sketchy to do the security check after setting the value,
        # but it keeps the code cleaner and lets us avoid rooting |obj| over the
        # call to CallerSubsumes().
        body = body + fill(
            """
            if (passedToJSImpl && !CallerSubsumes(obj)) {
              cx.ThrowErrorMessage<MSG_PERMISSION_DENIED_TO_PASS_ARG>("${sourceDescription}");
              return false;
            }
            return true;
            """,
            sourceDescription=sourceDescription,
        )

        setters = [
            ClassMethod(
                "SetToObject",
                "bool",
                [
                    Argument("BindingCallContext&", "cx"),
                    Argument("JSObject*", "obj"),
                    Argument("bool", "passedToJSImpl", default="false"),
                ],
                inline=True,
                bodyInHeader=True,
                body=body,
            )
        ]
    elif type.isDictionary() and not type.inner.needsConversionFromJS:
        # In this case we are never initialized from JS to start with
        setters = None
    else:
        # Important: we need to not have our declName involve
        # maybe-GCing operations.
        jsConversion = fill(
            conversionInfo.template,
            val="value",
            maybeMutableVal="value",
            declName="memberSlot",
            holderName=(holderName if ownsMembers else "%s.ref()" % holderName),
            passedToJSImpl="passedToJSImpl",
        )

        jsConversion = fill(
            """
            tryNext = false;
            { // scope for memberSlot
              ${structType}& memberSlot = RawSetAs${name}(${ctorArgs});
              $*{jsConversion}
            }
            return true;
            """,
            structType=structType,
            name=name,
            ctorArgs=ctorArgs,
            jsConversion=jsConversion,
        )

        needCallContext = idlTypeNeedsCallContext(type)
        if needCallContext:
            cxType = "BindingCallContext&"
        else:
            cxType = "JSContext*"
        setters = [
            ClassMethod(
                "TrySetTo" + name,
                "bool",
                [
                    Argument(cxType, "cx"),
                    Argument("JS::Handle<JS::Value>", "value"),
                    Argument("bool&", "tryNext"),
                    Argument("bool", "passedToJSImpl", default="false"),
                ],
                visibility="private",
                body=jsConversion,
            )
        ]
        if needCallContext:
            # Add a method for non-binding uses of unions to allow them to set
            # things in the union without providing a call context (though if
            # they want good error reporting they'll provide one anyway).
            shimBody = fill(
                """
                BindingCallContext cx(cx_, nullptr);
                return TrySetTo${name}(cx, value, tryNext, passedToJSImpl);
                """,
                name=name,
            )
            setters.append(
                ClassMethod(
                    "TrySetTo" + name,
                    "bool",
                    [
                        Argument("JSContext*", "cx_"),
                        Argument("JS::Handle<JS::Value>", "value"),
                        Argument("bool&", "tryNext"),
                        Argument("bool", "passedToJSImpl", default="false"),
                    ],
                    visibility="private",
                    body=shimBody,
                )
            )

    return {
        "name": name,
        "structType": structType,
        "externalType": externalType,
        "setters": setters,
        "ctorArgs": ctorArgs,
        "ctorArgList": [Argument("JSContext*", "cx")] if ctorNeedsCx else [],
    }


def getUnionConversionTemplate(type):
    assert type.isUnion()
    assert not type.nullable()

    memberTypes = type.flatMemberTypes
    prettyNames = []

    interfaceMemberTypes = [t for t in memberTypes if t.isNonCallbackInterface()]
    if len(interfaceMemberTypes) > 0:
        interfaceObject = []
        for memberType in interfaceMemberTypes:
            name = getUnionMemberName(memberType)
            interfaceObject.append(
                CGGeneric(
                    "(failed = !TrySetTo%s(cx, ${val}, tryNext, ${passedToJSImpl})) || !tryNext"
                    % name
                )
            )
            prettyNames.append(memberType.prettyName())
        interfaceObject = CGWrapper(
            CGList(interfaceObject, " ||\n"),
            pre="done = ",
            post=";\n",
            reindent=True,
        )
    else:
        interfaceObject = None

    sequenceObjectMemberTypes = [t for t in memberTypes if t.isSequence()]
    if len(sequenceObjectMemberTypes) > 0:
        assert len(sequenceObjectMemberTypes) == 1
        memberType = sequenceObjectMemberTypes[0]
        name = getUnionMemberName(memberType)
        sequenceObject = CGGeneric(
            "done = (failed = !TrySetTo%s(cx, ${val}, tryNext, ${passedToJSImpl})) || !tryNext;\n"
            % name
        )
        prettyNames.append(memberType.prettyName())
    else:
        sequenceObject = None

    callbackMemberTypes = [
        t for t in memberTypes if t.isCallback() or t.isCallbackInterface()
    ]
    if len(callbackMemberTypes) > 0:
        assert len(callbackMemberTypes) == 1
        memberType = callbackMemberTypes[0]
        name = getUnionMemberName(memberType)
        callbackObject = CGGeneric(
            "done = (failed = !TrySetTo%s(cx, ${val}, tryNext, ${passedToJSImpl})) || !tryNext;\n"
            % name
        )
        prettyNames.append(memberType.prettyName())
    else:
        callbackObject = None

    dictionaryMemberTypes = [t for t in memberTypes if t.isDictionary()]
    if len(dictionaryMemberTypes) > 0:
        assert len(dictionaryMemberTypes) == 1
        memberType = dictionaryMemberTypes[0]
        name = getUnionMemberName(memberType)
        setDictionary = CGGeneric(
            "done = (failed = !TrySetTo%s(cx, ${val}, tryNext, ${passedToJSImpl})) || !tryNext;\n"
            % name
        )
        prettyNames.append(memberType.prettyName())
    else:
        setDictionary = None

    recordMemberTypes = [t for t in memberTypes if t.isRecord()]
    if len(recordMemberTypes) > 0:
        assert len(recordMemberTypes) == 1
        memberType = recordMemberTypes[0]
        name = getUnionMemberName(memberType)
        recordObject = CGGeneric(
            "done = (failed = !TrySetTo%s(cx, ${val}, tryNext, ${passedToJSImpl})) || !tryNext;\n"
            % name
        )
        prettyNames.append(memberType.prettyName())
    else:
        recordObject = None

    objectMemberTypes = [t for t in memberTypes if t.isObject()]
    if len(objectMemberTypes) > 0:
        assert len(objectMemberTypes) == 1
        # Very important to NOT construct a temporary Rooted here, since the
        # SetToObject call can call a Rooted constructor and we need to keep
        # stack discipline for Rooted.
        object = CGGeneric(
            "if (!SetToObject(cx, &${val}.toObject(), ${passedToJSImpl})) {\n"
            "  return false;\n"
            "}\n"
            "done = true;\n"
        )
        prettyNames.append(objectMemberTypes[0].prettyName())
    else:
        object = None

    hasObjectTypes = (
        interfaceObject or sequenceObject or callbackObject or object or recordObject
    )
    if hasObjectTypes:
        # "object" is not distinguishable from other types
        assert not object or not (
            interfaceObject or sequenceObject or callbackObject or recordObject
        )
        if sequenceObject or callbackObject:
            # An object can be both an sequence object and a callback or
            # dictionary, but we shouldn't have both in the union's members
            # because they are not distinguishable.
            assert not (sequenceObject and callbackObject)
            templateBody = CGElseChain([sequenceObject, callbackObject])
        else:
            templateBody = None
        if interfaceObject:
            assert not object
            if templateBody:
                templateBody = CGIfWrapper(templateBody, "!done")
            templateBody = CGList([interfaceObject, templateBody])
        else:
            templateBody = CGList([templateBody, object])

        if recordObject:
            templateBody = CGList([templateBody, CGIfWrapper(recordObject, "!done")])

        templateBody = CGIfWrapper(templateBody, "${val}.isObject()")
    else:
        templateBody = CGGeneric()

    if setDictionary:
        assert not object
        templateBody = CGList([templateBody, CGIfWrapper(setDictionary, "!done")])

    stringTypes = [t for t in memberTypes if t.isString() or t.isEnum()]
    numericTypes = [t for t in memberTypes if t.isNumeric()]
    booleanTypes = [t for t in memberTypes if t.isBoolean()]
    if stringTypes or numericTypes or booleanTypes:
        assert len(stringTypes) <= 1
        assert len(numericTypes) <= 1
        assert len(booleanTypes) <= 1

        # We will wrap all this stuff in a do { } while (0); so we
        # can use "break" for flow control.
        def getStringOrPrimitiveConversion(memberType):
            name = getUnionMemberName(memberType)
            return CGGeneric(
                "done = (failed = !TrySetTo%s(cx, ${val}, tryNext)) || !tryNext;\n"
                "break;\n" % name
            )

        other = CGList([])
        stringConversion = [getStringOrPrimitiveConversion(t) for t in stringTypes]
        numericConversion = [getStringOrPrimitiveConversion(t) for t in numericTypes]
        booleanConversion = [getStringOrPrimitiveConversion(t) for t in booleanTypes]
        if stringConversion:
            if booleanConversion:
                other.append(CGIfWrapper(booleanConversion[0], "${val}.isBoolean()"))
            if numericConversion:
                other.append(CGIfWrapper(numericConversion[0], "${val}.isNumber()"))
            other.append(stringConversion[0])
        elif numericConversion:
            if booleanConversion:
                other.append(CGIfWrapper(booleanConversion[0], "${val}.isBoolean()"))
            other.append(numericConversion[0])
        else:
            assert booleanConversion
            other.append(booleanConversion[0])

        other = CGWrapper(CGIndenter(other), pre="do {\n", post="} while (false);\n")
        if hasObjectTypes or setDictionary:
            other = CGWrapper(CGIndenter(other), "{\n", post="}\n")
            if object:
                templateBody = CGElseChain([templateBody, other])
            else:
                other = CGWrapper(other, pre="if (!done) ")
                templateBody = CGList([templateBody, other])
        else:
            assert templateBody.define() == ""
            templateBody = other
    else:
        other = None

    templateBody = CGWrapper(
        templateBody, pre="bool done = false, failed = false, tryNext;\n"
    )
    throw = CGGeneric(
        fill(
            """
            if (failed) {
              return false;
            }
            if (!done) {
              cx.ThrowErrorMessage<MSG_NOT_IN_UNION>(sourceDescription, "${names}");
              return false;
            }
            """,
            names=", ".join(prettyNames),
        )
    )

    templateBody = CGList([templateBody, throw])

    hasUndefinedType = any(t.isUndefined() for t in memberTypes)
    elseChain = []

    # The spec does this before anything else, but we do it after checking
    # for null in the case of a nullable union. In practice this shouldn't
    # make a difference, but it makes things easier because we first need to
    # call Construct on our Maybe<...>, before we can set the union type to
    # undefined, and we do that below after checking for null (see the
    # 'if nullable:' block below).
    if hasUndefinedType:
        elseChain.append(
            CGIfWrapper(
                CGGeneric("SetUndefined();\n"),
                "${val}.isUndefined()",
            )
        )

    if type.hasNullableType:
        nullTest = (
            "${val}.isNull()" if hasUndefinedType else "${val}.isNullOrUndefined()"
        )
        elseChain.append(
            CGIfWrapper(
                CGGeneric("SetNull();\n"),
                nullTest,
            )
        )

    if len(elseChain) > 0:
        elseChain.append(CGWrapper(CGIndenter(templateBody), pre="{\n", post="}\n"))
        templateBody = CGElseChain(elseChain)

    return templateBody


def getUnionInitMethods(type, isOwningUnion=False):
    assert type.isUnion()

    template = getUnionConversionTemplate(type).define()

    replacements = {
        "val": "value",
        "passedToJSImpl": "passedToJSImpl",
    }

    initBody = fill(
        """
        MOZ_ASSERT(mType == eUninitialized);

        $*{conversion}
        return true;
        """,
        conversion=string.Template(template).substitute(replacements),
    )

    return [
        ClassMethod(
            "Init",
            "bool",
            [
                Argument("BindingCallContext&", "cx"),
                Argument("JS::Handle<JS::Value>", "value"),
                Argument("const char*", "sourceDescription", default='"Value"'),
                Argument("bool", "passedToJSImpl", default="false"),
            ],
            visibility="public",
            body=initBody,
        ),
        ClassMethod(
            "Init",
            "bool",
            [
                Argument("JSContext*", "cx_"),
                Argument("JS::Handle<JS::Value>", "value"),
                Argument("const char*", "sourceDescription", default='"Value"'),
                Argument("bool", "passedToJSImpl", default="false"),
            ],
            visibility="public",
            body=dedent(
                """
                BindingCallContext cx(cx_, nullptr);
                return Init(cx, value, sourceDescription, passedToJSImpl);
                """
            ),
        ),
    ]


class CGUnionStruct(CGThing):
    def __init__(self, type, descriptorProvider, ownsMembers=False):
        CGThing.__init__(self)
        self.type = type.unroll()
        self.descriptorProvider = descriptorProvider
        self.ownsMembers = ownsMembers
        self.struct = self.getStruct()

    def declare(self):
        return self.struct.declare()

    def define(self):
        return self.struct.define()

    def deps(self):
        return self.type.getDeps()

    def getStruct(self):

        members = [
            ClassMember("mType", "TypeOrUninit", body="eUninitialized"),
            ClassMember("mValue", "Value"),
        ]
        ctor = ClassConstructor(
            [], bodyInHeader=True, visibility="public", explicit=True
        )

        methods = []
        enumValues = ["eUninitialized"]
        toJSValCases = [
            CGCase(
                "eUninitialized", CGGeneric("return false;\n"), CGCase.DONT_ADD_BREAK
            )
        ]
        destructorCases = [CGCase("eUninitialized", None)]
        assignmentCase = CGCase(
            "eUninitialized",
            CGGeneric(
                "MOZ_ASSERT(mType == eUninitialized,\n"
                '           "We need to destroy ourselves?");\n'
            ),
        )
        assignmentCases = [assignmentCase]
        moveCases = [assignmentCase]
        traceCases = []
        unionValues = []

        def addSpecialType(typename):
            enumValue = "e" + typename
            enumValues.append(enumValue)
            methods.append(
                ClassMethod(
                    "Is" + typename,
                    "bool",
                    [],
                    const=True,
                    inline=True,
                    body="return mType == %s;\n" % enumValue,
                    bodyInHeader=True,
                )
            )
            methods.append(
                ClassMethod(
                    "Set" + typename,
                    "void",
                    [],
                    inline=True,
                    body=fill(
                        """
                        Uninit();
                        mType = ${enumValue};
                        """,
                        enumValue=enumValue,
                    ),
                    bodyInHeader=True,
                )
            )
            destructorCases.append(CGCase(enumValue, None))
            assignmentCase = CGCase(
                enumValue,
                CGGeneric(
                    fill(
                        """
                            MOZ_ASSERT(mType == eUninitialized);
                            mType = ${enumValue};
                            """,
                        enumValue=enumValue,
                    )
                ),
            )
            assignmentCases.append(assignmentCase)
            moveCases.append(assignmentCase)
            toJSValCases.append(
                CGCase(
                    enumValue,
                    CGGeneric(
                        fill(
                            """
                            rval.set${typename}();
                            return true;
                            """,
                            typename=typename,
                        )
                    ),
                    CGCase.DONT_ADD_BREAK,
                )
            )

        if self.type.hasNullableType:
            addSpecialType("Null")

        hasObjectType = any(t.isObject() for t in self.type.flatMemberTypes)
        skipToJSVal = False
        for t in self.type.flatMemberTypes:
            if t.isUndefined():
                addSpecialType("Undefined")
                continue

            vars = getUnionTypeTemplateVars(
                self.type,
                t,
                self.descriptorProvider,
                isMember="OwningUnion" if self.ownsMembers else "Union",
            )
            if vars["setters"]:
                methods.extend(vars["setters"])
            uninit = "Uninit();"
            if hasObjectType and not self.ownsMembers:
                uninit = (
                    'MOZ_ASSERT(mType != eObject, "This will not play well with Rooted");\n'
                    + uninit
                )
            if not t.isObject() or self.ownsMembers:
                body = fill(
                    """
                    if (mType == e${name}) {
                      return mValue.m${name}.Value();
                    }
                    %s
                    mType = e${name};
                    return mValue.m${name}.SetValue(${ctorArgs});
                    """,
                    **vars,
                )

                # bodyInHeader must be false for return values because they own
                # their union members and we don't want include headers in
                # UnionTypes.h just to call Addref/Release
                methods.append(
                    ClassMethod(
                        "RawSetAs" + vars["name"],
                        vars["structType"] + "&",
                        vars["ctorArgList"],
                        bodyInHeader=not self.ownsMembers,
                        body=body % "MOZ_ASSERT(mType == eUninitialized);",
                    )
                )
                methods.append(
                    ClassMethod(
                        "SetAs" + vars["name"],
                        vars["structType"] + "&",
                        vars["ctorArgList"],
                        bodyInHeader=not self.ownsMembers,
                        body=body % uninit,
                    )
                )

                # Provide a SetStringLiteral() method to support string defaults.
                if t.isByteString() or t.isUTF8String():
                    charType = "const nsCString::char_type"
                elif t.isString():
                    charType = "const nsString::char_type"
                else:
                    charType = None

                if charType:
                    methods.append(
                        ClassMethod(
                            "SetStringLiteral",
                            "void",
                            # Hack, but it works...
                            [Argument(charType, "(&aData)[N]")],
                            inline=True,
                            bodyInHeader=True,
                            templateArgs=["int N"],
                            body="RawSetAs%s().AssignLiteral(aData);\n" % t.name,
                        )
                    )

            body = fill("return mType == e${name};\n", **vars)
            methods.append(
                ClassMethod(
                    "Is" + vars["name"],
                    "bool",
                    [],
                    const=True,
                    bodyInHeader=True,
                    body=body,
                )
            )

            body = fill(
                """
                MOZ_RELEASE_ASSERT(Is${name}(), "Wrong type!");
                mValue.m${name}.Destroy();
                mType = eUninitialized;
                """,
                **vars,
            )
            methods.append(
                ClassMethod(
                    "Destroy" + vars["name"],
                    "void",
                    [],
                    visibility="private",
                    bodyInHeader=not self.ownsMembers,
                    body=body,
                )
            )

            body = fill(
                """
                MOZ_RELEASE_ASSERT(Is${name}(), "Wrong type!");
                return mValue.m${name}.Value();
                """,
                **vars,
            )
            # The non-const version of GetAs* returns our internal type
            getterReturnType = "%s&" % vars["structType"]
            methods.append(
                ClassMethod(
                    "GetAs" + vars["name"],
                    getterReturnType,
                    [],
                    bodyInHeader=True,
                    body=body,
                )
            )
            # The const version of GetAs* returns our internal type
            # for owning unions, but our external type for non-owning
            # ones.
            if self.ownsMembers:
                getterReturnType = "%s const &" % vars["structType"]
            else:
                getterReturnType = vars["externalType"]
            methods.append(
                ClassMethod(
                    "GetAs" + vars["name"],
                    getterReturnType,
                    [],
                    const=True,
                    bodyInHeader=True,
                    body=body,
                )
            )

            unionValues.append(fill("UnionMember<${structType} > m${name}", **vars))
            destructorCases.append(
                CGCase("e" + vars["name"], CGGeneric("Destroy%s();\n" % vars["name"]))
            )

            enumValues.append("e" + vars["name"])

            conversionToJS = self.getConversionToJS(vars, t)
            if conversionToJS:
                toJSValCases.append(
                    CGCase("e" + vars["name"], conversionToJS, CGCase.DONT_ADD_BREAK)
                )
            else:
                skipToJSVal = True

            assignmentCases.append(
                CGCase(
                    "e" + vars["name"],
                    CGGeneric(
                        "SetAs%s() = aOther.GetAs%s();\n" % (vars["name"], vars["name"])
                    ),
                )
            )
            moveCases.append(
                CGCase(
                    "e" + vars["name"],
                    CGGeneric(
                        "mType = e%s;\n" % vars["name"]
                        + "mValue.m%s.SetValue(std::move(aOther.mValue.m%s.Value()));\n"
                        % (vars["name"], vars["name"])
                    ),
                )
            )
            if self.ownsMembers and typeNeedsRooting(t):
                if t.isObject():
                    traceCases.append(
                        CGCase(
                            "e" + vars["name"],
                            CGGeneric(
                                'JS::TraceRoot(trc, %s, "%s");\n'
                                % (
                                    "&mValue.m" + vars["name"] + ".Value()",
                                    "mValue.m" + vars["name"],
                                )
                            ),
                        )
                    )
                elif t.isDictionary():
                    traceCases.append(
                        CGCase(
                            "e" + vars["name"],
                            CGGeneric(
                                "mValue.m%s.Value().TraceDictionary(trc);\n"
                                % vars["name"]
                            ),
                        )
                    )
                elif t.isSequence():
                    traceCases.append(
                        CGCase(
                            "e" + vars["name"],
                            CGGeneric(
                                "DoTraceSequence(trc, mValue.m%s.Value());\n"
                                % vars["name"]
                            ),
                        )
                    )
                elif t.isRecord():
                    traceCases.append(
                        CGCase(
                            "e" + vars["name"],
                            CGGeneric(
                                "TraceRecord(trc, mValue.m%s.Value());\n" % vars["name"]
                            ),
                        )
                    )
                else:
                    assert t.isSpiderMonkeyInterface()
                    traceCases.append(
                        CGCase(
                            "e" + vars["name"],
                            CGGeneric(
                                "mValue.m%s.Value().TraceSelf(trc);\n" % vars["name"]
                            ),
                        )
                    )

        dtor = CGSwitch("mType", destructorCases).define()

        methods.extend(getUnionInitMethods(self.type, isOwningUnion=self.ownsMembers))
        methods.append(
            ClassMethod(
                "Uninit",
                "void",
                [],
                visibility="public",
                body=dtor,
                bodyInHeader=not self.ownsMembers,
                inline=not self.ownsMembers,
            )
        )

        if not skipToJSVal:
            methods.append(
                ClassMethod(
                    "ToJSVal",
                    "bool",
                    [
                        Argument("JSContext*", "cx"),
                        Argument("JS::Handle<JSObject*>", "scopeObj"),
                        Argument("JS::MutableHandle<JS::Value>", "rval"),
                    ],
                    body=CGSwitch(
                        "mType", toJSValCases, default=CGGeneric("return false;\n")
                    ).define(),
                    const=True,
                )
            )

        constructors = [ctor]
        selfName = CGUnionStruct.unionTypeName(self.type, self.ownsMembers)
        if self.ownsMembers:
            if traceCases:
                traceBody = CGSwitch(
                    "mType", traceCases, default=CGGeneric("")
                ).define()
                methods.append(
                    ClassMethod(
                        "TraceUnion",
                        "void",
                        [Argument("JSTracer*", "trc")],
                        body=traceBody,
                    )
                )

            op_body = CGList([])
            op_body.append(CGSwitch("aOther.mType", moveCases))
            constructors.append(
                ClassConstructor(
                    [Argument("%s&&" % selfName, "aOther")],
                    visibility="public",
                    body=op_body.define(),
                )
            )

            methods.append(
                ClassMethod(
                    "operator=",
                    "%s&" % selfName,
                    [Argument("%s&&" % selfName, "aOther")],
                    body="this->~%s();\nnew (this) %s (std::move(aOther));\nreturn *this;\n"
                    % (selfName, selfName),
                )
            )

            body = dedent(
                """
                MOZ_RELEASE_ASSERT(mType != eUninitialized);
                return static_cast<Type>(mType);
                """
            )
            methods.append(
                ClassMethod(
                    "GetType",
                    "Type",
                    [],
                    bodyInHeader=True,
                    body=body,
                    const=True,
                )
            )

            if CGUnionStruct.isUnionCopyConstructible(self.type):
                constructors.append(
                    ClassConstructor(
                        [Argument("const %s&" % selfName, "aOther")],
                        bodyInHeader=True,
                        visibility="public",
                        explicit=True,
                        body="*this = aOther;\n",
                    )
                )
                op_body = CGList([])
                op_body.append(CGSwitch("aOther.mType", assignmentCases))
                op_body.append(CGGeneric("return *this;\n"))
                methods.append(
                    ClassMethod(
                        "operator=",
                        "%s&" % selfName,
                        [Argument("const %s&" % selfName, "aOther")],
                        body=op_body.define(),
                    )
                )
                disallowCopyConstruction = False
            else:
                disallowCopyConstruction = True
        else:
            disallowCopyConstruction = True

        if self.ownsMembers and idlTypeNeedsCycleCollection(self.type):
            friend = (
                "  friend void ImplCycleCollectionUnlink(%s& aUnion);\n"
                % CGUnionStruct.unionTypeName(self.type, True)
            )
        else:
            friend = ""

        enumValuesNoUninit = [x for x in enumValues if x != "eUninitialized"]

        bases = [ClassBase("AllOwningUnionBase")] if self.ownsMembers else []
        enums = [
            ClassEnum("TypeOrUninit", enumValues, visibility="private"),
            ClassEnum(
                "Type",
                enumValuesNoUninit,
                visibility="public",
                enumClass=True,
                values=["TypeOrUninit::" + x for x in enumValuesNoUninit],
            ),
        ]
        return CGClass(
            selfName,
            bases=bases,
            members=members,
            constructors=constructors,
            methods=methods,
            disallowCopyConstruction=disallowCopyConstruction,
            extradeclarations=friend,
            destructor=ClassDestructor(
                visibility="public", body="Uninit();\n", bodyInHeader=True
            ),
            enums=enums,
            unions=[ClassUnion("Value", unionValues, visibility="private")],
        )

    def getConversionToJS(self, templateVars, type):
        if type.isDictionary() and not type.inner.needsConversionToJS:
            # We won't be able to convert this dictionary to a JS value, nor
            # will we need to, since we don't need a ToJSVal method at all.
            return None

        assert not type.nullable()  # flatMemberTypes never has nullable types
        val = "mValue.m%(name)s.Value()" % templateVars
        wrapCode = wrapForType(
            type,
            self.descriptorProvider,
            {
                "jsvalRef": "rval",
                "jsvalHandle": "rval",
                "obj": "scopeObj",
                "result": val,
                "spiderMonkeyInterfacesAreStructs": True,
            },
        )
        return CGGeneric(wrapCode)

    @staticmethod
    def isUnionCopyConstructible(type):
        return all(isTypeCopyConstructible(t) for t in type.flatMemberTypes)

    @staticmethod
    def unionTypeName(type, ownsMembers):
        """
        Returns a string name for this known union type.
        """
        assert type.isUnion() and not type.nullable()
        return ("Owning" if ownsMembers else "") + type.name

    @staticmethod
    def unionTypeDecl(type, ownsMembers):
        """
        Returns a string for declaring this possibly-nullable union type.
        """
        assert type.isUnion()
        nullable = type.nullable()
        if nullable:
            type = type.inner
        decl = CGGeneric(CGUnionStruct.unionTypeName(type, ownsMembers))
        if nullable:
            decl = CGTemplatedType("Nullable", decl)
        return decl.define()


class ClassItem:
    """Use with CGClass"""

    def __init__(self, name, visibility):
        self.name = name
        self.visibility = visibility

    def declare(self, cgClass):
        assert False

    def define(self, cgClass):
        assert False


class ClassBase(ClassItem):
    def __init__(self, name, visibility="public"):
        ClassItem.__init__(self, name, visibility)

    def declare(self, cgClass):
        return "%s %s" % (self.visibility, self.name)

    def define(self, cgClass):
        # Only in the header
        return ""


class ClassMethod(ClassItem):
    def __init__(
        self,
        name,
        returnType,
        args,
        inline=False,
        static=False,
        virtual=False,
        const=False,
        bodyInHeader=False,
        templateArgs=None,
        visibility="public",
        body=None,
        breakAfterReturnDecl="\n",
        breakAfterSelf="\n",
        override=False,
        canRunScript=False,
    ):
        """
        override indicates whether to flag the method as override
        """
        assert not override or virtual
        assert not (override and static)
        self.returnType = returnType
        self.args = args
        self.inline = inline or bodyInHeader
        self.static = static
        self.virtual = virtual
        self.const = const
        self.bodyInHeader = bodyInHeader
        self.templateArgs = templateArgs
        self.body = body
        self.breakAfterReturnDecl = breakAfterReturnDecl
        self.breakAfterSelf = breakAfterSelf
        self.override = override
        self.canRunScript = canRunScript
        ClassItem.__init__(self, name, visibility)

    def getDecorators(self, declaring):
        decorators = []
        if self.canRunScript:
            decorators.append("MOZ_CAN_RUN_SCRIPT")
        if self.inline:
            decorators.append("inline")
        if declaring:
            if self.static:
                decorators.append("static")
            if self.virtual and not self.override:
                decorators.append("virtual")
        if decorators:
            return " ".join(decorators) + " "
        return ""

    def getBody(self):
        # Override me or pass a string to constructor
        assert self.body is not None
        return self.body

    def declare(self, cgClass):
        templateClause = (
            "template <%s>\n" % ", ".join(self.templateArgs)
            if self.bodyInHeader and self.templateArgs
            else ""
        )
        args = ", ".join([a.declare() for a in self.args])
        if self.bodyInHeader:
            body = indent(self.getBody())
            body = "\n{\n" + body + "}\n"
        else:
            body = ";\n"

        return fill(
            "${templateClause}${decorators}${returnType}${breakAfterReturnDecl}"
            "${name}(${args})${const}${override}${body}"
            "${breakAfterSelf}",
            templateClause=templateClause,
            decorators=self.getDecorators(True),
            returnType=self.returnType,
            breakAfterReturnDecl=self.breakAfterReturnDecl,
            name=self.name,
            args=args,
            const=" const" if self.const else "",
            override=" override" if self.override else "",
            body=body,
            breakAfterSelf=self.breakAfterSelf,
        )

    def define(self, cgClass):
        if self.bodyInHeader:
            return ""

        templateArgs = cgClass.templateArgs
        if templateArgs:
            if cgClass.templateSpecialization:
                templateArgs = templateArgs[len(cgClass.templateSpecialization) :]

        if templateArgs:
            templateClause = "template <%s>\n" % ", ".join(
                [str(a) for a in templateArgs]
            )
        else:
            templateClause = ""

        return fill(
            """
            ${templateClause}${decorators}${returnType}
            ${className}::${name}(${args})${const}
            {
              $*{body}
            }
            """,
            templateClause=templateClause,
            decorators=self.getDecorators(False),
            returnType=self.returnType,
            className=cgClass.getNameString(),
            name=self.name,
            args=", ".join([a.define() for a in self.args]),
            const=" const" if self.const else "",
            body=self.getBody(),
        )


class ClassUsingDeclaration(ClassItem):
    """
    Used for importing a name from a base class into a CGClass

    baseClass is the name of the base class to import the name from

    name is the name to import

    visibility determines the visibility of the name (public,
    protected, private), defaults to public.
    """

    def __init__(self, baseClass, name, visibility="public"):
        self.baseClass = baseClass
        ClassItem.__init__(self, name, visibility)

    def declare(self, cgClass):
        return "using %s::%s;\n\n" % (self.baseClass, self.name)

    def define(self, cgClass):
        return ""


class ClassConstructor(ClassItem):
    """
    Used for adding a constructor to a CGClass.

    args is a list of Argument objects that are the arguments taken by the
    constructor.

    inline should be True if the constructor should be marked inline.

    bodyInHeader should be True if the body should be placed in the class
    declaration in the header.

    default should be True if the definition of the constructor should be
    `= default;`.

    visibility determines the visibility of the constructor (public,
    protected, private), defaults to private.

    explicit should be True if the constructor should be marked explicit.

    baseConstructors is a list of strings containing calls to base constructors,
    defaults to None.

    body contains a string with the code for the constructor, defaults to empty.
    """

    def __init__(
        self,
        args,
        inline=False,
        bodyInHeader=False,
        default=False,
        visibility="private",
        explicit=False,
        constexpr=False,
        baseConstructors=None,
        body="",
    ):
        assert not (inline and constexpr)
        assert not (bodyInHeader and constexpr)
        assert not (default and body)
        self.args = args
        self.inline = inline or bodyInHeader
        self.bodyInHeader = bodyInHeader or constexpr or default
        self.default = default
        self.explicit = explicit
        self.constexpr = constexpr
        self.baseConstructors = baseConstructors or []
        self.body = body
        ClassItem.__init__(self, None, visibility)

    def getDecorators(self, declaring):
        decorators = []
        if declaring:
            if self.explicit:
                decorators.append("explicit")
            if self.inline:
                decorators.append("inline")
            if self.constexpr:
                decorators.append("constexpr")
        if decorators:
            return " ".join(decorators) + " "
        return ""

    def getInitializationList(self, cgClass):
        items = [str(c) for c in self.baseConstructors]
        for m in cgClass.members:
            if not m.static:
                initialize = m.body
                if initialize:
                    items.append(m.name + "(" + initialize + ")")

        if len(items) > 0:
            return "\n  : " + ",\n    ".join(items)
        return ""

    def getBody(self):
        return self.body

    def declare(self, cgClass):
        args = ", ".join([a.declare() for a in self.args])
        if self.bodyInHeader:
            if self.default:
                body = " = default;\n"
            else:
                body = (
                    self.getInitializationList(cgClass)
                    + "\n{\n"
                    + indent(self.getBody())
                    + "}\n"
                )
        else:
            body = ";\n"

        return fill(
            "${decorators}${className}(${args})${body}\n",
            decorators=self.getDecorators(True),
            className=cgClass.getNameString(),
            args=args,
            body=body,
        )

    def define(self, cgClass):
        if self.bodyInHeader:
            return ""

        return fill(
            """
            ${decorators}
            ${className}::${className}(${args})${initializationList}
            {
              $*{body}
            }
            """,
            decorators=self.getDecorators(False),
            className=cgClass.getNameString(),
            args=", ".join([a.define() for a in self.args]),
            initializationList=self.getInitializationList(cgClass),
            body=self.getBody(),
        )


class ClassDestructor(ClassItem):
    """
    Used for adding a destructor to a CGClass.

    inline should be True if the destructor should be marked inline.

    bodyInHeader should be True if the body should be placed in the class
    declaration in the header.

    visibility determines the visibility of the destructor (public,
    protected, private), defaults to private.

    body contains a string with the code for the destructor, defaults to empty.

    virtual determines whether the destructor is virtual, defaults to False.
    """

    def __init__(
        self,
        inline=False,
        bodyInHeader=False,
        visibility="private",
        body="",
        virtual=False,
    ):
        self.inline = inline or bodyInHeader
        self.bodyInHeader = bodyInHeader
        self.body = body
        self.virtual = virtual
        ClassItem.__init__(self, None, visibility)

    def getDecorators(self, declaring):
        decorators = []
        if self.virtual and declaring:
            decorators.append("virtual")
        if self.inline and declaring:
            decorators.append("inline")
        if decorators:
            return " ".join(decorators) + " "
        return ""

    def getBody(self):
        return self.body

    def declare(self, cgClass):
        if self.bodyInHeader:
            body = "\n{\n" + indent(self.getBody()) + "}\n"
        else:
            body = ";\n"

        return fill(
            "${decorators}~${className}()${body}\n",
            decorators=self.getDecorators(True),
            className=cgClass.getNameString(),
            body=body,
        )

    def define(self, cgClass):
        if self.bodyInHeader:
            return ""
        return fill(
            """
            ${decorators}
            ${className}::~${className}()
            {
              $*{body}
            }
            """,
            decorators=self.getDecorators(False),
            className=cgClass.getNameString(),
            body=self.getBody(),
        )


class ClassMember(ClassItem):
    def __init__(
        self,
        name,
        type,
        visibility="private",
        static=False,
        body=None,
        hasIgnoreInitCheckFlag=False,
    ):
        self.type = type
        self.static = static
        self.body = body
        self.hasIgnoreInitCheckFlag = hasIgnoreInitCheckFlag
        ClassItem.__init__(self, name, visibility)

    def declare(self, cgClass):
        return "%s%s%s %s;\n" % (
            "static " if self.static else "",
            "MOZ_INIT_OUTSIDE_CTOR " if self.hasIgnoreInitCheckFlag else "",
            self.type,
            self.name,
        )

    def define(self, cgClass):
        if not self.static:
            return ""
        if self.body:
            body = " = " + self.body
        else:
            body = ""
        return "%s %s::%s%s;\n" % (self.type, cgClass.getNameString(), self.name, body)


class ClassEnum(ClassItem):
    def __init__(
        self, name, entries, values=None, visibility="public", enumClass=False
    ):
        self.entries = entries
        self.values = values
        self.enumClass = enumClass
        ClassItem.__init__(self, name, visibility)

    def declare(self, cgClass):
        entries = []
        for i in range(0, len(self.entries)):
            if not self.values or i >= len(self.values):
                entry = "%s" % self.entries[i]
            else:
                entry = "%s = %s" % (self.entries[i], self.values[i])
            entries.append(entry)

        decl = ["enum"]
        self.enumClass and decl.append("class")
        self.name and decl.append(self.name)
        decl = " ".join(decl)

        return "%s\n{\n%s\n};\n" % (decl, indent(",\n".join(entries)))

    def define(self, cgClass):
        # Only goes in the header
        return ""


class ClassUnion(ClassItem):
    def __init__(self, name, entries, visibility="public"):
        self.entries = [entry + ";\n" for entry in entries]
        ClassItem.__init__(self, name, visibility)

    def declare(self, cgClass):
        return "union %s\n{\n%s\n};\n" % (self.name, indent("".join(self.entries)))

    def define(self, cgClass):
        # Only goes in the header
        return ""


class CGClass(CGThing):
    def __init__(
        self,
        name,
        bases=[],
        members=[],
        constructors=[],
        destructor=None,
        methods=[],
        enums=[],
        unions=[],
        templateArgs=[],
        templateSpecialization=[],
        isStruct=False,
        disallowCopyConstruction=False,
        indent="",
        decorators="",
        extradeclarations="",
        extradefinitions="",
    ):
        CGThing.__init__(self)
        self.name = name
        self.bases = bases
        self.members = members
        self.constructors = constructors
        # We store our single destructor in a list, since all of our
        # code wants lists of members.
        self.destructors = [destructor] if destructor else []
        self.methods = methods
        self.enums = enums
        self.unions = unions
        self.templateArgs = templateArgs
        self.templateSpecialization = templateSpecialization
        self.isStruct = isStruct
        self.disallowCopyConstruction = disallowCopyConstruction
        self.indent = indent
        self.defaultVisibility = "public" if isStruct else "private"
        self.decorators = decorators
        self.extradeclarations = extradeclarations
        self.extradefinitions = extradefinitions

    def getNameString(self):
        className = self.name
        if self.templateSpecialization:
            className += "<%s>" % ", ".join(
                [str(a) for a in self.templateSpecialization]
            )
        return className

    def declare(self):
        result = ""
        if self.templateArgs:
            templateArgs = [a.declare() for a in self.templateArgs]
            templateArgs = templateArgs[len(self.templateSpecialization) :]
            result += "template <%s>\n" % ",".join([str(a) for a in templateArgs])

        type = "struct" if self.isStruct else "class"

        if self.templateSpecialization:
            specialization = "<%s>" % ", ".join(
                [str(a) for a in self.templateSpecialization]
            )
        else:
            specialization = ""

        myself = "%s %s%s" % (type, self.name, specialization)
        if self.decorators != "":
            myself += " " + self.decorators
        result += myself

        if self.bases:
            inherit = " : "
            result += inherit
            # Grab our first base
            baseItems = [CGGeneric(b.declare(self)) for b in self.bases]
            bases = baseItems[:1]
            # Indent the rest
            bases.extend(
                CGIndenter(b, len(myself) + len(inherit)) for b in baseItems[1:]
            )
            result += ",\n".join(b.define() for b in bases)

        result += "\n{\n"

        result += self.extradeclarations

        def declareMembers(cgClass, memberList, defaultVisibility):
            members = {"private": [], "protected": [], "public": []}

            for member in memberList:
                members[member.visibility].append(member)

            if defaultVisibility == "public":
                order = ["public", "protected", "private"]
            else:
                order = ["private", "protected", "public"]

            result = ""

            lastVisibility = defaultVisibility
            for visibility in order:
                list = members[visibility]
                if list:
                    if visibility != lastVisibility:
                        result += visibility + ":\n"
                    for member in list:
                        result += indent(member.declare(cgClass))
                    lastVisibility = visibility
            return (result, lastVisibility)

        if self.disallowCopyConstruction:

            class DisallowedCopyConstructor(object):
                def __init__(self):
                    self.visibility = "private"

                def declare(self, cgClass):
                    name = cgClass.getNameString()
                    return (
                        "%s(const %s&) = delete;\n"
                        "%s& operator=(const %s&) = delete;\n"
                        % (name, name, name, name)
                    )

            disallowedCopyConstructors = [DisallowedCopyConstructor()]
        else:
            disallowedCopyConstructors = []

        order = [
            self.enums,
            self.unions,
            self.members,
            self.constructors + disallowedCopyConstructors,
            self.destructors,
            self.methods,
        ]

        lastVisibility = self.defaultVisibility
        pieces = []
        for memberList in order:
            code, lastVisibility = declareMembers(self, memberList, lastVisibility)

            if code:
                code = code.rstrip() + "\n"  # remove extra blank lines at the end
                pieces.append(code)

        result += "\n".join(pieces)
        result += "};\n"
        result = indent(result, len(self.indent))
        return result

    def define(self):
        def defineMembers(cgClass, memberList, itemCount, separator=""):
            result = ""
            for member in memberList:
                if itemCount != 0:
                    result = result + separator
                definition = member.define(cgClass)
                if definition:
                    # Member variables would only produce empty lines here.
                    result += definition
                    itemCount += 1
            return (result, itemCount)

        order = [
            (self.members, ""),
            (self.constructors, "\n"),
            (self.destructors, "\n"),
            (self.methods, "\n"),
        ]

        result = self.extradefinitions
        itemCount = 0
        for memberList, separator in order:
            memberString, itemCount = defineMembers(
                self, memberList, itemCount, separator
            )
            result = result + memberString
        return result


class CGResolveOwnPropertyViaResolve(CGAbstractBindingMethod):
    """
    An implementation of Xray ResolveOwnProperty stuff for things that have a
    resolve hook.
    """

    def __init__(self, descriptor):
        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "wrapper"),
            Argument("JS::Handle<JSObject*>", "obj"),
            Argument("JS::Handle<jsid>", "id"),
            Argument("JS::MutableHandle<Maybe<JS::PropertyDescriptor>>", "desc"),
        ]
        CGAbstractBindingMethod.__init__(
            self,
            descriptor,
            "ResolveOwnPropertyViaResolve",
            args,
            getThisObj="",
            callArgs="",
        )

    def generate_code(self):
        return CGGeneric(
            dedent(
                """
            {
              // Since we're dealing with an Xray, do the resolve on the
              // underlying object first.  That gives it a chance to
              // define properties on the actual object as needed, and
              // then use the fact that it created the objects as a flag
              // to avoid re-resolving the properties if someone deletes
              // them.
              JSAutoRealm ar(cx, obj);
              JS_MarkCrossZoneId(cx, id);
              JS::Rooted<mozilla::Maybe<JS::PropertyDescriptor>> objDesc(cx);
              if (!self->DoResolve(cx, obj, id, &objDesc)) {
                return false;
              }
              // If desc->value() is undefined, then the DoResolve call
              // has already defined the property on the object.  Don't
              // try to also define it.
              if (objDesc.isSome() &&
                  !objDesc->value().isUndefined()) {
                JS::Rooted<JS::PropertyDescriptor> defineDesc(cx, *objDesc);
                if (!JS_DefinePropertyById(cx, obj, id, defineDesc)) {
                  return false;
                }
              }
            }
            return self->DoResolve(cx, wrapper, id, desc);
            """
            )
        )


class CGEnumerateOwnPropertiesViaGetOwnPropertyNames(CGAbstractBindingMethod):
    """
    An implementation of Xray EnumerateOwnProperties stuff for things
    that have a resolve hook.
    """

    def __init__(self, descriptor):
        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "wrapper"),
            Argument("JS::Handle<JSObject*>", "obj"),
            Argument("JS::MutableHandleVector<jsid>", "props"),
        ]
        CGAbstractBindingMethod.__init__(
            self,
            descriptor,
            "EnumerateOwnPropertiesViaGetOwnPropertyNames",
            args,
            getThisObj="",
            callArgs="",
        )

    def generate_code(self):
        return CGGeneric(
            dedent(
                """
            FastErrorResult rv;
            // This wants all own props, not just enumerable ones.
            self->GetOwnPropertyNames(cx, props, false, rv);
            if (rv.MaybeSetPendingException(cx)) {
              return false;
            }
            return true;
            """
            )
        )


class CGPrototypeTraitsClass(CGClass):
    def __init__(self, descriptor, indent=""):
        templateArgs = [Argument("prototypes::ID", "PrototypeID")]
        templateSpecialization = ["prototypes::id::" + descriptor.name]
        enums = [ClassEnum("", ["Depth"], [descriptor.interface.inheritanceDepth()])]
        CGClass.__init__(
            self,
            "PrototypeTraits",
            indent=indent,
            templateArgs=templateArgs,
            templateSpecialization=templateSpecialization,
            enums=enums,
            isStruct=True,
        )

    def deps(self):
        return set()


class CGClassForwardDeclare(CGThing):
    def __init__(self, name, isStruct=False):
        CGThing.__init__(self)
        self.name = name
        self.isStruct = isStruct

    def declare(self):
        type = "struct" if self.isStruct else "class"
        return "%s %s;\n" % (type, self.name)

    def define(self):
        # Header only
        return ""

    def deps(self):
        return set()


class CGProxySpecialOperation(CGPerSignatureCall):
    """
    Base class for classes for calling an indexed or named special operation
    (don't use this directly, use the derived classes below).

    If checkFound is False, will just assert that the prop is found instead of
    checking that it is before wrapping the value.

    resultVar: See the docstring for CGCallGenerator.

    foundVar: For getters and deleters, the generated code can also set a bool
    variable, declared by the caller, if the given indexed or named property
    already existed. If the caller wants this, it should pass the name of the
    bool variable as the foundVar keyword argument to the constructor. The
    caller is responsible for declaring the variable and initializing it to
    false.
    """

    def __init__(
        self,
        descriptor,
        operation,
        checkFound=True,
        argumentHandleValue=None,
        resultVar=None,
        foundVar=None,
    ):
        self.checkFound = checkFound
        self.foundVar = foundVar or "found"

        nativeName = MakeNativeName(descriptor.binaryNameFor(operation, False))
        operation = descriptor.operations[operation]
        assert len(operation.signatures()) == 1
        signature = operation.signatures()[0]

        returnType, arguments = signature

        # We pass len(arguments) as the final argument so that the
        # CGPerSignatureCall won't do any argument conversion of its own.
        CGPerSignatureCall.__init__(
            self,
            returnType,
            arguments,
            nativeName,
            False,
            descriptor,
            operation,
            len(arguments),
            resultVar=resultVar,
            objectName="proxy",
        )

        if operation.isSetter():
            # arguments[0] is the index or name of the item that we're setting.
            argument = arguments[1]
            info = getJSToNativeConversionInfo(
                argument.type,
                descriptor,
                sourceDescription=(
                    "value being assigned to %s setter"
                    % descriptor.interface.identifier.name
                ),
            )
            if argumentHandleValue is None:
                argumentHandleValue = "desc.value()"
            rootedValue = fill(
                """
                JS::Rooted<JS::Value> rootedValue(cx, ${argumentHandleValue});
                """,
                argumentHandleValue=argumentHandleValue,
            )
            templateValues = {
                "declName": argument.identifier.name,
                "holderName": argument.identifier.name + "_holder",
                "val": argumentHandleValue,
                "maybeMutableVal": "&rootedValue",
                "obj": "obj",
                "passedToJSImpl": "false",
            }
            self.cgRoot.prepend(instantiateJSToNativeConversion(info, templateValues))
            # rootedValue needs to come before the conversion, so we
            # need to prepend it last.
            self.cgRoot.prepend(CGGeneric(rootedValue))
        elif operation.isGetter() or operation.isDeleter():
            if foundVar is None:
                self.cgRoot.prepend(CGGeneric("bool found = false;\n"))

    def getArguments(self):
        args = [(a, a.identifier.name) for a in self.arguments]
        if self.idlNode.isGetter() or self.idlNode.isDeleter():
            args.append(
                (
                    FakeArgument(BuiltinTypes[IDLBuiltinType.Types.boolean]),
                    self.foundVar,
                )
            )
        return args

    def wrap_return_value(self):
        if not self.idlNode.isGetter() or self.templateValues is None:
            return ""

        wrap = CGGeneric(
            wrapForType(self.returnType, self.descriptor, self.templateValues)
        )
        if self.checkFound:
            wrap = CGIfWrapper(wrap, self.foundVar)
        else:
            wrap = CGList([CGGeneric("MOZ_ASSERT(" + self.foundVar + ");\n"), wrap])
        return "\n" + wrap.define()


class CGProxyIndexedOperation(CGProxySpecialOperation):
    """
    Class to generate a call to an indexed operation.

    If doUnwrap is False, the caller is responsible for making sure a variable
    named 'self' holds the C++ object somewhere where the code we generate
    will see it.

    If checkFound is False, will just assert that the prop is found instead of
    checking that it is before wrapping the value.

    resultVar: See the docstring for CGCallGenerator.

    foundVar: See the docstring for CGProxySpecialOperation.
    """

    def __init__(
        self,
        descriptor,
        name,
        doUnwrap=True,
        checkFound=True,
        argumentHandleValue=None,
        resultVar=None,
        foundVar=None,
    ):
        self.doUnwrap = doUnwrap
        CGProxySpecialOperation.__init__(
            self,
            descriptor,
            name,
            checkFound,
            argumentHandleValue=argumentHandleValue,
            resultVar=resultVar,
            foundVar=foundVar,
        )

    def define(self):
        # Our first argument is the id we're getting.
        argName = self.arguments[0].identifier.name
        if argName == "index":
            # We already have our index in a variable with that name
            setIndex = ""
        else:
            setIndex = "uint32_t %s = index;\n" % argName
        if self.doUnwrap:
            unwrap = "%s* self = UnwrapProxy(proxy);\n" % self.descriptor.nativeType
        else:
            unwrap = ""
        return setIndex + unwrap + CGProxySpecialOperation.define(self)


class CGProxyIndexedGetter(CGProxyIndexedOperation):
    """
    Class to generate a call to an indexed getter. If templateValues is not None
    the returned value will be wrapped with wrapForType using templateValues.

    If doUnwrap is False, the caller is responsible for making sure a variable
    named 'self' holds the C++ object somewhere where the code we generate
    will see it.

    If checkFound is False, will just assert that the prop is found instead of
    checking that it is before wrapping the value.

    foundVar: See the docstring for CGProxySpecialOperation.
    """

    def __init__(
        self,
        descriptor,
        templateValues=None,
        doUnwrap=True,
        checkFound=True,
        foundVar=None,
    ):
        self.templateValues = templateValues
        CGProxyIndexedOperation.__init__(
            self, descriptor, "IndexedGetter", doUnwrap, checkFound, foundVar=foundVar
        )


class CGProxyIndexedPresenceChecker(CGProxyIndexedGetter):
    """
    Class to generate a call that checks whether an indexed property exists.

    For now, we just delegate to CGProxyIndexedGetter

    foundVar: See the docstring for CGProxySpecialOperation.
    """

    def __init__(self, descriptor, foundVar):
        CGProxyIndexedGetter.__init__(self, descriptor, foundVar=foundVar)
        self.cgRoot.append(CGGeneric("(void)result;\n"))


class CGProxyIndexedSetter(CGProxyIndexedOperation):
    """
    Class to generate a call to an indexed setter.
    """

    def __init__(self, descriptor, argumentHandleValue=None):
        CGProxyIndexedOperation.__init__(
            self, descriptor, "IndexedSetter", argumentHandleValue=argumentHandleValue
        )


class CGProxyNamedOperation(CGProxySpecialOperation):
    """
    Class to generate a call to a named operation.

    'value' is the jsval to use for the name; None indicates that it should be
    gotten from the property id.

    resultVar: See the docstring for CGCallGenerator.

    foundVar: See the docstring for CGProxySpecialOperation.

    tailCode: if we end up with a non-symbol string id, run this code after
              we do all our other work.
    """

    def __init__(
        self,
        descriptor,
        name,
        value=None,
        argumentHandleValue=None,
        resultVar=None,
        foundVar=None,
        tailCode="",
    ):
        CGProxySpecialOperation.__init__(
            self,
            descriptor,
            name,
            argumentHandleValue=argumentHandleValue,
            resultVar=resultVar,
            foundVar=foundVar,
        )
        self.value = value
        self.tailCode = tailCode

    def define(self):
        # Our first argument is the id we're getting.
        argName = self.arguments[0].identifier.name
        if argName == "id":
            # deal with the name collision
            decls = "JS::Rooted<jsid> id_(cx, id);\n"
            idName = "id_"
        else:
            decls = ""
            idName = "id"

        decls += "FakeString<char16_t> %s;\n" % argName

        main = fill(
            """
            ${nativeType}* self = UnwrapProxy(proxy);
            $*{op}
            $*{tailCode}
            """,
            nativeType=self.descriptor.nativeType,
            op=CGProxySpecialOperation.define(self),
            tailCode=self.tailCode,
        )

        if self.value is None:
            return fill(
                """
                $*{decls}
                bool isSymbol;
                if (!ConvertIdToString(cx, ${idName}, ${argName}, isSymbol)) {
                  return false;
                }
                if (!isSymbol) {
                  $*{main}
                }
                """,
                decls=decls,
                idName=idName,
                argName=argName,
                main=main,
            )

        # Sadly, we have to set up nameVal even if we have an atom id,
        # because we don't know for sure, and we can end up needing it
        # so it needs to be higher up the stack.  Using a Maybe here
        # seems like probable overkill.
        return fill(
            """
            $*{decls}
            JS::Rooted<JS::Value> nameVal(cx, ${value});
            if (!nameVal.isSymbol()) {
              if (!ConvertJSValueToString(cx, nameVal, eStringify, eStringify,
                                          ${argName})) {
                return false;
              }
              $*{main}
            }
            """,
            decls=decls,
            value=self.value,
            argName=argName,
            main=main,
        )


class CGProxyNamedGetter(CGProxyNamedOperation):
    """
    Class to generate a call to an named getter. If templateValues is not None
    the returned value will be wrapped with wrapForType using templateValues.
    'value' is the jsval to use for the name; None indicates that it should be
    gotten from the property id.

    foundVar: See the docstring for CGProxySpecialOperation.
    """

    def __init__(self, descriptor, templateValues=None, value=None, foundVar=None):
        self.templateValues = templateValues
        CGProxyNamedOperation.__init__(
            self, descriptor, "NamedGetter", value, foundVar=foundVar
        )


class CGProxyNamedPresenceChecker(CGProxyNamedGetter):
    """
    Class to generate a call that checks whether a named property exists.

    For now, we just delegate to CGProxyNamedGetter

    foundVar: See the docstring for CGProxySpecialOperation.
    """

    def __init__(self, descriptor, foundVar=None):
        CGProxyNamedGetter.__init__(self, descriptor, foundVar=foundVar)
        self.cgRoot.append(CGGeneric("(void)result;\n"))


class CGProxyNamedSetter(CGProxyNamedOperation):
    """
    Class to generate a call to a named setter.
    """

    def __init__(self, descriptor, tailCode, argumentHandleValue=None):
        CGProxyNamedOperation.__init__(
            self,
            descriptor,
            "NamedSetter",
            argumentHandleValue=argumentHandleValue,
            tailCode=tailCode,
        )


class CGProxyNamedDeleter(CGProxyNamedOperation):
    """
    Class to generate a call to a named deleter.

    resultVar: See the docstring for CGCallGenerator.

    foundVar: See the docstring for CGProxySpecialOperation.
    """

    def __init__(self, descriptor, resultVar=None, foundVar=None):
        CGProxyNamedOperation.__init__(
            self, descriptor, "NamedDeleter", resultVar=resultVar, foundVar=foundVar
        )


class CGProxyIsProxy(CGAbstractMethod):
    def __init__(self, descriptor):
        args = [Argument("JSObject*", "obj")]
        CGAbstractMethod.__init__(
            self, descriptor, "IsProxy", "bool", args, alwaysInline=True
        )

    def declare(self):
        return ""

    def definition_body(self):
        return "return js::IsProxy(obj) && js::GetProxyHandler(obj) == DOMProxyHandler::getInstance();\n"


class CGProxyUnwrap(CGAbstractMethod):
    def __init__(self, descriptor):
        args = [Argument("JSObject*", "obj")]
        CGAbstractMethod.__init__(
            self,
            descriptor,
            "UnwrapProxy",
            descriptor.nativeType + "*",
            args,
            alwaysInline=True,
        )

    def declare(self):
        return ""

    def definition_body(self):
        return fill(
            """
            MOZ_ASSERT(js::IsProxy(obj));
            if (js::GetProxyHandler(obj) != DOMProxyHandler::getInstance()) {
              MOZ_ASSERT(xpc::WrapperFactory::IsXrayWrapper(obj));
              obj = js::UncheckedUnwrap(obj);
            }
            MOZ_ASSERT(IsProxy(obj));
            return static_cast<${type}*>(js::GetProxyReservedSlot(obj, DOM_OBJECT_SLOT).toPrivate());
            """,
            type=self.descriptor.nativeType,
        )


MISSING_PROP_PREF = "dom.missing_prop_counters.enabled"


def missingPropUseCountersForDescriptor(desc):
    if not desc.needsMissingPropUseCounters:
        return ""

    return fill(
        """
        if (StaticPrefs::${pref}() && id.isAtom()) {
          CountMaybeMissingProperty(proxy, id);
        }

        """,
        pref=prefIdentifier(MISSING_PROP_PREF),
    )


def findAncestorWithInstrumentedProps(desc):
    """
    Find an ancestor of desc.interface (not including desc.interface
    itself) that has instrumented properties on it.  May return None
    if there is no such ancestor.
    """
    ancestor = desc.interface.parent
    while ancestor:
        if ancestor.getExtendedAttribute("InstrumentedProps"):
            return ancestor
        ancestor = ancestor.parent
    return None


class CGCountMaybeMissingProperty(CGAbstractMethod):
    def __init__(self, descriptor):
        """
        Returns whether we counted the property involved.
        """
        CGAbstractMethod.__init__(
            self,
            descriptor,
            "CountMaybeMissingProperty",
            "bool",
            [
                Argument("JS::Handle<JSObject*>", "proxy"),
                Argument("JS::Handle<jsid>", "id"),
            ],
        )

    def gen_switch(self, switchDecriptor):
        """
        Generate a switch from the switch descriptor.  The descriptor
        dictionary must have the following properties:

        1) A "precondition" property that contains code to run before the
           switch statement.  Its value ie a string.
        2) A "condition" property for the condition.  Its value is a string.
        3) A "cases" property.  Its value is an object that has property names
           corresponding to the case labels.  The values of those properties
           are either new switch descriptor dictionaries (which will then
           generate nested switches) or strings to use for case bodies.
        """
        cases = []
        for label, body in sorted(six.iteritems(switchDecriptor["cases"])):
            if isinstance(body, dict):
                body = self.gen_switch(body)
            cases.append(
                fill(
                    """
                case ${label}: {
                  $*{body}
                  break;
                }
                """,
                    label=label,
                    body=body,
                )
            )
        return fill(
            """
            $*{precondition}
            switch (${condition}) {
              $*{cases}
            }
            """,
            precondition=switchDecriptor["precondition"],
            condition=switchDecriptor["condition"],
            cases="".join(cases),
        )

    def charSwitch(self, props, charIndex):
        """
        Create a switch for the given props, based on the first char where
        they start to differ at index charIndex or more.  Each prop is a tuple
        containing interface name and prop name.

        Incoming props should be a sorted list.
        """
        if len(props) == 1:
            # We're down to one string: just check whether we match it.
            return fill(
                """
                if (JS_LinearStringEqualsLiteral(str, "${name}")) {
                  counter.emplace(eUseCounter_${iface}_${name});
                }
                """,
                iface=self.descriptor.name,
                name=props[0],
            )

        switch = dict()
        if charIndex == 0:
            switch["precondition"] = "StringIdChars chars(nogc, str);\n"
        else:
            switch["precondition"] = ""

        # Find the first place where we might actually have a difference.
        while all(prop[charIndex] == props[0][charIndex] for prop in props):
            charIndex += 1

        switch["condition"] = "chars[%d]" % charIndex
        switch["cases"] = dict()
        current_props = None
        curChar = None
        idx = 0
        while idx < len(props):
            nextChar = "'%s'" % props[idx][charIndex]
            if nextChar != curChar:
                if curChar:
                    switch["cases"][curChar] = self.charSwitch(
                        current_props, charIndex + 1
                    )
                current_props = []
                curChar = nextChar
            current_props.append(props[idx])
            idx += 1
        switch["cases"][curChar] = self.charSwitch(current_props, charIndex + 1)
        return switch

    def definition_body(self):
        ancestor = findAncestorWithInstrumentedProps(self.descriptor)

        if ancestor:
            body = fill(
                """
                if (${ancestor}_Binding::CountMaybeMissingProperty(proxy, id)) {
                  return true;
                }

                """,
                ancestor=ancestor.identifier.name,
            )
        else:
            body = ""

        instrumentedProps = self.descriptor.instrumentedProps
        if not instrumentedProps:
            return body + dedent(
                """
                return false;
                """
            )

        lengths = set(len(prop) for prop in instrumentedProps)
        switchDesc = {"condition": "JS::GetLinearStringLength(str)", "precondition": ""}
        switchDesc["cases"] = dict()
        for length in sorted(lengths):
            switchDesc["cases"][str(length)] = self.charSwitch(
                list(sorted(prop for prop in instrumentedProps if len(prop) == length)),
                0,
            )

        return body + fill(
            """
            MOZ_ASSERT(StaticPrefs::${pref}() && id.isAtom());
            Maybe<UseCounter> counter;
            {
              // Scope for our no-GC section, so we don't need to rely on SetUseCounter not GCing.
              JS::AutoCheckCannotGC nogc;
              JSLinearString* str = JS::AtomToLinearString(id.toAtom());
              // Don't waste time fetching the chars until we've done the length switch.
              $*{switch}
            }
            if (counter) {
              SetUseCounter(proxy, *counter);
              return true;
            }

            return false;
            """,
            pref=prefIdentifier(MISSING_PROP_PREF),
            switch=self.gen_switch(switchDesc),
        )


class CGDOMJSProxyHandler_getOwnPropDescriptor(ClassMethod):
    def __init__(self, descriptor):
        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "proxy"),
            Argument("JS::Handle<jsid>", "id"),
            Argument("bool", "ignoreNamedProps"),
            Argument("JS::MutableHandle<Maybe<JS::PropertyDescriptor>>", "desc"),
        ]
        ClassMethod.__init__(
            self,
            "getOwnPropDescriptor",
            "bool",
            args,
            virtual=True,
            override=True,
            const=True,
        )
        self.descriptor = descriptor

    def getBody(self):
        indexedSetter = self.descriptor.operations["IndexedSetter"]

        if self.descriptor.isMaybeCrossOriginObject():
            xrayDecl = dedent(
                """
                MOZ_ASSERT(!xpc::WrapperFactory::IsXrayWrapper(proxy));
                MOZ_ASSERT(IsPlatformObjectSameOrigin(cx, proxy),
                           "getOwnPropertyDescriptor() and set() should have dealt");
                MOZ_ASSERT(js::IsObjectInContextCompartment(proxy, cx),
                           "getOwnPropertyDescriptor() and set() should have dealt");

                """
            )
            xrayCheck = ""
        else:
            xrayDecl = "bool isXray = xpc::WrapperFactory::IsXrayWrapper(proxy);\n"
            xrayCheck = "!isXray &&"

        if self.descriptor.supportsIndexedProperties():
            attributes = [
                "JS::PropertyAttribute::Configurable",
                "JS::PropertyAttribute::Enumerable",
            ]
            if indexedSetter is not None:
                attributes.append("JS::PropertyAttribute::Writable")
            setDescriptor = (
                "desc.set(mozilla::Some(JS::PropertyDescriptor::Data(value, { %s })));\nreturn true;\n"
                % ", ".join(attributes)
            )
            templateValues = {
                "jsvalRef": "value",
                "jsvalHandle": "&value",
                "obj": "proxy",
                "successCode": setDescriptor,
            }
            getIndexed = fill(
                """
                uint32_t index = GetArrayIndexFromId(id);
                if (IsArrayIndex(index)) {
                  JS::Rooted<JS::Value> value(cx);
                  $*{callGetter}
                }

                """,
                callGetter=CGProxyIndexedGetter(
                    self.descriptor, templateValues
                ).define(),
            )
        else:
            getIndexed = ""

        missingPropUseCounters = missingPropUseCountersForDescriptor(self.descriptor)

        if self.descriptor.supportsNamedProperties():
            operations = self.descriptor.operations
            attributes = ["JS::PropertyAttribute::Configurable"]
            if self.descriptor.namedPropertiesEnumerable:
                attributes.append("JS::PropertyAttribute::Enumerable")
            if operations["NamedSetter"] is not None:
                attributes.append("JS::PropertyAttribute::Writable")
            setDescriptor = (
                "desc.set(mozilla::Some(JS::PropertyDescriptor::Data(value, { %s })));\nreturn true;\n"
                % ", ".join(attributes)
            )
            templateValues = {
                "jsvalRef": "value",
                "jsvalHandle": "&value",
                "obj": "proxy",
                "successCode": setDescriptor,
            }

            computeCondition = dedent(
                """
                bool hasOnProto;
                if (!HasPropertyOnPrototype(cx, proxy, id, &hasOnProto)) {
                  return false;
                }
                callNamedGetter = !hasOnProto;
                """
            )
            if self.descriptor.interface.getExtendedAttribute("LegacyOverrideBuiltIns"):
                computeCondition = fill(
                    """
                    if (!isXray) {
                      callNamedGetter = true;
                    } else {
                      $*{hasOnProto}
                    }
                    """,
                    hasOnProto=computeCondition,
                )

            outerCondition = "!ignoreNamedProps"
            if self.descriptor.supportsIndexedProperties():
                outerCondition = "!IsArrayIndex(index) && " + outerCondition

            namedGetCode = CGProxyNamedGetter(self.descriptor, templateValues).define()
            namedGet = fill(
                """
                bool callNamedGetter = false;
                if (${outerCondition}) {
                  $*{computeCondition}
                }
                if (callNamedGetter) {
                  JS::Rooted<JS::Value> value(cx);
                  $*{namedGetCode}
                }
                """,
                outerCondition=outerCondition,
                computeCondition=computeCondition,
                namedGetCode=namedGetCode,
            )
            namedGet += "\n"
        else:
            namedGet = ""

        return fill(
            """
            $*{xrayDecl}
            $*{getIndexed}
            $*{missingPropUseCounters}
            JS::Rooted<JSObject*> expando(cx);
            if (${xrayCheck}(expando = GetExpandoObject(proxy))) {
              if (!JS_GetOwnPropertyDescriptorById(cx, expando, id, desc)) {
                return false;
              }
              if (desc.isSome()) {
                return true;
              }
            }

            $*{namedGet}
            desc.reset();
            return true;
            """,
            xrayDecl=xrayDecl,
            xrayCheck=xrayCheck,
            getIndexed=getIndexed,
            missingPropUseCounters=missingPropUseCounters,
            namedGet=namedGet,
        )


class CGDOMJSProxyHandler_defineProperty(ClassMethod):
    def __init__(self, descriptor):
        # The usual convention is to name the ObjectOpResult out-parameter
        # `result`, but that name is a bit overloaded around here.
        args = [
            Argument("JSContext*", "cx_"),
            Argument("JS::Handle<JSObject*>", "proxy"),
            Argument("JS::Handle<jsid>", "id"),
            Argument("JS::Handle<JS::PropertyDescriptor>", "desc"),
            Argument("JS::ObjectOpResult&", "opresult"),
            Argument("bool*", "done"),
        ]
        ClassMethod.__init__(
            self,
            "defineProperty",
            "bool",
            args,
            virtual=True,
            override=True,
            const=True,
        )
        self.descriptor = descriptor

    def getBody(self):
        set = ""

        indexedSetter = self.descriptor.operations["IndexedSetter"]
        if indexedSetter:
            error_label = CGSpecializedMethod.error_reporting_label_helper(
                self.descriptor, indexedSetter, isConstructor=False
            )
            if error_label:
                cxDecl = fill(
                    """
                    BindingCallContext cx(cx_, "${error_label}");
                    """,
                    error_label=error_label,
                )
            else:
                cxDecl = dedent(
                    """
                    JSContext* cx = cx_;
                    """
                )
            set += fill(
                """
                uint32_t index = GetArrayIndexFromId(id);
                if (IsArrayIndex(index)) {
                  $*{cxDecl}
                  *done = true;
                  // https://heycam.github.io/webidl/#legacy-platform-object-defineownproperty
                  // Step 1.1.  The no-indexed-setter case is handled by step 1.2.
                  if (!desc.isDataDescriptor()) {
                    return opresult.failNotDataDescriptor();
                  }

                  $*{callSetter}
                  return opresult.succeed();
                }
                """,
                cxDecl=cxDecl,
                callSetter=CGProxyIndexedSetter(self.descriptor).define(),
            )
        elif self.descriptor.supportsIndexedProperties():
            # We allow untrusted content to prevent Xrays from setting a
            # property if that property is an indexed property and we have no
            # indexed setter.  That's how the object would normally behave if
            # you tried to set the property on it.  That means we don't need to
            # do anything special for Xrays here.
            set += dedent(
                """
                if (IsArrayIndex(GetArrayIndexFromId(id))) {
                  *done = true;
                  return opresult.failNoIndexedSetter();
                }
                """
            )

        namedSetter = self.descriptor.operations["NamedSetter"]
        if namedSetter:
            error_label = CGSpecializedMethod.error_reporting_label_helper(
                self.descriptor, namedSetter, isConstructor=False
            )
            if error_label:
                set += fill(
                    """
                    BindingCallContext cx(cx_, "${error_label}");
                    """,
                    error_label=error_label,
                )
            else:
                set += dedent(
                    """
                    JSContext* cx = cx_;
                    """
                )
            if self.descriptor.hasLegacyUnforgeableMembers:
                raise TypeError(
                    "Can't handle a named setter on an interface "
                    "that has unforgeables.  Figure out how that "
                    "should work!"
                )
            tailCode = dedent(
                """
                *done = true;
                return opresult.succeed();
                """
            )
            set += CGProxyNamedSetter(self.descriptor, tailCode).define()
        else:
            # We allow untrusted content to prevent Xrays from setting a
            # property if that property is already a named property on the
            # object and we have no named setter.  That's how the object would
            # normally behave if you tried to set the property on it.  That
            # means we don't need to do anything special for Xrays here.
            if self.descriptor.supportsNamedProperties():
                set += fill(
                    """
                    JSContext* cx = cx_;
                    bool found = false;
                    $*{presenceChecker}

                    if (found) {
                      *done = true;
                      return opresult.failNoNamedSetter();
                    }
                    """,
                    presenceChecker=CGProxyNamedPresenceChecker(
                        self.descriptor, foundVar="found"
                    ).define(),
                )
            if self.descriptor.isMaybeCrossOriginObject():
                set += dedent(
                    """
                    MOZ_ASSERT(IsPlatformObjectSameOrigin(cx_, proxy),
                               "Why did the MaybeCrossOriginObject defineProperty override fail?");
                    MOZ_ASSERT(js::IsObjectInContextCompartment(proxy, cx_),
                               "Why did the MaybeCrossOriginObject defineProperty override fail?");
                    """
                )

        # In all cases we want to tail-call to our base class; we can
        # always land here for symbols.
        set += (
            "return mozilla::dom::DOMProxyHandler::defineProperty(%s);\n"
            % ", ".join(a.name for a in self.args)
        )
        return set


def getDeleterBody(descriptor, type, foundVar=None):
    """
    type should be "Named" or "Indexed"

    The possible outcomes:
    - an error happened                       (the emitted code returns false)
    - own property not found                  (foundVar=false, deleteSucceeded=true)
    - own property found and deleted          (foundVar=true,  deleteSucceeded=true)
    - own property found but can't be deleted (foundVar=true,  deleteSucceeded=false)
    """
    assert type in ("Named", "Indexed")
    deleter = descriptor.operations[type + "Deleter"]
    if deleter:
        assert type == "Named"
        assert foundVar is not None
        if descriptor.hasLegacyUnforgeableMembers:
            raise TypeError(
                "Can't handle a deleter on an interface "
                "that has unforgeables.  Figure out how "
                "that should work!"
            )
        # See if the deleter method is fallible.
        t = deleter.signatures()[0][0]
        if t.isPrimitive() and not t.nullable() and t.tag() == IDLType.Tags.bool:
            # The deleter method has a boolean return value. When a
            # property is found, the return value indicates whether it
            # was successfully deleted.
            setDS = fill(
                """
                if (!${foundVar}) {
                  deleteSucceeded = true;
                }
                """,
                foundVar=foundVar,
            )
        else:
            # No boolean return value: if a property is found,
            # deleting it always succeeds.
            setDS = "deleteSucceeded = true;\n"

        body = (
            CGProxyNamedDeleter(
                descriptor, resultVar="deleteSucceeded", foundVar=foundVar
            ).define()
            + setDS
        )
    elif getattr(descriptor, "supports%sProperties" % type)():
        presenceCheckerClass = globals()["CGProxy%sPresenceChecker" % type]
        foundDecl = ""
        if foundVar is None:
            foundVar = "found"
            foundDecl = "bool found = false;\n"
        body = fill(
            """
            $*{foundDecl}
            $*{presenceChecker}
            deleteSucceeded = !${foundVar};
            """,
            foundDecl=foundDecl,
            presenceChecker=presenceCheckerClass(
                descriptor, foundVar=foundVar
            ).define(),
            foundVar=foundVar,
        )
    else:
        body = None
    return body


class CGDeleteNamedProperty(CGAbstractStaticMethod):
    def __init__(self, descriptor):
        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "xray"),
            Argument("JS::Handle<JSObject*>", "proxy"),
            Argument("JS::Handle<jsid>", "id"),
            Argument("JS::ObjectOpResult&", "opresult"),
        ]
        CGAbstractStaticMethod.__init__(
            self, descriptor, "DeleteNamedProperty", "bool", args
        )

    def definition_body(self):
        return fill(
            """
            MOZ_ASSERT(xpc::WrapperFactory::IsXrayWrapper(xray));
            MOZ_ASSERT(js::IsProxy(proxy));
            MOZ_ASSERT(!xpc::WrapperFactory::IsXrayWrapper(proxy));
            JSAutoRealm ar(cx, proxy);
            bool deleteSucceeded = false;
            bool found = false;
            $*{namedBody}
            if (!found || deleteSucceeded) {
              return opresult.succeed();
            }
            return opresult.failCantDelete();
            """,
            namedBody=getDeleterBody(self.descriptor, "Named", foundVar="found"),
        )


class CGDOMJSProxyHandler_delete(ClassMethod):
    def __init__(self, descriptor):
        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "proxy"),
            Argument("JS::Handle<jsid>", "id"),
            Argument("JS::ObjectOpResult&", "opresult"),
        ]
        ClassMethod.__init__(
            self, "delete_", "bool", args, virtual=True, override=True, const=True
        )
        self.descriptor = descriptor

    def getBody(self):
        delete = dedent(
            """
            MOZ_ASSERT(!xpc::WrapperFactory::IsXrayWrapper(proxy),
                      "Should not have a XrayWrapper here");

            """
        )

        if self.descriptor.isMaybeCrossOriginObject():
            delete += dedent(
                """
                if (!IsPlatformObjectSameOrigin(cx, proxy)) {
                  return ReportCrossOriginDenial(cx, id, "delete"_ns);
                }

                // Safe to enter the Realm of proxy now.
                JSAutoRealm ar(cx, proxy);
                JS_MarkCrossZoneId(cx, id);
                """
            )

        indexedBody = getDeleterBody(self.descriptor, "Indexed")
        if indexedBody is not None:
            # Can't handle cross-origin objects here.
            assert not self.descriptor.isMaybeCrossOriginObject()
            delete += fill(
                """
                uint32_t index = GetArrayIndexFromId(id);
                if (IsArrayIndex(index)) {
                  bool deleteSucceeded;
                  $*{indexedBody}
                  return deleteSucceeded ? opresult.succeed() : opresult.failCantDelete();
                }
                """,
                indexedBody=indexedBody,
            )

        namedBody = getDeleterBody(self.descriptor, "Named", foundVar="found")
        if namedBody is not None:
            delete += dedent(
                """
                // Try named delete only if the named property visibility
                // algorithm says the property is visible.
                bool tryNamedDelete = true;
                { // Scope for expando
                  JS::Rooted<JSObject*> expando(cx, DOMProxyHandler::GetExpandoObject(proxy));
                  if (expando) {
                    bool hasProp;
                    if (!JS_HasPropertyById(cx, expando, id, &hasProp)) {
                      return false;
                    }
                    tryNamedDelete = !hasProp;
                  }
                }
                """
            )

            if not self.descriptor.interface.getExtendedAttribute(
                "LegacyOverrideBuiltIns"
            ):
                delete += dedent(
                    """
                    if (tryNamedDelete) {
                      bool hasOnProto;
                      if (!HasPropertyOnPrototype(cx, proxy, id, &hasOnProto)) {
                        return false;
                      }
                      tryNamedDelete = !hasOnProto;
                    }
                    """
                )

            # We always return above for an index id in the case when we support
            # indexed properties, so we can just treat the id as a name
            # unconditionally here.
            delete += fill(
                """
                if (tryNamedDelete) {
                  bool found = false;
                  bool deleteSucceeded;
                  $*{namedBody}
                  if (found) {
                    return deleteSucceeded ? opresult.succeed() : opresult.failCantDelete();
                  }
                }
                """,
                namedBody=namedBody,
            )

        delete += dedent(
            """

            return dom::DOMProxyHandler::delete_(cx, proxy, id, opresult);
            """
        )

        return delete


class CGDOMJSProxyHandler_ownPropNames(ClassMethod):
    def __init__(
        self,
        descriptor,
    ):
        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "proxy"),
            Argument("unsigned", "flags"),
            Argument("JS::MutableHandleVector<jsid>", "props"),
        ]
        ClassMethod.__init__(
            self, "ownPropNames", "bool", args, virtual=True, override=True, const=True
        )
        self.descriptor = descriptor

    def getBody(self):
        if self.descriptor.isMaybeCrossOriginObject():
            xrayDecl = dedent(
                """
                MOZ_ASSERT(!xpc::WrapperFactory::IsXrayWrapper(proxy));
                if (!IsPlatformObjectSameOrigin(cx, proxy)) {
                  if (!(flags & JSITER_HIDDEN)) {
                    // There are no enumerable cross-origin props, so we're done.
                    return true;
                  }

                  JS::Rooted<JSObject*> holder(cx);
                  if (!EnsureHolder(cx, proxy, &holder)) {
                    return false;
                  }

                  if (!js::GetPropertyKeys(cx, holder, flags, props)) {
                    return false;
                  }

                  return xpc::AppendCrossOriginWhitelistedPropNames(cx, props);
                }

                """
            )
            xrayCheck = ""
        else:
            xrayDecl = "bool isXray = xpc::WrapperFactory::IsXrayWrapper(proxy);\n"
            xrayCheck = "!isXray &&"

        # Per spec, we do indices, then named props, then everything else.
        if self.descriptor.supportsIndexedProperties():
            if self.descriptor.lengthNeedsCallerType():
                callerType = callerTypeGetterForDescriptor(self.descriptor)
            else:
                callerType = ""
            addIndices = fill(
                """

                uint32_t length = UnwrapProxy(proxy)->Length(${callerType});
                MOZ_ASSERT(int32_t(length) >= 0);
                for (int32_t i = 0; i < int32_t(length); ++i) {
                  if (!props.append(JS::PropertyKey::Int(i))) {
                    return false;
                  }
                }
                """,
                callerType=callerType,
            )
        else:
            addIndices = ""

        if self.descriptor.supportsNamedProperties():
            if self.descriptor.interface.getExtendedAttribute("LegacyOverrideBuiltIns"):
                shadow = "!isXray"
            else:
                shadow = "false"

            if self.descriptor.supportedNamesNeedCallerType():
                callerType = ", " + callerTypeGetterForDescriptor(self.descriptor)
            else:
                callerType = ""

            addNames = fill(
                """
                nsTArray<nsString> names;
                UnwrapProxy(proxy)->GetSupportedNames(names${callerType});
                if (!AppendNamedPropertyIds(cx, proxy, names, ${shadow}, props)) {
                  return false;
                }
                """,
                callerType=callerType,
                shadow=shadow,
            )
            if not self.descriptor.namedPropertiesEnumerable:
                addNames = CGIfWrapper(
                    CGGeneric(addNames), "flags & JSITER_HIDDEN"
                ).define()
            addNames = "\n" + addNames
        else:
            addNames = ""

        addExpandoProps = fill(
            """
            JS::Rooted<JSObject*> expando(cx);
            if (${xrayCheck}(expando = DOMProxyHandler::GetExpandoObject(proxy)) &&
                !js::GetPropertyKeys(cx, expando, flags, props)) {
              return false;
            }
            """,
            xrayCheck=xrayCheck,
        )

        if self.descriptor.isMaybeCrossOriginObject():
            # We need to enter our compartment (which we might not be
            # in right now) to get the expando props.
            addExpandoProps = fill(
                """
                {  // Scope for accessing the expando.
                  // Safe to enter our compartment, because IsPlatformObjectSameOrigin tested true.
                  JSAutoRealm ar(cx, proxy);
                  $*{addExpandoProps}
                }
                for (auto& id : props) {
                  JS_MarkCrossZoneId(cx, id);
                }
                """,
                addExpandoProps=addExpandoProps,
            )

        return fill(
            """
            $*{xrayDecl}
            $*{addIndices}
            $*{addNames}

            $*{addExpandoProps}

            return true;
            """,
            xrayDecl=xrayDecl,
            addIndices=addIndices,
            addNames=addNames,
            addExpandoProps=addExpandoProps,
        )


class CGDOMJSProxyHandler_hasOwn(ClassMethod):
    def __init__(self, descriptor):
        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "proxy"),
            Argument("JS::Handle<jsid>", "id"),
            Argument("bool*", "bp"),
        ]
        ClassMethod.__init__(
            self, "hasOwn", "bool", args, virtual=True, override=True, const=True
        )
        self.descriptor = descriptor

    def getBody(self):
        if self.descriptor.isMaybeCrossOriginObject():
            maybeCrossOrigin = dedent(
                """
                if (!IsPlatformObjectSameOrigin(cx, proxy)) {
                  // Just hand this off to BaseProxyHandler to do the slow-path thing.
                  // The BaseProxyHandler code is OK with this happening without entering the
                  // compartment of "proxy", which is important to get the right answers.
                  return js::BaseProxyHandler::hasOwn(cx, proxy, id, bp);
                }

                // Now safe to enter the Realm of proxy and do the rest of the work there.
                JSAutoRealm ar(cx, proxy);
                JS_MarkCrossZoneId(cx, id);
                """
            )
        else:
            maybeCrossOrigin = ""

        if self.descriptor.supportsIndexedProperties():
            indexed = fill(
                """
                uint32_t index = GetArrayIndexFromId(id);
                if (IsArrayIndex(index)) {
                  bool found = false;
                  $*{presenceChecker}

                  *bp = found;
                  return true;
                }

                """,
                presenceChecker=CGProxyIndexedPresenceChecker(
                    self.descriptor, foundVar="found"
                ).define(),
            )
        else:
            indexed = ""

        if self.descriptor.supportsNamedProperties():
            # If we support indexed properties we always return above for index
            # property names, so no need to check for those here.
            named = fill(
                """
                bool found = false;
                $*{presenceChecker}

                *bp = found;
                """,
                presenceChecker=CGProxyNamedPresenceChecker(
                    self.descriptor, foundVar="found"
                ).define(),
            )
            if not self.descriptor.interface.getExtendedAttribute(
                "LegacyOverrideBuiltIns"
            ):
                named = fill(
                    """
                    bool hasOnProto;
                    if (!HasPropertyOnPrototype(cx, proxy, id, &hasOnProto)) {
                      return false;
                    }
                    if (!hasOnProto) {
                      $*{protoLacksProperty}
                      return true;
                    }
                    """,
                    protoLacksProperty=named,
                )
                named += "*bp = false;\n"
            else:
                named += "\n"
        else:
            named = "*bp = false;\n"

        missingPropUseCounters = missingPropUseCountersForDescriptor(self.descriptor)

        return fill(
            """
            MOZ_ASSERT(!xpc::WrapperFactory::IsXrayWrapper(proxy),
                      "Should not have a XrayWrapper here");
            $*{maybeCrossOrigin}
            $*{indexed}

            $*{missingPropUseCounters}
            JS::Rooted<JSObject*> expando(cx, GetExpandoObject(proxy));
            if (expando) {
              bool b = true;
              bool ok = JS_HasPropertyById(cx, expando, id, &b);
              *bp = !!b;
              if (!ok || *bp) {
                return ok;
              }
            }

            $*{named}
            return true;
            """,
            maybeCrossOrigin=maybeCrossOrigin,
            indexed=indexed,
            missingPropUseCounters=missingPropUseCounters,
            named=named,
        )


class CGDOMJSProxyHandler_get(ClassMethod):
    def __init__(self, descriptor):
        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "proxy"),
            Argument("JS::Handle<JS::Value>", "receiver"),
            Argument("JS::Handle<jsid>", "id"),
            Argument("JS::MutableHandle<JS::Value>", "vp"),
        ]
        ClassMethod.__init__(
            self, "get", "bool", args, virtual=True, override=True, const=True
        )
        self.descriptor = descriptor

    def getBody(self):
        missingPropUseCounters = missingPropUseCountersForDescriptor(self.descriptor)

        getUnforgeableOrExpando = dedent(
            """
            bool expandoHasProp = false;
            { // Scope for expando
              JS::Rooted<JSObject*> expando(cx, DOMProxyHandler::GetExpandoObject(proxy));
              if (expando) {
                if (!JS_HasPropertyById(cx, expando, id, &expandoHasProp)) {
                  return false;
                }

                if (expandoHasProp) {
                  // Forward the get to the expando object, but our receiver is whatever our
                  // receiver is.
                  if (!JS_ForwardGetPropertyTo(cx, expando, id, ${receiver}, vp)) {
                    return false;
                  }
                }
              }
            }
            """
        )

        getOnPrototype = dedent(
            """
            bool foundOnPrototype;
            if (!GetPropertyOnPrototype(cx, proxy, ${receiver}, id, &foundOnPrototype, vp)) {
              return false;
            }
            """
        )

        if self.descriptor.isMaybeCrossOriginObject():
            # We can't handle these for cross-origin objects
            assert not self.descriptor.supportsIndexedProperties()
            assert not self.descriptor.supportsNamedProperties()

            return fill(
                """
                MOZ_ASSERT(!xpc::WrapperFactory::IsXrayWrapper(proxy),
                            "Should not have a XrayWrapper here");

                if (!IsPlatformObjectSameOrigin(cx, proxy)) {
                  return CrossOriginGet(cx, proxy, receiver, id, vp);
                }

                $*{missingPropUseCounters}
                { // Scope for the JSAutoRealm accessing expando and prototype.
                  JSAutoRealm ar(cx, proxy);
                  JS::Rooted<JS::Value> wrappedReceiver(cx, receiver);
                  if (!MaybeWrapValue(cx, &wrappedReceiver)) {
                    return false;
                  }
                  JS_MarkCrossZoneId(cx, id);

                  $*{getUnforgeableOrExpando}
                  if (!expandoHasProp) {
                    $*{getOnPrototype}
                    if (!foundOnPrototype) {
                      MOZ_ASSERT(vp.isUndefined());
                      return true;
                    }
                  }
                }

                return MaybeWrapValue(cx, vp);
                """,
                missingPropUseCounters=missingPropUseCountersForDescriptor(
                    self.descriptor
                ),
                getUnforgeableOrExpando=fill(
                    getUnforgeableOrExpando, receiver="wrappedReceiver"
                ),
                getOnPrototype=fill(getOnPrototype, receiver="wrappedReceiver"),
            )

        templateValues = {"jsvalRef": "vp", "jsvalHandle": "vp", "obj": "proxy"}

        getUnforgeableOrExpando = fill(
            getUnforgeableOrExpando, receiver="receiver"
        ) + dedent(
            """

            if (expandoHasProp) {
              return true;
            }
            """
        )
        if self.descriptor.supportsIndexedProperties():
            getIndexedOrExpando = fill(
                """
                uint32_t index = GetArrayIndexFromId(id);
                if (IsArrayIndex(index)) {
                  $*{callGetter}
                  // Even if we don't have this index, we don't forward the
                  // get on to our expando object.
                } else {
                  $*{getUnforgeableOrExpando}
                }
                """,
                callGetter=CGProxyIndexedGetter(
                    self.descriptor, templateValues
                ).define(),
                getUnforgeableOrExpando=getUnforgeableOrExpando,
            )
        else:
            getIndexedOrExpando = getUnforgeableOrExpando

        if self.descriptor.supportsNamedProperties():
            getNamed = CGProxyNamedGetter(self.descriptor, templateValues)
            if self.descriptor.supportsIndexedProperties():
                getNamed = CGIfWrapper(getNamed, "!IsArrayIndex(index)")
            getNamed = getNamed.define() + "\n"
        else:
            getNamed = ""

        getOnPrototype = fill(getOnPrototype, receiver="receiver") + dedent(
            """

            if (foundOnPrototype) {
              return true;
            }

            MOZ_ASSERT(vp.isUndefined());
            """
        )

        if self.descriptor.interface.getExtendedAttribute("LegacyOverrideBuiltIns"):
            getNamedOrOnPrototype = getNamed + getOnPrototype
        else:
            getNamedOrOnPrototype = getOnPrototype + getNamed

        return fill(
            """
            MOZ_ASSERT(!xpc::WrapperFactory::IsXrayWrapper(proxy),
                        "Should not have a XrayWrapper here");

            $*{missingPropUseCounters}
            $*{indexedOrExpando}

            $*{namedOrOnPropotype}
            return true;
            """,
            missingPropUseCounters=missingPropUseCounters,
            indexedOrExpando=getIndexedOrExpando,
            namedOrOnPropotype=getNamedOrOnPrototype,
        )


class CGDOMJSProxyHandler_setCustom(ClassMethod):
    def __init__(self, descriptor):
        args = [
            Argument("JSContext*", "cx_"),
            Argument("JS::Handle<JSObject*>", "proxy"),
            Argument("JS::Handle<jsid>", "id"),
            Argument("JS::Handle<JS::Value>", "v"),
            Argument("bool*", "done"),
        ]
        ClassMethod.__init__(
            self, "setCustom", "bool", args, virtual=True, override=True, const=True
        )
        self.descriptor = descriptor

    def getBody(self):
        assertion = (
            "MOZ_ASSERT(!xpc::WrapperFactory::IsXrayWrapper(proxy),\n"
            '           "Should not have a XrayWrapper here");\n'
        )

        # Correctness first. If we have a NamedSetter and [LegacyOverrideBuiltIns],
        # always call the NamedSetter and never do anything else.
        namedSetter = self.descriptor.operations["NamedSetter"]
        if namedSetter is not None and self.descriptor.interface.getExtendedAttribute(
            "LegacyOverrideBuiltIns"
        ):
            # Check assumptions.
            if self.descriptor.supportsIndexedProperties():
                raise ValueError(
                    "In interface "
                    + self.descriptor.name
                    + ": "
                    + "Can't cope with [LegacyOverrideBuiltIns] and an indexed getter"
                )
            if self.descriptor.hasLegacyUnforgeableMembers:
                raise ValueError(
                    "In interface "
                    + self.descriptor.name
                    + ": "
                    + "Can't cope with [LegacyOverrideBuiltIns] and unforgeable members"
                )

            tailCode = dedent(
                """
                *done = true;
                return true;
                """
            )
            callSetter = CGProxyNamedSetter(
                self.descriptor, tailCode, argumentHandleValue="v"
            )
            error_label = CGSpecializedMethod.error_reporting_label_helper(
                self.descriptor, namedSetter, isConstructor=False
            )
            if error_label:
                cxDecl = fill(
                    """
                    BindingCallContext cx(cx_, "${error_label}");
                    """,
                    error_label=error_label,
                )
            else:
                cxDecl = dedent(
                    """
                    JSContext* cx = cx_;
                    """
                )
            return fill(
                """
                $*{assertion}
                $*{cxDecl}
                $*{callSetter}
                *done = false;
                return true;
                """,
                assertion=assertion,
                cxDecl=cxDecl,
                callSetter=callSetter.define(),
            )

        # As an optimization, if we are going to call an IndexedSetter, go
        # ahead and call it and have done.
        indexedSetter = self.descriptor.operations["IndexedSetter"]
        if indexedSetter is not None:
            error_label = CGSpecializedMethod.error_reporting_label_helper(
                self.descriptor, indexedSetter, isConstructor=False
            )
            if error_label:
                cxDecl = fill(
                    """
                    BindingCallContext cx(cx_, "${error_label}");
                    """,
                    error_label=error_label,
                )
            else:
                cxDecl = dedent(
                    """
                    JSContext* cx = cx_;
                    """
                )
            setIndexed = fill(
                """
                uint32_t index = GetArrayIndexFromId(id);
                if (IsArrayIndex(index)) {
                  $*{cxDecl}
                  $*{callSetter}
                  *done = true;
                  return true;
                }

                """,
                cxDecl=cxDecl,
                callSetter=CGProxyIndexedSetter(
                    self.descriptor, argumentHandleValue="v"
                ).define(),
            )
        else:
            setIndexed = ""

        return assertion + setIndexed + "*done = false;\n" "return true;\n"


class CGDOMJSProxyHandler_className(ClassMethod):
    def __init__(self, descriptor):
        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "proxy"),
        ]
        ClassMethod.__init__(
            self,
            "className",
            "const char*",
            args,
            virtual=True,
            override=True,
            const=True,
        )
        self.descriptor = descriptor

    def getBody(self):
        if self.descriptor.isMaybeCrossOriginObject():
            crossOrigin = dedent(
                """
                if (!IsPlatformObjectSameOrigin(cx, proxy)) {
                  return "Object";
                }

                """
            )
        else:
            crossOrigin = ""
        return fill(
            """
            $*{crossOrigin}
            return "${name}";
            """,
            crossOrigin=crossOrigin,
            name=self.descriptor.name,
        )


class CGDOMJSProxyHandler_finalizeInBackground(ClassMethod):
    def __init__(self, descriptor):
        args = [Argument("const JS::Value&", "priv")]
        ClassMethod.__init__(
            self,
            "finalizeInBackground",
            "bool",
            args,
            virtual=True,
            override=True,
            const=True,
        )
        self.descriptor = descriptor

    def getBody(self):
        return "return false;\n"


class CGDOMJSProxyHandler_finalize(ClassMethod):
    def __init__(self, descriptor):
        args = [Argument("JS::GCContext*", "gcx"), Argument("JSObject*", "proxy")]
        ClassMethod.__init__(
            self, "finalize", "void", args, virtual=True, override=True, const=True
        )
        self.descriptor = descriptor

    def getBody(self):
        return (
            "%s* self = UnwrapPossiblyNotInitializedDOMObject<%s>(proxy);\n"
            % (self.descriptor.nativeType, self.descriptor.nativeType)
        ) + finalizeHook(
            self.descriptor,
            FINALIZE_HOOK_NAME,
            self.args[0].name,
            self.args[1].name,
        ).define()


class CGDOMJSProxyHandler_objectMoved(ClassMethod):
    def __init__(self, descriptor):
        args = [Argument("JSObject*", "obj"), Argument("JSObject*", "old")]
        ClassMethod.__init__(
            self, "objectMoved", "size_t", args, virtual=True, override=True, const=True
        )
        self.descriptor = descriptor

    def getBody(self):
        return (
            "%s* self = UnwrapPossiblyNotInitializedDOMObject<%s>(obj);\n"
            % (self.descriptor.nativeType, self.descriptor.nativeType)
        ) + objectMovedHook(
            self.descriptor,
            OBJECT_MOVED_HOOK_NAME,
            self.args[0].name,
            self.args[1].name,
        )


class CGDOMJSProxyHandler_getElements(ClassMethod):
    def __init__(self, descriptor):
        assert descriptor.supportsIndexedProperties()

        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "proxy"),
            Argument("uint32_t", "begin"),
            Argument("uint32_t", "end"),
            Argument("js::ElementAdder*", "adder"),
        ]
        ClassMethod.__init__(
            self, "getElements", "bool", args, virtual=True, override=True, const=True
        )
        self.descriptor = descriptor

    def getBody(self):
        # Just like ownPropertyKeys we'll assume that we have no holes, so
        # we have all properties from 0 to length.  If that ever changes
        # (unlikely), we'll need to do something a bit more clever with how we
        # forward on to our ancestor.

        templateValues = {
            "jsvalRef": "temp",
            "jsvalHandle": "&temp",
            "obj": "proxy",
            "successCode": (
                "if (!adder->append(cx, temp)) return false;\n" "continue;\n"
            ),
        }
        get = CGProxyIndexedGetter(
            self.descriptor, templateValues, False, False
        ).define()

        if self.descriptor.lengthNeedsCallerType():
            callerType = callerTypeGetterForDescriptor(self.descriptor)
        else:
            callerType = ""

        return fill(
            """
            JS::Rooted<JS::Value> temp(cx);
            MOZ_ASSERT(!xpc::WrapperFactory::IsXrayWrapper(proxy),
                       "Should not have a XrayWrapper here");

            ${nativeType}* self = UnwrapProxy(proxy);
            uint32_t length = self->Length(${callerType});
            // Compute the end of the indices we'll get ourselves
            uint32_t ourEnd = std::max(begin, std::min(end, length));

            for (uint32_t index = begin; index < ourEnd; ++index) {
              $*{get}
            }

            if (end > ourEnd) {
              JS::Rooted<JSObject*> proto(cx);
              if (!js::GetObjectProto(cx, proxy, &proto)) {
                return false;
              }
              return js::GetElementsWithAdder(cx, proto, proxy, ourEnd, end, adder);
            }

            return true;
            """,
            nativeType=self.descriptor.nativeType,
            callerType=callerType,
            get=get,
        )


class CGJSProxyHandler_getInstance(ClassMethod):
    def __init__(self, type):
        self.type = type
        ClassMethod.__init__(
            self, "getInstance", "const %s*" % self.type, [], static=True
        )

    def getBody(self):
        return fill(
            """
            static const ${type} instance;
            return &instance;
            """,
            type=self.type,
        )


class CGDOMJSProxyHandler_call(ClassMethod):
    def __init__(self):
        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "proxy"),
            Argument("const JS::CallArgs&", "args"),
        ]

        ClassMethod.__init__(
            self, "call", "bool", args, virtual=True, override=True, const=True
        )

    def getBody(self):
        return fill(
            """
            return js::ForwardToNative(cx, ${legacyCaller}, args);
            """,
            legacyCaller=LEGACYCALLER_HOOK_NAME,
        )


class CGDOMJSProxyHandler_isCallable(ClassMethod):
    def __init__(self):
        ClassMethod.__init__(
            self,
            "isCallable",
            "bool",
            [Argument("JSObject*", "obj")],
            virtual=True,
            override=True,
            const=True,
        )

    def getBody(self):
        return dedent(
            """
            return true;
        """
        )


class CGDOMJSProxyHandler_canNurseryAllocate(ClassMethod):
    """
    Override the default canNurseryAllocate in BaseProxyHandler, for cases when
    we should be nursery-allocated.
    """

    def __init__(self):
        ClassMethod.__init__(
            self,
            "canNurseryAllocate",
            "bool",
            [],
            virtual=True,
            override=True,
            const=True,
        )

    def getBody(self):
        return dedent(
            """
            return true;
        """
        )


class CGDOMJSProxyHandler_getOwnPropertyDescriptor(ClassMethod):
    """
    Implementation of getOwnPropertyDescriptor.  We only use this for
    cross-origin objects.
    """

    def __init__(self, descriptor):
        assert descriptor.isMaybeCrossOriginObject()

        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "proxy"),
            Argument("JS::Handle<jsid>", "id"),
            Argument("JS::MutableHandle<Maybe<JS::PropertyDescriptor>>", "desc"),
        ]
        ClassMethod.__init__(
            self,
            "getOwnPropertyDescriptor",
            "bool",
            args,
            virtual=True,
            override=True,
            const=True,
        )
        self.descriptor = descriptor

    def getBody(self):
        return dedent(
            """
            // Implementation of <https://html.spec.whatwg.org/multipage/history.html#location-getownproperty>.
            MOZ_ASSERT(!xpc::WrapperFactory::IsXrayWrapper(proxy));

            // Step 1.
            if (IsPlatformObjectSameOrigin(cx, proxy)) {
              { // Scope so we can wrap our PropertyDescriptor back into
                // the caller compartment.
                // Enter the Realm of "proxy" so we can work with it.
                JSAutoRealm ar(cx, proxy);

                JS_MarkCrossZoneId(cx, id);

                // The spec messes around with configurability of the returned
                // descriptor here, but it's not clear what should actually happen
                // here.  See <https://github.com/whatwg/html/issues/4157>.  For
                // now, keep our old behavior and don't do any magic.
                if (!dom::DOMProxyHandler::getOwnPropertyDescriptor(cx, proxy, id, desc)) {
                  return false;
                }
              }
              return JS_WrapPropertyDescriptor(cx, desc);
            }

            // Step 2.
            if (!CrossOriginGetOwnPropertyHelper(cx, proxy, id, desc)) {
              return false;
            }

            // Step 3.
            if (desc.isSome()) {
              return true;
            }

            // And step 4.
            return CrossOriginPropertyFallback(cx, proxy, id, desc);
            """
        )


class CGDOMJSProxyHandler_getSameOriginPrototype(ClassMethod):
    """
    Implementation of getSameOriginPrototype.  We only use this for
    cross-origin objects.
    """

    def __init__(self, descriptor):
        assert descriptor.isMaybeCrossOriginObject()

        args = [Argument("JSContext*", "cx")]
        ClassMethod.__init__(
            self,
            "getSameOriginPrototype",
            "JSObject*",
            args,
            virtual=True,
            override=True,
            const=True,
        )
        self.descriptor = descriptor

    def getBody(self):
        return dedent(
            """
            return GetProtoObjectHandle(cx);
            """
        )


class CGDOMJSProxyHandler_definePropertySameOrigin(ClassMethod):
    """
    Implementation of definePropertySameOrigin.  We only use this for
    cross-origin objects.
    """

    def __init__(self, descriptor):
        assert descriptor.isMaybeCrossOriginObject()

        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "proxy"),
            Argument("JS::Handle<jsid>", "id"),
            Argument("JS::Handle<JS::PropertyDescriptor>", "desc"),
            Argument("JS::ObjectOpResult&", "result"),
        ]
        ClassMethod.__init__(
            self,
            "definePropertySameOrigin",
            "bool",
            args,
            virtual=True,
            override=True,
            const=True,
        )
        self.descriptor = descriptor

    def getBody(self):
        return dedent(
            """
            return dom::DOMProxyHandler::defineProperty(cx, proxy, id, desc, result);
            """
        )


class CGDOMJSProxyHandler_set(ClassMethod):
    """
    Implementation of set().  We only use this for cross-origin objects.
    """

    def __init__(self, descriptor):
        assert descriptor.isMaybeCrossOriginObject()

        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "proxy"),
            Argument("JS::Handle<jsid>", "id"),
            Argument("JS::Handle<JS::Value>", "v"),
            Argument("JS::Handle<JS::Value>", "receiver"),
            Argument("JS::ObjectOpResult&", "result"),
        ]
        ClassMethod.__init__(
            self, "set", "bool", args, virtual=True, override=True, const=True
        )
        self.descriptor = descriptor

    def getBody(self):
        return dedent(
            """
            if (!IsPlatformObjectSameOrigin(cx, proxy)) {
              return CrossOriginSet(cx, proxy, id, v, receiver, result);
            }

            // Safe to enter the Realm of proxy now, since it's same-origin with us.
            JSAutoRealm ar(cx, proxy);
            JS::Rooted<JS::Value> wrappedReceiver(cx, receiver);
            if (!MaybeWrapValue(cx, &wrappedReceiver)) {
              return false;
            }

            JS::Rooted<JS::Value> wrappedValue(cx, v);
            if (!MaybeWrapValue(cx, &wrappedValue)) {
              return false;
            }

            JS_MarkCrossZoneId(cx, id);

            return dom::DOMProxyHandler::set(cx, proxy, id, wrappedValue, wrappedReceiver, result);
            """
        )


class CGDOMJSProxyHandler_EnsureHolder(ClassMethod):
    """
    Implementation of EnsureHolder().  We only use this for cross-origin objects.
    """

    def __init__(self, descriptor):
        args = [
            Argument("JSContext*", "cx"),
            Argument("JS::Handle<JSObject*>", "proxy"),
            Argument("JS::MutableHandle<JSObject*>", "holder"),
        ]
        ClassMethod.__init__(
            self, "EnsureHolder", "bool", args, virtual=True, override=True, const=True
        )
        self.descriptor = descriptor

    def getBody(self):
        return dedent(
            """
            return EnsureHolder(cx, proxy,
                                JSCLASS_RESERVED_SLOTS(JS::GetClass(proxy)) - 1,
                                sCrossOriginProperties, holder);
            """
        )


class CGDOMJSProxyHandler(CGClass):
    def __init__(self, descriptor):
        assert (
            descriptor.supportsIndexedProperties()
            or descriptor.supportsNamedProperties()
            or descriptor.isMaybeCrossOriginObject()
        )
        methods = [
            CGDOMJSProxyHandler_getOwnPropDescriptor(descriptor),
            CGDOMJSProxyHandler_defineProperty(descriptor),
            ClassUsingDeclaration("mozilla::dom::DOMProxyHandler", "defineProperty"),
            CGDOMJSProxyHandler_ownPropNames(descriptor),
            CGDOMJSProxyHandler_hasOwn(descriptor),
            CGDOMJSProxyHandler_get(descriptor),
            CGDOMJSProxyHandler_className(descriptor),
            CGDOMJSProxyHandler_finalizeInBackground(descriptor),
            CGDOMJSProxyHandler_finalize(descriptor),
            CGJSProxyHandler_getInstance("DOMProxyHandler"),
            CGDOMJSProxyHandler_delete(descriptor),
        ]
        constructors = [
            ClassConstructor([], constexpr=True, visibility="public", explicit=True)
        ]

        if descriptor.supportsIndexedProperties():
            methods.append(CGDOMJSProxyHandler_getElements(descriptor))
        if descriptor.operations["IndexedSetter"] is not None or (
            descriptor.operations["NamedSetter"] is not None
            and descriptor.interface.getExtendedAttribute("LegacyOverrideBuiltIns")
        ):
            methods.append(CGDOMJSProxyHandler_setCustom(descriptor))
        if descriptor.operations["LegacyCaller"]:
            methods.append(CGDOMJSProxyHandler_call())
            methods.append(CGDOMJSProxyHandler_isCallable())
        if descriptor.interface.hasProbablyShortLivingWrapper():
            if not descriptor.wrapperCache:
                raise TypeError(
                    "Need a wrapper cache to support nursery "
                    "allocation of DOM objects"
                )
            methods.append(CGDOMJSProxyHandler_canNurseryAllocate())
        if descriptor.wrapperCache:
            methods.append(CGDOMJSProxyHandler_objectMoved(descriptor))

        if descriptor.isMaybeCrossOriginObject():
            methods.extend(
                [
                    CGDOMJSProxyHandler_getOwnPropertyDescriptor(descriptor),
                    CGDOMJSProxyHandler_getSameOriginPrototype(descriptor),
                    CGDOMJSProxyHandler_definePropertySameOrigin(descriptor),
                    CGDOMJSProxyHandler_set(descriptor),
                    CGDOMJSProxyHandler_EnsureHolder(descriptor),
                    ClassUsingDeclaration(
                        "MaybeCrossOriginObjectMixins", "EnsureHolder"
                    ),
                ]
            )

        if descriptor.interface.getExtendedAttribute("LegacyOverrideBuiltIns"):
            assert not descriptor.isMaybeCrossOriginObject()
            parentClass = "ShadowingDOMProxyHandler"
        elif descriptor.isMaybeCrossOriginObject():
            parentClass = "MaybeCrossOriginObject<mozilla::dom::DOMProxyHandler>"
        else:
            parentClass = "mozilla::dom::DOMProxyHandler"

        CGClass.__init__(
            self,
            "DOMProxyHandler",
            bases=[ClassBase(parentClass)],
            constructors=constructors,
            methods=methods,
        )


class CGDOMJSProxyHandlerDeclarer(CGThing):
    """
    A class for declaring a DOMProxyHandler.
    """

    def __init__(self, handlerThing):
        self.handlerThing = handlerThing

    def declare(self):
        # Our class declaration should happen when we're defining
        return ""

    def define(self):
        return self.handlerThing.declare()


class CGDOMJSProxyHandlerDefiner(CGThing):
    """
    A class for defining a DOMProxyHandler.
    """

    def __init__(self, handlerThing):
        self.handlerThing = handlerThing

    def declare(self):
        return ""

    def define(self):
        return self.handlerThing.define()


def stripTrailingWhitespace(text):
    tail = "\n" if text.endswith("\n") else ""
    lines = text.splitlines()
    return "\n".join(line.rstrip() for line in lines) + tail


class MemberProperties:
    def __init__(self):
        self.isCrossOriginMethod = False
        self.isCrossOriginGetter = False
        self.isCrossOriginSetter = False


def memberProperties(m, descriptor):
    props = MemberProperties()
    if m.isMethod():
        if not m.isIdentifierLess() or m == descriptor.operations["Stringifier"]:
            if not m.isStatic() and descriptor.interface.hasInterfacePrototypeObject():
                if m.getExtendedAttribute("CrossOriginCallable"):
                    props.isCrossOriginMethod = True
    elif m.isAttr():
        if not m.isStatic() and descriptor.interface.hasInterfacePrototypeObject():
            if m.getExtendedAttribute("CrossOriginReadable"):
                props.isCrossOriginGetter = True
        if not m.readonly:
            if not m.isStatic() and descriptor.interface.hasInterfacePrototypeObject():
                if m.getExtendedAttribute("CrossOriginWritable"):
                    props.isCrossOriginSetter = True
        elif m.getExtendedAttribute("PutForwards"):
            if m.getExtendedAttribute("CrossOriginWritable"):
                props.isCrossOriginSetter = True
        elif m.getExtendedAttribute("Replaceable") or m.getExtendedAttribute(
            "LegacyLenientSetter"
        ):
            if m.getExtendedAttribute("CrossOriginWritable"):
                props.isCrossOriginSetter = True

    return props


class CGDescriptor(CGThing):
    def __init__(self, descriptor):
        CGThing.__init__(self)

        assert (
            not descriptor.concrete
            or descriptor.interface.hasInterfacePrototypeObject()
        )

        self._deps = descriptor.interface.getDeps()

        iteratorCGThings = None
        if (
            descriptor.interface.isIterable()
            and descriptor.interface.maplikeOrSetlikeOrIterable.isPairIterator()
        ) or descriptor.interface.isAsyncIterable():
            # We need the Wrap function when using the [Async]IterableIterator type, so we want to declare it before we need it. We don't really want to expose it in the header file, so we make it static too.
            iteratorCGThings = []
            itr_iface = (
                descriptor.interface.maplikeOrSetlikeOrIterable.iteratorType.inner
            )
            iteratorDescriptor = descriptor.getDescriptor(itr_iface.identifier.name)
            iteratorCGThings.append(
                CGWrapNonWrapperCacheMethod(
                    iteratorDescriptor, static=True, signatureOnly=True
                )
            )
            iteratorCGThings = CGList(
                (CGIndenter(t, declareOnly=True) for t in iteratorCGThings), "\n"
            )
            iteratorCGThings = CGWrapper(iteratorCGThings, pre="\n", post="\n")
            iteratorCGThings = CGWrapper(
                CGNamespace(
                    toBindingNamespace(iteratorDescriptor.name), iteratorCGThings
                ),
                post="\n",
            )

        cgThings = []

        isIteratorInterface = (
            descriptor.interface.isIteratorInterface()
            or descriptor.interface.isAsyncIteratorInterface()
        )
        if not isIteratorInterface:
            cgThings.append(
                CGGeneric(declare="typedef %s NativeType;\n" % descriptor.nativeType)
            )
            parent = descriptor.interface.parent
            if parent:
                cgThings.append(
                    CGGeneric(
                        "static_assert(IsRefcounted<NativeType>::value == IsRefcounted<%s::NativeType>::value,\n"
                        '              "Can\'t inherit from an interface with a different ownership model.");\n'
                        % toBindingNamespace(descriptor.parentPrototypeName)
                    )
                )

        defaultToJSONMethod = None
        needCrossOriginPropertyArrays = False
        unscopableNames = list()
        for n in descriptor.interface.legacyFactoryFunctions:
            cgThings.append(
                CGClassConstructor(descriptor, n, LegacyFactoryFunctionName(n))
            )
        for m in descriptor.interface.members:
            if m.isMethod() and m.identifier.name == "QueryInterface":
                continue

            props = memberProperties(m, descriptor)

            if m.isMethod():
                if m.getExtendedAttribute("Unscopable"):
                    assert not m.isStatic()
                    unscopableNames.append(m.identifier.name)
                if m.isDefaultToJSON():
                    defaultToJSONMethod = m
                elif (
                    not m.isIdentifierLess()
                    or m == descriptor.operations["Stringifier"]
                ):
                    if m.isStatic():
                        assert descriptor.interface.hasInterfaceObject()
                        cgThings.append(CGStaticMethod(descriptor, m))
                        if m.returnsPromise():
                            cgThings.append(CGStaticMethodJitinfo(m))
                    elif descriptor.interface.hasInterfacePrototypeObject():
                        specializedMethod = CGSpecializedMethod(descriptor, m)
                        cgThings.append(specializedMethod)
                        if m.returnsPromise():
                            cgThings.append(
                                CGMethodPromiseWrapper(descriptor, specializedMethod)
                            )
                        cgThings.append(CGMemberJITInfo(descriptor, m))
                        if props.isCrossOriginMethod:
                            needCrossOriginPropertyArrays = True
            # If we've hit the maplike/setlike member itself, go ahead and
            # generate its convenience functions.
            elif m.isMaplikeOrSetlike():
                cgThings.append(CGMaplikeOrSetlikeHelperGenerator(descriptor, m))
            elif m.isAttr():
                if m.type.isObservableArray():
                    cgThings.append(
                        CGObservableArrayProxyHandlerGenerator(descriptor, m)
                    )
                    cgThings.append(CGObservableArrayHelperGenerator(descriptor, m))
                if m.getExtendedAttribute("Unscopable"):
                    assert not m.isStatic()
                    unscopableNames.append(m.identifier.name)
                if m.isStatic():
                    assert descriptor.interface.hasInterfaceObject()
                    cgThings.append(CGStaticGetter(descriptor, m))
                elif descriptor.interface.hasInterfacePrototypeObject():
                    specializedGetter = CGSpecializedGetter(descriptor, m)
                    cgThings.append(specializedGetter)
                    if m.type.isPromise():
                        cgThings.append(
                            CGGetterPromiseWrapper(descriptor, specializedGetter)
                        )
                    if props.isCrossOriginGetter:
                        needCrossOriginPropertyArrays = True
                if not m.readonly:
                    if m.isStatic():
                        assert descriptor.interface.hasInterfaceObject()
                        cgThings.append(CGStaticSetter(descriptor, m))
                    elif descriptor.interface.hasInterfacePrototypeObject():
                        cgThings.append(CGSpecializedSetter(descriptor, m))
                        if props.isCrossOriginSetter:
                            needCrossOriginPropertyArrays = True
                elif m.getExtendedAttribute("PutForwards"):
                    cgThings.append(CGSpecializedForwardingSetter(descriptor, m))
                    if props.isCrossOriginSetter:
                        needCrossOriginPropertyArrays = True
                elif m.getExtendedAttribute("Replaceable"):
                    cgThings.append(CGSpecializedReplaceableSetter(descriptor, m))
                elif m.getExtendedAttribute("LegacyLenientSetter"):
                    # XXX In this case, we need to add an include for mozilla/dom/Document.h to the generated cpp file.
                    cgThings.append(CGSpecializedLenientSetter(descriptor, m))
                if (
                    not m.isStatic()
                    and descriptor.interface.hasInterfacePrototypeObject()
                ):
                    cgThings.append(CGMemberJITInfo(descriptor, m))
            if m.isConst() and m.type.isPrimitive():
                cgThings.append(CGConstDefinition(m))

        if defaultToJSONMethod:
            cgThings.append(CGDefaultToJSONMethod(descriptor, defaultToJSONMethod))
            cgThings.append(CGMemberJITInfo(descriptor, defaultToJSONMethod))

        if descriptor.concrete and not descriptor.proxy:
            if wantsAddProperty(descriptor):
                cgThings.append(CGAddPropertyHook(descriptor))

            # Always have a finalize hook, regardless of whether the class
            # wants a custom hook.
            cgThings.append(CGClassFinalizeHook(descriptor))

        if wantsGetWrapperCache(descriptor):
            cgThings.append(CGGetWrapperCacheHook(descriptor))

        if descriptor.concrete and descriptor.wrapperCache and not descriptor.proxy:
            cgThings.append(CGClassObjectMovedHook(descriptor))

        properties = PropertyArrays(descriptor)
        cgThings.append(CGGeneric(define=str(properties)))
        cgThings.append(CGNativeProperties(descriptor, properties))

        if defaultToJSONMethod:
            # Now that we know about our property arrays, we can
            # output our "collect attribute values" method, which uses those.
            cgThings.append(
                CGCollectJSONAttributesMethod(descriptor, defaultToJSONMethod)
            )

        # Declare our DOMProxyHandler.
        if descriptor.concrete and descriptor.proxy:
            cgThings.append(
                CGGeneric(
                    fill(
                        """
                        static_assert(std::is_base_of_v<nsISupports, ${nativeType}>,
                                      "We don't support non-nsISupports native classes for "
                                      "proxy-based bindings yet");

                        """,
                        nativeType=descriptor.nativeType,
                    )
                )
            )
            if not descriptor.wrapperCache:
                raise TypeError(
                    "We need a wrappercache to support expandos for proxy-based "
                    "bindings (" + descriptor.name + ")"
                )
            handlerThing = CGDOMJSProxyHandler(descriptor)
            cgThings.append(CGDOMJSProxyHandlerDeclarer(handlerThing))
            cgThings.append(CGProxyIsProxy(descriptor))
            cgThings.append(CGProxyUnwrap(descriptor))

        # Set up our Xray callbacks as needed.  This needs to come
        # after we have our DOMProxyHandler defined.
        if descriptor.wantsXrays:
            if descriptor.concrete and descriptor.proxy:
                if descriptor.needsXrayNamedDeleterHook():
                    cgThings.append(CGDeleteNamedProperty(descriptor))
            elif descriptor.needsXrayResolveHooks():
                cgThings.append(CGResolveOwnPropertyViaResolve(descriptor))
                cgThings.append(
                    CGEnumerateOwnPropertiesViaGetOwnPropertyNames(descriptor)
                )
            if descriptor.wantsXrayExpandoClass:
                cgThings.append(CGXrayExpandoJSClass(descriptor))

            # Now that we have our ResolveOwnProperty/EnumerateOwnProperties stuff
            # done, set up our NativePropertyHooks.
            cgThings.append(CGNativePropertyHooks(descriptor, properties))

        if descriptor.interface.hasInterfaceObject():
            cgThings.append(CGClassConstructor(descriptor, descriptor.interface.ctor()))
            cgThings.append(CGInterfaceObjectJSClass(descriptor, properties))
            cgThings.append(CGLegacyFactoryFunctions(descriptor))

        cgThings.append(CGLegacyCallHook(descriptor))
        if descriptor.interface.getExtendedAttribute("NeedResolve"):
            cgThings.append(CGResolveHook(descriptor))
            cgThings.append(CGMayResolveHook(descriptor))
            cgThings.append(CGEnumerateHook(descriptor))

        if descriptor.hasNamedPropertiesObject:
            cgThings.append(CGGetNamedPropertiesObjectMethod(descriptor))

        if descriptor.interface.hasInterfacePrototypeObject():
            cgThings.append(CGPrototypeJSClass(descriptor, properties))

        if (
            descriptor.interface.hasInterfaceObject()
            and not descriptor.interface.isExternal()
            and descriptor.isExposedConditionally()
        ):
            cgThings.append(CGConstructorEnabled(descriptor))

        if (
            descriptor.interface.hasMembersInSlots()
            and descriptor.interface.hasChildInterfaces()
        ):
            raise TypeError(
                "We don't support members in slots on "
                "non-leaf interfaces like %s" % descriptor.interface.identifier.name
            )

        if descriptor.needsMissingPropUseCounters:
            cgThings.append(CGCountMaybeMissingProperty(descriptor))

        if descriptor.concrete:
            if descriptor.interface.isSerializable():
                cgThings.append(CGSerializer(descriptor))
                cgThings.append(CGDeserializer(descriptor))

            # CGDOMProxyJSClass/CGDOMJSClass need GetProtoObjectHandle, but we don't want to export it for the iterator interfaces, so declare it here.
            if isIteratorInterface:
                cgThings.append(
                    CGGetProtoObjectHandleMethod(
                        descriptor, static=True, signatureOnly=True
                    )
                )

            if descriptor.proxy:
                cgThings.append(CGDOMJSProxyHandlerDefiner(handlerThing))
                cgThings.append(CGDOMProxyJSClass(descriptor))
            else:
                cgThings.append(CGDOMJSClass(descriptor))

            if descriptor.interface.hasMembersInSlots():
                cgThings.append(CGUpdateMemberSlotsMethod(descriptor))

            if descriptor.isGlobal():
                assert descriptor.wrapperCache
                cgThings.append(CGWrapGlobalMethod(descriptor, properties))
            elif descriptor.wrapperCache:
                cgThings.append(CGWrapWithCacheMethod(descriptor))
                cgThings.append(CGWrapMethod(descriptor))
            else:
                cgThings.append(
                    CGWrapNonWrapperCacheMethod(descriptor, static=isIteratorInterface)
                )

        # If we're not wrappercached, we don't know how to clear our
        # cached values, since we can't get at the JSObject.
        if descriptor.wrapperCache:
            cgThings.extend(
                CGClearCachedValueMethod(descriptor, m)
                for m in clearableCachedAttrs(descriptor)
            )

        haveUnscopables = (
            len(unscopableNames) != 0
            and descriptor.interface.hasInterfacePrototypeObject()
        )
        if haveUnscopables:
            cgThings.append(
                CGList(
                    [
                        CGGeneric("static const char* const unscopableNames[] = {"),
                        CGIndenter(
                            CGList(
                                [CGGeneric('"%s"' % name) for name in unscopableNames]
                                + [CGGeneric("nullptr")],
                                ",\n",
                            )
                        ),
                        CGGeneric("};\n"),
                    ],
                    "\n",
                )
            )

        legacyWindowAliases = descriptor.interface.legacyWindowAliases
        haveLegacyWindowAliases = len(legacyWindowAliases) != 0
        if haveLegacyWindowAliases:
            cgThings.append(
                CGList(
                    [
                        CGGeneric("static const char* const legacyWindowAliases[] = {"),
                        CGIndenter(
                            CGList(
                                [
                                    CGGeneric('"%s"' % name)
                                    for name in legacyWindowAliases
                                ]
                                + [CGGeneric("nullptr")],
                                ",\n",
                            )
                        ),
                        CGGeneric("};\n"),
                    ],
                    "\n",
                )
            )

        # CGCreateInterfaceObjectsMethod needs to come after our
        # CGDOMJSClass and unscopables, if any.
        cgThings.append(
            CGCreateInterfaceObjectsMethod(
                descriptor,
                properties,
                haveUnscopables,
                haveLegacyWindowAliases,
                static=isIteratorInterface,
            )
        )

        # CGGetProtoObjectMethod and CGGetConstructorObjectMethod need
        # to come after CGCreateInterfaceObjectsMethod.
        if (
            descriptor.interface.hasInterfacePrototypeObject()
            and not descriptor.hasOrdinaryObjectPrototype
        ):
            cgThings.append(
                CGGetProtoObjectHandleMethod(descriptor, static=isIteratorInterface)
            )
            if descriptor.interface.hasChildInterfaces():
                assert not isIteratorInterface
                cgThings.append(CGGetProtoObjectMethod(descriptor))
        if descriptor.interface.hasInterfaceObject():
            cgThings.append(CGGetConstructorObjectHandleMethod(descriptor))
            cgThings.append(CGGetConstructorObjectMethod(descriptor))

        # See whether we need to generate cross-origin property arrays.
        if needCrossOriginPropertyArrays:
            cgThings.append(CGCrossOriginProperties(descriptor))

        cgThings = CGList((CGIndenter(t, declareOnly=True) for t in cgThings), "\n")
        cgThings = CGWrapper(cgThings, pre="\n", post="\n")
        cgThings = CGWrapper(
            CGNamespace(toBindingNamespace(descriptor.name), cgThings), post="\n"
        )
        self.cgRoot = CGList([iteratorCGThings, cgThings], "\n")

    def declare(self):
        return self.cgRoot.declare()

    def define(self):
        return self.cgRoot.define()

    def deps(self):
        return self._deps


class CGNamespacedEnum(CGThing):
    def __init__(self, namespace, enumName, names, values, comment=""):

        if not values:
            values = []

        # Account for explicit enum values.
        entries = []
        for i in range(0, len(names)):
            if len(values) > i and values[i] is not None:
                entry = "%s = %s" % (names[i], values[i])
            else:
                entry = names[i]
            entries.append(entry)

        # Append a Count.
        entries.append("_" + enumName + "_Count")

        # Indent.
        entries = ["  " + e for e in entries]

        # Build the enum body.
        enumstr = comment + "enum %s : uint16_t\n{\n%s\n};\n" % (
            enumName,
            ",\n".join(entries),
        )
        curr = CGGeneric(declare=enumstr)

        # Add some whitespace padding.
        curr = CGWrapper(curr, pre="\n", post="\n")

        # Add the namespace.
        curr = CGNamespace(namespace, curr)

        # Add the typedef
        typedef = "\ntypedef %s::%s %s;\n\n" % (namespace, enumName, enumName)
        curr = CGList([curr, CGGeneric(declare=typedef)])

        # Save the result.
        self.node = curr

    def declare(self):
        return self.node.declare()

    def define(self):
        return ""


def initIdsClassMethod(identifiers, atomCacheName):
    idinit = [
        '!atomsCache->%s.init(cx, "%s")' % (CGDictionary.makeIdName(id), id)
        for id in identifiers
    ]
    idinit.reverse()
    body = fill(
        """
        MOZ_ASSERT(reinterpret_cast<jsid*>(atomsCache)->isVoid());

        // Initialize these in reverse order so that any failure leaves the first one
        // uninitialized.
        if (${idinit}) {
          return false;
        }
        return true;
        """,
        idinit=" ||\n    ".join(idinit),
    )
    return ClassMethod(
        "InitIds",
        "bool",
        [Argument("JSContext*", "cx"), Argument("%s*" % atomCacheName, "atomsCache")],
        static=True,
        body=body,
        visibility="private",
    )


class CGDictionary(CGThing):
    def __init__(self, dictionary, descriptorProvider):
        self.dictionary = dictionary
        self.descriptorProvider = descriptorProvider
        self.needToInitIds = len(dictionary.members) > 0
        self.memberInfo = [
            (
                member,
                getJSToNativeConversionInfo(
                    member.type,
                    descriptorProvider,
                    isMember="Dictionary",
                    isOptional=member.canHaveMissingValue(),
                    isKnownMissing=not dictionary.needsConversionFromJS,
                    defaultValue=member.defaultValue,
                    sourceDescription=self.getMemberSourceDescription(member),
                ),
            )
            for member in dictionary.members
        ]

        # If we have a union member which is going to be declared in a different
        # header but contains something that will be declared in the same header
        # as us, bail: the C++ includes won't work out.
        for member in dictionary.members:
            type = member.type.unroll()
            if type.isUnion() and CGHeaders.getUnionDeclarationFilename(
                descriptorProvider.getConfig(), type
            ) != CGHeaders.getDeclarationFilename(dictionary):
                for t in type.flatMemberTypes:
                    if t.isDictionary() and CGHeaders.getDeclarationFilename(
                        t.inner
                    ) == CGHeaders.getDeclarationFilename(dictionary):
                        raise TypeError(
                            "Dictionary contains a union that will live in a different "
                            "header that contains a dictionary from the same header as "
                            "the original dictionary.  This won't compile.  Move the "
                            "inner dictionary to a different Web IDL file to move it "
                            "to a different header.\n%s\n%s"
                            % (t.location, t.inner.location)
                        )
        self.structs = self.getStructs()

    def declare(self):
        return self.structs.declare()

    def define(self):
        return self.structs.define()

    def base(self):
        if self.dictionary.parent:
            return self.makeClassName(self.dictionary.parent)
        return "DictionaryBase"

    def initMethod(self):
        """
        This function outputs the body of the Init() method for the dictionary.

        For the most part, this is some bookkeeping for our atoms so
        we can avoid atomizing strings all the time, then we just spit
        out the getMemberConversion() output for each member,
        separated by newlines.

        """
        body = dedent(
            """
            // Passing a null JSContext is OK only if we're initing from null,
            // Since in that case we will not have to do any property gets
            // Also evaluate isNullOrUndefined in order to avoid false-positive
            // checkers by static analysis tools
            MOZ_ASSERT_IF(!cx, val.isNull() && val.isNullOrUndefined());
            """
        )

        if self.needToInitIds:
            body += fill(
                """
                ${dictName}Atoms* atomsCache = nullptr;
                if (cx) {
                  atomsCache = GetAtomCache<${dictName}Atoms>(cx);
                  if (reinterpret_cast<jsid*>(atomsCache)->isVoid() &&
                      !InitIds(cx, atomsCache)) {
                    return false;
                  }
                }

                """,
                dictName=self.makeClassName(self.dictionary),
            )

        if self.dictionary.parent:
            body += fill(
                """
                // Per spec, we init the parent's members first
                if (!${dictName}::Init(cx, val)) {
                  return false;
                }

                """,
                dictName=self.makeClassName(self.dictionary.parent),
            )
        else:
            body += dedent(
                """
                if (!IsConvertibleToDictionary(val)) {
                  return cx.ThrowErrorMessage<MSG_CONVERSION_ERROR>(sourceDescription, "dictionary");
                }

                """
            )

        memberInits = [self.getMemberConversion(m).define() for m in self.memberInfo]
        if memberInits:
            body += fill(
                """
                bool isNull = val.isNullOrUndefined();
                // We only need these if !isNull, in which case we have |cx|.
                Maybe<JS::Rooted<JSObject *> > object;
                Maybe<JS::Rooted<JS::Value> > temp;
                if (!isNull) {
                  MOZ_ASSERT(cx);
                  object.emplace(cx, &val.toObject());
                  temp.emplace(cx);
                }
                $*{memberInits}
                """,
                memberInits="\n".join(memberInits),
            )

        body += "return true;\n"

        return ClassMethod(
            "Init",
            "bool",
            [
                Argument("BindingCallContext&", "cx"),
                Argument("JS::Handle<JS::Value>", "val"),
                Argument("const char*", "sourceDescription", default='"Value"'),
                Argument("bool", "passedToJSImpl", default="false"),
            ],
            body=body,
        )

    def initWithoutCallContextMethod(self):
        """
        This function outputs the body of an Init() method for the dictionary
        that takes just a JSContext*.  This is needed for non-binding consumers.
        """
        body = dedent(
            """
            // We don't want to use sourceDescription for our context here;
            // that's not really what it's formatted for.
            BindingCallContext cx(cx_, nullptr);
            return Init(cx, val, sourceDescription, passedToJSImpl);
            """
        )
        return ClassMethod(
            "Init",
            "bool",
            [
                Argument("JSContext*", "cx_"),
                Argument("JS::Handle<JS::Value>", "val"),
                Argument("const char*", "sourceDescription", default='"Value"'),
                Argument("bool", "passedToJSImpl", default="false"),
            ],
            body=body,
        )

    def simpleInitMethod(self):
        """
        This function outputs the body of the Init() method for the dictionary,
        for cases when we are just default-initializing it.

        """
        relevantMembers = [
            m
            for m in self.memberInfo
            # We only need to init the things that can have
            # default values.
            if m[0].optional and m[0].defaultValue
        ]

        # We mostly avoid outputting code that uses cx in our native-to-JS
        # conversions, but there is one exception: we may have a
        # dictionary-typed member that _does_ generally support conversion from
        # JS.  If we have such a thing, we can pass it a null JSContext and
        # JS::NullHandleValue to default-initialize it, but since the
        # native-to-JS templates hardcode `cx` as the JSContext value, we're
        # going to need to provide that.
        haveMemberThatNeedsCx = any(
            m[0].type.isDictionary() and m[0].type.unroll().inner.needsConversionFromJS
            for m in relevantMembers
        )
        if haveMemberThatNeedsCx:
            body = dedent(
                """
                JSContext* cx = nullptr;
                """
            )
        else:
            body = ""

        if self.dictionary.parent:
            if self.dictionary.parent.needsConversionFromJS:
                args = "nullptr, JS::NullHandleValue"
            else:
                args = ""
            body += fill(
                """
                // We init the parent's members first
                if (!${dictName}::Init(${args})) {
                  return false;
                }

                """,
                dictName=self.makeClassName(self.dictionary.parent),
                args=args,
            )

        memberInits = [
            self.getMemberConversion(m, isKnownMissing=True).define()
            for m in relevantMembers
        ]
        if memberInits:
            body += fill(
                """
                $*{memberInits}
                """,
                memberInits="\n".join(memberInits),
            )

        body += "return true;\n"

        return ClassMethod(
            "Init",
            "bool",
            [
                Argument("const char*", "sourceDescription", default='"Value"'),
                Argument("bool", "passedToJSImpl", default="false"),
            ],
            body=body,
        )

    def initFromJSONMethod(self):
        return ClassMethod(
            "Init",
            "bool",
            [Argument("const nsAString&", "aJSON")],
            body=dedent(
                """
                AutoJSAPI jsapi;
                JSObject* cleanGlobal = SimpleGlobalObject::Create(SimpleGlobalObject::GlobalType::BindingDetail);
                if (!cleanGlobal) {
                  return false;
                }
                if (!jsapi.Init(cleanGlobal)) {
                  return false;
                }
                JSContext* cx = jsapi.cx();
                JS::Rooted<JS::Value> json(cx);
                bool ok = ParseJSON(cx, aJSON, &json);
                NS_ENSURE_TRUE(ok, false);
                return Init(cx, json);
                """
            ),
        )

    def toJSONMethod(self):
        return ClassMethod(
            "ToJSON",
            "bool",
            [Argument("nsAString&", "aJSON")],
            body=dedent(
                """
                AutoJSAPI jsapi;
                jsapi.Init();
                JSContext *cx = jsapi.cx();
                // It's safe to use UnprivilegedJunkScopeOrWorkerGlobal here
                // because we'll only be creating objects, in ways that have no
                // side-effects, followed by a call to JS::ToJSONMaybeSafely,
                // which likewise guarantees no side-effects for the sorts of
                // things we will pass it.
                JSObject* scope = UnprivilegedJunkScopeOrWorkerGlobal(fallible);
                if (!scope) {
                  JS_ReportOutOfMemory(cx);
                  return false;
                }
                JSAutoRealm ar(cx, scope);
                JS::Rooted<JS::Value> val(cx);
                if (!ToObjectInternal(cx, &val)) {
                  return false;
                }
                JS::Rooted<JSObject*> obj(cx, &val.toObject());
                return StringifyToJSON(cx, obj, aJSON);
            """
            ),
            const=True,
        )

    def toObjectInternalMethod(self):
        body = ""
        if self.needToInitIds:
            body += fill(
                """
                ${dictName}Atoms* atomsCache = GetAtomCache<${dictName}Atoms>(cx);
                if (reinterpret_cast<jsid*>(atomsCache)->isVoid() &&
                    !InitIds(cx, atomsCache)) {
                  return false;
                }

                """,
                dictName=self.makeClassName(self.dictionary),
            )

        if self.dictionary.parent:
            body += fill(
                """
                // Per spec, we define the parent's members first
                if (!${dictName}::ToObjectInternal(cx, rval)) {
                  return false;
                }
                JS::Rooted<JSObject*> obj(cx, &rval.toObject());

                """,
                dictName=self.makeClassName(self.dictionary.parent),
            )
        else:
            body += dedent(
                """
                JS::Rooted<JSObject*> obj(cx, JS_NewPlainObject(cx));
                if (!obj) {
                  return false;
                }
                rval.set(JS::ObjectValue(*obj));

                """
            )

        if self.memberInfo:
            body += "\n".join(
                self.getMemberDefinition(m).define() for m in self.memberInfo
            )
        body += "\nreturn true;\n"

        return ClassMethod(
            "ToObjectInternal",
            "bool",
            [
                Argument("JSContext*", "cx"),
                Argument("JS::MutableHandle<JS::Value>", "rval"),
            ],
            const=True,
            body=body,
        )

    def initIdsMethod(self):
        assert self.needToInitIds
        return initIdsClassMethod(
            [m.identifier.name for m in self.dictionary.members],
            "%sAtoms" % self.makeClassName(self.dictionary),
        )

    def traceDictionaryMethod(self):
        body = ""
        if self.dictionary.parent:
            cls = self.makeClassName(self.dictionary.parent)
            body += "%s::TraceDictionary(trc);\n" % cls

        memberTraces = [
            self.getMemberTrace(m)
            for m in self.dictionary.members
            if typeNeedsRooting(m.type)
        ]

        if memberTraces:
            body += "\n".join(memberTraces)

        return ClassMethod(
            "TraceDictionary",
            "void",
            [
                Argument("JSTracer*", "trc"),
            ],
            body=body,
        )

    @staticmethod
    def dictionaryNeedsCycleCollection(dictionary):
        return any(idlTypeNeedsCycleCollection(m.type) for m in dictionary.members) or (
            dictionary.parent
            and CGDictionary.dictionaryNeedsCycleCollection(dictionary.parent)
        )

    def traverseForCCMethod(self):
        body = ""
        if self.dictionary.parent and self.dictionaryNeedsCycleCollection(
            self.dictionary.parent
        ):
            cls = self.makeClassName(self.dictionary.parent)
            body += "%s::TraverseForCC(aCallback, aFlags);\n" % cls

        for m, _ in self.memberInfo:
            if idlTypeNeedsCycleCollection(m.type):
                memberName = self.makeMemberName(m.identifier.name)
                body += (
                    'ImplCycleCollectionTraverse(aCallback, %s, "%s", aFlags);\n'
                    % (memberName, memberName)
                )

        return ClassMethod(
            "TraverseForCC",
            "void",
            [
                Argument("nsCycleCollectionTraversalCallback&", "aCallback"),
                Argument("uint32_t", "aFlags"),
            ],
            body=body,
            # Inline so we don't pay a codesize hit unless someone actually uses
            # this traverse method.
            inline=True,
            bodyInHeader=True,
        )

    def unlinkForCCMethod(self):
        body = ""
        if self.dictionary.parent and self.dictionaryNeedsCycleCollection(
            self.dictionary.parent
        ):
            cls = self.makeClassName(self.dictionary.parent)
            body += "%s::UnlinkForCC();\n" % cls

        for m, _ in self.memberInfo:
            if idlTypeNeedsCycleCollection(m.type):
                memberName = self.makeMemberName(m.identifier.name)
                body += "ImplCycleCollectionUnlink(%s);\n" % memberName

        return ClassMethod(
            "UnlinkForCC",
            "void",
            [],
            body=body,
            # Inline so we don't pay a codesize hit unless someone actually uses
            # this unlink method.
            inline=True,
            bodyInHeader=True,
        )

    def assignmentOperator(self):
        body = CGList([])
        body.append(CGGeneric("%s::operator=(aOther);\n" % self.base()))

        for m, _ in self.memberInfo:
            memberName = self.makeMemberName(m.identifier.name)
            if m.canHaveMissingValue():
                memberAssign = CGGeneric(
                    fill(
                        """
                    ${name}.Reset();
                    if (aOther.${name}.WasPassed()) {
                      ${name}.Construct(aOther.${name}.Value());
                    }
                    """,
                        name=memberName,
                    )
                )
            else:
                memberAssign = CGGeneric("%s = aOther.%s;\n" % (memberName, memberName))
            body.append(memberAssign)
        body.append(CGGeneric("return *this;\n"))
        return ClassMethod(
            "operator=",
            "%s&" % self.makeClassName(self.dictionary),
            [Argument("const %s&" % self.makeClassName(self.dictionary), "aOther")],
            body=body.define(),
        )

    def canHaveEqualsOperator(self):
        return all(
            m.type.isString() or m.type.isPrimitive() for (m, _) in self.memberInfo
        )

    def equalsOperator(self):
        body = CGList([])

        for m, _ in self.memberInfo:
            memberName = self.makeMemberName(m.identifier.name)
            memberTest = CGGeneric(
                fill(
                    """
                if (${memberName} != aOther.${memberName}) {
                    return false;
                }
                """,
                    memberName=memberName,
                )
            )
            body.append(memberTest)
        body.append(CGGeneric("return true;\n"))
        return ClassMethod(
            "operator==",
            "bool",
            [Argument("const %s&" % self.makeClassName(self.dictionary), "aOther")],
            const=True,
            body=body.define(),
        )

    def getStructs(self):
        d = self.dictionary
        selfName = self.makeClassName(d)
        members = [
            ClassMember(
                self.makeMemberName(m[0].identifier.name),
                self.getMemberType(m),
                visibility="public",
                body=self.getMemberInitializer(m),
                hasIgnoreInitCheckFlag=True,
            )
            for m in self.memberInfo
        ]
        if d.parent:
            # We always want to init our parent with our non-initializing
            # constructor arg, because either we're about to init ourselves (and
            # hence our parent) or we don't want any init happening.
            baseConstructors = [
                "%s(%s)"
                % (self.makeClassName(d.parent), self.getNonInitializingCtorArg())
            ]
        else:
            baseConstructors = None

        if d.needsConversionFromJS:
            initArgs = "nullptr, JS::NullHandleValue"
        else:
            initArgs = ""
        ctors = [
            ClassConstructor(
                [],
                visibility="public",
                baseConstructors=baseConstructors,
                body=(
                    "// Safe to pass a null context if we pass a null value\n"
                    "Init(%s);\n" % initArgs
                ),
            ),
            ClassConstructor(
                [Argument("const FastDictionaryInitializer&", "")],
                visibility="public",
                baseConstructors=baseConstructors,
                explicit=True,
                bodyInHeader=True,
                body='// Do nothing here; this is used by our "Fast" subclass\n',
            ),
        ]
        methods = []

        if self.needToInitIds:
            methods.append(self.initIdsMethod())

        if d.needsConversionFromJS:
            methods.append(self.initMethod())
            methods.append(self.initWithoutCallContextMethod())
        else:
            methods.append(self.simpleInitMethod())

        canBeRepresentedAsJSON = self.dictionarySafeToJSONify(d)
        if canBeRepresentedAsJSON and d.getExtendedAttribute("GenerateInitFromJSON"):
            methods.append(self.initFromJSONMethod())

        if d.needsConversionToJS:
            methods.append(self.toObjectInternalMethod())

        if canBeRepresentedAsJSON and d.getExtendedAttribute("GenerateToJSON"):
            methods.append(self.toJSONMethod())

        methods.append(self.traceDictionaryMethod())

        try:
            if self.dictionaryNeedsCycleCollection(d):
                methods.append(self.traverseForCCMethod())
                methods.append(self.unlinkForCCMethod())
        except CycleCollectionUnsupported:
            # We have some member that we don't know how to CC.  Don't output
            # our cycle collection overloads, so attempts to CC us will fail to
            # compile instead of misbehaving.
            pass

        ctors.append(
            ClassConstructor(
                [Argument("%s&&" % selfName, "aOther")],
                default=True,
                visibility="public",
                baseConstructors=baseConstructors,
            )
        )

        if CGDictionary.isDictionaryCopyConstructible(d):
            disallowCopyConstruction = False
            # Note: gcc's -Wextra has a warning against not initializng our
            # base explicitly. If we have one. Use our non-initializing base
            # constructor to get around that.
            ctors.append(
                ClassConstructor(
                    [Argument("const %s&" % selfName, "aOther")],
                    bodyInHeader=True,
                    visibility="public",
                    baseConstructors=baseConstructors,
                    explicit=True,
                    body="*this = aOther;\n",
                )
            )
            methods.append(self.assignmentOperator())
        else:
            disallowCopyConstruction = True

        if self.canHaveEqualsOperator():
            methods.append(self.equalsOperator())

        struct = CGClass(
            selfName,
            bases=[ClassBase(self.base())],
            members=members,
            constructors=ctors,
            methods=methods,
            isStruct=True,
            disallowCopyConstruction=disallowCopyConstruction,
        )

        fastDictionaryCtor = ClassConstructor(
            [],
            visibility="public",
            bodyInHeader=True,
            baseConstructors=["%s(%s)" % (selfName, self.getNonInitializingCtorArg())],
            body="// Doesn't matter what int we pass to the parent constructor\n",
        )

        fastStruct = CGClass(
            "Fast" + selfName,
            bases=[ClassBase(selfName)],
            constructors=[fastDictionaryCtor],
            isStruct=True,
        )

        return CGList([struct, CGNamespace("binding_detail", fastStruct)], "\n")

    def deps(self):
        return self.dictionary.getDeps()

    @staticmethod
    def makeDictionaryName(dictionary):
        return dictionary.identifier.name

    def makeClassName(self, dictionary):
        return self.makeDictionaryName(dictionary)

    @staticmethod
    def makeMemberName(name):
        return "m" + name[0].upper() + IDLToCIdentifier(name[1:])

    def getMemberType(self, memberInfo):
        _, conversionInfo = memberInfo
        # We can't handle having a holderType here
        assert conversionInfo.holderType is None
        declType = conversionInfo.declType
        if conversionInfo.dealWithOptional:
            declType = CGTemplatedType("Optional", declType)
        return declType.define()

    def getMemberConversion(self, memberInfo, isKnownMissing=False):
        """
        A function that outputs the initialization of a single dictionary
        member from the given dictionary value.

        We start with our conversionInfo, which tells us how to
        convert a JS::Value to whatever type this member is.  We
        substiture the template from the conversionInfo with values
        that point to our "temp" JS::Value and our member (which is
        the C++ value we want to produce).  The output is a string of
        code to do the conversion.  We store this string in
        conversionReplacements["convert"].

        Now we have three different ways we might use (or skip) this
        string of code, depending on whether the value is required,
        optional with default value, or optional without default
        value.  We set up a template in the 'conversion' variable for
        exactly how to do this, then substitute into it from the
        conversionReplacements dictionary.
        """
        member, conversionInfo = memberInfo

        # We should only be initializing things with default values if
        # we're always-missing.
        assert not isKnownMissing or (member.optional and member.defaultValue)

        replacements = {
            "declName": self.makeMemberName(member.identifier.name),
            # We need a holder name for external interfaces, but
            # it's scoped down to the conversion so we can just use
            # anything we want.
            "holderName": "holder",
            "passedToJSImpl": "passedToJSImpl",
        }

        if isKnownMissing:
            replacements["val"] = "(JS::NullHandleValue)"
        else:
            replacements["val"] = "temp.ref()"
            replacements["maybeMutableVal"] = "temp.ptr()"

        # We can't handle having a holderType here
        assert conversionInfo.holderType is None
        if conversionInfo.dealWithOptional:
            replacements["declName"] = "(" + replacements["declName"] + ".Value())"
        if member.defaultValue:
            if isKnownMissing:
                replacements["haveValue"] = "false"
            else:
                replacements["haveValue"] = "!isNull && !temp->isUndefined()"

        propId = self.makeIdName(member.identifier.name)
        propGet = "JS_GetPropertyById(cx, *object, atomsCache->%s, temp.ptr())" % propId

        conversionReplacements = {
            "prop": self.makeMemberName(member.identifier.name),
            "convert": string.Template(conversionInfo.template).substitute(
                replacements
            ),
            "propGet": propGet,
        }
        # The conversion code will only run where a default value or a value passed
        # by the author needs to get converted, so we can remember if we have any
        # members present here.
        conversionReplacements["convert"] += "mIsAnyMemberPresent = true;\n"
        if isKnownMissing:
            conversion = ""
        else:
            setTempValue = CGGeneric(
                dedent(
                    """
                if (!${propGet}) {
                  return false;
                }
                """
                )
            )
            conditions = getConditionList(member, "cx", "*object")
            if len(conditions) != 0:
                setTempValue = CGIfElseWrapper(
                    conditions.define(),
                    setTempValue,
                    CGGeneric("temp->setUndefined();\n"),
                )
            setTempValue = CGIfWrapper(setTempValue, "!isNull")
            conversion = setTempValue.define()

        if member.defaultValue:
            if member.type.isUnion() and (
                not member.type.nullable()
                or not isinstance(member.defaultValue, IDLNullValue)
            ):
                # Since this has a default value, it might have been initialized
                # already.  Go ahead and uninit it before we try to init it
                # again.
                memberName = self.makeMemberName(member.identifier.name)
                if member.type.nullable():
                    conversion += fill(
                        """
                        if (!${memberName}.IsNull()) {
                          ${memberName}.Value().Uninit();
                        }
                        """,
                        memberName=memberName,
                    )
                else:
                    conversion += "%s.Uninit();\n" % memberName
            conversion += "${convert}"
        elif not conversionInfo.dealWithOptional:
            # We're required, but have no default value.  Make sure
            # that we throw if we have no value provided.
            conversion += dedent(
                """
                if (!isNull && !temp->isUndefined()) {
                ${convert}
                } else if (cx) {
                  // Don't error out if we have no cx.  In that
                  // situation the caller is default-constructing us and we'll
                  // just assume they know what they're doing.
                  return cx.ThrowErrorMessage<MSG_MISSING_REQUIRED_DICTIONARY_MEMBER>("%s");
                }
                """
                % self.getMemberSourceDescription(member)
            )
            conversionReplacements["convert"] = indent(
                conversionReplacements["convert"]
            ).rstrip()
        else:
            conversion += (
                "if (!isNull && !temp->isUndefined()) {\n"
                "  ${prop}.Construct();\n"
                "${convert}"
                "}\n"
            )
            conversionReplacements["convert"] = indent(
                conversionReplacements["convert"]
            )

        return CGGeneric(string.Template(conversion).substitute(conversionReplacements))

    def getMemberDefinition(self, memberInfo):
        member = memberInfo[0]
        declType = memberInfo[1].declType
        memberLoc = self.makeMemberName(member.identifier.name)
        if not member.canHaveMissingValue():
            memberData = memberLoc
        else:
            # The data is inside the Optional<>
            memberData = "%s.InternalValue()" % memberLoc

        # If you have to change this list (which you shouldn't!), make sure it
        # continues to match the list in test_Object.prototype_props.html
        if member.identifier.name in [
            "constructor",
            "toString",
            "toLocaleString",
            "valueOf",
            "hasOwnProperty",
            "isPrototypeOf",
            "propertyIsEnumerable",
            "__defineGetter__",
            "__defineSetter__",
            "__lookupGetter__",
            "__lookupSetter__",
            "__proto__",
        ]:
            raise TypeError(
                "'%s' member of %s dictionary shadows "
                "a property of Object.prototype, and Xrays to "
                "Object can't handle that.\n"
                "%s"
                % (
                    member.identifier.name,
                    self.dictionary.identifier.name,
                    member.location,
                )
            )

        propDef = (
            "JS_DefinePropertyById(cx, obj, atomsCache->%s, temp, JSPROP_ENUMERATE)"
            % self.makeIdName(member.identifier.name)
        )

        innerTemplate = wrapForType(
            member.type,
            self.descriptorProvider,
            {
                "result": "currentValue",
                "successCode": (
                    "if (!%s) {\n" "  return false;\n" "}\n" "break;\n" % propDef
                ),
                "jsvalRef": "temp",
                "jsvalHandle": "&temp",
                "returnsNewObject": False,
                # 'obj' can just be allowed to be the string "obj", since that
                # will be our dictionary object, which is presumably itself in
                # the right scope.
                "spiderMonkeyInterfacesAreStructs": True,
            },
        )
        conversion = CGGeneric(innerTemplate)
        conversion = CGWrapper(
            conversion,
            pre=(
                "JS::Rooted<JS::Value> temp(cx);\n"
                "%s const & currentValue = %s;\n" % (declType.define(), memberData)
            ),
        )

        # Now make sure that our successCode can actually break out of the
        # conversion.  This incidentally gives us a scope for 'temp' and
        # 'currentValue'.
        conversion = CGWrapper(
            CGIndenter(conversion),
            pre=(
                "do {\n"
                "  // block for our 'break' successCode and scope for 'temp' and 'currentValue'\n"
            ),
            post="} while(false);\n",
        )
        if member.canHaveMissingValue():
            # Only do the conversion if we have a value
            conversion = CGIfWrapper(conversion, "%s.WasPassed()" % memberLoc)
        conditions = getConditionList(member, "cx", "obj")
        if len(conditions) != 0:
            conversion = CGIfWrapper(conversion, conditions.define())
        return conversion

    def getMemberTrace(self, member):
        type = member.type
        assert typeNeedsRooting(type)
        memberLoc = self.makeMemberName(member.identifier.name)
        if not member.canHaveMissingValue():
            memberData = memberLoc
        else:
            # The data is inside the Optional<>
            memberData = "%s.Value()" % memberLoc

        memberName = "%s.%s" % (self.makeClassName(self.dictionary), memberLoc)

        if type.isObject():
            trace = CGGeneric(
                'JS::TraceRoot(trc, %s, "%s");\n' % ("&" + memberData, memberName)
            )
            if type.nullable():
                trace = CGIfWrapper(trace, memberData)
        elif type.isAny():
            trace = CGGeneric(
                'JS::TraceRoot(trc, %s, "%s");\n' % ("&" + memberData, memberName)
            )
        elif (
            type.isSequence()
            or type.isDictionary()
            or type.isSpiderMonkeyInterface()
            or type.isUnion()
            or type.isRecord()
        ):
            if type.nullable():
                memberNullable = memberData
                memberData = "%s.Value()" % memberData
            if type.isSequence():
                trace = CGGeneric("DoTraceSequence(trc, %s);\n" % memberData)
            elif type.isDictionary():
                trace = CGGeneric("%s.TraceDictionary(trc);\n" % memberData)
            elif type.isUnion():
                trace = CGGeneric("%s.TraceUnion(trc);\n" % memberData)
            elif type.isRecord():
                trace = CGGeneric("TraceRecord(trc, %s);\n" % memberData)
            else:
                assert type.isSpiderMonkeyInterface()
                trace = CGGeneric("%s.TraceSelf(trc);\n" % memberData)
            if type.nullable():
                trace = CGIfWrapper(trace, "!%s.IsNull()" % memberNullable)
        else:
            assert False  # unknown type

        if member.canHaveMissingValue():
            trace = CGIfWrapper(trace, "%s.WasPassed()" % memberLoc)

        return trace.define()

    def getMemberInitializer(self, memberInfo):
        """
        Get the right initializer for the member.  Most members don't need one,
        but we need to pre-initialize 'object' that have a default value or are
        required (and hence are not inside Optional), so they're safe to trace
        at all times.  And we can optimize a bit for dictionary-typed members.
        """
        member, _ = memberInfo
        if member.canHaveMissingValue():
            # Allowed missing value means no need to set it up front, since it's
            # inside an Optional and won't get traced until it's actually set
            # up.
            return None
        type = member.type
        if type.isDictionary():
            # When we construct ourselves, we don't want to init our member
            # dictionaries.  Either we're being constructed-but-not-initialized
            # ourselves (and then we don't want to init them) or we're about to
            # init ourselves and then we'll init them anyway.
            return CGDictionary.getNonInitializingCtorArg()
        return initializerForType(type)

    def getMemberSourceDescription(self, member):
        return "'%s' member of %s" % (
            member.identifier.name,
            self.dictionary.identifier.name,
        )

    @staticmethod
    def makeIdName(name):
        return IDLToCIdentifier(name) + "_id"

    @staticmethod
    def getNonInitializingCtorArg():
        return "FastDictionaryInitializer()"

    @staticmethod
    def isDictionaryCopyConstructible(dictionary):
        if dictionary.parent and not CGDictionary.isDictionaryCopyConstructible(
            dictionary.parent
        ):
            return False
        return all(isTypeCopyConstructible(m.type) for m in dictionary.members)

    @staticmethod
    def typeSafeToJSONify(type):
        """
        Determine whether the given type is safe to convert to JSON.  The
        restriction is that this needs to be safe while in a global controlled
        by an adversary, and "safe" means no side-effects when the JS
        representation of this type is converted to JSON.  That means that we
        have to be pretty restrictive about what things we can allow.  For
        example, "object" is out, because it may have accessor properties on it.
        """
        if type.nullable():
            # Converting null to JSON is always OK.
            return CGDictionary.typeSafeToJSONify(type.inner)

        if type.isSequence():
            # Sequences are arrays we create ourselves, with no holes.  They
            # should be safe if their contents are safe, as long as we suppress
            # invocation of .toJSON on objects.
            return CGDictionary.typeSafeToJSONify(type.inner)

        if type.isUnion():
            # OK if everything in it is ok.
            return all(CGDictionary.typeSafeToJSONify(t) for t in type.flatMemberTypes)

        if type.isDictionary():
            # OK if the dictionary is OK
            return CGDictionary.dictionarySafeToJSONify(type.inner)

        if type.isUndefined() or type.isString() or type.isEnum():
            # Strings are always OK.
            return True

        if type.isPrimitive():
            # Primitives (numbers and booleans) are ok, as long as
            # they're not unrestricted float/double.
            return not type.isFloat() or not type.isUnrestricted()

        if type.isRecord():
            # Records are okay, as long as the value type is.
            # Per spec, only strings are allowed as keys.
            return CGDictionary.typeSafeToJSONify(type.inner)

        return False

    @staticmethod
    def dictionarySafeToJSONify(dictionary):
        # The dictionary itself is OK, so we're good if all our types are.
        return all(CGDictionary.typeSafeToJSONify(m.type) for m in dictionary.members)


class CGRegisterWorkerBindings(CGAbstractMethod):
    def __init__(self, config):
        CGAbstractMethod.__init__(
            self,
            None,
            "RegisterWorkerBindings",
            "bool",
            [Argument("JSContext*", "aCx"), Argument("JS::Handle<JSObject*>", "aObj")],
        )
        self.config = config

    def definition_body(self):
        descriptors = self.config.getDescriptors(
            hasInterfaceObject=True, isExposedInAnyWorker=True, register=True
        )
        conditions = []
        for desc in descriptors:
            bindingNS = toBindingNamespace(desc.name)
            condition = "!%s::GetConstructorObject(aCx)" % bindingNS
            if desc.isExposedConditionally():
                condition = (
                    "%s::ConstructorEnabled(aCx, aObj) && " % bindingNS + condition
                )
            conditions.append(condition)
        lines = [
            CGIfWrapper(CGGeneric("return false;\n"), condition)
            for condition in conditions
        ]
        lines.append(CGGeneric("return true;\n"))
        return CGList(lines, "\n").define()


class CGRegisterWorkerDebuggerBindings(CGAbstractMethod):
    def __init__(self, config):
        CGAbstractMethod.__init__(
            self,
            None,
            "RegisterWorkerDebuggerBindings",
            "bool",
            [Argument("JSContext*", "aCx"), Argument("JS::Handle<JSObject*>", "aObj")],
        )
        self.config = config

    def definition_body(self):
        descriptors = self.config.getDescriptors(
            hasInterfaceObject=True, isExposedInWorkerDebugger=True, register=True
        )
        conditions = []
        for desc in descriptors:
            bindingNS = toBindingNamespace(desc.name)
            condition = "!%s::GetConstructorObject(aCx)" % bindingNS
            if desc.isExposedConditionally():
                condition = (
                    "%s::ConstructorEnabled(aCx, aObj) && " % bindingNS + condition
                )
            conditions.append(condition)
        lines = [
            CGIfWrapper(CGGeneric("return false;\n"), condition)
            for condition in conditions
        ]
        lines.append(CGGeneric("return true;\n"))
        return CGList(lines, "\n").define()


class CGRegisterWorkletBindings(CGAbstractMethod):
    def __init__(self, config):
        CGAbstractMethod.__init__(
            self,
            None,
            "RegisterWorkletBindings",
            "bool",
            [Argument("JSContext*", "aCx"), Argument("JS::Handle<JSObject*>", "aObj")],
        )
        self.config = config

    def definition_body(self):
        descriptors = self.config.getDescriptors(
            hasInterfaceObject=True, isExposedInAnyWorklet=True, register=True
        )
        conditions = []
        for desc in descriptors:
            bindingNS = toBindingNamespace(desc.name)
            condition = "!%s::GetConstructorObject(aCx)" % bindingNS
            if desc.isExposedConditionally():
                condition = (
                    "%s::ConstructorEnabled(aCx, aObj) && " % bindingNS + condition
                )
            conditions.append(condition)
        lines = [
            CGIfWrapper(CGGeneric("return false;\n"), condition)
            for condition in conditions
        ]
        lines.append(CGGeneric("return true;\n"))
        return CGList(lines, "\n").define()


class CGRegisterShadowRealmBindings(CGAbstractMethod):
    def __init__(self, config):
        CGAbstractMethod.__init__(
            self,
            None,
            "RegisterShadowRealmBindings",
            "bool",
            [Argument("JSContext*", "aCx"), Argument("JS::Handle<JSObject*>", "aObj")],
        )
        self.config = config

    def definition_body(self):
        descriptors = self.config.getDescriptors(
            hasInterfaceObject=True, isExposedInShadowRealms=True, register=True
        )
        conditions = []
        for desc in descriptors:
            bindingNS = toBindingNamespace(desc.name)
            condition = "!%s::GetConstructorObject(aCx)" % bindingNS
            if desc.isExposedConditionally():
                condition = (
                    "%s::ConstructorEnabled(aCx, aObj) && " % bindingNS + condition
                )
            conditions.append(condition)
        lines = [
            CGIfWrapper(CGGeneric("return false;\n"), condition)
            for condition in conditions
        ]
        lines.append(CGGeneric("return true;\n"))
        return CGList(lines, "\n").define()


def BindingNamesOffsetEnum(name):
    return CppKeywords.checkMethodName(name.replace(" ", "_"))


class CGGlobalNames(CGGeneric):
    def __init__(self, names):
        """
        names is expected to be a list of tuples of the name and the descriptor it refers to.
        """

        strings = []
        entries = []
        for name, desc in names:
            # Generate the entry declaration
            # XXX(nika): mCreate & mEnabled require relocations. If we want to
            # reduce those, we could move them into separate tables.
            nativeEntry = fill(
                """
                {
                  /* mNameOffset */ BindingNamesOffset::${nameOffset},
                  /* mNameLength */ ${nameLength},
                  /* mConstructorId */ constructors::id::${realname},
                  /* mCreate */ ${realname}_Binding::CreateInterfaceObjects,
                  /* mEnabled */ ${enabled}
                }
                """,
                nameOffset=BindingNamesOffsetEnum(name),
                nameLength=len(name),
                name=name,
                realname=desc.name,
                enabled=(
                    "%s_Binding::ConstructorEnabled" % desc.name
                    if desc.isExposedConditionally()
                    else "nullptr"
                ),
            )

            entries.append((name, nativeEntry))

        # Unfortunately, when running tests, we may have no entries.
        # PerfectHash will assert if we give it an empty set of entries, so we
        # just generate a dummy value.
        if len(entries) == 0:
            CGGeneric.__init__(
                self,
                define=dedent(
                    """
                static_assert(false, "No WebIDL global name entries!");
                """
                ),
            )
            return

        # Build the perfect hash function.
        phf = PerfectHash(entries, GLOBAL_NAMES_PHF_SIZE)

        # Generate code for the PHF
        phfCodegen = phf.codegen(
            "WebIDLGlobalNameHash::sEntries", "WebIDLNameTableEntry"
        )
        entries = phfCodegen.gen_entries(lambda e: e[1])
        getter = phfCodegen.gen_jslinearstr_getter(
            name="WebIDLGlobalNameHash::GetEntry",
            return_type="const WebIDLNameTableEntry*",
            return_entry=dedent(
                """
                if (JS_LinearStringEqualsAscii(aKey, BindingName(entry.mNameOffset), entry.mNameLength)) {
                  return &entry;
                }
                return nullptr;
                """
            ),
        )

        define = fill(
            """
            const uint32_t WebIDLGlobalNameHash::sCount = ${count};

            $*{entries}

            $*{getter}
            """,
            count=len(phf.entries),
            strings="\n".join(strings) + ";\n",
            entries=entries,
            getter=getter,
        )
        CGGeneric.__init__(self, define=define)


def dependencySortObjects(objects, dependencyGetter, nameGetter):
    """
    Sort IDL objects with dependencies on each other such that if A
    depends on B then B will come before A.  This is needed for
    declaring C++ classes in the right order, for example.  Objects
    that have no dependencies are just sorted by name.

    objects should be something that can produce a set of objects
    (e.g. a set, iterator, list, etc).

    dependencyGetter is something that, given an object, should return
    the set of objects it depends on.
    """
    # XXXbz this will fail if we have two webidl files F1 and F2 such that F1
    # declares an object which depends on an object in F2, and F2 declares an
    # object (possibly a different one!) that depends on an object in F1.  The
    # good news is that I expect this to never happen.
    sortedObjects = []
    objects = set(objects)
    while len(objects) != 0:
        # Find the dictionaries that don't depend on anything else
        # anymore and move them over.
        toMove = [o for o in objects if len(dependencyGetter(o) & objects) == 0]
        if len(toMove) == 0:
            raise TypeError(
                "Loop in dependency graph\n" + "\n".join(o.location for o in objects)
            )
        objects = objects - set(toMove)
        sortedObjects.extend(sorted(toMove, key=nameGetter))
    return sortedObjects


class ForwardDeclarationBuilder:
    """
    Create a canonical representation of a set of namespaced forward
    declarations.
    """

    def __init__(self):
        """
        The set of declarations is represented as a tree of nested namespaces.
        Each tree node has a set of declarations |decls| and a dict |children|.
        Each declaration is a pair consisting of the class name and a boolean
        that is true iff the class is really a struct. |children| maps the
        names of inner namespaces to the declarations in that namespace.
        """
        self.decls = set()
        self.children = {}

    def _ensureNonTemplateType(self, type):
        if "<" in type:
            # This is a templated type.  We don't really know how to
            # forward-declare those, and trying to do it naively is not going to
            # go well (e.g. we may have :: characters inside the type we're
            # templated on!).  Just bail out.
            raise TypeError(
                "Attempt to use ForwardDeclarationBuilder on "
                "templated type %s.  We don't know how to do that "
                "yet." % type
            )

    def _listAdd(self, namespaces, name, isStruct=False):
        """
        Add a forward declaration, where |namespaces| is a list of namespaces.
        |name| should not contain any other namespaces.
        """
        if namespaces:
            child = self.children.setdefault(namespaces[0], ForwardDeclarationBuilder())
            child._listAdd(namespaces[1:], name, isStruct)
        else:
            assert "::" not in name
            self.decls.add((name, isStruct))

    def addInMozillaDom(self, name, isStruct=False):
        """
        Add a forward declaration to the mozilla::dom:: namespace. |name| should not
        contain any other namespaces.
        """
        self._ensureNonTemplateType(name)
        self._listAdd(["mozilla", "dom"], name, isStruct)

    def add(self, nativeType, isStruct=False):
        """
        Add a forward declaration, where |nativeType| is a string containing
        the type and its namespaces, in the usual C++ way.
        """
        self._ensureNonTemplateType(nativeType)
        components = nativeType.split("::")
        self._listAdd(components[:-1], components[-1], isStruct)

    def _build(self, atTopLevel):
        """
        Return a codegenerator for the forward declarations.
        """
        decls = []
        if self.decls:
            decls.append(
                CGList(
                    [
                        CGClassForwardDeclare(cname, isStruct)
                        for cname, isStruct in sorted(self.decls)
                    ]
                )
            )
        for namespace, child in sorted(six.iteritems(self.children)):
            decls.append(CGNamespace(namespace, child._build(atTopLevel=False)))

        cg = CGList(decls, "\n")
        if not atTopLevel and len(decls) + len(self.decls) > 1:
            cg = CGWrapper(cg, pre="\n", post="\n")
        return cg

    def build(self):
        return self._build(atTopLevel=True)

    def forwardDeclareForType(self, t, config):
        t = t.unroll()
        if t.isGeckoInterface():
            name = t.inner.identifier.name
            try:
                desc = config.getDescriptor(name)
                self.add(desc.nativeType)
            except NoSuchDescriptorError:
                pass

        # Note: SpiderMonkey interfaces are typedefs, so can't be
        # forward-declared
        elif t.isPromise():
            self.addInMozillaDom("Promise")
        elif t.isCallback():
            self.addInMozillaDom(t.callback.identifier.name)
        elif t.isDictionary():
            self.addInMozillaDom(t.inner.identifier.name, isStruct=True)
        elif t.isCallbackInterface():
            self.addInMozillaDom(t.inner.identifier.name)
        elif t.isUnion():
            # Forward declare both the owning and non-owning version,
            # since we don't know which one we might want
            self.addInMozillaDom(CGUnionStruct.unionTypeName(t, False))
            self.addInMozillaDom(CGUnionStruct.unionTypeName(t, True))
        elif t.isRecord():
            self.forwardDeclareForType(t.inner, config)
        # Don't need to do anything for void, primitive, string, any or object.
        # There may be some other cases we are missing.


class CGForwardDeclarations(CGWrapper):
    """
    Code generate the forward declarations for a header file.
    additionalDeclarations is a list of tuples containing a classname and a
    boolean. If the boolean is true we will declare a struct, otherwise we'll
    declare a class.
    """

    def __init__(
        self,
        config,
        descriptors,
        callbacks,
        dictionaries,
        callbackInterfaces,
        additionalDeclarations=[],
    ):
        builder = ForwardDeclarationBuilder()

        # Needed for at least Wrap.
        for d in descriptors:
            # If this is a generated iterator interface, we only create these
            # in the generated bindings, and don't need to forward declare.
            if (
                d.interface.isIteratorInterface()
                or d.interface.isAsyncIteratorInterface()
            ):
                continue
            builder.add(d.nativeType)
            if d.interface.isSerializable():
                builder.add("nsIGlobalObject")
            # If we're an interface and we have a maplike/setlike declaration,
            # we'll have helper functions exposed to the native side of our
            # bindings, which will need to show up in the header. If either of
            # our key/value types are interfaces, they'll be passed as
            # arguments to helper functions, and they'll need to be forward
            # declared in the header.
            if d.interface.maplikeOrSetlikeOrIterable:
                if d.interface.maplikeOrSetlikeOrIterable.hasKeyType():
                    builder.forwardDeclareForType(
                        d.interface.maplikeOrSetlikeOrIterable.keyType, config
                    )
                if d.interface.maplikeOrSetlikeOrIterable.hasValueType():
                    builder.forwardDeclareForType(
                        d.interface.maplikeOrSetlikeOrIterable.valueType, config
                    )

            for m in d.interface.members:
                if m.isAttr() and m.type.isObservableArray():
                    builder.forwardDeclareForType(m.type, config)

        # We just about always need NativePropertyHooks
        builder.addInMozillaDom("NativePropertyHooks", isStruct=True)
        builder.addInMozillaDom("ProtoAndIfaceCache")

        for callback in callbacks:
            builder.addInMozillaDom(callback.identifier.name)
            for t in getTypesFromCallback(callback):
                builder.forwardDeclareForType(t, config)

        for d in callbackInterfaces:
            builder.add(d.nativeType)
            builder.add(d.nativeType + "Atoms", isStruct=True)
            for t in getTypesFromDescriptor(d):
                builder.forwardDeclareForType(t, config)
            if d.hasCEReactions():
                builder.addInMozillaDom("DocGroup")

        for d in dictionaries:
            if len(d.members) > 0:
                builder.addInMozillaDom(d.identifier.name + "Atoms", isStruct=True)
            for t in getTypesFromDictionary(d):
                builder.forwardDeclareForType(t, config)

        for className, isStruct in additionalDeclarations:
            builder.add(className, isStruct=isStruct)

        CGWrapper.__init__(self, builder.build())


def dependencySortDictionariesAndUnionsAndCallbacks(types):
    def getDependenciesFromType(type):
        if type.isDictionary():
            return set([type.unroll().inner])
        if type.isSequence():
            return getDependenciesFromType(type.unroll())
        if type.isUnion():
            return set([type.unroll()])
        if type.isRecord():
            return set([type.unroll().inner])
        if type.isCallback():
            return set([type.unroll()])
        return set()

    def getDependencies(unionTypeOrDictionaryOrCallback):
        if isinstance(unionTypeOrDictionaryOrCallback, IDLDictionary):
            deps = set()
            if unionTypeOrDictionaryOrCallback.parent:
                deps.add(unionTypeOrDictionaryOrCallback.parent)
            for member in unionTypeOrDictionaryOrCallback.members:
                deps |= getDependenciesFromType(member.type)
            return deps

        if (
            unionTypeOrDictionaryOrCallback.isType()
            and unionTypeOrDictionaryOrCallback.isUnion()
        ):
            deps = set()
            for member in unionTypeOrDictionaryOrCallback.flatMemberTypes:
                deps |= getDependenciesFromType(member)
            return deps

        assert unionTypeOrDictionaryOrCallback.isCallback()
        return set()

    def getName(unionTypeOrDictionaryOrCallback):
        if isinstance(unionTypeOrDictionaryOrCallback, IDLDictionary):
            return unionTypeOrDictionaryOrCallback.identifier.name

        if (
            unionTypeOrDictionaryOrCallback.isType()
            and unionTypeOrDictionaryOrCallback.isUnion()
        ):
            return unionTypeOrDictionaryOrCallback.name

        assert unionTypeOrDictionaryOrCallback.isCallback()
        return unionTypeOrDictionaryOrCallback.identifier.name

    return dependencySortObjects(types, getDependencies, getName)


class CGBindingRoot(CGThing):
    """
    Root codegen class for binding generation. Instantiate the class, and call
    declare or define to generate header or cpp code (respectively).
    """

    def __init__(self, config, prefix, webIDLFile):
        bindingHeaders = dict.fromkeys(
            ("mozilla/dom/NonRefcountedDOMObject.h", "MainThreadUtils.h"), True
        )
        bindingDeclareHeaders = dict.fromkeys(
            (
                "mozilla/dom/BindingDeclarations.h",
                "mozilla/dom/Nullable.h",
            ),
            True,
        )

        descriptors = config.getDescriptors(
            webIDLFile=webIDLFile, hasInterfaceOrInterfacePrototypeObject=True
        )

        unionTypes = UnionsForFile(config, webIDLFile)

        (
            unionHeaders,
            unionImplheaders,
            unionDeclarations,
            traverseMethods,
            unlinkMethods,
            unionStructs,
        ) = UnionTypes(unionTypes, config)

        bindingDeclareHeaders.update(dict.fromkeys(unionHeaders, True))
        bindingHeaders.update(dict.fromkeys(unionImplheaders, True))
        bindingDeclareHeaders["mozilla/dom/UnionMember.h"] = len(unionStructs) > 0
        bindingDeclareHeaders["mozilla/dom/FakeString.h"] = len(unionStructs) > 0
        # BindingUtils.h is only needed for SetToObject.
        # If it stops being inlined or stops calling CallerSubsumes
        # both this bit and the bit in UnionTypes can be removed.
        bindingDeclareHeaders["mozilla/dom/BindingUtils.h"] = any(
            d.isObject() for t in unionTypes for d in t.flatMemberTypes
        )
        bindingHeaders["mozilla/dom/IterableIterator.h"] = any(
            (
                d.interface.isIteratorInterface()
                and d.interface.maplikeOrSetlikeOrIterable.isPairIterator()
            )
            or d.interface.isAsyncIteratorInterface()
            or d.interface.isIterable()
            or d.interface.isAsyncIterable()
            for d in descriptors
        )

        def memberNeedsSubjectPrincipal(d, m):
            if m.isAttr():
                return (
                    "needsSubjectPrincipal" in d.getExtendedAttributes(m, getter=True)
                ) or (
                    not m.readonly
                    and "needsSubjectPrincipal"
                    in d.getExtendedAttributes(m, setter=True)
                )
            return m.isMethod() and "needsSubjectPrincipal" in d.getExtendedAttributes(
                m
            )

        if any(
            memberNeedsSubjectPrincipal(d, m)
            for d in descriptors
            for m in d.interface.members
        ):
            bindingHeaders["mozilla/BasePrincipal.h"] = True
            bindingHeaders["nsJSPrincipals.h"] = True

        # The conditions for which we generate profiler labels are fairly
        # complicated. The check below is a little imprecise to make it simple.
        # It includes the profiler header in all cases where it is necessary and
        # generates only a few false positives.
        bindingHeaders["mozilla/ProfilerLabels.h"] = any(
            # constructor profiler label
            d.interface.legacyFactoryFunctions
            or (d.interface.hasInterfaceObject() and d.interface.ctor())
            or any(
                # getter/setter profiler labels
                m.isAttr()
                # method profiler label
                or m.isMethod()
                for m in d.interface.members
            )
            for d in descriptors
        )

        def descriptorHasCrossOriginProperties(desc):
            def hasCrossOriginProperty(m):
                props = memberProperties(m, desc)
                return (
                    props.isCrossOriginMethod
                    or props.isCrossOriginGetter
                    or props.isCrossOriginSetter
                )

            return any(hasCrossOriginProperty(m) for m in desc.interface.members)

        def descriptorHasObservableArrayTypes(desc):
            def hasObservableArrayTypes(m):
                return m.isAttr() and m.type.isObservableArray()

            return any(hasObservableArrayTypes(m) for m in desc.interface.members)

        bindingDeclareHeaders["mozilla/dom/RemoteObjectProxy.h"] = any(
            descriptorHasCrossOriginProperties(d) for d in descriptors
        )
        bindingDeclareHeaders["jsapi.h"] = any(
            descriptorHasCrossOriginProperties(d)
            or descriptorHasObservableArrayTypes(d)
            for d in descriptors
        )
        bindingDeclareHeaders["js/TypeDecls.h"] = not bindingDeclareHeaders["jsapi.h"]
        bindingDeclareHeaders["js/RootingAPI.h"] = not bindingDeclareHeaders["jsapi.h"]

        # JS::IsCallable
        bindingDeclareHeaders["js/CallAndConstruct.h"] = True

        def descriptorHasIteratorAlias(desc):
            def hasIteratorAlias(m):
                return m.isMethod() and (
                    ("@@iterator" in m.aliases) or ("@@asyncIterator" in m.aliases)
                )

            return any(hasIteratorAlias(m) for m in desc.interface.members)

        bindingHeaders["js/Symbol.h"] = any(
            descriptorHasIteratorAlias(d) for d in descriptors
        )

        bindingHeaders["js/shadow/Object.h"] = any(
            d.interface.hasMembersInSlots() for d in descriptors
        )

        # The symbols supplied by this header are used so ubiquitously it's not
        # worth the effort delineating the exact dependency, if it can't be done
        # *at* the places where their definitions are required.
        bindingHeaders["js/experimental/JitInfo.h"] = True

        # JS::GetClass, JS::GetCompartment, JS::GetReservedSlot, and
        # JS::SetReservedSlot are also used too many places to restate
        # dependency logic.
        bindingHeaders["js/Object.h"] = True

        # JS::IsCallable, JS::Call, JS::Construct
        bindingHeaders["js/CallAndConstruct.h"] = True

        # JS_IsExceptionPending
        bindingHeaders["js/Exception.h"] = True

        # JS::Map{Clear, Delete, Has, Get, Set}
        bindingHeaders["js/MapAndSet.h"] = True

        # JS_DefineElement, JS_DefineProperty, JS_DefinePropertyById,
        # JS_DefineUCProperty, JS_ForwardGetPropertyTo, JS_GetProperty,
        # JS_GetPropertyById, JS_HasPropertyById, JS_SetProperty,
        # JS_SetPropertyById
        bindingHeaders["js/PropertyAndElement.h"] = True

        # JS_GetOwnPropertyDescriptorById
        bindingHeaders["js/PropertyDescriptor.h"] = True

        def descriptorDeprecated(desc):
            iface = desc.interface
            return any(
                m.getExtendedAttribute("Deprecated") for m in iface.members + [iface]
            )

        bindingHeaders["mozilla/dom/Document.h"] = any(
            descriptorDeprecated(d) for d in descriptors
        )

        bindingHeaders["mozilla/dom/DOMJSProxyHandler.h"] = any(
            d.concrete and d.proxy for d in descriptors
        )

        bindingHeaders["mozilla/dom/ProxyHandlerUtils.h"] = any(
            d.concrete and d.proxy for d in descriptors
        )

        bindingHeaders["js/String.h"] = any(
            d.needsMissingPropUseCounters for d in descriptors
        )

        hasCrossOriginObjects = any(
            d.concrete and d.isMaybeCrossOriginObject() for d in descriptors
        )
        bindingHeaders["mozilla/dom/MaybeCrossOriginObject.h"] = hasCrossOriginObjects
        bindingHeaders["AccessCheck.h"] = hasCrossOriginObjects
        hasCEReactions = any(d.hasCEReactions() for d in descriptors)
        bindingHeaders["mozilla/dom/CustomElementRegistry.h"] = hasCEReactions
        bindingHeaders["mozilla/dom/DocGroup.h"] = hasCEReactions

        def descriptorHasChromeOnly(desc):
            ctor = desc.interface.ctor()

            return (
                any(
                    isChromeOnly(a) or needsContainsHack(a) or needsCallerType(a)
                    for a in desc.interface.members
                )
                or desc.interface.getExtendedAttribute("ChromeOnly") is not None
                or
                # JS-implemented interfaces with an interface object get a
                # chromeonly _create method.  And interfaces with an
                # interface object might have a ChromeOnly constructor.
                (
                    desc.interface.hasInterfaceObject()
                    and (
                        desc.interface.isJSImplemented()
                        or (ctor and isChromeOnly(ctor))
                    )
                )
            )

        # XXXkhuey ugly hack but this is going away soon.
        bindingHeaders["xpcprivate.h"] = webIDLFile.endswith("EventTarget.webidl")

        hasThreadChecks = any(d.hasThreadChecks() for d in descriptors)
        bindingHeaders["nsThreadUtils.h"] = hasThreadChecks

        dictionaries = config.getDictionaries(webIDLFile)

        def dictionaryHasChromeOnly(dictionary):
            while dictionary:
                if any(isChromeOnly(m) for m in dictionary.members):
                    return True
                dictionary = dictionary.parent
            return False

        def needsNonSystemPrincipal(member):
            return (
                member.getExtendedAttribute("NeedsSubjectPrincipal") == ["NonSystem"]
                or member.getExtendedAttribute("SetterNeedsSubjectPrincipal")
                == ["NonSystem"]
                or member.getExtendedAttribute("GetterNeedsSubjectPrincipal")
                == ["NonSystem"]
            )

        def descriptorNeedsNonSystemPrincipal(d):
            return any(needsNonSystemPrincipal(m) for m in d.interface.members)

        def descriptorHasPrefDisabler(desc):
            iface = desc.interface
            return any(
                PropertyDefiner.getControllingCondition(m, desc).hasDisablers()
                for m in iface.members
                if (m.isMethod() or m.isAttr() or m.isConst())
            )

        def addPrefHeaderForObject(bindingHeaders, obj):
            """
            obj might be a dictionary member or an interface.
            """
            if obj is not None:
                pref = PropertyDefiner.getStringAttr(obj, "Pref")
                if pref:
                    bindingHeaders[prefHeader(pref)] = True

        def addPrefHeadersForDictionary(bindingHeaders, dictionary):
            while dictionary:
                for m in dictionary.members:
                    addPrefHeaderForObject(bindingHeaders, m)
                dictionary = dictionary.parent

        for d in dictionaries:
            addPrefHeadersForDictionary(bindingHeaders, d)
        for d in descriptors:
            interface = d.interface
            addPrefHeaderForObject(bindingHeaders, interface)
            addPrefHeaderForObject(bindingHeaders, interface.ctor())

        bindingHeaders["mozilla/dom/WebIDLPrefs.h"] = any(
            descriptorHasPrefDisabler(d) for d in descriptors
        )
        bindingHeaders["nsContentUtils.h"] = (
            any(descriptorHasChromeOnly(d) for d in descriptors)
            or any(descriptorNeedsNonSystemPrincipal(d) for d in descriptors)
            or any(dictionaryHasChromeOnly(d) for d in dictionaries)
        )
        hasNonEmptyDictionaries = any(len(dict.members) > 0 for dict in dictionaries)
        callbacks = config.getCallbacks(webIDLFile)
        callbackDescriptors = config.getDescriptors(
            webIDLFile=webIDLFile, isCallback=True
        )
        jsImplemented = config.getDescriptors(
            webIDLFile=webIDLFile, isJSImplemented=True
        )
        bindingDeclareHeaders["nsWeakReference.h"] = jsImplemented
        bindingDeclareHeaders["mozilla/dom/PrototypeList.h"] = descriptors
        bindingHeaders["nsIGlobalObject.h"] = jsImplemented
        bindingHeaders["AtomList.h"] = (
            hasNonEmptyDictionaries or jsImplemented or callbackDescriptors
        )

        if callbackDescriptors:
            bindingDeclareHeaders["mozilla/ErrorResult.h"] = True

        def descriptorClearsPropsInSlots(descriptor):
            if not descriptor.wrapperCache:
                return False
            return any(
                m.isAttr() and m.getExtendedAttribute("StoreInSlot")
                for m in descriptor.interface.members
            )

        bindingHeaders["nsJSUtils.h"] = any(
            descriptorClearsPropsInSlots(d) for d in descriptors
        )

        # Make sure we can sanely use binding_detail in generated code.
        cgthings = [
            CGGeneric(
                dedent(
                    """
            namespace binding_detail {}; // Just to make sure it's known as a namespace
            using namespace mozilla::dom::binding_detail;
            """
                )
            )
        ]

        # Do codegen for all the enums
        enums = config.getEnums(webIDLFile)
        cgthings.extend(CGEnum(e) for e in enums)

        bindingDeclareHeaders["mozilla/Span.h"] = enums
        bindingDeclareHeaders["mozilla/ArrayUtils.h"] = enums

        hasCode = descriptors or callbackDescriptors or dictionaries or callbacks
        bindingHeaders["mozilla/dom/BindingUtils.h"] = hasCode
        bindingHeaders["mozilla/OwningNonNull.h"] = hasCode
        bindingHeaders["<type_traits>"] = hasCode
        bindingHeaders["mozilla/dom/BindingDeclarations.h"] = not hasCode and enums

        bindingHeaders["WrapperFactory.h"] = descriptors
        bindingHeaders["mozilla/dom/DOMJSClass.h"] = descriptors
        bindingHeaders["mozilla/dom/ScriptSettings.h"] = dictionaries  # AutoJSAPI
        # Ensure we see our enums in the generated .cpp file, for the ToJSValue
        # method body.  Also ensure that we see jsapi.h.
        if enums:
            bindingHeaders[CGHeaders.getDeclarationFilename(enums[0])] = True
            bindingHeaders["jsapi.h"] = True

        # For things that have [UseCounter] or [InstrumentedProps] or [Trial]
        for d in descriptors:
            if d.concrete:
                if d.instrumentedProps:
                    bindingHeaders["mozilla/UseCounter.h"] = True
                if d.needsMissingPropUseCounters:
                    bindingHeaders[prefHeader(MISSING_PROP_PREF)] = True
            if d.interface.isSerializable():
                bindingHeaders["mozilla/dom/StructuredCloneTags.h"] = True
            if d.wantsXrays:
                bindingHeaders["mozilla/Atomics.h"] = True
                bindingHeaders["mozilla/dom/XrayExpandoClass.h"] = True
                if d.wantsXrayExpandoClass:
                    bindingHeaders["XrayWrapper.h"] = True
            for m in d.interface.members:
                if m.getExtendedAttribute("UseCounter"):
                    bindingHeaders["mozilla/UseCounter.h"] = True
                if m.getExtendedAttribute("Trial"):
                    bindingHeaders["mozilla/OriginTrials.h"] = True

        bindingHeaders["mozilla/dom/SimpleGlobalObject.h"] = any(
            CGDictionary.dictionarySafeToJSONify(d) for d in dictionaries
        )

        for ancestor in (findAncestorWithInstrumentedProps(d) for d in descriptors):
            if not ancestor:
                continue
            bindingHeaders[CGHeaders.getDeclarationFilename(ancestor)] = True

        cgthings.extend(traverseMethods)
        cgthings.extend(unlinkMethods)

        # Do codegen for all the dictionaries.  We have to be a bit careful
        # here, because we have to generate these in order from least derived
        # to most derived so that class inheritance works out.  We also have to
        # generate members before the dictionary that contains them.

        for t in dependencySortDictionariesAndUnionsAndCallbacks(
            dictionaries + unionStructs + callbacks
        ):
            if t.isDictionary():
                cgthings.append(CGDictionary(t, config))
            elif t.isUnion():
                cgthings.append(CGUnionStruct(t, config))
                cgthings.append(CGUnionStruct(t, config, True))
            else:
                assert t.isCallback()
                cgthings.append(CGCallbackFunction(t, config))
                cgthings.append(CGNamespace("binding_detail", CGFastCallback(t)))

        # Do codegen for all the descriptors
        cgthings.extend([CGDescriptor(x) for x in descriptors])

        # Do codegen for all the callback interfaces.
        cgthings.extend([CGCallbackInterface(x) for x in callbackDescriptors])

        cgthings.extend(
            [
                CGNamespace("binding_detail", CGFastCallback(x.interface))
                for x in callbackDescriptors
            ]
        )

        # Do codegen for JS implemented classes
        def getParentDescriptor(desc):
            if not desc.interface.parent:
                return set()
            return {desc.getDescriptor(desc.interface.parent.identifier.name)}

        for x in dependencySortObjects(
            jsImplemented, getParentDescriptor, lambda d: d.interface.identifier.name
        ):
            cgthings.append(
                CGCallbackInterface(x, spiderMonkeyInterfacesAreStructs=True)
            )
            cgthings.append(CGJSImplClass(x))

        # And make sure we have the right number of newlines at the end
        curr = CGWrapper(CGList(cgthings, "\n\n"), post="\n\n")

        # Wrap all of that in our namespaces.
        curr = CGNamespace.build(["mozilla", "dom"], CGWrapper(curr, pre="\n"))

        curr = CGList(
            [
                CGForwardDeclarations(
                    config,
                    descriptors,
                    callbacks,
                    dictionaries,
                    callbackDescriptors + jsImplemented,
                    additionalDeclarations=unionDeclarations,
                ),
                curr,
            ],
            "\n",
        )

        # Add header includes.
        bindingHeaders = [
            header for header, include in six.iteritems(bindingHeaders) if include
        ]
        bindingDeclareHeaders = [
            header
            for header, include in six.iteritems(bindingDeclareHeaders)
            if include
        ]

        curr = CGHeaders(
            descriptors,
            dictionaries,
            callbacks,
            callbackDescriptors,
            bindingDeclareHeaders,
            bindingHeaders,
            prefix,
            curr,
            config,
            jsImplemented,
        )

        # Add include guards.
        curr = CGIncludeGuard(prefix, curr)

        # Add the auto-generated comment.
        curr = CGWrapper(
            curr,
            pre=(
                AUTOGENERATED_WITH_SOURCE_WARNING_COMMENT % os.path.basename(webIDLFile)
            ),
        )

        # Store the final result.
        self.root = curr

    def declare(self):
        return stripTrailingWhitespace(self.root.declare())

    def define(self):
        return stripTrailingWhitespace(self.root.define())

    def deps(self):
        return self.root.deps()


class CGNativeMember(ClassMethod):
    def __init__(
        self,
        descriptorProvider,
        member,
        name,
        signature,
        extendedAttrs,
        breakAfter=True,
        passJSBitsAsNeeded=True,
        visibility="public",
        spiderMonkeyInterfacesAreStructs=True,
        variadicIsSequence=False,
        resultNotAddRefed=False,
        virtual=False,
        override=False,
        canRunScript=False,
    ):
        """
        If spiderMonkeyInterfacesAreStructs is false, SpiderMonkey interfaces
        will be passed as JS::Handle<JSObject*>.  If it's true they will be
        passed as one of the dom::SpiderMonkeyInterfaceObjectStorage subclasses.

        If passJSBitsAsNeeded is false, we don't automatically pass in a
        JSContext* or a JSObject* based on the return and argument types.  We
        can still pass it based on 'implicitJSContext' annotations.
        """
        self.descriptorProvider = descriptorProvider
        self.member = member
        self.extendedAttrs = extendedAttrs
        self.resultAlreadyAddRefed = not resultNotAddRefed
        self.passJSBitsAsNeeded = passJSBitsAsNeeded
        self.spiderMonkeyInterfacesAreStructs = spiderMonkeyInterfacesAreStructs
        self.variadicIsSequence = variadicIsSequence
        breakAfterSelf = "\n" if breakAfter else ""
        ClassMethod.__init__(
            self,
            name,
            self.getReturnType(signature[0], False),
            self.getArgs(signature[0], signature[1]),
            static=member.isStatic(),
            # Mark our getters, which are attrs that
            # have a non-void return type, as const.
            const=(
                not member.isStatic()
                and member.isAttr()
                and not signature[0].isUndefined()
            ),
            breakAfterReturnDecl=" ",
            breakAfterSelf=breakAfterSelf,
            visibility=visibility,
            virtual=virtual,
            override=override,
            canRunScript=canRunScript,
        )

    def getReturnType(self, type, isMember):
        return self.getRetvalInfo(type, isMember)[0]

    def getRetvalInfo(self, type, isMember):
        """
        Returns a tuple:

        The first element is the type declaration for the retval

        The second element is a default value that can be used on error returns.
        For cases whose behavior depends on isMember, the second element will be
        None if isMember is true.

        The third element is a template for actually returning a value stored in
        "${declName}" and "${holderName}".  This means actually returning it if
        we're not outparam, else assigning to the "retval" outparam.  If
        isMember is true, this can be None, since in that case the caller will
        never examine this value.
        """
        if type.isUndefined():
            return "void", "", ""
        if type.isPrimitive() and type.tag() in builtinNames:
            result = CGGeneric(builtinNames[type.tag()])
            defaultReturnArg = "0"
            if type.nullable():
                result = CGTemplatedType("Nullable", result)
                defaultReturnArg = ""
            return (
                result.define(),
                "%s(%s)" % (result.define(), defaultReturnArg),
                "return ${declName};\n",
            )
        if type.isJSString():
            if isMember:
                raise TypeError("JSString not supported as return type member")
            # Outparam
            return "void", "", "aRetVal.set(${declName});\n"
        if type.isDOMString() or type.isUSVString():
            if isMember:
                # No need for a third element in the isMember case
                return "nsString", None, None
            # Outparam
            return "void", "", "aRetVal = ${declName};\n"
        if type.isByteString() or type.isUTF8String():
            if isMember:
                # No need for a third element in the isMember case
                return "nsCString", None, None
            # Outparam
            return "void", "", "aRetVal = ${declName};\n"
        if type.isEnum():
            enumName = type.unroll().inner.identifier.name
            if type.nullable():
                enumName = CGTemplatedType("Nullable", CGGeneric(enumName)).define()
                defaultValue = "%s()" % enumName
            else:
                defaultValue = "%s(0)" % enumName
            return enumName, defaultValue, "return ${declName};\n"
        if type.isGeckoInterface() or type.isPromise():
            if type.isGeckoInterface():
                iface = type.unroll().inner
                result = CGGeneric(
                    self.descriptorProvider.getDescriptor(
                        iface.identifier.name
                    ).prettyNativeType
                )
            else:
                result = CGGeneric("Promise")
            if self.resultAlreadyAddRefed:
                if isMember:
                    holder = "RefPtr"
                else:
                    holder = "already_AddRefed"
                if memberReturnsNewObject(self.member) or isMember:
                    warning = ""
                else:
                    warning = "// Return a raw pointer here to avoid refcounting, but make sure it's safe (the object should be kept alive by the callee).\n"
                result = CGWrapper(result, pre=("%s%s<" % (warning, holder)), post=">")
            else:
                result = CGWrapper(result, post="*")
            # Since we always force an owning type for callback return values,
            # our ${declName} is an OwningNonNull or RefPtr.  So we can just
            # .forget() to get our already_AddRefed.
            return result.define(), "nullptr", "return ${declName}.forget();\n"
        if type.isCallback():
            return (
                "already_AddRefed<%s>" % type.unroll().callback.identifier.name,
                "nullptr",
                "return ${declName}.forget();\n",
            )
        if type.isAny():
            if isMember:
                # No need for a third element in the isMember case
                return "JS::Value", None, None
            # Outparam
            return "void", "", "aRetVal.set(${declName});\n"

        if type.isObject():
            if isMember:
                # No need for a third element in the isMember case
                return "JSObject*", None, None
            return "void", "", "aRetVal.set(${declName});\n"
        if type.isSpiderMonkeyInterface():
            if isMember:
                # No need for a third element in the isMember case
                return "JSObject*", None, None
            if type.nullable():
                returnCode = (
                    "${declName}.IsNull() ? nullptr : ${declName}.Value().Obj()"
                )
            else:
                returnCode = "${declName}.Obj()"
            return "void", "", "aRetVal.set(%s);\n" % returnCode
        if type.isSequence():
            # If we want to handle sequence-of-sequences return values, we're
            # going to need to fix example codegen to not produce nsTArray<void>
            # for the relevant argument...
            assert not isMember
            # Outparam.
            if type.nullable():
                returnCode = dedent(
                    """
                    if (${declName}.IsNull()) {
                      aRetVal.SetNull();
                    } else {
                      aRetVal.SetValue() = std::move(${declName}.Value());
                    }
                    """
                )
            else:
                returnCode = "aRetVal = std::move(${declName});\n"
            return "void", "", returnCode
        if type.isRecord():
            # If we want to handle record-of-record return values, we're
            # going to need to fix example codegen to not produce record<void>
            # for the relevant argument...
            assert not isMember
            # In this case we convert directly into our outparam to start with
            return "void", "", ""
        if type.isDictionary():
            if isMember:
                # Only the first member of the tuple matters here, but return
                # bogus values for the others in case someone decides to use
                # them.
                return CGDictionary.makeDictionaryName(type.inner), None, None
            # In this case we convert directly into our outparam to start with
            return "void", "", ""
        if type.isUnion():
            if isMember:
                # Only the first member of the tuple matters here, but return
                # bogus values for the others in case someone decides to use
                # them.
                return CGUnionStruct.unionTypeDecl(type, True), None, None
            # In this case we convert directly into our outparam to start with
            return "void", "", ""

        raise TypeError("Don't know how to declare return value for %s" % type)

    def getArgs(self, returnType, argList):
        args = [self.getArg(arg) for arg in argList]
        # Now the outparams
        if returnType.isJSString():
            args.append(Argument("JS::MutableHandle<JSString*>", "aRetVal"))
        elif returnType.isDOMString() or returnType.isUSVString():
            args.append(Argument("nsString&", "aRetVal"))
        elif returnType.isByteString() or returnType.isUTF8String():
            args.append(Argument("nsCString&", "aRetVal"))
        elif returnType.isSequence():
            nullable = returnType.nullable()
            if nullable:
                returnType = returnType.inner
            # And now the actual underlying type
            elementDecl = self.getReturnType(returnType.inner, True)
            type = CGTemplatedType("nsTArray", CGGeneric(elementDecl))
            if nullable:
                type = CGTemplatedType("Nullable", type)
            args.append(Argument("%s&" % type.define(), "aRetVal"))
        elif returnType.isRecord():
            nullable = returnType.nullable()
            if nullable:
                returnType = returnType.inner
            # And now the actual underlying type
            elementDecl = self.getReturnType(returnType.inner, True)
            type = CGTemplatedType(
                "Record", [recordKeyDeclType(returnType), CGGeneric(elementDecl)]
            )
            if nullable:
                type = CGTemplatedType("Nullable", type)
            args.append(Argument("%s&" % type.define(), "aRetVal"))
        elif returnType.isDictionary():
            nullable = returnType.nullable()
            if nullable:
                returnType = returnType.inner
            dictType = CGGeneric(CGDictionary.makeDictionaryName(returnType.inner))
            if nullable:
                dictType = CGTemplatedType("Nullable", dictType)
            args.append(Argument("%s&" % dictType.define(), "aRetVal"))
        elif returnType.isUnion():
            args.append(
                Argument(
                    "%s&" % CGUnionStruct.unionTypeDecl(returnType, True), "aRetVal"
                )
            )
        elif returnType.isAny():
            args.append(Argument("JS::MutableHandle<JS::Value>", "aRetVal"))
        elif returnType.isObject() or returnType.isSpiderMonkeyInterface():
            args.append(Argument("JS::MutableHandle<JSObject*>", "aRetVal"))

        # And the nsIPrincipal
        if "needsSubjectPrincipal" in self.extendedAttrs:
            # Cheat and assume self.descriptorProvider is a descriptor
            if self.descriptorProvider.interface.isExposedInAnyWorker():
                args.append(Argument("Maybe<nsIPrincipal*>", "aSubjectPrincipal"))
            elif "needsNonSystemSubjectPrincipal" in self.extendedAttrs:
                args.append(Argument("nsIPrincipal*", "aPrincipal"))
            else:
                args.append(Argument("nsIPrincipal&", "aPrincipal"))
        # And the caller type, if desired.
        if needsCallerType(self.member):
            args.append(Argument("CallerType", "aCallerType"))
        # And the ErrorResult or OOMReporter
        if "needsErrorResult" in self.extendedAttrs:
            # Use aRv so it won't conflict with local vars named "rv"
            args.append(Argument("ErrorResult&", "aRv"))
        elif "canOOM" in self.extendedAttrs:
            args.append(Argument("OOMReporter&", "aRv"))

        # The legacycaller thisval
        if self.member.isMethod() and self.member.isLegacycaller():
            # If it has an identifier, we can't deal with it yet
            assert self.member.isIdentifierLess()
            args.insert(0, Argument("const JS::Value&", "aThisVal"))
        # And jscontext bits.
        if needCx(
            returnType,
            argList,
            self.extendedAttrs,
            self.passJSBitsAsNeeded,
            self.member.isStatic(),
        ):
            args.insert(0, Argument("JSContext*", "cx"))
            if needScopeObject(
                returnType,
                argList,
                self.extendedAttrs,
                self.descriptorProvider.wrapperCache,
                self.passJSBitsAsNeeded,
                self.member.getExtendedAttribute("StoreInSlot"),
            ):
                args.insert(1, Argument("JS::Handle<JSObject*>", "obj"))
        # And if we're static, a global
        if self.member.isStatic():
            args.insert(0, Argument("const GlobalObject&", "global"))
        return args

    def doGetArgType(self, type, optional, isMember):
        """
        The main work of getArgType.  Returns a string type decl, whether this
        is a const ref, as well as whether the type should be wrapped in
        Nullable as needed.

        isMember can be false or one of the strings "Sequence", "Variadic",
                 "Record"
        """
        if type.isSequence():
            nullable = type.nullable()
            if nullable:
                type = type.inner
            elementType = type.inner
            argType = self.getArgType(elementType, False, "Sequence")[0]
            decl = CGTemplatedType("Sequence", argType)
            return decl.define(), True, True

        if type.isRecord():
            nullable = type.nullable()
            if nullable:
                type = type.inner
            elementType = type.inner
            argType = self.getArgType(elementType, False, "Record")[0]
            decl = CGTemplatedType("Record", [recordKeyDeclType(type), argType])
            return decl.define(), True, True

        if type.isUnion():
            # unionTypeDecl will handle nullable types, so return False for
            # auto-wrapping in Nullable
            return CGUnionStruct.unionTypeDecl(type, isMember), True, False

        if type.isPromise():
            assert not type.nullable()
            if optional or isMember:
                typeDecl = "OwningNonNull<Promise>"
            else:
                typeDecl = "Promise&"
            return (typeDecl, False, False)

        if type.isGeckoInterface() and not type.isCallbackInterface():
            iface = type.unroll().inner
            if iface.identifier.name == "WindowProxy":
                return "WindowProxyHolder", True, False

            argIsPointer = type.nullable() or iface.isExternal()
            forceOwningType = iface.isCallback() or isMember
            if argIsPointer:
                if (optional or isMember) and forceOwningType:
                    typeDecl = "RefPtr<%s>"
                else:
                    typeDecl = "%s*"
            else:
                if optional or isMember:
                    if forceOwningType:
                        typeDecl = "OwningNonNull<%s>"
                    else:
                        typeDecl = "NonNull<%s>"
                else:
                    typeDecl = "%s&"
            return (
                (
                    typeDecl
                    % self.descriptorProvider.getDescriptor(
                        iface.identifier.name
                    ).prettyNativeType
                ),
                False,
                False,
            )

        if type.isSpiderMonkeyInterface():
            if not self.spiderMonkeyInterfacesAreStructs:
                return "JS::Handle<JSObject*>", False, False

            # Unroll for the name, in case we're nullable.
            return type.unroll().name, True, True

        if type.isJSString():
            if isMember:
                raise TypeError("JSString not supported as member")
            return "JS::Handle<JSString*>", False, False

        if type.isDOMString() or type.isUSVString():
            if isMember:
                declType = "nsString"
            else:
                declType = "nsAString"
            return declType, True, False

        if type.isByteString() or type.isUTF8String():
            # TODO(emilio): Maybe bytestrings could benefit from nsAutoCString
            # or such too.
            if type.isUTF8String() and not isMember:
                declType = "nsACString"
            else:
                declType = "nsCString"
            return declType, True, False

        if type.isEnum():
            return type.unroll().inner.identifier.name, False, True

        if type.isCallback() or type.isCallbackInterface():
            forceOwningType = optional or isMember
            if type.nullable():
                if forceOwningType:
                    declType = "RefPtr<%s>"
                else:
                    declType = "%s*"
            else:
                if forceOwningType:
                    declType = "OwningNonNull<%s>"
                else:
                    declType = "%s&"
            if type.isCallback():
                name = type.unroll().callback.identifier.name
            else:
                name = type.unroll().inner.identifier.name
            return declType % name, False, False

        if type.isAny():
            # Don't do the rooting stuff for variadics for now
            if isMember:
                declType = "JS::Value"
            else:
                declType = "JS::Handle<JS::Value>"
            return declType, False, False

        if type.isObject():
            if isMember:
                declType = "JSObject*"
            else:
                declType = "JS::Handle<JSObject*>"
            return declType, False, False

        if type.isDictionary():
            typeName = CGDictionary.makeDictionaryName(type.inner)
            return typeName, True, True

        assert type.isPrimitive()

        return builtinNames[type.tag()], False, True

    def getArgType(self, type, optional, isMember):
        """
        Get the type of an argument declaration.  Returns the type CGThing, and
        whether this should be a const ref.

        isMember can be False, "Sequence", or "Variadic"
        """
        decl, ref, handleNullable = self.doGetArgType(type, optional, isMember)
        decl = CGGeneric(decl)
        if handleNullable and type.nullable():
            decl = CGTemplatedType("Nullable", decl)
            ref = True
        if isMember == "Variadic":
            arrayType = "Sequence" if self.variadicIsSequence else "nsTArray"
            decl = CGTemplatedType(arrayType, decl)
            ref = True
        elif optional:
            # Note: All variadic args claim to be optional, but we can just use
            # empty arrays to represent them not being present.
            decl = CGTemplatedType("Optional", decl)
            ref = True
        return (decl, ref)

    def getArg(self, arg):
        """
        Get the full argument declaration for an argument
        """
        decl, ref = self.getArgType(
            arg.type, arg.canHaveMissingValue(), "Variadic" if arg.variadic else False
        )
        if ref:
            decl = CGWrapper(decl, pre="const ", post="&")

        return Argument(decl.define(), arg.identifier.name)

    def arguments(self):
        return self.member.signatures()[0][1]


class CGExampleMethod(CGNativeMember):
    def __init__(self, descriptor, method, signature, isConstructor, breakAfter=True):
        CGNativeMember.__init__(
            self,
            descriptor,
            method,
            CGSpecializedMethod.makeNativeName(descriptor, method),
            signature,
            descriptor.getExtendedAttributes(method),
            breakAfter=breakAfter,
            variadicIsSequence=True,
        )

    def declare(self, cgClass):
        assert self.member.isMethod()
        # We skip declaring ourselves if this is a maplike/setlike/iterable
        # method, because those get implemented automatically by the binding
        # machinery, so the implementor of the interface doesn't have to worry
        # about it.
        if self.member.isMaplikeOrSetlikeOrIterableMethod():
            return ""
        return CGNativeMember.declare(self, cgClass)

    def define(self, cgClass):
        return ""


class CGExampleGetter(CGNativeMember):
    def __init__(self, descriptor, attr):
        CGNativeMember.__init__(
            self,
            descriptor,
            attr,
            CGSpecializedGetter.makeNativeName(descriptor, attr),
            (attr.type, []),
            descriptor.getExtendedAttributes(attr, getter=True),
        )

    def declare(self, cgClass):
        assert self.member.isAttr()
        # We skip declaring ourselves if this is a maplike/setlike attr (in
        # practice, "size"), because those get implemented automatically by the
        # binding machinery, so the implementor of the interface doesn't have to
        # worry about it.
        if self.member.isMaplikeOrSetlikeAttr():
            return ""
        return CGNativeMember.declare(self, cgClass)

    def define(self, cgClass):
        return ""


class CGExampleSetter(CGNativeMember):
    def __init__(self, descriptor, attr):
        CGNativeMember.__init__(
            self,
            descriptor,
            attr,
            CGSpecializedSetter.makeNativeName(descriptor, attr),
            (
                BuiltinTypes[IDLBuiltinType.Types.undefined],
                [FakeArgument(attr.type)],
            ),
            descriptor.getExtendedAttributes(attr, setter=True),
        )

    def define(self, cgClass):
        return ""


class CGBindingImplClass(CGClass):
    """
    Common codegen for generating a C++ implementation of a WebIDL interface
    """

    def __init__(
        self,
        descriptor,
        cgMethod,
        cgGetter,
        cgSetter,
        wantGetParent=True,
        wrapMethodName="WrapObject",
        skipStaticMethods=False,
    ):
        """
        cgMethod, cgGetter and cgSetter are classes used to codegen methods,
        getters and setters.
        """
        self.descriptor = descriptor
        self._deps = descriptor.interface.getDeps()

        iface = descriptor.interface

        self.methodDecls = []

        def appendMethod(m, isConstructor=False):
            sigs = m.signatures()
            for s in sigs[:-1]:
                # Don't put a blank line after overloads, until we
                # get to the last one.
                self.methodDecls.append(
                    cgMethod(descriptor, m, s, isConstructor, breakAfter=False)
                )
            self.methodDecls.append(cgMethod(descriptor, m, sigs[-1], isConstructor))

        if iface.ctor():
            appendMethod(iface.ctor(), isConstructor=True)
        for n in iface.legacyFactoryFunctions:
            appendMethod(n, isConstructor=True)
        for m in iface.members:
            if m.isMethod():
                if m.isIdentifierLess():
                    continue
                if m.isMaplikeOrSetlikeOrIterableMethod():
                    # Handled by generated code already
                    continue
                if not m.isStatic() or not skipStaticMethods:
                    appendMethod(m)
            elif m.isAttr():
                if m.isMaplikeOrSetlikeAttr() or m.type.isObservableArray():
                    # Handled by generated code already
                    continue
                self.methodDecls.append(cgGetter(descriptor, m))
                if not m.readonly:
                    self.methodDecls.append(cgSetter(descriptor, m))

        # Now do the special operations
        def appendSpecialOperation(name, op):
            if op is None:
                return
            assert len(op.signatures()) == 1
            returnType, args = op.signatures()[0]
            # Make a copy of the args, since we plan to modify them.
            args = list(args)
            if op.isGetter() or op.isDeleter():
                # This is a total hack.  The '&' belongs with the
                # type, not the name!  But it works, and is simpler
                # than trying to somehow make this pretty.
                args.append(
                    FakeArgument(
                        BuiltinTypes[IDLBuiltinType.Types.boolean], name="&found"
                    )
                )
            if name == "Stringifier":
                if op.isIdentifierLess():
                    # XXXbz I wish we were consistent about our renaming here.
                    name = "Stringify"
                else:
                    # We already added this method
                    return
            if name == "LegacyCaller":
                if op.isIdentifierLess():
                    # XXXbz I wish we were consistent about our renaming here.
                    name = "LegacyCall"
                else:
                    # We already added this method
                    return
            self.methodDecls.append(
                CGNativeMember(
                    descriptor,
                    op,
                    name,
                    (returnType, args),
                    descriptor.getExtendedAttributes(op),
                )
            )

        # Sort things by name so we get stable ordering in the output.
        ops = sorted(descriptor.operations.items(), key=lambda x: x[0])
        for name, op in ops:
            appendSpecialOperation(name, op)
        # If we support indexed properties, then we need a Length()
        # method so we know which indices are supported.
        if descriptor.supportsIndexedProperties():
            # But we don't need it if we already have an infallible
            # "length" attribute, which we often do.
            haveLengthAttr = any(
                m
                for m in iface.members
                if m.isAttr()
                and CGSpecializedGetter.makeNativeName(descriptor, m) == "Length"
            )
            if not haveLengthAttr:
                self.methodDecls.append(
                    CGNativeMember(
                        descriptor,
                        FakeMember(),
                        "Length",
                        (BuiltinTypes[IDLBuiltinType.Types.unsigned_long], []),
                        [],
                    ),
                )
        # And if we support named properties we need to be able to
        # enumerate the supported names.
        if descriptor.supportsNamedProperties():
            self.methodDecls.append(
                CGNativeMember(
                    descriptor,
                    FakeMember(),
                    "GetSupportedNames",
                    (
                        IDLSequenceType(
                            None, BuiltinTypes[IDLBuiltinType.Types.domstring]
                        ),
                        [],
                    ),
                    [],
                )
            )

        if descriptor.concrete:
            wrapArgs = [
                Argument("JSContext*", "aCx"),
                Argument("JS::Handle<JSObject*>", "aGivenProto"),
            ]
            if not descriptor.wrapperCache:
                wrapReturnType = "bool"
                wrapArgs.append(Argument("JS::MutableHandle<JSObject*>", "aReflector"))
            else:
                wrapReturnType = "JSObject*"
            self.methodDecls.insert(
                0,
                ClassMethod(
                    wrapMethodName,
                    wrapReturnType,
                    wrapArgs,
                    virtual=descriptor.wrapperCache,
                    breakAfterReturnDecl=" ",
                    override=descriptor.wrapperCache,
                    body=self.getWrapObjectBody(),
                ),
            )
        if descriptor.hasCEReactions():
            self.methodDecls.insert(
                0,
                ClassMethod(
                    "GetDocGroup",
                    "DocGroup*",
                    [],
                    const=True,
                    breakAfterReturnDecl=" ",
                    body=self.getGetDocGroupBody(),
                ),
            )
        if wantGetParent:
            self.methodDecls.insert(
                0,
                ClassMethod(
                    "GetParentObject",
                    self.getGetParentObjectReturnType(),
                    [],
                    const=True,
                    breakAfterReturnDecl=" ",
                    body=self.getGetParentObjectBody(),
                ),
            )

        # Invoke  CGClass.__init__ in any subclasses afterwards to do the actual codegen.

    def getWrapObjectBody(self):
        return None

    def getGetParentObjectReturnType(self):
        # The lack of newline before the end of the string is on purpose.
        return dedent(
            """
            // This should return something that eventually allows finding a
            // path to the global this object is associated with.  Most simply,
            // returning an actual global works.
            nsIGlobalObject*"""
        )

    def getGetParentObjectBody(self):
        return None

    def getGetDocGroupBody(self):
        return None

    def deps(self):
        return self._deps


class CGExampleObservableArrayCallback(CGNativeMember):
    def __init__(self, descriptor, attr, callbackName):
        assert attr.isAttr()
        assert attr.type.isObservableArray()
        CGNativeMember.__init__(
            self,
            descriptor,
            attr,
            self.makeNativeName(attr, callbackName),
            (
                BuiltinTypes[IDLBuiltinType.Types.undefined],
                [
                    FakeArgument(attr.type.inner, "aValue"),
                    FakeArgument(
                        BuiltinTypes[IDLBuiltinType.Types.unsigned_long], "aIndex"
                    ),
                ],
            ),
            ["needsErrorResult"],
        )

    def declare(self, cgClass):
        assert self.member.isAttr()
        assert self.member.type.isObservableArray()
        return CGNativeMember.declare(self, cgClass)

    def define(self, cgClass):
        return ""

    @staticmethod
    def makeNativeName(attr, callbackName):
        assert attr.isAttr()
        nativeName = MakeNativeName(attr.identifier.name)
        return "On" + callbackName + nativeName


class CGExampleClass(CGBindingImplClass):
    """
    Codegen for the actual example class implementation for this descriptor
    """

    def __init__(self, descriptor):
        CGBindingImplClass.__init__(
            self,
            descriptor,
            CGExampleMethod,
            CGExampleGetter,
            CGExampleSetter,
            wantGetParent=descriptor.wrapperCache,
        )

        self.parentIface = descriptor.interface.parent
        if self.parentIface:
            self.parentDesc = descriptor.getDescriptor(self.parentIface.identifier.name)
            bases = [ClassBase(self.nativeLeafName(self.parentDesc))]
        else:
            bases = [
                ClassBase(
                    "nsISupports /* or NonRefcountedDOMObject if this is a non-refcounted object */"
                )
            ]
            if descriptor.wrapperCache:
                bases.append(
                    ClassBase(
                        "nsWrapperCache /* Change wrapperCache in the binding configuration if you don't want this */"
                    )
                )

        destructorVisibility = "protected"
        if self.parentIface:
            extradeclarations = (
                "public:\n"
                "  NS_DECL_ISUPPORTS_INHERITED\n"
                "  NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED(%s, %s)\n"
                "\n"
                % (
                    self.nativeLeafName(descriptor),
                    self.nativeLeafName(self.parentDesc),
                )
            )
        else:
            extradeclarations = (
                "public:\n"
                "  NS_DECL_CYCLE_COLLECTING_ISUPPORTS\n"
                "  NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(%s)\n"
                "\n" % self.nativeLeafName(descriptor)
            )

        if descriptor.interface.hasChildInterfaces():
            decorators = ""
        else:
            decorators = "final"

        for m in descriptor.interface.members:
            if m.isAttr() and m.type.isObservableArray():
                self.methodDecls.append(
                    CGExampleObservableArrayCallback(descriptor, m, "Set")
                )
                self.methodDecls.append(
                    CGExampleObservableArrayCallback(descriptor, m, "Delete")
                )

        CGClass.__init__(
            self,
            self.nativeLeafName(descriptor),
            bases=bases,
            constructors=[ClassConstructor([], visibility="public")],
            destructor=ClassDestructor(visibility=destructorVisibility),
            methods=self.methodDecls,
            decorators=decorators,
            extradeclarations=extradeclarations,
        )

    def define(self):
        # Just override CGClass and do our own thing
        nativeType = self.nativeLeafName(self.descriptor)

        ctordtor = fill(
            """
            ${nativeType}::${nativeType}()
            {
                // Add |MOZ_COUNT_CTOR(${nativeType});| for a non-refcounted object.
            }

            ${nativeType}::~${nativeType}()
            {
                // Add |MOZ_COUNT_DTOR(${nativeType});| for a non-refcounted object.
            }
            """,
            nativeType=nativeType,
        )

        if self.parentIface:
            ccImpl = fill(
                """

                // Only needed for refcounted objects.
                # error "If you don't have members that need cycle collection,
                # then remove all the cycle collection bits from this
                # implementation and the corresponding header.  If you do, you
                # want NS_IMPL_CYCLE_COLLECTION_INHERITED(${nativeType},
                # ${parentType}, your, members, here)"
                NS_IMPL_ADDREF_INHERITED(${nativeType}, ${parentType})
                NS_IMPL_RELEASE_INHERITED(${nativeType}, ${parentType})
                NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(${nativeType})
                NS_INTERFACE_MAP_END_INHERITING(${parentType})

                """,
                nativeType=nativeType,
                parentType=self.nativeLeafName(self.parentDesc),
            )
        else:
            ccImpl = fill(
                """

                // Only needed for refcounted objects.
                NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE_0(${nativeType})
                NS_IMPL_CYCLE_COLLECTING_ADDREF(${nativeType})
                NS_IMPL_CYCLE_COLLECTING_RELEASE(${nativeType})
                NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(${nativeType})
                  NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY
                  NS_INTERFACE_MAP_ENTRY(nsISupports)
                NS_INTERFACE_MAP_END

                """,
                nativeType=nativeType,
            )

        classImpl = ccImpl + ctordtor + "\n"
        if self.descriptor.concrete:
            if self.descriptor.wrapperCache:
                reflectorArg = ""
                reflectorPassArg = ""
                returnType = "JSObject*"
            else:
                reflectorArg = ", JS::MutableHandle<JSObject*> aReflector"
                reflectorPassArg = ", aReflector"
                returnType = "bool"
            classImpl += fill(
                """
                ${returnType}
                ${nativeType}::WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto${reflectorArg})
                {
                  return ${ifaceName}_Binding::Wrap(aCx, this, aGivenProto${reflectorPassArg});
                }

                """,
                returnType=returnType,
                nativeType=nativeType,
                reflectorArg=reflectorArg,
                ifaceName=self.descriptor.name,
                reflectorPassArg=reflectorPassArg,
            )

        return classImpl

    @staticmethod
    def nativeLeafName(descriptor):
        return descriptor.nativeType.split("::")[-1]


class CGExampleRoot(CGThing):
    """
    Root codegen class for example implementation generation.  Instantiate the
    class and call declare or define to generate header or cpp code,
    respectively.
    """

    def __init__(self, config, interfaceName):
        descriptor = config.getDescriptor(interfaceName)

        self.root = CGWrapper(CGExampleClass(descriptor), pre="\n", post="\n")

        self.root = CGNamespace.build(["mozilla", "dom"], self.root)

        builder = ForwardDeclarationBuilder()
        if descriptor.hasCEReactions():
            builder.addInMozillaDom("DocGroup")
        for member in descriptor.interface.members:
            if not member.isAttr() and not member.isMethod():
                continue
            if member.isStatic():
                builder.addInMozillaDom("GlobalObject")
            if member.isAttr():
                if not member.isMaplikeOrSetlikeAttr():
                    builder.forwardDeclareForType(member.type, config)
            else:
                assert member.isMethod()
                if not member.isMaplikeOrSetlikeOrIterableMethod():
                    for sig in member.signatures():
                        builder.forwardDeclareForType(sig[0], config)
                        for arg in sig[1]:
                            builder.forwardDeclareForType(arg.type, config)

        self.root = CGList([builder.build(), self.root], "\n")

        # Throw in our #includes
        self.root = CGHeaders(
            [],
            [],
            [],
            [],
            [
                "nsWrapperCache.h",
                "nsCycleCollectionParticipant.h",
                "mozilla/Attributes.h",
                "mozilla/ErrorResult.h",
                "mozilla/dom/BindingDeclarations.h",
                "js/TypeDecls.h",
            ],
            [
                "mozilla/dom/%s.h" % interfaceName,
                (
                    "mozilla/dom/%s"
                    % CGHeaders.getDeclarationFilename(descriptor.interface)
                ),
            ],
            "",
            self.root,
        )

        # And now some include guards
        self.root = CGIncludeGuard(interfaceName, self.root)

        # And our license block comes before everything else
        self.root = CGWrapper(
            self.root,
            pre=dedent(
                """
            /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
            /* vim:set ts=2 sw=2 sts=2 et cindent: */
            /* This Source Code Form is subject to the terms of the Mozilla Public
             * License, v. 2.0. If a copy of the MPL was not distributed with this
             * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

            """
            ),
        )

    def declare(self):
        return self.root.declare()

    def define(self):
        return self.root.define()


def jsImplName(name):
    return name + "JSImpl"


class CGJSImplMember(CGNativeMember):
    """
    Base class for generating code for the members of the implementation class
    for a JS-implemented WebIDL interface.
    """

    def __init__(
        self,
        descriptorProvider,
        member,
        name,
        signature,
        extendedAttrs,
        breakAfter=True,
        passJSBitsAsNeeded=True,
        visibility="public",
        variadicIsSequence=False,
        virtual=False,
        override=False,
    ):
        CGNativeMember.__init__(
            self,
            descriptorProvider,
            member,
            name,
            signature,
            extendedAttrs,
            breakAfter=breakAfter,
            passJSBitsAsNeeded=passJSBitsAsNeeded,
            visibility=visibility,
            variadicIsSequence=variadicIsSequence,
            virtual=virtual,
            override=override,
        )
        self.body = self.getImpl()

    def getArgs(self, returnType, argList):
        args = CGNativeMember.getArgs(self, returnType, argList)
        args.append(Argument("JS::Realm*", "aRealm", "nullptr"))
        return args


class CGJSImplMethod(CGJSImplMember):
    """
    Class for generating code for the methods for a JS-implemented WebIDL
    interface.
    """

    def __init__(self, descriptor, method, signature, isConstructor, breakAfter=True):
        self.signature = signature
        self.descriptor = descriptor
        self.isConstructor = isConstructor
        CGJSImplMember.__init__(
            self,
            descriptor,
            method,
            CGSpecializedMethod.makeNativeName(descriptor, method),
            signature,
            descriptor.getExtendedAttributes(method),
            breakAfter=breakAfter,
            variadicIsSequence=True,
            passJSBitsAsNeeded=False,
        )

    def getArgs(self, returnType, argList):
        if self.isConstructor:
            # Skip the JS::Compartment bits for constructors; it's handled
            # manually in getImpl.  But we do need our aGivenProto argument.  We
            # allow it to be omitted if the default proto is desired.
            return CGNativeMember.getArgs(self, returnType, argList) + [
                Argument("JS::Handle<JSObject*>", "aGivenProto", "nullptr")
            ]
        return CGJSImplMember.getArgs(self, returnType, argList)

    def getImpl(self):
        args = self.getArgs(self.signature[0], self.signature[1])
        if not self.isConstructor:
            return "return mImpl->%s(%s);\n" % (
                self.name,
                ", ".join(arg.name for arg in args),
            )

        assert self.descriptor.interface.isJSImplemented()
        if self.name != "Constructor":
            raise TypeError(
                "Named constructors are not supported for JS implemented WebIDL. See bug 851287."
            )
        if len(self.signature[1]) != 0:
            # The first two arguments to the constructor implementation are not
            # arguments to the WebIDL constructor, so don't pass them to
            # __Init().  The last argument is the prototype we're supposed to
            # use, and shouldn't get passed to __Init() either.
            assert args[0].argType == "const GlobalObject&"
            assert args[1].argType == "JSContext*"
            assert args[-1].argType == "JS::Handle<JSObject*>"
            assert args[-1].name == "aGivenProto"
            constructorArgs = [arg.name for arg in args[2:-1]]
            constructorArgs.append("js::GetNonCCWObjectRealm(scopeObj)")
            initCall = fill(
                """
                // Wrap the object before calling __Init so that __DOM_IMPL__ is available.
                JS::Rooted<JSObject*> scopeObj(cx, global.Get());
                MOZ_ASSERT(js::IsObjectInContextCompartment(scopeObj, cx));
                JS::Rooted<JS::Value> wrappedVal(cx);
                if (!GetOrCreateDOMReflector(cx, impl, &wrappedVal, aGivenProto)) {
                  MOZ_ASSERT(JS_IsExceptionPending(cx));
                  aRv.Throw(NS_ERROR_UNEXPECTED);
                  return nullptr;
                }
                // Initialize the object with the constructor arguments.
                impl->mImpl->__Init(${args});
                if (aRv.Failed()) {
                  return nullptr;
                }
                """,
                args=", ".join(constructorArgs),
            )
        else:
            initCall = ""
        return fill(
            """
            RefPtr<${implClass}> impl =
              ConstructJSImplementation<${implClass}>("${contractId}", global, aRv);
            if (aRv.Failed()) {
              return nullptr;
            }
            $*{initCall}
            return impl.forget();
            """,
            contractId=self.descriptor.interface.getJSImplementation(),
            implClass=self.descriptor.name,
            initCall=initCall,
        )


# We're always fallible
def callbackGetterName(attr, descriptor):
    return "Get" + MakeNativeName(
        descriptor.binaryNameFor(attr.identifier.name, attr.isStatic())
    )


def callbackSetterName(attr, descriptor):
    return "Set" + MakeNativeName(
        descriptor.binaryNameFor(attr.identifier.name, attr.isStatic())
    )


class CGJSImplGetter(CGJSImplMember):
    """
    Class for generating code for the getters of attributes for a JS-implemented
    WebIDL interface.
    """

    def __init__(self, descriptor, attr):
        CGJSImplMember.__init__(
            self,
            descriptor,
            attr,
            CGSpecializedGetter.makeNativeName(descriptor, attr),
            (attr.type, []),
            descriptor.getExtendedAttributes(attr, getter=True),
            passJSBitsAsNeeded=False,
        )

    def getImpl(self):
        callbackArgs = [arg.name for arg in self.getArgs(self.member.type, [])]
        return "return mImpl->%s(%s);\n" % (
            callbackGetterName(self.member, self.descriptorProvider),
            ", ".join(callbackArgs),
        )


class CGJSImplSetter(CGJSImplMember):
    """
    Class for generating code for the setters of attributes for a JS-implemented
    WebIDL interface.
    """

    def __init__(self, descriptor, attr):
        CGJSImplMember.__init__(
            self,
            descriptor,
            attr,
            CGSpecializedSetter.makeNativeName(descriptor, attr),
            (
                BuiltinTypes[IDLBuiltinType.Types.undefined],
                [FakeArgument(attr.type)],
            ),
            descriptor.getExtendedAttributes(attr, setter=True),
            passJSBitsAsNeeded=False,
        )

    def getImpl(self):
        callbackArgs = [
            arg.name
            for arg in self.getArgs(
                BuiltinTypes[IDLBuiltinType.Types.undefined],
                [FakeArgument(self.member.type)],
            )
        ]
        return "mImpl->%s(%s);\n" % (
            callbackSetterName(self.member, self.descriptorProvider),
            ", ".join(callbackArgs),
        )


class CGJSImplClass(CGBindingImplClass):
    def __init__(self, descriptor):
        CGBindingImplClass.__init__(
            self,
            descriptor,
            CGJSImplMethod,
            CGJSImplGetter,
            CGJSImplSetter,
            skipStaticMethods=True,
        )

        if descriptor.interface.parent:
            parentClass = descriptor.getDescriptor(
                descriptor.interface.parent.identifier.name
            ).jsImplParent
            baseClasses = [ClassBase(parentClass)]
            isupportsDecl = "NS_DECL_ISUPPORTS_INHERITED\n"
            ccDecl = "NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(%s, %s)\n" % (
                descriptor.name,
                parentClass,
            )
            extradefinitions = fill(
                """
                NS_IMPL_CYCLE_COLLECTION_INHERITED(${ifaceName}, ${parentClass}, mImpl, mParent)
                NS_IMPL_ADDREF_INHERITED(${ifaceName}, ${parentClass})
                NS_IMPL_RELEASE_INHERITED(${ifaceName}, ${parentClass})
                NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(${ifaceName})
                NS_INTERFACE_MAP_END_INHERITING(${parentClass})
                """,
                ifaceName=self.descriptor.name,
                parentClass=parentClass,
            )
        else:
            baseClasses = [
                ClassBase("nsSupportsWeakReference"),
                ClassBase("nsWrapperCache"),
            ]
            isupportsDecl = "NS_DECL_CYCLE_COLLECTING_ISUPPORTS\n"
            ccDecl = (
                "NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(%s)\n" % descriptor.name
            )
            extradefinitions = fill(
                """
                NS_IMPL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(${ifaceName})
                NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(${ifaceName})
                  NS_IMPL_CYCLE_COLLECTION_UNLINK(mImpl)
                  NS_IMPL_CYCLE_COLLECTION_UNLINK(mParent)
                  NS_IMPL_CYCLE_COLLECTION_UNLINK_PRESERVED_WRAPPER
                  tmp->ClearWeakReferences();
                NS_IMPL_CYCLE_COLLECTION_UNLINK_END
                NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN(${ifaceName})
                  NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mImpl)
                  NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mParent)
                NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
                NS_IMPL_CYCLE_COLLECTING_ADDREF(${ifaceName})
                NS_IMPL_CYCLE_COLLECTING_RELEASE(${ifaceName})
                NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(${ifaceName})
                  NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY
                  NS_INTERFACE_MAP_ENTRY(nsISupports)
                  NS_INTERFACE_MAP_ENTRY(nsISupportsWeakReference)
                NS_INTERFACE_MAP_END
                """,
                ifaceName=self.descriptor.name,
            )

        extradeclarations = fill(
            """
            public:
              $*{isupportsDecl}
              $*{ccDecl}

            private:
              RefPtr<${jsImplName}> mImpl;
              nsCOMPtr<nsIGlobalObject> mParent;

            """,
            isupportsDecl=isupportsDecl,
            ccDecl=ccDecl,
            jsImplName=jsImplName(descriptor.name),
        )

        if descriptor.interface.getExtendedAttribute("WantsEventListenerHooks"):
            # No need to do too much sanity checking here; the
            # generated code will fail to compile if the methods we
            # try to overrid aren't on a superclass.
            self.methodDecls.extend(
                self.getEventHookMethod(parentClass, "EventListenerAdded")
            )
            self.methodDecls.extend(
                self.getEventHookMethod(parentClass, "EventListenerRemoved")
            )

        if descriptor.interface.hasChildInterfaces():
            decorators = ""
            # We need a protected virtual destructor our subclasses can use
            destructor = ClassDestructor(virtual=True, visibility="protected")
        else:
            decorators = "final"
            destructor = ClassDestructor(virtual=False, visibility="private")

        baseConstructors = [
            (
                "mImpl(new %s(nullptr, aJSImplObject, aJSImplGlobal, /* aIncumbentGlobal = */ nullptr))"
                % jsImplName(descriptor.name)
            ),
            "mParent(aParent)",
        ]
        parentInterface = descriptor.interface.parent
        while parentInterface:
            if parentInterface.isJSImplemented():
                baseConstructors.insert(
                    0, "%s(aJSImplObject, aJSImplGlobal, aParent)" % parentClass
                )
                break
            parentInterface = parentInterface.parent
        if not parentInterface and descriptor.interface.parent:
            # We only have C++ ancestors, so only pass along the window
            baseConstructors.insert(0, "%s(aParent)" % parentClass)

        constructor = ClassConstructor(
            [
                Argument("JS::Handle<JSObject*>", "aJSImplObject"),
                Argument("JS::Handle<JSObject*>", "aJSImplGlobal"),
                Argument("nsIGlobalObject*", "aParent"),
            ],
            visibility="public",
            baseConstructors=baseConstructors,
        )

        self.methodDecls.append(
            ClassMethod(
                "_Create",
                "bool",
                JSNativeArguments(),
                static=True,
                body=self.getCreateFromExistingBody(),
            )
        )

        CGClass.__init__(
            self,
            descriptor.name,
            bases=baseClasses,
            constructors=[constructor],
            destructor=destructor,
            methods=self.methodDecls,
            decorators=decorators,
            extradeclarations=extradeclarations,
            extradefinitions=extradefinitions,
        )

    def getWrapObjectBody(self):
        return fill(
            """
            JS::Rooted<JSObject*> obj(aCx, ${name}_Binding::Wrap(aCx, this, aGivenProto));
            if (!obj) {
              return nullptr;
            }

            // Now define it on our chrome object
            JSAutoRealm ar(aCx, mImpl->CallbackGlobalOrNull());
            if (!JS_WrapObject(aCx, &obj)) {
              return nullptr;
            }
            JS::Rooted<JSObject*> callback(aCx, mImpl->CallbackOrNull());
            if (!JS_DefineProperty(aCx, callback, "__DOM_IMPL__", obj, 0)) {
              return nullptr;
            }
            return obj;
            """,
            name=self.descriptor.name,
        )

    def getGetParentObjectReturnType(self):
        return "nsISupports*"

    def getGetParentObjectBody(self):
        return "return mParent;\n"

    def getGetDocGroupBody(self):
        return dedent(
            """
            nsCOMPtr<nsPIDOMWindowInner> window = do_QueryInterface(mParent);
            if (!window) {
              return nullptr;
            }
            return window->GetDocGroup();
            """
        )

    def getCreateFromExistingBody(self):
        # XXXbz we could try to get parts of this (e.g. the argument
        # conversions) auto-generated by somehow creating an IDLMethod and
        # adding it to our interface, but we'd still need to special-case the
        # implementation slightly to have it not try to forward to the JS
        # object...
        return fill(
            """
            JS::CallArgs args = JS::CallArgsFromVp(argc, vp);
            if (!args.requireAtLeast(cx, "${ifaceName}._create", 2)) {
              return false;
            }
            BindingCallContext callCx(cx, "${ifaceName}._create");
            if (!args[0].isObject()) {
              return callCx.ThrowErrorMessage<MSG_NOT_OBJECT>("Argument 1");
            }
            if (!args[1].isObject()) {
              return callCx.ThrowErrorMessage<MSG_NOT_OBJECT>("Argument 2");
            }

            // GlobalObject will go through wrappers as needed for us, and
            // is simpler than the right UnwrapArg incantation.
            GlobalObject global(cx, &args[0].toObject());
            if (global.Failed()) {
              return false;
            }
            nsCOMPtr<nsIGlobalObject> globalHolder = do_QueryInterface(global.GetAsSupports());
            MOZ_ASSERT(globalHolder);
            JS::Rooted<JSObject*> arg(cx, &args[1].toObject());
            JS::Rooted<JSObject*> argGlobal(cx, JS::CurrentGlobalOrNull(cx));
            RefPtr<${implName}> impl = new ${implName}(arg, argGlobal, globalHolder);
            MOZ_ASSERT(js::IsObjectInContextCompartment(arg, cx));
            return GetOrCreateDOMReflector(cx, impl, args.rval());
            """,
            ifaceName=self.descriptor.interface.identifier.name,
            implName=self.descriptor.name,
        )

    def getEventHookMethod(self, parentClass, methodName):
        body = fill(
            """
            ${parentClass}::${methodName}(aType);
            mImpl->${methodName}(Substring(nsDependentAtomString(aType), 2), IgnoreErrors());
            """,
            parentClass=parentClass,
            methodName=methodName,
        )
        return [
            ClassMethod(
                methodName,
                "void",
                [Argument("nsAtom*", "aType")],
                virtual=True,
                override=True,
                body=body,
            ),
            ClassUsingDeclaration(parentClass, methodName),
        ]


def isJSImplementedDescriptor(descriptorProvider):
    return (
        isinstance(descriptorProvider, Descriptor)
        and descriptorProvider.interface.isJSImplemented()
    )


class CGCallback(CGClass):
    def __init__(
        self, idlObject, descriptorProvider, baseName, methods, getters=[], setters=[]
    ):
        self.baseName = baseName
        self._deps = idlObject.getDeps()
        self.idlObject = idlObject
        self.name = idlObject.identifier.name
        if isJSImplementedDescriptor(descriptorProvider):
            self.name = jsImplName(self.name)
        # For our public methods that needThisHandling we want most of the
        # same args and the same return type as what CallbackMember
        # generates.  So we want to take advantage of all its
        # CGNativeMember infrastructure, but that infrastructure can't deal
        # with templates and most especially template arguments.  So just
        # cheat and have CallbackMember compute all those things for us.
        realMethods = []
        for method in methods:
            if not isinstance(method, CallbackMember) or not method.needThisHandling:
                realMethods.append(method)
            else:
                realMethods.extend(self.getMethodImpls(method))
        realMethods.append(
            ClassMethod(
                "operator==",
                "bool",
                [Argument("const %s&" % self.name, "aOther")],
                inline=True,
                bodyInHeader=True,
                const=True,
                body=("return %s::operator==(aOther);\n" % baseName),
            )
        )
        CGClass.__init__(
            self,
            self.name,
            bases=[ClassBase(baseName)],
            constructors=self.getConstructors(),
            methods=realMethods + getters + setters,
        )

    def getConstructors(self):
        if (
            not self.idlObject.isInterface()
            and not self.idlObject._treatNonObjectAsNull
        ):
            body = "MOZ_ASSERT(JS::IsCallable(mCallback));\n"
        else:
            # Not much we can assert about it, other than not being null, and
            # CallbackObject does that already.
            body = ""
        return [
            ClassConstructor(
                [
                    Argument("JSContext*", "aCx"),
                    Argument("JS::Handle<JSObject*>", "aCallback"),
                    Argument("JS::Handle<JSObject*>", "aCallbackGlobal"),
                    Argument("nsIGlobalObject*", "aIncumbentGlobal"),
                ],
                bodyInHeader=True,
                visibility="public",
                explicit=True,
                baseConstructors=[
                    "%s(aCx, aCallback, aCallbackGlobal, aIncumbentGlobal)"
                    % self.baseName,
                ],
                body=body,
            ),
            ClassConstructor(
                [
                    Argument("JSObject*", "aCallback"),
                    Argument("JSObject*", "aCallbackGlobal"),
                    Argument("const FastCallbackConstructor&", ""),
                ],
                bodyInHeader=True,
                visibility="public",
                explicit=True,
                baseConstructors=[
                    "%s(aCallback, aCallbackGlobal, FastCallbackConstructor())"
                    % self.baseName,
                ],
                body=body,
            ),
            ClassConstructor(
                [
                    Argument("JSObject*", "aCallback"),
                    Argument("JSObject*", "aCallbackGlobal"),
                    Argument("JSObject*", "aAsyncStack"),
                    Argument("nsIGlobalObject*", "aIncumbentGlobal"),
                ],
                bodyInHeader=True,
                visibility="public",
                explicit=True,
                baseConstructors=[
                    "%s(aCallback, aCallbackGlobal, aAsyncStack, aIncumbentGlobal)"
                    % self.baseName,
                ],
                body=body,
            ),
        ]

    def getMethodImpls(self, method):
        assert method.needThisHandling
        args = list(method.args)
        # Strip out the BindingCallContext&/JSObject* args
        # that got added.
        assert args[0].name == "cx" and args[0].argType == "BindingCallContext&"
        assert args[1].name == "aThisVal" and args[1].argType == "JS::Handle<JS::Value>"
        args = args[2:]

        # Now remember which index the ErrorResult argument is at;
        # we'll need this below.
        assert args[-1].name == "aRv" and args[-1].argType == "ErrorResult&"
        rvIndex = len(args) - 1
        assert rvIndex >= 0

        # Record the names of all the arguments, so we can use them when we call
        # the private method.
        argnames = [arg.name for arg in args]
        argnamesWithThis = ["s.GetCallContext()", "thisValJS"] + argnames
        argnamesWithoutThis = [
            "s.GetCallContext()",
            "JS::UndefinedHandleValue",
        ] + argnames
        # Now that we've recorded the argnames for our call to our private
        # method, insert our optional argument for the execution reason.
        args.append(Argument("const char*", "aExecutionReason", "nullptr"))

        # Make copies of the arg list for the two "without rv" overloads.  Note
        # that those don't need aExceptionHandling or aRealm arguments because
        # those would make not sense anyway: the only sane thing to do with
        # exceptions in the "without rv" cases is to report them.
        argsWithoutRv = list(args)
        argsWithoutRv.pop(rvIndex)
        argsWithoutThisAndRv = list(argsWithoutRv)

        # Add the potional argument for deciding whether the CallSetup should
        # re-throw exceptions on aRv.
        args.append(
            Argument("ExceptionHandling", "aExceptionHandling", "eReportExceptions")
        )
        # And the argument for communicating when exceptions should really be
        # rethrown.  In particular, even when aExceptionHandling is
        # eRethrowExceptions they won't get rethrown if aRealm is provided
        # and its principal doesn't subsume either the callback or the
        # exception.
        args.append(Argument("JS::Realm*", "aRealm", "nullptr"))
        # And now insert our template argument.
        argsWithoutThis = list(args)
        args.insert(0, Argument("const T&", "thisVal"))
        argsWithoutRv.insert(0, Argument("const T&", "thisVal"))

        argnamesWithoutThisAndRv = [arg.name for arg in argsWithoutThisAndRv]
        argnamesWithoutThisAndRv.insert(rvIndex, "IgnoreErrors()")
        # If we just leave things like that, and have no actual arguments in the
        # IDL, we will end up trying to call the templated "without rv" overload
        # with "rv" as the thisVal.  That's no good.  So explicitly append the
        # aExceptionHandling and aRealm values we need to end up matching the
        # signature of our non-templated "with rv" overload.
        argnamesWithoutThisAndRv.extend(["eReportExceptions", "nullptr"])

        argnamesWithoutRv = [arg.name for arg in argsWithoutRv]
        # Note that we need to insert at rvIndex + 1, since we inserted a
        # thisVal arg at the start.
        argnamesWithoutRv.insert(rvIndex + 1, "IgnoreErrors()")

        errorReturn = method.getDefaultRetval()

        setupCall = fill(
            """
            MOZ_ASSERT(!aRv.Failed(), "Don't pass an already-failed ErrorResult to a callback!");
            if (!aExecutionReason) {
              aExecutionReason = "${executionReason}";
            }
            CallSetup s(this, aRv, aExecutionReason, aExceptionHandling, aRealm);
            if (!s.GetContext()) {
              MOZ_ASSERT(aRv.Failed());
              return${errorReturn};
            }
            """,
            errorReturn=errorReturn,
            executionReason=method.getPrettyName(),
        )

        bodyWithThis = fill(
            """
            $*{setupCall}
            JS::Rooted<JS::Value> thisValJS(s.GetContext());
            if (!ToJSValue(s.GetContext(), thisVal, &thisValJS)) {
              aRv.Throw(NS_ERROR_FAILURE);
              return${errorReturn};
            }
            return ${methodName}(${callArgs});
            """,
            setupCall=setupCall,
            errorReturn=errorReturn,
            methodName=method.name,
            callArgs=", ".join(argnamesWithThis),
        )
        bodyWithoutThis = fill(
            """
            $*{setupCall}
            return ${methodName}(${callArgs});
            """,
            setupCall=setupCall,
            errorReturn=errorReturn,
            methodName=method.name,
            callArgs=", ".join(argnamesWithoutThis),
        )
        bodyWithThisWithoutRv = fill(
            """
            return ${methodName}(${callArgs});
            """,
            methodName=method.name,
            callArgs=", ".join(argnamesWithoutRv),
        )
        bodyWithoutThisAndRv = fill(
            """
            return ${methodName}(${callArgs});
            """,
            methodName=method.name,
            callArgs=", ".join(argnamesWithoutThisAndRv),
        )

        return [
            ClassMethod(
                method.name,
                method.returnType,
                args,
                bodyInHeader=True,
                templateArgs=["typename T"],
                body=bodyWithThis,
                canRunScript=method.canRunScript,
            ),
            ClassMethod(
                method.name,
                method.returnType,
                argsWithoutThis,
                bodyInHeader=True,
                body=bodyWithoutThis,
                canRunScript=method.canRunScript,
            ),
            ClassMethod(
                method.name,
                method.returnType,
                argsWithoutRv,
                bodyInHeader=True,
                templateArgs=["typename T"],
                body=bodyWithThisWithoutRv,
                canRunScript=method.canRunScript,
            ),
            ClassMethod(
                method.name,
                method.returnType,
                argsWithoutThisAndRv,
                bodyInHeader=True,
                body=bodyWithoutThisAndRv,
                canRunScript=method.canRunScript,
            ),
            method,
        ]

    def deps(self):
        return self._deps


class CGCallbackFunction(CGCallback):
    def __init__(self, callback, descriptorProvider):
        self.callback = callback
        if callback.isConstructor():
            methods = [ConstructCallback(callback, descriptorProvider)]
        else:
            methods = [CallCallback(callback, descriptorProvider)]
        CGCallback.__init__(
            self, callback, descriptorProvider, "CallbackFunction", methods
        )

    def getConstructors(self):
        return CGCallback.getConstructors(self) + [
            ClassConstructor(
                [Argument("CallbackFunction*", "aOther")],
                bodyInHeader=True,
                visibility="public",
                explicit=True,
                baseConstructors=["CallbackFunction(aOther)"],
            )
        ]


class CGFastCallback(CGClass):
    def __init__(self, idlObject):
        self._deps = idlObject.getDeps()
        baseName = idlObject.identifier.name
        constructor = ClassConstructor(
            [
                Argument("JSObject*", "aCallback"),
                Argument("JSObject*", "aCallbackGlobal"),
            ],
            bodyInHeader=True,
            visibility="public",
            explicit=True,
            baseConstructors=[
                "%s(aCallback, aCallbackGlobal, FastCallbackConstructor())" % baseName,
            ],
            body="",
        )

        traceMethod = ClassMethod(
            "Trace",
            "void",
            [Argument("JSTracer*", "aTracer")],
            inline=True,
            bodyInHeader=True,
            visibility="public",
            body="%s::Trace(aTracer);\n" % baseName,
        )
        holdMethod = ClassMethod(
            "FinishSlowJSInitIfMoreThanOneOwner",
            "void",
            [Argument("JSContext*", "aCx")],
            inline=True,
            bodyInHeader=True,
            visibility="public",
            body=("%s::FinishSlowJSInitIfMoreThanOneOwner(aCx);\n" % baseName),
        )

        CGClass.__init__(
            self,
            "Fast%s" % baseName,
            bases=[ClassBase(baseName)],
            constructors=[constructor],
            methods=[traceMethod, holdMethod],
        )

    def deps(self):
        return self._deps


class CGCallbackInterface(CGCallback):
    def __init__(self, descriptor, spiderMonkeyInterfacesAreStructs=False):
        iface = descriptor.interface
        attrs = [
            m
            for m in iface.members
            if (
                m.isAttr()
                and not m.isStatic()
                and (not m.isMaplikeOrSetlikeAttr() or not iface.isJSImplemented())
            )
        ]
        getters = [
            CallbackGetter(a, descriptor, spiderMonkeyInterfacesAreStructs)
            for a in attrs
        ]
        setters = [
            CallbackSetter(a, descriptor, spiderMonkeyInterfacesAreStructs)
            for a in attrs
            if not a.readonly
        ]
        methods = [
            m
            for m in iface.members
            if (
                m.isMethod()
                and not m.isStatic()
                and not m.isIdentifierLess()
                and (
                    not m.isMaplikeOrSetlikeOrIterableMethod()
                    or not iface.isJSImplemented()
                )
            )
        ]
        methods = [
            CallbackOperation(m, sig, descriptor, spiderMonkeyInterfacesAreStructs)
            for m in methods
            for sig in m.signatures()
        ]

        needInitId = False
        if iface.isJSImplemented() and iface.ctor():
            sigs = descriptor.interface.ctor().signatures()
            if len(sigs) != 1:
                raise TypeError("We only handle one constructor.  See bug 869268.")
            methods.append(CGJSImplInitOperation(sigs[0], descriptor))
            needInitId = True

        idlist = [
            descriptor.binaryNameFor(m.identifier.name, m.isStatic())
            for m in iface.members
            if m.isAttr() or m.isMethod()
        ]
        if needInitId:
            idlist.append("__init")

        if iface.isJSImplemented() and iface.getExtendedAttribute(
            "WantsEventListenerHooks"
        ):
            methods.append(CGJSImplEventHookOperation(descriptor, "eventListenerAdded"))
            methods.append(
                CGJSImplEventHookOperation(descriptor, "eventListenerRemoved")
            )
            idlist.append("eventListenerAdded")
            idlist.append("eventListenerRemoved")

        if len(idlist) != 0:
            methods.append(initIdsClassMethod(idlist, iface.identifier.name + "Atoms"))
        CGCallback.__init__(
            self,
            iface,
            descriptor,
            "CallbackInterface",
            methods,
            getters=getters,
            setters=setters,
        )


class FakeMember:
    def __init__(self, name=None):
        if name is not None:
            self.identifier = FakeIdentifier(name)

    def isStatic(self):
        return False

    def isAttr(self):
        return False

    def isMethod(self):
        return False

    def getExtendedAttribute(self, name):
        # Claim to be a [NewObject] so we can avoid the "return a raw pointer"
        # comments CGNativeMember codegen would otherwise stick in.
        if name == "NewObject":
            return True
        return None


class CallbackMember(CGNativeMember):
    # XXXbz It's OK to use CallbackKnownNotGray for wrapScope because
    # CallSetup already handled the unmark-gray bits for us. we don't have
    # anything better to use for 'obj', really...
    def __init__(
        self,
        sig,
        name,
        descriptorProvider,
        needThisHandling,
        rethrowContentException=False,
        spiderMonkeyInterfacesAreStructs=False,
        wrapScope=None,
        canRunScript=False,
        passJSBitsAsNeeded=False,
    ):
        """
        needThisHandling is True if we need to be able to accept a specified
        thisObj, False otherwise.
        """
        assert not rethrowContentException or not needThisHandling

        self.retvalType = sig[0]
        self.originalSig = sig
        args = sig[1]
        self.argCount = len(args)
        if self.argCount > 0:
            # Check for variadic arguments
            lastArg = args[self.argCount - 1]
            if lastArg.variadic:
                self.argCountStr = "(%d - 1) + %s.Length()" % (
                    self.argCount,
                    lastArg.identifier.name,
                )
            else:
                self.argCountStr = "%d" % self.argCount
        self.needThisHandling = needThisHandling
        # If needThisHandling, we generate ourselves as private and the caller
        # will handle generating public versions that handle the "this" stuff.
        visibility = "private" if needThisHandling else "public"
        self.rethrowContentException = rethrowContentException

        self.wrapScope = wrapScope
        # We don't care, for callback codegen, whether our original member was
        # a method or attribute or whatnot.  Just always pass FakeMember()
        # here.
        CGNativeMember.__init__(
            self,
            descriptorProvider,
            FakeMember(),
            name,
            (self.retvalType, args),
            extendedAttrs=["needsErrorResult"],
            passJSBitsAsNeeded=passJSBitsAsNeeded,
            visibility=visibility,
            spiderMonkeyInterfacesAreStructs=spiderMonkeyInterfacesAreStructs,
            canRunScript=canRunScript,
        )
        # We have to do all the generation of our body now, because
        # the caller relies on us throwing if we can't manage it.
        self.body = self.getImpl()

    def getImpl(self):
        setupCall = self.getCallSetup()
        declRval = self.getRvalDecl()
        if self.argCount > 0:
            argvDecl = fill(
                """
                JS::RootedVector<JS::Value> argv(cx);
                if (!argv.resize(${argCount})) {
                  $*{failureCode}
                  return${errorReturn};
                }
                """,
                argCount=self.argCountStr,
                failureCode=self.getArgvDeclFailureCode(),
                errorReturn=self.getDefaultRetval(),
            )
        else:
            # Avoid weird 0-sized arrays
            argvDecl = ""
        convertArgs = self.getArgConversions()
        doCall = self.getCall()
        returnResult = self.getResultConversion()

        body = declRval + argvDecl + convertArgs + doCall
        if self.needsScopeBody():
            body = "{\n" + indent(body) + "}\n"
        return setupCall + body + returnResult

    def needsScopeBody(self):
        return False

    def getArgvDeclFailureCode(self):
        return dedent(
            """
            // That threw an exception on the JSContext, and our CallSetup will do
            // the right thing with that.
            """
        )

    def getExceptionCode(self, forResult):
        return fill(
            """
            aRv.Throw(NS_ERROR_UNEXPECTED);
            return${defaultRetval};
            """,
            defaultRetval=self.getDefaultRetval(),
        )

    def getResultConversion(
        self, val="rval", failureCode=None, isDefinitelyObject=False, exceptionCode=None
    ):
        replacements = {
            "val": val,
            "holderName": "rvalHolder",
            "declName": "rvalDecl",
            # We actually want to pass in a null scope object here, because
            # wrapping things into our current compartment (that of mCallback)
            # is what we want.
            "obj": "nullptr",
            "passedToJSImpl": "false",
        }

        if isJSImplementedDescriptor(self.descriptorProvider):
            isCallbackReturnValue = "JSImpl"
        else:
            isCallbackReturnValue = "Callback"
        sourceDescription = "return value of %s" % self.getPrettyName()
        convertType = instantiateJSToNativeConversion(
            getJSToNativeConversionInfo(
                self.retvalType,
                self.descriptorProvider,
                failureCode=failureCode,
                isDefinitelyObject=isDefinitelyObject,
                exceptionCode=exceptionCode or self.getExceptionCode(forResult=True),
                isCallbackReturnValue=isCallbackReturnValue,
                # Allow returning a callback type that
                # allows non-callable objects.
                allowTreatNonCallableAsNull=True,
                sourceDescription=sourceDescription,
            ),
            replacements,
        )
        assignRetval = string.Template(
            self.getRetvalInfo(self.retvalType, False)[2]
        ).substitute(replacements)
        type = convertType.define()
        return type + assignRetval

    def getArgConversions(self):
        # Just reget the arglist from self.originalSig, because our superclasses
        # just have way to many members they like to clobber, so I can't find a
        # safe member name to store it in.
        argConversions = [
            self.getArgConversion(i, arg) for i, arg in enumerate(self.originalSig[1])
        ]
        if not argConversions:
            return "\n"

        # Do them back to front, so our argc modifications will work
        # correctly, because we examine trailing arguments first.
        argConversions.reverse()
        # Wrap each one in a scope so that any locals it has don't leak out, and
        # also so that we can just "break;" for our successCode.
        argConversions = [
            CGWrapper(CGIndenter(CGGeneric(c)), pre="do {\n", post="} while (false);\n")
            for c in argConversions
        ]
        if self.argCount > 0:
            argConversions.insert(0, self.getArgcDecl())
        # And slap them together.
        return CGList(argConversions, "\n").define() + "\n"

    def getArgConversion(self, i, arg):
        argval = arg.identifier.name

        if arg.variadic:
            argval = argval + "[idx]"
            jsvalIndex = "%d + idx" % i
        else:
            jsvalIndex = "%d" % i
            if arg.canHaveMissingValue():
                argval += ".Value()"

        if arg.type.isDOMString():
            # XPConnect string-to-JS conversion wants to mutate the string.  So
            # let's give it a string it can mutate
            # XXXbz if we try to do a sequence of strings, this will kinda fail.
            result = "mutableStr"
            prepend = "nsString mutableStr(%s);\n" % argval
        else:
            result = argval
            prepend = ""

        wrapScope = self.wrapScope
        if arg.type.isUnion() and wrapScope is None:
            prepend += (
                "JS::Rooted<JSObject*> callbackObj(cx, CallbackKnownNotGray());\n"
            )
            wrapScope = "callbackObj"

        conversion = prepend + wrapForType(
            arg.type,
            self.descriptorProvider,
            {
                "result": result,
                "successCode": "continue;\n" if arg.variadic else "break;\n",
                "jsvalRef": "argv[%s]" % jsvalIndex,
                "jsvalHandle": "argv[%s]" % jsvalIndex,
                "obj": wrapScope,
                "returnsNewObject": False,
                "exceptionCode": self.getExceptionCode(forResult=False),
                "spiderMonkeyInterfacesAreStructs": self.spiderMonkeyInterfacesAreStructs,
            },
        )

        if arg.variadic:
            conversion = fill(
                """
                for (uint32_t idx = 0; idx < ${arg}.Length(); ++idx) {
                  $*{conversion}
                }
                break;
                """,
                arg=arg.identifier.name,
                conversion=conversion,
            )
        elif arg.canHaveMissingValue():
            conversion = fill(
                """
                if (${argName}.WasPassed()) {
                  $*{conversion}
                } else if (argc == ${iPlus1}) {
                  // This is our current trailing argument; reduce argc
                  --argc;
                } else {
                  argv[${i}].setUndefined();
                }
                """,
                argName=arg.identifier.name,
                conversion=conversion,
                iPlus1=i + 1,
                i=i,
            )
        return conversion

    def getDefaultRetval(self):
        default = self.getRetvalInfo(self.retvalType, False)[1]
        if len(default) != 0:
            default = " " + default
        return default

    def getArgs(self, returnType, argList):
        args = CGNativeMember.getArgs(self, returnType, argList)
        if not self.needThisHandling:
            # Since we don't need this handling, we're the actual method that
            # will be called, so we need an aRethrowExceptions argument.
            if not self.rethrowContentException:
                args.append(Argument("const char*", "aExecutionReason", "nullptr"))
                args.append(
                    Argument(
                        "ExceptionHandling", "aExceptionHandling", "eReportExceptions"
                    )
                )
            args.append(Argument("JS::Realm*", "aRealm", "nullptr"))
            return args
        # We want to allow the caller to pass in a "this" value, as
        # well as a BindingCallContext.
        return [
            Argument("BindingCallContext&", "cx"),
            Argument("JS::Handle<JS::Value>", "aThisVal"),
        ] + args

    def getCallSetup(self):
        if self.needThisHandling:
            # It's been done for us already
            return ""
        callSetup = "CallSetup s(this, aRv"
        if self.rethrowContentException:
            # getArgs doesn't add the aExceptionHandling argument but does add
            # aRealm for us.
            callSetup += (
                ', "%s", eRethrowContentExceptions, aRealm, /* aIsJSImplementedWebIDL = */ '
                % self.getPrettyName()
            )
            callSetup += toStringBool(
                isJSImplementedDescriptor(self.descriptorProvider)
            )
        else:
            callSetup += ', "%s", aExceptionHandling, aRealm' % self.getPrettyName()
        callSetup += ");\n"
        return fill(
            """
            $*{callSetup}
            if (aRv.Failed()) {
              return${errorReturn};
            }
            MOZ_ASSERT(s.GetContext());
            BindingCallContext& cx = s.GetCallContext();

            """,
            callSetup=callSetup,
            errorReturn=self.getDefaultRetval(),
        )

    def getArgcDecl(self):
        return CGGeneric("unsigned argc = %s;\n" % self.argCountStr)

    @staticmethod
    def ensureASCIIName(idlObject):
        type = "attribute" if idlObject.isAttr() else "operation"
        if re.match("[^\x20-\x7E]", idlObject.identifier.name):
            raise SyntaxError(
                'Callback %s name "%s" contains non-ASCII '
                "characters.  We can't handle that.  %s"
                % (type, idlObject.identifier.name, idlObject.location)
            )
        if re.match('"', idlObject.identifier.name):
            raise SyntaxError(
                "Callback %s name '%s' contains "
                "double-quote character.  We can't handle "
                "that.  %s" % (type, idlObject.identifier.name, idlObject.location)
            )


class ConstructCallback(CallbackMember):
    def __init__(self, callback, descriptorProvider):
        self.callback = callback
        CallbackMember.__init__(
            self,
            callback.signatures()[0],
            "Construct",
            descriptorProvider,
            needThisHandling=False,
            canRunScript=True,
        )

    def getRvalDecl(self):
        # Box constructedObj for getJSToNativeConversionInfo().
        return "JS::Rooted<JS::Value> rval(cx);\n"

    def getCall(self):
        if self.argCount > 0:
            args = "JS::HandleValueArray::subarray(argv, 0, argc)"
        else:
            args = "JS::HandleValueArray::empty()"

        return fill(
            """
            JS::Rooted<JS::Value> constructor(cx, JS::ObjectValue(*mCallback));
            JS::Rooted<JSObject*> constructedObj(cx);
            if (!JS::Construct(cx, constructor,
                          ${args}, &constructedObj)) {
              aRv.NoteJSContextException(cx);
              return${errorReturn};
            }
            rval.setObject(*constructedObj);
            """,
            args=args,
            errorReturn=self.getDefaultRetval(),
        )

    def getResultConversion(self):
        return CallbackMember.getResultConversion(self, isDefinitelyObject=True)

    def getPrettyName(self):
        return self.callback.identifier.name


class CallbackMethod(CallbackMember):
    def __init__(
        self,
        sig,
        name,
        descriptorProvider,
        needThisHandling,
        rethrowContentException=False,
        spiderMonkeyInterfacesAreStructs=False,
        canRunScript=False,
    ):
        CallbackMember.__init__(
            self,
            sig,
            name,
            descriptorProvider,
            needThisHandling,
            rethrowContentException,
            spiderMonkeyInterfacesAreStructs=spiderMonkeyInterfacesAreStructs,
            canRunScript=canRunScript,
        )

    def getRvalDecl(self):
        return "JS::Rooted<JS::Value> rval(cx);\n"

    def getNoteCallFailed(self):
        return fill(
            """
                aRv.NoteJSContextException(cx);
                return${errorReturn};
                """,
            errorReturn=self.getDefaultRetval(),
        )

    def getCall(self):
        if self.argCount > 0:
            args = "JS::HandleValueArray::subarray(argv, 0, argc)"
        else:
            args = "JS::HandleValueArray::empty()"

        return fill(
            """
            $*{declCallable}
            $*{declThis}
            if (${callGuard}!JS::Call(cx, ${thisVal}, callable,
                          ${args}, &rval)) {
              $*{noteError}
            }
            """,
            declCallable=self.getCallableDecl(),
            declThis=self.getThisDecl(),
            callGuard=self.getCallGuard(),
            thisVal=self.getThisVal(),
            args=args,
            noteError=self.getNoteCallFailed(),
        )


class CallCallback(CallbackMethod):
    def __init__(self, callback, descriptorProvider):
        self.callback = callback
        CallbackMethod.__init__(
            self,
            callback.signatures()[0],
            "Call",
            descriptorProvider,
            needThisHandling=True,
            canRunScript=not callback.isRunScriptBoundary(),
        )

    def getNoteCallFailed(self):
        if self.retvalType.isPromise():
            return dedent(
                """
                // Convert exception to a rejected promise.
                // See https://heycam.github.io/webidl/#call-a-user-objects-operation
                // step 12 and step 15.5.
                return CreateRejectedPromiseFromThrownException(cx, aRv);
                """
            )
        return CallbackMethod.getNoteCallFailed(self)

    def getExceptionCode(self, forResult):
        # If the result value is a promise, and conversion
        # to the promise throws an exception we shouldn't
        # try to convert that exception to a promise again.
        if self.retvalType.isPromise() and not forResult:
            return dedent(
                """
                // Convert exception to a rejected promise.
                // See https://heycam.github.io/webidl/#call-a-user-objects-operation
                // step 10 and step 15.5.
                return CreateRejectedPromiseFromThrownException(cx, aRv);
                """
            )
        return CallbackMethod.getExceptionCode(self, forResult)

    def getThisDecl(self):
        return ""

    def getThisVal(self):
        return "aThisVal"

    def getCallableDecl(self):
        return "JS::Rooted<JS::Value> callable(cx, JS::ObjectValue(*mCallback));\n"

    def getPrettyName(self):
        return self.callback.identifier.name

    def getCallGuard(self):
        if self.callback._treatNonObjectAsNull:
            return "JS::IsCallable(mCallback) && "
        return ""


class CallbackOperationBase(CallbackMethod):
    """
    Common class for implementing various callback operations.
    """

    def __init__(
        self,
        signature,
        jsName,
        nativeName,
        descriptor,
        singleOperation,
        rethrowContentException=False,
        spiderMonkeyInterfacesAreStructs=False,
    ):
        self.singleOperation = singleOperation
        self.methodName = descriptor.binaryNameFor(jsName, False)
        CallbackMethod.__init__(
            self,
            signature,
            nativeName,
            descriptor,
            singleOperation,
            rethrowContentException,
            spiderMonkeyInterfacesAreStructs=spiderMonkeyInterfacesAreStructs,
        )

    def getThisDecl(self):
        if not self.singleOperation:
            return "JS::Rooted<JS::Value> thisValue(cx, JS::ObjectValue(*mCallback));\n"
        # This relies on getCallableDecl declaring a boolean
        # isCallable in the case when we're a single-operation
        # interface.
        return dedent(
            """
            JS::Rooted<JS::Value> thisValue(cx, isCallable ? aThisVal.get()
                                                           : JS::ObjectValue(*mCallback));
            """
        )

    def getThisVal(self):
        return "thisValue"

    def getCallableDecl(self):
        getCallableFromProp = fill(
            """
            ${atomCacheName}* atomsCache = GetAtomCache<${atomCacheName}>(cx);
            if ((reinterpret_cast<jsid*>(atomsCache)->isVoid() &&
                 !InitIds(cx, atomsCache)) ||
                !GetCallableProperty(cx, atomsCache->${methodAtomName}, &callable)) {
              aRv.Throw(NS_ERROR_UNEXPECTED);
              return${errorReturn};
            }
            """,
            methodAtomName=CGDictionary.makeIdName(self.methodName),
            atomCacheName=self.descriptorProvider.interface.identifier.name + "Atoms",
            errorReturn=self.getDefaultRetval(),
        )
        if not self.singleOperation:
            return "JS::Rooted<JS::Value> callable(cx);\n" + getCallableFromProp
        return fill(
            """
            bool isCallable = JS::IsCallable(mCallback);
            JS::Rooted<JS::Value> callable(cx);
            if (isCallable) {
              callable = JS::ObjectValue(*mCallback);
            } else {
              $*{getCallableFromProp}
            }
            """,
            getCallableFromProp=getCallableFromProp,
        )

    def getCallGuard(self):
        return ""


class CallbackOperation(CallbackOperationBase):
    """
    Codegen actual WebIDL operations on callback interfaces.
    """

    def __init__(self, method, signature, descriptor, spiderMonkeyInterfacesAreStructs):
        self.ensureASCIIName(method)
        self.method = method
        jsName = method.identifier.name
        CallbackOperationBase.__init__(
            self,
            signature,
            jsName,
            MakeNativeName(descriptor.binaryNameFor(jsName, False)),
            descriptor,
            descriptor.interface.isSingleOperationInterface(),
            rethrowContentException=descriptor.interface.isJSImplemented(),
            spiderMonkeyInterfacesAreStructs=spiderMonkeyInterfacesAreStructs,
        )

    def getPrettyName(self):
        return "%s.%s" % (
            self.descriptorProvider.interface.identifier.name,
            self.method.identifier.name,
        )


class CallbackAccessor(CallbackMember):
    """
    Shared superclass for CallbackGetter and CallbackSetter.
    """

    def __init__(self, attr, sig, name, descriptor, spiderMonkeyInterfacesAreStructs):
        self.ensureASCIIName(attr)
        self.attrName = attr.identifier.name
        CallbackMember.__init__(
            self,
            sig,
            name,
            descriptor,
            needThisHandling=False,
            rethrowContentException=descriptor.interface.isJSImplemented(),
            spiderMonkeyInterfacesAreStructs=spiderMonkeyInterfacesAreStructs,
        )

    def getPrettyName(self):
        return "%s.%s" % (
            self.descriptorProvider.interface.identifier.name,
            self.attrName,
        )


class CallbackGetter(CallbackAccessor):
    def __init__(self, attr, descriptor, spiderMonkeyInterfacesAreStructs):
        CallbackAccessor.__init__(
            self,
            attr,
            (attr.type, []),
            callbackGetterName(attr, descriptor),
            descriptor,
            spiderMonkeyInterfacesAreStructs,
        )

    def getRvalDecl(self):
        return "JS::Rooted<JS::Value> rval(cx);\n"

    def getCall(self):
        return fill(
            """
            JS::Rooted<JSObject *> callback(cx, mCallback);
            ${atomCacheName}* atomsCache = GetAtomCache<${atomCacheName}>(cx);
            if ((reinterpret_cast<jsid*>(atomsCache)->isVoid()
                 && !InitIds(cx, atomsCache)) ||
                !JS_GetPropertyById(cx, callback, atomsCache->${attrAtomName}, &rval)) {
              aRv.Throw(NS_ERROR_UNEXPECTED);
              return${errorReturn};
            }
            """,
            atomCacheName=self.descriptorProvider.interface.identifier.name + "Atoms",
            attrAtomName=CGDictionary.makeIdName(
                self.descriptorProvider.binaryNameFor(self.attrName, False)
            ),
            errorReturn=self.getDefaultRetval(),
        )


class CallbackSetter(CallbackAccessor):
    def __init__(self, attr, descriptor, spiderMonkeyInterfacesAreStructs):
        CallbackAccessor.__init__(
            self,
            attr,
            (
                BuiltinTypes[IDLBuiltinType.Types.undefined],
                [FakeArgument(attr.type)],
            ),
            callbackSetterName(attr, descriptor),
            descriptor,
            spiderMonkeyInterfacesAreStructs,
        )

    def getRvalDecl(self):
        # We don't need an rval
        return ""

    def getCall(self):
        return fill(
            """
            MOZ_ASSERT(argv.length() == 1);
            JS::Rooted<JSObject*> callback(cx, CallbackKnownNotGray());
            ${atomCacheName}* atomsCache = GetAtomCache<${atomCacheName}>(cx);
            if ((reinterpret_cast<jsid*>(atomsCache)->isVoid() &&
                 !InitIds(cx, atomsCache)) ||
                !JS_SetPropertyById(cx, callback, atomsCache->${attrAtomName}, argv[0])) {
              aRv.Throw(NS_ERROR_UNEXPECTED);
              return${errorReturn};
            }
            """,
            atomCacheName=self.descriptorProvider.interface.identifier.name + "Atoms",
            attrAtomName=CGDictionary.makeIdName(
                self.descriptorProvider.binaryNameFor(self.attrName, False)
            ),
            errorReturn=self.getDefaultRetval(),
        )

    def getArgcDecl(self):
        return None


class CGJSImplInitOperation(CallbackOperationBase):
    """
    Codegen the __Init() method used to pass along constructor arguments for JS-implemented WebIDL.
    """

    def __init__(self, sig, descriptor):
        assert sig in descriptor.interface.ctor().signatures()
        CallbackOperationBase.__init__(
            self,
            (BuiltinTypes[IDLBuiltinType.Types.undefined], sig[1]),
            "__init",
            "__Init",
            descriptor,
            singleOperation=False,
            rethrowContentException=True,
            spiderMonkeyInterfacesAreStructs=True,
        )

    def getPrettyName(self):
        return "__init"


class CGJSImplEventHookOperation(CallbackOperationBase):
    """
    Codegen the hooks on a JS impl for adding/removing event listeners.
    """

    def __init__(self, descriptor, name):
        self.name = name

        CallbackOperationBase.__init__(
            self,
            (
                BuiltinTypes[IDLBuiltinType.Types.undefined],
                [FakeArgument(BuiltinTypes[IDLBuiltinType.Types.domstring], "aType")],
            ),
            name,
            MakeNativeName(name),
            descriptor,
            singleOperation=False,
            rethrowContentException=False,
            spiderMonkeyInterfacesAreStructs=True,
        )

    def getPrettyName(self):
        return self.name


def getMaplikeOrSetlikeErrorReturn(helperImpl):
    """
    Generate return values based on whether a maplike or setlike generated
    method is an interface method (which returns bool) or a helper function
    (which uses ErrorResult).
    """
    if helperImpl:
        return dedent(
            """
            aRv.Throw(NS_ERROR_UNEXPECTED);
            return%s;
            """
            % helperImpl.getDefaultRetval()
        )
    return "return false;\n"


def getMaplikeOrSetlikeBackingObject(descriptor, maplikeOrSetlike, helperImpl=None):
    """
    Generate code to get/create a JS backing object for a maplike/setlike
    declaration from the declaration slot.
    """
    func_prefix = maplikeOrSetlike.maplikeOrSetlikeOrIterableType.title()
    ret = fill(
        """
        JS::Rooted<JSObject*> backingObj(cx);
        bool created = false;
        if (!Get${func_prefix}BackingObject(cx, obj, ${slot}, &backingObj, &created)) {
          $*{errorReturn}
        }
        if (created) {
          PreserveWrapper<${selfType}>(self);
        }
        """,
        slot=memberReservedSlot(maplikeOrSetlike, descriptor),
        func_prefix=func_prefix,
        errorReturn=getMaplikeOrSetlikeErrorReturn(helperImpl),
        selfType=descriptor.nativeType,
    )
    return ret


def getMaplikeOrSetlikeSizeGetterBody(descriptor, attr):
    """
    Creates the body for the size getter method of maplike/setlike interfaces.
    """
    # We should only have one declaration attribute currently
    assert attr.identifier.name == "size"
    assert attr.isMaplikeOrSetlikeAttr()
    return fill(
        """
        $*{getBackingObj}
        uint32_t result = JS::${funcPrefix}Size(cx, backingObj);
        MOZ_ASSERT(!JS_IsExceptionPending(cx));
        args.rval().setNumber(result);
        return true;
        """,
        getBackingObj=getMaplikeOrSetlikeBackingObject(
            descriptor, attr.maplikeOrSetlike
        ),
        funcPrefix=attr.maplikeOrSetlike.prefix,
    )


class CGMaplikeOrSetlikeMethodGenerator(CGThing):
    """
    Creates methods for maplike/setlike interfaces. It is expected that all
    methods will be have a maplike/setlike object attached. Unwrapping/wrapping
    will be taken care of by the usual method generation machinery in
    CGMethodCall/CGPerSignatureCall. Functionality is filled in here instead of
    using CGCallGenerator.
    """

    def __init__(
        self,
        descriptor,
        maplikeOrSetlike,
        methodName,
        needsValueTypeReturn=False,
        helperImpl=None,
    ):
        CGThing.__init__(self)
        # True if this will be the body of a C++ helper function.
        self.helperImpl = helperImpl
        self.descriptor = descriptor
        self.maplikeOrSetlike = maplikeOrSetlike
        self.cgRoot = CGList([])
        impl_method_name = methodName
        if impl_method_name[0] == "_":
            # double underscore means this is a js-implemented chrome only rw
            # function. Truncate the double underscore so calling the right
            # underlying JSAPI function still works.
            impl_method_name = impl_method_name[2:]
        self.cgRoot.append(
            CGGeneric(
                getMaplikeOrSetlikeBackingObject(
                    self.descriptor, self.maplikeOrSetlike, self.helperImpl
                )
            )
        )
        self.returnStmt = getMaplikeOrSetlikeErrorReturn(self.helperImpl)

        # Generates required code for the method. Method descriptions included
        # in definitions below. Throw if we don't have a method to fill in what
        # we're looking for.
        try:
            methodGenerator = getattr(self, impl_method_name)
        except AttributeError:
            raise TypeError(
                "Missing %s method definition '%s'"
                % (self.maplikeOrSetlike.maplikeOrSetlikeType, methodName)
            )
        # Method generator returns tuple, containing:
        #
        # - a list of CGThings representing setup code for preparing to call
        #   the JS API function
        # - a list of arguments needed for the JS API function we're calling
        # - list of code CGThings needed for return value conversion.
        (setupCode, arguments, setResult) = methodGenerator()

        # Create the actual method call, and then wrap it with the code to
        # return the value if needed.
        funcName = self.maplikeOrSetlike.prefix + MakeNativeName(impl_method_name)
        # Append the list of setup code CGThings
        self.cgRoot.append(CGList(setupCode))
        # Create the JS API call
        code = dedent(
            """
            if (!JS::${funcName}(${args})) {
              $*{errorReturn}
            }
            """
        )

        if needsValueTypeReturn:
            assert self.helperImpl and impl_method_name == "get"
            code += fill(
                """
                if (result.isUndefined()) {
                  aRv.Throw(NS_ERROR_NOT_AVAILABLE);
                  return${retval};
                }
                """,
                retval=self.helperImpl.getDefaultRetval(),
            )

        self.cgRoot.append(
            CGWrapper(
                CGGeneric(
                    fill(
                        code,
                        funcName=funcName,
                        args=", ".join(["cx", "backingObj"] + arguments),
                        errorReturn=self.returnStmt,
                    )
                )
            )
        )
        # Append result conversion
        self.cgRoot.append(CGList(setResult))

    def mergeTuples(self, a, b):
        """
        Expecting to take 2 tuples were all elements are lists, append the lists in
        the second tuple to the lists in the first.
        """
        return tuple([x + y for x, y in zip(a, b)])

    def appendArgConversion(self, name):
        """
        Generate code to convert arguments to JS::Values, so they can be
        passed into JSAPI functions.
        """
        return CGGeneric(
            fill(
                """
            JS::Rooted<JS::Value> ${name}Val(cx);
            if (!ToJSValue(cx, ${name}, &${name}Val)) {
              $*{errorReturn}
            }
            """,
                name=name,
                errorReturn=self.returnStmt,
            )
        )

    def appendKeyArgConversion(self):
        """
        Generates the key argument for methods. Helper functions will use
        a RootedVector<JS::Value>, while interface methods have separate JS::Values.
        """
        if self.helperImpl:
            return ([], ["argv[0]"], [])
        return ([self.appendArgConversion("arg0")], ["arg0Val"], [])

    def appendKeyAndValueArgConversion(self):
        """
        Generates arguments for methods that require a key and value. Helper
        functions will use a RootedVector<JS::Value>, while interface methods have
        separate JS::Values.
        """
        r = self.appendKeyArgConversion()
        if self.helperImpl:
            return self.mergeTuples(r, ([], ["argv[1]"], []))
        return self.mergeTuples(
            r, ([self.appendArgConversion("arg1")], ["arg1Val"], [])
        )

    def appendIteratorResult(self):
        """
        Generate code to output JSObject* return values, needed for functions that
        return iterators. Iterators cannot currently be wrapped via Xrays. If
        something that would return an iterator is called via Xray, fail early.
        """
        # TODO: Bug 1173651 - Remove check once bug 1023984 is fixed.
        code = CGGeneric(
            dedent(
                """
            // TODO (Bug 1173651): Xrays currently cannot wrap iterators. Change
            // after bug 1023984 is fixed.
            if (xpc::WrapperFactory::IsXrayWrapper(obj)) {
              JS_ReportErrorASCII(cx, "Xray wrapping of iterators not supported.");
              return false;
            }
            JS::Rooted<JSObject*> result(cx);
            JS::Rooted<JS::Value> v(cx);
            """
            )
        )
        arguments = "&v"
        setResult = CGGeneric(
            dedent(
                """
            result = &v.toObject();
            """
            )
        )
        return ([code], [arguments], [setResult])

    def appendSelfResult(self):
        """
        Generate code to return the interface object itself.
        """
        code = CGGeneric(
            dedent(
                """
            JS::Rooted<JSObject*> result(cx);
            """
            )
        )
        setResult = CGGeneric(
            dedent(
                """
            result = obj;
            """
            )
        )
        return ([code], [], [setResult])

    def appendBoolResult(self):
        if self.helperImpl:
            return ([CGGeneric("bool retVal;\n")], ["&retVal"], [])
        return ([CGGeneric("bool result;\n")], ["&result"], [])

    def forEach(self):
        """
        void forEach(callback c, any thisval);

        ForEach takes a callback, and a possible value to use as 'this'. The
        callback needs to take value, key, and the interface object
        implementing maplike/setlike. In order to make sure that the third arg
        is our interface object instead of the map/set backing object, we
        create a js function with the callback and original object in its
        storage slots, then use a helper function in BindingUtils to make sure
        the callback is called correctly.
        """
        assert not self.helperImpl
        code = [
            CGGeneric(
                dedent(
                    """
            // Create a wrapper function.
            JSFunction* func = js::NewFunctionWithReserved(cx, ForEachHandler, 3, 0, nullptr);
            if (!func) {
              return false;
            }
            JS::Rooted<JSObject*> funcObj(cx, JS_GetFunctionObject(func));
            JS::Rooted<JS::Value> funcVal(cx, JS::ObjectValue(*funcObj));
            js::SetFunctionNativeReserved(funcObj, FOREACH_CALLBACK_SLOT,
                                          JS::ObjectValue(*arg0));
            js::SetFunctionNativeReserved(funcObj, FOREACH_MAPLIKEORSETLIKEOBJ_SLOT,
                                          JS::ObjectValue(*obj));
            """
                )
            )
        ]
        arguments = ["funcVal", "arg1"]
        return (code, arguments, [])

    def set(self):
        """
        object set(key, value);

        Maplike only function, takes key and sets value to it, returns
        interface object unless being called from a C++ helper.
        """
        assert self.maplikeOrSetlike.isMaplike()
        r = self.appendKeyAndValueArgConversion()
        if self.helperImpl:
            return r
        return self.mergeTuples(r, self.appendSelfResult())

    def add(self):
        """
        object add(value);

        Setlike only function, adds value to set, returns interface object
        unless being called from a C++ helper
        """
        assert self.maplikeOrSetlike.isSetlike()
        r = self.appendKeyArgConversion()
        if self.helperImpl:
            return r
        return self.mergeTuples(r, self.appendSelfResult())

    def get(self):
        """
        type? get(key);

        Retrieves a value from a backing object based on the key. Returns value
        if key is in backing object, undefined otherwise.
        """
        assert self.maplikeOrSetlike.isMaplike()
        r = self.appendKeyArgConversion()

        code = []
        # We don't need to create the result variable because it'll be created elsewhere
        # for JSObject Get method
        if not self.helperImpl or not self.helperImpl.needsScopeBody():
            code = [
                CGGeneric(
                    dedent(
                        """
                        JS::Rooted<JS::Value> result(cx);
                        """
                    )
                )
            ]

        arguments = ["&result"]
        return self.mergeTuples(r, (code, arguments, []))

    def has(self):
        """
        bool has(key);

        Check if an entry exists in the backing object. Returns true if value
        exists in backing object, false otherwise.
        """
        return self.mergeTuples(self.appendKeyArgConversion(), self.appendBoolResult())

    def keys(self):
        """
        object keys();

        Returns new object iterator with all keys from backing object.
        """
        return self.appendIteratorResult()

    def values(self):
        """
        object values();

        Returns new object iterator with all values from backing object.
        """
        return self.appendIteratorResult()

    def entries(self):
        """
        object entries();

        Returns new object iterator with all keys and values from backing
        object. Keys will be null for set.
        """
        return self.appendIteratorResult()

    def clear(self):
        """
        void clear();

        Removes all entries from map/set.
        """
        return ([], [], [])

    def delete(self):
        """
        bool delete(key);

        Deletes an entry from the backing object. Returns true if value existed
        in backing object, false otherwise.
        """
        return self.mergeTuples(self.appendKeyArgConversion(), self.appendBoolResult())

    def define(self):
        return self.cgRoot.define()


class CGHelperFunctionGenerator(CallbackMember):
    """
    Generates code to allow C++ to perform operations. Gets a context from the
    binding wrapper, turns arguments into JS::Values (via
    CallbackMember/CGNativeMember argument conversion), then uses
    getCall to generate the body for getting result, and maybe convert the
    result into return type (via CallbackMember/CGNativeMember result
    conversion)
    """

    class HelperFunction(CGAbstractMethod):
        """
        Generates context retrieval code and rooted JSObject for interface for
        method generator to use
        """

        def __init__(self, descriptor, name, args, code, returnType):
            self.code = code
            CGAbstractMethod.__init__(self, descriptor, name, returnType, args)

        def definition_body(self):
            return self.code

    def __init__(
        self,
        descriptor,
        name,
        args,
        returnType=BuiltinTypes[IDLBuiltinType.Types.undefined],
        needsResultConversion=True,
    ):
        assert returnType.isType()
        self.needsResultConversion = needsResultConversion

        # Run CallbackMember init function to generate argument conversion code.
        # wrapScope is set to 'obj' when generating maplike or setlike helper
        # functions, as we don't have access to the CallbackPreserveColor
        # method.
        CallbackMember.__init__(
            self,
            [returnType, args],
            name,
            descriptor,
            False,
            wrapScope="obj",
            passJSBitsAsNeeded=typeNeedsCx(returnType),
        )

        # Wrap CallbackMember body code into a CGAbstractMethod to make
        # generation easier.
        self.implMethod = CGHelperFunctionGenerator.HelperFunction(
            descriptor, name, self.args, self.body, self.returnType
        )

    def getCallSetup(self):
        # If passJSBitsAsNeeded is true, it means the caller will provide a
        # JSContext, so we don't need to create JSContext and enter
        # UnprivilegedJunkScopeOrWorkerGlobal here.
        code = "MOZ_ASSERT(self);\n"
        if not self.passJSBitsAsNeeded:
            code += dedent(
                """
                AutoJSAPI jsapi;
                jsapi.Init();
                JSContext* cx = jsapi.cx();
                // It's safe to use UnprivilegedJunkScopeOrWorkerGlobal here because
                // all we want is to wrap into _some_ scope and then unwrap to find
                // the reflector, and wrapping has no side-effects.
                JSObject* scope = UnprivilegedJunkScopeOrWorkerGlobal(fallible);
                if (!scope) {
                  aRv.Throw(NS_ERROR_UNEXPECTED);
                  return%s;
                }
                JSAutoRealm tempRealm(cx, scope);
                """
                % self.getDefaultRetval()
            )

        code += dedent(
            """
            JS::Rooted<JS::Value> v(cx);
            if(!ToJSValue(cx, self, &v)) {
              aRv.Throw(NS_ERROR_UNEXPECTED);
              return%s;
            }
            // This is a reflector, but due to trying to name things
            // similarly across method generators, it's called obj here.
            JS::Rooted<JSObject*> obj(cx);
            obj = js::UncheckedUnwrap(&v.toObject(), /* stopAtWindowProxy = */ false);
            """
            % self.getDefaultRetval()
        )

        # We'd like wrap the inner code in a scope such that the code can use the
        # same realm. So here we are creating the result variable outside of the
        # scope.
        if self.needsScopeBody():
            code += "JS::Rooted<JS::Value> result(cx);\n"

        return code

    def getArgs(self, returnType, argList):
        # We don't need the context or the value. We'll generate those instead.
        args = CGNativeMember.getArgs(self, returnType, argList)
        # Prepend a pointer to the binding object onto the arguments
        return [Argument(self.descriptorProvider.nativeType + "*", "self")] + args

    def needsScopeBody(self):
        return self.passJSBitsAsNeeded

    def getArgvDeclFailureCode(self):
        return "aRv.Throw(NS_ERROR_UNEXPECTED);\n"

    def getResultConversion(self):
        if self.needsResultConversion:
            code = ""
            if self.needsScopeBody():
                code = dedent(
                    """
                    if (!JS_WrapValue(cx, &result)) {
                      aRv.NoteJSContextException(cx);
                      return;
                    }
                    """
                )

            failureCode = dedent("aRv.Throw(NS_ERROR_UNEXPECTED);\nreturn nullptr;\n")

            exceptionCode = None
            if self.retvalType.isPrimitive():
                exceptionCode = dedent(
                    "aRv.NoteJSContextException(cx);\nreturn%s;\n"
                    % self.getDefaultRetval()
                )

            return code + CallbackMember.getResultConversion(
                self,
                "result",
                failureCode=failureCode,
                isDefinitelyObject=True,
                exceptionCode=exceptionCode,
            )

        assignRetval = string.Template(
            self.getRetvalInfo(self.retvalType, False)[2]
        ).substitute(
            {
                "declName": "retVal",
            }
        )
        return assignRetval

    def getRvalDecl(self):
        # hack to make sure we put JSAutoRealm inside the body scope
        return "JSAutoRealm reflectorRealm(cx, obj);\n"

    def getArgcDecl(self):
        # Don't need argc for anything.
        return None

    def getCall(self):
        assert False  # Override me!

    def getPrettyName(self):
        return self.name

    def declare(self):
        return self.implMethod.declare()

    def define(self):
        return self.implMethod.define()


class CGMaplikeOrSetlikeHelperFunctionGenerator(CGHelperFunctionGenerator):
    """
    Generates code to allow C++ to perform operations on backing objects. Gets
    a context from the binding wrapper, turns arguments into JS::Values (via
    CallbackMember/CGNativeMember argument conversion), then uses
    CGMaplikeOrSetlikeMethodGenerator to generate the body.
    """

    def __init__(
        self,
        descriptor,
        maplikeOrSetlike,
        name,
        needsKeyArg=False,
        needsValueArg=False,
        needsValueTypeReturn=False,
        needsBoolReturn=False,
        needsResultConversion=True,
    ):
        self.maplikeOrSetlike = maplikeOrSetlike
        self.needsValueTypeReturn = needsValueTypeReturn

        args = []
        if needsKeyArg:
            args.append(FakeArgument(maplikeOrSetlike.keyType, "aKey"))
        if needsValueArg:
            assert needsKeyArg
            assert not needsValueTypeReturn
            args.append(FakeArgument(maplikeOrSetlike.valueType, "aValue"))

        returnType = BuiltinTypes[IDLBuiltinType.Types.undefined]
        if needsBoolReturn:
            returnType = BuiltinTypes[IDLBuiltinType.Types.boolean]
        elif needsValueTypeReturn:
            returnType = maplikeOrSetlike.valueType

        CGHelperFunctionGenerator.__init__(
            self,
            descriptor,
            name,
            args,
            returnType,
            needsResultConversion,
        )

    def getCall(self):
        return CGMaplikeOrSetlikeMethodGenerator(
            self.descriptorProvider,
            self.maplikeOrSetlike,
            self.name.lower(),
            self.needsValueTypeReturn,
            helperImpl=self,
        ).define()


class CGMaplikeOrSetlikeHelperGenerator(CGNamespace):
    """
    Declares and defines convenience methods for accessing backing objects on
    setlike/maplike interface. Generates function signatures, un/packs
    backing objects from slot, etc.
    """

    def __init__(self, descriptor, maplikeOrSetlike):
        self.descriptor = descriptor
        # Since iterables are folded in with maplike/setlike, make sure we've
        # got the right type here.
        assert maplikeOrSetlike.isMaplike() or maplikeOrSetlike.isSetlike()
        self.maplikeOrSetlike = maplikeOrSetlike
        self.namespace = "%sHelpers" % (
            self.maplikeOrSetlike.maplikeOrSetlikeOrIterableType.title()
        )
        self.helpers = [
            CGMaplikeOrSetlikeHelperFunctionGenerator(
                descriptor, maplikeOrSetlike, "Clear"
            ),
            CGMaplikeOrSetlikeHelperFunctionGenerator(
                descriptor,
                maplikeOrSetlike,
                "Delete",
                needsKeyArg=True,
                needsBoolReturn=True,
                needsResultConversion=False,
            ),
            CGMaplikeOrSetlikeHelperFunctionGenerator(
                descriptor,
                maplikeOrSetlike,
                "Has",
                needsKeyArg=True,
                needsBoolReturn=True,
                needsResultConversion=False,
            ),
        ]
        if self.maplikeOrSetlike.isMaplike():
            self.helpers.append(
                CGMaplikeOrSetlikeHelperFunctionGenerator(
                    descriptor,
                    maplikeOrSetlike,
                    "Set",
                    needsKeyArg=True,
                    needsValueArg=True,
                )
            )
            self.helpers.append(
                CGMaplikeOrSetlikeHelperFunctionGenerator(
                    descriptor,
                    maplikeOrSetlike,
                    "Get",
                    needsKeyArg=True,
                    needsValueTypeReturn=True,
                )
            )
        else:
            assert self.maplikeOrSetlike.isSetlike()
            self.helpers.append(
                CGMaplikeOrSetlikeHelperFunctionGenerator(
                    descriptor, maplikeOrSetlike, "Add", needsKeyArg=True
                )
            )
        CGNamespace.__init__(self, self.namespace, CGList(self.helpers))


class CGIterableMethodGenerator(CGGeneric):
    """
    Creates methods for iterable interfaces. Unwrapping/wrapping
    will be taken care of by the usual method generation machinery in
    CGMethodCall/CGPerSignatureCall. Functionality is filled in here instead of
    using CGCallGenerator.
    """

    def __init__(self, descriptor, methodName, args):
        if methodName == "forEach":
            assert len(args) == 2

            CGGeneric.__init__(
                self,
                fill(
                    """
                if (!JS::IsCallable(arg0)) {
                  cx.ThrowErrorMessage<MSG_NOT_CALLABLE>("Argument 1");
                  return false;
                }
                JS::RootedValueArray<3> callArgs(cx);
                callArgs[2].setObject(*obj);
                JS::Rooted<JS::Value> ignoredReturnVal(cx);
                auto GetKeyAtIndex = &${selfType}::GetKeyAtIndex;
                auto GetValueAtIndex = &${selfType}::GetValueAtIndex;
                for (size_t i = 0; i < self->GetIterableLength(); ++i) {
                  if (!CallIterableGetter(cx, GetValueAtIndex, self, i,
                                          callArgs[0])) {
                    return false;
                  }
                  if (!CallIterableGetter(cx, GetKeyAtIndex, self, i,
                                          callArgs[1])) {
                    return false;
                  }
                  if (!JS::Call(cx, arg1, arg0, JS::HandleValueArray(callArgs),
                                &ignoredReturnVal)) {
                    return false;
                  }
                }
                """,
                    ifaceName=descriptor.interface.identifier.name,
                    selfType=descriptor.nativeType,
                ),
            )
            return

        if descriptor.interface.isIterable():
            assert descriptor.interface.maplikeOrSetlikeOrIterable.isPairIterator()
            assert len(args) == 0

            wrap = f"{descriptor.interface.identifier.name}Iterator_Binding::Wrap"
            iterClass = f"mozilla::dom::binding_detail::WrappableIterableIterator<{descriptor.nativeType}, &{wrap}>"
        else:
            needReturnMethod = toStringBool(
                descriptor.interface.maplikeOrSetlikeOrIterable.getExtendedAttribute(
                    "GenerateReturnMethod"
                )
                is not None
            )
            wrap = f"{descriptor.interface.identifier.name}AsyncIterator_Binding::Wrap"
            iterClass = f"mozilla::dom::binding_detail::WrappableAsyncIterableIterator<{descriptor.nativeType}, {needReturnMethod}, &{wrap}>"

        createIterator = fill(
            """
            typedef ${iterClass} itrType;
            RefPtr<itrType> result(new itrType(self,
                                               itrType::IteratorType::${itrMethod}));
            """,
            iterClass=iterClass,
            itrMethod=methodName.title(),
        )

        if descriptor.interface.isAsyncIterable():
            args.append("initError")
            createIterator = fill(
                """
                $*{createIterator}
                {
                  ErrorResult initError;
                  self->InitAsyncIteratorData(result->Data(), itrType::IteratorType::${itrMethod}, ${args});
                  if (initError.MaybeSetPendingException(cx, "Asynchronous iterator initialization steps for ${ifaceName} failed")) {
                    return false;
                  }
                }
                """,
                createIterator=createIterator,
                itrMethod=methodName.title(),
                args=", ".join(args),
                ifaceName=descriptor.interface.identifier.name,
            )

        CGGeneric.__init__(self, createIterator)


def getObservableArrayBackingObject(descriptor, attr, errorReturn="return false;\n"):
    """
    Generate code to get/create a JS backing list for an observableArray attribute
    from the declaration slot.
    """
    assert attr.isAttr()
    assert attr.type.isObservableArray()

    # GetObservableArrayBackingObject may return a wrapped object for Xrays, so
    # when we create it we need to unwrap it to store the interface in the
    # reserved slot.
    return fill(
        """
        JS::Rooted<JSObject*> backingObj(cx);
        bool created = false;
        if (!GetObservableArrayBackingObject(cx, obj, ${slot},
                &backingObj, &created, ${namespace}::ObservableArrayProxyHandler::getInstance(),
                self)) {
          $*{errorReturn}
        }
        if (created) {
          PreserveWrapper(self);
        }
        """,
        namespace=toBindingNamespace(MakeNativeName(attr.identifier.name)),
        slot=memberReservedSlot(attr, descriptor),
        errorReturn=errorReturn,
        selfType=descriptor.nativeType,
    )


def getObservableArrayGetterBody(descriptor, attr):
    """
    Creates the body for the getter method of an observableArray attribute.
    """
    assert attr.type.isObservableArray()
    return fill(
        """
        $*{getBackingObj}
        MOZ_ASSERT(!JS_IsExceptionPending(cx));
        args.rval().setObject(*backingObj);
        return true;
        """,
        getBackingObj=getObservableArrayBackingObject(descriptor, attr),
    )


class CGObservableArrayProxyHandler_callback(ClassMethod):
    """
    Base class for declaring and defining the hook methods for ObservableArrayProxyHandler
    subclasses to get the interface native object from backing object and calls
    its On{Set|Delete}* callback.

     * 'callbackType': "Set" or "Delete".
     * 'invalidTypeFatal' (optional): If True, we don't expect the type
                                      conversion would fail, so generate the
                                      assertion code if type conversion fails.
    """

    def __init__(
        self, descriptor, attr, name, args, callbackType, invalidTypeFatal=False
    ):
        assert attr.isAttr()
        assert attr.type.isObservableArray()
        assert callbackType in ["Set", "Delete"]
        self.descriptor = descriptor
        self.attr = attr
        self.innertype = attr.type.inner
        self.callbackType = callbackType
        self.invalidTypeFatal = invalidTypeFatal
        ClassMethod.__init__(
            self,
            name,
            "bool",
            args,
            visibility="protected",
            virtual=True,
            override=True,
            const=True,
        )

    def preConversion(self):
        """
        The code to run before the conversion steps.
        """
        return ""

    def preCallback(self):
        """
        The code to run before calling the callback.
        """
        return ""

    def postCallback(self):
        """
        The code to run after calling the callback, all subclasses should override
        this to generate the return values.
        """
        assert False  # Override me!

    def getBody(self):
        exceptionCode = (
            fill(
                """
                MOZ_ASSERT_UNREACHABLE("The item in ObservableArray backing list is not ${innertype}?");
                return false;
                """,
                innertype=self.innertype,
            )
            if self.invalidTypeFatal
            else None
        )
        convertType = instantiateJSToNativeConversion(
            getJSToNativeConversionInfo(
                self.innertype,
                self.descriptor,
                sourceDescription="Element in ObservableArray backing list",
                exceptionCode=exceptionCode,
            ),
            {
                "declName": "decl",
                "holderName": "holder",
                "val": "aValue",
            },
        )
        callbackArgs = ["decl", "aIndex", "rv"]
        if typeNeedsCx(self.innertype):
            callbackArgs.insert(0, "cx")
        return fill(
            """
            MOZ_ASSERT(IsObservableArrayProxy(aProxy));
            $*{preConversion}

            BindingCallContext cx(aCx, "ObservableArray ${name}");
            $*{convertType}

            $*{preCallback}
            JS::Value val = js::GetProxyReservedSlot(aProxy, OBSERVABLE_ARRAY_DOM_INTERFACE_SLOT);
            auto* interface = static_cast<${ifaceType}*>(val.toPrivate());
            MOZ_ASSERT(interface);

            ErrorResult rv;
            MOZ_KnownLive(interface)->${methodName}(${callbackArgs});
            $*{postCallback}
            """,
            preConversion=self.preConversion(),
            name=self.name,
            convertType=convertType.define(),
            preCallback=self.preCallback(),
            ifaceType=self.descriptor.nativeType,
            methodName="On%s%s"
            % (self.callbackType, MakeNativeName(self.attr.identifier.name)),
            callbackArgs=", ".join(callbackArgs),
            postCallback=self.postCallback(),
        )


class CGObservableArrayProxyHandler_OnDeleteItem(
    CGObservableArrayProxyHandler_callback
):
    """
    Declares and defines the hook methods for ObservableArrayProxyHandler
    subclasses to get the interface native object from backing object and calls
    its OnDelete* callback.
    """

    def __init__(self, descriptor, attr):
        args = [
            Argument("JSContext*", "aCx"),
            Argument("JS::Handle<JSObject*>", "aProxy"),
            Argument("JS::Handle<JS::Value>", "aValue"),
            Argument("uint32_t", "aIndex"),
        ]
        CGObservableArrayProxyHandler_callback.__init__(
            self,
            descriptor,
            attr,
            "OnDeleteItem",
            args,
            "Delete",
            True,
        )

    def postCallback(self):
        return dedent(
            """
            return !rv.MaybeSetPendingException(cx);
            """
        )


class CGObservableArrayProxyHandler_SetIndexedValue(
    CGObservableArrayProxyHandler_callback
):
    """
    Declares and defines the hook methods for ObservableArrayProxyHandler
    subclasses to run the setting the indexed value steps.
    """

    def __init__(self, descriptor, attr):
        args = [
            Argument("JSContext*", "aCx"),
            Argument("JS::Handle<JSObject*>", "aProxy"),
            Argument("JS::Handle<JSObject*>", "aBackingList"),
            Argument("uint32_t", "aIndex"),
            Argument("JS::Handle<JS::Value>", "aValue"),
            Argument("JS::ObjectOpResult&", "aResult"),
        ]
        CGObservableArrayProxyHandler_callback.__init__(
            self,
            descriptor,
            attr,
            "SetIndexedValue",
            args,
            "Set",
        )

    def preConversion(self):
        return dedent(
            """
            uint32_t oldLen;
            if (!JS::GetArrayLength(aCx, aBackingList, &oldLen)) {
              return false;
            }

            if (aIndex > oldLen) {
              return aResult.failBadIndex();
            }
            """
        )

    def preCallback(self):
        return dedent(
            """
            if (aIndex < oldLen) {
              JS::Rooted<JS::Value> value(aCx);
              if (!JS_GetElement(aCx, aBackingList, aIndex, &value)) {
                return false;
              }

              if (!OnDeleteItem(aCx, aProxy, value, aIndex)) {
                return false;
              }
            }

            """
        )

    def postCallback(self):
        return dedent(
            """
            if (rv.MaybeSetPendingException(cx)) {
              return false;
            }

            if (!JS_SetElement(aCx, aBackingList, aIndex, aValue)) {
              return false;
            }

            return aResult.succeed();
            """
        )


class CGObservableArrayProxyHandler(CGThing):
    """
    A class for declaring a ObservableArrayProxyHandler.
    """

    def __init__(self, descriptor, attr):
        assert attr.isAttr()
        assert attr.type.isObservableArray()
        methods = [
            # The item stored in backing object should always be converted successfully.
            CGObservableArrayProxyHandler_OnDeleteItem(descriptor, attr),
            CGObservableArrayProxyHandler_SetIndexedValue(descriptor, attr),
            CGJSProxyHandler_getInstance("ObservableArrayProxyHandler"),
        ]
        parentClass = "mozilla::dom::ObservableArrayProxyHandler"
        self.proxyHandler = CGClass(
            "ObservableArrayProxyHandler",
            bases=[ClassBase(parentClass)],
            constructors=[],
            methods=methods,
        )

    def declare(self):
        # Our class declaration should happen when we're defining
        return ""

    def define(self):
        return self.proxyHandler.declare() + "\n" + self.proxyHandler.define()


class CGObservableArrayProxyHandlerGenerator(CGNamespace):
    """
    Declares and defines convenience methods for accessing backing list objects
    for observable array attribute. Generates function signatures, un/packs
    backing list objects from slot, etc.
    """

    def __init__(self, descriptor, attr):
        assert attr.isAttr()
        assert attr.type.isObservableArray()
        namespace = toBindingNamespace(MakeNativeName(attr.identifier.name))
        proxyHandler = CGObservableArrayProxyHandler(descriptor, attr)
        CGNamespace.__init__(self, namespace, proxyHandler)


class CGObservableArraySetterGenerator(CGGeneric):
    """
    Creates setter for an observableArray attributes.
    """

    def __init__(self, descriptor, attr):
        assert attr.isAttr()
        assert attr.type.isObservableArray()
        getBackingObject = getObservableArrayBackingObject(descriptor, attr)
        setElement = dedent(
            """
            if (!JS_SetElement(cx, backingObj, i, val)) {
              return false;
            }
            """
        )
        conversion = wrapForType(
            attr.type.inner,
            descriptor,
            {
                "result": "arg0.ElementAt(i)",
                "successCode": setElement,
                "jsvalRef": "val",
                "jsvalHandle": "&val",
            },
        )
        CGGeneric.__init__(
            self,
            fill(
                """
                if (xpc::WrapperFactory::IsXrayWrapper(obj)) {
                  JS_ReportErrorASCII(cx, "Accessing from Xray wrapper is not supported.");
                  return false;
                }

                ${getBackingObject}
                const ObservableArrayProxyHandler* handler = GetObservableArrayProxyHandler(backingObj);
                if (!handler->SetLength(cx, backingObj, 0)) {
                  return false;
                }

                JS::Rooted<JS::Value> val(cx);
                for (size_t i = 0; i < arg0.Length(); i++) {
                  $*{conversion}
                }
                """,
                conversion=conversion,
                getBackingObject=getBackingObject,
            ),
        )


class CGObservableArrayHelperFunctionGenerator(CGHelperFunctionGenerator):
    """
    Generates code to allow C++ to perform operations on backing objects. Gets
    a context from the binding wrapper, turns arguments into JS::Values (via
    CallbackMember/CGNativeMember argument conversion), then uses
    MethodBodyGenerator to generate the body.
    """

    class MethodBodyGenerator(CGThing):
        """
        Creates methods body for observable array attribute. It is expected that all
        methods will be have a maplike/setlike object attached. Unwrapping/wrapping
        will be taken care of by the usual method generation machinery in
        CGMethodCall/CGPerSignatureCall. Functionality is filled in here instead of
        using CGCallGenerator.
        """

        def __init__(
            self,
            descriptor,
            attr,
            methodName,
            helperGenerator,
            needsIndexArg,
        ):
            assert attr.isAttr()
            assert attr.type.isObservableArray()

            CGThing.__init__(self)
            self.helperGenerator = helperGenerator
            self.cgRoot = CGList([])

            self.cgRoot.append(
                CGGeneric(
                    getObservableArrayBackingObject(
                        descriptor,
                        attr,
                        dedent(
                            """
                            aRv.Throw(NS_ERROR_UNEXPECTED);
                            return%s;
                            """
                            % helperGenerator.getDefaultRetval()
                        ),
                    )
                )
            )

            # Generates required code for the method. Method descriptions included
            # in definitions below. Throw if we don't have a method to fill in what
            # we're looking for.
            try:
                methodGenerator = getattr(self, methodName)
            except AttributeError:
                raise TypeError(
                    "Missing observable array method definition '%s'" % methodName
                )
            # Method generator returns tuple, containing:
            #
            # - a list of CGThings representing setup code for preparing to call
            #   the JS API function
            # - JS API function name
            # - a list of arguments needed for the JS API function we're calling
            # - a list of CGThings representing code needed before return.
            (setupCode, funcName, arguments, returnCode) = methodGenerator()

            # Append the list of setup code CGThings
            self.cgRoot.append(CGList(setupCode))
            # Create the JS API call
            if needsIndexArg:
                arguments.insert(0, "aIndex")
            self.cgRoot.append(
                CGWrapper(
                    CGGeneric(
                        fill(
                            """
                            aRv.MightThrowJSException();
                            if (!${funcName}(${args})) {
                              aRv.StealExceptionFromJSContext(cx);
                              return${retval};
                            }
                            """,
                            funcName=funcName,
                            args=", ".join(["cx", "backingObj"] + arguments),
                            retval=helperGenerator.getDefaultRetval(),
                        )
                    )
                )
            )
            # Append code before return
            self.cgRoot.append(CGList(returnCode))

        def elementat(self):
            setupCode = []
            if not self.helperGenerator.needsScopeBody():
                setupCode.append(CGGeneric("JS::Rooted<JS::Value> result(cx);\n"))
            returnCode = [
                CGGeneric(
                    fill(
                        """
                        if (result.isUndefined()) {
                          aRv.Throw(NS_ERROR_NOT_AVAILABLE);
                          return${retval};
                        }
                        """,
                        retval=self.helperGenerator.getDefaultRetval(),
                    )
                )
            ]
            return (setupCode, "JS_GetElement", ["&result"], returnCode)

        def replaceelementat(self):
            setupCode = [
                CGGeneric(
                    fill(
                        """
                        uint32_t length;
                        aRv.MightThrowJSException();
                        if (!JS::GetArrayLength(cx, backingObj, &length)) {
                          aRv.StealExceptionFromJSContext(cx);
                          return${retval};
                        }
                        if (aIndex > length) {
                          aRv.ThrowRangeError("Invalid index");
                          return${retval};
                        }
                        """,
                        retval=self.helperGenerator.getDefaultRetval(),
                    )
                )
            ]
            return (setupCode, "JS_SetElement", ["argv[0]"], [])

        def appendelement(self):
            setupCode = [
                CGGeneric(
                    fill(
                        """
                        uint32_t length;
                        aRv.MightThrowJSException();
                        if (!JS::GetArrayLength(cx, backingObj, &length)) {
                          aRv.StealExceptionFromJSContext(cx);
                          return${retval};
                        }
                        """,
                        retval=self.helperGenerator.getDefaultRetval(),
                    )
                )
            ]
            return (setupCode, "JS_SetElement", ["length", "argv[0]"], [])

        def removelastelement(self):
            setupCode = [
                CGGeneric(
                    fill(
                        """
                        uint32_t length;
                        aRv.MightThrowJSException();
                        if (!JS::GetArrayLength(cx, backingObj, &length)) {
                          aRv.StealExceptionFromJSContext(cx);
                          return${retval};
                        }
                        if (length == 0) {
                          aRv.Throw(NS_ERROR_NOT_AVAILABLE);
                          return${retval};
                        }
                        """,
                        retval=self.helperGenerator.getDefaultRetval(),
                    )
                )
            ]
            return (setupCode, "JS::SetArrayLength", ["length - 1"], [])

        def length(self):
            return (
                [CGGeneric("uint32_t retVal;\n")],
                "JS::GetArrayLength",
                ["&retVal"],
                [],
            )

        def define(self):
            return self.cgRoot.define()

    def __init__(
        self,
        descriptor,
        attr,
        name,
        returnType=BuiltinTypes[IDLBuiltinType.Types.undefined],
        needsResultConversion=True,
        needsIndexArg=False,
        needsValueArg=False,
    ):
        assert attr.isAttr()
        assert attr.type.isObservableArray()
        self.attr = attr
        self.needsIndexArg = needsIndexArg

        args = []
        if needsValueArg:
            args.append(FakeArgument(attr.type.inner, "aValue"))

        CGHelperFunctionGenerator.__init__(
            self,
            descriptor,
            name,
            args,
            returnType,
            needsResultConversion,
        )

    def getArgs(self, returnType, argList):
        if self.needsIndexArg:
            argList = [
                FakeArgument(BuiltinTypes[IDLBuiltinType.Types.unsigned_long], "aIndex")
            ] + argList
        return CGHelperFunctionGenerator.getArgs(self, returnType, argList)

    def getCall(self):
        return CGObservableArrayHelperFunctionGenerator.MethodBodyGenerator(
            self.descriptorProvider,
            self.attr,
            self.name.lower(),
            self,
            self.needsIndexArg,
        ).define()


class CGObservableArrayHelperGenerator(CGNamespace):
    """
    Declares and defines convenience methods for accessing backing object for
    observable array type. Generates function signatures, un/packs
    backing objects from slot, etc.
    """

    def __init__(self, descriptor, attr):
        assert attr.isAttr()
        assert attr.type.isObservableArray()

        namespace = "%sHelpers" % MakeNativeName(attr.identifier.name)
        helpers = [
            CGObservableArrayHelperFunctionGenerator(
                descriptor,
                attr,
                "ElementAt",
                returnType=attr.type.inner,
                needsIndexArg=True,
            ),
            CGObservableArrayHelperFunctionGenerator(
                descriptor,
                attr,
                "ReplaceElementAt",
                needsIndexArg=True,
                needsValueArg=True,
            ),
            CGObservableArrayHelperFunctionGenerator(
                descriptor,
                attr,
                "AppendElement",
                needsValueArg=True,
            ),
            CGObservableArrayHelperFunctionGenerator(
                descriptor,
                attr,
                "RemoveLastElement",
            ),
            CGObservableArrayHelperFunctionGenerator(
                descriptor,
                attr,
                "Length",
                returnType=BuiltinTypes[IDLBuiltinType.Types.unsigned_long],
                needsResultConversion=False,
            ),
        ]
        CGNamespace.__init__(self, namespace, CGList(helpers, "\n"))


class GlobalGenRoots:
    """
    Roots for global codegen.

    To generate code, call the method associated with the target, and then
    call the appropriate define/declare method.
    """

    @staticmethod
    def GeneratedAtomList(config):
        # Atom enum
        dictionaries = config.dictionaries

        structs = []

        def memberToAtomCacheMember(binaryNameFor, m):
            binaryMemberName = binaryNameFor(m)
            return ClassMember(
                CGDictionary.makeIdName(binaryMemberName),
                "PinnedStringId",
                visibility="public",
            )

        def buildAtomCacheStructure(idlobj, binaryNameFor, members):
            classMembers = [memberToAtomCacheMember(binaryNameFor, m) for m in members]
            structName = idlobj.identifier.name + "Atoms"
            return (
                structName,
                CGWrapper(
                    CGClass(
                        structName, bases=None, isStruct=True, members=classMembers
                    ),
                    post="\n",
                ),
            )

        for dict in dictionaries:
            if len(dict.members) == 0:
                continue

            structs.append(
                buildAtomCacheStructure(dict, lambda m: m.identifier.name, dict.members)
            )

        for d in config.getDescriptors(isJSImplemented=True) + config.getDescriptors(
            isCallback=True
        ):
            members = [m for m in d.interface.members if m.isAttr() or m.isMethod()]
            if d.interface.isJSImplemented() and d.interface.ctor():
                # We'll have an __init() method.
                members.append(FakeMember("__init"))
            if d.interface.isJSImplemented() and d.interface.getExtendedAttribute(
                "WantsEventListenerHooks"
            ):
                members.append(FakeMember("eventListenerAdded"))
                members.append(FakeMember("eventListenerRemoved"))
            if len(members) == 0:
                continue

            structs.append(
                buildAtomCacheStructure(
                    d.interface,
                    lambda m: d.binaryNameFor(m.identifier.name, m.isStatic()),
                    members,
                )
            )

        structs.sort()
        generatedStructs = [struct for structName, struct in structs]
        structNames = [structName for structName, struct in structs]

        mainStruct = CGWrapper(
            CGClass(
                "PerThreadAtomCache",
                bases=[ClassBase(structName) for structName in structNames],
                isStruct=True,
            ),
            post="\n",
        )

        structs = CGList(generatedStructs + [mainStruct])

        # Wrap all of that in our namespaces.
        curr = CGNamespace.build(["mozilla", "dom"], CGWrapper(structs, pre="\n"))
        curr = CGWrapper(curr, post="\n")

        # Add include statement for PinnedStringId.
        declareIncludes = ["mozilla/dom/PinnedStringId.h"]
        curr = CGHeaders([], [], [], [], declareIncludes, [], "GeneratedAtomList", curr)

        # Add include guards.
        curr = CGIncludeGuard("GeneratedAtomList", curr)

        # Add the auto-generated comment.
        curr = CGWrapper(curr, pre=AUTOGENERATED_WARNING_COMMENT)

        # Done.
        return curr

    @staticmethod
    def GeneratedEventList(config):
        eventList = CGList([])
        for generatedEvent in config.generatedEvents:
            eventList.append(
                CGGeneric(declare=("GENERATED_EVENT(%s)\n" % generatedEvent))
            )
        return eventList

    @staticmethod
    def PrototypeList(config):

        # Prototype ID enum.
        descriptorsWithPrototype = config.getDescriptors(
            hasInterfacePrototypeObject=True
        )
        protos = [d.name for d in descriptorsWithPrototype]
        idEnum = CGNamespacedEnum("id", "ID", ["_ID_Start"] + protos, [0, "_ID_Start"])
        idEnum = CGList([idEnum])

        def fieldSizeAssert(amount, jitInfoField, message):
            maxFieldValue = (
                "(uint64_t(1) << (sizeof(std::declval<JSJitInfo>().%s) * 8))"
                % jitInfoField
            )
            return CGGeneric(
                define='static_assert(%s < %s, "%s");\n\n'
                % (amount, maxFieldValue, message)
            )

        idEnum.append(
            fieldSizeAssert("id::_ID_Count", "protoID", "Too many prototypes!")
        )

        # Wrap all of that in our namespaces.
        idEnum = CGNamespace.build(
            ["mozilla", "dom", "prototypes"], CGWrapper(idEnum, pre="\n")
        )
        idEnum = CGWrapper(idEnum, post="\n")

        curr = CGList(
            [
                CGGeneric(define="#include <stdint.h>\n"),
                CGGeneric(define="#include <type_traits>\n\n"),
                CGGeneric(define='#include "js/experimental/JitInfo.h"\n\n'),
                CGGeneric(define='#include "mozilla/dom/BindingNames.h"\n\n'),
                CGGeneric(define='#include "mozilla/dom/PrototypeList.h"\n\n'),
                idEnum,
            ]
        )

        # Let things know the maximum length of the prototype chain.
        maxMacroName = "MAX_PROTOTYPE_CHAIN_LENGTH"
        maxMacro = CGGeneric(
            declare="#define " + maxMacroName + " " + str(config.maxProtoChainLength)
        )
        curr.append(CGWrapper(maxMacro, post="\n\n"))
        curr.append(
            fieldSizeAssert(
                maxMacroName, "depth", "Some inheritance chain is too long!"
            )
        )

        # Constructor ID enum.
        constructors = [d.name for d in config.getDescriptors(hasInterfaceObject=True)]
        idEnum = CGNamespacedEnum(
            "id",
            "ID",
            ["_ID_Start"] + constructors,
            ["prototypes::id::_ID_Count", "_ID_Start"],
        )

        # Wrap all of that in our namespaces.
        idEnum = CGNamespace.build(
            ["mozilla", "dom", "constructors"], CGWrapper(idEnum, pre="\n")
        )
        idEnum = CGWrapper(idEnum, post="\n")

        curr.append(idEnum)

        # Named properties object enum.
        namedPropertiesObjects = [
            d.name for d in config.getDescriptors(hasNamedPropertiesObject=True)
        ]
        idEnum = CGNamespacedEnum(
            "id",
            "ID",
            ["_ID_Start"] + namedPropertiesObjects,
            ["constructors::id::_ID_Count", "_ID_Start"],
        )

        # Wrap all of that in our namespaces.
        idEnum = CGNamespace.build(
            ["mozilla", "dom", "namedpropertiesobjects"], CGWrapper(idEnum, pre="\n")
        )
        idEnum = CGWrapper(idEnum, post="\n")

        curr.append(idEnum)

        traitsDecls = [
            CGGeneric(
                declare=dedent(
                    """
            template <prototypes::ID PrototypeID>
            struct PrototypeTraits;
            """
                )
            )
        ]
        traitsDecls.extend(CGPrototypeTraitsClass(d) for d in descriptorsWithPrototype)

        ifaceNamesWithProto = [
            d.interface.getClassName() for d in descriptorsWithPrototype
        ]
        traitsDecls.append(
            CGStringTable("NamesOfInterfacesWithProtos", ifaceNamesWithProto)
        )

        traitsDecl = CGNamespace.build(["mozilla", "dom"], CGList(traitsDecls))

        curr.append(traitsDecl)

        # Add include guards.
        curr = CGIncludeGuard("PrototypeList", curr)

        # Add the auto-generated comment.
        curr = CGWrapper(curr, pre=AUTOGENERATED_WARNING_COMMENT)

        # Done.
        return curr

    @staticmethod
    def BindingNames(config):
        declare = fill(
            """
            enum class BindingNamesOffset : uint16_t {
              $*{enumValues}
            };

            namespace binding_detail {
            extern const char sBindingNames[];
            }  // namespace binding_detail

            MOZ_ALWAYS_INLINE const char* BindingName(BindingNamesOffset aOffset) {
              return binding_detail::sBindingNames + static_cast<size_t>(aOffset);
            }
            """,
            enumValues="".join(
                "%s = %i,\n" % (BindingNamesOffsetEnum(n), o)
                for (n, o) in config.namesStringOffsets
            ),
        )
        define = fill(
            """
            namespace binding_detail {

            const char sBindingNames[] = {
              $*{namesString}
            };

            }  // namespace binding_detail

            // Making this enum bigger than a uint16_t has consequences on the size
            // of some structs (eg. WebIDLNameTableEntry) and tables. We should try
            // to avoid that.
            static_assert(EnumTypeFitsWithin<BindingNamesOffset, uint16_t>::value,
                          "Size increase");
            """,
            namesString=' "\\0"\n'.join(
                '/* %5i */ "%s"' % (o, n) for (n, o) in config.namesStringOffsets
            )
            + "\n",
        )

        curr = CGGeneric(declare=declare, define=define)
        curr = CGWrapper(curr, pre="\n", post="\n")

        curr = CGNamespace.build(["mozilla", "dom"], curr)
        curr = CGWrapper(curr, post="\n")

        curr = CGHeaders(
            [],
            [],
            [],
            [],
            ["<stddef.h>", "<stdint.h>", "mozilla/Attributes.h"],
            ["mozilla/dom/BindingNames.h", "mozilla/EnumTypeTraits.h"],
            "BindingNames",
            curr,
        )

        # Add include guards.
        curr = CGIncludeGuard("BindingNames", curr)

        # Done.
        return curr

    @staticmethod
    def RegisterBindings(config):

        curr = CGNamespace.build(
            ["mozilla", "dom"], CGGlobalNames(config.windowGlobalNames)
        )
        curr = CGWrapper(curr, post="\n")

        # Add the includes
        defineIncludes = [
            CGHeaders.getDeclarationFilename(desc.interface)
            for desc in config.getDescriptors(
                hasInterfaceObject=True, isExposedInWindow=True, register=True
            )
        ]
        defineIncludes.append("mozilla/dom/BindingNames.h")
        defineIncludes.append("mozilla/dom/WebIDLGlobalNameHash.h")
        defineIncludes.append("mozilla/dom/PrototypeList.h")
        defineIncludes.append("mozilla/PerfectHash.h")
        defineIncludes.append("js/String.h")
        curr = CGHeaders([], [], [], [], [], defineIncludes, "RegisterBindings", curr)

        # Add include guards.
        curr = CGIncludeGuard("RegisterBindings", curr)

        # Done.
        return curr

    @staticmethod
    def RegisterWorkerBindings(config):

        curr = CGRegisterWorkerBindings(config)

        # Wrap all of that in our namespaces.
        curr = CGNamespace.build(["mozilla", "dom"], CGWrapper(curr, post="\n"))
        curr = CGWrapper(curr, post="\n")

        # Add the includes
        defineIncludes = [
            CGHeaders.getDeclarationFilename(desc.interface)
            for desc in config.getDescriptors(
                hasInterfaceObject=True, register=True, isExposedInAnyWorker=True
            )
        ]

        curr = CGHeaders(
            [], [], [], [], [], defineIncludes, "RegisterWorkerBindings", curr
        )

        # Add include guards.
        curr = CGIncludeGuard("RegisterWorkerBindings", curr)

        # Done.
        return curr

    @staticmethod
    def RegisterWorkerDebuggerBindings(config):

        curr = CGRegisterWorkerDebuggerBindings(config)

        # Wrap all of that in our namespaces.
        curr = CGNamespace.build(["mozilla", "dom"], CGWrapper(curr, post="\n"))
        curr = CGWrapper(curr, post="\n")

        # Add the includes
        defineIncludes = [
            CGHeaders.getDeclarationFilename(desc.interface)
            for desc in config.getDescriptors(
                hasInterfaceObject=True, register=True, isExposedInWorkerDebugger=True
            )
        ]

        curr = CGHeaders(
            [], [], [], [], [], defineIncludes, "RegisterWorkerDebuggerBindings", curr
        )

        # Add include guards.
        curr = CGIncludeGuard("RegisterWorkerDebuggerBindings", curr)

        # Done.
        return curr

    @staticmethod
    def RegisterWorkletBindings(config):

        curr = CGRegisterWorkletBindings(config)

        # Wrap all of that in our namespaces.
        curr = CGNamespace.build(["mozilla", "dom"], CGWrapper(curr, post="\n"))
        curr = CGWrapper(curr, post="\n")

        # Add the includes
        defineIncludes = [
            CGHeaders.getDeclarationFilename(desc.interface)
            for desc in config.getDescriptors(
                hasInterfaceObject=True, register=True, isExposedInAnyWorklet=True
            )
        ]

        curr = CGHeaders(
            [], [], [], [], [], defineIncludes, "RegisterWorkletBindings", curr
        )

        # Add include guards.
        curr = CGIncludeGuard("RegisterWorkletBindings", curr)

        # Done.
        return curr

    @staticmethod
    def RegisterShadowRealmBindings(config):

        curr = CGRegisterShadowRealmBindings(config)

        # Wrap all of that in our namespaces.
        curr = CGNamespace.build(["mozilla", "dom"], CGWrapper(curr, post="\n"))
        curr = CGWrapper(curr, post="\n")

        # Add the includes
        defineIncludes = [
            CGHeaders.getDeclarationFilename(desc.interface)
            for desc in config.getDescriptors(
                hasInterfaceObject=True, register=True, isExposedInShadowRealms=True
            )
        ]

        curr = CGHeaders(
            [], [], [], [], [], defineIncludes, "RegisterShadowRealmBindings", curr
        )

        # Add include guards.
        curr = CGIncludeGuard("RegisterShadowRealmBindings", curr)

        # Done.
        return curr

    @staticmethod
    def UnionTypes(config):
        unionTypes = UnionsForFile(config, None)
        (
            includes,
            implincludes,
            declarations,
            traverseMethods,
            unlinkMethods,
            unionStructs,
        ) = UnionTypes(unionTypes, config)

        unionStructs = dependencySortDictionariesAndUnionsAndCallbacks(unionStructs)

        unions = CGList(
            traverseMethods
            + unlinkMethods
            + [CGUnionStruct(t, config) for t in unionStructs]
            + [CGUnionStruct(t, config, True) for t in unionStructs],
            "\n",
        )

        includes.add("mozilla/OwningNonNull.h")
        includes.add("mozilla/dom/UnionMember.h")
        includes.add("mozilla/dom/BindingDeclarations.h")
        # BindingUtils.h is only needed for SetToObject.
        # If it stops being inlined or stops calling CallerSubsumes
        # both this bit and the bit in CGBindingRoot can be removed.
        includes.add("mozilla/dom/BindingUtils.h")

        # Wrap all of that in our namespaces.
        curr = CGNamespace.build(["mozilla", "dom"], unions)

        curr = CGWrapper(curr, post="\n")

        builder = ForwardDeclarationBuilder()
        for className, isStruct in declarations:
            builder.add(className, isStruct=isStruct)

        curr = CGList([builder.build(), curr], "\n")

        curr = CGHeaders([], [], [], [], includes, implincludes, "UnionTypes", curr)

        # Add include guards.
        curr = CGIncludeGuard("UnionTypes", curr)

        # Done.
        return curr

    @staticmethod
    def WebIDLPrefs(config):
        prefs = set()
        headers = set(["mozilla/dom/WebIDLPrefs.h"])
        for d in config.getDescriptors(hasInterfaceOrInterfacePrototypeObject=True):
            for m in d.interface.members:
                pref = PropertyDefiner.getStringAttr(m, "Pref")
                if pref:
                    headers.add(prefHeader(pref))
                    prefs.add((pref, prefIdentifier(pref)))
        prefs = sorted(prefs)
        declare = fill(
            """
            enum class WebIDLPrefIndex : uint8_t {
              NoPref,
              $*{prefs}
            };
            typedef bool (*WebIDLPrefFunc)();
            extern const WebIDLPrefFunc sWebIDLPrefs[${len}];
            """,
            prefs=",\n".join(map(lambda p: "// " + p[0] + "\n" + p[1], prefs)) + "\n",
            len=len(prefs) + 1,
        )
        define = fill(
            """
            const WebIDLPrefFunc sWebIDLPrefs[] = {
              nullptr,
              $*{prefs}
            };
            """,
            prefs=",\n".join(
                map(lambda p: "// " + p[0] + "\nStaticPrefs::" + p[1], prefs)
            )
            + "\n",
        )
        prefFunctions = CGGeneric(declare=declare, define=define)

        # Wrap all of that in our namespaces.
        curr = CGNamespace.build(["mozilla", "dom"], prefFunctions)

        curr = CGWrapper(curr, post="\n")

        curr = CGHeaders([], [], [], [], [], headers, "WebIDLPrefs", curr)

        # Add include guards.
        curr = CGIncludeGuard("WebIDLPrefs", curr)

        # Done.
        return curr

    @staticmethod
    def WebIDLSerializable(config):
        # We need a declaration of StructuredCloneTags in the header.
        declareIncludes = set(
            [
                "mozilla/dom/DOMJSClass.h",
                "mozilla/dom/StructuredCloneTags.h",
                "js/TypeDecls.h",
            ]
        )
        defineIncludes = set(
            ["mozilla/dom/WebIDLSerializable.h", "mozilla/PerfectHash.h"]
        )
        names = list()
        for d in config.getDescriptors(isSerializable=True):
            names.append(d.name)
            defineIncludes.add(CGHeaders.getDeclarationFilename(d.interface))

        if len(names) == 0:
            # We can't really create a PerfectHash out of this, but also there's
            # not much point to this file if we have no [Serializable] objects.
            # Just spit out an empty file.
            return CGIncludeGuard("WebIDLSerializable", CGGeneric(""))

        # If we had a lot of serializable things, it might be worth it to use a
        # PerfectHash here, or an array ordered by sctag value and binary
        # search.  But setting those up would require knowing in this python
        # code the values of the various SCTAG_DOM_*.  We could hardcode them
        # here and add static asserts that the values are right, or switch to
        # code-generating StructuredCloneTags.h or something.  But in practice,
        # there's a pretty small number of serializable interfaces, and just
        # doing a linear walk is fine.  It's not obviously worse than the
        # if-cascade we used to have.  Let's just make sure we notice if we do
        # end up with a lot of serializable things here.
        #
        # Also, in practice it looks like compilers compile this linear walk to
        # an out-of-bounds check followed by a direct index into an array, by
        # basically making a second copy of this array ordered by tag, with the
        # holes filled in.  Again, worth checking whether this still happens if
        # we have too many serializable things.
        if len(names) > 20:
            raise TypeError(
                "We now have %s serializable interfaces.  "
                "Double-check that the compiler is still "
                "generating a jump table." % len(names)
            )

        entries = list()
        # Make sure we have stable ordering.
        for name in sorted(names):
            # Strip off trailing newline to make our formatting look right.
            entries.append(
                fill(
                    """
                {
                  /* mTag */ ${tag},
                  /* mDeserialize */ ${name}_Binding::Deserialize
                }
                """,
                    tag=StructuredCloneTag(name),
                    name=name,
                )[:-1]
            )

        declare = dedent(
            """
            WebIDLDeserializer LookupDeserializer(StructuredCloneTags aTag);
            """
        )
        define = fill(
            """
            struct WebIDLSerializableEntry {
              StructuredCloneTags mTag;
              WebIDLDeserializer mDeserialize;
            };

            static const WebIDLSerializableEntry sEntries[] = {
              $*{entries}
            };

            WebIDLDeserializer LookupDeserializer(StructuredCloneTags aTag) {
              for (auto& entry : sEntries) {
                if (entry.mTag == aTag) {
                  return entry.mDeserialize;
                }
              }
              return nullptr;
            }
            """,
            entries=",\n".join(entries) + "\n",
        )

        code = CGGeneric(declare=declare, define=define)

        # Wrap all of that in our namespaces.
        curr = CGNamespace.build(["mozilla", "dom"], code)

        curr = CGWrapper(curr, post="\n")

        curr = CGHeaders(
            [], [], [], [], declareIncludes, defineIncludes, "WebIDLSerializable", curr
        )

        # Add include guards.
        curr = CGIncludeGuard("WebIDLSerializable", curr)

        # Done.
        return curr


# Code generator for simple events
class CGEventGetter(CGNativeMember):
    def __init__(self, descriptor, attr):
        ea = descriptor.getExtendedAttributes(attr, getter=True)
        CGNativeMember.__init__(
            self,
            descriptor,
            attr,
            CGSpecializedGetter.makeNativeName(descriptor, attr),
            (attr.type, []),
            ea,
            resultNotAddRefed=not attr.type.isSequence(),
        )
        self.body = self.getMethodBody()

    def getArgs(self, returnType, argList):
        if "needsErrorResult" in self.extendedAttrs:
            raise TypeError("Event code generator does not support [Throws]!")
        if "canOOM" in self.extendedAttrs:
            raise TypeError("Event code generator does not support [CanOOM]!")
        if not self.member.isAttr():
            raise TypeError("Event code generator does not support methods")
        if self.member.isStatic():
            raise TypeError("Event code generators does not support static attributes")
        return CGNativeMember.getArgs(self, returnType, argList)

    def getMethodBody(self):
        type = self.member.type
        memberName = CGDictionary.makeMemberName(self.member.identifier.name)
        if (
            (type.isPrimitive() and type.tag() in builtinNames)
            or type.isEnum()
            or type.isPromise()
            or type.isGeckoInterface()
        ):
            return "return " + memberName + ";\n"
        if type.isJSString():
            # https://bugzilla.mozilla.org/show_bug.cgi?id=1580167
            raise TypeError("JSString not supported as member of a generated event")
        if (
            type.isDOMString()
            or type.isByteString()
            or type.isUSVString()
            or type.isUTF8String()
        ):
            return "aRetVal = " + memberName + ";\n"
        if type.isSpiderMonkeyInterface() or type.isObject():
            return fill(
                """
                if (${memberName}) {
                  JS::ExposeObjectToActiveJS(${memberName});
                }
                aRetVal.set(${memberName});
                return;
                """,
                memberName=memberName,
            )
        if type.isAny():
            return fill(
                """
                ${selfName}(aRetVal);
                """,
                selfName=self.name,
            )
        if type.isUnion():
            return "aRetVal = " + memberName + ";\n"
        if type.isSequence():
            if type.nullable():
                return (
                    "if ("
                    + memberName
                    + ".IsNull()) { aRetVal.SetNull(); } else { aRetVal.SetValue("
                    + memberName
                    + ".Value().Clone()); }\n"
                )
            else:
                return "aRetVal = " + memberName + ".Clone();\n"
        raise TypeError("Event code generator does not support this type!")

    def declare(self, cgClass):
        if (
            getattr(self.member, "originatingInterface", cgClass.descriptor.interface)
            != cgClass.descriptor.interface
        ):
            return ""
        return CGNativeMember.declare(self, cgClass)

    def define(self, cgClass):
        if (
            getattr(self.member, "originatingInterface", cgClass.descriptor.interface)
            != cgClass.descriptor.interface
        ):
            return ""
        return CGNativeMember.define(self, cgClass)


class CGEventSetter(CGNativeMember):
    def __init__(self):
        raise TypeError("Event code generator does not support setters!")


class CGEventMethod(CGNativeMember):
    def __init__(self, descriptor, method, signature, isConstructor, breakAfter=True):
        self.isInit = False

        CGNativeMember.__init__(
            self,
            descriptor,
            method,
            CGSpecializedMethod.makeNativeName(descriptor, method),
            signature,
            descriptor.getExtendedAttributes(method),
            breakAfter=breakAfter,
            variadicIsSequence=True,
        )
        self.originalArgs = list(self.args)

        iface = descriptor.interface
        allowed = isConstructor
        if not allowed and iface.getExtendedAttribute("LegacyEventInit"):
            # Allow it, only if it fits the initFooEvent profile exactly
            # We could check the arg types but it's not worth the effort.
            if (
                method.identifier.name == "init" + iface.identifier.name
                and signature[1][0].type.isDOMString()
                and signature[1][1].type.isBoolean()
                and signature[1][2].type.isBoolean()
                and
                # -3 on the left to ignore the type, bubbles, and cancelable parameters
                # -1 on the right to ignore the .trusted property which bleeds through
                # here because it is [Unforgeable].
                len(signature[1]) - 3
                == len([x for x in iface.members if x.isAttr()]) - 1
            ):
                allowed = True
                self.isInit = True

        if not allowed:
            raise TypeError("Event code generator does not support methods!")

    def getArgs(self, returnType, argList):
        args = [self.getArg(arg) for arg in argList]
        return args

    def getArg(self, arg):
        decl, ref = self.getArgType(
            arg.type, arg.canHaveMissingValue(), "Variadic" if arg.variadic else False
        )
        if ref:
            decl = CGWrapper(decl, pre="const ", post="&")

        name = arg.identifier.name
        name = "a" + name[0].upper() + name[1:]
        return Argument(decl.define(), name)

    def declare(self, cgClass):
        if self.isInit:
            constructorForNativeCaller = ""
        else:
            self.args = list(self.originalArgs)
            self.args.insert(0, Argument("mozilla::dom::EventTarget*", "aOwner"))
            constructorForNativeCaller = CGNativeMember.declare(self, cgClass)

        self.args = list(self.originalArgs)
        if needCx(None, self.arguments(), [], considerTypes=True, static=True):
            self.args.insert(0, Argument("JSContext*", "aCx"))
        if not self.isInit:
            self.args.insert(0, Argument("const GlobalObject&", "aGlobal"))

        return constructorForNativeCaller + CGNativeMember.declare(self, cgClass)

    def defineInit(self, cgClass):
        iface = self.descriptorProvider.interface
        members = ""
        while iface.identifier.name != "Event":
            i = 3  # Skip the boilerplate args: type, bubble,s cancelable.
            for m in iface.members:
                if m.isAttr():
                    # We need to initialize all the member variables that do
                    # not come from Event.
                    if (
                        getattr(m, "originatingInterface", iface).identifier.name
                        == "Event"
                    ):
                        continue
                    name = CGDictionary.makeMemberName(m.identifier.name)
                    members += "%s = %s;\n" % (name, self.args[i].name)
                    i += 1
            iface = iface.parent

        self.body = fill(
            """
            InitEvent(${typeArg}, ${bubblesArg}, ${cancelableArg});
            ${members}
            """,
            typeArg=self.args[0].name,
            bubblesArg=self.args[1].name,
            cancelableArg=self.args[2].name,
            members=members,
        )

        return CGNativeMember.define(self, cgClass)

    def define(self, cgClass):
        self.args = list(self.originalArgs)
        if self.isInit:
            return self.defineInit(cgClass)
        members = ""
        holdJS = ""
        iface = self.descriptorProvider.interface
        while iface.identifier.name != "Event":
            for m in self.descriptorProvider.getDescriptor(
                iface.identifier.name
            ).interface.members:
                if m.isAttr():
                    # We initialize all the other member variables in the
                    # Constructor except those ones coming from the Event.
                    if (
                        getattr(
                            m, "originatingInterface", cgClass.descriptor.interface
                        ).identifier.name
                        == "Event"
                    ):
                        continue
                    name = CGDictionary.makeMemberName(m.identifier.name)
                    if m.type.isSequence():
                        # For sequences we may not be able to do a simple
                        # assignment because the underlying types may not match.
                        # For example, the argument can be a
                        # Sequence<OwningNonNull<SomeInterface>> while our
                        # member is an nsTArray<RefPtr<SomeInterface>>.  So
                        # use AppendElements, which is actually a template on
                        # the incoming type on nsTArray and does the right thing
                        # for this case.
                        target = name
                        source = "%s.%s" % (self.args[1].name, name)
                        sequenceCopy = "e->%s.AppendElements(%s);\n"
                        if m.type.nullable():
                            sequenceCopy = CGIfWrapper(
                                CGGeneric(sequenceCopy), "!%s.IsNull()" % source
                            ).define()
                            target += ".SetValue()"
                            source += ".Value()"
                        members += sequenceCopy % (target, source)
                    elif m.type.isSpiderMonkeyInterface():
                        srcname = "%s.%s" % (self.args[1].name, name)
                        if m.type.nullable():
                            members += fill(
                                """
                                if (${srcname}.IsNull()) {
                                  e->${varname} = nullptr;
                                } else {
                                  e->${varname} = ${srcname}.Value().Obj();
                                }
                                """,
                                varname=name,
                                srcname=srcname,
                            )
                        else:
                            members += fill(
                                """
                                e->${varname}.set(${srcname}.Obj());
                                """,
                                varname=name,
                                srcname=srcname,
                            )
                    else:
                        members += "e->%s = %s.%s;\n" % (name, self.args[1].name, name)
                    if (
                        m.type.isAny()
                        or m.type.isObject()
                        or m.type.isSpiderMonkeyInterface()
                    ):
                        holdJS = "mozilla::HoldJSObjects(e.get());\n"
            iface = iface.parent

        self.body = fill(
            """
            RefPtr<${nativeType}> e = new ${nativeType}(aOwner);
            bool trusted = e->Init(aOwner);
            e->InitEvent(${eventType}, ${eventInit}.mBubbles, ${eventInit}.mCancelable);
            $*{members}
            e->SetTrusted(trusted);
            e->SetComposed(${eventInit}.mComposed);
            $*{holdJS}
            return e.forget();
            """,
            nativeType=self.descriptorProvider.nativeType.split("::")[-1],
            eventType=self.args[0].name,
            eventInit=self.args[1].name,
            members=members,
            holdJS=holdJS,
        )

        self.args.insert(0, Argument("mozilla::dom::EventTarget*", "aOwner"))
        constructorForNativeCaller = CGNativeMember.define(self, cgClass) + "\n"
        self.args = list(self.originalArgs)
        self.body = fill(
            """
            nsCOMPtr<mozilla::dom::EventTarget> owner = do_QueryInterface(aGlobal.GetAsSupports());
            return Constructor(owner, ${arg0}, ${arg1});
            """,
            arg0=self.args[0].name,
            arg1=self.args[1].name,
        )
        if needCx(None, self.arguments(), [], considerTypes=True, static=True):
            self.args.insert(0, Argument("JSContext*", "aCx"))
        self.args.insert(0, Argument("const GlobalObject&", "aGlobal"))
        return constructorForNativeCaller + CGNativeMember.define(self, cgClass)


class CGEventClass(CGBindingImplClass):
    """
    Codegen for the actual Event class implementation for this descriptor
    """

    def __init__(self, descriptor):
        CGBindingImplClass.__init__(
            self,
            descriptor,
            CGEventMethod,
            CGEventGetter,
            CGEventSetter,
            False,
            "WrapObjectInternal",
        )
        members = []
        extraMethods = []
        self.membersNeedingCC = []
        self.membersNeedingTrace = []

        for m in descriptor.interface.members:
            if (
                getattr(m, "originatingInterface", descriptor.interface)
                != descriptor.interface
            ):
                continue

            if m.isAttr():
                if m.type.isAny():
                    self.membersNeedingTrace.append(m)
                    # Add a getter that doesn't need a JSContext.  Note that we
                    # don't need to do this if our originating interface is not
                    # the descriptor's interface, because in that case we
                    # wouldn't generate the getter that _does_ need a JSContext
                    # either.
                    extraMethods.append(
                        ClassMethod(
                            CGSpecializedGetter.makeNativeName(descriptor, m),
                            "void",
                            [Argument("JS::MutableHandle<JS::Value>", "aRetVal")],
                            const=True,
                            body=fill(
                                """
                                JS::ExposeValueToActiveJS(${memberName});
                                aRetVal.set(${memberName});
                                """,
                                memberName=CGDictionary.makeMemberName(
                                    m.identifier.name
                                ),
                            ),
                        )
                    )
                elif m.type.isObject() or m.type.isSpiderMonkeyInterface():
                    self.membersNeedingTrace.append(m)
                elif typeNeedsRooting(m.type):
                    raise TypeError(
                        "Need to implement tracing for event member of type %s" % m.type
                    )
                elif idlTypeNeedsCycleCollection(m.type):
                    self.membersNeedingCC.append(m)

                nativeType = self.getNativeTypeForIDLType(m.type).define()
                members.append(
                    ClassMember(
                        CGDictionary.makeMemberName(m.identifier.name),
                        nativeType,
                        visibility="private",
                        body="body",
                    )
                )

        parent = self.descriptor.interface.parent
        self.parentType = self.descriptor.getDescriptor(
            parent.identifier.name
        ).nativeType.split("::")[-1]
        self.nativeType = self.descriptor.nativeType.split("::")[-1]

        if self.needCC():
            isupportsDecl = fill(
                """
                NS_DECL_ISUPPORTS_INHERITED
                NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED(${nativeType}, ${parentType})
                """,
                nativeType=self.nativeType,
                parentType=self.parentType,
            )
        else:
            isupportsDecl = fill(
                """
                NS_INLINE_DECL_REFCOUNTING_INHERITED(${nativeType}, ${parentType})
                """,
                nativeType=self.nativeType,
                parentType=self.parentType,
            )

        baseDeclarations = fill(
            """
            public:
              $*{isupportsDecl}

            protected:
              virtual ~${nativeType}();
              explicit ${nativeType}(mozilla::dom::EventTarget* aOwner);

            """,
            isupportsDecl=isupportsDecl,
            nativeType=self.nativeType,
            parentType=self.parentType,
        )

        className = self.nativeType
        asConcreteTypeMethod = ClassMethod(
            "As%s" % className,
            "%s*" % className,
            [],
            virtual=True,
            body="return this;\n",
            breakAfterReturnDecl=" ",
            override=True,
        )
        extraMethods.append(asConcreteTypeMethod)

        CGClass.__init__(
            self,
            className,
            bases=[ClassBase(self.parentType)],
            methods=extraMethods + self.methodDecls,
            members=members,
            extradeclarations=baseDeclarations,
        )

    def getWrapObjectBody(self):
        return (
            "return %s_Binding::Wrap(aCx, this, aGivenProto);\n" % self.descriptor.name
        )

    def needCC(self):
        return len(self.membersNeedingCC) != 0 or len(self.membersNeedingTrace) != 0

    def implTraverse(self):
        retVal = ""
        for m in self.membersNeedingCC:
            retVal += (
                "  NS_IMPL_CYCLE_COLLECTION_TRAVERSE(%s)\n"
                % CGDictionary.makeMemberName(m.identifier.name)
            )
        return retVal

    def implUnlink(self):
        retVal = ""
        for m in self.membersNeedingCC:
            retVal += (
                "  NS_IMPL_CYCLE_COLLECTION_UNLINK(%s)\n"
                % CGDictionary.makeMemberName(m.identifier.name)
            )
        for m in self.membersNeedingTrace:
            name = CGDictionary.makeMemberName(m.identifier.name)
            if m.type.isAny():
                retVal += "  tmp->" + name + ".setUndefined();\n"
            elif m.type.isObject() or m.type.isSpiderMonkeyInterface():
                retVal += "  tmp->" + name + " = nullptr;\n"
            else:
                raise TypeError("Unknown traceable member type %s" % m.type)
        return retVal

    def implTrace(self):
        retVal = ""
        for m in self.membersNeedingTrace:
            retVal += (
                "  NS_IMPL_CYCLE_COLLECTION_TRACE_JS_MEMBER_CALLBACK(%s)\n"
                % CGDictionary.makeMemberName(m.identifier.name)
            )
        return retVal

    def define(self):
        for m in self.membersNeedingTrace:
            if not (
                m.type.isAny() or m.type.isObject() or m.type.isSpiderMonkeyInterface()
            ):
                raise TypeError("Unknown traceable member type %s" % m.type)

        if len(self.membersNeedingTrace) > 0:
            dropJS = "mozilla::DropJSObjects(this);\n"
        else:
            dropJS = ""
        # Just override CGClass and do our own thing
        ctorParams = (
            "aOwner, nullptr, nullptr" if self.parentType == "Event" else "aOwner"
        )

        if self.needCC():
            classImpl = fill(
                """

                NS_IMPL_CYCLE_COLLECTION_CLASS(${nativeType})

                NS_IMPL_ADDREF_INHERITED(${nativeType}, ${parentType})
                NS_IMPL_RELEASE_INHERITED(${nativeType}, ${parentType})

                NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_INHERITED(${nativeType}, ${parentType})
                $*{traverse}
                NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END

                NS_IMPL_CYCLE_COLLECTION_TRACE_BEGIN_INHERITED(${nativeType}, ${parentType})
                $*{trace}
                NS_IMPL_CYCLE_COLLECTION_TRACE_END

                NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN_INHERITED(${nativeType}, ${parentType})
                $*{unlink}
                NS_IMPL_CYCLE_COLLECTION_UNLINK_END

                NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(${nativeType})
                NS_INTERFACE_MAP_END_INHERITING(${parentType})
                """,
                nativeType=self.nativeType,
                parentType=self.parentType,
                traverse=self.implTraverse(),
                unlink=self.implUnlink(),
                trace=self.implTrace(),
            )
        else:
            classImpl = ""

        classImpl += fill(
            """

            ${nativeType}::${nativeType}(mozilla::dom::EventTarget* aOwner)
              : ${parentType}(${ctorParams})
            {
            }

            ${nativeType}::~${nativeType}()
            {
              $*{dropJS}
            }

            """,
            nativeType=self.nativeType,
            ctorParams=ctorParams,
            parentType=self.parentType,
            dropJS=dropJS,
        )

        return classImpl + CGBindingImplClass.define(self)

    def getNativeTypeForIDLType(self, type):
        if type.isPrimitive() and type.tag() in builtinNames:
            nativeType = CGGeneric(builtinNames[type.tag()])
            if type.nullable():
                nativeType = CGTemplatedType("Nullable", nativeType)
        elif type.isEnum():
            nativeType = CGGeneric(type.unroll().inner.identifier.name)
            if type.nullable():
                nativeType = CGTemplatedType("Nullable", nativeType)
        elif type.isJSString():
            nativeType = CGGeneric("JS::Heap<JSString*>")
        elif type.isDOMString() or type.isUSVString():
            nativeType = CGGeneric("nsString")
        elif type.isByteString() or type.isUTF8String():
            nativeType = CGGeneric("nsCString")
        elif type.isPromise():
            nativeType = CGGeneric("RefPtr<Promise>")
        elif type.isGeckoInterface():
            iface = type.unroll().inner
            nativeType = self.descriptor.getDescriptor(iface.identifier.name).nativeType
            # Now trim off unnecessary namespaces
            nativeType = nativeType.split("::")
            if nativeType[0] == "mozilla":
                nativeType.pop(0)
                if nativeType[0] == "dom":
                    nativeType.pop(0)
            nativeType = CGWrapper(
                CGGeneric("::".join(nativeType)), pre="RefPtr<", post=">"
            )
        elif type.isAny():
            nativeType = CGGeneric("JS::Heap<JS::Value>")
        elif type.isObject() or type.isSpiderMonkeyInterface():
            nativeType = CGGeneric("JS::Heap<JSObject*>")
        elif type.isUnion():
            nativeType = CGGeneric(CGUnionStruct.unionTypeDecl(type, True))
        elif type.isSequence():
            if type.nullable():
                innerType = type.inner.inner
            else:
                innerType = type.inner
            if (
                not innerType.isPrimitive()
                and not innerType.isEnum()
                and not innerType.isDOMString()
                and not innerType.isByteString()
                and not innerType.isUTF8String()
                and not innerType.isPromise()
                and not innerType.isGeckoInterface()
            ):
                raise TypeError(
                    "Don't know how to properly manage GC/CC for "
                    "event member of type %s" % type
                )
            nativeType = CGTemplatedType(
                "nsTArray", self.getNativeTypeForIDLType(innerType)
            )
            if type.nullable():
                nativeType = CGTemplatedType("Nullable", nativeType)
        else:
            raise TypeError("Don't know how to declare event member of type %s" % type)
        return nativeType


class CGEventRoot(CGThing):
    def __init__(self, config, interfaceName):
        descriptor = config.getDescriptor(interfaceName)

        self.root = CGWrapper(CGEventClass(descriptor), pre="\n", post="\n")

        self.root = CGNamespace.build(["mozilla", "dom"], self.root)

        self.root = CGList(
            [CGClassForwardDeclare("JSContext", isStruct=True), self.root]
        )

        parent = descriptor.interface.parent.identifier.name

        # Throw in our #includes
        self.root = CGHeaders(
            [descriptor],
            [],
            [],
            [],
            [
                config.getDescriptor(parent).headerFile,
                "mozilla/Attributes.h",
                "mozilla/dom/%sBinding.h" % interfaceName,
                "mozilla/dom/BindingUtils.h",
            ],
            [
                "%s.h" % interfaceName,
                "js/GCAPI.h",
                "mozilla/HoldDropJSObjects.h",
                "mozilla/dom/Nullable.h",
            ],
            "",
            self.root,
            config,
        )

        # And now some include guards
        self.root = CGIncludeGuard(interfaceName, self.root)

        self.root = CGWrapper(
            self.root,
            pre=(
                AUTOGENERATED_WITH_SOURCE_WARNING_COMMENT
                % os.path.basename(descriptor.interface.filename())
            ),
        )

        self.root = CGWrapper(
            self.root,
            pre=dedent(
                """
            /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
            /* vim:set ts=2 sw=2 sts=2 et cindent: */
            /* This Source Code Form is subject to the terms of the Mozilla Public
             * License, v. 2.0. If a copy of the MPL was not distributed with this
             * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

            """
            ),
        )

    def declare(self):
        return self.root.declare()

    def define(self):
        return self.root.define()