File: perlintern.html

package info (click to toggle)
perl-doc-html 5.26.0-4
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 39,400 kB
  • sloc: xml: 36; makefile: 7
file content (2622 lines) | stat: -rw-r--r-- 122,977 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
  <title>perlintern - perldoc.perl.org</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  <meta http-equiv="Content-Language" content="en-gb">
  <link rel="search" type="application/opensearchdescription+xml" title="Search perldoc.perl.org" href="/static/search.xml"/>
  <link href="static/css-20100830.css" rel="stylesheet" rev="stylesheet" type="text/css" media="screen">
  <link href="static/exploreperl.css" rel="stylesheet" rev="stylesheet" type="text/css">
</head>

<body onLoad="perldoc.startup();" onPageShow="if (event.persisted) perldoc.startup();">
    <div id="page">
      
      <div id="header">
	<div id="homepage_link">
	  <a href="index.html"></a>
	</div>
	<div id="strapline">
	  Perl Programming Documentation
	</div>
	<div id="download_link" class="download">
	  <a href="http://www.perl.org/get.html">Download Perl</a>
	</div>
	<div id="explore_link" class="download">
	  <a id="explore_anchor" href="#">Explore</a>
	</div>
      </div>
      
      <div id="body">
        <div id="left_column">
          <div class="side_group">
            
	    <div class="side_panel doc_panel">
              <p>Manual</p>
              <ul>
                <li><a href="index-overview.html">Overview</a>
                <li><a href="index-tutorials.html">Tutorials</a>
                <li><a href="index-faq.html">FAQs</a>
                <li><a href="index-history.html">History / Changes</a>
                <li><a href="index-licence.html">License</a>
              </ul>
            </div>
            <div class="side_panel doc_panel">
              <p>Reference</p>
              <ul>
                <li><a href="index-language.html">Language</a>
                <li><a href="index-functions.html">Functions</a>
                <li><a href="perlop.html">Operators</a>
                <li><a href="perlvar.html">Special Variables</a>
                <li><a href="index-pragmas.html">Pragmas</a>
                <li><a href="index-utilities.html">Utilities</a>
                <li><a href="index-internals.html">Internals</a>
                <li><a href="index-platforms.html">Platform Specific</a>
              </ul>
            </div>
            <div class="side_panel doc_panel">
              <p>Modules</p>
              <ul>
		<li>
		
                
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		
                  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		
                  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		    
		  
		
                  
		
                  
		
                  
		    
		  
		
                  
		
                  
		
		
                    <a href="index-modules-A.html">A</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-B.html">B</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-C.html">C</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-D.html">D</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-E.html">E</a>
                    
                      
                        <li>
                      
                    
                
                    <a href="index-modules-F.html">F</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-G.html">G</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-H.html">H</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-I.html">I</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-L.html">L</a>
                    
                      
                        <li>
                      
                    
                
                    <a href="index-modules-M.html">M</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-N.html">N</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-O.html">O</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-P.html">P</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-S.html">S</a>
                    
                      
                        <li>
                      
                    
                
                    <a href="index-modules-T.html">T</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-U.html">U</a>
                    
                      
                        &bull;
                      
                    
                
                    <a href="index-modules-X.html">X</a>
                    
                
              </ul>
            </div>
            
	      <div class="side_panel doc_panel">
		<p>Tools</p>
		<ul>
		  <li><a href="preferences.html">Preferences</a>
		</ul>
	      </div>
            
          </div>
        </div>
        <div id="centre_column">
          <div id="content_header">
            <div id="title_bar">
              <div id="page_name">
                <h1>perlintern</h1>
              </div>
              <div id="perl_version">
                Perl 5 version 26.0 documentation
              </div>
              <div class="page_links" id="page_links_top">
                <a href="#" onClick="toolbar.goToTop();return false;">Go to top</a>
		
              </div>
	      <div class="page_links" id="page_links_bottom">
		
                  <a href="#" id="page_index_toggle">Show page index</a> &bull;
		
                <a href="#" id="recent_pages_toggle">Show recent pages</a>		
	      </div>
	      <div id="search_form">
		<form action="search.html" method="GET" id="search">
		  <input type="text" name="q" id="search_box" alt="Search">
		</form>
	      </div>
            </div>
            <div id="breadcrumbs">
                
    <a href="index.html">Home</a> &gt;
    
      
        <a href="index-internals.html">Internals and C language interface</a> &gt;
      
    
    perlintern
  

            </div>
          </div>
          <div id="content_body">
	    <!--[if lt IE 7]>
 <div class="noscript">
   <p>
     <strong>It looks like you're using Internet Explorer 6. This is a very old
     browser which does not offer full support for modern websites.</strong>
   </p>
   <p>
     Unfortunately this means that this website will not work on
     your computer.
   </p>
   <p>
     Don't miss out though! To view the site (and get a better experience from
     many other websites), simply upgrade to
     <a href="http://www.microsoft.com/windows/Internet-explorer/default.aspx">Internet
Explorer 8</a>
     or download an alternative browser such as
     <a href="http://www.mozilla.com/en-US/firefox/firefox.html">Firefox</a>,
     <a href="http://www.apple.com/safari/download/">Safari</a>, or
     <a href="http://www.google.co.uk/chrome">Google Chrome</a>.
   </p>
   <p>
     All of these browsers are free. If you're using a PC at work, you may
     need to contact your IT administrator.
   </p>
 </div>
<![endif]-->
	    <noscript>
	      <div class="noscript">
	      <p>
                <strong>Please note: Many features of this site require JavaScript. You appear to have JavaScript disabled,
	        or are running a non-JavaScript capable web browser.</strong>
	      </p>
	      <p>
		To get the best experience, please enable JavaScript or download a modern web browser such as <a href="http://www.microsoft.com/windows/Internet-explorer/default.aspx">Internet Explorer 8</a>, <a href="http://www.mozilla.com/en-US/firefox/firefox.html">Firefox</a>, <a href="http://www.apple.com/safari/download/">Safari</a>, or <a href="http://www.google.co.uk/chrome">Google Chrome</a>.
              </p>
	      </div>
	    </noscript>

	    <div id="recent_pages" class="hud_container">
	      <div id="recent_pages_header" class="hud_header">
		<div id="recent_pages_close" class="hud_close"><a href="#" onClick="recentPages.hide();return false;"></a></div>
		<div id="recent_pages_title" class="hud_title"><span class="hud_span_top">Recently read</span></div>
		<div id="recent_pages_topright" class="hud_topright"></div>
	      </div>
	      <div id="recent_pages_content" class="hud_content">
	      </div>
	      <div id="recent_pages_footer" class="hud_footer">
		<div id="recent_pages_bottomleft" class="hud_bottomleft"></div>
		<div id="recent_pages_bottom" class="hud_bottom"><span class="hud_span_bottom"></span></div>
		<div id="recent_pages_resize" class="hud_resize"></div>
	      </div>
	    </div>
  
	    <div id="from_search"></div>
            <h1>perlintern</h1>


  <!--    -->
<ul><li><a href="#NAME">NAME</a><li><a href="#DESCRIPTION">DESCRIPTION
 </a><li><a href="#Compile-time-scope-hooks">Compile-time scope hooks</a><li><a href="#Custom-Operators">Custom Operators</a><li><a href="#CV-Manipulation-Functions">CV Manipulation Functions</a><li><a href="#CV-reference-counts-and-CvOUTSIDE">CV reference counts and CvOUTSIDE</a><li><a href="#Embedding-Functions">Embedding Functions</a><li><a href="#GV-Functions">GV Functions</a><li><a href="#Hash-Manipulation-Functions">Hash Manipulation Functions</a><li><a href="#IO-Functions">IO Functions</a><li><a href="#Lexer-interface">Lexer interface</a><li><a href="#Magical-Functions">Magical Functions</a><li><a href="#Miscellaneous-Functions">Miscellaneous Functions</a><li><a href="#MRO-Functions">MRO Functions</a><li><a href="#Optree-Manipulation-Functions">Optree Manipulation Functions</a><li><a href="#Pad-Data-Structures">Pad Data Structures</a><li><a href="#Per-Interpreter-Variables">Per-Interpreter Variables</a><li><a href="#Stack-Manipulation-Macros">Stack Manipulation Macros</a><li><a href="#SV-Body-Allocation">SV-Body Allocation</a><li><a href="#SV-Manipulation-Functions">SV Manipulation Functions</a><li><a href="#Unicode-Support">Unicode Support</a><li><a href="#Undocumented-functions">Undocumented functions</a><li><a href="#AUTHORS">AUTHORS</a><li><a href="#SEE-ALSO">SEE ALSO</a></ul><a name="NAME"></a><h1>NAME</h1>
<p>perlintern - autogenerated documentation of purely <b>internal</b>
		 Perl functions</p>
<a name="DESCRIPTION"></a><h1>DESCRIPTION
 </h1>
<p>This file is the autogenerated documentation of functions in the
Perl interpreter that are documented using Perl's internal documentation
format but are not marked as part of the Perl API.  In other words,
<b>they are not for use in extensions</b>!</p>
<a name="Compile-time-scope-hooks"></a><h1>Compile-time scope hooks</h1>
<ul>
<li><a name="BhkENTRY"></a><b>BhkENTRY
</b>
<p>NOTE: this function is experimental and may change or be
removed without notice.</p>
<p>Return an entry from the BHK structure.  <code class="inline"><span class="w">which</span></code>
 is a preprocessor token
indicating which entry to return.  If the appropriate flag is not set
this will return <code class="inline"><span class="w">NULL</span></code>
.  The type of the return value depends on which
entry you ask for.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span> *	<span class="i">BhkENTRY</span><span class="s">(</span><span class="w">BHK</span> *<span class="w">hk</span><span class="cm">,</span> <span class="w">which</span><span class="s">)</span></li></ol></pre></li>
<li><a name="BhkFLAGS"></a><b>BhkFLAGS
</b>
<p>NOTE: this function is experimental and may change or be
removed without notice.</p>
<p>Return the BHK's flags.</p>
<pre class="verbatim"><ol><li>	<span class="w">U32</span>	<span class="i">BhkFLAGS</span><span class="s">(</span><span class="w">BHK</span> *<span class="w">hk</span><span class="s">)</span></li></ol></pre></li>
<li><a name="CALL_BLOCK_HOOKS"></a><b>CALL_BLOCK_HOOKS
</b>
<p>NOTE: this function is experimental and may change or be
removed without notice.</p>
<p>Call all the registered block hooks for type <code class="inline"><span class="w">which</span></code>
.  <code class="inline"><span class="w">which</span></code>
 is a
preprocessing token; the type of <code class="inline"><span class="w">arg</span></code>
 depends on <code class="inline"><span class="w">which</span></code>
.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">CALL_BLOCK_HOOKS</span><span class="s">(</span><span class="w">which</span><span class="cm">,</span> <span class="w">arg</span><span class="s">)</span></li></ol></pre></li>
</ul>
<a name="Custom-Operators"></a><h1>Custom Operators</h1>
<ul>
<li><a name="core_prototype"></a><b>core_prototype
</b>
<p>This function assigns the prototype of the named core function to <code class="inline"><span class="w">sv</span></code>
, or
to a new mortal SV if <code class="inline"><span class="w">sv</span></code>
 is <code class="inline"><span class="w">NULL</span></code>
.  It returns the modified <code class="inline"><span class="w">sv</span></code>
, or
<code class="inline"><span class="w">NULL</span></code>
 if the core function has no prototype.  <code class="inline"><span class="w">code</span></code>
 is a code as returned
by <code class="inline"><span class="i">keyword</span><span class="s">(</span><span class="s">)</span></code>
.  It must not be equal to 0.</p>
<pre class="verbatim"><ol><li>	<span class="w">SV</span> *	<span class="i">core_prototype</span><span class="s">(</span><span class="w">SV</span> *<span class="w">sv</span><span class="cm">,</span> <span class="w">const</span> <span class="w">char</span> *<span class="w">name</span><span class="cm">,</span></li><li>		               <span class="w">const</span> <a class="l_k" href="functions/int.html">int</a> <span class="w">code</span><span class="cm">,</span></li><li>		               <a class="l_k" href="functions/int.html">int</a> <span class="i">* const</span> <span class="w">opnum</span><span class="s">)</span></li></ol></pre></li>
</ul>
<a name="CV-Manipulation-Functions"></a><h1>CV Manipulation Functions</h1>
<ul>
<li><a name="docatch"></a><b>docatch
</b>
<p>Check for the cases 0 or 3 of cur_env.je_ret, only used inside an eval context.</p>
<p>0 is used as continue inside eval,</p>
<p>3 is used for a die caught by an inner eval - continue inner loop</p>
<p>See <i>cop.h</i>: je_mustcatch, when set at any runlevel to TRUE, means eval ops must
establish a local jmpenv to handle exception traps.</p>
<pre class="verbatim"><ol><li>	<span class="w">OP</span>*	<span class="i">docatch</span><span class="s">(</span><span class="w">OP</span> *<span class="w">o</span><span class="s">)</span></li></ol></pre></li>
</ul>
<a name="CV-reference-counts-and-CvOUTSIDE"></a><h1>CV reference counts and CvOUTSIDE</h1>
<ul>
<li><a name="CvWEAKOUTSIDE"></a><b>CvWEAKOUTSIDE
</b>
<p>Each CV has a pointer, <code class="inline"><span class="i">CvOUTSIDE</span><span class="s">(</span><span class="s">)</span></code>
, to its lexically enclosing
CV (if any).  Because pointers to anonymous sub prototypes are
stored in <code class="inline"><span class="i">&amp;</span></code>
 pad slots, it is a possible to get a circular reference,
with the parent pointing to the child and vice-versa.  To avoid the
ensuing memory leak, we do not increment the reference count of the CV
pointed to by <code class="inline"><span class="w">CvOUTSIDE</span></code>
 in the <i>one specific instance</i> that the parent
has a <code class="inline"><span class="i">&amp;</span></code>
 pad slot pointing back to us.  In this case, we set the
<code class="inline"><span class="w">CvWEAKOUTSIDE</span></code>
 flag in the child.  This allows us to determine under what
circumstances we should decrement the refcount of the parent when freeing
the child.</p>
<p>There is a further complication with non-closure anonymous subs (i.e. those
that do not refer to any lexicals outside that sub).  In this case, the
anonymous prototype is shared rather than being cloned.  This has the
consequence that the parent may be freed while there are still active
children, <i>e.g.</i>,</p>
<pre class="verbatim"><ol><li>    BEGIN <span class="s">{</span> <span class="i">$a</span> = <a class="l_k" href="functions/sub.html">sub</a> <span class="s">{</span> <a class="l_k" href="functions/eval.html">eval</a> <span class="q">&#39;$x&#39;</span> <span class="s">}</span> <span class="s">}</span></li></ol></pre><p>In this case, the BEGIN is freed immediately after execution since there
are no active references to it: the anon sub prototype has
<code class="inline"><span class="w">CvWEAKOUTSIDE</span></code>
 set since it's not a closure, and $a points to the same
CV, so it doesn't contribute to BEGIN's refcount either.  When $a is
executed, the <code class="inline"><a class="l_k" href="functions/eval.html">eval</a> <span class="q">&#39;$x&#39;</span></code>
 causes the chain of <code class="inline"><span class="w">CvOUTSIDE</span></code>
s to be followed,
and the freed BEGIN is accessed.</p>
<p>To avoid this, whenever a CV and its associated pad is freed, any
<code class="inline"><span class="i">&amp;</span></code>
 entries in the pad are explicitly removed from the pad, and if the
refcount of the pointed-to anon sub is still positive, then that
child's <code class="inline"><span class="w">CvOUTSIDE</span></code>
 is set to point to its grandparent.  This will only
occur in the single specific case of a non-closure anon prototype
having one or more active references (such as <code class="inline"><span class="i">$a</span></code>
 above).</p>
<p>One other thing to consider is that a CV may be merely undefined
rather than freed, eg <code class="inline"><a class="l_k" href="functions/undef.html">undef</a> <span class="i">&amp;foo</span></code>
.  In this case, its refcount may
not have reached zero, but we still delete its pad and its <code class="inline"><span class="w">CvROOT</span></code>
 etc.
Since various children may still have their <code class="inline"><span class="w">CvOUTSIDE</span></code>
 pointing at this
undefined CV, we keep its own <code class="inline"><span class="w">CvOUTSIDE</span></code>
 for the time being, so that
the chain of lexical scopes is unbroken.  For example, the following
should print 123:</p>
<pre class="verbatim"><ol><li>    <a class="l_k" href="functions/my.html">my</a> <span class="i">$x</span> = <span class="n">123</span><span class="sc">;</span></li><li><a name="tmp"></a>    sub <span class="m">tmp</span> <span class="s">{</span> <a class="l_k" href="functions/sub.html">sub</a> <span class="s">{</span> <a class="l_k" href="functions/eval.html">eval</a> <span class="q">&#39;$x&#39;</span> <span class="s">}</span> <span class="s">}</span></li><li>    <a class="l_k" href="functions/my.html">my</a> <span class="i">$a</span> = <span class="i">tmp</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span></li><li>    <a class="l_k" href="functions/undef.html">undef</a> <span class="i">&amp;tmp</span><span class="sc">;</span></li><li>    <a class="l_k" href="functions/print.html">print</a>  <span class="i">$a</span>-&gt;<span class="s">(</span><span class="s">)</span><span class="sc">;</span></li><li></li><li>	<span class="w">bool</span>	<span class="i">CvWEAKOUTSIDE</span><span class="s">(</span><span class="w">CV</span> *<span class="w">cv</span><span class="s">)</span></li></ol></pre></li>
</ul>
<a name="Embedding-Functions"></a><h1>Embedding Functions</h1>
<ul>
<li><a name="cv_dump"></a><b>cv_dump
</b>
<p>dump the contents of a CV</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">cv_dump</span><span class="s">(</span><span class="w">CV</span> *<span class="w">cv</span><span class="cm">,</span> <span class="w">const</span> <span class="w">char</span> *<span class="w">title</span><span class="s">)</span></li></ol></pre></li>
<li><a name="cv_forget_slab"></a><b>cv_forget_slab
</b>
<p>When a CV has a reference count on its slab (<code class="inline"><span class="w">CvSLABBED</span></code>
), it is responsible
for making sure it is freed.  (Hence, no two CVs should ever have a
reference count on the same slab.)  The CV only needs to reference the slab
during compilation.  Once it is compiled and <code class="inline"><span class="w">CvROOT</span></code>
 attached, it has
finished its job, so it can forget the slab.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">cv_forget_slab</span><span class="s">(</span><span class="w">CV</span> *<span class="w">cv</span><span class="s">)</span></li></ol></pre></li>
<li><a name="do_dump_pad"></a><b>do_dump_pad
</b>
<p>Dump the contents of a padlist</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">do_dump_pad</span><span class="s">(</span><span class="w">I32</span> <span class="w">level</span><span class="cm">,</span> <span class="w">PerlIO</span> *<span class="w">file</span><span class="cm">,</span></li><li>		            <span class="w">PADLIST</span> *<span class="w">padlist</span><span class="cm">,</span> <a class="l_k" href="functions/int.html">int</a> <span class="w">full</span><span class="s">)</span></li></ol></pre></li>
<li><a name="pad_alloc_name"></a><b>pad_alloc_name
</b>
<p>Allocates a place in the currently-compiling
pad (via <a href="perlapi.html#pad_alloc">pad_alloc in perlapi</a>) and
then stores a name for that entry.  <code class="inline"><span class="w">name</span></code>
 is adopted and
becomes the name entry; it must already contain the name
string.  <code class="inline"><span class="w">typestash</span></code>
 and <code class="inline"><span class="w">ourstash</span></code>
 and the <code class="inline"><span class="w">padadd_STATE</span></code>

flag get added to <code class="inline"><span class="w">name</span></code>
.  None of the other
processing of <a href="perlapi.html#pad_add_name_pvn">pad_add_name_pvn in perlapi</a>
is done.  Returns the offset of the allocated pad slot.</p>
<pre class="verbatim"><ol><li>	<span class="w">PADOFFSET</span> <span class="i">pad_alloc_name</span><span class="s">(</span><span class="w">PADNAME</span> *<span class="w">name</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">flags</span><span class="cm">,</span></li><li>	                         <span class="w">HV</span> *<span class="w">typestash</span><span class="cm">,</span> <span class="w">HV</span> *<span class="w">ourstash</span><span class="s">)</span></li></ol></pre></li>
<li><a name="pad_block_start"></a><b>pad_block_start
</b>
<p>Update the pad compilation state variables on entry to a new block.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">pad_block_start</span><span class="s">(</span><a class="l_k" href="functions/int.html">int</a> <span class="w">full</span><span class="s">)</span></li></ol></pre></li>
<li><a name="pad_check_dup"></a><b>pad_check_dup
</b>
<p>Check for duplicate declarations: report any of:</p>
<pre class="verbatim"><ol><li>     <span class="i">* a</span> <span class="q">&#39;my&#39;</span> <span class="w">in</span> <span class="w">the</span> <span class="w">current</span> <span class="w">scope</span> <span class="w">with</span> <span class="w">the</span> <span class="w">same</span> <span class="w">name</span><span class="sc">;</span></li><li>     <span class="i">* an</span> <span class="q">&#39;our&#39;</span> <span class="s">(</span><span class="w">anywhere</span> <span class="w">in</span> <span class="w">the</span> <span class="w">pad</span><span class="s">)</span> <span class="w">with</span> <span class="w">the</span> <span class="w">same</span> <span class="w">name</span> <a class="l_k" href="functions/and.html">and</a> <span class="w">the</span></li><li>       <span class="w">same</span> <span class="w">stash</span> <span class="w">as</span> <span class="q">&#39;ourstash&#39;</span></li></ol></pre><p><code class="inline"><span class="w">is_our</span></code>
 indicates that the name to check is an <code class="inline"><span class="q">&quot;our&quot;</span></code>
 declaration.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">pad_check_dup</span><span class="s">(</span><span class="w">PADNAME</span> *<span class="w">name</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">flags</span><span class="cm">,</span></li><li>		              <span class="w">const</span> <span class="w">HV</span> *<span class="w">ourstash</span><span class="s">)</span></li></ol></pre></li>
<li><a name="pad_findlex"></a><b>pad_findlex
</b>
<p>Find a named lexical anywhere in a chain of nested pads.  Add fake entries
in the inner pads if it's found in an outer one.</p>
<p>Returns the offset in the bottom pad of the lex or the fake lex.
<code class="inline"><span class="w">cv</span></code>
 is the CV in which to start the search, and seq is the current <code class="inline"><span class="w">cop_seq</span></code>

to match against.  If <code class="inline"><a class="l_k" href="functions/warn.html">warn</a></code> is true, print appropriate warnings.  The <code class="inline"><span class="w">out_</span></code>
*
vars return values, and so are pointers to where the returned values
should be stored.  <code class="inline"><span class="w">out_capture</span></code>
, if non-null, requests that the innermost
instance of the lexical is captured; <code class="inline"><span class="w">out_name</span></code>
 is set to the innermost
matched pad name or fake pad name; <code class="inline"><span class="w">out_flags</span></code>
 returns the flags normally
associated with the <code class="inline"><span class="w">PARENT_FAKELEX_FLAGS</span></code>
 field of a fake pad name.</p>
<p>Note that <code class="inline"><span class="i">pad_findlex</span><span class="s">(</span><span class="s">)</span></code>
 is recursive; it recurses up the chain of CVs,
then comes back down, adding fake entries
as it goes.  It has to be this way
because fake names in anon protoypes have to store in <code class="inline"><span class="w">xpadn_low</span></code>
 the
index into the parent pad.</p>
<pre class="verbatim"><ol><li>	<span class="w">PADOFFSET</span> <span class="i">pad_findlex</span><span class="s">(</span><span class="w">const</span> <span class="w">char</span> *<span class="w">namepv</span><span class="cm">,</span></li><li>	                      <span class="w">STRLEN</span> <span class="w">namelen</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">flags</span><span class="cm">,</span></li><li>	                      <span class="w">const</span> <span class="w">CV</span>* <span class="w">cv</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">seq</span><span class="cm">,</span> <a class="l_k" href="functions/int.html">int</a> <a class="l_k" href="functions/warn.html">warn</a><span class="cm">,</span></li><li>	                      <span class="w">SV</span>** <span class="w">out_capture</span><span class="cm">,</span></li><li>	                      <span class="w">PADNAME</span>** <span class="w">out_name</span><span class="cm">,</span></li><li>	                      <a class="l_k" href="functions/int.html">int</a> <span class="i">*out_flags</span><span class="s">)</span></li></ol></pre></li>
<li><a name="pad_fixup_inner_anons"></a><b>pad_fixup_inner_anons
</b>
<p>For any anon CVs in the pad, change <code class="inline"><span class="w">CvOUTSIDE</span></code>
 of that CV from
<code class="inline"><span class="w">old_cv</span></code>
 to <code class="inline"><span class="w">new_cv</span></code>
 if necessary.  Needed when a newly-compiled CV has to be
moved to a pre-existing CV struct.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">pad_fixup_inner_anons</span><span class="s">(</span><span class="w">PADLIST</span> *<span class="w">padlist</span><span class="cm">,</span></li><li>		                      <span class="w">CV</span> *<span class="w">old_cv</span><span class="cm">,</span> <span class="w">CV</span> *<span class="w">new_cv</span><span class="s">)</span></li></ol></pre></li>
<li><a name="pad_free"></a><b>pad_free
</b>
<p>Free the SV at offset po in the current pad.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">pad_free</span><span class="s">(</span><span class="w">PADOFFSET</span> <span class="w">po</span><span class="s">)</span></li></ol></pre></li>
<li><a name="pad_leavemy"></a><b>pad_leavemy
</b>
<p>Cleanup at end of scope during compilation: set the max seq number for
lexicals in this scope and warn of any lexicals that never got introduced.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">pad_leavemy</span><span class="s">(</span><span class="s">)</span></li></ol></pre></li>
<li><a name="padlist_dup"></a><b>padlist_dup
</b>
<p>Duplicates a pad.</p>
<pre class="verbatim"><ol><li>	<span class="w">PADLIST</span> * <span class="i">padlist_dup</span><span class="s">(</span><span class="w">PADLIST</span> *<span class="w">srcpad</span><span class="cm">,</span></li><li>	                      <span class="w">CLONE_PARAMS</span> *<span class="w">param</span><span class="s">)</span></li></ol></pre></li>
<li><a name="padname_dup"></a><b>padname_dup
</b>
<p>Duplicates a pad name.</p>
<pre class="verbatim"><ol><li>	<span class="w">PADNAME</span> * <span class="i">padname_dup</span><span class="s">(</span><span class="w">PADNAME</span> *<span class="w">src</span><span class="cm">,</span> <span class="w">CLONE_PARAMS</span> *<span class="w">param</span><span class="s">)</span></li></ol></pre></li>
<li><a name="padnamelist_dup"></a><b>padnamelist_dup
</b>
<p>Duplicates a pad name list.</p>
<pre class="verbatim"><ol><li>	<span class="w">PADNAMELIST</span> * <span class="i">padnamelist_dup</span><span class="s">(</span><span class="w">PADNAMELIST</span> *<span class="w">srcpad</span><span class="cm">,</span></li><li>	                              <span class="w">CLONE_PARAMS</span> *<span class="w">param</span><span class="s">)</span></li></ol></pre></li>
<li><a name="pad_push"></a><b>pad_push
</b>
<p>Push a new pad frame onto the padlist, unless there's already a pad at
this depth, in which case don't bother creating a new one.  Then give
the new pad an <code class="inline"><span class="i">@_</span></code>
 in slot zero.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">pad_push</span><span class="s">(</span><span class="w">PADLIST</span> *<span class="w">padlist</span><span class="cm">,</span> <a class="l_k" href="functions/int.html">int</a> <span class="w">depth</span><span class="s">)</span></li></ol></pre></li>
<li><a name="pad_reset"></a><b>pad_reset
</b>
<p>Mark all the current temporaries for reuse</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">pad_reset</span><span class="s">(</span><span class="s">)</span></li></ol></pre></li>
<li><a name="pad_swipe"></a><b>pad_swipe
</b>
<p>Abandon the tmp in the current pad at offset <code class="inline"><span class="w">po</span></code>
 and replace with a
new one.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">pad_swipe</span><span class="s">(</span><span class="w">PADOFFSET</span> <span class="w">po</span><span class="cm">,</span> <span class="w">bool</span> <span class="w">refadjust</span><span class="s">)</span></li></ol></pre></li>
</ul>
<a name="GV-Functions"></a><h1>GV Functions</h1>
<ul>
<li><a name="gv_try_downgrade"></a><b>gv_try_downgrade
</b>
<p>NOTE: this function is experimental and may change or be
removed without notice.</p>
<p>If the typeglob <code class="inline"><span class="w">gv</span></code>
 can be expressed more succinctly, by having
something other than a real GV in its place in the stash, replace it
with the optimised form.  Basic requirements for this are that <code class="inline"><span class="w">gv</span></code>

is a real typeglob, is sufficiently ordinary, and is only referenced
from its package.  This function is meant to be used when a GV has been
looked up in part to see what was there, causing upgrading, but based
on what was found it turns out that the real GV isn't required after all.</p>
<p>If <code class="inline"><span class="w">gv</span></code>
 is a completely empty typeglob, it is deleted from the stash.</p>
<p>If <code class="inline"><span class="w">gv</span></code>
 is a typeglob containing only a sufficiently-ordinary constant
sub, the typeglob is replaced with a scalar-reference placeholder that
more compactly represents the same thing.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">gv_try_downgrade</span><span class="s">(</span><span class="w">GV</span>* <span class="w">gv</span><span class="s">)</span></li></ol></pre></li>
</ul>
<a name="Hash-Manipulation-Functions"></a><h1>Hash Manipulation Functions</h1>
<ul>
<li><a name="hv_ename_add"></a><b>hv_ename_add
</b>
<p>Adds a name to a stash's internal list of effective names.  See
<code class="inline"><a href="#hv_ename_delete">hv_ename_delete</a></code>.</p>
<p>This is called when a stash is assigned to a new location in the symbol
table.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">hv_ename_add</span><span class="s">(</span><span class="w">HV</span> *<span class="w">hv</span><span class="cm">,</span> <span class="w">const</span> <span class="w">char</span> *<span class="w">name</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">len</span><span class="cm">,</span></li><li>		             <span class="w">U32</span> <span class="w">flags</span><span class="s">)</span></li></ol></pre></li>
<li><a name="hv_ename_delete"></a><b>hv_ename_delete
</b>
<p>Removes a name from a stash's internal list of effective names.  If this is
the name returned by <code class="inline"><span class="w">HvENAME</span></code>
, then another name in the list will take
its place (<code class="inline"><span class="w">HvENAME</span></code>
 will use it).</p>
<p>This is called when a stash is deleted from the symbol table.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">hv_ename_delete</span><span class="s">(</span><span class="w">HV</span> *<span class="w">hv</span><span class="cm">,</span> <span class="w">const</span> <span class="w">char</span> *<span class="w">name</span><span class="cm">,</span></li><li>		                <span class="w">U32</span> <span class="w">len</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">flags</span><span class="s">)</span></li></ol></pre></li>
<li><a name="refcounted_he_chain_2hv"></a><b>refcounted_he_chain_2hv
</b>
<p>Generates and returns a <code class="inline"><span class="w">HV</span> *</code>
 representing the content of a
<code class="inline"><span class="w">refcounted_he</span></code>
 chain.
<code class="inline"><span class="w">flags</span></code>
 is currently unused and must be zero.</p>
<pre class="verbatim"><ol><li>	<span class="w">HV</span> *	<span class="i">refcounted_he_chain_2hv</span><span class="s">(</span></li><li>		    <span class="w">const</span> <span class="w">struct</span> <span class="w">refcounted_he</span> *<span class="w">c</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">flags</span></li><li>		<span class="s">)</span></li></ol></pre></li>
<li><a name="refcounted_he_fetch_pv"></a><b>refcounted_he_fetch_pv
</b>
<p>Like <a href="#refcounted_he_fetch_pvn">refcounted_he_fetch_pvn</a>, but takes a nul-terminated string
instead of a string/length pair.</p>
<pre class="verbatim"><ol><li>	<span class="w">SV</span> *	<span class="i">refcounted_he_fetch_pv</span><span class="s">(</span></li><li>		    <span class="w">const</span> <span class="w">struct</span> <span class="w">refcounted_he</span> *<span class="w">chain</span><span class="cm">,</span></li><li>		    <span class="w">const</span> <span class="w">char</span> *<span class="w">key</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">hash</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">flags</span></li><li>		<span class="s">)</span></li></ol></pre></li>
<li><a name="refcounted_he_fetch_pvn"></a><b>refcounted_he_fetch_pvn
</b>
<p>Search along a <code class="inline"><span class="w">refcounted_he</span></code>
 chain for an entry with the key specified
by <code class="inline"><span class="w">keypv</span></code>
 and <code class="inline"><span class="w">keylen</span></code>
.  If <code class="inline"><span class="w">flags</span></code>
 has the <code class="inline"><span class="w">REFCOUNTED_HE_KEY_UTF8</span></code>

bit set, the key octets are interpreted as UTF-8, otherwise they
are interpreted as Latin-1.  <code class="inline"><span class="w">hash</span></code>
 is a precomputed hash of the key
string, or zero if it has not been precomputed.  Returns a mortal scalar
representing the value associated with the key, or <code class="inline"><span class="i">&amp;PL_sv_placeholder</span></code>

if there is no value associated with the key.</p>
<pre class="verbatim"><ol><li>	<span class="w">SV</span> *	<span class="i">refcounted_he_fetch_pvn</span><span class="s">(</span></li><li>		    <span class="w">const</span> <span class="w">struct</span> <span class="w">refcounted_he</span> *<span class="w">chain</span><span class="cm">,</span></li><li>		    <span class="w">const</span> <span class="w">char</span> *<span class="w">keypv</span><span class="cm">,</span> <span class="w">STRLEN</span> <span class="w">keylen</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">hash</span><span class="cm">,</span></li><li>		    <span class="w">U32</span> <span class="w">flags</span></li><li>		<span class="s">)</span></li></ol></pre></li>
<li><a name="refcounted_he_fetch_pvs"></a><b>refcounted_he_fetch_pvs
</b>
<p>Like <a href="#refcounted_he_fetch_pvn">refcounted_he_fetch_pvn</a>, but takes a <code class="inline"><span class="w">NUL</span></code>
-terminated literal string
instead of a string/length pair, and no precomputed hash.</p>
<pre class="verbatim"><ol><li>	<span class="w">SV</span> *	<span class="i">refcounted_he_fetch_pvs</span><span class="s">(</span></li><li>		    <span class="w">const</span> <span class="w">struct</span> <span class="w">refcounted_he</span> *<span class="w">chain</span><span class="cm">,</span></li><li>		    <span class="w">const</span> <span class="w">char</span> *<span class="w">key</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">flags</span></li><li>		<span class="s">)</span></li></ol></pre></li>
<li><a name="refcounted_he_fetch_sv"></a><b>refcounted_he_fetch_sv
</b>
<p>Like <a href="#refcounted_he_fetch_pvn">refcounted_he_fetch_pvn</a>, but takes a Perl scalar instead of a
string/length pair.</p>
<pre class="verbatim"><ol><li>	<span class="w">SV</span> *	<span class="i">refcounted_he_fetch_sv</span><span class="s">(</span></li><li>		    <span class="w">const</span> <span class="w">struct</span> <span class="w">refcounted_he</span> *<span class="w">chain</span><span class="cm">,</span> <span class="w">SV</span> *<span class="w">key</span><span class="cm">,</span></li><li>		    <span class="w">U32</span> <span class="w">hash</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">flags</span></li><li>		<span class="s">)</span></li></ol></pre></li>
<li><a name="refcounted_he_free"></a><b>refcounted_he_free
</b>
<p>Decrements the reference count of a <code class="inline"><span class="w">refcounted_he</span></code>
 by one.  If the
reference count reaches zero the structure's memory is freed, which
(recursively) causes a reduction of its parent <code class="inline"><span class="w">refcounted_he</span></code>
's
reference count.  It is safe to pass a null pointer to this function:
no action occurs in this case.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">refcounted_he_free</span><span class="s">(</span><span class="w">struct</span> <span class="w">refcounted_he</span> *<span class="w">he</span><span class="s">)</span></li></ol></pre></li>
<li><a name="refcounted_he_inc"></a><b>refcounted_he_inc
</b>
<p>Increment the reference count of a <code class="inline"><span class="w">refcounted_he</span></code>
.  The pointer to the
<code class="inline"><span class="w">refcounted_he</span></code>
 is also returned.  It is safe to pass a null pointer
to this function: no action occurs and a null pointer is returned.</p>
<pre class="verbatim"><ol><li>	<span class="w">struct</span> <span class="w">refcounted_he</span> * <span class="i">refcounted_he_inc</span><span class="s">(</span></li><li>	                           <span class="w">struct</span> <span class="w">refcounted_he</span> *<span class="w">he</span></li><li>	                       <span class="s">)</span></li></ol></pre></li>
<li><a name="refcounted_he_new_pv"></a><b>refcounted_he_new_pv
</b>
<p>Like <a href="#refcounted_he_new_pvn">refcounted_he_new_pvn</a>, but takes a nul-terminated string instead
of a string/length pair.</p>
<pre class="verbatim"><ol><li>	<span class="w">struct</span> <span class="w">refcounted_he</span> * <span class="i">refcounted_he_new_pv</span><span class="s">(</span></li><li>	                           <span class="w">struct</span> <span class="w">refcounted_he</span> *<span class="w">parent</span><span class="cm">,</span></li><li>	                           <span class="w">const</span> <span class="w">char</span> *<span class="w">key</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">hash</span><span class="cm">,</span></li><li>	                           <span class="w">SV</span> *<span class="w">value</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">flags</span></li><li>	                       <span class="s">)</span></li></ol></pre></li>
<li><a name="refcounted_he_new_pvn"></a><b>refcounted_he_new_pvn
</b>
<p>Creates a new <code class="inline"><span class="w">refcounted_he</span></code>
.  This consists of a single key/value
pair and a reference to an existing <code class="inline"><span class="w">refcounted_he</span></code>
 chain (which may
be empty), and thus forms a longer chain.  When using the longer chain,
the new key/value pair takes precedence over any entry for the same key
further along the chain.</p>
<p>The new key is specified by <code class="inline"><span class="w">keypv</span></code>
 and <code class="inline"><span class="w">keylen</span></code>
.  If <code class="inline"><span class="w">flags</span></code>
 has
the <code class="inline"><span class="w">REFCOUNTED_HE_KEY_UTF8</span></code>
 bit set, the key octets are interpreted
as UTF-8, otherwise they are interpreted as Latin-1.  <code class="inline"><span class="w">hash</span></code>
 is
a precomputed hash of the key string, or zero if it has not been
precomputed.</p>
<p><code class="inline"><span class="w">value</span></code>
 is the scalar value to store for this key.  <code class="inline"><span class="w">value</span></code>
 is copied
by this function, which thus does not take ownership of any reference
to it, and later changes to the scalar will not be reflected in the
value visible in the <code class="inline"><span class="w">refcounted_he</span></code>
.  Complex types of scalar will not
be stored with referential integrity, but will be coerced to strings.
<code class="inline"><span class="w">value</span></code>
 may be either null or <code class="inline"><span class="i">&amp;PL_sv_placeholder</span></code>
 to indicate that no
value is to be associated with the key; this, as with any non-null value,
takes precedence over the existence of a value for the key further along
the chain.</p>
<p><code class="inline"><span class="w">parent</span></code>
 points to the rest of the <code class="inline"><span class="w">refcounted_he</span></code>
 chain to be
attached to the new <code class="inline"><span class="w">refcounted_he</span></code>
.  This function takes ownership
of one reference to <code class="inline"><span class="w">parent</span></code>
, and returns one reference to the new
<code class="inline"><span class="w">refcounted_he</span></code>
.</p>
<pre class="verbatim"><ol><li>	<span class="w">struct</span> <span class="w">refcounted_he</span> * <span class="i">refcounted_he_new_pvn</span><span class="s">(</span></li><li>	                           <span class="w">struct</span> <span class="w">refcounted_he</span> *<span class="w">parent</span><span class="cm">,</span></li><li>	                           <span class="w">const</span> <span class="w">char</span> *<span class="w">keypv</span><span class="cm">,</span></li><li>	                           <span class="w">STRLEN</span> <span class="w">keylen</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">hash</span><span class="cm">,</span></li><li>	                           <span class="w">SV</span> *<span class="w">value</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">flags</span></li><li>	                       <span class="s">)</span></li></ol></pre></li>
<li><a name="refcounted_he_new_pvs"></a><b>refcounted_he_new_pvs
</b>
<p>Like <a href="#refcounted_he_new_pvn">refcounted_he_new_pvn</a>, but takes a <code class="inline"><span class="w">NUL</span></code>
-terminated literal string
instead of a string/length pair, and no precomputed hash.</p>
<pre class="verbatim"><ol><li>	<span class="w">struct</span> <span class="w">refcounted_he</span> * <span class="i">refcounted_he_new_pvs</span><span class="s">(</span></li><li>	                           <span class="w">struct</span> <span class="w">refcounted_he</span> *<span class="w">parent</span><span class="cm">,</span></li><li>	                           <span class="w">const</span> <span class="w">char</span> *<span class="w">key</span><span class="cm">,</span> <span class="w">SV</span> *<span class="w">value</span><span class="cm">,</span></li><li>	                           <span class="w">U32</span> <span class="w">flags</span></li><li>	                       <span class="s">)</span></li></ol></pre></li>
<li><a name="refcounted_he_new_sv"></a><b>refcounted_he_new_sv
</b>
<p>Like <a href="#refcounted_he_new_pvn">refcounted_he_new_pvn</a>, but takes a Perl scalar instead of a
string/length pair.</p>
<pre class="verbatim"><ol><li>	<span class="w">struct</span> <span class="w">refcounted_he</span> * <span class="i">refcounted_he_new_sv</span><span class="s">(</span></li><li>	                           <span class="w">struct</span> <span class="w">refcounted_he</span> *<span class="w">parent</span><span class="cm">,</span></li><li>	                           <span class="w">SV</span> *<span class="w">key</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">hash</span><span class="cm">,</span> <span class="w">SV</span> *<span class="w">value</span><span class="cm">,</span></li><li>	                           <span class="w">U32</span> <span class="w">flags</span></li><li>	                       <span class="s">)</span></li></ol></pre></li>
</ul>
<a name="IO-Functions"></a><h1>IO Functions</h1>
<ul>
<li><a name="start_glob"></a><b>start_glob
</b>
<p>NOTE: this function is experimental and may change or be
removed without notice.</p>
<p>Function called by <code class="inline"><span class="w">do_readline</span></code>
 to spawn a glob (or do the glob inside
perl on VMS).  This code used to be inline, but now perl uses <code class="inline"><span class="w">File::Glob</span></code>

this glob starter is only used by miniperl during the build process,
or when PERL_EXTERNAL_GLOB is defined.
Moving it away shrinks <i>pp_hot.c</i>; shrinking <i>pp_hot.c</i> helps speed perl up.</p>
<pre class="verbatim"><ol><li>	<span class="w">PerlIO</span>*	<span class="i">start_glob</span><span class="s">(</span><span class="w">SV</span> *<span class="w">tmpglob</span><span class="cm">,</span> <span class="w">IO</span> *<span class="w">io</span><span class="s">)</span></li></ol></pre></li>
</ul>
<a name="Lexer-interface"></a><h1>Lexer interface</h1>
<ul>
<li><a name="validate_proto"></a><b>validate_proto
</b>
<p>NOTE: this function is experimental and may change or be
removed without notice.</p>
<p>This function performs syntax checking on a prototype, <code class="inline"><span class="w">proto</span></code>
.
If <code class="inline"><a class="l_k" href="functions/warn.html">warn</a></code> is true, any illegal characters or mismatched brackets
will trigger illegalproto warnings, declaring that they were
detected in the prototype for <code class="inline"><span class="w">name</span></code>
.</p>
<p>The return value is <code class="inline"><span class="w">true</span></code>
 if this is a valid prototype, and
<code class="inline"><span class="w">false</span></code>
 if it is not, regardless of whether <code class="inline"><a class="l_k" href="functions/warn.html">warn</a></code> was <code class="inline"><span class="w">true</span></code>
 or
<code class="inline"><span class="w">false</span></code>
.</p>
<p>Note that <code class="inline"><span class="w">NULL</span></code>
 is a valid <code class="inline"><span class="w">proto</span></code>
 and will always return <code class="inline"><span class="w">true</span></code>
.</p>
<p>NOTE: the perl_ form of this function is deprecated.</p>
<pre class="verbatim"><ol><li>	<span class="w">bool</span>	<span class="i">validate_proto</span><span class="s">(</span><span class="w">SV</span> *<span class="w">name</span><span class="cm">,</span> <span class="w">SV</span> *<span class="w">proto</span><span class="cm">,</span> <span class="w">bool</span> <a class="l_k" href="functions/warn.html">warn</a><span class="s">)</span></li></ol></pre></li>
</ul>
<a name="Magical-Functions"></a><h1>Magical Functions</h1>
<ul>
<li><a name="magic_clearhint"></a><b>magic_clearhint
</b>
<p>Triggered by a delete from <code class="inline"><span class="i">%^H</span></code>
, records the key to
<code class="inline"><span class="w">PL_compiling</span>.<span class="w">cop_hints_hash</span></code>
.</p>
<pre class="verbatim"><ol><li>	<a class="l_k" href="functions/int.html">int</a>	<span class="i">magic_clearhint</span><span class="s">(</span><span class="w">SV</span>* <span class="w">sv</span><span class="cm">,</span> <span class="w">MAGIC</span>* <span class="w">mg</span><span class="s">)</span></li></ol></pre></li>
<li><a name="magic_clearhints"></a><b>magic_clearhints
</b>
<p>Triggered by clearing <code class="inline"><span class="i">%^H</span></code>
, resets <code class="inline"><span class="w">PL_compiling</span>.<span class="w">cop_hints_hash</span></code>
.</p>
<pre class="verbatim"><ol><li>	<a class="l_k" href="functions/int.html">int</a>	<span class="i">magic_clearhints</span><span class="s">(</span><span class="w">SV</span>* <span class="w">sv</span><span class="cm">,</span> <span class="w">MAGIC</span>* <span class="w">mg</span><span class="s">)</span></li></ol></pre></li>
<li><a name="magic_methcall"></a><b>magic_methcall
</b>
<p>Invoke a magic method (like FETCH).</p>
<p><code class="inline"><span class="w">sv</span></code>
 and <code class="inline"><span class="w">mg</span></code>
 are the tied thingy and the tie magic.</p>
<p><code class="inline"><span class="w">meth</span></code>
 is the name of the method to call.</p>
<p><code class="inline"><span class="w">argc</span></code>
 is the number of args (in addition to $self) to pass to the method.</p>
<p>The <code class="inline"><span class="w">flags</span></code>
 can be:</p>
<pre class="verbatim"><ol><li>    <span class="w">G_DISCARD</span>     <span class="w">invoke</span> <span class="w">method</span> <span class="w">with</span> <span class="w">G_DISCARD</span> <span class="w">flag</span> <a class="l_k" href="functions/and.html">and</a> <span class="w">don&#39;t</span></li><li>                  <a class="l_k" href="functions/return.html">return</a> <span class="w">a</span> <span class="w">value</span></li><li>    <span class="w">G_UNDEF_FILL</span>  <span class="w">fill</span> <span class="w">the</span> <span class="w">stack</span> <span class="w">with</span> <span class="w">argc</span> <span class="w">pointers</span> <span class="w">to</span></li><li>                  <span class="w">PL_sv_undef</span></li></ol></pre><p>The arguments themselves are any values following the <code class="inline"><span class="w">flags</span></code>
 argument.</p>
<p>Returns the SV (if any) returned by the method, or <code class="inline"><span class="w">NULL</span></code>
 on failure.</p>
<pre class="verbatim"><ol><li>	<span class="w">SV</span>*	<span class="i">magic_methcall</span><span class="s">(</span><span class="w">SV</span> *<span class="w">sv</span><span class="cm">,</span> <span class="w">const</span> <span class="w">MAGIC</span> *<span class="w">mg</span><span class="cm">,</span></li><li>		               <span class="w">SV</span> *<span class="w">meth</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">flags</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">argc</span><span class="cm">,</span></li><li>		               ...<span class="s">)</span></li></ol></pre></li>
<li><a name="magic_sethint"></a><b>magic_sethint
</b>
<p>Triggered by a store to <code class="inline"><span class="i">%^H</span></code>
, records the key/value pair to
<code class="inline"><span class="w">PL_compiling</span>.<span class="w">cop_hints_hash</span></code>
.  It is assumed that hints aren't storing
anything that would need a deep copy.  Maybe we should warn if we find a
reference.</p>
<pre class="verbatim"><ol><li>	<a class="l_k" href="functions/int.html">int</a>	<span class="i">magic_sethint</span><span class="s">(</span><span class="w">SV</span>* <span class="w">sv</span><span class="cm">,</span> <span class="w">MAGIC</span>* <span class="w">mg</span><span class="s">)</span></li></ol></pre></li>
<li><a name="mg_localize"></a><b>mg_localize
</b>
<p>Copy some of the magic from an existing SV to new localized version of that
SV.  Container magic (<i>e.g.</i>, <code class="inline"><span class="i">%ENV</span></code>
, <code class="inline"><span class="i">$1</span></code>
, <code class="inline"><a class="l_k" href="functions/tie.html">tie</a></code>)
gets copied, value magic doesn't (<i>e.g.</i>,
<code class="inline"><span class="w">taint</span></code>
, <code class="inline"><a class="l_k" href="functions/pos.html">pos</a></code>).</p>
<p>If <code class="inline"><span class="w">setmagic</span></code>
 is false then no set magic will be called on the new (empty) SV.
This typically means that assignment will soon follow (e.g. <code class="inline"><span class="q">&#39;local $x = $y&#39;</span></code>
),
and that will handle the magic.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">mg_localize</span><span class="s">(</span><span class="w">SV</span>* <span class="w">sv</span><span class="cm">,</span> <span class="w">SV</span>* <span class="w">nsv</span><span class="cm">,</span> <span class="w">bool</span> <span class="w">setmagic</span><span class="s">)</span></li></ol></pre></li>
</ul>
<a name="Miscellaneous-Functions"></a><h1>Miscellaneous Functions</h1>
<ul>
<li><a name="free_c_backtrace"></a><b>free_c_backtrace
</b>
<p>Deallocates a backtrace received from get_c_bracktrace.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">free_c_backtrace</span><span class="s">(</span><span class="w">Perl_c_backtrace</span>* <span class="w">bt</span><span class="s">)</span></li></ol></pre></li>
<li><a name="get_c_backtrace"></a><b>get_c_backtrace
</b>
<p>Collects the backtrace (aka "stacktrace") into a single linear
malloced buffer, which the caller <b>must</b> <code class="inline"><span class="i">Perl_free_c_backtrace</span><span class="s">(</span><span class="s">)</span></code>
.</p>
<p>Scans the frames back by <code class="inline"><span class="w">depth</span> + <span class="w">skip</span></code>
, then drops the <code class="inline"><span class="w">skip</span></code>
 innermost,
returning at most <code class="inline"><span class="w">depth</span></code>
 frames.</p>
<pre class="verbatim"><ol><li>	<span class="w">Perl_c_backtrace</span>* <span class="i">get_c_backtrace</span><span class="s">(</span><a class="l_k" href="functions/int.html">int</a> <span class="w">max_depth</span><span class="cm">,</span></li><li>	                                  <a class="l_k" href="functions/int.html">int</a> <span class="w">skip</span><span class="s">)</span></li></ol></pre></li>
</ul>
<a name="MRO-Functions"></a><h1>MRO Functions</h1>
<ul>
<li><a name="mro_get_linear_isa_dfs"></a><b>mro_get_linear_isa_dfs
</b>
<p>Returns the Depth-First Search linearization of <code class="inline"><span class="i">@ISA</span></code>

the given stash.  The return value is a read-only AV*.
<code class="inline"><span class="w">level</span></code>
 should be 0 (it is used internally in this
function's recursion).</p>
<p>You are responsible for <code class="inline"><span class="i">SvREFCNT_inc</span><span class="s">(</span><span class="s">)</span></code>
 on the
return value if you plan to store it anywhere
semi-permanently (otherwise it might be deleted
out from under you the next time the cache is
invalidated).</p>
<pre class="verbatim"><ol><li>	<span class="w">AV</span>*	<span class="i">mro_get_linear_isa_dfs</span><span class="s">(</span><span class="w">HV</span>* <span class="w">stash</span><span class="cm">,</span> <span class="w">U32</span> <span class="w">level</span><span class="s">)</span></li></ol></pre></li>
<li><a name="mro_isa_changed_in"></a><b>mro_isa_changed_in
</b>
<p>Takes the necessary steps (cache invalidations, mostly)
when the <code class="inline"><span class="i">@ISA</span></code>
 of the given package has changed.  Invoked
by the <code class="inline"><span class="w">setisa</span></code>
 magic, should not need to invoke directly.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">mro_isa_changed_in</span><span class="s">(</span><span class="w">HV</span>* <span class="w">stash</span><span class="s">)</span></li></ol></pre></li>
<li><a name="mro_package_moved"></a><b>mro_package_moved
</b>
<p>Call this function to signal to a stash that it has been assigned to
another spot in the stash hierarchy.  <code class="inline"><span class="w">stash</span></code>
 is the stash that has been
assigned.  <code class="inline"><span class="w">oldstash</span></code>
 is the stash it replaces, if any.  <code class="inline"><span class="w">gv</span></code>
 is the glob
that is actually being assigned to.</p>
<p>This can also be called with a null first argument to
indicate that <code class="inline"><span class="w">oldstash</span></code>
 has been deleted.</p>
<p>This function invalidates isa caches on the old stash, on all subpackages
nested inside it, and on the subclasses of all those, including
non-existent packages that have corresponding entries in <code class="inline"><span class="w">stash</span></code>
.</p>
<p>It also sets the effective names (<code class="inline"><span class="w">HvENAME</span></code>
) on all the stashes as
appropriate.</p>
<p>If the <code class="inline"><span class="w">gv</span></code>
 is present and is not in the symbol table, then this function
simply returns.  This checked will be skipped if <code class="inline"><span class="w">flags</span> <span class="i">&amp; 1</span></code>
.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">mro_package_moved</span><span class="s">(</span><span class="w">HV</span> * <span class="w">const</span> <span class="w">stash</span><span class="cm">,</span></li><li>		                  <span class="w">HV</span> * <span class="w">const</span> <span class="w">oldstash</span><span class="cm">,</span></li><li>		                  <span class="w">const</span> <span class="w">GV</span> * <span class="w">const</span> <span class="w">gv</span><span class="cm">,</span></li><li>		                  <span class="w">U32</span> <span class="w">flags</span><span class="s">)</span></li></ol></pre></li>
</ul>
<a name="Optree-Manipulation-Functions"></a><h1>Optree Manipulation Functions</h1>
<ul>
<li><a name="finalize_optree"></a><b>finalize_optree
</b>
<p>This function finalizes the optree.  Should be called directly after
the complete optree is built.  It does some additional
checking which can't be done in the normal <code class="inline"><span class="w">ck_</span></code>
xxx functions and makes
the tree thread-safe.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">finalize_optree</span><span class="s">(</span><span class="w">OP</span>* <span class="w">o</span><span class="s">)</span></li></ol></pre></li>
</ul>
<a name="Pad-Data-Structures"></a><h1>Pad Data Structures</h1>
<ul>
<li><a name="CX_CURPAD_SAVE"></a><b>CX_CURPAD_SAVE
</b>
<p>Save the current pad in the given context block structure.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">CX_CURPAD_SAVE</span><span class="s">(</span><span class="w">struct</span> <span class="w">context</span><span class="s">)</span></li></ol></pre></li>
<li><a name="CX_CURPAD_SV"></a><b>CX_CURPAD_SV
</b>
<p>Access the SV at offset <code class="inline"><span class="w">po</span></code>
 in the saved current pad in the given
context block structure (can be used as an lvalue).</p>
<pre class="verbatim"><ol><li>	<span class="w">SV</span> *	<span class="i">CX_CURPAD_SV</span><span class="s">(</span><span class="w">struct</span> <span class="w">context</span><span class="cm">,</span> <span class="w">PADOFFSET</span> <span class="w">po</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PAD_BASE_SV"></a><b>PAD_BASE_SV
</b>
<p>Get the value from slot <code class="inline"><span class="w">po</span></code>
 in the base (DEPTH=1) pad of a padlist</p>
<pre class="verbatim"><ol><li>	<span class="w">SV</span> *	<span class="i">PAD_BASE_SV</span><span class="s">(</span><span class="w">PADLIST</span> <span class="w">padlist</span><span class="cm">,</span> <span class="w">PADOFFSET</span> <span class="w">po</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PAD_CLONE_VARS"></a><b>PAD_CLONE_VARS
</b>
<p>Clone the state variables associated with running and compiling pads.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">PAD_CLONE_VARS</span><span class="s">(</span><span class="w">PerlInterpreter</span> *<span class="w">proto_perl</span><span class="cm">,</span></li><li>		               <span class="w">CLONE_PARAMS</span>* <span class="w">param</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PAD_COMPNAME_FLAGS"></a><b>PAD_COMPNAME_FLAGS
</b>
<p>Return the flags for the current compiling pad name
at offset <code class="inline"><span class="w">po</span></code>
.  Assumes a valid slot entry.</p>
<pre class="verbatim"><ol><li>	<span class="w">U32</span>	<span class="i">PAD_COMPNAME_FLAGS</span><span class="s">(</span><span class="w">PADOFFSET</span> <span class="w">po</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PAD_COMPNAME_GEN"></a><b>PAD_COMPNAME_GEN
</b>
<p>The generation number of the name at offset <code class="inline"><span class="w">po</span></code>
 in the current
compiling pad (lvalue).</p>
<pre class="verbatim"><ol><li>	<span class="w">STRLEN</span>	<span class="i">PAD_COMPNAME_GEN</span><span class="s">(</span><span class="w">PADOFFSET</span> <span class="w">po</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PAD_COMPNAME_GEN_set"></a><b>PAD_COMPNAME_GEN_set
</b>
<p>Sets the generation number of the name at offset <code class="inline"><span class="w">po</span></code>
 in the current
ling pad (lvalue) to <code class="inline"><span class="w">gen</span></code>
.
	STRLEN	PAD_COMPNAME_GEN_set(PADOFFSET po, int gen)</p>
</li>
<li><a name="PAD_COMPNAME_OURSTASH"></a><b>PAD_COMPNAME_OURSTASH
</b>
<p>Return the stash associated with an <code class="inline"><a class="l_k" href="functions/our.html">our</a></code> variable.
Assumes the slot entry is a valid <code class="inline"><a class="l_k" href="functions/our.html">our</a></code> lexical.</p>
<pre class="verbatim"><ol><li>	<span class="w">HV</span> *	<span class="i">PAD_COMPNAME_OURSTASH</span><span class="s">(</span><span class="w">PADOFFSET</span> <span class="w">po</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PAD_COMPNAME_PV"></a><b>PAD_COMPNAME_PV
</b>
<p>Return the name of the current compiling pad name
at offset <code class="inline"><span class="w">po</span></code>
.  Assumes a valid slot entry.</p>
<pre class="verbatim"><ol><li>	<span class="w">char</span> *	<span class="i">PAD_COMPNAME_PV</span><span class="s">(</span><span class="w">PADOFFSET</span> <span class="w">po</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PAD_COMPNAME_TYPE"></a><b>PAD_COMPNAME_TYPE
</b>
<p>Return the type (stash) of the current compiling pad name at offset
<code class="inline"><span class="w">po</span></code>
.  Must be a valid name.  Returns null if not typed.</p>
<pre class="verbatim"><ol><li>	<span class="w">HV</span> *	<span class="i">PAD_COMPNAME_TYPE</span><span class="s">(</span><span class="w">PADOFFSET</span> <span class="w">po</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PadnameIsOUR"></a><b>PadnameIsOUR
</b>
<p>Whether this is an "our" variable.</p>
<pre class="verbatim"><ol><li>	<span class="w">bool</span>	<span class="i">PadnameIsOUR</span><span class="s">(</span><span class="w">PADNAME</span> <span class="w">pn</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PadnameIsSTATE"></a><b>PadnameIsSTATE
</b>
<p>Whether this is a "state" variable.</p>
<pre class="verbatim"><ol><li>	<span class="w">bool</span>	<span class="i">PadnameIsSTATE</span><span class="s">(</span><span class="w">PADNAME</span> <span class="w">pn</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PadnameOURSTASH"></a><b>PadnameOURSTASH
</b>
<p>The stash in which this "our" variable was declared.</p>
<pre class="verbatim"><ol><li>	<span class="w">HV</span> *	<span class="i">PadnameOURSTASH</span><span class="s">(</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PadnameOUTER"></a><b>PadnameOUTER
</b>
<p>Whether this entry belongs to an outer pad.  Entries for which this is true
are often referred to as 'fake'.</p>
<pre class="verbatim"><ol><li>	<span class="w">bool</span>	<span class="i">PadnameOUTER</span><span class="s">(</span><span class="w">PADNAME</span> <span class="w">pn</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PadnameTYPE"></a><b>PadnameTYPE
</b>
<p>The stash associated with a typed lexical.  This returns the <code class="inline"><span class="i">%Foo::</span></code>
 hash
for <code class="inline"><a class="l_k" href="functions/my.html">my</a> <span class="w">Foo</span> <span class="i">$bar</span></code>
.</p>
<pre class="verbatim"><ol><li>	<span class="w">HV</span> *	<span class="i">PadnameTYPE</span><span class="s">(</span><span class="w">PADNAME</span> <span class="w">pn</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PAD_RESTORE_LOCAL"></a><b>PAD_RESTORE_LOCAL
</b>
<p>Restore the old pad saved into the local variable <code class="inline"><span class="w">opad</span></code>
 by <code class="inline"><span class="i">PAD_SAVE_LOCAL</span><span class="s">(</span><span class="s">)</span></code>
</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">PAD_RESTORE_LOCAL</span><span class="s">(</span><span class="w">PAD</span> *<span class="w">opad</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PAD_SAVE_LOCAL"></a><b>PAD_SAVE_LOCAL
</b>
<p>Save the current pad to the local variable <code class="inline"><span class="w">opad</span></code>
, then make the
current pad equal to <code class="inline"><span class="w">npad</span></code>
</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">PAD_SAVE_LOCAL</span><span class="s">(</span><span class="w">PAD</span> *<span class="w">opad</span><span class="cm">,</span> <span class="w">PAD</span> *<span class="w">npad</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PAD_SAVE_SETNULLPAD"></a><b>PAD_SAVE_SETNULLPAD
</b>
<p>Save the current pad then set it to null.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">PAD_SAVE_SETNULLPAD</span><span class="s">(</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PAD_SETSV"></a><b>PAD_SETSV
</b>
<p>Set the slot at offset <code class="inline"><span class="w">po</span></code>
 in the current pad to <code class="inline"><span class="w">sv</span></code>
</p>
<pre class="verbatim"><ol><li>	<span class="w">SV</span> *	<span class="i">PAD_SETSV</span><span class="s">(</span><span class="w">PADOFFSET</span> <span class="w">po</span><span class="cm">,</span> <span class="w">SV</span>* <span class="w">sv</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PAD_SET_CUR"></a><b>PAD_SET_CUR
</b>
<p>Set the current pad to be pad <code class="inline"><span class="w">n</span></code>
 in the padlist, saving
the previous current pad.  NB currently this macro expands to a string too
long for some compilers, so it's best to replace it with</p>
<pre class="verbatim"><ol><li>    <span class="i">SAVECOMPPAD</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span></li><li>    <span class="i">PAD_SET_CUR_NOSAVE</span><span class="s">(</span><span class="w">padlist</span><span class="cm">,</span><span class="w">n</span><span class="s">)</span><span class="sc">;</span></li><li></li><li></li><li>	<span class="w">void</span>	<span class="i">PAD_SET_CUR</span><span class="s">(</span><span class="w">PADLIST</span> <span class="w">padlist</span><span class="cm">,</span> <span class="w">I32</span> <span class="w">n</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PAD_SET_CUR_NOSAVE"></a><b>PAD_SET_CUR_NOSAVE
</b>
<p>like PAD_SET_CUR, but without the save</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">PAD_SET_CUR_NOSAVE</span><span class="s">(</span><span class="w">PADLIST</span> <span class="w">padlist</span><span class="cm">,</span> <span class="w">I32</span> <span class="w">n</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PAD_SV"></a><b>PAD_SV
</b>
<p>Get the value at offset <code class="inline"><span class="w">po</span></code>
 in the current pad</p>
<pre class="verbatim"><ol><li>	<span class="w">SV</span> *	<span class="i">PAD_SV</span><span class="s">(</span><span class="w">PADOFFSET</span> <span class="w">po</span><span class="s">)</span></li></ol></pre></li>
<li><a name="PAD_SVl"></a><b>PAD_SVl
</b>
<p>Lightweight and lvalue version of <code class="inline"><span class="w">PAD_SV</span></code>
.
Get or set the value at offset <code class="inline"><span class="w">po</span></code>
 in the current pad.
Unlike <code class="inline"><span class="w">PAD_SV</span></code>
, does not print diagnostics with -DX.
For internal use only.</p>
<pre class="verbatim"><ol><li>	<span class="w">SV</span> *	<span class="i">PAD_SVl</span><span class="s">(</span><span class="w">PADOFFSET</span> <span class="w">po</span><span class="s">)</span></li></ol></pre></li>
<li><a name="SAVECLEARSV"></a><b>SAVECLEARSV
</b>
<p>Clear the pointed to pad value on scope exit.  (i.e. the runtime action of
<code class="inline"><a class="l_k" href="functions/my.html">my</a></code>)</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">SAVECLEARSV</span><span class="s">(</span><span class="w">SV</span> **<span class="w">svp</span><span class="s">)</span></li></ol></pre></li>
<li><a name="SAVECOMPPAD"></a><b>SAVECOMPPAD
</b>
<p>save <code class="inline"><span class="w">PL_comppad</span></code>
 and <code class="inline"><span class="w">PL_curpad</span></code>
</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">SAVECOMPPAD</span><span class="s">(</span><span class="s">)</span></li></ol></pre></li>
<li><a name="SAVEPADSV"></a><b>SAVEPADSV
</b>
<p>Save a pad slot (used to restore after an iteration)</p>
<p>XXX DAPM it would make more sense to make the arg a PADOFFSET
	void	SAVEPADSV(PADOFFSET po)</p>
</li>
</ul>
<a name="Per-Interpreter-Variables"></a><h1>Per-Interpreter Variables</h1>
<ul>
<li><a name="PL_DBsingle"></a><b>PL_DBsingle
</b>
<p>When Perl is run in debugging mode, with the <b>-d</b> switch, this SV is a
boolean which indicates whether subs are being single-stepped.
Single-stepping is automatically turned on after every step.  This is the C
variable which corresponds to Perl's $DB::single variable.  See
<code class="inline"><a href="#PL_DBsub">PL_DBsub</a></code>.</p>
<pre class="verbatim"><ol><li>	<span class="w">SV</span> *	<span class="w">PL_DBsingle</span></li></ol></pre></li>
<li><a name="PL_DBsub"></a><b>PL_DBsub
</b>
<p>When Perl is run in debugging mode, with the <b>-d</b> switch, this GV contains
the SV which holds the name of the sub being debugged.  This is the C
variable which corresponds to Perl's $DB::sub variable.  See
<code class="inline"><a href="#PL_DBsingle">PL_DBsingle</a></code>.</p>
<pre class="verbatim"><ol><li>	<span class="w">GV</span> *	<span class="w">PL_DBsub</span></li></ol></pre></li>
<li><a name="PL_DBtrace"></a><b>PL_DBtrace
</b>
<p>Trace variable used when Perl is run in debugging mode, with the <b>-d</b>
switch.  This is the C variable which corresponds to Perl's $DB::trace
variable.  See <code class="inline"><a href="#PL_DBsingle">PL_DBsingle</a></code>.</p>
<pre class="verbatim"><ol><li>	<span class="w">SV</span> *	<span class="w">PL_DBtrace</span></li></ol></pre></li>
<li><a name="PL_dowarn"></a><b>PL_dowarn
</b>
<p>The C variable that roughly corresponds to Perl's <code class="inline"><span class="i">$^W</span></code>
 warning variable.
However, <code class="inline"><span class="i">$^W</span></code>
 is treated as a boolean, whereas <code class="inline"><span class="w">PL_dowarn</span></code>
 is a
collection of flag bits.</p>
<pre class="verbatim"><ol><li>	<span class="w">U8</span>	<span class="w">PL_dowarn</span></li></ol></pre></li>
<li><a name="PL_last_in_gv"></a><b>PL_last_in_gv
</b>
<p>The GV which was last used for a filehandle input operation.  (<code class="inline"><span class="q">&lt;FH&gt;</span></code>
)</p>
<pre class="verbatim"><ol><li>	<span class="w">GV</span>*	<span class="w">PL_last_in_gv</span></li></ol></pre></li>
<li><a name="PL_ofsgv"></a><b>PL_ofsgv
</b>
<p>The glob containing the output field separator - <code class="inline"><span class="i">*,</span></code>
 in Perl space.</p>
<pre class="verbatim"><ol><li>	<span class="w">GV</span>*	<span class="w">PL_ofsgv</span></li></ol></pre></li>
<li><a name="PL_rs"></a><b>PL_rs
</b>
<p>The input record separator - <code class="inline"><span class="i">$/</span></code>
 in Perl space.</p>
<pre class="verbatim"><ol><li>	<span class="w">SV</span>*	<span class="w">PL_rs</span></li></ol></pre></li>
</ul>
<a name="Stack-Manipulation-Macros"></a><h1>Stack Manipulation Macros</h1>
<ul>
<li><a name="djSP"></a><b>djSP
</b>
<p>Declare Just <code class="inline"><span class="w">SP</span></code>
.  This is actually identical to <code class="inline"><span class="w">dSP</span></code>
, and declares
a local copy of perl's stack pointer, available via the <code class="inline"><span class="w">SP</span></code>
 macro.
See <code class="inline"><a href="perlapi.html#SP">SP in perlapi</a></code>.  (Available for backward source code compatibility with
the old (Perl 5.005) thread model.)</p>
<pre class="verbatim"><ol><li>		<span class="w">djSP</span><span class="sc">;</span></li></ol></pre></li>
<li><a name="LVRET"></a><b>LVRET
</b>
<p>True if this op will be the return value of an lvalue subroutine</p>
</li>
</ul>
<a name="SV-Body-Allocation"></a><h1>SV-Body Allocation</h1>
<ul>
<li><a name="sv_2num"></a><b>sv_2num
</b>
<p>NOTE: this function is experimental and may change or be
removed without notice.</p>
<p>Return an SV with the numeric value of the source SV, doing any necessary
reference or overload conversion.  The caller is expected to have handled
get-magic already.</p>
<pre class="verbatim"><ol><li>	<span class="w">SV</span>*	<span class="i">sv_2num</span><span class="s">(</span><span class="w">SV</span> *<span class="w">const</span> <span class="w">sv</span><span class="s">)</span></li></ol></pre></li>
</ul>
<a name="SV-Manipulation-Functions"></a><h1>SV Manipulation Functions</h1>
<p>An SV (or AV, HV, etc.) is allocated in two parts: the head (struct
sv, av, hv...) contains type and reference count information, and for
many types, a pointer to the body (struct xrv, xpv, xpviv...), which
contains fields specific to each type.  Some types store all they need
in the head, so don't have a body.</p>
<p>In all but the most memory-paranoid configurations (ex: PURIFY), heads
and bodies are allocated out of arenas, which by default are
approximately 4K chunks of memory parcelled up into N heads or bodies.
Sv-bodies are allocated by their sv-type, guaranteeing size
consistency needed to allocate safely from arrays.</p>
<p>For SV-heads, the first slot in each arena is reserved, and holds a
link to the next arena, some flags, and a note of the number of slots.
Snaked through each arena chain is a linked list of free items; when
this becomes empty, an extra arena is allocated and divided up into N
items which are threaded into the free list.</p>
<p>SV-bodies are similar, but they use arena-sets by default, which
separate the link and info from the arena itself, and reclaim the 1st
slot in the arena.  SV-bodies are further described later.</p>
<p>The following global variables are associated with arenas:</p>
<pre class="verbatim"><ol><li> <span class="w">PL_sv_arenaroot</span>     <span class="w">pointer</span> <span class="w">to</span> <span class="w">list</span> <span class="w">of</span> <span class="w">SV</span> <span class="w">arenas</span></li><li> <span class="w">PL_sv_root</span>          <span class="w">pointer</span> <span class="w">to</span> <span class="w">list</span> <span class="w">of</span> <span class="w">free</span> <span class="w">SV</span> <span class="w">structures</span></li><li></li><li> <span class="w">PL_body_arenas</span>      <span class="w">head</span> <span class="w">of</span> <span class="w">linked</span>-<span class="w">list</span> <span class="w">of</span> <span class="w">body</span> <span class="w">arenas</span></li><li> <span class="w">PL_body_roots</span><span class="s">[</span><span class="s">]</span>     <span class="w">array</span> <span class="w">of</span> <span class="w">pointers</span> <span class="w">to</span> <span class="w">list</span> <span class="w">of</span> <span class="w">free</span> <span class="w">bodies</span> <span class="w">of</span> <span class="w">svtype</span></li><li>                     <span class="w">arrays</span> <span class="w">are</span> <span class="w">indexed</span> <span class="w">by</span> <span class="w">the</span> <span class="w">svtype</span> <span class="w">needed</span></li></ol></pre><p>A few special SV heads are not allocated from an arena, but are
instead directly created in the interpreter structure, eg PL_sv_undef.
The size of arenas can be changed from the default by setting
PERL_ARENA_SIZE appropriately at compile time.</p>
<p>The SV arena serves the secondary purpose of allowing still-live SVs
to be located and destroyed during final cleanup.</p>
<p>At the lowest level, the macros new_SV() and del_SV() grab and free
an SV head.  (If debugging with -DD, del_SV() calls the function S_del_sv()
to return the SV to the free list with error checking.) new_SV() calls
more_sv() / sv_add_arena() to add an extra arena if the free list is empty.
SVs in the free list have their SvTYPE field set to all ones.</p>
<p>At the time of very final cleanup, sv_free_arenas() is called from
perl_destruct() to physically free all the arenas allocated since the
start of the interpreter.</p>
<p>The function visit() scans the SV arenas list, and calls a specified
function for each SV it finds which is still live - ie which has an SvTYPE
other than all 1's, and a non-zero SvREFCNT. visit() is used by the
following functions (specified as [function that calls visit()] / [function
called by visit() for each SV]):</p>
<pre class="verbatim"><ol><li>    <span class="i">sv_report_used</span><span class="s">(</span><span class="s">)</span> / <span class="i">do_report_used</span><span class="s">(</span><span class="s">)</span></li><li>			<a class="l_k" href="functions/dump.html">dump</a> <span class="w">all</span> <span class="w">remaining</span> <span class="w">SVs</span> <span class="s">(</span><span class="w">debugging</span> <span class="w">aid</span><span class="s">)</span></li><li></li><li>    <span class="i">sv_clean_objs</span><span class="s">(</span><span class="s">)</span> / <span class="i">do_clean_objs</span><span class="s">(</span><span class="s">)</span><span class="cm">,</span><span class="i">do_clean_named_objs</span><span class="s">(</span><span class="s">)</span><span class="cm">,</span></li><li>		      <span class="i">do_clean_named_io_objs</span><span class="s">(</span><span class="s">)</span><span class="cm">,</span><span class="i">do_curse</span><span class="s">(</span><span class="s">)</span></li><li>			<span class="w">Attempt</span> <span class="w">to</span> <span class="w">free</span> <span class="w">all</span> <span class="w">objects</span> <span class="w">pointed</span> <span class="w">to</span> <span class="w">by</span> <span class="w">RVs</span><span class="cm">,</span></li><li>			<span class="w">try</span> <span class="w">to</span> <a class="l_k" href="functions/do.html">do</a> <span class="w">the</span> <span class="w">same</span> <a class="l_k" href="functions/for.html">for</a> <span class="w">all</span> <span class="w">objects</span> <span class="w">indir</span>-</li><li>			<span class="w">ectly</span> <span class="w">referenced</span> <span class="w">by</span> <span class="w">typeglobs</span> <span class="w">too</span><span class="cm">,</span> <a class="l_k" href="functions/and.html">and</a></li><li>			<span class="w">then</span> <a class="l_k" href="functions/do.html">do</a> <span class="w">a</span> <span class="w">final</span> <span class="w">sweep</span><span class="cm">,</span> <span class="w">cursing</span> <span class="w">any</span></li><li>			<span class="w">objects</span> <span class="w">that</span> <span class="w">remain</span>.  <span class="w">Called</span> <span class="w">once</span> <span class="w">from</span></li><li>			<span class="i">perl_destruct</span><span class="s">(</span><span class="s">)</span><span class="cm">,</span> <span class="w">prior</span> <span class="w">to</span> <span class="w">calling</span> <span class="i">sv_clean_all</span><span class="s">(</span><span class="s">)</span></li><li>			<span class="w">below</span>.</li><li></li><li>    <span class="i">sv_clean_all</span><span class="s">(</span><span class="s">)</span> / <span class="i">do_clean_all</span><span class="s">(</span><span class="s">)</span></li><li>			<span class="i">SvREFCNT_dec</span><span class="s">(</span><span class="w">sv</span><span class="s">)</span> <a class="l_k" href="functions/each.html">each</a> <span class="w">remaining</span> <span class="w">SV</span><span class="cm">,</span> <span class="w">possibly</span></li><li>			<span class="w">triggering</span> <span class="w">an</span> <span class="i">sv_free</span><span class="s">(</span><span class="s">)</span>. <span class="w">It</span> <span class="w">also</span> <span class="w">sets</span> <span class="w">the</span></li><li>			<span class="w">SVf_BREAK</span> <span class="w">flag</span> <span class="w">on</span> <span class="w">the</span> <span class="w">SV</span> <span class="w">to</span> <span class="w">indicate</span> <span class="w">that</span> <span class="w">the</span></li><li>			<span class="w">refcnt</span> <span class="w">has</span> <span class="w">been</span> <span class="w">artificially</span> <span class="w">lowered</span><span class="cm">,</span> <a class="l_k" href="functions/and.html">and</a> <span class="w">thus</span></li><li>			<span class="w">stopping</span> <span class="i">sv_free</span><span class="s">(</span><span class="s">)</span> <span class="w">from</span> <span class="w">giving</span> <span class="w">spurious</span> <span class="w">warnings</span></li><li>			<span class="w">about</span> <span class="w">SVs</span> <span class="w">which</span> <span class="w">unexpectedly</span> <span class="w">have</span> <span class="w">a</span> <span class="w">refcnt</span></li><li>			<span class="w">of</span> <span class="w">zero</span>.  <span class="w">called</span> <span class="w">repeatedly</span> <span class="w">from</span> <span class="i">perl_destruct</span><span class="s">(</span><span class="s">)</span></li><li>			<a class="l_k" href="functions/until.html">until</a> <span class="w">there</span> <span class="w">are</span> <a class="l_k" href="functions/no.html">no</a> <span class="w">SVs</span> <span class="w">left</span>.</li></ol></pre><ul>
<li><a name="sv_add_arena"></a><b>sv_add_arena
</b>
<p>Given a chunk of memory, link it to the head of the list of arenas,
and split it into a list of free SVs.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">sv_add_arena</span><span class="s">(</span><span class="w">char</span> *<span class="w">const</span> <span class="w">ptr</span><span class="cm">,</span> <span class="w">const</span> <span class="w">U32</span> <span class="w">size</span><span class="cm">,</span></li><li>		             <span class="w">const</span> <span class="w">U32</span> <span class="w">flags</span><span class="s">)</span></li></ol></pre></li>
<li><a name="sv_clean_all"></a><b>sv_clean_all
</b>
<p>Decrement the refcnt of each remaining SV, possibly triggering a
cleanup.  This function may have to be called multiple times to free
SVs which are in complex self-referential hierarchies.</p>
<pre class="verbatim"><ol><li>	<span class="w">I32</span>	<span class="i">sv_clean_all</span><span class="s">(</span><span class="s">)</span></li></ol></pre></li>
<li><a name="sv_clean_objs"></a><b>sv_clean_objs
</b>
<p>Attempt to destroy all objects not yet freed.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">sv_clean_objs</span><span class="s">(</span><span class="s">)</span></li></ol></pre></li>
<li><a name="sv_free_arenas"></a><b>sv_free_arenas
</b>
<p>Deallocate the memory used by all arenas.  Note that all the individual SV
heads and bodies within the arenas must already have been freed.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">sv_free_arenas</span><span class="s">(</span><span class="s">)</span></li></ol></pre></li>
<li><a name="SvTHINKFIRST"></a><b>SvTHINKFIRST
</b>
<p>A quick flag check to see whether an <code class="inline"><span class="w">sv</span></code>
 should be passed to <code class="inline"><span class="w">sv_force_normal</span></code>

to be "downgraded" before <code class="inline"><span class="w">SvIVX</span></code>
 or <code class="inline"><span class="w">SvPVX</span></code>
 can be modified directly.</p>
<p>For example, if your scalar is a reference and you want to modify the <code class="inline"><span class="w">SvIVX</span></code>

slot, you can't just do <code class="inline"><span class="w">SvROK_off</span></code>
, as that will leak the referent.</p>
<p>This is used internally by various sv-modifying functions, such as
<code class="inline"><span class="w">sv_setsv</span></code>
, <code class="inline"><span class="w">sv_setiv</span></code>
 and <code class="inline"><span class="w">sv_pvn_force</span></code>
.</p>
<p>One case that this does not handle is a gv without SvFAKE set.  After</p>
<pre class="verbatim"><ol><li>    <a class="l_k" href="functions/if.html">if</a> <span class="s">(</span><span class="i">SvTHINKFIRST</span><span class="s">(</span><span class="w">gv</span><span class="s">)</span><span class="s">)</span> <span class="i">sv_force_normal</span><span class="s">(</span><span class="w">gv</span><span class="s">)</span><span class="sc">;</span></li></ol></pre><p>it will still be a gv.</p>
<p><code class="inline"><span class="w">SvTHINKFIRST</span></code>
 sometimes produces false positives.  In those cases
<code class="inline"><span class="w">sv_force_normal</span></code>
 does nothing.</p>
<pre class="verbatim"><ol><li>	<span class="w">U32</span>	<span class="i">SvTHINKFIRST</span><span class="s">(</span><span class="w">SV</span> *<span class="w">sv</span><span class="s">)</span></li></ol></pre></li>
</ul>
<a name="Unicode-Support"></a><h1>Unicode Support</h1>
<ul>
<li><a name="find_uninit_var"></a><b>find_uninit_var
</b>
<p>NOTE: this function is experimental and may change or be
removed without notice.</p>
<p>Find the name of the undefined variable (if any) that caused the operator
to issue a "Use of uninitialized value" warning.
If match is true, only return a name if its value matches <code class="inline"><span class="w">uninit_sv</span></code>
.
So roughly speaking, if a unary operator (such as <code class="inline"><span class="w">OP_COS</span></code>
) generates a
warning, then following the direct child of the op may yield an
<code class="inline"><span class="w">OP_PADSV</span></code>
 or <code class="inline"><span class="w">OP_GV</span></code>
 that gives the name of the undefined variable.  On the
other hand, with <code class="inline"><span class="w">OP_ADD</span></code>
 there are two branches to follow, so we only print
the variable name if we get an exact match.
<code class="inline"><span class="w">desc_p</span></code>
 points to a string pointer holding the description of the op.
This may be updated if needed.</p>
<p>The name is returned as a mortal SV.</p>
<p>Assumes that <code class="inline"><span class="w">PL_op</span></code>
 is the OP that originally triggered the error, and that
<code class="inline"><span class="w">PL_comppad</span></code>
/<code class="inline"><span class="w">PL_curpad</span></code>
 points to the currently executing pad.</p>
<pre class="verbatim"><ol><li>	<span class="w">SV</span>*	<span class="i">find_uninit_var</span><span class="s">(</span><span class="w">const</span> <span class="w">OP</span> *<span class="w">const</span> <span class="w">obase</span><span class="cm">,</span></li><li>		                <span class="w">const</span> <span class="w">SV</span> *<span class="w">const</span> <span class="w">uninit_sv</span><span class="cm">,</span></li><li>		                <span class="w">bool</span> <span class="w">match</span><span class="cm">,</span> <span class="w">const</span> <span class="w">char</span> **<span class="w">desc_p</span><span class="s">)</span></li></ol></pre></li>
<li><a name="report_uninit"></a><b>report_uninit
</b>
<p>Print appropriate "Use of uninitialized variable" warning.</p>
<pre class="verbatim"><ol><li>	<span class="w">void</span>	<span class="i">report_uninit</span><span class="s">(</span><span class="w">const</span> <span class="w">SV</span> *<span class="w">uninit_sv</span><span class="s">)</span></li></ol></pre></li>
</ul>
<a name="Undocumented-functions"></a><h1>Undocumented functions</h1>
<p>The following functions are currently undocumented.  If you use one of
them, you may wish to consider creating and submitting documentation for
it.</p>
<ul>
<li><a name="PerlIO_restore_errno"></a><b>PerlIO_restore_errno
</b>
</li>
<li><a name="PerlIO_save_errno"></a><b>PerlIO_save_errno
</b>
</li>
<li><a name="Slab_Alloc"></a><b>Slab_Alloc
</b>
</li>
<li><a name="Slab_Free"></a><b>Slab_Free
</b>
</li>
<li><a name="Slab_to_ro"></a><b>Slab_to_ro
</b>
</li>
<li><a name="Slab_to_rw"></a><b>Slab_to_rw
</b>
</li>
<li><a name="_add_range_to_invlist"></a><b>_add_range_to_invlist
</b>
</li>
<li><a name="_byte_dump_string"></a><b>_byte_dump_string
</b>
</li>
<li><a name="_core_swash_init"></a><b>_core_swash_init
</b>
</li>
<li><a name="_get_regclass_nonbitmap_data"></a><b>_get_regclass_nonbitmap_data
</b>
</li>
<li><a name="_get_swash_invlist"></a><b>_get_swash_invlist
</b>
</li>
<li><a name="_invlistEQ"></a><b>_invlistEQ
</b>
</li>
<li><a name="_invlist_array_init"></a><b>_invlist_array_init
</b>
</li>
<li><a name="_invlist_contains_cp"></a><b>_invlist_contains_cp
</b>
</li>
<li><a name="_invlist_dump"></a><b>_invlist_dump
</b>
</li>
<li><a name="_invlist_intersection"></a><b>_invlist_intersection
</b>
</li>
<li><a name="_invlist_intersection_maybe_complement_2nd"></a><b>_invlist_intersection_maybe_complement_2nd
</b>
</li>
<li><a name="_invlist_invert"></a><b>_invlist_invert
</b>
</li>
<li><a name="_invlist_len"></a><b>_invlist_len
</b>
</li>
<li><a name="_invlist_populate_swatch"></a><b>_invlist_populate_swatch
</b>
</li>
<li><a name="_invlist_search"></a><b>_invlist_search
</b>
</li>
<li><a name="_invlist_subtract"></a><b>_invlist_subtract
</b>
</li>
<li><a name="_invlist_union"></a><b>_invlist_union
</b>
</li>
<li><a name="_invlist_union_maybe_complement_2nd"></a><b>_invlist_union_maybe_complement_2nd
</b>
</li>
<li><a name="_is_grapheme"></a><b>_is_grapheme
</b>
</li>
<li><a name="_load_PL_utf8_foldclosures"></a><b>_load_PL_utf8_foldclosures
</b>
</li>
<li><a name="_mem_collxfrm"></a><b>_mem_collxfrm
</b>
</li>
<li><a name="_new_invlist"></a><b>_new_invlist
</b>
</li>
<li><a name="_new_invlist_C_array"></a><b>_new_invlist_C_array
</b>
</li>
<li><a name="_setup_canned_invlist"></a><b>_setup_canned_invlist
</b>
</li>
<li><a name="_swash_inversion_hash"></a><b>_swash_inversion_hash
</b>
</li>
<li><a name="_swash_to_invlist"></a><b>_swash_to_invlist
</b>
</li>
<li><a name="_to_fold_latin1"></a><b>_to_fold_latin1
</b>
</li>
<li><a name="_to_upper_title_latin1"></a><b>_to_upper_title_latin1
</b>
</li>
<li><a name="_warn_problematic_locale"></a><b>_warn_problematic_locale
</b>
</li>
<li><a name="abort_execution"></a><b>abort_execution
</b>
</li>
<li><a name="add_cp_to_invlist"></a><b>add_cp_to_invlist
</b>
</li>
<li><a name="alloc_LOGOP"></a><b>alloc_LOGOP
</b>
</li>
<li><a name="alloc_maybe_populate_EXACT"></a><b>alloc_maybe_populate_EXACT
</b>
</li>
<li><a name="allocmy"></a><b>allocmy
</b>
</li>
<li><a name="amagic_is_enabled"></a><b>amagic_is_enabled
</b>
</li>
<li><a name="append_utf8_from_native_byte"></a><b>append_utf8_from_native_byte
</b>
</li>
<li><a name="apply"></a><b>apply
</b>
</li>
<li><a name="av_extend_guts"></a><b>av_extend_guts
</b>
</li>
<li><a name="av_reify"></a><b>av_reify
</b>
</li>
<li><a name="bind_match"></a><b>bind_match
</b>
</li>
<li><a name="boot_core_PerlIO"></a><b>boot_core_PerlIO
</b>
</li>
<li><a name="boot_core_UNIVERSAL"></a><b>boot_core_UNIVERSAL
</b>
</li>
<li><a name="boot_core_mro"></a><b>boot_core_mro
</b>
</li>
<li><a name="cando"></a><b>cando
</b>
</li>
<li><a name="check_utf8_print"></a><b>check_utf8_print
</b>
</li>
<li><a name="ck_anoncode"></a><b>ck_anoncode
</b>
</li>
<li><a name="ck_backtick"></a><b>ck_backtick
</b>
</li>
<li><a name="ck_bitop"></a><b>ck_bitop
</b>
</li>
<li><a name="ck_cmp"></a><b>ck_cmp
</b>
</li>
<li><a name="ck_concat"></a><b>ck_concat
</b>
</li>
<li><a name="ck_defined"></a><b>ck_defined
</b>
</li>
<li><a name="ck_delete"></a><b>ck_delete
</b>
</li>
<li><a name="ck_each"></a><b>ck_each
</b>
</li>
<li><a name="ck_entersub_args_core"></a><b>ck_entersub_args_core
</b>
</li>
<li><a name="ck_eof"></a><b>ck_eof
</b>
</li>
<li><a name="ck_eval"></a><b>ck_eval
</b>
</li>
<li><a name="ck_exec"></a><b>ck_exec
</b>
</li>
<li><a name="ck_exists"></a><b>ck_exists
</b>
</li>
<li><a name="ck_ftst"></a><b>ck_ftst
</b>
</li>
<li><a name="ck_fun"></a><b>ck_fun
</b>
</li>
<li><a name="ck_glob"></a><b>ck_glob
</b>
</li>
<li><a name="ck_grep"></a><b>ck_grep
</b>
</li>
<li><a name="ck_index"></a><b>ck_index
</b>
</li>
<li><a name="ck_join"></a><b>ck_join
</b>
</li>
<li><a name="ck_length"></a><b>ck_length
</b>
</li>
<li><a name="ck_lfun"></a><b>ck_lfun
</b>
</li>
<li><a name="ck_listiob"></a><b>ck_listiob
</b>
</li>
<li><a name="ck_match"></a><b>ck_match
</b>
</li>
<li><a name="ck_method"></a><b>ck_method
</b>
</li>
<li><a name="ck_null"></a><b>ck_null
</b>
</li>
<li><a name="ck_open"></a><b>ck_open
</b>
</li>
<li><a name="ck_prototype"></a><b>ck_prototype
</b>
</li>
<li><a name="ck_readline"></a><b>ck_readline
</b>
</li>
<li><a name="ck_refassign"></a><b>ck_refassign
</b>
</li>
<li><a name="ck_repeat"></a><b>ck_repeat
</b>
</li>
<li><a name="ck_require"></a><b>ck_require
</b>
</li>
<li><a name="ck_return"></a><b>ck_return
</b>
</li>
<li><a name="ck_rfun"></a><b>ck_rfun
</b>
</li>
<li><a name="ck_rvconst"></a><b>ck_rvconst
</b>
</li>
<li><a name="ck_sassign"></a><b>ck_sassign
</b>
</li>
<li><a name="ck_select"></a><b>ck_select
</b>
</li>
<li><a name="ck_shift"></a><b>ck_shift
</b>
</li>
<li><a name="ck_smartmatch"></a><b>ck_smartmatch
</b>
</li>
<li><a name="ck_sort"></a><b>ck_sort
</b>
</li>
<li><a name="ck_spair"></a><b>ck_spair
</b>
</li>
<li><a name="ck_split"></a><b>ck_split
</b>
</li>
<li><a name="ck_stringify"></a><b>ck_stringify
</b>
</li>
<li><a name="ck_subr"></a><b>ck_subr
</b>
</li>
<li><a name="ck_substr"></a><b>ck_substr
</b>
</li>
<li><a name="ck_svconst"></a><b>ck_svconst
</b>
</li>
<li><a name="ck_tell"></a><b>ck_tell
</b>
</li>
<li><a name="ck_trunc"></a><b>ck_trunc
</b>
</li>
<li><a name="closest_cop"></a><b>closest_cop
</b>
</li>
<li><a name="compute_EXACTish"></a><b>compute_EXACTish
</b>
</li>
<li><a name="coresub_op"></a><b>coresub_op
</b>
</li>
<li><a name="create_eval_scope"></a><b>create_eval_scope
</b>
</li>
<li><a name="croak_caller"></a><b>croak_caller
</b>
</li>
<li><a name="croak_no_mem"></a><b>croak_no_mem
</b>
</li>
<li><a name="croak_popstack"></a><b>croak_popstack
</b>
</li>
<li><a name="current_re_engine"></a><b>current_re_engine
</b>
</li>
<li><a name="custom_op_get_field"></a><b>custom_op_get_field
</b>
</li>
<li><a name="cv_ckproto_len_flags"></a><b>cv_ckproto_len_flags
</b>
</li>
<li><a name="cv_clone_into"></a><b>cv_clone_into
</b>
</li>
<li><a name="cv_const_sv_or_av"></a><b>cv_const_sv_or_av
</b>
</li>
<li><a name="cv_undef_flags"></a><b>cv_undef_flags
</b>
</li>
<li><a name="cvgv_from_hek"></a><b>cvgv_from_hek
</b>
</li>
<li><a name="cvgv_set"></a><b>cvgv_set
</b>
</li>
<li><a name="cvstash_set"></a><b>cvstash_set
</b>
</li>
<li><a name="deb_stack_all"></a><b>deb_stack_all
</b>
</li>
<li><a name="defelem_target"></a><b>defelem_target
</b>
</li>
<li><a name="delete_eval_scope"></a><b>delete_eval_scope
</b>
</li>
<li><a name="delimcpy_no_escape"></a><b>delimcpy_no_escape
</b>
</li>
<li><a name="die_unwind"></a><b>die_unwind
</b>
</li>
<li><a name="do_aexec"></a><b>do_aexec
</b>
</li>
<li><a name="do_aexec5"></a><b>do_aexec5
</b>
</li>
<li><a name="do_eof"></a><b>do_eof
</b>
</li>
<li><a name="do_exec"></a><b>do_exec
</b>
</li>
<li><a name="do_exec3"></a><b>do_exec3
</b>
</li>
<li><a name="do_execfree"></a><b>do_execfree
</b>
</li>
<li><a name="do_ipcctl"></a><b>do_ipcctl
</b>
</li>
<li><a name="do_ipcget"></a><b>do_ipcget
</b>
</li>
<li><a name="do_msgrcv"></a><b>do_msgrcv
</b>
</li>
<li><a name="do_msgsnd"></a><b>do_msgsnd
</b>
</li>
<li><a name="do_ncmp"></a><b>do_ncmp
</b>
</li>
<li><a name="do_open6"></a><b>do_open6
</b>
</li>
<li><a name="do_open_raw"></a><b>do_open_raw
</b>
</li>
<li><a name="do_print"></a><b>do_print
</b>
</li>
<li><a name="do_readline"></a><b>do_readline
</b>
</li>
<li><a name="do_seek"></a><b>do_seek
</b>
</li>
<li><a name="do_semop"></a><b>do_semop
</b>
</li>
<li><a name="do_shmio"></a><b>do_shmio
</b>
</li>
<li><a name="do_sysseek"></a><b>do_sysseek
</b>
</li>
<li><a name="do_tell"></a><b>do_tell
</b>
</li>
<li><a name="do_trans"></a><b>do_trans
</b>
</li>
<li><a name="do_vecget"></a><b>do_vecget
</b>
</li>
<li><a name="do_vecset"></a><b>do_vecset
</b>
</li>
<li><a name="do_vop"></a><b>do_vop
</b>
</li>
<li><a name="does_utf8_overflow"></a><b>does_utf8_overflow
</b>
</li>
<li><a name="dofile"></a><b>dofile
</b>
</li>
<li><a name="drand48_init_r"></a><b>drand48_init_r
</b>
</li>
<li><a name="drand48_r"></a><b>drand48_r
</b>
</li>
<li><a name="dtrace_probe_call"></a><b>dtrace_probe_call
</b>
</li>
<li><a name="dtrace_probe_load"></a><b>dtrace_probe_load
</b>
</li>
<li><a name="dtrace_probe_op"></a><b>dtrace_probe_op
</b>
</li>
<li><a name="dtrace_probe_phase"></a><b>dtrace_probe_phase
</b>
</li>
<li><a name="dump_all_perl"></a><b>dump_all_perl
</b>
</li>
<li><a name="dump_packsubs_perl"></a><b>dump_packsubs_perl
</b>
</li>
<li><a name="dump_sub_perl"></a><b>dump_sub_perl
</b>
</li>
<li><a name="dump_sv_child"></a><b>dump_sv_child
</b>
</li>
<li><a name="emulate_cop_io"></a><b>emulate_cop_io
</b>
</li>
<li><a name="feature_is_enabled"></a><b>feature_is_enabled
</b>
</li>
<li><a name="find_lexical_cv"></a><b>find_lexical_cv
</b>
</li>
<li><a name="find_runcv_where"></a><b>find_runcv_where
</b>
</li>
<li><a name="find_script"></a><b>find_script
</b>
</li>
<li><a name="form_short_octal_warning"></a><b>form_short_octal_warning
</b>
</li>
<li><a name="free_tied_hv_pool"></a><b>free_tied_hv_pool
</b>
</li>
<li><a name="get_db_sub"></a><b>get_db_sub
</b>
</li>
<li><a name="get_debug_opts"></a><b>get_debug_opts
</b>
</li>
<li><a name="get_hash_seed"></a><b>get_hash_seed
</b>
</li>
<li><a name="get_invlist_iter_addr"></a><b>get_invlist_iter_addr
</b>
</li>
<li><a name="get_invlist_offset_addr"></a><b>get_invlist_offset_addr
</b>
</li>
<li><a name="get_invlist_previous_index_addr"></a><b>get_invlist_previous_index_addr
</b>
</li>
<li><a name="get_no_modify"></a><b>get_no_modify
</b>
</li>
<li><a name="get_opargs"></a><b>get_opargs
</b>
</li>
<li><a name="get_re_arg"></a><b>get_re_arg
</b>
</li>
<li><a name="getenv_len"></a><b>getenv_len
</b>
</li>
<li><a name="grok_atoUV"></a><b>grok_atoUV
</b>
</li>
<li><a name="grok_bslash_c"></a><b>grok_bslash_c
</b>
</li>
<li><a name="grok_bslash_o"></a><b>grok_bslash_o
</b>
</li>
<li><a name="grok_bslash_x"></a><b>grok_bslash_x
</b>
</li>
<li><a name="gv_fetchmeth_internal"></a><b>gv_fetchmeth_internal
</b>
</li>
<li><a name="gv_override"></a><b>gv_override
</b>
</li>
<li><a name="gv_setref"></a><b>gv_setref
</b>
</li>
<li><a name="gv_stashpvn_internal"></a><b>gv_stashpvn_internal
</b>
</li>
<li><a name="gv_stashsvpvn_cached"></a><b>gv_stashsvpvn_cached
</b>
</li>
<li><a name="handle_named_backref"></a><b>handle_named_backref
</b>
</li>
<li><a name="hfree_next_entry"></a><b>hfree_next_entry
</b>
</li>
<li><a name="hv_backreferences_p"></a><b>hv_backreferences_p
</b>
</li>
<li><a name="hv_kill_backrefs"></a><b>hv_kill_backrefs
</b>
</li>
<li><a name="hv_placeholders_p"></a><b>hv_placeholders_p
</b>
</li>
<li><a name="hv_undef_flags"></a><b>hv_undef_flags
</b>
</li>
<li><a name="init_argv_symbols"></a><b>init_argv_symbols
</b>
</li>
<li><a name="init_constants"></a><b>init_constants
</b>
</li>
<li><a name="init_dbargs"></a><b>init_dbargs
</b>
</li>
<li><a name="init_debugger"></a><b>init_debugger
</b>
</li>
<li><a name="invert"></a><b>invert
</b>
</li>
<li><a name="invlist_array"></a><b>invlist_array
</b>
</li>
<li><a name="invlist_clear"></a><b>invlist_clear
</b>
</li>
<li><a name="invlist_clone"></a><b>invlist_clone
</b>
</li>
<li><a name="invlist_highest"></a><b>invlist_highest
</b>
</li>
<li><a name="invlist_is_iterating"></a><b>invlist_is_iterating
</b>
</li>
<li><a name="invlist_iterfinish"></a><b>invlist_iterfinish
</b>
</li>
<li><a name="invlist_iterinit"></a><b>invlist_iterinit
</b>
</li>
<li><a name="invlist_max"></a><b>invlist_max
</b>
</li>
<li><a name="invlist_previous_index"></a><b>invlist_previous_index
</b>
</li>
<li><a name="invlist_set_len"></a><b>invlist_set_len
</b>
</li>
<li><a name="invlist_set_previous_index"></a><b>invlist_set_previous_index
</b>
</li>
<li><a name="invlist_trim"></a><b>invlist_trim
</b>
</li>
<li><a name="io_close"></a><b>io_close
</b>
</li>
<li><a name="isFF_OVERLONG"></a><b>isFF_OVERLONG
</b>
</li>
<li><a name="isFOO_lc"></a><b>isFOO_lc
</b>
</li>
<li><a name="is_utf8_common"></a><b>is_utf8_common
</b>
</li>
<li><a name="is_utf8_common_with_len"></a><b>is_utf8_common_with_len
</b>
</li>
<li><a name="is_utf8_cp_above_31_bits"></a><b>is_utf8_cp_above_31_bits
</b>
</li>
<li><a name="is_utf8_overlong_given_start_byte_ok"></a><b>is_utf8_overlong_given_start_byte_ok
</b>
</li>
<li><a name="isinfnansv"></a><b>isinfnansv
</b>
</li>
<li><a name="jmaybe"></a><b>jmaybe
</b>
</li>
<li><a name="keyword"></a><b>keyword
</b>
</li>
<li><a name="keyword_plugin_standard"></a><b>keyword_plugin_standard
</b>
</li>
<li><a name="list"></a><b>list
</b>
</li>
<li><a name="localize"></a><b>localize
</b>
</li>
<li><a name="magic_clear_all_env"></a><b>magic_clear_all_env
</b>
</li>
<li><a name="magic_cleararylen_p"></a><b>magic_cleararylen_p
</b>
</li>
<li><a name="magic_clearenv"></a><b>magic_clearenv
</b>
</li>
<li><a name="magic_clearisa"></a><b>magic_clearisa
</b>
</li>
<li><a name="magic_clearpack"></a><b>magic_clearpack
</b>
</li>
<li><a name="magic_clearsig"></a><b>magic_clearsig
</b>
</li>
<li><a name="magic_copycallchecker"></a><b>magic_copycallchecker
</b>
</li>
<li><a name="magic_existspack"></a><b>magic_existspack
</b>
</li>
<li><a name="magic_freearylen_p"></a><b>magic_freearylen_p
</b>
</li>
<li><a name="magic_freeovrld"></a><b>magic_freeovrld
</b>
</li>
<li><a name="magic_get"></a><b>magic_get
</b>
</li>
<li><a name="magic_getarylen"></a><b>magic_getarylen
</b>
</li>
<li><a name="magic_getdebugvar"></a><b>magic_getdebugvar
</b>
</li>
<li><a name="magic_getdefelem"></a><b>magic_getdefelem
</b>
</li>
<li><a name="magic_getnkeys"></a><b>magic_getnkeys
</b>
</li>
<li><a name="magic_getpack"></a><b>magic_getpack
</b>
</li>
<li><a name="magic_getpos"></a><b>magic_getpos
</b>
</li>
<li><a name="magic_getsig"></a><b>magic_getsig
</b>
</li>
<li><a name="magic_getsubstr"></a><b>magic_getsubstr
</b>
</li>
<li><a name="magic_gettaint"></a><b>magic_gettaint
</b>
</li>
<li><a name="magic_getuvar"></a><b>magic_getuvar
</b>
</li>
<li><a name="magic_getvec"></a><b>magic_getvec
</b>
</li>
<li><a name="magic_killbackrefs"></a><b>magic_killbackrefs
</b>
</li>
<li><a name="magic_nextpack"></a><b>magic_nextpack
</b>
</li>
<li><a name="magic_regdata_cnt"></a><b>magic_regdata_cnt
</b>
</li>
<li><a name="magic_regdatum_get"></a><b>magic_regdatum_get
</b>
</li>
<li><a name="magic_regdatum_set"></a><b>magic_regdatum_set
</b>
</li>
<li><a name="magic_scalarpack"></a><b>magic_scalarpack
</b>
</li>
<li><a name="magic_set"></a><b>magic_set
</b>
</li>
<li><a name="magic_set_all_env"></a><b>magic_set_all_env
</b>
</li>
<li><a name="magic_setarylen"></a><b>magic_setarylen
</b>
</li>
<li><a name="magic_setcollxfrm"></a><b>magic_setcollxfrm
</b>
</li>
<li><a name="magic_setdbline"></a><b>magic_setdbline
</b>
</li>
<li><a name="magic_setdebugvar"></a><b>magic_setdebugvar
</b>
</li>
<li><a name="magic_setdefelem"></a><b>magic_setdefelem
</b>
</li>
<li><a name="magic_setenv"></a><b>magic_setenv
</b>
</li>
<li><a name="magic_setisa"></a><b>magic_setisa
</b>
</li>
<li><a name="magic_setlvref"></a><b>magic_setlvref
</b>
</li>
<li><a name="magic_setmglob"></a><b>magic_setmglob
</b>
</li>
<li><a name="magic_setnkeys"></a><b>magic_setnkeys
</b>
</li>
<li><a name="magic_setpack"></a><b>magic_setpack
</b>
</li>
<li><a name="magic_setpos"></a><b>magic_setpos
</b>
</li>
<li><a name="magic_setregexp"></a><b>magic_setregexp
</b>
</li>
<li><a name="magic_setsig"></a><b>magic_setsig
</b>
</li>
<li><a name="magic_setsubstr"></a><b>magic_setsubstr
</b>
</li>
<li><a name="magic_settaint"></a><b>magic_settaint
</b>
</li>
<li><a name="magic_setutf8"></a><b>magic_setutf8
</b>
</li>
<li><a name="magic_setuvar"></a><b>magic_setuvar
</b>
</li>
<li><a name="magic_setvec"></a><b>magic_setvec
</b>
</li>
<li><a name="magic_sizepack"></a><b>magic_sizepack
</b>
</li>
<li><a name="magic_wipepack"></a><b>magic_wipepack
</b>
</li>
<li><a name="malloc_good_size"></a><b>malloc_good_size
</b>
</li>
<li><a name="malloced_size"></a><b>malloced_size
</b>
</li>
<li><a name="mem_collxfrm"></a><b>mem_collxfrm
</b>
</li>
<li><a name="mem_log_alloc"></a><b>mem_log_alloc
</b>
</li>
<li><a name="mem_log_free"></a><b>mem_log_free
</b>
</li>
<li><a name="mem_log_realloc"></a><b>mem_log_realloc
</b>
</li>
<li><a name="mg_find_mglob"></a><b>mg_find_mglob
</b>
</li>
<li><a name="mode_from_discipline"></a><b>mode_from_discipline
</b>
</li>
<li><a name="more_bodies"></a><b>more_bodies
</b>
</li>
<li><a name="mro_meta_dup"></a><b>mro_meta_dup
</b>
</li>
<li><a name="mro_meta_init"></a><b>mro_meta_init
</b>
</li>
<li><a name="multideref_stringify"></a><b>multideref_stringify
</b>
</li>
<li><a name="my_attrs"></a><b>my_attrs
</b>
</li>
<li><a name="my_clearenv"></a><b>my_clearenv
</b>
</li>
<li><a name="my_lstat_flags"></a><b>my_lstat_flags
</b>
</li>
<li><a name="my_stat_flags"></a><b>my_stat_flags
</b>
</li>
<li><a name="my_unexec"></a><b>my_unexec
</b>
</li>
<li><a name="newATTRSUB_x"></a><b>newATTRSUB_x
</b>
</li>
<li><a name="newGP"></a><b>newGP
</b>
</li>
<li><a name="newMETHOP_internal"></a><b>newMETHOP_internal
</b>
</li>
<li><a name="newSTUB"></a><b>newSTUB
</b>
</li>
<li><a name="newSVavdefelem"></a><b>newSVavdefelem
</b>
</li>
<li><a name="newXS_deffile"></a><b>newXS_deffile
</b>
</li>
<li><a name="newXS_len_flags"></a><b>newXS_len_flags
</b>
</li>
<li><a name="new_warnings_bitfield"></a><b>new_warnings_bitfield
</b>
</li>
<li><a name="nextargv"></a><b>nextargv
</b>
</li>
<li><a name="noperl_die"></a><b>noperl_die
</b>
</li>
<li><a name="notify_parser_that_changed_to_utf8"></a><b>notify_parser_that_changed_to_utf8
</b>
</li>
<li><a name="oopsAV"></a><b>oopsAV
</b>
</li>
<li><a name="oopsHV"></a><b>oopsHV
</b>
</li>
<li><a name="op_clear"></a><b>op_clear
</b>
</li>
<li><a name="op_integerize"></a><b>op_integerize
</b>
</li>
<li><a name="op_lvalue_flags"></a><b>op_lvalue_flags
</b>
</li>
<li><a name="op_refcnt_dec"></a><b>op_refcnt_dec
</b>
</li>
<li><a name="op_refcnt_inc"></a><b>op_refcnt_inc
</b>
</li>
<li><a name="op_relocate_sv"></a><b>op_relocate_sv
</b>
</li>
<li><a name="op_std_init"></a><b>op_std_init
</b>
</li>
<li><a name="op_unscope"></a><b>op_unscope
</b>
</li>
<li><a name="opmethod_stash"></a><b>opmethod_stash
</b>
</li>
<li><a name="opslab_force_free"></a><b>opslab_force_free
</b>
</li>
<li><a name="opslab_free"></a><b>opslab_free
</b>
</li>
<li><a name="opslab_free_nopad"></a><b>opslab_free_nopad
</b>
</li>
<li><a name="package"></a><b>package
</b>
</li>
<li><a name="package_version"></a><b>package_version
</b>
</li>
<li><a name="pad_add_weakref"></a><b>pad_add_weakref
</b>
</li>
<li><a name="padlist_store"></a><b>padlist_store
</b>
</li>
<li><a name="padname_free"></a><b>padname_free
</b>
</li>
<li><a name="padnamelist_free"></a><b>padnamelist_free
</b>
</li>
<li><a name="parse_unicode_opts"></a><b>parse_unicode_opts
</b>
</li>
<li><a name="parser_free"></a><b>parser_free
</b>
</li>
<li><a name="parser_free_nexttoke_ops"></a><b>parser_free_nexttoke_ops
</b>
</li>
<li><a name="path_is_searchable"></a><b>path_is_searchable
</b>
</li>
<li><a name="peep"></a><b>peep
</b>
</li>
<li><a name="pmruntime"></a><b>pmruntime
</b>
</li>
<li><a name="populate_isa"></a><b>populate_isa
</b>
</li>
<li><a name="ptr_hash"></a><b>ptr_hash
</b>
</li>
<li><a name="qerror"></a><b>qerror
</b>
</li>
<li><a name="re_exec_indentf"></a><b>re_exec_indentf
</b>
</li>
<li><a name="re_indentf"></a><b>re_indentf
</b>
</li>
<li><a name="re_op_compile"></a><b>re_op_compile
</b>
</li>
<li><a name="re_printf"></a><b>re_printf
</b>
</li>
<li><a name="reg_named_buff"></a><b>reg_named_buff
</b>
</li>
<li><a name="reg_named_buff_iter"></a><b>reg_named_buff_iter
</b>
</li>
<li><a name="reg_numbered_buff_fetch"></a><b>reg_numbered_buff_fetch
</b>
</li>
<li><a name="reg_numbered_buff_length"></a><b>reg_numbered_buff_length
</b>
</li>
<li><a name="reg_numbered_buff_store"></a><b>reg_numbered_buff_store
</b>
</li>
<li><a name="reg_qr_package"></a><b>reg_qr_package
</b>
</li>
<li><a name="reg_skipcomment"></a><b>reg_skipcomment
</b>
</li>
<li><a name="reg_temp_copy"></a><b>reg_temp_copy
</b>
</li>
<li><a name="regcurly"></a><b>regcurly
</b>
</li>
<li><a name="regprop"></a><b>regprop
</b>
</li>
<li><a name="report_evil_fh"></a><b>report_evil_fh
</b>
</li>
<li><a name="report_redefined_cv"></a><b>report_redefined_cv
</b>
</li>
<li><a name="report_wrongway_fh"></a><b>report_wrongway_fh
</b>
</li>
<li><a name="rpeep"></a><b>rpeep
</b>
</li>
<li><a name="rsignal_restore"></a><b>rsignal_restore
</b>
</li>
<li><a name="rsignal_save"></a><b>rsignal_save
</b>
</li>
<li><a name="rxres_save"></a><b>rxres_save
</b>
</li>
<li><a name="same_dirent"></a><b>same_dirent
</b>
</li>
<li><a name="save_strlen"></a><b>save_strlen
</b>
</li>
<li><a name="sawparens"></a><b>sawparens
</b>
</li>
<li><a name="scalar"></a><b>scalar
</b>
</li>
<li><a name="scalarvoid"></a><b>scalarvoid
</b>
</li>
<li><a name="set_caret_X"></a><b>set_caret_X
</b>
</li>
<li><a name="set_padlist"></a><b>set_padlist
</b>
</li>
<li><a name="should_warn_nl"></a><b>should_warn_nl
</b>
</li>
<li><a name="sighandler"></a><b>sighandler
</b>
</li>
<li><a name="softref2xv"></a><b>softref2xv
</b>
</li>
<li><a name="ssc_add_range"></a><b>ssc_add_range
</b>
</li>
<li><a name="ssc_clear_locale"></a><b>ssc_clear_locale
</b>
</li>
<li><a name="ssc_cp_and"></a><b>ssc_cp_and
</b>
</li>
<li><a name="ssc_intersection"></a><b>ssc_intersection
</b>
</li>
<li><a name="ssc_union"></a><b>ssc_union
</b>
</li>
<li><a name="sub_crush_depth"></a><b>sub_crush_depth
</b>
</li>
<li><a name="sv_add_backref"></a><b>sv_add_backref
</b>
</li>
<li><a name="sv_buf_to_ro"></a><b>sv_buf_to_ro
</b>
</li>
<li><a name="sv_del_backref"></a><b>sv_del_backref
</b>
</li>
<li><a name="sv_free2"></a><b>sv_free2
</b>
</li>
<li><a name="sv_kill_backrefs"></a><b>sv_kill_backrefs
</b>
</li>
<li><a name="sv_len_utf8_nomg"></a><b>sv_len_utf8_nomg
</b>
</li>
<li><a name="sv_magicext_mglob"></a><b>sv_magicext_mglob
</b>
</li>
<li><a name="sv_mortalcopy_flags"></a><b>sv_mortalcopy_flags
</b>
</li>
<li><a name="sv_only_taint_gmagic"></a><b>sv_only_taint_gmagic
</b>
</li>
<li><a name="sv_or_pv_pos_u2b"></a><b>sv_or_pv_pos_u2b
</b>
</li>
<li><a name="sv_resetpvn"></a><b>sv_resetpvn
</b>
</li>
<li><a name="sv_sethek"></a><b>sv_sethek
</b>
</li>
<li><a name="sv_setsv_cow"></a><b>sv_setsv_cow
</b>
</li>
<li><a name="sv_unglob"></a><b>sv_unglob
</b>
</li>
<li><a name="swash_fetch"></a><b>swash_fetch
</b>
</li>
<li><a name="swash_init"></a><b>swash_init
</b>
</li>
<li><a name="tied_method"></a><b>tied_method
</b>
</li>
<li><a name="tmps_grow_p"></a><b>tmps_grow_p
</b>
</li>
<li><a name="translate_substr_offsets"></a><b>translate_substr_offsets
</b>
</li>
<li><a name="try_amagic_bin"></a><b>try_amagic_bin
</b>
</li>
<li><a name="try_amagic_un"></a><b>try_amagic_un
</b>
</li>
<li><a name="unshare_hek"></a><b>unshare_hek
</b>
</li>
<li><a name="utilize"></a><b>utilize
</b>
</li>
<li><a name="varname"></a><b>varname
</b>
</li>
<li><a name="vivify_defelem"></a><b>vivify_defelem
</b>
</li>
<li><a name="vivify_ref"></a><b>vivify_ref
</b>
</li>
<li><a name="wait4pid"></a><b>wait4pid
</b>
</li>
<li><a name="was_lvalue_sub"></a><b>was_lvalue_sub
</b>
</li>
<li><a name="watch"></a><b>watch
</b>
</li>
<li><a name="win32_croak_not_implemented"></a><b>win32_croak_not_implemented
</b>
</li>
<li><a name="write_to_stderr"></a><b>write_to_stderr
</b>
</li>
<li><a name="xs_boot_epilog"></a><b>xs_boot_epilog
</b>
</li>
<li><a name="xs_handshake"></a><b>xs_handshake
</b>
</li>
<li><a name="yyerror"></a><b>yyerror
</b>
</li>
<li><a name="yyerror_pv"></a><b>yyerror_pv
</b>
</li>
<li><a name="yyerror_pvn"></a><b>yyerror_pvn
</b>
</li>
<li><a name="yylex"></a><b>yylex
</b>
</li>
<li><a name="yyparse"></a><b>yyparse
</b>
</li>
<li><a name="yyquit"></a><b>yyquit
</b>
</li>
<li><a name="yyunlex"></a><b>yyunlex
</b>
</li>
</ul>
<a name="AUTHORS"></a><h1>AUTHORS</h1>
<p>The autodocumentation system was originally added to the Perl core by
Benjamin Stuhl.  Documentation is by whoever was kind enough to
document their functions.</p>
<a name="SEE-ALSO"></a><h1>SEE ALSO</h1>
<p><a href="perlguts.html">perlguts</a>, <a href="perlapi.html">perlapi</a></p>




  <div id="page_index" class="hud_container">
    <div id="page_index_header" class="hud_header">
      <div id="page_index_close" class="hud_close"><a href="#" onClick="pageIndex.hide();return false;"></a></div>
      <div id="page_index_title" class="hud_title"><span class="hud_span_top">Page index</span></div>
      <div id="page_index_topright" class="hud_topright"></div>
    </div>
    <div id="page_index_content" class="hud_content">
      <ul><li><a href="#NAME">NAME</a><li><a href="#DESCRIPTION">DESCRIPTION
 </a><li><a href="#Compile-time-scope-hooks">Compile-time scope hooks</a><li><a href="#Custom-Operators">Custom Operators</a><li><a href="#CV-Manipulation-Functions">CV Manipulation Functions</a><li><a href="#CV-reference-counts-and-CvOUTSIDE">CV reference counts and CvOUTSIDE</a><li><a href="#Embedding-Functions">Embedding Functions</a><li><a href="#GV-Functions">GV Functions</a><li><a href="#Hash-Manipulation-Functions">Hash Manipulation Functions</a><li><a href="#IO-Functions">IO Functions</a><li><a href="#Lexer-interface">Lexer interface</a><li><a href="#Magical-Functions">Magical Functions</a><li><a href="#Miscellaneous-Functions">Miscellaneous Functions</a><li><a href="#MRO-Functions">MRO Functions</a><li><a href="#Optree-Manipulation-Functions">Optree Manipulation Functions</a><li><a href="#Pad-Data-Structures">Pad Data Structures</a><li><a href="#Per-Interpreter-Variables">Per-Interpreter Variables</a><li><a href="#Stack-Manipulation-Macros">Stack Manipulation Macros</a><li><a href="#SV-Body-Allocation">SV-Body Allocation</a><li><a href="#SV-Manipulation-Functions">SV Manipulation Functions</a><li><a href="#Unicode-Support">Unicode Support</a><li><a href="#Undocumented-functions">Undocumented functions</a><li><a href="#AUTHORS">AUTHORS</a><li><a href="#SEE-ALSO">SEE ALSO</a></ul>
    </div>
    <div id="page_index_footer" class="hud_footer">
      <div id="page_index_bottomleft" class="hud_bottomleft"></div>
      <div id="page_index_bottom" class="hud_bottom"><span class="hud_span_bottom"></span></div>
      <div id="page_index_resize" class="hud_resize"></div>
    </div>
  </div>


	    &nbsp;
          </div>
          <div id="content_footer">
          </div>
        </div>
        <div class="clear"></div>
      </div>
      
    <div id="footer">
      <div id="footer_content">
        <div id="footer_strapline">
          perldoc.perl.org - Official documentation for the Perl programming language
        </div>
        <div id="footer_links">
          <div id="address">
            <p class="name">Contact details</p>
            <p class="address">
	      Site maintained by <a href="mailto:jj@jonallen.info">Jon Allen (JJ)</a><br>
	    </p>
            <p class="contact">
              Documentation maintained by the <a href="http://lists.cpan.org/showlist.cgi?name=perl5-porters">Perl 5 Porters</a>
            </p>
          </div>
          <ul class="f1">
            <li>Manual
              <ul class="f2">
                <li><a href="index-overview.html">Overview</a>
                <li><a href="index-tutorials.html">Tutorials</a>
                <li><a href="index-faq.html">FAQs</a>
                <li><a href="index-history.html">Changes</a>
              </ul>
            <li>Reference
              <ul class="f2">
                <li><a href="index-language.html">Language</a>
                <li><a href="index-functions.html">Functions</a>
                <li><a href="perlop.html">Operators</a>
                <li><a href="perlvar.html">Variables</a>
              </ul>
            <li>Modules
              <ul class="f2">
                <li><a href="index-modules-A.html">Modules</a>
                <li><a href="index-pragmas.html">Pragmas</a>
                <li><a href="index-utilities.html">Utilities</a>
              </ul>
            <li>Misc
              <ul class="f2">
                <li><a href="index-licence.html">License</a>
                <li><a href="index-internals.html">Internals</a>
                <li><a href="index-platforms.html">Platforms</a>
              </ul>          </ul>
          <div class="clear"></div>
        </div>
      </div>
      <div id="footer_end">
      </div>
    </div>
      
    </div>
      <script language="JavaScript" type="text/javascript" src="static/exploreperl.js"></script>
      <script language="JavaScript" src="static/combined-20100403.js" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
  perldoc.setPath(0);
  perldoc.pageName    = 'perlintern';
  perldoc.pageAddress = 'perlintern.html';
  perldoc.contentPage = 1;
  explorePerl.render();
  explorePerl.addEvents('explore_anchor');
</script>
    
  </body>
</html>