/usr/share/perl/5.26.1/pod/perlapi.pod is in perl-doc 5.26.1-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563 12564 12565 12566 12567 12568 12569 12570 12571 12572 12573 12574 12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893 12894 12895 12896 12897 12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993 12994 12995 12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016 13017 13018 13019 13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115 13116 13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 13167 13168 13169 13170 13171 13172 13173 13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 13204 13205 13206 13207 13208 13209 13210 13211 13212 13213 13214 13215 13216 13217 13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228 13229 13230 13231 13232 13233 13234 13235 13236 13237 13238 13239 13240 13241 13242 13243 13244 13245 13246 13247 13248 13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259 13260 13261 13262 13263 13264 13265 13266 13267 13268 13269 13270 13271 13272 13273 13274 13275 13276 13277 13278 13279 13280 13281 13282 13283 13284 13285 13286 13287 13288 13289 13290 13291 13292 13293 13294 13295 13296 13297 13298 13299 13300 13301 13302 13303 13304 13305 13306 13307 13308 13309 13310 13311 13312 13313 13314 13315 13316 13317 13318 13319 13320 13321 13322 13323 13324 13325 13326 13327 13328 13329 13330 13331 13332 13333 13334 13335 13336 13337 13338 13339 13340 13341 13342 13343 13344 13345 13346 13347 13348 13349 13350 13351 13352 13353 13354 13355 13356 13357 13358 13359 13360 13361 13362 13363 13364 13365 13366 13367 13368 13369 13370 13371 13372 13373 13374 13375 13376 13377 13378 13379 13380 13381 13382 13383 13384 13385 13386 13387 13388 13389 13390 13391 13392 13393 13394 13395 13396 13397 13398 13399 13400 13401 13402 13403 13404 13405 13406 13407 13408 13409 13410 13411 13412 13413 13414 13415 13416 13417 13418 13419 13420 13421 13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 13451 13452 13453 13454 13455 13456 13457 13458 13459 13460 13461 13462 13463 13464 13465 13466 13467 13468 13469 13470 13471 13472 13473 13474 13475 13476 13477 13478 13479 13480 13481 13482 13483 13484 13485 13486 13487 13488 13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 13499 13500 13501 13502 13503 13504 13505 13506 13507 13508 13509 13510 13511 13512 13513 13514 13515 13516 13517 13518 13519 13520 13521 13522 13523 13524 13525 13526 13527 13528 13529 13530 13531 13532 13533 13534 13535 13536 13537 13538 13539 13540 13541 13542 13543 13544 13545 13546 13547 13548 13549 13550 13551 13552 13553 13554 13555 13556 13557 13558 13559 13560 13561 13562 13563 13564 13565 13566 13567 13568 13569 13570 13571 13572 13573 13574 13575 13576 13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 13610 13611 13612 13613 13614 13615 13616 13617 13618 13619 13620 13621 13622 13623 13624 13625 13626 13627 13628 13629 13630 13631 13632 13633 13634 13635 13636 13637 13638 13639 13640 13641 13642 13643 13644 13645 13646 13647 13648 13649 13650 13651 13652 13653 13654 13655 13656 13657 13658 13659 13660 13661 13662 13663 13664 13665 13666 13667 13668 13669 13670 13671 13672 13673 13674 13675 13676 13677 13678 13679 13680 13681 13682 13683 13684 13685 13686 13687 13688 13689 13690 13691 13692 13693 13694 13695 13696 13697 13698 13699 13700 13701 13702 13703 13704 13705 13706 13707 13708 13709 13710 13711 13712 13713 13714 13715 13716 13717 13718 13719 13720 13721 13722 13723 13724 13725 13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 13753 13754 13755 13756 13757 13758 13759 13760 13761 13762 13763 13764 13765 13766 13767 13768 13769 13770 13771 13772 13773 13774 13775 13776 13777 13778 13779 13780 13781 13782 13783 13784 13785 13786 13787 13788 13789 13790 13791 13792 13793 13794 13795 13796 13797 13798 13799 13800 13801 13802 13803 13804 13805 13806 13807 13808 13809 13810 13811 13812 13813 13814 13815 13816 13817 13818 13819 13820 13821 13822 13823 13824 13825 13826 13827 13828 13829 13830 13831 13832 13833 13834 13835 13836 13837 13838 13839 13840 13841 13842 13843 13844 13845 13846 13847 13848 13849 13850 13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 13871 13872 13873 13874 13875 13876 13877 13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 13890 13891 13892 13893 13894 13895 13896 13897 13898 13899 13900 13901 13902 13903 13904 13905 13906 13907 13908 13909 13910 13911 13912 13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 13942 13943 13944 13945 13946 13947 13948 13949 13950 13951 13952 13953 13954 13955 13956 13957 13958 13959 13960 13961 13962 13963 13964 13965 13966 13967 13968 13969 13970 13971 13972 13973 13974 13975 13976 13977 13978 13979 13980 13981 13982 13983 13984 13985 13986 13987 13988 13989 13990 13991 13992 13993 13994 13995 13996 13997 13998 13999 14000 14001 14002 14003 14004 14005 14006 14007 14008 14009 14010 14011 14012 14013 14014 14015 14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 14054 14055 14056 14057 14058 14059 14060 14061 14062 14063 14064 14065 14066 14067 14068 14069 14070 14071 14072 14073 14074 14075 14076 14077 14078 14079 14080 14081 14082 14083 14084 14085 14086 14087 14088 14089 14090 14091 14092 14093 14094 14095 14096 14097 14098 14099 14100 14101 14102 14103 14104 14105 14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133 14134 14135 14136 14137 14138 14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168 14169 14170 14171 14172 14173 14174 14175 14176 14177 14178 14179 14180 14181 14182 14183 14184 14185 14186 14187 14188 14189 14190 14191 14192 14193 14194 14195 14196 14197 14198 14199 14200 14201 14202 14203 14204 14205 14206 14207 14208 14209 14210 14211 14212 14213 14214 14215 14216 14217 14218 14219 14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235 14236 14237 14238 14239 14240 14241 14242 14243 14244 14245 14246 14247 14248 14249 14250 14251 14252 14253 14254 14255 14256 14257 14258 14259 14260 14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271 14272 14273 14274 14275 14276 14277 14278 14279 14280 14281 14282 14283 14284 14285 14286 14287 14288 14289 14290 14291 14292 14293 14294 14295 14296 14297 14298 14299 14300 14301 14302 14303 14304 14305 14306 14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319 14320 14321 14322 14323 14324 14325 14326 14327 14328 14329 14330 14331 14332 14333 14334 14335 14336 14337 14338 14339 14340 14341 14342 14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353 14354 14355 14356 14357 14358 14359 14360 14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377 14378 14379 14380 14381 14382 14383 14384 14385 14386 14387 14388 14389 14390 14391 14392 14393 14394 14395 14396 14397 14398 14399 14400 14401 14402 14403 14404 14405 14406 14407 14408 14409 14410 14411 14412 14413 14414 14415 14416 14417 14418 14419 14420 14421 14422 14423 14424 14425 14426 14427 14428 14429 14430 14431 14432 14433 14434 14435 14436 14437 14438 14439 14440 14441 14442 14443 14444 14445 14446 14447 14448 14449 14450 14451 14452 14453 14454 14455 14456 14457 14458 14459 14460 14461 14462 14463 14464 14465 14466 14467 14468 14469 14470 14471 14472 14473 14474 14475 14476 14477 14478 14479 14480 14481 14482 14483 14484 14485 14486 14487 14488 14489 14490 14491 14492 14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 14503 14504 14505 14506 14507 14508 14509 14510 14511 14512 14513 14514 14515 14516 14517 14518 14519 14520 14521 14522 14523 14524 14525 14526 14527 14528 14529 14530 14531 14532 14533 14534 14535 14536 14537 14538 14539 14540 14541 14542 14543 14544 14545 14546 14547 14548 14549 14550 14551 14552 14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563 14564 14565 14566 14567 14568 14569 14570 14571 14572 14573 14574 14575 14576 14577 14578 14579 14580 14581 14582 14583 14584 14585 14586 14587 14588 14589 14590 14591 14592 14593 14594 14595 14596 14597 14598 14599 14600 14601 14602 14603 14604 14605 14606 14607 14608 14609 14610 14611 14612 14613 14614 14615 14616 14617 14618 14619 14620 14621 14622 14623 14624 14625 14626 14627 14628 14629 14630 14631 14632 14633 14634 14635 14636 14637 14638 14639 14640 14641 14642 14643 14644 14645 14646 14647 14648 14649 14650 14651 14652 14653 14654 14655 14656 14657 14658 14659 14660 14661 14662 14663 14664 14665 14666 14667 14668 14669 14670 14671 14672 14673 14674 14675 14676 14677 14678 14679 14680 14681 14682 14683 14684 14685 14686 14687 14688 14689 14690 14691 14692 14693 14694 14695 14696 14697 14698 14699 14700 14701 14702 14703 14704 14705 14706 14707 14708 14709 14710 14711 14712 14713 14714 14715 14716 14717 14718 14719 14720 14721 14722 14723 14724 14725 14726 14727 14728 14729 14730 14731 14732 14733 14734 14735 14736 14737 14738 14739 14740 14741 14742 14743 14744 14745 14746 14747 14748 14749 14750 14751 14752 14753 14754 14755 14756 14757 14758 14759 14760 14761 14762 14763 14764 14765 14766 14767 14768 14769 14770 14771 14772 14773 14774 14775 14776 14777 14778 14779 14780 14781 14782 14783 14784 14785 14786 14787 14788 14789 14790 14791 14792 14793 14794 14795 14796 14797 14798 14799 14800 14801 14802 14803 14804 14805 14806 14807 14808 14809 14810 14811 14812 14813 14814 14815 14816 14817 14818 14819 14820 14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835 14836 14837 14838 14839 14840 14841 14842 14843 14844 14845 14846 14847 14848 14849 14850 14851 14852 14853 14854 14855 14856 14857 14858 14859 14860 14861 14862 14863 14864 14865 14866 14867 14868 14869 14870 14871 14872 14873 14874 14875 14876 14877 14878 14879 14880 14881 14882 14883 14884 14885 14886 14887 14888 14889 14890 14891 14892 14893 14894 14895 14896 14897 14898 14899 14900 14901 14902 14903 14904 14905 14906 14907 14908 14909 14910 14911 14912 14913 14914 14915 14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926 14927 14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938 14939 14940 14941 14942 14943 14944 14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960 14961 14962 14963 14964 14965 14966 14967 14968 14969 14970 14971 14972 14973 14974 14975 14976 14977 14978 14979 14980 14981 14982 14983 14984 14985 14986 14987 14988 14989 14990 14991 14992 14993 14994 14995 14996 14997 14998 14999 15000 15001 15002 15003 15004 15005 15006 15007 15008 15009 15010 15011 15012 15013 15014 15015 15016 15017 15018 15019 15020 15021 15022 15023 15024 15025 15026 15027 15028 15029 15030 15031 15032 15033 15034 15035 15036 15037 15038 15039 15040 15041 15042 15043 15044 15045 15046 15047 15048 15049 15050 15051 15052 15053 15054 15055 15056 15057 15058 15059 15060 15061 15062 15063 15064 15065 15066 15067 15068 15069 15070 15071 15072 15073 15074 15075 15076 15077 15078 15079 15080 15081 15082 15083 15084 15085 15086 15087 15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 15102 15103 15104 15105 15106 15107 15108 15109 15110 15111 15112 15113 15114 15115 15116 15117 15118 15119 15120 15121 15122 15123 15124 15125 15126 15127 15128 15129 15130 15131 15132 15133 15134 15135 15136 15137 15138 15139 15140 15141 15142 15143 15144 15145 15146 15147 15148 15149 15150 15151 15152 15153 15154 15155 15156 15157 15158 15159 15160 15161 15162 15163 15164 15165 15166 15167 15168 15169 15170 15171 15172 15173 15174 15175 15176 15177 15178 15179 15180 15181 15182 15183 15184 15185 15186 15187 15188 15189 15190 15191 15192 15193 15194 15195 15196 15197 15198 15199 15200 15201 15202 15203 15204 15205 15206 15207 15208 15209 15210 15211 15212 15213 15214 15215 15216 15217 15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 15229 15230 15231 15232 15233 15234 15235 15236 15237 15238 15239 15240 15241 15242 15243 15244 15245 15246 15247 15248 15249 15250 15251 15252 15253 15254 15255 15256 15257 15258 15259 15260 15261 15262 15263 15264 15265 15266 15267 15268 15269 15270 15271 15272 15273 15274 15275 15276 15277 15278 15279 15280 15281 15282 15283 15284 15285 15286 15287 15288 15289 15290 15291 15292 15293 15294 15295 15296 15297 15298 15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 15312 15313 15314 15315 15316 15317 15318 15319 15320 15321 15322 15323 15324 15325 15326 15327 15328 15329 15330 15331 15332 15333 15334 15335 15336 15337 15338 15339 15340 15341 15342 15343 15344 15345 15346 15347 15348 15349 15350 15351 15352 15353 15354 15355 15356 15357 15358 15359 15360 15361 15362 15363 15364 15365 15366 15367 15368 15369 15370 15371 15372 15373 15374 15375 15376 15377 15378 15379 15380 15381 15382 15383 15384 15385 15386 15387 15388 15389 15390 15391 15392 15393 15394 15395 15396 15397 15398 15399 15400 15401 15402 15403 15404 15405 15406 15407 15408 15409 15410 15411 15412 15413 15414 15415 15416 15417 15418 15419 15420 15421 15422 15423 15424 15425 15426 15427 15428 15429 15430 15431 15432 15433 15434 15435 15436 15437 15438 15439 15440 15441 15442 15443 15444 15445 15446 15447 15448 15449 15450 15451 15452 15453 15454 15455 15456 15457 15458 15459 15460 15461 15462 15463 15464 15465 15466 15467 15468 15469 15470 15471 15472 15473 15474 15475 15476 15477 15478 15479 15480 15481 15482 15483 15484 15485 15486 15487 15488 15489 15490 15491 15492 15493 15494 15495 15496 15497 15498 15499 15500 15501 15502 15503 15504 15505 15506 15507 15508 15509 15510 15511 15512 15513 15514 15515 15516 15517 15518 15519 15520 15521 15522 15523 15524 15525 15526 15527 15528 15529 15530 15531 15532 15533 15534 15535 15536 15537 15538 15539 15540 15541 15542 15543 15544 15545 15546 15547 15548 15549 15550 15551 15552 15553 15554 15555 15556 15557 15558 15559 15560 15561 15562 15563 15564 15565 15566 15567 15568 15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 15589 15590 15591 15592 15593 15594 15595 15596 15597 15598 15599 15600 15601 15602 15603 15604 15605 15606 15607 15608 15609 15610 15611 15612 15613 15614 15615 15616 15617 15618 15619 15620 15621 15622 15623 15624 15625 15626 15627 15628 15629 15630 15631 15632 15633 15634 15635 15636 15637 15638 15639 15640 15641 15642 15643 15644 15645 15646 15647 15648 15649 15650 15651 15652 15653 15654 15655 15656 15657 15658 15659 15660 15661 15662 15663 15664 15665 15666 15667 15668 15669 15670 15671 15672 15673 15674 15675 15676 15677 15678 15679 15680 15681 15682 15683 15684 15685 15686 15687 15688 15689 15690 15691 15692 15693 15694 15695 15696 15697 15698 15699 15700 15701 15702 15703 15704 15705 15706 15707 15708 15709 15710 15711 15712 15713 15714 15715 15716 15717 15718 15719 15720 15721 15722 15723 15724 15725 15726 15727 15728 15729 15730 15731 15732 15733 15734 15735 15736 15737 15738 15739 15740 15741 15742 15743 15744 15745 15746 15747 15748 15749 15750 15751 15752 15753 15754 15755 15756 15757 15758 15759 15760 15761 15762 15763 15764 15765 15766 15767 15768 15769 15770 15771 15772 15773 15774 15775 15776 15777 15778 15779 15780 15781 15782 15783 15784 15785 15786 15787 15788 15789 15790 15791 15792 15793 15794 15795 15796 15797 15798 15799 15800 15801 15802 15803 15804 15805 15806 15807 15808 15809 15810 15811 15812 15813 15814 15815 15816 15817 15818 15819 15820 15821 15822 15823 15824 15825 15826 15827 15828 15829 15830 15831 15832 15833 15834 15835 15836 15837 15838 15839 15840 15841 15842 15843 15844 15845 15846 15847 15848 15849 15850 15851 15852 15853 15854 15855 15856 15857 15858 15859 15860 15861 15862 15863 15864 15865 15866 15867 15868 15869 15870 15871 15872 15873 15874 15875 15876 15877 15878 15879 15880 15881 15882 15883 15884 15885 15886 15887 15888 15889 15890 15891 15892 15893 15894 15895 15896 15897 15898 15899 15900 15901 15902 15903 15904 15905 15906 15907 15908 15909 15910 15911 15912 15913 15914 15915 15916 15917 15918 15919 15920 15921 15922 15923 15924 15925 15926 15927 15928 15929 15930 15931 15932 15933 15934 15935 15936 15937 15938 15939 15940 15941 15942 15943 15944 15945 15946 15947 15948 15949 15950 15951 15952 15953 15954 15955 15956 15957 15958 15959 15960 15961 15962 15963 15964 15965 15966 15967 15968 15969 15970 15971 15972 15973 15974 15975 15976 15977 15978 15979 15980 15981 15982 15983 15984 15985 15986 15987 15988 15989 15990 15991 15992 15993 15994 15995 15996 15997 15998 15999 16000 16001 16002 16003 16004 16005 16006 16007 16008 16009 16010 16011 16012 16013 16014 16015 16016 16017 16018 16019 16020 16021 16022 16023 16024 16025 16026 16027 16028 16029 16030 16031 16032 16033 16034 16035 16036 16037 16038 16039 16040 16041 16042 16043 16044 16045 16046 16047 16048 16049 16050 16051 16052 16053 16054 16055 16056 16057 16058 16059 16060 16061 16062 16063 16064 16065 16066 16067 16068 16069 16070 16071 16072 16073 16074 16075 16076 16077 16078 16079 16080 16081 16082 16083 16084 16085 16086 16087 16088 16089 16090 16091 16092 16093 16094 16095 16096 16097 16098 16099 16100 16101 16102 16103 16104 16105 16106 16107 16108 16109 16110 16111 16112 16113 16114 16115 16116 16117 16118 16119 16120 16121 16122 16123 16124 16125 16126 16127 16128 16129 16130 16131 16132 16133 16134 16135 16136 16137 16138 16139 16140 16141 16142 16143 16144 16145 16146 16147 16148 16149 16150 16151 16152 16153 16154 16155 16156 16157 16158 16159 16160 16161 16162 16163 16164 16165 16166 16167 16168 16169 16170 16171 16172 16173 16174 16175 16176 16177 16178 16179 16180 16181 16182 16183 16184 16185 16186 16187 16188 16189 16190 16191 16192 16193 16194 16195 16196 16197 16198 16199 16200 16201 16202 16203 16204 16205 16206 16207 16208 16209 16210 16211 16212 16213 16214 16215 16216 16217 16218 16219 16220 16221 16222 16223 16224 16225 16226 16227 16228 16229 16230 16231 16232 16233 16234 16235 16236 16237 16238 16239 16240 16241 16242 16243 16244 16245 16246 16247 16248 16249 16250 16251 16252 16253 16254 16255 16256 16257 16258 16259 16260 16261 16262 16263 16264 16265 16266 16267 16268 16269 16270 16271 16272 16273 16274 16275 16276 16277 16278 16279 16280 16281 16282 16283 16284 16285 16286 16287 16288 16289 16290 16291 16292 16293 16294 16295 16296 16297 16298 16299 16300 16301 16302 16303 16304 16305 16306 16307 16308 16309 16310 16311 16312 16313 16314 16315 16316 16317 16318 16319 16320 16321 16322 16323 16324 16325 16326 16327 16328 16329 16330 16331 16332 16333 16334 16335 16336 16337 16338 16339 16340 16341 16342 16343 16344 16345 16346 16347 16348 16349 16350 16351 16352 16353 16354 16355 16356 16357 16358 16359 16360 16361 16362 16363 16364 16365 16366 16367 16368 16369 16370 16371 16372 16373 16374 16375 16376 16377 16378 16379 16380 16381 16382 16383 16384 16385 16386 16387 16388 16389 16390 16391 16392 16393 16394 16395 16396 16397 16398 16399 16400 16401 16402 16403 16404 16405 16406 16407 16408 16409 16410 16411 16412 16413 16414 16415 16416 16417 16418 16419 16420 16421 16422 16423 16424 16425 16426 16427 16428 16429 16430 16431 16432 16433 16434 16435 16436 16437 16438 16439 16440 16441 16442 16443 16444 16445 16446 16447 16448 16449 16450 16451 16452 16453 16454 16455 16456 16457 16458 16459 16460 16461 16462 16463 16464 16465 16466 16467 16468 16469 16470 16471 16472 16473 16474 16475 16476 16477 16478 16479 16480 16481 16482 16483 16484 16485 16486 16487 16488 16489 16490 16491 16492 16493 16494 16495 16496 16497 16498 16499 16500 16501 16502 16503 16504 16505 16506 16507 16508 16509 16510 16511 16512 16513 16514 16515 16516 16517 16518 16519 16520 16521 16522 16523 16524 16525 | -*- buffer-read-only: t -*-
!!!!!!! DO NOT EDIT THIS FILE !!!!!!!
This file is built by autodoc.pl extracting documentation from the C source
files.
Any changes made here will be lost!
=head1 NAME
perlapi - autogenerated documentation for the perl public API
=head1 DESCRIPTION
X<Perl API> X<API> X<api>
This file contains the documentation of the perl public API generated by
F<embed.pl>, specifically a listing of functions, macros, flags, and variables
that may be used by extension writers. L<At the end|/Undocumented functions>
is a list of functions which have yet to be documented. The interfaces of
those are subject to change without notice. Anything not listed here is
not part of the public API, and should not be used by extension writers at
all. For these reasons, blindly using functions listed in proto.h is to be
avoided when writing extensions.
In Perl, unlike C, a string of characters may generally contain embedded
C<NUL> characters. Sometimes in the documentation a Perl string is referred
to as a "buffer" to distinguish it from a C string, but sometimes they are
both just referred to as strings.
Note that all Perl API global variables must be referenced with the C<PL_>
prefix. Again, those not listed here are not to be used by extension writers,
and can be changed or removed without notice; same with macros.
Some macros are provided for compatibility with the older,
unadorned names, but this support may be disabled in a future release.
Perl was originally written to handle US-ASCII only (that is characters
whose ordinal numbers are in the range 0 - 127).
And documentation and comments may still use the term ASCII, when
sometimes in fact the entire range from 0 - 255 is meant.
The non-ASCII characters below 256 can have various meanings, depending on
various things. (See, most notably, L<perllocale>.) But usually the whole
range can be referred to as ISO-8859-1. Often, the term "Latin-1" (or
"Latin1") is used as an equivalent for ISO-8859-1. But some people treat
"Latin1" as referring just to the characters in the range 128 through 255, or
somethimes from 160 through 255.
This documentation uses "Latin1" and "Latin-1" to refer to all 256 characters.
Note that Perl can be compiled and run under either ASCII or EBCDIC (See
L<perlebcdic>). Most of the documentation (and even comments in the code)
ignore the EBCDIC possibility.
For almost all purposes the differences are transparent.
As an example, under EBCDIC,
instead of UTF-8, UTF-EBCDIC is used to encode Unicode strings, and so
whenever this documentation refers to C<utf8>
(and variants of that name, including in function names),
it also (essentially transparently) means C<UTF-EBCDIC>.
But the ordinals of characters differ between ASCII, EBCDIC, and
the UTF- encodings, and a string encoded in UTF-EBCDIC may occupy a different
number of bytes than in UTF-8.
The listing below is alphabetical, case insensitive.
=head1 Array Manipulation Functions
=over 8
=item av_clear
X<av_clear>
Frees the all the elements of an array, leaving it empty.
The XS equivalent of C<@array = ()>. See also L</av_undef>.
Note that it is possible that the actions of a destructor called directly
or indirectly by freeing an element of the array could cause the reference
count of the array itself to be reduced (e.g. by deleting an entry in the
symbol table). So it is a possibility that the AV could have been freed
(or even reallocated) on return from the call unless you hold a reference
to it.
void av_clear(AV *av)
=for hackers
Found in file av.c
=item av_create_and_push
X<av_create_and_push>
NOTE: this function is experimental and may change or be
removed without notice.
Push an SV onto the end of the array, creating the array if necessary.
A small internal helper function to remove a commonly duplicated idiom.
void av_create_and_push(AV **const avp,
SV *const val)
=for hackers
Found in file av.c
=item av_create_and_unshift_one
X<av_create_and_unshift_one>
NOTE: this function is experimental and may change or be
removed without notice.
Unshifts an SV onto the beginning of the array, creating the array if
necessary.
A small internal helper function to remove a commonly duplicated idiom.
SV** av_create_and_unshift_one(AV **const avp,
SV *const val)
=for hackers
Found in file av.c
=item av_delete
X<av_delete>
Deletes the element indexed by C<key> from the array, makes the element
mortal, and returns it. If C<flags> equals C<G_DISCARD>, the element is
freed and NULL is returned. NULL is also returned if C<key> is out of
range.
Perl equivalent: S<C<splice(@myarray, $key, 1, undef)>> (with the
C<splice> in void context if C<G_DISCARD> is present).
SV* av_delete(AV *av, SSize_t key, I32 flags)
=for hackers
Found in file av.c
=item av_exists
X<av_exists>
Returns true if the element indexed by C<key> has been initialized.
This relies on the fact that uninitialized array elements are set to
C<NULL>.
Perl equivalent: C<exists($myarray[$key])>.
bool av_exists(AV *av, SSize_t key)
=for hackers
Found in file av.c
=item av_extend
X<av_extend>
Pre-extend an array. The C<key> is the index to which the array should be
extended.
void av_extend(AV *av, SSize_t key)
=for hackers
Found in file av.c
=item av_fetch
X<av_fetch>
Returns the SV at the specified index in the array. The C<key> is the
index. If lval is true, you are guaranteed to get a real SV back (in case
it wasn't real before), which you can then modify. Check that the return
value is non-null before dereferencing it to a C<SV*>.
See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
more information on how to use this function on tied arrays.
The rough perl equivalent is C<$myarray[$key]>.
SV** av_fetch(AV *av, SSize_t key, I32 lval)
=for hackers
Found in file av.c
=item AvFILL
X<AvFILL>
Same as C<av_top_index()>. Deprecated, use C<av_top_index()> instead.
int AvFILL(AV* av)
=for hackers
Found in file av.h
=item av_fill
X<av_fill>
Set the highest index in the array to the given number, equivalent to
Perl's S<C<$#array = $fill;>>.
The number of elements in the array will be S<C<fill + 1>> after
C<av_fill()> returns. If the array was previously shorter, then the
additional elements appended are set to NULL. If the array
was longer, then the excess elements are freed. S<C<av_fill(av, -1)>> is
the same as C<av_clear(av)>.
void av_fill(AV *av, SSize_t fill)
=for hackers
Found in file av.c
=item av_len
X<av_len>
Same as L</av_top_index>. Note that, unlike what the name implies, it returns
the highest index in the array, so to get the size of the array you need to use
S<C<av_len(av) + 1>>. This is unlike L</sv_len>, which returns what you would
expect.
SSize_t av_len(AV *av)
=for hackers
Found in file av.c
=item av_make
X<av_make>
Creates a new AV and populates it with a list of SVs. The SVs are copied
into the array, so they may be freed after the call to C<av_make>. The new AV
will have a reference count of 1.
Perl equivalent: C<my @new_array = ($scalar1, $scalar2, $scalar3...);>
AV* av_make(SSize_t size, SV **strp)
=for hackers
Found in file av.c
=item av_pop
X<av_pop>
Removes one SV from the end of the array, reducing its size by one and
returning the SV (transferring control of one reference count) to the
caller. Returns C<&PL_sv_undef> if the array is empty.
Perl equivalent: C<pop(@myarray);>
SV* av_pop(AV *av)
=for hackers
Found in file av.c
=item av_push
X<av_push>
Pushes an SV (transferring control of one reference count) onto the end of the
array. The array will grow automatically to accommodate the addition.
Perl equivalent: C<push @myarray, $val;>.
void av_push(AV *av, SV *val)
=for hackers
Found in file av.c
=item av_shift
X<av_shift>
Removes one SV from the start of the array, reducing its size by one and
returning the SV (transferring control of one reference count) to the
caller. Returns C<&PL_sv_undef> if the array is empty.
Perl equivalent: C<shift(@myarray);>
SV* av_shift(AV *av)
=for hackers
Found in file av.c
=item av_store
X<av_store>
Stores an SV in an array. The array index is specified as C<key>. The
return value will be C<NULL> if the operation failed or if the value did not
need to be actually stored within the array (as in the case of tied
arrays). Otherwise, it can be dereferenced
to get the C<SV*> that was stored
there (= C<val>)).
Note that the caller is responsible for suitably incrementing the reference
count of C<val> before the call, and decrementing it if the function
returned C<NULL>.
Approximate Perl equivalent: C<splice(@myarray, $key, 1, $val)>.
See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
more information on how to use this function on tied arrays.
SV** av_store(AV *av, SSize_t key, SV *val)
=for hackers
Found in file av.c
=item av_tindex
X<av_tindex>
Same as C<av_top_index()>.
int av_tindex(AV* av)
=for hackers
Found in file av.h
=item av_top_index
X<av_top_index>
Returns the highest index in the array. The number of elements in the
array is S<C<av_top_index(av) + 1>>. Returns -1 if the array is empty.
The Perl equivalent for this is C<$#myarray>.
(A slightly shorter form is C<av_tindex>.)
SSize_t av_top_index(AV *av)
=for hackers
Found in file av.c
=item av_undef
X<av_undef>
Undefines the array. The XS equivalent of C<undef(@array)>.
As well as freeing all the elements of the array (like C<av_clear()>), this
also frees the memory used by the av to store its list of scalars.
See L</av_clear> for a note about the array possibly being invalid on
return.
void av_undef(AV *av)
=for hackers
Found in file av.c
=item av_unshift
X<av_unshift>
Unshift the given number of C<undef> values onto the beginning of the
array. The array will grow automatically to accommodate the addition.
Perl equivalent: S<C<unshift @myarray, ((undef) x $num);>>
void av_unshift(AV *av, SSize_t num)
=for hackers
Found in file av.c
=item get_av
X<get_av>
Returns the AV of the specified Perl global or package array with the given
name (so it won't work on lexical variables). C<flags> are passed
to C<gv_fetchpv>. If C<GV_ADD> is set and the
Perl variable does not exist then it will be created. If C<flags> is zero
and the variable does not exist then NULL is returned.
Perl equivalent: C<@{"$name"}>.
NOTE: the perl_ form of this function is deprecated.
AV* get_av(const char *name, I32 flags)
=for hackers
Found in file perl.c
=item newAV
X<newAV>
Creates a new AV. The reference count is set to 1.
Perl equivalent: C<my @array;>.
AV* newAV()
=for hackers
Found in file av.h
=item sortsv
X<sortsv>
In-place sort an array of SV pointers with the given comparison routine.
Currently this always uses mergesort. See C<L</sortsv_flags>> for a more
flexible routine.
void sortsv(SV** array, size_t num_elts,
SVCOMPARE_t cmp)
=for hackers
Found in file pp_sort.c
=item sortsv_flags
X<sortsv_flags>
In-place sort an array of SV pointers with the given comparison routine,
with various SORTf_* flag options.
void sortsv_flags(SV** array, size_t num_elts,
SVCOMPARE_t cmp, U32 flags)
=for hackers
Found in file pp_sort.c
=back
=head1 Callback Functions
=over 8
=item call_argv
X<call_argv>
Performs a callback to the specified named and package-scoped Perl subroutine
with C<argv> (a C<NULL>-terminated array of strings) as arguments. See
L<perlcall>.
Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
NOTE: the perl_ form of this function is deprecated.
I32 call_argv(const char* sub_name, I32 flags,
char** argv)
=for hackers
Found in file perl.c
=item call_method
X<call_method>
Performs a callback to the specified Perl method. The blessed object must
be on the stack. See L<perlcall>.
NOTE: the perl_ form of this function is deprecated.
I32 call_method(const char* methname, I32 flags)
=for hackers
Found in file perl.c
=item call_pv
X<call_pv>
Performs a callback to the specified Perl sub. See L<perlcall>.
NOTE: the perl_ form of this function is deprecated.
I32 call_pv(const char* sub_name, I32 flags)
=for hackers
Found in file perl.c
=item call_sv
X<call_sv>
Performs a callback to the Perl sub specified by the SV.
If neither the C<G_METHOD> nor C<G_METHOD_NAMED> flag is supplied, the
SV may be any of a CV, a GV, a reference to a CV, a reference to a GV
or C<SvPV(sv)> will be used as the name of the sub to call.
If the C<G_METHOD> flag is supplied, the SV may be a reference to a CV or
C<SvPV(sv)> will be used as the name of the method to call.
If the C<G_METHOD_NAMED> flag is supplied, C<SvPV(sv)> will be used as
the name of the method to call.
Some other values are treated specially for internal use and should
not be depended on.
See L<perlcall>.
NOTE: the perl_ form of this function is deprecated.
I32 call_sv(SV* sv, VOL I32 flags)
=for hackers
Found in file perl.c
=item ENTER
X<ENTER>
Opening bracket on a callback. See C<L</LEAVE>> and L<perlcall>.
ENTER;
=for hackers
Found in file scope.h
=item ENTER_with_name(name)
X<ENTER_with_name(name)>
Same as C<L</ENTER>>, but when debugging is enabled it also associates the
given literal string with the new scope.
ENTER_with_name(name);
=for hackers
Found in file scope.h
=item eval_pv
X<eval_pv>
Tells Perl to C<eval> the given string in scalar context and return an SV* result.
NOTE: the perl_ form of this function is deprecated.
SV* eval_pv(const char* p, I32 croak_on_error)
=for hackers
Found in file perl.c
=item eval_sv
X<eval_sv>
Tells Perl to C<eval> the string in the SV. It supports the same flags
as C<call_sv>, with the obvious exception of C<G_EVAL>. See L<perlcall>.
NOTE: the perl_ form of this function is deprecated.
I32 eval_sv(SV* sv, I32 flags)
=for hackers
Found in file perl.c
=item FREETMPS
X<FREETMPS>
Closing bracket for temporaries on a callback. See C<L</SAVETMPS>> and
L<perlcall>.
FREETMPS;
=for hackers
Found in file scope.h
=item LEAVE
X<LEAVE>
Closing bracket on a callback. See C<L</ENTER>> and L<perlcall>.
LEAVE;
=for hackers
Found in file scope.h
=item LEAVE_with_name(name)
X<LEAVE_with_name(name)>
Same as C<L</LEAVE>>, but when debugging is enabled it first checks that the
scope has the given name. C<name> must be a C<NUL>-terminated literal string.
LEAVE_with_name(name);
=for hackers
Found in file scope.h
=item SAVETMPS
X<SAVETMPS>
Opening bracket for temporaries on a callback. See C<L</FREETMPS>> and
L<perlcall>.
SAVETMPS;
=for hackers
Found in file scope.h
=back
=head1 Character case changing
Perl uses "full" Unicode case mappings. This means that converting a single
character to another case may result in a sequence of more than one character.
For example, the uppercase of C<E<223>> (LATIN SMALL LETTER SHARP S) is the two
character sequence C<SS>. This presents some complications The lowercase of
all characters in the range 0..255 is a single character, and thus
C<L</toLOWER_L1>> is furnished. But, C<toUPPER_L1> can't exist, as it couldn't
return a valid result for all legal inputs. Instead C<L</toUPPER_uvchr>> has
an API that does allow every possible legal result to be returned.) Likewise
no other function that is crippled by not being able to give the correct
results for the full range of possible inputs has been implemented here.
=over 8
=item toFOLD
X<toFOLD>
Converts the specified character to foldcase. If the input is anything but an
ASCII uppercase character, that input character itself is returned. Variant
C<toFOLD_A> is equivalent. (There is no equivalent C<to_FOLD_L1> for the full
Latin1 range, as the full generality of L</toFOLD_uvchr> is needed there.)
U8 toFOLD(U8 ch)
=for hackers
Found in file handy.h
=item toFOLD_utf8
X<toFOLD_utf8>
This is like C<L</toFOLD_utf8_safe>>, but doesn't have the C<e>
parameter The function therefore can't check if it is reading
beyond the end of the string. Starting in Perl v5.30, it will take the C<e>
parameter, becoming a synonym for C<toFOLD_utf8_safe>. At that time every
program that uses it will have to be changed to successfully compile. In the
meantime, the first runtime call to C<toFOLD_utf8> from each call point in the
program will raise a deprecation warning, enabled by default. You can convert
your program now to use C<toFOLD_utf8_safe>, and avoid the warnings, and get an
extra measure of protection, or you can wait until v5.30, when you'll be forced
to add the C<e> parameter.
UV toFOLD_utf8(U8* p, U8* s, STRLEN* lenp)
=for hackers
Found in file handy.h
=item toFOLD_utf8_safe
X<toFOLD_utf8_safe>
Converts the first UTF-8 encoded character in the sequence starting at C<p> and
extending no further than S<C<e - 1>> to its foldcase version, and
stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note
that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
bytes since the foldcase version may be longer than the original character.
The first code point of the foldcased version is returned
(but note, as explained at L<the top of this section|/Character case
changing>, that there may be more).
The suffix C<_safe> in the function's name indicates that it will not attempt
to read beyond S<C<e - 1>>, provided that the constraint S<C<s E<lt> e>> is
true (this is asserted for in C<-DDEBUGGING> builds). If the UTF-8 for the
input character is malformed in some way, the program may croak, or the
function may return the REPLACEMENT CHARACTER, at the discretion of the
implementation, and subject to change in future releases.
UV toFOLD_utf8_safe(U8* p, U8* e, U8* s,
STRLEN* lenp)
=for hackers
Found in file handy.h
=item toFOLD_uvchr
X<toFOLD_uvchr>
Converts the code point C<cp> to its foldcase version, and
stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. The code
point is interpreted as native if less than 256; otherwise as Unicode. Note
that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
bytes since the foldcase version may be longer than the original character.
The first code point of the foldcased version is returned
(but note, as explained at L<the top of this section|/Character case
changing>, that there may be more).
UV toFOLD_uvchr(UV cp, U8* s, STRLEN* lenp)
=for hackers
Found in file handy.h
=item toLOWER
X<toLOWER>
Converts the specified character to lowercase. If the input is anything but an
ASCII uppercase character, that input character itself is returned. Variant
C<toLOWER_A> is equivalent.
U8 toLOWER(U8 ch)
=for hackers
Found in file handy.h
=item toLOWER_L1
X<toLOWER_L1>
Converts the specified Latin1 character to lowercase. The results are
undefined if the input doesn't fit in a byte.
U8 toLOWER_L1(U8 ch)
=for hackers
Found in file handy.h
=item toLOWER_LC
X<toLOWER_LC>
Converts the specified character to lowercase using the current locale's rules,
if possible; otherwise returns the input character itself.
U8 toLOWER_LC(U8 ch)
=for hackers
Found in file handy.h
=item toLOWER_utf8
X<toLOWER_utf8>
This is like C<L</toLOWER_utf8_safe>>, but doesn't have the C<e>
parameter The function therefore can't check if it is reading
beyond the end of the string. Starting in Perl v5.30, it will take the C<e>
parameter, becoming a synonym for C<toLOWER_utf8_safe>. At that time every
program that uses it will have to be changed to successfully compile. In the
meantime, the first runtime call to C<toLOWER_utf8> from each call point in the
program will raise a deprecation warning, enabled by default. You can convert
your program now to use C<toLOWER_utf8_safe>, and avoid the warnings, and get an
extra measure of protection, or you can wait until v5.30, when you'll be forced
to add the C<e> parameter.
UV toLOWER_utf8(U8* p, U8* s, STRLEN* lenp)
=for hackers
Found in file handy.h
=item toLOWER_utf8_safe
X<toLOWER_utf8_safe>
Converts the first UTF-8 encoded character in the sequence starting at C<p> and
extending no further than S<C<e - 1>> to its lowercase version, and
stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note
that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
bytes since the lowercase version may be longer than the original character.
The first code point of the lowercased version is returned
(but note, as explained at L<the top of this section|/Character case
changing>, that there may be more).
The suffix C<_safe> in the function's name indicates that it will not attempt
to read beyond S<C<e - 1>>, provided that the constraint S<C<s E<lt> e>> is
true (this is asserted for in C<-DDEBUGGING> builds). If the UTF-8 for the
input character is malformed in some way, the program may croak, or the
function may return the REPLACEMENT CHARACTER, at the discretion of the
implementation, and subject to change in future releases.
UV toLOWER_utf8_safe(U8* p, U8* e, U8* s,
STRLEN* lenp)
=for hackers
Found in file handy.h
=item toLOWER_uvchr
X<toLOWER_uvchr>
Converts the code point C<cp> to its lowercase version, and
stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. The code
point is interpreted as native if less than 256; otherwise as Unicode. Note
that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
bytes since the lowercase version may be longer than the original character.
The first code point of the lowercased version is returned
(but note, as explained at L<the top of this section|/Character case
changing>, that there may be more).
UV toLOWER_uvchr(UV cp, U8* s, STRLEN* lenp)
=for hackers
Found in file handy.h
=item toTITLE
X<toTITLE>
Converts the specified character to titlecase. If the input is anything but an
ASCII lowercase character, that input character itself is returned. Variant
C<toTITLE_A> is equivalent. (There is no C<toTITLE_L1> for the full Latin1
range, as the full generality of L</toTITLE_uvchr> is needed there. Titlecase is
not a concept used in locale handling, so there is no functionality for that.)
U8 toTITLE(U8 ch)
=for hackers
Found in file handy.h
=item toTITLE_utf8
X<toTITLE_utf8>
This is like C<L</toLOWER_utf8_safe>>, but doesn't have the C<e>
parameter The function therefore can't check if it is reading
beyond the end of the string. Starting in Perl v5.30, it will take the C<e>
parameter, becoming a synonym for C<toTITLE_utf8_safe>. At that time every
program that uses it will have to be changed to successfully compile. In the
meantime, the first runtime call to C<toTITLE_utf8> from each call point in the
program will raise a deprecation warning, enabled by default. You can convert
your program now to use C<toTITLE_utf8_safe>, and avoid the warnings, and get an
extra measure of protection, or you can wait until v5.30, when you'll be forced
to add the C<e> parameter.
UV toTITLE_utf8(U8* p, U8* s, STRLEN* lenp)
=for hackers
Found in file handy.h
=item toTITLE_utf8_safe
X<toTITLE_utf8_safe>
Converts the first UTF-8 encoded character in the sequence starting at C<p> and
extending no further than S<C<e - 1>> to its titlecase version, and
stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note
that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
bytes since the titlecase version may be longer than the original character.
The first code point of the titlecased version is returned
(but note, as explained at L<the top of this section|/Character case
changing>, that there may be more).
The suffix C<_safe> in the function's name indicates that it will not attempt
to read beyond S<C<e - 1>>, provided that the constraint S<C<s E<lt> e>> is
true (this is asserted for in C<-DDEBUGGING> builds). If the UTF-8 for the
input character is malformed in some way, the program may croak, or the
function may return the REPLACEMENT CHARACTER, at the discretion of the
implementation, and subject to change in future releases.
UV toTITLE_utf8_safe(U8* p, U8* e, U8* s,
STRLEN* lenp)
=for hackers
Found in file handy.h
=item toTITLE_uvchr
X<toTITLE_uvchr>
Converts the code point C<cp> to its titlecase version, and
stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. The code
point is interpreted as native if less than 256; otherwise as Unicode. Note
that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
bytes since the titlecase version may be longer than the original character.
The first code point of the titlecased version is returned
(but note, as explained at L<the top of this section|/Character case
changing>, that there may be more).
UV toTITLE_uvchr(UV cp, U8* s, STRLEN* lenp)
=for hackers
Found in file handy.h
=item toUPPER
X<toUPPER>
Converts the specified character to uppercase. If the input is anything but an
ASCII lowercase character, that input character itself is returned. Variant
C<toUPPER_A> is equivalent.
U8 toUPPER(U8 ch)
=for hackers
Found in file handy.h
=item toUPPER_utf8
X<toUPPER_utf8>
This is like C<L</toUPPER_utf8_safe>>, but doesn't have the C<e>
parameter The function therefore can't check if it is reading
beyond the end of the string. Starting in Perl v5.30, it will take the C<e>
parameter, becoming a synonym for C<toUPPER_utf8_safe>. At that time every
program that uses it will have to be changed to successfully compile. In the
meantime, the first runtime call to C<toUPPER_utf8> from each call point in the
program will raise a deprecation warning, enabled by default. You can convert
your program now to use C<toUPPER_utf8_safe>, and avoid the warnings, and get an
extra measure of protection, or you can wait until v5.30, when you'll be forced
to add the C<e> parameter.
UV toUPPER_utf8(U8* p, U8* s, STRLEN* lenp)
=for hackers
Found in file handy.h
=item toUPPER_utf8_safe
X<toUPPER_utf8_safe>
Converts the first UTF-8 encoded character in the sequence starting at C<p> and
extending no further than S<C<e - 1>> to its uppercase version, and
stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. Note
that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
bytes since the uppercase version may be longer than the original character.
The first code point of the uppercased version is returned
(but note, as explained at L<the top of this section|/Character case
changing>, that there may be more).
The suffix C<_safe> in the function's name indicates that it will not attempt
to read beyond S<C<e - 1>>, provided that the constraint S<C<s E<lt> e>> is
true (this is asserted for in C<-DDEBUGGING> builds). If the UTF-8 for the
input character is malformed in some way, the program may croak, or the
function may return the REPLACEMENT CHARACTER, at the discretion of the
implementation, and subject to change in future releases.
UV toUPPER_utf8_safe(U8* p, U8* e, U8* s,
STRLEN* lenp)
=for hackers
Found in file handy.h
=item toUPPER_uvchr
X<toUPPER_uvchr>
Converts the code point C<cp> to its uppercase version, and
stores that in UTF-8 in C<s>, and its length in bytes in C<lenp>. The code
point is interpreted as native if less than 256; otherwise as Unicode. Note
that the buffer pointed to by C<s> needs to be at least C<UTF8_MAXBYTES_CASE+1>
bytes since the uppercase version may be longer than the original character.
The first code point of the uppercased version is returned
(but note, as explained at L<the top of this section|/Character case
changing>, that there may be more.)
UV toUPPER_uvchr(UV cp, U8* s, STRLEN* lenp)
=for hackers
Found in file handy.h
=back
=head1 Character classification
This section is about functions (really macros) that classify characters
into types, such as punctuation versus alphabetic, etc. Most of these are
analogous to regular expression character classes. (See
L<perlrecharclass/POSIX Character Classes>.) There are several variants for
each class. (Not all macros have all variants; each item below lists the
ones valid for it.) None are affected by C<use bytes>, and only the ones
with C<LC> in the name are affected by the current locale.
The base function, e.g., C<isALPHA()>, takes an octet (either a C<char> or a
C<U8>) as input and returns a boolean as to whether or not the character
represented by that octet is (or on non-ASCII platforms, corresponds to) an
ASCII character in the named class based on platform, Unicode, and Perl rules.
If the input is a number that doesn't fit in an octet, FALSE is returned.
Variant C<isI<FOO>_A> (e.g., C<isALPHA_A()>) is identical to the base function
with no suffix C<"_A">. This variant is used to emphasize by its name that
only ASCII-range characters can return TRUE.
Variant C<isI<FOO>_L1> imposes the Latin-1 (or EBCDIC equivalent) character set
onto the platform. That is, the code points that are ASCII are unaffected,
since ASCII is a subset of Latin-1. But the non-ASCII code points are treated
as if they are Latin-1 characters. For example, C<isWORDCHAR_L1()> will return
true when called with the code point 0xDF, which is a word character in both
ASCII and EBCDIC (though it represents different characters in each).
Variant C<isI<FOO>_uvchr> is like the C<isI<FOO>_L1> variant, but accepts any UV code
point as input. If the code point is larger than 255, Unicode rules are used
to determine if it is in the character class. For example,
C<isWORDCHAR_uvchr(0x100)> returns TRUE, since 0x100 is LATIN CAPITAL LETTER A
WITH MACRON in Unicode, and is a word character.
Variant C<isI<FOO>_utf8_safe> is like C<isI<FOO>_uvchr>, but is used for UTF-8
encoded strings. Each call classifies one character, even if the string
contains many. This variant takes two parameters. The first, C<p>, is a
pointer to the first byte of the character to be classified. (Recall that it
may take more than one byte to represent a character in UTF-8 strings.) The
second parameter, C<e>, points to anywhere in the string beyond the first
character, up to one byte past the end of the entire string. The suffix
C<_safe> in the function's name indicates that it will not attempt to read
beyond S<C<e - 1>>, provided that the constraint S<C<s E<lt> e>> is true (this
is asserted for in C<-DDEBUGGING> builds). If the UTF-8 for the input
character is malformed in some way, the program may croak, or the function may
return FALSE, at the discretion of the implementation, and subject to change in
future releases.
Variant C<isI<FOO>_utf8> is like C<isI<FOO>_utf8_safe>, but takes just a single
parameter, C<p>, which has the same meaning as the corresponding parameter does
in C<isI<FOO>_utf8_safe>. The function therefore can't check if it is reading
beyond the end of the string. Starting in Perl v5.30, it will take a second
parameter, becoming a synonym for C<isI<FOO>_utf8_safe>. At that time every
program that uses it will have to be changed to successfully compile. In the
meantime, the first runtime call to C<isI<FOO>_utf8> from each call point in the
program will raise a deprecation warning, enabled by default. You can convert
your program now to use C<isI<FOO>_utf8_safe>, and avoid the warnings, and get an
extra measure of protection, or you can wait until v5.30, when you'll be forced
to add the C<e> parameter.
Variant C<isI<FOO>_LC> is like the C<isI<FOO>_A> and C<isI<FOO>_L1> variants, but the
result is based on the current locale, which is what C<LC> in the name stands
for. If Perl can determine that the current locale is a UTF-8 locale, it uses
the published Unicode rules; otherwise, it uses the C library function that
gives the named classification. For example, C<isDIGIT_LC()> when not in a
UTF-8 locale returns the result of calling C<isdigit()>. FALSE is always
returned if the input won't fit into an octet. On some platforms where the C
library function is known to be defective, Perl changes its result to follow
the POSIX standard's rules.
Variant C<isI<FOO>_LC_uvchr> is like C<isI<FOO>_LC>, but is defined on any UV. It
returns the same as C<isI<FOO>_LC> for input code points less than 256, and
returns the hard-coded, not-affected-by-locale, Unicode results for larger ones.
Variant C<isI<FOO>_LC_utf8_safe> is like C<isI<FOO>_LC_uvchr>, but is used for UTF-8
encoded strings. Each call classifies one character, even if the string
contains many. This variant takes two parameters. The first, C<p>, is a
pointer to the first byte of the character to be classified. (Recall that it
may take more than one byte to represent a character in UTF-8 strings.) The
second parameter, C<e>, points to anywhere in the string beyond the first
character, up to one byte past the end of the entire string. The suffix
C<_safe> in the function's name indicates that it will not attempt to read
beyond S<C<e - 1>>, provided that the constraint S<C<s E<lt> e>> is true (this
is asserted for in C<-DDEBUGGING> builds). If the UTF-8 for the input
character is malformed in some way, the program may croak, or the function may
return FALSE, at the discretion of the implementation, and subject to change in
future releases.
Variant C<isI<FOO>_LC_utf8> is like C<isI<FOO>_LC_utf8_safe>, but takes just a single
parameter, C<p>, which has the same meaning as the corresponding parameter does
in C<isI<FOO>_LC_utf8_safe>. The function therefore can't check if it is reading
beyond the end of the string. Starting in Perl v5.30, it will take a second
parameter, becoming a synonym for C<isI<FOO>_LC_utf8_safe>. At that time every
program that uses it will have to be changed to successfully compile. In the
meantime, the first runtime call to C<isI<FOO>_LC_utf8> from each call point in
the program will raise a deprecation warning, enabled by default. You can
convert your program now to use C<isI<FOO>_LC_utf8_safe>, and avoid the warnings,
and get an extra measure of protection, or you can wait until v5.30, when
you'll be forced to add the C<e> parameter.
=over 8
=item isALPHA
X<isALPHA>
Returns a boolean indicating whether the specified character is an
alphabetic character, analogous to C<m/[[:alpha:]]/>.
See the L<top of this section|/Character classification> for an explanation of
variants
C<isALPHA_A>, C<isALPHA_L1>, C<isALPHA_uvchr>, C<isALPHA_utf8_safe>,
C<isALPHA_LC>, C<isALPHA_LC_uvchr>, and C<isALPHA_LC_utf8_safe>.
bool isALPHA(char ch)
=for hackers
Found in file handy.h
=item isALPHANUMERIC
X<isALPHANUMERIC>
Returns a boolean indicating whether the specified character is a either an
alphabetic character or decimal digit, analogous to C<m/[[:alnum:]]/>.
See the L<top of this section|/Character classification> for an explanation of
variants
C<isALPHANUMERIC_A>, C<isALPHANUMERIC_L1>, C<isALPHANUMERIC_uvchr>,
C<isALPHANUMERIC_utf8_safe>, C<isALPHANUMERIC_LC>, C<isALPHANUMERIC_LC_uvchr>,
and C<isALPHANUMERIC_LC_utf8_safe>.
bool isALPHANUMERIC(char ch)
=for hackers
Found in file handy.h
=item isASCII
X<isASCII>
Returns a boolean indicating whether the specified character is one of the 128
characters in the ASCII character set, analogous to C<m/[[:ascii:]]/>.
On non-ASCII platforms, it returns TRUE iff this
character corresponds to an ASCII character. Variants C<isASCII_A()> and
C<isASCII_L1()> are identical to C<isASCII()>.
See the L<top of this section|/Character classification> for an explanation of
variants
C<isASCII_uvchr>, C<isASCII_utf8_safe>, C<isASCII_LC>, C<isASCII_LC_uvchr>, and
C<isASCII_LC_utf8_safe>. Note, however, that some platforms do not have the C
library routine C<isascii()>. In these cases, the variants whose names contain
C<LC> are the same as the corresponding ones without.
Also note, that because all ASCII characters are UTF-8 invariant (meaning they
have the exact same representation (always a single byte) whether encoded in
UTF-8 or not), C<isASCII> will give the correct results when called with any
byte in any string encoded or not in UTF-8. And similarly C<isASCII_utf8_safe>
will work properly on any string encoded or not in UTF-8.
bool isASCII(char ch)
=for hackers
Found in file handy.h
=item isBLANK
X<isBLANK>
Returns a boolean indicating whether the specified character is a
character considered to be a blank, analogous to C<m/[[:blank:]]/>.
See the L<top of this section|/Character classification> for an explanation of
variants
C<isBLANK_A>, C<isBLANK_L1>, C<isBLANK_uvchr>, C<isBLANK_utf8_safe>,
C<isBLANK_LC>, C<isBLANK_LC_uvchr>, and C<isBLANK_LC_utf8_safe>. Note,
however, that some platforms do not have the C library routine
C<isblank()>. In these cases, the variants whose names contain C<LC> are
the same as the corresponding ones without.
bool isBLANK(char ch)
=for hackers
Found in file handy.h
=item isCNTRL
X<isCNTRL>
Returns a boolean indicating whether the specified character is a
control character, analogous to C<m/[[:cntrl:]]/>.
See the L<top of this section|/Character classification> for an explanation of
variants
C<isCNTRL_A>, C<isCNTRL_L1>, C<isCNTRL_uvchr>, C<isCNTRL_utf8_safe>,
C<isCNTRL_LC>, C<isCNTRL_LC_uvchr>, and C<isCNTRL_LC_utf8_safe> On EBCDIC
platforms, you almost always want to use the C<isCNTRL_L1> variant.
bool isCNTRL(char ch)
=for hackers
Found in file handy.h
=item isDIGIT
X<isDIGIT>
Returns a boolean indicating whether the specified character is a
digit, analogous to C<m/[[:digit:]]/>.
Variants C<isDIGIT_A> and C<isDIGIT_L1> are identical to C<isDIGIT>.
See the L<top of this section|/Character classification> for an explanation of
variants
C<isDIGIT_uvchr>, C<isDIGIT_utf8_safe>, C<isDIGIT_LC>, C<isDIGIT_LC_uvchr>, and
C<isDIGIT_LC_utf8_safe>.
bool isDIGIT(char ch)
=for hackers
Found in file handy.h
=item isGRAPH
X<isGRAPH>
Returns a boolean indicating whether the specified character is a
graphic character, analogous to C<m/[[:graph:]]/>.
See the L<top of this section|/Character classification> for an explanation of
variants C<isGRAPH_A>, C<isGRAPH_L1>, C<isGRAPH_uvchr>, C<isGRAPH_utf8_safe>,
C<isGRAPH_LC>, C<isGRAPH_LC_uvchr>, and C<isGRAPH_LC_utf8_safe>.
bool isGRAPH(char ch)
=for hackers
Found in file handy.h
=item isIDCONT
X<isIDCONT>
Returns a boolean indicating whether the specified character can be the
second or succeeding character of an identifier. This is very close to, but
not quite the same as the official Unicode property C<XID_Continue>. The
difference is that this returns true only if the input character also matches
L</isWORDCHAR>. See the L<top of this section|/Character classification> for
an
explanation of variants C<isIDCONT_A>, C<isIDCONT_L1>, C<isIDCONT_uvchr>,
C<isIDCONT_utf8_safe>, C<isIDCONT_LC>, C<isIDCONT_LC_uvchr>, and
C<isIDCONT_LC_utf8_safe>.
bool isIDCONT(char ch)
=for hackers
Found in file handy.h
=item isIDFIRST
X<isIDFIRST>
Returns a boolean indicating whether the specified character can be the first
character of an identifier. This is very close to, but not quite the same as
the official Unicode property C<XID_Start>. The difference is that this
returns true only if the input character also matches L</isWORDCHAR>.
See the L<top of this section|/Character classification> for an explanation of
variants
C<isIDFIRST_A>, C<isIDFIRST_L1>, C<isIDFIRST_uvchr>, C<isIDFIRST_utf8_safe>,
C<isIDFIRST_LC>, C<isIDFIRST_LC_uvchr>, and C<isIDFIRST_LC_utf8_safe>.
bool isIDFIRST(char ch)
=for hackers
Found in file handy.h
=item isLOWER
X<isLOWER>
Returns a boolean indicating whether the specified character is a
lowercase character, analogous to C<m/[[:lower:]]/>.
See the L<top of this section|/Character classification> for an explanation of
variants
C<isLOWER_A>, C<isLOWER_L1>, C<isLOWER_uvchr>, C<isLOWER_utf8_safe>,
C<isLOWER_LC>, C<isLOWER_LC_uvchr>, and C<isLOWER_LC_utf8_safe>.
bool isLOWER(char ch)
=for hackers
Found in file handy.h
=item isOCTAL
X<isOCTAL>
Returns a boolean indicating whether the specified character is an
octal digit, [0-7].
The only two variants are C<isOCTAL_A> and C<isOCTAL_L1>; each is identical to
C<isOCTAL>.
bool isOCTAL(char ch)
=for hackers
Found in file handy.h
=item isPRINT
X<isPRINT>
Returns a boolean indicating whether the specified character is a
printable character, analogous to C<m/[[:print:]]/>.
See the L<top of this section|/Character classification> for an explanation of
variants
C<isPRINT_A>, C<isPRINT_L1>, C<isPRINT_uvchr>, C<isPRINT_utf8_safe>,
C<isPRINT_LC>, C<isPRINT_LC_uvchr>, and C<isPRINT_LC_utf8_safe>.
bool isPRINT(char ch)
=for hackers
Found in file handy.h
=item isPSXSPC
X<isPSXSPC>
(short for Posix Space)
Starting in 5.18, this is identical in all its forms to the
corresponding C<isSPACE()> macros.
The locale forms of this macro are identical to their corresponding
C<isSPACE()> forms in all Perl releases. In releases prior to 5.18, the
non-locale forms differ from their C<isSPACE()> forms only in that the
C<isSPACE()> forms don't match a Vertical Tab, and the C<isPSXSPC()> forms do.
Otherwise they are identical. Thus this macro is analogous to what
C<m/[[:space:]]/> matches in a regular expression.
See the L<top of this section|/Character classification> for an explanation of
variants C<isPSXSPC_A>, C<isPSXSPC_L1>, C<isPSXSPC_uvchr>, C<isPSXSPC_utf8_safe>,
C<isPSXSPC_LC>, C<isPSXSPC_LC_uvchr>, and C<isPSXSPC_LC_utf8_safe>.
bool isPSXSPC(char ch)
=for hackers
Found in file handy.h
=item isPUNCT
X<isPUNCT>
Returns a boolean indicating whether the specified character is a
punctuation character, analogous to C<m/[[:punct:]]/>.
Note that the definition of what is punctuation isn't as
straightforward as one might desire. See L<perlrecharclass/POSIX Character
Classes> for details.
See the L<top of this section|/Character classification> for an explanation of
variants C<isPUNCT_A>, C<isPUNCT_L1>, C<isPUNCT_uvchr>, C<isPUNCT_utf8_safe>,
C<isPUNCT_LC>, C<isPUNCT_LC_uvchr>, and C<isPUNCT_LC_utf8_safe>.
bool isPUNCT(char ch)
=for hackers
Found in file handy.h
=item isSPACE
X<isSPACE>
Returns a boolean indicating whether the specified character is a
whitespace character. This is analogous
to what C<m/\s/> matches in a regular expression. Starting in Perl 5.18
this also matches what C<m/[[:space:]]/> does. Prior to 5.18, only the
locale forms of this macro (the ones with C<LC> in their names) matched
precisely what C<m/[[:space:]]/> does. In those releases, the only difference,
in the non-locale variants, was that C<isSPACE()> did not match a vertical tab.
(See L</isPSXSPC> for a macro that matches a vertical tab in all releases.)
See the L<top of this section|/Character classification> for an explanation of
variants
C<isSPACE_A>, C<isSPACE_L1>, C<isSPACE_uvchr>, C<isSPACE_utf8_safe>,
C<isSPACE_LC>, C<isSPACE_LC_uvchr>, and C<isSPACE_LC_utf8_safe>.
bool isSPACE(char ch)
=for hackers
Found in file handy.h
=item isUPPER
X<isUPPER>
Returns a boolean indicating whether the specified character is an
uppercase character, analogous to C<m/[[:upper:]]/>.
See the L<top of this section|/Character classification> for an explanation of
variants C<isUPPER_A>, C<isUPPER_L1>, C<isUPPER_uvchr>, C<isUPPER_utf8_safe>,
C<isUPPER_LC>, C<isUPPER_LC_uvchr>, and C<isUPPER_LC_utf8_safe>.
bool isUPPER(char ch)
=for hackers
Found in file handy.h
=item isWORDCHAR
X<isWORDCHAR>
Returns a boolean indicating whether the specified character is a character
that is a word character, analogous to what C<m/\w/> and C<m/[[:word:]]/> match
in a regular expression. A word character is an alphabetic character, a
decimal digit, a connecting punctuation character (such as an underscore), or
a "mark" character that attaches to one of those (like some sort of accent).
C<isALNUM()> is a synonym provided for backward compatibility, even though a
word character includes more than the standard C language meaning of
alphanumeric.
See the L<top of this section|/Character classification> for an explanation of
variants C<isWORDCHAR_A>, C<isWORDCHAR_L1>, C<isWORDCHAR_uvchr>, and
C<isWORDCHAR_utf8_safe>. C<isWORDCHAR_LC>, C<isWORDCHAR_LC_uvchr>, and
C<isWORDCHAR_LC_utf8_safe> are also as described there, but additionally
include the platform's native underscore.
bool isWORDCHAR(char ch)
=for hackers
Found in file handy.h
=item isXDIGIT
X<isXDIGIT>
Returns a boolean indicating whether the specified character is a hexadecimal
digit. In the ASCII range these are C<[0-9A-Fa-f]>. Variants C<isXDIGIT_A()>
and C<isXDIGIT_L1()> are identical to C<isXDIGIT()>.
See the L<top of this section|/Character classification> for an explanation of
variants
C<isXDIGIT_uvchr>, C<isXDIGIT_utf8_safe>, C<isXDIGIT_LC>, C<isXDIGIT_LC_uvchr>,
and C<isXDIGIT_LC_utf8_safe>.
bool isXDIGIT(char ch)
=for hackers
Found in file handy.h
=back
=head1 Cloning an interpreter
=over 8
=item perl_clone
X<perl_clone>
Create and return a new interpreter by cloning the current one.
C<perl_clone> takes these flags as parameters:
C<CLONEf_COPY_STACKS> - is used to, well, copy the stacks also,
without it we only clone the data and zero the stacks,
with it we copy the stacks and the new perl interpreter is
ready to run at the exact same point as the previous one.
The pseudo-fork code uses C<COPY_STACKS> while the
threads->create doesn't.
C<CLONEf_KEEP_PTR_TABLE> -
C<perl_clone> keeps a ptr_table with the pointer of the old
variable as a key and the new variable as a value,
this allows it to check if something has been cloned and not
clone it again but rather just use the value and increase the
refcount. If C<KEEP_PTR_TABLE> is not set then C<perl_clone> will kill
the ptr_table using the function
C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
reason to keep it around is if you want to dup some of your own
variable who are outside the graph perl scans, an example of this
code is in F<threads.xs> create.
C<CLONEf_CLONE_HOST> -
This is a win32 thing, it is ignored on unix, it tells perls
win32host code (which is c++) to clone itself, this is needed on
win32 if you want to run two threads at the same time,
if you just want to do some stuff in a separate perl interpreter
and then throw it away and return to the original one,
you don't need to do anything.
PerlInterpreter* perl_clone(
PerlInterpreter *proto_perl,
UV flags
)
=for hackers
Found in file sv.c
=back
=head1 Compile-time scope hooks
=over 8
=item BhkDISABLE
X<BhkDISABLE>
NOTE: this function is experimental and may change or be
removed without notice.
Temporarily disable an entry in this BHK structure, by clearing the
appropriate flag. C<which> is a preprocessor token indicating which
entry to disable.
void BhkDISABLE(BHK *hk, which)
=for hackers
Found in file op.h
=item BhkENABLE
X<BhkENABLE>
NOTE: this function is experimental and may change or be
removed without notice.
Re-enable an entry in this BHK structure, by setting the appropriate
flag. C<which> is a preprocessor token indicating which entry to enable.
This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
pointer.
void BhkENABLE(BHK *hk, which)
=for hackers
Found in file op.h
=item BhkENTRY_set
X<BhkENTRY_set>
NOTE: this function is experimental and may change or be
removed without notice.
Set an entry in the BHK structure, and set the flags to indicate it is
valid. C<which> is a preprocessing token indicating which entry to set.
The type of C<ptr> depends on the entry.
void BhkENTRY_set(BHK *hk, which, void *ptr)
=for hackers
Found in file op.h
=item blockhook_register
X<blockhook_register>
NOTE: this function is experimental and may change or be
removed without notice.
Register a set of hooks to be called when the Perl lexical scope changes
at compile time. See L<perlguts/"Compile-time scope hooks">.
NOTE: this function must be explicitly called as Perl_blockhook_register with an aTHX_ parameter.
void Perl_blockhook_register(pTHX_ BHK *hk)
=for hackers
Found in file op.c
=back
=head1 COP Hint Hashes
=over 8
=item cophh_2hv
X<cophh_2hv>
NOTE: this function is experimental and may change or be
removed without notice.
Generates and returns a standard Perl hash representing the full set of
key/value pairs in the cop hints hash C<cophh>. C<flags> is currently
unused and must be zero.
HV * cophh_2hv(const COPHH *cophh, U32 flags)
=for hackers
Found in file cop.h
=item cophh_copy
X<cophh_copy>
NOTE: this function is experimental and may change or be
removed without notice.
Make and return a complete copy of the cop hints hash C<cophh>.
COPHH * cophh_copy(COPHH *cophh)
=for hackers
Found in file cop.h
=item cophh_delete_pv
X<cophh_delete_pv>
NOTE: this function is experimental and may change or be
removed without notice.
Like L</cophh_delete_pvn>, but takes a nul-terminated string instead of
a string/length pair.
COPHH * cophh_delete_pv(const COPHH *cophh,
const char *key, U32 hash,
U32 flags)
=for hackers
Found in file cop.h
=item cophh_delete_pvn
X<cophh_delete_pvn>
NOTE: this function is experimental and may change or be
removed without notice.
Delete a key and its associated value from the cop hints hash C<cophh>,
and returns the modified hash. The returned hash pointer is in general
not the same as the hash pointer that was passed in. The input hash is
consumed by the function, and the pointer to it must not be subsequently
used. Use L</cophh_copy> if you need both hashes.
The key is specified by C<keypv> and C<keylen>. If C<flags> has the
C<COPHH_KEY_UTF8> bit set, the key octets are interpreted as UTF-8,
otherwise they are interpreted as Latin-1. C<hash> is a precomputed
hash of the key string, or zero if it has not been precomputed.
COPHH * cophh_delete_pvn(COPHH *cophh,
const char *keypv,
STRLEN keylen, U32 hash,
U32 flags)
=for hackers
Found in file cop.h
=item cophh_delete_pvs
X<cophh_delete_pvs>
NOTE: this function is experimental and may change or be
removed without notice.
Like L</cophh_delete_pvn>, but takes a C<NUL>-terminated literal string instead
of a string/length pair, and no precomputed hash.
COPHH * cophh_delete_pvs(const COPHH *cophh,
const char *key, U32 flags)
=for hackers
Found in file cop.h
=item cophh_delete_sv
X<cophh_delete_sv>
NOTE: this function is experimental and may change or be
removed without notice.
Like L</cophh_delete_pvn>, but takes a Perl scalar instead of a
string/length pair.
COPHH * cophh_delete_sv(const COPHH *cophh, SV *key,
U32 hash, U32 flags)
=for hackers
Found in file cop.h
=item cophh_fetch_pv
X<cophh_fetch_pv>
NOTE: this function is experimental and may change or be
removed without notice.
Like L</cophh_fetch_pvn>, but takes a nul-terminated string instead of
a string/length pair.
SV * cophh_fetch_pv(const COPHH *cophh,
const char *key, U32 hash,
U32 flags)
=for hackers
Found in file cop.h
=item cophh_fetch_pvn
X<cophh_fetch_pvn>
NOTE: this function is experimental and may change or be
removed without notice.
Look up the entry in the cop hints hash C<cophh> with the key specified by
C<keypv> and C<keylen>. If C<flags> has the C<COPHH_KEY_UTF8> bit set,
the key octets are interpreted as UTF-8, otherwise they are interpreted
as Latin-1. C<hash> is a precomputed hash of the key string, or zero if
it has not been precomputed. Returns a mortal scalar copy of the value
associated with the key, or C<&PL_sv_placeholder> if there is no value
associated with the key.
SV * cophh_fetch_pvn(const COPHH *cophh,
const char *keypv,
STRLEN keylen, U32 hash,
U32 flags)
=for hackers
Found in file cop.h
=item cophh_fetch_pvs
X<cophh_fetch_pvs>
NOTE: this function is experimental and may change or be
removed without notice.
Like L</cophh_fetch_pvn>, but takes a C<NUL>-terminated literal string instead
of a string/length pair, and no precomputed hash.
SV * cophh_fetch_pvs(const COPHH *cophh,
const char *key, U32 flags)
=for hackers
Found in file cop.h
=item cophh_fetch_sv
X<cophh_fetch_sv>
NOTE: this function is experimental and may change or be
removed without notice.
Like L</cophh_fetch_pvn>, but takes a Perl scalar instead of a
string/length pair.
SV * cophh_fetch_sv(const COPHH *cophh, SV *key,
U32 hash, U32 flags)
=for hackers
Found in file cop.h
=item cophh_free
X<cophh_free>
NOTE: this function is experimental and may change or be
removed without notice.
Discard the cop hints hash C<cophh>, freeing all resources associated
with it.
void cophh_free(COPHH *cophh)
=for hackers
Found in file cop.h
=item cophh_new_empty
X<cophh_new_empty>
NOTE: this function is experimental and may change or be
removed without notice.
Generate and return a fresh cop hints hash containing no entries.
COPHH * cophh_new_empty()
=for hackers
Found in file cop.h
=item cophh_store_pv
X<cophh_store_pv>
NOTE: this function is experimental and may change or be
removed without notice.
Like L</cophh_store_pvn>, but takes a nul-terminated string instead of
a string/length pair.
COPHH * cophh_store_pv(const COPHH *cophh,
const char *key, U32 hash,
SV *value, U32 flags)
=for hackers
Found in file cop.h
=item cophh_store_pvn
X<cophh_store_pvn>
NOTE: this function is experimental and may change or be
removed without notice.
Stores a value, associated with a key, in the cop hints hash C<cophh>,
and returns the modified hash. The returned hash pointer is in general
not the same as the hash pointer that was passed in. The input hash is
consumed by the function, and the pointer to it must not be subsequently
used. Use L</cophh_copy> if you need both hashes.
The key is specified by C<keypv> and C<keylen>. If C<flags> has the
C<COPHH_KEY_UTF8> bit set, the key octets are interpreted as UTF-8,
otherwise they are interpreted as Latin-1. C<hash> is a precomputed
hash of the key string, or zero if it has not been precomputed.
C<value> is the scalar value to store for this key. C<value> 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 cop hints hash. Complex types of scalar will not
be stored with referential integrity, but will be coerced to strings.
COPHH * cophh_store_pvn(COPHH *cophh, const char *keypv,
STRLEN keylen, U32 hash,
SV *value, U32 flags)
=for hackers
Found in file cop.h
=item cophh_store_pvs
X<cophh_store_pvs>
NOTE: this function is experimental and may change or be
removed without notice.
Like L</cophh_store_pvn>, but takes a C<NUL>-terminated literal string instead
of a string/length pair, and no precomputed hash.
COPHH * cophh_store_pvs(const COPHH *cophh,
const char *key, SV *value,
U32 flags)
=for hackers
Found in file cop.h
=item cophh_store_sv
X<cophh_store_sv>
NOTE: this function is experimental and may change or be
removed without notice.
Like L</cophh_store_pvn>, but takes a Perl scalar instead of a
string/length pair.
COPHH * cophh_store_sv(const COPHH *cophh, SV *key,
U32 hash, SV *value, U32 flags)
=for hackers
Found in file cop.h
=back
=head1 COP Hint Reading
=over 8
=item cop_hints_2hv
X<cop_hints_2hv>
Generates and returns a standard Perl hash representing the full set of
hint entries in the cop C<cop>. C<flags> is currently unused and must
be zero.
HV * cop_hints_2hv(const COP *cop, U32 flags)
=for hackers
Found in file cop.h
=item cop_hints_fetch_pv
X<cop_hints_fetch_pv>
Like L</cop_hints_fetch_pvn>, but takes a nul-terminated string instead
of a string/length pair.
SV * cop_hints_fetch_pv(const COP *cop,
const char *key, U32 hash,
U32 flags)
=for hackers
Found in file cop.h
=item cop_hints_fetch_pvn
X<cop_hints_fetch_pvn>
Look up the hint entry in the cop C<cop> with the key specified by
C<keypv> and C<keylen>. If C<flags> has the C<COPHH_KEY_UTF8> bit set,
the key octets are interpreted as UTF-8, otherwise they are interpreted
as Latin-1. C<hash> is a precomputed hash of the key string, or zero if
it has not been precomputed. Returns a mortal scalar copy of the value
associated with the key, or C<&PL_sv_placeholder> if there is no value
associated with the key.
SV * cop_hints_fetch_pvn(const COP *cop,
const char *keypv,
STRLEN keylen, U32 hash,
U32 flags)
=for hackers
Found in file cop.h
=item cop_hints_fetch_pvs
X<cop_hints_fetch_pvs>
Like L</cop_hints_fetch_pvn>, but takes a C<NUL>-terminated literal string
instead of a string/length pair, and no precomputed hash.
SV * cop_hints_fetch_pvs(const COP *cop,
const char *key, U32 flags)
=for hackers
Found in file cop.h
=item cop_hints_fetch_sv
X<cop_hints_fetch_sv>
Like L</cop_hints_fetch_pvn>, but takes a Perl scalar instead of a
string/length pair.
SV * cop_hints_fetch_sv(const COP *cop, SV *key,
U32 hash, U32 flags)
=for hackers
Found in file cop.h
=back
=head1 Custom Operators
=over 8
=item custom_op_register
X<custom_op_register>
Register a custom op. See L<perlguts/"Custom Operators">.
NOTE: this function must be explicitly called as Perl_custom_op_register with an aTHX_ parameter.
void Perl_custom_op_register(pTHX_
Perl_ppaddr_t ppaddr,
const XOP *xop)
=for hackers
Found in file op.c
=item custom_op_xop
X<custom_op_xop>
Return the XOP structure for a given custom op. This macro should be
considered internal to C<OP_NAME> and the other access macros: use them instead.
This macro does call a function. Prior
to 5.19.6, this was implemented as a
function.
NOTE: this function must be explicitly called as Perl_custom_op_xop with an aTHX_ parameter.
const XOP * Perl_custom_op_xop(pTHX_ const OP *o)
=for hackers
Found in file op.c
=item XopDISABLE
X<XopDISABLE>
Temporarily disable a member of the XOP, by clearing the appropriate flag.
void XopDISABLE(XOP *xop, which)
=for hackers
Found in file op.h
=item XopENABLE
X<XopENABLE>
Reenable a member of the XOP which has been disabled.
void XopENABLE(XOP *xop, which)
=for hackers
Found in file op.h
=item XopENTRY
X<XopENTRY>
Return a member of the XOP structure. C<which> is a cpp token
indicating which entry to return. If the member is not set
this will return a default value. The return type depends
on C<which>. This macro evaluates its arguments more than
once. If you are using C<Perl_custom_op_xop> to retreive a
C<XOP *> from a C<OP *>, use the more efficient L</XopENTRYCUSTOM> instead.
XopENTRY(XOP *xop, which)
=for hackers
Found in file op.h
=item XopENTRYCUSTOM
X<XopENTRYCUSTOM>
Exactly like C<XopENTRY(XopENTRY(Perl_custom_op_xop(aTHX_ o), which)> but more
efficient. The C<which> parameter is identical to L</XopENTRY>.
XopENTRYCUSTOM(const OP *o, which)
=for hackers
Found in file op.h
=item XopENTRY_set
X<XopENTRY_set>
Set a member of the XOP structure. C<which> is a cpp token
indicating which entry to set. See L<perlguts/"Custom Operators">
for details about the available members and how
they are used. This macro evaluates its argument
more than once.
void XopENTRY_set(XOP *xop, which, value)
=for hackers
Found in file op.h
=item XopFLAGS
X<XopFLAGS>
Return the XOP's flags.
U32 XopFLAGS(XOP *xop)
=for hackers
Found in file op.h
=back
=head1 CV Manipulation Functions
This section documents functions to manipulate CVs which are code-values,
or subroutines. For more information, see L<perlguts>.
=over 8
=item caller_cx
X<caller_cx>
The XSUB-writer's equivalent of L<caller()|perlfunc/caller>. The
returned C<PERL_CONTEXT> structure can be interrogated to find all the
information returned to Perl by C<caller>. Note that XSUBs don't get a
stack frame, so C<caller_cx(0, NULL)> will return information for the
immediately-surrounding Perl code.
This function skips over the automatic calls to C<&DB::sub> made on the
behalf of the debugger. If the stack frame requested was a sub called by
C<DB::sub>, the return value will be the frame for the call to
C<DB::sub>, since that has the correct line number/etc. for the call
site. If I<dbcxp> is non-C<NULL>, it will be set to a pointer to the
frame for the sub call itself.
const PERL_CONTEXT * caller_cx(
I32 level,
const PERL_CONTEXT **dbcxp
)
=for hackers
Found in file pp_ctl.c
=item CvSTASH
X<CvSTASH>
Returns the stash of the CV. A stash is the symbol table hash, containing
the package-scoped variables in the package where the subroutine was defined.
For more information, see L<perlguts>.
This also has a special use with XS AUTOLOAD subs.
See L<perlguts/Autoloading with XSUBs>.
HV* CvSTASH(CV* cv)
=for hackers
Found in file cv.h
=item find_runcv
X<find_runcv>
Locate the CV corresponding to the currently executing sub or eval.
If C<db_seqp> is non_null, skip CVs that are in the DB package and populate
C<*db_seqp> with the cop sequence number at the point that the DB:: code was
entered. (This allows debuggers to eval in the scope of the breakpoint
rather than in the scope of the debugger itself.)
CV* find_runcv(U32 *db_seqp)
=for hackers
Found in file pp_ctl.c
=item get_cv
X<get_cv>
Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
NOTE: the perl_ form of this function is deprecated.
CV* get_cv(const char* name, I32 flags)
=for hackers
Found in file perl.c
=item get_cvn_flags
X<get_cvn_flags>
Returns the CV of the specified Perl subroutine. C<flags> are passed to
C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
exist then it will be declared (which has the same effect as saying
C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
then NULL is returned.
NOTE: the perl_ form of this function is deprecated.
CV* get_cvn_flags(const char* name, STRLEN len,
I32 flags)
=for hackers
Found in file perl.c
=back
=head1 C<xsubpp> variables and internal functions
=over 8
=item ax
X<ax>
Variable which is setup by C<xsubpp> to indicate the stack base offset,
used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
must be called prior to setup the C<MARK> variable.
I32 ax
=for hackers
Found in file XSUB.h
=item CLASS
X<CLASS>
Variable which is setup by C<xsubpp> to indicate the
class name for a C++ XS constructor. This is always a C<char*>. See
C<L</THIS>>.
char* CLASS
=for hackers
Found in file XSUB.h
=item dAX
X<dAX>
Sets up the C<ax> variable.
This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
dAX;
=for hackers
Found in file XSUB.h
=item dAXMARK
X<dAXMARK>
Sets up the C<ax> variable and stack marker variable C<mark>.
This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
dAXMARK;
=for hackers
Found in file XSUB.h
=item dITEMS
X<dITEMS>
Sets up the C<items> variable.
This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
dITEMS;
=for hackers
Found in file XSUB.h
=item dUNDERBAR
X<dUNDERBAR>
Sets up any variable needed by the C<UNDERBAR> macro. It used to define
C<padoff_du>, but it is currently a noop. However, it is strongly advised
to still use it for ensuring past and future compatibility.
dUNDERBAR;
=for hackers
Found in file XSUB.h
=item dXSARGS
X<dXSARGS>
Sets up stack and mark pointers for an XSUB, calling C<dSP> and C<dMARK>.
Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
This is usually handled automatically by C<xsubpp>.
dXSARGS;
=for hackers
Found in file XSUB.h
=item dXSI32
X<dXSI32>
Sets up the C<ix> variable for an XSUB which has aliases. This is usually
handled automatically by C<xsubpp>.
dXSI32;
=for hackers
Found in file XSUB.h
=item items
X<items>
Variable which is setup by C<xsubpp> to indicate the number of
items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
I32 items
=for hackers
Found in file XSUB.h
=item ix
X<ix>
Variable which is setup by C<xsubpp> to indicate which of an
XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
I32 ix
=for hackers
Found in file XSUB.h
=item RETVAL
X<RETVAL>
Variable which is setup by C<xsubpp> to hold the return value for an
XSUB. This is always the proper type for the XSUB. See
L<perlxs/"The RETVAL Variable">.
(whatever) RETVAL
=for hackers
Found in file XSUB.h
=item ST
X<ST>
Used to access elements on the XSUB's stack.
SV* ST(int ix)
=for hackers
Found in file XSUB.h
=item THIS
X<THIS>
Variable which is setup by C<xsubpp> to designate the object in a C++
XSUB. This is always the proper type for the C++ object. See C<L</CLASS>> and
L<perlxs/"Using XS With C++">.
(whatever) THIS
=for hackers
Found in file XSUB.h
=item UNDERBAR
X<UNDERBAR>
The SV* corresponding to the C<$_> variable. Works even if there
is a lexical C<$_> in scope.
=for hackers
Found in file XSUB.h
=item XS
X<XS>
Macro to declare an XSUB and its C parameter list. This is handled by
C<xsubpp>. It is the same as using the more explicit C<XS_EXTERNAL> macro.
=for hackers
Found in file XSUB.h
=item XS_EXTERNAL
X<XS_EXTERNAL>
Macro to declare an XSUB and its C parameter list explicitly exporting the symbols.
=for hackers
Found in file XSUB.h
=item XS_INTERNAL
X<XS_INTERNAL>
Macro to declare an XSUB and its C parameter list without exporting the symbols.
This is handled by C<xsubpp> and generally preferable over exporting the XSUB
symbols unnecessarily.
=for hackers
Found in file XSUB.h
=back
=head1 Debugging Utilities
=over 8
=item dump_all
X<dump_all>
Dumps the entire optree of the current program starting at C<PL_main_root> to
C<STDERR>. Also dumps the optrees for all visible subroutines in
C<PL_defstash>.
void dump_all()
=for hackers
Found in file dump.c
=item dump_packsubs
X<dump_packsubs>
Dumps the optrees for all visible subroutines in C<stash>.
void dump_packsubs(const HV* stash)
=for hackers
Found in file dump.c
=item op_class
X<op_class>
Given an op, determine what type of struct it has been allocated as.
Returns one of the OPclass enums, such as OPclass_LISTOP.
OPclass op_class(const OP *o)
=for hackers
Found in file dump.c
=item op_dump
X<op_dump>
Dumps the optree starting at OP C<o> to C<STDERR>.
void op_dump(const OP *o)
=for hackers
Found in file dump.c
=item sv_dump
X<sv_dump>
Dumps the contents of an SV to the C<STDERR> filehandle.
For an example of its output, see L<Devel::Peek>.
void sv_dump(SV* sv)
=for hackers
Found in file dump.c
=back
=head1 Display and Dump functions
=over 8
=item pv_display
X<pv_display>
Similar to
pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
except that an additional "\0" will be appended to the string when
len > cur and pv[cur] is "\0".
Note that the final string may be up to 7 chars longer than pvlim.
char* pv_display(SV *dsv, const char *pv, STRLEN cur,
STRLEN len, STRLEN pvlim)
=for hackers
Found in file dump.c
=item pv_escape
X<pv_escape>
Escapes at most the first C<count> chars of C<pv> and puts the results into
C<dsv> such that the size of the escaped string will not exceed C<max> chars
and will not contain any incomplete escape sequences. The number of bytes
escaped will be returned in the C<STRLEN *escaped> parameter if it is not null.
When the C<dsv> parameter is null no escaping actually occurs, but the number
of bytes that would be escaped were it not null will be calculated.
If flags contains C<PERL_PV_ESCAPE_QUOTE> then any double quotes in the string
will also be escaped.
Normally the SV will be cleared before the escaped string is prepared,
but when C<PERL_PV_ESCAPE_NOCLEAR> is set this will not occur.
If C<PERL_PV_ESCAPE_UNI> is set then the input string is treated as UTF-8
if C<PERL_PV_ESCAPE_UNI_DETECT> is set then the input string is scanned
using C<is_utf8_string()> to determine if it is UTF-8.
If C<PERL_PV_ESCAPE_ALL> is set then all input chars will be output
using C<\x01F1> style escapes, otherwise if C<PERL_PV_ESCAPE_NONASCII> is set, only
non-ASCII chars will be escaped using this style; otherwise, only chars above
255 will be so escaped; other non printable chars will use octal or
common escaped patterns like C<\n>.
Otherwise, if C<PERL_PV_ESCAPE_NOBACKSLASH>
then all chars below 255 will be treated as printable and
will be output as literals.
If C<PERL_PV_ESCAPE_FIRSTCHAR> is set then only the first char of the
string will be escaped, regardless of max. If the output is to be in hex,
then it will be returned as a plain hex
sequence. Thus the output will either be a single char,
an octal escape sequence, a special escape like C<\n> or a hex value.
If C<PERL_PV_ESCAPE_RE> is set then the escape char used will be a C<"%"> and
not a C<"\\">. This is because regexes very often contain backslashed
sequences, whereas C<"%"> is not a particularly common character in patterns.
Returns a pointer to the escaped text as held by C<dsv>.
char* pv_escape(SV *dsv, char const * const str,
const STRLEN count, const STRLEN max,
STRLEN * const escaped,
const U32 flags)
=for hackers
Found in file dump.c
=item pv_pretty
X<pv_pretty>
Converts a string into something presentable, handling escaping via
C<pv_escape()> and supporting quoting and ellipses.
If the C<PERL_PV_PRETTY_QUOTE> flag is set then the result will be
double quoted with any double quotes in the string escaped. Otherwise
if the C<PERL_PV_PRETTY_LTGT> flag is set then the result be wrapped in
angle brackets.
If the C<PERL_PV_PRETTY_ELLIPSES> flag is set and not all characters in
string were output then an ellipsis C<...> will be appended to the
string. Note that this happens AFTER it has been quoted.
If C<start_color> is non-null then it will be inserted after the opening
quote (if there is one) but before the escaped text. If C<end_color>
is non-null then it will be inserted after the escaped text but before
any quotes or ellipses.
Returns a pointer to the prettified text as held by C<dsv>.
char* pv_pretty(SV *dsv, char const * const str,
const STRLEN count, const STRLEN max,
char const * const start_color,
char const * const end_color,
const U32 flags)
=for hackers
Found in file dump.c
=back
=head1 Embedding Functions
=over 8
=item cv_clone
X<cv_clone>
Clone a CV, making a lexical closure. C<proto> supplies the prototype
of the function: its code, pad structure, and other attributes.
The prototype is combined with a capture of outer lexicals to which the
code refers, which are taken from the currently-executing instance of
the immediately surrounding code.
CV * cv_clone(CV *proto)
=for hackers
Found in file pad.c
=item cv_name
X<cv_name>
Returns an SV containing the name of the CV, mainly for use in error
reporting. The CV may actually be a GV instead, in which case the returned
SV holds the GV's name. Anything other than a GV or CV is treated as a
string already holding the sub name, but this could change in the future.
An SV may be passed as a second argument. If so, the name will be assigned
to it and it will be returned. Otherwise the returned SV will be a new
mortal.
If C<flags> has the C<CV_NAME_NOTQUAL> bit set, then the package name will not be
included. If the first argument is neither a CV nor a GV, this flag is
ignored (subject to change).
SV * cv_name(CV *cv, SV *sv, U32 flags)
=for hackers
Found in file pad.c
=item cv_undef
X<cv_undef>
Clear out all the active components of a CV. This can happen either
by an explicit C<undef &foo>, or by the reference count going to zero.
In the former case, we keep the C<CvOUTSIDE> pointer, so that any anonymous
children can still follow the full lexical scope chain.
void cv_undef(CV* cv)
=for hackers
Found in file pad.c
=item find_rundefsv
X<find_rundefsv>
Returns the global variable C<$_>.
SV * find_rundefsv()
=for hackers
Found in file pad.c
=item find_rundefsvoffset
X<find_rundefsvoffset>
DEPRECATED! It is planned to remove this function from a
future release of Perl. Do not use it for new code; remove it from
existing code.
Until the lexical C<$_> feature was removed, this function would
find the position of the lexical C<$_> in the pad of the
currently-executing function and returns the offset in the current pad,
or C<NOT_IN_PAD>.
Now it always returns C<NOT_IN_PAD>.
NOTE: the perl_ form of this function is deprecated.
PADOFFSET find_rundefsvoffset()
=for hackers
Found in file pad.c
=item intro_my
X<intro_my>
"Introduce" C<my> variables to visible status. This is called during parsing
at the end of each statement to make lexical variables visible to subsequent
statements.
U32 intro_my()
=for hackers
Found in file pad.c
=item load_module
X<load_module>
Loads the module whose name is pointed to by the string part of C<name>.
Note that the actual module name, not its filename, should be given.
Eg, "Foo::Bar" instead of "Foo/Bar.pm". ver, if specified and not NULL,
provides version semantics similar to C<use Foo::Bar VERSION>. The optional
trailing arguments can be used to specify arguments to the module's C<import()>
method, similar to C<use Foo::Bar VERSION LIST>; their precise handling depends
on the flags. The flags argument is a bitwise-ORed collection of any of
C<PERL_LOADMOD_DENY>, C<PERL_LOADMOD_NOIMPORT>, or C<PERL_LOADMOD_IMPORT_OPS>
(or 0 for no flags).
If C<PERL_LOADMOD_NOIMPORT> is set, the module is loaded as if with an empty
import list, as in C<use Foo::Bar ()>; this is the only circumstance in which
the trailing optional arguments may be omitted entirely. Otherwise, if
C<PERL_LOADMOD_IMPORT_OPS> is set, the trailing arguments must consist of
exactly one C<OP*>, containing the op tree that produces the relevant import
arguments. Otherwise, the trailing arguments must all be C<SV*> values that
will be used as import arguments; and the list must be terminated with C<(SV*)
NULL>. If neither C<PERL_LOADMOD_NOIMPORT> nor C<PERL_LOADMOD_IMPORT_OPS> is
set, the trailing C<NULL> pointer is needed even if no import arguments are
desired. The reference count for each specified C<SV*> argument is
decremented. In addition, the C<name> argument is modified.
If C<PERL_LOADMOD_DENY> is set, the module is loaded as if with C<no> rather
than C<use>.
void load_module(U32 flags, SV* name, SV* ver, ...)
=for hackers
Found in file op.c
=item newPADNAMELIST
X<newPADNAMELIST>
NOTE: this function is experimental and may change or be
removed without notice.
Creates a new pad name list. C<max> is the highest index for which space
is allocated.
PADNAMELIST * newPADNAMELIST(size_t max)
=for hackers
Found in file pad.c
=item newPADNAMEouter
X<newPADNAMEouter>
NOTE: this function is experimental and may change or be
removed without notice.
Constructs and returns a new pad name. Only use this function for names
that refer to outer lexicals. (See also L</newPADNAMEpvn>.) C<outer> is
the outer pad name that this one mirrors. The returned pad name has the
C<PADNAMEt_OUTER> flag already set.
PADNAME * newPADNAMEouter(PADNAME *outer)
=for hackers
Found in file pad.c
=item newPADNAMEpvn
X<newPADNAMEpvn>
NOTE: this function is experimental and may change or be
removed without notice.
Constructs and returns a new pad name. C<s> must be a UTF-8 string. Do not
use this for pad names that point to outer lexicals. See
C<L</newPADNAMEouter>>.
PADNAME * newPADNAMEpvn(const char *s, STRLEN len)
=for hackers
Found in file pad.c
=item nothreadhook
X<nothreadhook>
Stub that provides thread hook for perl_destruct when there are
no threads.
int nothreadhook()
=for hackers
Found in file perl.c
=item pad_add_anon
X<pad_add_anon>
Allocates a place in the currently-compiling pad (via L</pad_alloc>)
for an anonymous function that is lexically scoped inside the
currently-compiling function.
The function C<func> is linked into the pad, and its C<CvOUTSIDE> link
to the outer scope is weakened to avoid a reference loop.
One reference count is stolen, so you may need to do C<SvREFCNT_inc(func)>.
C<optype> should be an opcode indicating the type of operation that the
pad entry is to support. This doesn't affect operational semantics,
but is used for debugging.
PADOFFSET pad_add_anon(CV *func, I32 optype)
=for hackers
Found in file pad.c
=item pad_add_name_pv
X<pad_add_name_pv>
Exactly like L</pad_add_name_pvn>, but takes a nul-terminated string
instead of a string/length pair.
PADOFFSET pad_add_name_pv(const char *name, U32 flags,
HV *typestash, HV *ourstash)
=for hackers
Found in file pad.c
=item pad_add_name_pvn
X<pad_add_name_pvn>
Allocates a place in the currently-compiling pad for a named lexical
variable. Stores the name and other metadata in the name part of the
pad, and makes preparations to manage the variable's lexical scoping.
Returns the offset of the allocated pad slot.
C<namepv>/C<namelen> specify the variable's name, including leading sigil.
If C<typestash> is non-null, the name is for a typed lexical, and this
identifies the type. If C<ourstash> is non-null, it's a lexical reference
to a package variable, and this identifies the package. The following
flags can be OR'ed together:
padadd_OUR redundantly specifies if it's a package var
padadd_STATE variable will retain value persistently
padadd_NO_DUP_CHECK skip check for lexical shadowing
PADOFFSET pad_add_name_pvn(const char *namepv,
STRLEN namelen, U32 flags,
HV *typestash, HV *ourstash)
=for hackers
Found in file pad.c
=item pad_add_name_sv
X<pad_add_name_sv>
Exactly like L</pad_add_name_pvn>, but takes the name string in the form
of an SV instead of a string/length pair.
PADOFFSET pad_add_name_sv(SV *name, U32 flags,
HV *typestash, HV *ourstash)
=for hackers
Found in file pad.c
=item pad_alloc
X<pad_alloc>
NOTE: this function is experimental and may change or be
removed without notice.
Allocates a place in the currently-compiling pad,
returning the offset of the allocated pad slot.
No name is initially attached to the pad slot.
C<tmptype> is a set of flags indicating the kind of pad entry required,
which will be set in the value SV for the allocated pad entry:
SVs_PADMY named lexical variable ("my", "our", "state")
SVs_PADTMP unnamed temporary store
SVf_READONLY constant shared between recursion levels
C<SVf_READONLY> has been supported here only since perl 5.20. To work with
earlier versions as well, use C<SVf_READONLY|SVs_PADTMP>. C<SVf_READONLY>
does not cause the SV in the pad slot to be marked read-only, but simply
tells C<pad_alloc> that it I<will> be made read-only (by the caller), or at
least should be treated as such.
C<optype> should be an opcode indicating the type of operation that the
pad entry is to support. This doesn't affect operational semantics,
but is used for debugging.
PADOFFSET pad_alloc(I32 optype, U32 tmptype)
=for hackers
Found in file pad.c
=item pad_findmy_pv
X<pad_findmy_pv>
Exactly like L</pad_findmy_pvn>, but takes a nul-terminated string
instead of a string/length pair.
PADOFFSET pad_findmy_pv(const char *name, U32 flags)
=for hackers
Found in file pad.c
=item pad_findmy_pvn
X<pad_findmy_pvn>
Given the name of a lexical variable, find its position in the
currently-compiling pad.
C<namepv>/C<namelen> specify the variable's name, including leading sigil.
C<flags> is reserved and must be zero.
If it is not in the current pad but appears in the pad of any lexically
enclosing scope, then a pseudo-entry for it is added in the current pad.
Returns the offset in the current pad,
or C<NOT_IN_PAD> if no such lexical is in scope.
PADOFFSET pad_findmy_pvn(const char *namepv,
STRLEN namelen, U32 flags)
=for hackers
Found in file pad.c
=item pad_findmy_sv
X<pad_findmy_sv>
Exactly like L</pad_findmy_pvn>, but takes the name string in the form
of an SV instead of a string/length pair.
PADOFFSET pad_findmy_sv(SV *name, U32 flags)
=for hackers
Found in file pad.c
=item padnamelist_fetch
X<padnamelist_fetch>
NOTE: this function is experimental and may change or be
removed without notice.
Fetches the pad name from the given index.
PADNAME * padnamelist_fetch(PADNAMELIST *pnl,
SSize_t key)
=for hackers
Found in file pad.c
=item padnamelist_store
X<padnamelist_store>
NOTE: this function is experimental and may change or be
removed without notice.
Stores the pad name (which may be null) at the given index, freeing any
existing pad name in that slot.
PADNAME ** padnamelist_store(PADNAMELIST *pnl,
SSize_t key, PADNAME *val)
=for hackers
Found in file pad.c
=item pad_setsv
X<pad_setsv>
Set the value at offset C<po> in the current (compiling or executing) pad.
Use the macro C<PAD_SETSV()> rather than calling this function directly.
void pad_setsv(PADOFFSET po, SV *sv)
=for hackers
Found in file pad.c
=item pad_sv
X<pad_sv>
Get the value at offset C<po> in the current (compiling or executing) pad.
Use macro C<PAD_SV> instead of calling this function directly.
SV * pad_sv(PADOFFSET po)
=for hackers
Found in file pad.c
=item pad_tidy
X<pad_tidy>
NOTE: this function is experimental and may change or be
removed without notice.
Tidy up a pad at the end of compilation of the code to which it belongs.
Jobs performed here are: remove most stuff from the pads of anonsub
prototypes; give it a C<@_>; mark temporaries as such. C<type> indicates
the kind of subroutine:
padtidy_SUB ordinary subroutine
padtidy_SUBCLONE prototype for lexical closure
padtidy_FORMAT format
void pad_tidy(padtidy_type type)
=for hackers
Found in file pad.c
=item perl_alloc
X<perl_alloc>
Allocates a new Perl interpreter. See L<perlembed>.
PerlInterpreter* perl_alloc()
=for hackers
Found in file perl.c
=item perl_construct
X<perl_construct>
Initializes a new Perl interpreter. See L<perlembed>.
void perl_construct(PerlInterpreter *my_perl)
=for hackers
Found in file perl.c
=item perl_destruct
X<perl_destruct>
Shuts down a Perl interpreter. See L<perlembed>.
int perl_destruct(PerlInterpreter *my_perl)
=for hackers
Found in file perl.c
=item perl_free
X<perl_free>
Releases a Perl interpreter. See L<perlembed>.
void perl_free(PerlInterpreter *my_perl)
=for hackers
Found in file perl.c
=item perl_parse
X<perl_parse>
Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
int perl_parse(PerlInterpreter *my_perl,
XSINIT_t xsinit, int argc,
char** argv, char** env)
=for hackers
Found in file perl.c
=item perl_run
X<perl_run>
Tells a Perl interpreter to run. See L<perlembed>.
int perl_run(PerlInterpreter *my_perl)
=for hackers
Found in file perl.c
=item require_pv
X<require_pv>
Tells Perl to C<require> the file named by the string argument. It is
analogous to the Perl code C<eval "require '$file'">. It's even
implemented that way; consider using load_module instead.
NOTE: the perl_ form of this function is deprecated.
void require_pv(const char* pv)
=for hackers
Found in file perl.c
=back
=head1 Exception Handling (simple) Macros
=over 8
=item dXCPT
X<dXCPT>
Set up necessary local variables for exception handling.
See L<perlguts/"Exception Handling">.
dXCPT;
=for hackers
Found in file XSUB.h
=item XCPT_CATCH
X<XCPT_CATCH>
Introduces a catch block. See L<perlguts/"Exception Handling">.
=for hackers
Found in file XSUB.h
=item XCPT_RETHROW
X<XCPT_RETHROW>
Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
XCPT_RETHROW;
=for hackers
Found in file XSUB.h
=item XCPT_TRY_END
X<XCPT_TRY_END>
Ends a try block. See L<perlguts/"Exception Handling">.
=for hackers
Found in file XSUB.h
=item XCPT_TRY_START
X<XCPT_TRY_START>
Starts a try block. See L<perlguts/"Exception Handling">.
=for hackers
Found in file XSUB.h
=back
=head1 Functions in file scope.c
=over 8
=item save_gp
X<save_gp>
Saves the current GP of gv on the save stack to be restored on scope exit.
If empty is true, replace the GP with a new GP.
If empty is false, mark gv with GVf_INTRO so the next reference
assigned is localized, which is how C< local *foo = $someref; > works.
void save_gp(GV* gv, I32 empty)
=for hackers
Found in file scope.c
=back
=head1 Functions in file vutil.c
=over 8
=item new_version
X<new_version>
Returns a new version object based on the passed in SV:
SV *sv = new_version(SV *ver);
Does not alter the passed in ver SV. See "upg_version" if you
want to upgrade the SV.
SV* new_version(SV *ver)
=for hackers
Found in file vutil.c
=item prescan_version
X<prescan_version>
Validate that a given string can be parsed as a version object, but doesn't
actually perform the parsing. Can use either strict or lax validation rules.
Can optionally set a number of hint variables to save the parsing code
some time when tokenizing.
const char* prescan_version(const char *s, bool strict,
const char** errstr,
bool *sqv,
int *ssaw_decimal,
int *swidth, bool *salpha)
=for hackers
Found in file vutil.c
=item scan_version
X<scan_version>
Returns a pointer to the next character after the parsed
version string, as well as upgrading the passed in SV to
an RV.
Function must be called with an already existing SV like
sv = newSV(0);
s = scan_version(s, SV *sv, bool qv);
Performs some preprocessing to the string to ensure that
it has the correct characteristics of a version. Flags the
object if it contains an underscore (which denotes this
is an alpha version). The boolean qv denotes that the version
should be interpreted as if it had multiple decimals, even if
it doesn't.
const char* scan_version(const char *s, SV *rv, bool qv)
=for hackers
Found in file vutil.c
=item upg_version
X<upg_version>
In-place upgrade of the supplied SV to a version object.
SV *sv = upg_version(SV *sv, bool qv);
Returns a pointer to the upgraded SV. Set the boolean qv if you want
to force this SV to be interpreted as an "extended" version.
SV* upg_version(SV *ver, bool qv)
=for hackers
Found in file vutil.c
=item vcmp
X<vcmp>
Version object aware cmp. Both operands must already have been
converted into version objects.
int vcmp(SV *lhv, SV *rhv)
=for hackers
Found in file vutil.c
=item vnormal
X<vnormal>
Accepts a version object and returns the normalized string
representation. Call like:
sv = vnormal(rv);
NOTE: you can pass either the object directly or the SV
contained within the RV.
The SV returned has a refcount of 1.
SV* vnormal(SV *vs)
=for hackers
Found in file vutil.c
=item vnumify
X<vnumify>
Accepts a version object and returns the normalized floating
point representation. Call like:
sv = vnumify(rv);
NOTE: you can pass either the object directly or the SV
contained within the RV.
The SV returned has a refcount of 1.
SV* vnumify(SV *vs)
=for hackers
Found in file vutil.c
=item vstringify
X<vstringify>
In order to maintain maximum compatibility with earlier versions
of Perl, this function will return either the floating point
notation or the multiple dotted notation, depending on whether
the original version contained 1 or more dots, respectively.
The SV returned has a refcount of 1.
SV* vstringify(SV *vs)
=for hackers
Found in file vutil.c
=item vverify
X<vverify>
Validates that the SV contains valid internal structure for a version object.
It may be passed either the version object (RV) or the hash itself (HV). If
the structure is valid, it returns the HV. If the structure is invalid,
it returns NULL.
SV *hv = vverify(sv);
Note that it only confirms the bare minimum structure (so as not to get
confused by derived classes which may contain additional hash entries):
=over 4
=item * The SV is an HV or a reference to an HV
=item * The hash contains a "version" key
=item * The "version" key has a reference to an AV as its value
=back
SV* vverify(SV *vs)
=for hackers
Found in file vutil.c
=back
=head1 "Gimme" Values
=over 8
=item G_ARRAY
X<G_ARRAY>
Used to indicate list context. See C<L</GIMME_V>>, C<L</GIMME>> and
L<perlcall>.
=for hackers
Found in file cop.h
=item G_DISCARD
X<G_DISCARD>
Indicates that arguments returned from a callback should be discarded. See
L<perlcall>.
=for hackers
Found in file cop.h
=item G_EVAL
X<G_EVAL>
Used to force a Perl C<eval> wrapper around a callback. See
L<perlcall>.
=for hackers
Found in file cop.h
=item GIMME
X<GIMME>
A backward-compatible version of C<GIMME_V> which can only return
C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
Deprecated. Use C<GIMME_V> instead.
U32 GIMME
=for hackers
Found in file op.h
=item GIMME_V
X<GIMME_V>
The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
respectively. See L<perlcall> for a usage example.
U32 GIMME_V
=for hackers
Found in file op.h
=item G_NOARGS
X<G_NOARGS>
Indicates that no arguments are being sent to a callback. See
L<perlcall>.
=for hackers
Found in file cop.h
=item G_SCALAR
X<G_SCALAR>
Used to indicate scalar context. See C<L</GIMME_V>>, C<L</GIMME>>, and
L<perlcall>.
=for hackers
Found in file cop.h
=item G_VOID
X<G_VOID>
Used to indicate void context. See C<L</GIMME_V>> and L<perlcall>.
=for hackers
Found in file cop.h
=back
=head1 Global Variables
These variables are global to an entire process. They are shared between
all interpreters and all threads in a process. Any variables not documented
here may be changed or removed without notice, so don't use them!
If you feel you really do need to use an unlisted variable, first send email to
L<perl5-porters@perl.org|mailto:perl5-porters@perl.org>. It may be that
someone there will point out a way to accomplish what you need without using an
internal variable. But if not, you should get a go-ahead to document and then
use the variable.
=over 8
=item PL_check
X<PL_check>
Array, indexed by opcode, of functions that will be called for the "check"
phase of optree building during compilation of Perl code. For most (but
not all) types of op, once the op has been initially built and populated
with child ops it will be filtered through the check function referenced
by the appropriate element of this array. The new op is passed in as the
sole argument to the check function, and the check function returns the
completed op. The check function may (as the name suggests) check the op
for validity and signal errors. It may also initialise or modify parts of
the ops, or perform more radical surgery such as adding or removing child
ops, or even throw the op away and return a different op in its place.
This array of function pointers is a convenient place to hook into the
compilation process. An XS module can put its own custom check function
in place of any of the standard ones, to influence the compilation of a
particular type of op. However, a custom check function must never fully
replace a standard check function (or even a custom check function from
another module). A module modifying checking must instead B<wrap> the
preexisting check function. A custom check function must be selective
about when to apply its custom behaviour. In the usual case where
it decides not to do anything special with an op, it must chain the
preexisting op function. Check functions are thus linked in a chain,
with the core's base checker at the end.
For thread safety, modules should not write directly to this array.
Instead, use the function L</wrap_op_checker>.
=for hackers
Found in file perlvars.h
=item PL_keyword_plugin
X<PL_keyword_plugin>
NOTE: this function is experimental and may change or be
removed without notice.
Function pointer, pointing at a function used to handle extended keywords.
The function should be declared as
int keyword_plugin_function(pTHX_
char *keyword_ptr, STRLEN keyword_len,
OP **op_ptr)
The function is called from the tokeniser, whenever a possible keyword
is seen. C<keyword_ptr> points at the word in the parser's input
buffer, and C<keyword_len> gives its length; it is not null-terminated.
The function is expected to examine the word, and possibly other state
such as L<%^H|perlvar/%^H>, to decide whether it wants to handle it
as an extended keyword. If it does not, the function should return
C<KEYWORD_PLUGIN_DECLINE>, and the normal parser process will continue.
If the function wants to handle the keyword, it first must
parse anything following the keyword that is part of the syntax
introduced by the keyword. See L</Lexer interface> for details.
When a keyword is being handled, the plugin function must build
a tree of C<OP> structures, representing the code that was parsed.
The root of the tree must be stored in C<*op_ptr>. The function then
returns a constant indicating the syntactic role of the construct that
it has parsed: C<KEYWORD_PLUGIN_STMT> if it is a complete statement, or
C<KEYWORD_PLUGIN_EXPR> if it is an expression. Note that a statement
construct cannot be used inside an expression (except via C<do BLOCK>
and similar), and an expression is not a complete statement (it requires
at least a terminating semicolon).
When a keyword is handled, the plugin function may also have
(compile-time) side effects. It may modify C<%^H>, define functions, and
so on. Typically, if side effects are the main purpose of a handler,
it does not wish to generate any ops to be included in the normal
compilation. In this case it is still required to supply an op tree,
but it suffices to generate a single null op.
That's how the C<*PL_keyword_plugin> function needs to behave overall.
Conventionally, however, one does not completely replace the existing
handler function. Instead, take a copy of C<PL_keyword_plugin> before
assigning your own function pointer to it. Your handler function should
look for keywords that it is interested in and handle those. Where it
is not interested, it should call the saved plugin function, passing on
the arguments it received. Thus C<PL_keyword_plugin> actually points
at a chain of handler functions, all of which have an opportunity to
handle keywords, and only the last function in the chain (built into
the Perl core) will normally return C<KEYWORD_PLUGIN_DECLINE>.
=for hackers
Found in file perlvars.h
=back
=head1 GV Functions
A GV is a structure which corresponds to to a Perl typeglob, ie *foo.
It is a structure that holds a pointer to a scalar, an array, a hash etc,
corresponding to $foo, @foo, %foo.
GVs are usually found as values in stashes (symbol table hashes) where
Perl stores its global variables.
=over 8
=item GvAV
X<GvAV>
Return the AV from the GV.
AV* GvAV(GV* gv)
=for hackers
Found in file gv.h
=item gv_const_sv
X<gv_const_sv>
If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
inlining, or C<gv> is a placeholder reference that would be promoted to such
a typeglob, then returns the value returned by the sub. Otherwise, returns
C<NULL>.
SV* gv_const_sv(GV* gv)
=for hackers
Found in file gv.c
=item GvCV
X<GvCV>
Return the CV from the GV.
CV* GvCV(GV* gv)
=for hackers
Found in file gv.h
=item gv_fetchmeth
X<gv_fetchmeth>
Like L</gv_fetchmeth_pvn>, but lacks a flags parameter.
GV* gv_fetchmeth(HV* stash, const char* name,
STRLEN len, I32 level)
=for hackers
Found in file gv.c
=item gv_fetchmethod_autoload
X<gv_fetchmethod_autoload>
Returns the glob which contains the subroutine to call to invoke the method
on the C<stash>. In fact in the presence of autoloading this may be the
glob for "AUTOLOAD". In this case the corresponding variable C<$AUTOLOAD> is
already setup.
The third parameter of C<gv_fetchmethod_autoload> determines whether
AUTOLOAD lookup is performed if the given method is not present: non-zero
means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
with a non-zero C<autoload> parameter.
These functions grant C<"SUPER"> token
as a prefix of the method name. Note
that if you want to keep the returned glob for a long time, you need to
check for it being "AUTOLOAD", since at the later time the call may load a
different subroutine due to C<$AUTOLOAD> changing its value. Use the glob
created as a side effect to do this.
These functions have the same side-effects as C<gv_fetchmeth> with
C<level==0>. The warning against passing the GV returned by
C<gv_fetchmeth> to C<call_sv> applies equally to these functions.
GV* gv_fetchmethod_autoload(HV* stash,
const char* name,
I32 autoload)
=for hackers
Found in file gv.c
=item gv_fetchmeth_autoload
X<gv_fetchmeth_autoload>
This is the old form of L</gv_fetchmeth_pvn_autoload>, which has no flags
parameter.
GV* gv_fetchmeth_autoload(HV* stash,
const char* name,
STRLEN len, I32 level)
=for hackers
Found in file gv.c
=item gv_fetchmeth_pv
X<gv_fetchmeth_pv>
Exactly like L</gv_fetchmeth_pvn>, but takes a nul-terminated string
instead of a string/length pair.
GV* gv_fetchmeth_pv(HV* stash, const char* name,
I32 level, U32 flags)
=for hackers
Found in file gv.c
=item gv_fetchmeth_pvn
X<gv_fetchmeth_pvn>
Returns the glob with the given C<name> and a defined subroutine or
C<NULL>. The glob lives in the given C<stash>, or in the stashes
accessible via C<@ISA> and C<UNIVERSAL::>.
The argument C<level> should be either 0 or -1. If C<level==0>, as a
side-effect creates a glob with the given C<name> in the given C<stash>
which in the case of success contains an alias for the subroutine, and sets
up caching info for this glob.
The only significant values for C<flags> are C<GV_SUPER> and C<SVf_UTF8>.
C<GV_SUPER> indicates that we want to look up the method in the superclasses
of the C<stash>.
The
GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
visible to Perl code. So when calling C<call_sv>, you should not use
the GV directly; instead, you should use the method's CV, which can be
obtained from the GV with the C<GvCV> macro.
GV* gv_fetchmeth_pvn(HV* stash, const char* name,
STRLEN len, I32 level,
U32 flags)
=for hackers
Found in file gv.c
=item gv_fetchmeth_pvn_autoload
X<gv_fetchmeth_pvn_autoload>
Same as C<gv_fetchmeth_pvn()>, but looks for autoloaded subroutines too.
Returns a glob for the subroutine.
For an autoloaded subroutine without a GV, will create a GV even
if C<level < 0>. For an autoloaded subroutine without a stub, C<GvCV()>
of the result may be zero.
Currently, the only significant value for C<flags> is C<SVf_UTF8>.
GV* gv_fetchmeth_pvn_autoload(HV* stash,
const char* name,
STRLEN len, I32 level,
U32 flags)
=for hackers
Found in file gv.c
=item gv_fetchmeth_pv_autoload
X<gv_fetchmeth_pv_autoload>
Exactly like L</gv_fetchmeth_pvn_autoload>, but takes a nul-terminated string
instead of a string/length pair.
GV* gv_fetchmeth_pv_autoload(HV* stash,
const char* name,
I32 level, U32 flags)
=for hackers
Found in file gv.c
=item gv_fetchmeth_sv
X<gv_fetchmeth_sv>
Exactly like L</gv_fetchmeth_pvn>, but takes the name string in the form
of an SV instead of a string/length pair.
GV* gv_fetchmeth_sv(HV* stash, SV* namesv,
I32 level, U32 flags)
=for hackers
Found in file gv.c
=item gv_fetchmeth_sv_autoload
X<gv_fetchmeth_sv_autoload>
Exactly like L</gv_fetchmeth_pvn_autoload>, but takes the name string in the form
of an SV instead of a string/length pair.
GV* gv_fetchmeth_sv_autoload(HV* stash, SV* namesv,
I32 level, U32 flags)
=for hackers
Found in file gv.c
=item GvHV
X<GvHV>
Return the HV from the GV.
HV* GvHV(GV* gv)
=for hackers
Found in file gv.h
=item gv_init
X<gv_init>
The old form of C<gv_init_pvn()>. It does not work with UTF-8 strings, as it
has no flags parameter. If the C<multi> parameter is set, the
C<GV_ADDMULTI> flag will be passed to C<gv_init_pvn()>.
void gv_init(GV* gv, HV* stash, const char* name,
STRLEN len, int multi)
=for hackers
Found in file gv.c
=item gv_init_pv
X<gv_init_pv>
Same as C<gv_init_pvn()>, but takes a nul-terminated string for the name
instead of separate char * and length parameters.
void gv_init_pv(GV* gv, HV* stash, const char* name,
U32 flags)
=for hackers
Found in file gv.c
=item gv_init_pvn
X<gv_init_pvn>
Converts a scalar into a typeglob. This is an incoercible typeglob;
assigning a reference to it will assign to one of its slots, instead of
overwriting it as happens with typeglobs created by C<SvSetSV>. Converting
any scalar that is C<SvOK()> may produce unpredictable results and is reserved
for perl's internal use.
C<gv> is the scalar to be converted.
C<stash> is the parent stash/package, if any.
C<name> and C<len> give the name. The name must be unqualified;
that is, it must not include the package name. If C<gv> is a
stash element, it is the caller's responsibility to ensure that the name
passed to this function matches the name of the element. If it does not
match, perl's internal bookkeeping will get out of sync.
C<flags> can be set to C<SVf_UTF8> if C<name> is a UTF-8 string, or
the return value of SvUTF8(sv). It can also take the
C<GV_ADDMULTI> flag, which means to pretend that the GV has been
seen before (i.e., suppress "Used once" warnings).
void gv_init_pvn(GV* gv, HV* stash, const char* name,
STRLEN len, U32 flags)
=for hackers
Found in file gv.c
=item gv_init_sv
X<gv_init_sv>
Same as C<gv_init_pvn()>, but takes an SV * for the name instead of separate
char * and length parameters. C<flags> is currently unused.
void gv_init_sv(GV* gv, HV* stash, SV* namesv,
U32 flags)
=for hackers
Found in file gv.c
=item gv_stashpv
X<gv_stashpv>
Returns a pointer to the stash for a specified package. Uses C<strlen> to
determine the length of C<name>, then calls C<gv_stashpvn()>.
HV* gv_stashpv(const char* name, I32 flags)
=for hackers
Found in file gv.c
=item gv_stashpvn
X<gv_stashpvn>
Returns a pointer to the stash for a specified package. The C<namelen>
parameter indicates the length of the C<name>, in bytes. C<flags> is passed
to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
created if it does not already exist. If the package does not exist and
C<flags> is 0 (or any other setting that does not create packages) then C<NULL>
is returned.
Flags may be one of:
GV_ADD
SVf_UTF8
GV_NOADD_NOINIT
GV_NOINIT
GV_NOEXPAND
GV_ADDMG
The most important of which are probably C<GV_ADD> and C<SVf_UTF8>.
Note, use of C<gv_stashsv> instead of C<gv_stashpvn> where possible is strongly
recommended for performance reasons.
HV* gv_stashpvn(const char* name, U32 namelen,
I32 flags)
=for hackers
Found in file gv.c
=item gv_stashpvs
X<gv_stashpvs>
Like C<gv_stashpvn>, but takes a C<NUL>-terminated literal string instead of a
string/length pair.
HV* gv_stashpvs(const char* name, I32 create)
=for hackers
Found in file handy.h
=item gv_stashsv
X<gv_stashsv>
Returns a pointer to the stash for a specified package. See
C<L</gv_stashpvn>>.
Note this interface is strongly preferred over C<gv_stashpvn> for performance
reasons.
HV* gv_stashsv(SV* sv, I32 flags)
=for hackers
Found in file gv.c
=item GvSV
X<GvSV>
Return the SV from the GV.
SV* GvSV(GV* gv)
=for hackers
Found in file gv.h
=item setdefout
X<setdefout>
Sets C<PL_defoutgv>, the default file handle for output, to the passed in
typeglob. As C<PL_defoutgv> "owns" a reference on its typeglob, the reference
count of the passed in typeglob is increased by one, and the reference count
of the typeglob that C<PL_defoutgv> points to is decreased by one.
void setdefout(GV* gv)
=for hackers
Found in file pp_sys.c
=back
=head1 Handy Values
=over 8
=item Nullav
X<Nullav>
Null AV pointer.
(deprecated - use C<(AV *)NULL> instead)
=for hackers
Found in file av.h
=item Nullch
X<Nullch>
Null character pointer. (No longer available when C<PERL_CORE> is
defined.)
=for hackers
Found in file handy.h
=item Nullcv
X<Nullcv>
Null CV pointer.
(deprecated - use C<(CV *)NULL> instead)
=for hackers
Found in file cv.h
=item Nullhv
X<Nullhv>
Null HV pointer.
(deprecated - use C<(HV *)NULL> instead)
=for hackers
Found in file hv.h
=item Nullsv
X<Nullsv>
Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
=for hackers
Found in file handy.h
=back
=head1 Hash Manipulation Functions
A HV structure represents a Perl hash. It consists mainly of an array
of pointers, each of which points to a linked list of HE structures. The
array is indexed by the hash function of the key, so each linked list
represents all the hash entries with the same hash value. Each HE contains
a pointer to the actual value, plus a pointer to a HEK structure which
holds the key and hash value.
=over 8
=item cop_fetch_label
X<cop_fetch_label>
NOTE: this function is experimental and may change or be
removed without notice.
Returns the label attached to a cop.
The flags pointer may be set to C<SVf_UTF8> or 0.
const char * cop_fetch_label(COP *const cop,
STRLEN *len, U32 *flags)
=for hackers
Found in file hv.c
=item cop_store_label
X<cop_store_label>
NOTE: this function is experimental and may change or be
removed without notice.
Save a label into a C<cop_hints_hash>.
You need to set flags to C<SVf_UTF8>
for a UTF-8 label.
void cop_store_label(COP *const cop,
const char *label, STRLEN len,
U32 flags)
=for hackers
Found in file hv.c
=item get_hv
X<get_hv>
Returns the HV of the specified Perl hash. C<flags> are passed to
C<gv_fetchpv>. If C<GV_ADD> is set and the
Perl variable does not exist then it will be created. If C<flags> is zero
and the variable does not exist then C<NULL> is returned.
NOTE: the perl_ form of this function is deprecated.
HV* get_hv(const char *name, I32 flags)
=for hackers
Found in file perl.c
=item HEf_SVKEY
X<HEf_SVKEY>
This flag, used in the length slot of hash entries and magic structures,
specifies the structure contains an C<SV*> pointer where a C<char*> pointer
is to be expected. (For information only--not to be used).
=for hackers
Found in file hv.h
=item HeHASH
X<HeHASH>
Returns the computed hash stored in the hash entry.
U32 HeHASH(HE* he)
=for hackers
Found in file hv.h
=item HeKEY
X<HeKEY>
Returns the actual pointer stored in the key slot of the hash entry. The
pointer may be either C<char*> or C<SV*>, depending on the value of
C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
usually preferable for finding the value of a key.
void* HeKEY(HE* he)
=for hackers
Found in file hv.h
=item HeKLEN
X<HeKLEN>
If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
be assigned to. The C<HePV()> macro is usually preferable for finding key
lengths.
STRLEN HeKLEN(HE* he)
=for hackers
Found in file hv.h
=item HePV
X<HePV>
Returns the key slot of the hash entry as a C<char*> value, doing any
necessary dereferencing of possibly C<SV*> keys. The length of the string
is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
not care about what the length of the key is, you may use the global
variable C<PL_na>, though this is rather less efficient than using a local
variable. Remember though, that hash keys in perl are free to contain
embedded nulls, so using C<strlen()> or similar is not a good way to find
the length of hash keys. This is very similar to the C<SvPV()> macro
described elsewhere in this document. See also C<L</HeUTF8>>.
If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
efficient.
char* HePV(HE* he, STRLEN len)
=for hackers
Found in file hv.h
=item HeSVKEY
X<HeSVKEY>
Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
contain an C<SV*> key.
SV* HeSVKEY(HE* he)
=for hackers
Found in file hv.h
=item HeSVKEY_force
X<HeSVKEY_force>
Returns the key as an C<SV*>. Will create and return a temporary mortal
C<SV*> if the hash entry contains only a C<char*> key.
SV* HeSVKEY_force(HE* he)
=for hackers
Found in file hv.h
=item HeSVKEY_set
X<HeSVKEY_set>
Sets the key to a given C<SV*>, taking care to set the appropriate flags to
indicate the presence of an C<SV*> key, and returns the same
C<SV*>.
SV* HeSVKEY_set(HE* he, SV* sv)
=for hackers
Found in file hv.h
=item HeUTF8
X<HeUTF8>
Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
doing any necessary dereferencing of possibly C<SV*> keys. The value returned
will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
typedef for C<char>.
U32 HeUTF8(HE* he)
=for hackers
Found in file hv.h
=item HeVAL
X<HeVAL>
Returns the value slot (type C<SV*>)
stored in the hash entry. Can be assigned
to.
SV *foo= HeVAL(hv);
HeVAL(hv)= sv;
SV* HeVAL(HE* he)
=for hackers
Found in file hv.h
=item hv_assert
X<hv_assert>
Check that a hash is in an internally consistent state.
void hv_assert(HV *hv)
=for hackers
Found in file hv.c
=item hv_bucket_ratio
X<hv_bucket_ratio>
NOTE: this function is experimental and may change or be
removed without notice.
If the hash is tied dispatches through to the SCALAR tied method,
otherwise if the hash contains no keys returns 0, otherwise returns
a mortal sv containing a string specifying the number of used buckets,
followed by a slash, followed by the number of available buckets.
This function is expensive, it must scan all of the buckets
to determine which are used, and the count is NOT cached.
In a large hash this could be a lot of buckets.
SV* hv_bucket_ratio(HV *hv)
=for hackers
Found in file hv.c
=item hv_clear
X<hv_clear>
Frees the all the elements of a hash, leaving it empty.
The XS equivalent of C<%hash = ()>. See also L</hv_undef>.
See L</av_clear> for a note about the hash possibly being invalid on
return.
void hv_clear(HV *hv)
=for hackers
Found in file hv.c
=item hv_clear_placeholders
X<hv_clear_placeholders>
Clears any placeholders from a hash. If a restricted hash has any of its keys
marked as readonly and the key is subsequently deleted, the key is not actually
deleted but is marked by assigning it a value of C<&PL_sv_placeholder>. This tags
it so it will be ignored by future operations such as iterating over the hash,
but will still allow the hash to have a value reassigned to the key at some
future point. This function clears any such placeholder keys from the hash.
See C<L<Hash::Util::lock_keys()|Hash::Util/lock_keys>> for an example of its
use.
void hv_clear_placeholders(HV *hv)
=for hackers
Found in file hv.c
=item hv_copy_hints_hv
X<hv_copy_hints_hv>
A specialised version of L</newHVhv> for copying C<%^H>. C<ohv> must be
a pointer to a hash (which may have C<%^H> magic, but should be generally
non-magical), or C<NULL> (interpreted as an empty hash). The content
of C<ohv> is copied to a new hash, which has the C<%^H>-specific magic
added to it. A pointer to the new hash is returned.
HV * hv_copy_hints_hv(HV *ohv)
=for hackers
Found in file hv.c
=item hv_delete
X<hv_delete>
Deletes a key/value pair in the hash. The value's SV is removed from
the hash, made mortal, and returned to the caller. The absolute
value of C<klen> is the length of the key. If C<klen> is negative the
key is assumed to be in UTF-8-encoded Unicode. The C<flags> value
will normally be zero; if set to C<G_DISCARD> then C<NULL> will be returned.
C<NULL> will also be returned if the key is not found.
SV* hv_delete(HV *hv, const char *key, I32 klen,
I32 flags)
=for hackers
Found in file hv.c
=item hv_delete_ent
X<hv_delete_ent>
Deletes a key/value pair in the hash. The value SV is removed from the hash,
made mortal, and returned to the caller. The C<flags> value will normally be
zero; if set to C<G_DISCARD> then C<NULL> will be returned. C<NULL> will also
be returned if the key is not found. C<hash> can be a valid precomputed hash
value, or 0 to ask for it to be computed.
SV* hv_delete_ent(HV *hv, SV *keysv, I32 flags,
U32 hash)
=for hackers
Found in file hv.c
=item HvENAME
X<HvENAME>
Returns the effective name of a stash, or NULL if there is none. The
effective name represents a location in the symbol table where this stash
resides. It is updated automatically when packages are aliased or deleted.
A stash that is no longer in the symbol table has no effective name. This
name is preferable to C<HvNAME> for use in MRO linearisations and isa
caches.
char* HvENAME(HV* stash)
=for hackers
Found in file hv.h
=item HvENAMELEN
X<HvENAMELEN>
Returns the length of the stash's effective name.
STRLEN HvENAMELEN(HV *stash)
=for hackers
Found in file hv.h
=item HvENAMEUTF8
X<HvENAMEUTF8>
Returns true if the effective name is in UTF-8 encoding.
unsigned char HvENAMEUTF8(HV *stash)
=for hackers
Found in file hv.h
=item hv_exists
X<hv_exists>
Returns a boolean indicating whether the specified hash key exists. The
absolute value of C<klen> is the length of the key. If C<klen> is
negative the key is assumed to be in UTF-8-encoded Unicode.
bool hv_exists(HV *hv, const char *key, I32 klen)
=for hackers
Found in file hv.c
=item hv_exists_ent
X<hv_exists_ent>
Returns a boolean indicating whether
the specified hash key exists. C<hash>
can be a valid precomputed hash value, or 0 to ask for it to be
computed.
bool hv_exists_ent(HV *hv, SV *keysv, U32 hash)
=for hackers
Found in file hv.c
=item hv_fetch
X<hv_fetch>
Returns the SV which corresponds to the specified key in the hash.
The absolute value of C<klen> is the length of the key. If C<klen> is
negative the key is assumed to be in UTF-8-encoded Unicode. If
C<lval> is set then the fetch will be part of a store. This means that if
there is no value in the hash associated with the given key, then one is
created and a pointer to it is returned. The C<SV*> it points to can be
assigned to. But always check that the
return value is non-null before dereferencing it to an C<SV*>.
See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
information on how to use this function on tied hashes.
SV** hv_fetch(HV *hv, const char *key, I32 klen,
I32 lval)
=for hackers
Found in file hv.c
=item hv_fetchs
X<hv_fetchs>
Like C<hv_fetch>, but takes a C<NUL>-terminated literal string instead of a
string/length pair.
SV** hv_fetchs(HV* tb, const char* key, I32 lval)
=for hackers
Found in file handy.h
=item hv_fetch_ent
X<hv_fetch_ent>
Returns the hash entry which corresponds to the specified key in the hash.
C<hash> must be a valid precomputed hash number for the given C<key>, or 0
if you want the function to compute it. IF C<lval> is set then the fetch
will be part of a store. Make sure the return value is non-null before
accessing it. The return value when C<hv> is a tied hash is a pointer to a
static location, so be sure to make a copy of the structure if you need to
store it somewhere.
See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
information on how to use this function on tied hashes.
HE* hv_fetch_ent(HV *hv, SV *keysv, I32 lval,
U32 hash)
=for hackers
Found in file hv.c
=item hv_fill
X<hv_fill>
Returns the number of hash buckets that happen to be in use.
This function is wrapped by the macro C<HvFILL>.
As of perl 5.25 this function is used only for debugging
purposes, and the number of used hash buckets is not
in any way cached, thus this function can be costly
to execute as it must iterate over all the buckets in the
hash.
STRLEN hv_fill(HV *const hv)
=for hackers
Found in file hv.c
=item hv_iterinit
X<hv_iterinit>
Prepares a starting point to traverse a hash table. Returns the number of
keys in the hash, including placeholders (i.e. the same as C<HvTOTALKEYS(hv)>).
The return value is currently only meaningful for hashes without tie magic.
NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
hash buckets that happen to be in use. If you still need that esoteric
value, you can get it through the macro C<HvFILL(hv)>.
I32 hv_iterinit(HV *hv)
=for hackers
Found in file hv.c
=item hv_iterkey
X<hv_iterkey>
Returns the key from the current position of the hash iterator. See
C<L</hv_iterinit>>.
char* hv_iterkey(HE* entry, I32* retlen)
=for hackers
Found in file hv.c
=item hv_iterkeysv
X<hv_iterkeysv>
Returns the key as an C<SV*> from the current position of the hash
iterator. The return value will always be a mortal copy of the key. Also
see C<L</hv_iterinit>>.
SV* hv_iterkeysv(HE* entry)
=for hackers
Found in file hv.c
=item hv_iternext
X<hv_iternext>
Returns entries from a hash iterator. See C<L</hv_iterinit>>.
You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
iterator currently points to, without losing your place or invalidating your
iterator. Note that in this case the current entry is deleted from the hash
with your iterator holding the last reference to it. Your iterator is flagged
to free the entry on the next call to C<hv_iternext>, so you must not discard
your iterator immediately else the entry will leak - call C<hv_iternext> to
trigger the resource deallocation.
HE* hv_iternext(HV *hv)
=for hackers
Found in file hv.c
=item hv_iternextsv
X<hv_iternextsv>
Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
operation.
SV* hv_iternextsv(HV *hv, char **key, I32 *retlen)
=for hackers
Found in file hv.c
=item hv_iternext_flags
X<hv_iternext_flags>
NOTE: this function is experimental and may change or be
removed without notice.
Returns entries from a hash iterator. See C<L</hv_iterinit>> and
C<L</hv_iternext>>.
The C<flags> value will normally be zero; if C<HV_ITERNEXT_WANTPLACEHOLDERS> is
set the placeholders keys (for restricted hashes) will be returned in addition
to normal keys. By default placeholders are automatically skipped over.
Currently a placeholder is implemented with a value that is
C<&PL_sv_placeholder>. Note that the implementation of placeholders and
restricted hashes may change, and the implementation currently is
insufficiently abstracted for any change to be tidy.
HE* hv_iternext_flags(HV *hv, I32 flags)
=for hackers
Found in file hv.c
=item hv_iterval
X<hv_iterval>
Returns the value from the current position of the hash iterator. See
C<L</hv_iterkey>>.
SV* hv_iterval(HV *hv, HE *entry)
=for hackers
Found in file hv.c
=item hv_magic
X<hv_magic>
Adds magic to a hash. See C<L</sv_magic>>.
void hv_magic(HV *hv, GV *gv, int how)
=for hackers
Found in file hv.c
=item HvNAME
X<HvNAME>
Returns the package name of a stash, or C<NULL> if C<stash> isn't a stash.
See C<L</SvSTASH>>, C<L</CvSTASH>>.
char* HvNAME(HV* stash)
=for hackers
Found in file hv.h
=item HvNAMELEN
X<HvNAMELEN>
Returns the length of the stash's name.
STRLEN HvNAMELEN(HV *stash)
=for hackers
Found in file hv.h
=item HvNAMEUTF8
X<HvNAMEUTF8>
Returns true if the name is in UTF-8 encoding.
unsigned char HvNAMEUTF8(HV *stash)
=for hackers
Found in file hv.h
=item hv_scalar
X<hv_scalar>
Evaluates the hash in scalar context and returns the result.
When the hash is tied dispatches through to the SCALAR method,
otherwise returns a mortal SV containing the number of keys
in the hash.
Note, prior to 5.25 this function returned what is now
returned by the hv_bucket_ratio() function.
SV* hv_scalar(HV *hv)
=for hackers
Found in file hv.c
=item hv_store
X<hv_store>
Stores an SV in a hash. The hash key is specified as C<key> and the
absolute value of C<klen> is the length of the key. If C<klen> is
negative the key is assumed to be in UTF-8-encoded Unicode. The
C<hash> parameter is the precomputed hash value; if it is zero then
Perl will compute it.
The return value will be
C<NULL> if the operation failed or if the value did not need to be actually
stored within the hash (as in the case of tied hashes). Otherwise it can
be dereferenced to get the original C<SV*>. Note that the caller is
responsible for suitably incrementing the reference count of C<val> before
the call, and decrementing it if the function returned C<NULL>. Effectively
a successful C<hv_store> takes ownership of one reference to C<val>. This is
usually what you want; a newly created SV has a reference count of one, so
if all your code does is create SVs then store them in a hash, C<hv_store>
will own the only reference to the new SV, and your code doesn't need to do
anything further to tidy up. C<hv_store> is not implemented as a call to
C<hv_store_ent>, and does not create a temporary SV for the key, so if your
key data is not already in SV form then use C<hv_store> in preference to
C<hv_store_ent>.
See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
information on how to use this function on tied hashes.
SV** hv_store(HV *hv, const char *key, I32 klen,
SV *val, U32 hash)
=for hackers
Found in file hv.c
=item hv_stores
X<hv_stores>
Like C<hv_store>, but takes a C<NUL>-terminated literal string instead of a
string/length pair
and omits the hash parameter.
SV** hv_stores(HV* tb, const char* key,
NULLOK SV* val)
=for hackers
Found in file handy.h
=item hv_store_ent
X<hv_store_ent>
Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
parameter is the precomputed hash value; if it is zero then Perl will
compute it. The return value is the new hash entry so created. It will be
C<NULL> if the operation failed or if the value did not need to be actually
stored within the hash (as in the case of tied hashes). Otherwise the
contents of the return value can be accessed using the C<He?> macros
described here. Note that the caller is responsible for suitably
incrementing the reference count of C<val> before the call, and
decrementing it if the function returned NULL. Effectively a successful
C<hv_store_ent> takes ownership of one reference to C<val>. This is
usually what you want; a newly created SV has a reference count of one, so
if all your code does is create SVs then store them in a hash, C<hv_store>
will own the only reference to the new SV, and your code doesn't need to do
anything further to tidy up. Note that C<hv_store_ent> only reads the C<key>;
unlike C<val> it does not take ownership of it, so maintaining the correct
reference count on C<key> is entirely the caller's responsibility. C<hv_store>
is not implemented as a call to C<hv_store_ent>, and does not create a temporary
SV for the key, so if your key data is not already in SV form then use
C<hv_store> in preference to C<hv_store_ent>.
See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
information on how to use this function on tied hashes.
HE* hv_store_ent(HV *hv, SV *key, SV *val, U32 hash)
=for hackers
Found in file hv.c
=item hv_undef
X<hv_undef>
Undefines the hash. The XS equivalent of C<undef(%hash)>.
As well as freeing all the elements of the hash (like C<hv_clear()>), this
also frees any auxiliary data and storage associated with the hash.
See L</av_clear> for a note about the hash possibly being invalid on
return.
void hv_undef(HV *hv)
=for hackers
Found in file hv.c
=item newHV
X<newHV>
Creates a new HV. The reference count is set to 1.
HV* newHV()
=for hackers
Found in file hv.h
=back
=head1 Hook manipulation
These functions provide convenient and thread-safe means of manipulating
hook variables.
=over 8
=item wrap_op_checker
X<wrap_op_checker>
Puts a C function into the chain of check functions for a specified op
type. This is the preferred way to manipulate the L</PL_check> array.
C<opcode> specifies which type of op is to be affected. C<new_checker>
is a pointer to the C function that is to be added to that opcode's
check chain, and C<old_checker_p> points to the storage location where a
pointer to the next function in the chain will be stored. The value of
C<new_pointer> is written into the L</PL_check> array, while the value
previously stored there is written to C<*old_checker_p>.
The function should be defined like this:
static OP *new_checker(pTHX_ OP *op) { ... }
It is intended to be called in this manner:
new_checker(aTHX_ op)
C<old_checker_p> should be defined like this:
static Perl_check_t old_checker_p;
L</PL_check> is global to an entire process, and a module wishing to
hook op checking may find itself invoked more than once per process,
typically in different threads. To handle that situation, this function
is idempotent. The location C<*old_checker_p> must initially (once
per process) contain a null pointer. A C variable of static duration
(declared at file scope, typically also marked C<static> to give
it internal linkage) will be implicitly initialised appropriately,
if it does not have an explicit initialiser. This function will only
actually modify the check chain if it finds C<*old_checker_p> to be null.
This function is also thread safe on the small scale. It uses appropriate
locking to avoid race conditions in accessing L</PL_check>.
When this function is called, the function referenced by C<new_checker>
must be ready to be called, except for C<*old_checker_p> being unfilled.
In a threading situation, C<new_checker> may be called immediately,
even before this function has returned. C<*old_checker_p> will always
be appropriately set before C<new_checker> is called. If C<new_checker>
decides not to do anything special with an op that it is given (which
is the usual case for most uses of op check hooking), it must chain the
check function referenced by C<*old_checker_p>.
If you want to influence compilation of calls to a specific subroutine,
then use L</cv_set_call_checker> rather than hooking checking of all
C<entersub> ops.
void wrap_op_checker(Optype opcode,
Perl_check_t new_checker,
Perl_check_t *old_checker_p)
=for hackers
Found in file op.c
=back
=head1 Lexer interface
This is the lower layer of the Perl parser, managing characters and tokens.
=over 8
=item lex_bufutf8
X<lex_bufutf8>
NOTE: this function is experimental and may change or be
removed without notice.
Indicates whether the octets in the lexer buffer
(L</PL_parser-E<gt>linestr>) should be interpreted as the UTF-8 encoding
of Unicode characters. If not, they should be interpreted as Latin-1
characters. This is analogous to the C<SvUTF8> flag for scalars.
In UTF-8 mode, it is not guaranteed that the lexer buffer actually
contains valid UTF-8. Lexing code must be robust in the face of invalid
encoding.
The actual C<SvUTF8> flag of the L</PL_parser-E<gt>linestr> scalar
is significant, but not the whole story regarding the input character
encoding. Normally, when a file is being read, the scalar contains octets
and its C<SvUTF8> flag is off, but the octets should be interpreted as
UTF-8 if the C<use utf8> pragma is in effect. During a string eval,
however, the scalar may have the C<SvUTF8> flag on, and in this case its
octets should be interpreted as UTF-8 unless the C<use bytes> pragma
is in effect. This logic may change in the future; use this function
instead of implementing the logic yourself.
bool lex_bufutf8()
=for hackers
Found in file toke.c
=item lex_discard_to
X<lex_discard_to>
NOTE: this function is experimental and may change or be
removed without notice.
Discards the first part of the L</PL_parser-E<gt>linestr> buffer,
up to C<ptr>. The remaining content of the buffer will be moved, and
all pointers into the buffer updated appropriately. C<ptr> must not
be later in the buffer than the position of L</PL_parser-E<gt>bufptr>:
it is not permitted to discard text that has yet to be lexed.
Normally it is not necessarily to do this directly, because it suffices to
use the implicit discarding behaviour of L</lex_next_chunk> and things
based on it. However, if a token stretches across multiple lines,
and the lexing code has kept multiple lines of text in the buffer for
that purpose, then after completion of the token it would be wise to
explicitly discard the now-unneeded earlier lines, to avoid future
multi-line tokens growing the buffer without bound.
void lex_discard_to(char *ptr)
=for hackers
Found in file toke.c
=item lex_grow_linestr
X<lex_grow_linestr>
NOTE: this function is experimental and may change or be
removed without notice.
Reallocates the lexer buffer (L</PL_parser-E<gt>linestr>) to accommodate
at least C<len> octets (including terminating C<NUL>). Returns a
pointer to the reallocated buffer. This is necessary before making
any direct modification of the buffer that would increase its length.
L</lex_stuff_pvn> provides a more convenient way to insert text into
the buffer.
Do not use C<SvGROW> or C<sv_grow> directly on C<PL_parser-E<gt>linestr>;
this function updates all of the lexer's variables that point directly
into the buffer.
char * lex_grow_linestr(STRLEN len)
=for hackers
Found in file toke.c
=item lex_next_chunk
X<lex_next_chunk>
NOTE: this function is experimental and may change or be
removed without notice.
Reads in the next chunk of text to be lexed, appending it to
L</PL_parser-E<gt>linestr>. This should be called when lexing code has
looked to the end of the current chunk and wants to know more. It is
usual, but not necessary, for lexing to have consumed the entirety of
the current chunk at this time.
If L</PL_parser-E<gt>bufptr> is pointing to the very end of the current
chunk (i.e., the current chunk has been entirely consumed), normally the
current chunk will be discarded at the same time that the new chunk is
read in. If C<flags> has the C<LEX_KEEP_PREVIOUS> bit set, the current chunk
will not be discarded. If the current chunk has not been entirely
consumed, then it will not be discarded regardless of the flag.
Returns true if some new text was added to the buffer, or false if the
buffer has reached the end of the input text.
bool lex_next_chunk(U32 flags)
=for hackers
Found in file toke.c
=item lex_peek_unichar
X<lex_peek_unichar>
NOTE: this function is experimental and may change or be
removed without notice.
Looks ahead one (Unicode) character in the text currently being lexed.
Returns the codepoint (unsigned integer value) of the next character,
or -1 if lexing has reached the end of the input text. To consume the
peeked character, use L</lex_read_unichar>.
If the next character is in (or extends into) the next chunk of input
text, the next chunk will be read in. Normally the current chunk will be
discarded at the same time, but if C<flags> has the C<LEX_KEEP_PREVIOUS>
bit set, then the current chunk will not be discarded.
If the input is being interpreted as UTF-8 and a UTF-8 encoding error
is encountered, an exception is generated.
I32 lex_peek_unichar(U32 flags)
=for hackers
Found in file toke.c
=item lex_read_space
X<lex_read_space>
NOTE: this function is experimental and may change or be
removed without notice.
Reads optional spaces, in Perl style, in the text currently being
lexed. The spaces may include ordinary whitespace characters and
Perl-style comments. C<#line> directives are processed if encountered.
L</PL_parser-E<gt>bufptr> is moved past the spaces, so that it points
at a non-space character (or the end of the input text).
If spaces extend into the next chunk of input text, the next chunk will
be read in. Normally the current chunk will be discarded at the same
time, but if C<flags> has the C<LEX_KEEP_PREVIOUS> bit set, then the current
chunk will not be discarded.
void lex_read_space(U32 flags)
=for hackers
Found in file toke.c
=item lex_read_to
X<lex_read_to>
NOTE: this function is experimental and may change or be
removed without notice.
Consume text in the lexer buffer, from L</PL_parser-E<gt>bufptr> up
to C<ptr>. This advances L</PL_parser-E<gt>bufptr> to match C<ptr>,
performing the correct bookkeeping whenever a newline character is passed.
This is the normal way to consume lexed text.
Interpretation of the buffer's octets can be abstracted out by
using the slightly higher-level functions L</lex_peek_unichar> and
L</lex_read_unichar>.
void lex_read_to(char *ptr)
=for hackers
Found in file toke.c
=item lex_read_unichar
X<lex_read_unichar>
NOTE: this function is experimental and may change or be
removed without notice.
Reads the next (Unicode) character in the text currently being lexed.
Returns the codepoint (unsigned integer value) of the character read,
and moves L</PL_parser-E<gt>bufptr> past the character, or returns -1
if lexing has reached the end of the input text. To non-destructively
examine the next character, use L</lex_peek_unichar> instead.
If the next character is in (or extends into) the next chunk of input
text, the next chunk will be read in. Normally the current chunk will be
discarded at the same time, but if C<flags> has the C<LEX_KEEP_PREVIOUS>
bit set, then the current chunk will not be discarded.
If the input is being interpreted as UTF-8 and a UTF-8 encoding error
is encountered, an exception is generated.
I32 lex_read_unichar(U32 flags)
=for hackers
Found in file toke.c
=item lex_start
X<lex_start>
NOTE: this function is experimental and may change or be
removed without notice.
Creates and initialises a new lexer/parser state object, supplying
a context in which to lex and parse from a new source of Perl code.
A pointer to the new state object is placed in L</PL_parser>. An entry
is made on the save stack so that upon unwinding, the new state object
will be destroyed and the former value of L</PL_parser> will be restored.
Nothing else need be done to clean up the parsing context.
The code to be parsed comes from C<line> and C<rsfp>. C<line>, if
non-null, provides a string (in SV form) containing code to be parsed.
A copy of the string is made, so subsequent modification of C<line>
does not affect parsing. C<rsfp>, if non-null, provides an input stream
from which code will be read to be parsed. If both are non-null, the
code in C<line> comes first and must consist of complete lines of input,
and C<rsfp> supplies the remainder of the source.
The C<flags> parameter is reserved for future use. Currently it is only
used by perl internally, so extensions should always pass zero.
void lex_start(SV *line, PerlIO *rsfp, U32 flags)
=for hackers
Found in file toke.c
=item lex_stuff_pv
X<lex_stuff_pv>
NOTE: this function is experimental and may change or be
removed without notice.
Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
reallocating the buffer if necessary. This means that lexing code that
runs later will see the characters as if they had appeared in the input.
It is not recommended to do this as part of normal parsing, and most
uses of this facility run the risk of the inserted characters being
interpreted in an unintended manner.
The string to be inserted is represented by octets starting at C<pv>
and continuing to the first nul. These octets are interpreted as either
UTF-8 or Latin-1, according to whether the C<LEX_STUFF_UTF8> flag is set
in C<flags>. The characters are recoded for the lexer buffer, according
to how the buffer is currently being interpreted (L</lex_bufutf8>).
If it is not convenient to nul-terminate a string to be inserted, the
L</lex_stuff_pvn> function is more appropriate.
void lex_stuff_pv(const char *pv, U32 flags)
=for hackers
Found in file toke.c
=item lex_stuff_pvn
X<lex_stuff_pvn>
NOTE: this function is experimental and may change or be
removed without notice.
Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
reallocating the buffer if necessary. This means that lexing code that
runs later will see the characters as if they had appeared in the input.
It is not recommended to do this as part of normal parsing, and most
uses of this facility run the risk of the inserted characters being
interpreted in an unintended manner.
The string to be inserted is represented by C<len> octets starting
at C<pv>. These octets are interpreted as either UTF-8 or Latin-1,
according to whether the C<LEX_STUFF_UTF8> flag is set in C<flags>.
The characters are recoded for the lexer buffer, according to how the
buffer is currently being interpreted (L</lex_bufutf8>). If a string
to be inserted is available as a Perl scalar, the L</lex_stuff_sv>
function is more convenient.
void lex_stuff_pvn(const char *pv, STRLEN len,
U32 flags)
=for hackers
Found in file toke.c
=item lex_stuff_pvs
X<lex_stuff_pvs>
NOTE: this function is experimental and may change or be
removed without notice.
Like L</lex_stuff_pvn>, but takes a C<NUL>-terminated literal string instead of
a string/length pair.
void lex_stuff_pvs(const char *pv, U32 flags)
=for hackers
Found in file handy.h
=item lex_stuff_sv
X<lex_stuff_sv>
NOTE: this function is experimental and may change or be
removed without notice.
Insert characters into the lexer buffer (L</PL_parser-E<gt>linestr>),
immediately after the current lexing point (L</PL_parser-E<gt>bufptr>),
reallocating the buffer if necessary. This means that lexing code that
runs later will see the characters as if they had appeared in the input.
It is not recommended to do this as part of normal parsing, and most
uses of this facility run the risk of the inserted characters being
interpreted in an unintended manner.
The string to be inserted is the string value of C<sv>. The characters
are recoded for the lexer buffer, according to how the buffer is currently
being interpreted (L</lex_bufutf8>). If a string to be inserted is
not already a Perl scalar, the L</lex_stuff_pvn> function avoids the
need to construct a scalar.
void lex_stuff_sv(SV *sv, U32 flags)
=for hackers
Found in file toke.c
=item lex_unstuff
X<lex_unstuff>
NOTE: this function is experimental and may change or be
removed without notice.
Discards text about to be lexed, from L</PL_parser-E<gt>bufptr> up to
C<ptr>. Text following C<ptr> will be moved, and the buffer shortened.
This hides the discarded text from any lexing code that runs later,
as if the text had never appeared.
This is not the normal way to consume lexed text. For that, use
L</lex_read_to>.
void lex_unstuff(char *ptr)
=for hackers
Found in file toke.c
=item parse_arithexpr
X<parse_arithexpr>
NOTE: this function is experimental and may change or be
removed without notice.
Parse a Perl arithmetic expression. This may contain operators of precedence
down to the bit shift operators. The expression must be followed (and thus
terminated) either by a comparison or lower-precedence operator or by
something that would normally terminate an expression such as semicolon.
If C<flags> has the C<PARSE_OPTIONAL> bit set, then the expression is optional,
otherwise it is mandatory. It is up to the caller to ensure that the
dynamic parser state (L</PL_parser> et al) is correctly set to reflect
the source of the code to be parsed and the lexical context for the
expression.
The op tree representing the expression is returned. If an optional
expression is absent, a null pointer is returned, otherwise the pointer
will be non-null.
If an error occurs in parsing or compilation, in most cases a valid op
tree is returned anyway. The error is reflected in the parser state,
normally resulting in a single exception at the top level of parsing
which covers all the compilation errors that occurred. Some compilation
errors, however, will throw an exception immediately.
OP * parse_arithexpr(U32 flags)
=for hackers
Found in file toke.c
=item parse_barestmt
X<parse_barestmt>
NOTE: this function is experimental and may change or be
removed without notice.
Parse a single unadorned Perl statement. This may be a normal imperative
statement or a declaration that has compile-time effect. It does not
include any label or other affixture. It is up to the caller to ensure
that the dynamic parser state (L</PL_parser> et al) is correctly set to
reflect the source of the code to be parsed and the lexical context for
the statement.
The op tree representing the statement is returned. This may be a
null pointer if the statement is null, for example if it was actually
a subroutine definition (which has compile-time side effects). If not
null, it will be ops directly implementing the statement, suitable to
pass to L</newSTATEOP>. It will not normally include a C<nextstate> or
equivalent op (except for those embedded in a scope contained entirely
within the statement).
If an error occurs in parsing or compilation, in most cases a valid op
tree (most likely null) is returned anyway. The error is reflected in
the parser state, normally resulting in a single exception at the top
level of parsing which covers all the compilation errors that occurred.
Some compilation errors, however, will throw an exception immediately.
The C<flags> parameter is reserved for future use, and must always
be zero.
OP * parse_barestmt(U32 flags)
=for hackers
Found in file toke.c
=item parse_block
X<parse_block>
NOTE: this function is experimental and may change or be
removed without notice.
Parse a single complete Perl code block. This consists of an opening
brace, a sequence of statements, and a closing brace. The block
constitutes a lexical scope, so C<my> variables and various compile-time
effects can be contained within it. It is up to the caller to ensure
that the dynamic parser state (L</PL_parser> et al) is correctly set to
reflect the source of the code to be parsed and the lexical context for
the statement.
The op tree representing the code block is returned. This is always a
real op, never a null pointer. It will normally be a C<lineseq> list,
including C<nextstate> or equivalent ops. No ops to construct any kind
of runtime scope are included by virtue of it being a block.
If an error occurs in parsing or compilation, in most cases a valid op
tree (most likely null) is returned anyway. The error is reflected in
the parser state, normally resulting in a single exception at the top
level of parsing which covers all the compilation errors that occurred.
Some compilation errors, however, will throw an exception immediately.
The C<flags> parameter is reserved for future use, and must always
be zero.
OP * parse_block(U32 flags)
=for hackers
Found in file toke.c
=item parse_fullexpr
X<parse_fullexpr>
NOTE: this function is experimental and may change or be
removed without notice.
Parse a single complete Perl expression. This allows the full
expression grammar, including the lowest-precedence operators such
as C<or>. The expression must be followed (and thus terminated) by a
token that an expression would normally be terminated by: end-of-file,
closing bracketing punctuation, semicolon, or one of the keywords that
signals a postfix expression-statement modifier. If C<flags> has the
C<PARSE_OPTIONAL> bit set, then the expression is optional, otherwise it is
mandatory. It is up to the caller to ensure that the dynamic parser
state (L</PL_parser> et al) is correctly set to reflect the source of
the code to be parsed and the lexical context for the expression.
The op tree representing the expression is returned. If an optional
expression is absent, a null pointer is returned, otherwise the pointer
will be non-null.
If an error occurs in parsing or compilation, in most cases a valid op
tree is returned anyway. The error is reflected in the parser state,
normally resulting in a single exception at the top level of parsing
which covers all the compilation errors that occurred. Some compilation
errors, however, will throw an exception immediately.
OP * parse_fullexpr(U32 flags)
=for hackers
Found in file toke.c
=item parse_fullstmt
X<parse_fullstmt>
NOTE: this function is experimental and may change or be
removed without notice.
Parse a single complete Perl statement. This may be a normal imperative
statement or a declaration that has compile-time effect, and may include
optional labels. It is up to the caller to ensure that the dynamic
parser state (L</PL_parser> et al) is correctly set to reflect the source
of the code to be parsed and the lexical context for the statement.
The op tree representing the statement is returned. This may be a
null pointer if the statement is null, for example if it was actually
a subroutine definition (which has compile-time side effects). If not
null, it will be the result of a L</newSTATEOP> call, normally including
a C<nextstate> or equivalent op.
If an error occurs in parsing or compilation, in most cases a valid op
tree (most likely null) is returned anyway. The error is reflected in
the parser state, normally resulting in a single exception at the top
level of parsing which covers all the compilation errors that occurred.
Some compilation errors, however, will throw an exception immediately.
The C<flags> parameter is reserved for future use, and must always
be zero.
OP * parse_fullstmt(U32 flags)
=for hackers
Found in file toke.c
=item parse_label
X<parse_label>
NOTE: this function is experimental and may change or be
removed without notice.
Parse a single label, possibly optional, of the type that may prefix a
Perl statement. It is up to the caller to ensure that the dynamic parser
state (L</PL_parser> et al) is correctly set to reflect the source of
the code to be parsed. If C<flags> has the C<PARSE_OPTIONAL> bit set, then the
label is optional, otherwise it is mandatory.
The name of the label is returned in the form of a fresh scalar. If an
optional label is absent, a null pointer is returned.
If an error occurs in parsing, which can only occur if the label is
mandatory, a valid label is returned anyway. The error is reflected in
the parser state, normally resulting in a single exception at the top
level of parsing which covers all the compilation errors that occurred.
SV * parse_label(U32 flags)
=for hackers
Found in file toke.c
=item parse_listexpr
X<parse_listexpr>
NOTE: this function is experimental and may change or be
removed without notice.
Parse a Perl list expression. This may contain operators of precedence
down to the comma operator. The expression must be followed (and thus
terminated) either by a low-precedence logic operator such as C<or> or by
something that would normally terminate an expression such as semicolon.
If C<flags> has the C<PARSE_OPTIONAL> bit set, then the expression is optional,
otherwise it is mandatory. It is up to the caller to ensure that the
dynamic parser state (L</PL_parser> et al) is correctly set to reflect
the source of the code to be parsed and the lexical context for the
expression.
The op tree representing the expression is returned. If an optional
expression is absent, a null pointer is returned, otherwise the pointer
will be non-null.
If an error occurs in parsing or compilation, in most cases a valid op
tree is returned anyway. The error is reflected in the parser state,
normally resulting in a single exception at the top level of parsing
which covers all the compilation errors that occurred. Some compilation
errors, however, will throw an exception immediately.
OP * parse_listexpr(U32 flags)
=for hackers
Found in file toke.c
=item parse_stmtseq
X<parse_stmtseq>
NOTE: this function is experimental and may change or be
removed without notice.
Parse a sequence of zero or more Perl statements. These may be normal
imperative statements, including optional labels, or declarations
that have compile-time effect, or any mixture thereof. The statement
sequence ends when a closing brace or end-of-file is encountered in a
place where a new statement could have validly started. It is up to
the caller to ensure that the dynamic parser state (L</PL_parser> et al)
is correctly set to reflect the source of the code to be parsed and the
lexical context for the statements.
The op tree representing the statement sequence is returned. This may
be a null pointer if the statements were all null, for example if there
were no statements or if there were only subroutine definitions (which
have compile-time side effects). If not null, it will be a C<lineseq>
list, normally including C<nextstate> or equivalent ops.
If an error occurs in parsing or compilation, in most cases a valid op
tree is returned anyway. The error is reflected in the parser state,
normally resulting in a single exception at the top level of parsing
which covers all the compilation errors that occurred. Some compilation
errors, however, will throw an exception immediately.
The C<flags> parameter is reserved for future use, and must always
be zero.
OP * parse_stmtseq(U32 flags)
=for hackers
Found in file toke.c
=item parse_termexpr
X<parse_termexpr>
NOTE: this function is experimental and may change or be
removed without notice.
Parse a Perl term expression. This may contain operators of precedence
down to the assignment operators. The expression must be followed (and thus
terminated) either by a comma or lower-precedence operator or by
something that would normally terminate an expression such as semicolon.
If C<flags> has the C<PARSE_OPTIONAL> bit set, then the expression is optional,
otherwise it is mandatory. It is up to the caller to ensure that the
dynamic parser state (L</PL_parser> et al) is correctly set to reflect
the source of the code to be parsed and the lexical context for the
expression.
The op tree representing the expression is returned. If an optional
expression is absent, a null pointer is returned, otherwise the pointer
will be non-null.
If an error occurs in parsing or compilation, in most cases a valid op
tree is returned anyway. The error is reflected in the parser state,
normally resulting in a single exception at the top level of parsing
which covers all the compilation errors that occurred. Some compilation
errors, however, will throw an exception immediately.
OP * parse_termexpr(U32 flags)
=for hackers
Found in file toke.c
=item PL_parser
X<PL_parser>
Pointer to a structure encapsulating the state of the parsing operation
currently in progress. The pointer can be locally changed to perform
a nested parse without interfering with the state of an outer parse.
Individual members of C<PL_parser> have their own documentation.
=for hackers
Found in file toke.c
=item PL_parser-E<gt>bufend
X<PL_parser-E<gt>bufend>
NOTE: this function is experimental and may change or be
removed without notice.
Direct pointer to the end of the chunk of text currently being lexed, the
end of the lexer buffer. This is equal to C<SvPVX(PL_parser-E<gt>linestr)
+ SvCUR(PL_parser-E<gt>linestr)>. A C<NUL> character (zero octet) is
always located at the end of the buffer, and does not count as part of
the buffer's contents.
=for hackers
Found in file toke.c
=item PL_parser-E<gt>bufptr
X<PL_parser-E<gt>bufptr>
NOTE: this function is experimental and may change or be
removed without notice.
Points to the current position of lexing inside the lexer buffer.
Characters around this point may be freely examined, within
the range delimited by C<SvPVX(L</PL_parser-E<gt>linestr>)> and
L</PL_parser-E<gt>bufend>. The octets of the buffer may be intended to be
interpreted as either UTF-8 or Latin-1, as indicated by L</lex_bufutf8>.
Lexing code (whether in the Perl core or not) moves this pointer past
the characters that it consumes. It is also expected to perform some
bookkeeping whenever a newline character is consumed. This movement
can be more conveniently performed by the function L</lex_read_to>,
which handles newlines appropriately.
Interpretation of the buffer's octets can be abstracted out by
using the slightly higher-level functions L</lex_peek_unichar> and
L</lex_read_unichar>.
=for hackers
Found in file toke.c
=item PL_parser-E<gt>linestart
X<PL_parser-E<gt>linestart>
NOTE: this function is experimental and may change or be
removed without notice.
Points to the start of the current line inside the lexer buffer.
This is useful for indicating at which column an error occurred, and
not much else. This must be updated by any lexing code that consumes
a newline; the function L</lex_read_to> handles this detail.
=for hackers
Found in file toke.c
=item PL_parser-E<gt>linestr
X<PL_parser-E<gt>linestr>
NOTE: this function is experimental and may change or be
removed without notice.
Buffer scalar containing the chunk currently under consideration of the
text currently being lexed. This is always a plain string scalar (for
which C<SvPOK> is true). It is not intended to be used as a scalar by
normal scalar means; instead refer to the buffer directly by the pointer
variables described below.
The lexer maintains various C<char*> pointers to things in the
C<PL_parser-E<gt>linestr> buffer. If C<PL_parser-E<gt>linestr> is ever
reallocated, all of these pointers must be updated. Don't attempt to
do this manually, but rather use L</lex_grow_linestr> if you need to
reallocate the buffer.
The content of the text chunk in the buffer is commonly exactly one
complete line of input, up to and including a newline terminator,
but there are situations where it is otherwise. The octets of the
buffer may be intended to be interpreted as either UTF-8 or Latin-1.
The function L</lex_bufutf8> tells you which. Do not use the C<SvUTF8>
flag on this scalar, which may disagree with it.
For direct examination of the buffer, the variable
L</PL_parser-E<gt>bufend> points to the end of the buffer. The current
lexing position is pointed to by L</PL_parser-E<gt>bufptr>. Direct use
of these pointers is usually preferable to examination of the scalar
through normal scalar means.
=for hackers
Found in file toke.c
=back
=head1 Locale-related functions and macros
=over 8
=item DECLARATION_FOR_LC_NUMERIC_MANIPULATION
X<DECLARATION_FOR_LC_NUMERIC_MANIPULATION>
This macro should be used as a statement. It declares a private variable
(whose name begins with an underscore) that is needed by the other macros in
this section. Failing to include this correctly should lead to a syntax error.
For compatibility with C89 C compilers it should be placed in a block before
any executable statements.
void DECLARATION_FOR_LC_NUMERIC_MANIPULATION
=for hackers
Found in file perl.h
=item RESTORE_LC_NUMERIC
X<RESTORE_LC_NUMERIC>
This is used in conjunction with one of the macros
L</STORE_LC_NUMERIC_SET_TO_NEEDED>
and
L</STORE_LC_NUMERIC_FORCE_TO_UNDERLYING>
to properly restore the C<LC_NUMERIC> state.
A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
declare at compile time a private variable used by this macro and the two
C<STORE> ones. This macro should be called as a single statement, not an
expression, but with an empty argument list, like this:
{
DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
...
RESTORE_LC_NUMERIC();
...
}
void RESTORE_LC_NUMERIC()
=for hackers
Found in file perl.h
=item STORE_LC_NUMERIC_FORCE_TO_UNDERLYING
X<STORE_LC_NUMERIC_FORCE_TO_UNDERLYING>
This is used by XS code that that is C<LC_NUMERIC> locale-aware to force the
locale for category C<LC_NUMERIC> to be what perl thinks is the current
underlying locale. (The perl interpreter could be wrong about what the
underlying locale actually is if some C or XS code has called the C library
function L<setlocale(3)> behind its back; calling L</sync_locale> before calling
this macro will update perl's records.)
A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
declare at compile time a private variable used by this macro. This macro
should be called as a single statement, not an expression, but with an empty
argument list, like this:
{
DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
...
STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
...
RESTORE_LC_NUMERIC();
...
}
The private variable is used to save the current locale state, so
that the requisite matching call to L</RESTORE_LC_NUMERIC> can restore it.
void STORE_LC_NUMERIC_FORCE_TO_UNDERLYING()
=for hackers
Found in file perl.h
=item STORE_LC_NUMERIC_SET_TO_NEEDED
X<STORE_LC_NUMERIC_SET_TO_NEEDED>
This is used to help wrap XS or C code that that is C<LC_NUMERIC> locale-aware.
This locale category is generally kept set to the C locale by Perl for
backwards compatibility, and because most XS code that reads floating point
values can cope only with the decimal radix character being a dot.
This macro makes sure the current C<LC_NUMERIC> state is set properly, to be
aware of locale if the call to the XS or C code from the Perl program is
from within the scope of a S<C<use locale>>; or to ignore locale if the call is
instead from outside such scope.
This macro is the start of wrapping the C or XS code; the wrap ending is done
by calling the L</RESTORE_LC_NUMERIC> macro after the operation. Otherwise
the state can be changed that will adversely affect other XS code.
A call to L</DECLARATION_FOR_LC_NUMERIC_MANIPULATION> must have been made to
declare at compile time a private variable used by this macro. This macro
should be called as a single statement, not an expression, but with an empty
argument list, like this:
{
DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
...
STORE_LC_NUMERIC_SET_TO_NEEDED();
...
RESTORE_LC_NUMERIC();
...
}
void STORE_LC_NUMERIC_SET_TO_NEEDED()
=for hackers
Found in file perl.h
=item sync_locale
X<sync_locale>
Changing the program's locale should be avoided by XS code. Nevertheless,
certain non-Perl libraries called from XS, such as C<Gtk> do so. When this
happens, Perl needs to be told that the locale has changed. Use this function
to do so, before returning to Perl.
void sync_locale()
=for hackers
Found in file locale.c
=back
=head1 Magical Functions
=over 8
=item mg_clear
X<mg_clear>
Clear something magical that the SV represents. See C<L</sv_magic>>.
int mg_clear(SV* sv)
=for hackers
Found in file mg.c
=item mg_copy
X<mg_copy>
Copies the magic from one SV to another. See C<L</sv_magic>>.
int mg_copy(SV *sv, SV *nsv, const char *key,
I32 klen)
=for hackers
Found in file mg.c
=item mg_find
X<mg_find>
Finds the magic pointer for C<type> matching the SV. See C<L</sv_magic>>.
MAGIC* mg_find(const SV* sv, int type)
=for hackers
Found in file mg.c
=item mg_findext
X<mg_findext>
Finds the magic pointer of C<type> with the given C<vtbl> for the C<SV>. See
C<L</sv_magicext>>.
MAGIC* mg_findext(const SV* sv, int type,
const MGVTBL *vtbl)
=for hackers
Found in file mg.c
=item mg_free
X<mg_free>
Free any magic storage used by the SV. See C<L</sv_magic>>.
int mg_free(SV* sv)
=for hackers
Found in file mg.c
=item mg_free_type
X<mg_free_type>
Remove any magic of type C<how> from the SV C<sv>. See L</sv_magic>.
void mg_free_type(SV *sv, int how)
=for hackers
Found in file mg.c
=item mg_get
X<mg_get>
Do magic before a value is retrieved from the SV. The type of SV must
be >= C<SVt_PVMG>. See C<L</sv_magic>>.
int mg_get(SV* sv)
=for hackers
Found in file mg.c
=item mg_length
X<mg_length>
DEPRECATED! It is planned to remove this function from a
future release of Perl. Do not use it for new code; remove it from
existing code.
Reports on the SV's length in bytes, calling length magic if available,
but does not set the UTF8 flag on C<sv>. It will fall back to 'get'
magic if there is no 'length' magic, but with no indication as to
whether it called 'get' magic. It assumes C<sv> is a C<PVMG> or
higher. Use C<sv_len()> instead.
U32 mg_length(SV* sv)
=for hackers
Found in file mg.c
=item mg_magical
X<mg_magical>
Turns on the magical status of an SV. See C<L</sv_magic>>.
void mg_magical(SV* sv)
=for hackers
Found in file mg.c
=item mg_set
X<mg_set>
Do magic after a value is assigned to the SV. See C<L</sv_magic>>.
int mg_set(SV* sv)
=for hackers
Found in file mg.c
=item SvGETMAGIC
X<SvGETMAGIC>
Invokes C<mg_get> on an SV if it has 'get' magic. For example, this
will call C<FETCH> on a tied variable. This macro evaluates its
argument more than once.
void SvGETMAGIC(SV* sv)
=for hackers
Found in file sv.h
=item SvLOCK
X<SvLOCK>
Arranges for a mutual exclusion lock to be obtained on C<sv> if a suitable module
has been loaded.
void SvLOCK(SV* sv)
=for hackers
Found in file sv.h
=item SvSETMAGIC
X<SvSETMAGIC>
Invokes C<mg_set> on an SV if it has 'set' magic. This is necessary
after modifying a scalar, in case it is a magical variable like C<$|>
or a tied variable (it calls C<STORE>). This macro evaluates its
argument more than once.
void SvSETMAGIC(SV* sv)
=for hackers
Found in file sv.h
=item SvSetMagicSV
X<SvSetMagicSV>
Like C<SvSetSV>, but does any set magic required afterwards.
void SvSetMagicSV(SV* dsv, SV* ssv)
=for hackers
Found in file sv.h
=item SvSetMagicSV_nosteal
X<SvSetMagicSV_nosteal>
Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
=for hackers
Found in file sv.h
=item SvSetSV
X<SvSetSV>
Calls C<sv_setsv> if C<dsv> is not the same as C<ssv>. May evaluate arguments
more than once. Does not handle 'set' magic on the destination SV.
void SvSetSV(SV* dsv, SV* ssv)
=for hackers
Found in file sv.h
=item SvSetSV_nosteal
X<SvSetSV_nosteal>
Calls a non-destructive version of C<sv_setsv> if C<dsv> is not the same as
C<ssv>. May evaluate arguments more than once.
void SvSetSV_nosteal(SV* dsv, SV* ssv)
=for hackers
Found in file sv.h
=item SvSHARE
X<SvSHARE>
Arranges for C<sv> to be shared between threads if a suitable module
has been loaded.
void SvSHARE(SV* sv)
=for hackers
Found in file sv.h
=item SvUNLOCK
X<SvUNLOCK>
Releases a mutual exclusion lock on C<sv> if a suitable module
has been loaded.
void SvUNLOCK(SV* sv)
=for hackers
Found in file sv.h
=back
=head1 Memory Management
=over 8
=item Copy
X<Copy>
The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
source, C<dest> is the destination, C<nitems> is the number of items, and
C<type> is the type. May fail on overlapping copies. See also C<L</Move>>.
void Copy(void* src, void* dest, int nitems, type)
=for hackers
Found in file handy.h
=item CopyD
X<CopyD>
Like C<Copy> but returns C<dest>. Useful
for encouraging compilers to tail-call
optimise.
void * CopyD(void* src, void* dest, int nitems, type)
=for hackers
Found in file handy.h
=item Move
X<Move>
The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
source, C<dest> is the destination, C<nitems> is the number of items, and
C<type> is the type. Can do overlapping moves. See also C<L</Copy>>.
void Move(void* src, void* dest, int nitems, type)
=for hackers
Found in file handy.h
=item MoveD
X<MoveD>
Like C<Move> but returns C<dest>. Useful
for encouraging compilers to tail-call
optimise.
void * MoveD(void* src, void* dest, int nitems, type)
=for hackers
Found in file handy.h
=item Newx
X<Newx>
The XSUB-writer's interface to the C C<malloc> function.
Memory obtained by this should B<ONLY> be freed with L</"Safefree">.
In 5.9.3, Newx() and friends replace the older New() API, and drops
the first parameter, I<x>, a debug aid which allowed callers to identify
themselves. This aid has been superseded by a new build option,
PERL_MEM_LOG (see L<perlhacktips/PERL_MEM_LOG>). The older API is still
there for use in XS modules supporting older perls.
void Newx(void* ptr, int nitems, type)
=for hackers
Found in file handy.h
=item Newxc
X<Newxc>
The XSUB-writer's interface to the C C<malloc> function, with
cast. See also C<L</Newx>>.
Memory obtained by this should B<ONLY> be freed with L</"Safefree">.
void Newxc(void* ptr, int nitems, type, cast)
=for hackers
Found in file handy.h
=item Newxz
X<Newxz>
The XSUB-writer's interface to the C C<malloc> function. The allocated
memory is zeroed with C<memzero>. See also C<L</Newx>>.
Memory obtained by this should B<ONLY> be freed with L</"Safefree">.
void Newxz(void* ptr, int nitems, type)
=for hackers
Found in file handy.h
=item Poison
X<Poison>
PoisonWith(0xEF) for catching access to freed memory.
void Poison(void* dest, int nitems, type)
=for hackers
Found in file handy.h
=item PoisonFree
X<PoisonFree>
PoisonWith(0xEF) for catching access to freed memory.
void PoisonFree(void* dest, int nitems, type)
=for hackers
Found in file handy.h
=item PoisonNew
X<PoisonNew>
PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
void PoisonNew(void* dest, int nitems, type)
=for hackers
Found in file handy.h
=item PoisonWith
X<PoisonWith>
Fill up memory with a byte pattern (a byte repeated over and over
again) that hopefully catches attempts to access uninitialized memory.
void PoisonWith(void* dest, int nitems, type,
U8 byte)
=for hackers
Found in file handy.h
=item Renew
X<Renew>
The XSUB-writer's interface to the C C<realloc> function.
Memory obtained by this should B<ONLY> be freed with L</"Safefree">.
void Renew(void* ptr, int nitems, type)
=for hackers
Found in file handy.h
=item Renewc
X<Renewc>
The XSUB-writer's interface to the C C<realloc> function, with
cast.
Memory obtained by this should B<ONLY> be freed with L</"Safefree">.
void Renewc(void* ptr, int nitems, type, cast)
=for hackers
Found in file handy.h
=item Safefree
X<Safefree>
The XSUB-writer's interface to the C C<free> function.
This should B<ONLY> be used on memory obtained using L</"Newx"> and friends.
void Safefree(void* ptr)
=for hackers
Found in file handy.h
=item savepv
X<savepv>
Perl's version of C<strdup()>. Returns a pointer to a newly allocated
string which is a duplicate of C<pv>. The size of the string is
determined by C<strlen()>, which means it may not contain embedded C<NUL>
characters and must have a trailing C<NUL>. The memory allocated for the new
string can be freed with the C<Safefree()> function.
On some platforms, Windows for example, all allocated memory owned by a thread
is deallocated when that thread ends. So if you need that not to happen, you
need to use the shared memory functions, such as C<L</savesharedpv>>.
char* savepv(const char* pv)
=for hackers
Found in file util.c
=item savepvn
X<savepvn>
Perl's version of what C<strndup()> would be if it existed. Returns a
pointer to a newly allocated string which is a duplicate of the first
C<len> bytes from C<pv>, plus a trailing
C<NUL> byte. The memory allocated for
the new string can be freed with the C<Safefree()> function.
On some platforms, Windows for example, all allocated memory owned by a thread
is deallocated when that thread ends. So if you need that not to happen, you
need to use the shared memory functions, such as C<L</savesharedpvn>>.
char* savepvn(const char* pv, I32 len)
=for hackers
Found in file util.c
=item savepvs
X<savepvs>
Like C<savepvn>, but takes a C<NUL>-terminated literal string instead of a
string/length pair.
char* savepvs(const char* s)
=for hackers
Found in file handy.h
=item savesharedpv
X<savesharedpv>
A version of C<savepv()> which allocates the duplicate string in memory
which is shared between threads.
char* savesharedpv(const char* pv)
=for hackers
Found in file util.c
=item savesharedpvn
X<savesharedpvn>
A version of C<savepvn()> which allocates the duplicate string in memory
which is shared between threads. (With the specific difference that a C<NULL>
pointer is not acceptable)
char* savesharedpvn(const char *const pv,
const STRLEN len)
=for hackers
Found in file util.c
=item savesharedpvs
X<savesharedpvs>
A version of C<savepvs()> which allocates the duplicate string in memory
which is shared between threads.
char* savesharedpvs(const char* s)
=for hackers
Found in file handy.h
=item savesharedsvpv
X<savesharedsvpv>
A version of C<savesharedpv()> which allocates the duplicate string in
memory which is shared between threads.
char* savesharedsvpv(SV *sv)
=for hackers
Found in file util.c
=item savesvpv
X<savesvpv>
A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
the passed in SV using C<SvPV()>
On some platforms, Windows for example, all allocated memory owned by a thread
is deallocated when that thread ends. So if you need that not to happen, you
need to use the shared memory functions, such as C<L</savesharedsvpv>>.
char* savesvpv(SV* sv)
=for hackers
Found in file util.c
=item StructCopy
X<StructCopy>
This is an architecture-independent macro to copy one structure to another.
void StructCopy(type *src, type *dest, type)
=for hackers
Found in file handy.h
=item Zero
X<Zero>
The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
destination, C<nitems> is the number of items, and C<type> is the type.
void Zero(void* dest, int nitems, type)
=for hackers
Found in file handy.h
=item ZeroD
X<ZeroD>
Like C<Zero> but returns dest. Useful
for encouraging compilers to tail-call
optimise.
void * ZeroD(void* dest, int nitems, type)
=for hackers
Found in file handy.h
=back
=head1 Miscellaneous Functions
=over 8
=item dump_c_backtrace
X<dump_c_backtrace>
Dumps the C backtrace to the given C<fp>.
Returns true if a backtrace could be retrieved, false if not.
bool dump_c_backtrace(PerlIO* fp, int max_depth,
int skip)
=for hackers
Found in file util.c
=item fbm_compile
X<fbm_compile>
Analyses the string in order to make fast searches on it using C<fbm_instr()>
-- the Boyer-Moore algorithm.
void fbm_compile(SV* sv, U32 flags)
=for hackers
Found in file util.c
=item fbm_instr
X<fbm_instr>
Returns the location of the SV in the string delimited by C<big> and
C<bigend> (C<bigend>) is the char following the last char).
It returns C<NULL> if the string can't be found. The C<sv>
does not have to be C<fbm_compiled>, but the search will not be as fast
then.
char* fbm_instr(unsigned char* big,
unsigned char* bigend, SV* littlestr,
U32 flags)
=for hackers
Found in file util.c
=item foldEQ
X<foldEQ>
Returns true if the leading C<len> bytes of the strings C<s1> and C<s2> are the
same
case-insensitively; false otherwise. Uppercase and lowercase ASCII range bytes
match themselves and their opposite case counterparts. Non-cased and non-ASCII
range bytes match only themselves.
I32 foldEQ(const char* a, const char* b, I32 len)
=for hackers
Found in file inline.h
=item foldEQ_locale
X<foldEQ_locale>
Returns true if the leading C<len> bytes of the strings C<s1> and C<s2> are the
same case-insensitively in the current locale; false otherwise.
I32 foldEQ_locale(const char* a, const char* b,
I32 len)
=for hackers
Found in file inline.h
=item form
X<form>
Takes a sprintf-style format pattern and conventional
(non-SV) arguments and returns the formatted string.
(char *) Perl_form(pTHX_ const char* pat, ...)
can be used any place a string (char *) is required:
char * s = Perl_form("%d.%d",major,minor);
Uses a single private buffer so if you want to format several strings you
must explicitly copy the earlier strings away (and free the copies when you
are done).
char* form(const char* pat, ...)
=for hackers
Found in file util.c
=item getcwd_sv
X<getcwd_sv>
Fill C<sv> with current working directory
int getcwd_sv(SV* sv)
=for hackers
Found in file util.c
=item get_c_backtrace_dump
X<get_c_backtrace_dump>
Returns a SV containing a dump of C<depth> frames of the call stack, skipping
the C<skip> innermost ones. C<depth> of 20 is usually enough.
The appended output looks like:
...
1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
...
The fields are tab-separated. The first column is the depth (zero
being the innermost non-skipped frame). In the hex:offset, the hex is
where the program counter was in C<S_parse_body>, and the :offset (might
be missing) tells how much inside the C<S_parse_body> the program counter was.
The C<util.c:1716> is the source code file and line number.
The F</usr/bin/perl> is obvious (hopefully).
Unknowns are C<"-">. Unknowns can happen unfortunately quite easily:
if the platform doesn't support retrieving the information;
if the binary is missing the debug information;
if the optimizer has transformed the code by for example inlining.
SV* get_c_backtrace_dump(int max_depth, int skip)
=for hackers
Found in file util.c
=item ibcmp
X<ibcmp>
This is a synonym for S<C<(! foldEQ())>>
I32 ibcmp(const char* a, const char* b, I32 len)
=for hackers
Found in file util.h
=item ibcmp_locale
X<ibcmp_locale>
This is a synonym for S<C<(! foldEQ_locale())>>
I32 ibcmp_locale(const char* a, const char* b,
I32 len)
=for hackers
Found in file util.h
=item is_safe_syscall
X<is_safe_syscall>
Test that the given C<pv> doesn't contain any internal C<NUL> characters.
If it does, set C<errno> to C<ENOENT>, optionally warn, and return FALSE.
Return TRUE if the name is safe.
Used by the C<IS_SAFE_SYSCALL()> macro.
bool is_safe_syscall(const char *pv, STRLEN len,
const char *what,
const char *op_name)
=for hackers
Found in file inline.h
=item memEQ
X<memEQ>
Test two buffers (which may contain embedded C<NUL> characters, to see if they
are equal. The C<len> parameter indicates the number of bytes to compare.
Returns zero if equal, or non-zero if non-equal.
bool memEQ(char* s1, char* s2, STRLEN len)
=for hackers
Found in file handy.h
=item memNE
X<memNE>
Test two buffers (which may contain embedded C<NUL> characters, to see if they
are not equal. The C<len> parameter indicates the number of bytes to compare.
Returns zero if non-equal, or non-zero if equal.
bool memNE(char* s1, char* s2, STRLEN len)
=for hackers
Found in file handy.h
=item mess
X<mess>
Take a sprintf-style format pattern and argument list. These are used to
generate a string message. If the message does not end with a newline,
then it will be extended with some indication of the current location
in the code, as described for L</mess_sv>.
Normally, the resulting message is returned in a new mortal SV.
During global destruction a single SV may be shared between uses of
this function.
SV * mess(const char *pat, ...)
=for hackers
Found in file util.c
=item mess_sv
X<mess_sv>
Expands a message, intended for the user, to include an indication of
the current location in the code, if the message does not already appear
to be complete.
C<basemsg> is the initial message or object. If it is a reference, it
will be used as-is and will be the result of this function. Otherwise it
is used as a string, and if it already ends with a newline, it is taken
to be complete, and the result of this function will be the same string.
If the message does not end with a newline, then a segment such as C<at
foo.pl line 37> will be appended, and possibly other clauses indicating
the current state of execution. The resulting message will end with a
dot and a newline.
Normally, the resulting message is returned in a new mortal SV.
During global destruction a single SV may be shared between uses of this
function. If C<consume> is true, then the function is permitted (but not
required) to modify and return C<basemsg> instead of allocating a new SV.
SV * mess_sv(SV *basemsg, bool consume)
=for hackers
Found in file util.c
=item my_snprintf
X<my_snprintf>
The C library C<snprintf> functionality, if available and
standards-compliant (uses C<vsnprintf>, actually). However, if the
C<vsnprintf> is not available, will unfortunately use the unsafe
C<vsprintf> which can overrun the buffer (there is an overrun check,
but that may be too late). Consider using C<sv_vcatpvf> instead, or
getting C<vsnprintf>.
int my_snprintf(char *buffer, const Size_t len,
const char *format, ...)
=for hackers
Found in file util.c
=item my_sprintf
X<my_sprintf>
The C library C<sprintf>, wrapped if necessary, to ensure that it will return
the length of the string written to the buffer. Only rare pre-ANSI systems
need the wrapper function - usually this is a direct call to C<sprintf>.
int my_sprintf(char *buffer, const char *pat, ...)
=for hackers
Found in file util.c
=item my_strlcat
X<my_strlcat>
The C library C<strlcat> if available, or a Perl implementation of it.
This operates on C C<NUL>-terminated strings.
C<my_strlcat()> appends string C<src> to the end of C<dst>. It will append at
most S<C<size - strlen(dst) - 1>> characters. It will then C<NUL>-terminate,
unless C<size> is 0 or the original C<dst> string was longer than C<size> (in
practice this should not happen as it means that either C<size> is incorrect or
that C<dst> is not a proper C<NUL>-terminated string).
Note that C<size> is the full size of the destination buffer and
the result is guaranteed to be C<NUL>-terminated if there is room. Note that
room for the C<NUL> should be included in C<size>.
The return value is the total length that C<dst> would have if C<size> is
sufficiently large. Thus it is the initial length of C<dst> plus the length of
C<src>. If C<size> is smaller than the return, the excess was not appended.
Size_t my_strlcat(char *dst, const char *src,
Size_t size)
=for hackers
Found in file util.c
=item my_strlcpy
X<my_strlcpy>
The C library C<strlcpy> if available, or a Perl implementation of it.
This operates on C C<NUL>-terminated strings.
C<my_strlcpy()> copies up to S<C<size - 1>> characters from the string C<src>
to C<dst>, C<NUL>-terminating the result if C<size> is not 0.
The return value is the total length C<src> would be if the copy completely
succeeded. If it is larger than C<size>, the excess was not copied.
Size_t my_strlcpy(char *dst, const char *src,
Size_t size)
=for hackers
Found in file util.c
=item my_vsnprintf
X<my_vsnprintf>
The C library C<vsnprintf> if available and standards-compliant.
However, if if the C<vsnprintf> is not available, will unfortunately
use the unsafe C<vsprintf> which can overrun the buffer (there is an
overrun check, but that may be too late). Consider using
C<sv_vcatpvf> instead, or getting C<vsnprintf>.
int my_vsnprintf(char *buffer, const Size_t len,
const char *format, va_list ap)
=for hackers
Found in file util.c
=item ninstr
X<ninstr>
Find the first (leftmost) occurrence of a sequence of bytes within another
sequence. This is the Perl version of C<strstr()>, extended to handle
arbitrary sequences, potentially containing embedded C<NUL> characters (C<NUL>
is what the initial C<n> in the function name stands for; some systems have an
equivalent, C<memmem()>, but with a somewhat different API).
Another way of thinking about this function is finding a needle in a haystack.
C<big> points to the first byte in the haystack. C<big_end> points to one byte
beyond the final byte in the haystack. C<little> points to the first byte in
the needle. C<little_end> points to one byte beyond the final byte in the
needle. All the parameters must be non-C<NULL>.
The function returns C<NULL> if there is no occurrence of C<little> within
C<big>. If C<little> is the empty string, C<big> is returned.
Because this function operates at the byte level, and because of the inherent
characteristics of UTF-8 (or UTF-EBCDIC), it will work properly if both the
needle and the haystack are strings with the same UTF-8ness, but not if the
UTF-8ness differs.
char * ninstr(char * big, char * bigend, char * little,
char * little_end)
=for hackers
Found in file util.c
=item PERL_SYS_INIT
X<PERL_SYS_INIT>
Provides system-specific tune up of the C runtime environment necessary to
run Perl interpreters. This should be called only once, before creating
any Perl interpreters.
void PERL_SYS_INIT(int *argc, char*** argv)
=for hackers
Found in file perl.h
=item PERL_SYS_INIT3
X<PERL_SYS_INIT3>
Provides system-specific tune up of the C runtime environment necessary to
run Perl interpreters. This should be called only once, before creating
any Perl interpreters.
void PERL_SYS_INIT3(int *argc, char*** argv,
char*** env)
=for hackers
Found in file perl.h
=item PERL_SYS_TERM
X<PERL_SYS_TERM>
Provides system-specific clean up of the C runtime environment after
running Perl interpreters. This should be called only once, after
freeing any remaining Perl interpreters.
void PERL_SYS_TERM()
=for hackers
Found in file perl.h
=item quadmath_format_needed
X<quadmath_format_needed>
C<quadmath_format_needed()> returns true if the C<format> string seems to
contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
or returns false otherwise.
The format specifier detection is not complete printf-syntax detection,
but it should catch most common cases.
If true is returned, those arguments B<should> in theory be processed
with C<quadmath_snprintf()>, but in case there is more than one such
format specifier (see L</quadmath_format_single>), and if there is
anything else beyond that one (even just a single byte), they
B<cannot> be processed because C<quadmath_snprintf()> is very strict,
accepting only one format spec, and nothing else.
In this case, the code should probably fail.
bool quadmath_format_needed(const char* format)
=for hackers
Found in file util.c
=item quadmath_format_single
X<quadmath_format_single>
C<quadmath_snprintf()> is very strict about its C<format> string and will
fail, returning -1, if the format is invalid. It accepts exactly
one format spec.
C<quadmath_format_single()> checks that the intended single spec looks
sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
and has C<Q> before it. This is not a full "printf syntax check",
just the basics.
Returns the format if it is valid, NULL if not.
C<quadmath_format_single()> can and will actually patch in the missing
C<Q>, if necessary. In this case it will return the modified copy of
the format, B<which the caller will need to free.>
See also L</quadmath_format_needed>.
const char* quadmath_format_single(const char* format)
=for hackers
Found in file util.c
=item READ_XDIGIT
X<READ_XDIGIT>
Returns the value of an ASCII-range hex digit and advances the string pointer.
Behaviour is only well defined when isXDIGIT(*str) is true.
U8 READ_XDIGIT(char str*)
=for hackers
Found in file handy.h
=item rninstr
X<rninstr>
Like C<L</ninstr>>, but instead finds the final (rightmost) occurrence of a
sequence of bytes within another sequence, returning C<NULL> if there is no
such occurrence.
char * rninstr(char * big, char * bigend,
char * little, char * little_end)
=for hackers
Found in file util.c
=item strEQ
X<strEQ>
Test two C<NUL>-terminated strings to see if they are equal. Returns true or
false.
bool strEQ(char* s1, char* s2)
=for hackers
Found in file handy.h
=item strGE
X<strGE>
Test two C<NUL>-terminated strings to see if the first, C<s1>, is greater than
or equal to the second, C<s2>. Returns true or false.
bool strGE(char* s1, char* s2)
=for hackers
Found in file handy.h
=item strGT
X<strGT>
Test two C<NUL>-terminated strings to see if the first, C<s1>, is greater than
the second, C<s2>. Returns true or false.
bool strGT(char* s1, char* s2)
=for hackers
Found in file handy.h
=item strLE
X<strLE>
Test two C<NUL>-terminated strings to see if the first, C<s1>, is less than or
equal to the second, C<s2>. Returns true or false.
bool strLE(char* s1, char* s2)
=for hackers
Found in file handy.h
=item strLT
X<strLT>
Test two C<NUL>-terminated strings to see if the first, C<s1>, is less than the
second, C<s2>. Returns true or false.
bool strLT(char* s1, char* s2)
=for hackers
Found in file handy.h
=item strNE
X<strNE>
Test two C<NUL>-terminated strings to see if they are different. Returns true
or false.
bool strNE(char* s1, char* s2)
=for hackers
Found in file handy.h
=item strnEQ
X<strnEQ>
Test two C<NUL>-terminated strings to see if they are equal. The C<len>
parameter indicates the number of bytes to compare. Returns true or false. (A
wrapper for C<strncmp>).
bool strnEQ(char* s1, char* s2, STRLEN len)
=for hackers
Found in file handy.h
=item strnNE
X<strnNE>
Test two C<NUL>-terminated strings to see if they are different. The C<len>
parameter indicates the number of bytes to compare. Returns true or false. (A
wrapper for C<strncmp>).
bool strnNE(char* s1, char* s2, STRLEN len)
=for hackers
Found in file handy.h
=item sv_destroyable
X<sv_destroyable>
Dummy routine which reports that object can be destroyed when there is no
sharing module present. It ignores its single SV argument, and returns
'true'. Exists to avoid test for a C<NULL> function pointer and because it
could potentially warn under some level of strict-ness.
bool sv_destroyable(SV *sv)
=for hackers
Found in file util.c
=item sv_nosharing
X<sv_nosharing>
Dummy routine which "shares" an SV when there is no sharing module present.
Or "locks" it. Or "unlocks" it. In other
words, ignores its single SV argument.
Exists to avoid test for a C<NULL> function pointer and because it could
potentially warn under some level of strict-ness.
void sv_nosharing(SV *sv)
=for hackers
Found in file util.c
=item vmess
X<vmess>
C<pat> and C<args> are a sprintf-style format pattern and encapsulated
argument list, respectively. These are used to generate a string message. If
the
message does not end with a newline, then it will be extended with
some indication of the current location in the code, as described for
L</mess_sv>.
Normally, the resulting message is returned in a new mortal SV.
During global destruction a single SV may be shared between uses of
this function.
SV * vmess(const char *pat, va_list *args)
=for hackers
Found in file util.c
=back
=head1 MRO Functions
These functions are related to the method resolution order of perl classes
=over 8
=item mro_get_linear_isa
X<mro_get_linear_isa>
Returns the mro linearisation for the given stash. By default, this
will be whatever C<mro_get_linear_isa_dfs> returns unless some
other MRO is in effect for the stash. The return value is a
read-only AV*.
You are responsible for C<SvREFCNT_inc()> 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).
AV* mro_get_linear_isa(HV* stash)
=for hackers
Found in file mro_core.c
=item mro_method_changed_in
X<mro_method_changed_in>
Invalidates method caching on any child classes
of the given stash, so that they might notice
the changes in this one.
Ideally, all instances of C<PL_sub_generation++> in
perl source outside of F<mro.c> should be
replaced by calls to this.
Perl automatically handles most of the common
ways a method might be redefined. However, there
are a few ways you could change a method in a stash
without the cache code noticing, in which case you
need to call this method afterwards:
1) Directly manipulating the stash HV entries from
XS code.
2) Assigning a reference to a readonly scalar
constant into a stash entry in order to create
a constant subroutine (like F<constant.pm>
does).
This same method is available from pure perl
via, C<mro::method_changed_in(classname)>.
void mro_method_changed_in(HV* stash)
=for hackers
Found in file mro_core.c
=item mro_register
X<mro_register>
Registers a custom mro plugin. See L<perlmroapi> for details.
void mro_register(const struct mro_alg *mro)
=for hackers
Found in file mro_core.c
=back
=head1 Multicall Functions
=over 8
=item dMULTICALL
X<dMULTICALL>
Declare local variables for a multicall. See L<perlcall/LIGHTWEIGHT CALLBACKS>.
dMULTICALL;
=for hackers
Found in file cop.h
=item MULTICALL
X<MULTICALL>
Make a lightweight callback. See L<perlcall/LIGHTWEIGHT CALLBACKS>.
MULTICALL;
=for hackers
Found in file cop.h
=item POP_MULTICALL
X<POP_MULTICALL>
Closing bracket for a lightweight callback.
See L<perlcall/LIGHTWEIGHT CALLBACKS>.
POP_MULTICALL;
=for hackers
Found in file cop.h
=item PUSH_MULTICALL
X<PUSH_MULTICALL>
Opening bracket for a lightweight callback.
See L<perlcall/LIGHTWEIGHT CALLBACKS>.
PUSH_MULTICALL;
=for hackers
Found in file cop.h
=back
=head1 Numeric functions
=over 8
=item grok_bin
X<grok_bin>
converts a string representing a binary number to numeric form.
On entry C<start> and C<*len> give the string to scan, C<*flags> gives
conversion flags, and C<result> should be C<NULL> or a pointer to an NV.
The scan stops at the end of the string, or the first invalid character.
Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in C<*flags>, encountering an
invalid character will also trigger a warning.
On return C<*len> is set to the length of the scanned string,
and C<*flags> gives output flags.
If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
and nothing is written to C<*result>. If the value is > C<UV_MAX>, C<grok_bin>
returns C<UV_MAX>, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
and writes the value to C<*result> (or the value is discarded if C<result>
is NULL).
The binary number may optionally be prefixed with C<"0b"> or C<"b"> unless
C<PERL_SCAN_DISALLOW_PREFIX> is set in C<*flags> on entry. If
C<PERL_SCAN_ALLOW_UNDERSCORES> is set in C<*flags> then the binary
number may use C<"_"> characters to separate digits.
UV grok_bin(const char* start, STRLEN* len_p,
I32* flags, NV *result)
=for hackers
Found in file numeric.c
=item grok_hex
X<grok_hex>
converts a string representing a hex number to numeric form.
On entry C<start> and C<*len_p> give the string to scan, C<*flags> gives
conversion flags, and C<result> should be C<NULL> or a pointer to an NV.
The scan stops at the end of the string, or the first invalid character.
Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in C<*flags>, encountering an
invalid character will also trigger a warning.
On return C<*len> is set to the length of the scanned string,
and C<*flags> gives output flags.
If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
and nothing is written to C<*result>. If the value is > C<UV_MAX>, C<grok_hex>
returns C<UV_MAX>, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
and writes the value to C<*result> (or the value is discarded if C<result>
is C<NULL>).
The hex number may optionally be prefixed with C<"0x"> or C<"x"> unless
C<PERL_SCAN_DISALLOW_PREFIX> is set in C<*flags> on entry. If
C<PERL_SCAN_ALLOW_UNDERSCORES> is set in C<*flags> then the hex
number may use C<"_"> characters to separate digits.
UV grok_hex(const char* start, STRLEN* len_p,
I32* flags, NV *result)
=for hackers
Found in file numeric.c
=item grok_infnan
X<grok_infnan>
Helper for C<grok_number()>, accepts various ways of spelling "infinity"
or "not a number", and returns one of the following flag combinations:
IS_NUMBER_INFINITE
IS_NUMBER_NAN
IS_NUMBER_INFINITE | IS_NUMBER_NEG
IS_NUMBER_NAN | IS_NUMBER_NEG
0
possibly |-ed with C<IS_NUMBER_TRAILING>.
If an infinity or a not-a-number is recognized, C<*sp> will point to
one byte past the end of the recognized string. If the recognition fails,
zero is returned, and C<*sp> will not move.
int grok_infnan(const char** sp, const char *send)
=for hackers
Found in file numeric.c
=item grok_number
X<grok_number>
Identical to C<grok_number_flags()> with C<flags> set to zero.
int grok_number(const char *pv, STRLEN len,
UV *valuep)
=for hackers
Found in file numeric.c
=item grok_number_flags
X<grok_number_flags>
Recognise (or not) a number. The type of the number is returned
(0 if unrecognised), otherwise it is a bit-ORed combination of
C<IS_NUMBER_IN_UV>, C<IS_NUMBER_GREATER_THAN_UV_MAX>, C<IS_NUMBER_NOT_INT>,
C<IS_NUMBER_NEG>, C<IS_NUMBER_INFINITY>, C<IS_NUMBER_NAN> (defined in perl.h).
If the value of the number can fit in a UV, it is returned in C<*valuep>.
C<IS_NUMBER_IN_UV> will be set to indicate that C<*valuep> is valid, C<IS_NUMBER_IN_UV>
will never be set unless C<*valuep> is valid, but C<*valuep> may have been assigned
to during processing even though C<IS_NUMBER_IN_UV> is not set on return.
If C<valuep> is C<NULL>, C<IS_NUMBER_IN_UV> will be set for the same cases as when
C<valuep> is non-C<NULL>, but no actual assignment (or SEGV) will occur.
C<IS_NUMBER_NOT_INT> will be set with C<IS_NUMBER_IN_UV> if trailing decimals were
seen (in which case C<*valuep> gives the true value truncated to an integer), and
C<IS_NUMBER_NEG> if the number is negative (in which case C<*valuep> holds the
absolute value). C<IS_NUMBER_IN_UV> is not set if e notation was used or the
number is larger than a UV.
C<flags> allows only C<PERL_SCAN_TRAILING>, which allows for trailing
non-numeric text on an otherwise successful I<grok>, setting
C<IS_NUMBER_TRAILING> on the result.
int grok_number_flags(const char *pv, STRLEN len,
UV *valuep, U32 flags)
=for hackers
Found in file numeric.c
=item grok_numeric_radix
X<grok_numeric_radix>
Scan and skip for a numeric decimal separator (radix).
bool grok_numeric_radix(const char **sp,
const char *send)
=for hackers
Found in file numeric.c
=item grok_oct
X<grok_oct>
converts a string representing an octal number to numeric form.
On entry C<start> and C<*len> give the string to scan, C<*flags> gives
conversion flags, and C<result> should be C<NULL> or a pointer to an NV.
The scan stops at the end of the string, or the first invalid character.
Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in C<*flags>, encountering an
8 or 9 will also trigger a warning.
On return C<*len> is set to the length of the scanned string,
and C<*flags> gives output flags.
If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
and nothing is written to C<*result>. If the value is > C<UV_MAX>, C<grok_oct>
returns C<UV_MAX>, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
and writes the value to C<*result> (or the value is discarded if C<result>
is C<NULL>).
If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in C<*flags> then the octal
number may use C<"_"> characters to separate digits.
UV grok_oct(const char* start, STRLEN* len_p,
I32* flags, NV *result)
=for hackers
Found in file numeric.c
=item isinfnan
X<isinfnan>
C<Perl_isinfnan()> is utility function that returns true if the NV
argument is either an infinity or a C<NaN>, false otherwise. To test
in more detail, use C<Perl_isinf()> and C<Perl_isnan()>.
This is also the logical inverse of Perl_isfinite().
bool isinfnan(NV nv)
=for hackers
Found in file numeric.c
=item Perl_signbit
X<Perl_signbit>
NOTE: this function is experimental and may change or be
removed without notice.
Return a non-zero integer if the sign bit on an NV is set, and 0 if
it is not.
If F<Configure> detects this system has a C<signbit()> that will work with
our NVs, then we just use it via the C<#define> in F<perl.h>. Otherwise,
fall back on this implementation. The main use of this function
is catching C<-0.0>.
C<Configure> notes: This function is called C<'Perl_signbit'> instead of a
plain C<'signbit'> because it is easy to imagine a system having a C<signbit()>
function or macro that doesn't happen to work with our particular choice
of NVs. We shouldn't just re-C<#define> C<signbit> as C<Perl_signbit> and expect
the standard system headers to be happy. Also, this is a no-context
function (no C<pTHX_>) because C<Perl_signbit()> is usually re-C<#defined> in
F<perl.h> as a simple macro call to the system's C<signbit()>.
Users should just always call C<Perl_signbit()>.
int Perl_signbit(NV f)
=for hackers
Found in file numeric.c
=item scan_bin
X<scan_bin>
For backwards compatibility. Use C<grok_bin> instead.
NV scan_bin(const char* start, STRLEN len,
STRLEN* retlen)
=for hackers
Found in file numeric.c
=item scan_hex
X<scan_hex>
For backwards compatibility. Use C<grok_hex> instead.
NV scan_hex(const char* start, STRLEN len,
STRLEN* retlen)
=for hackers
Found in file numeric.c
=item scan_oct
X<scan_oct>
For backwards compatibility. Use C<grok_oct> instead.
NV scan_oct(const char* start, STRLEN len,
STRLEN* retlen)
=for hackers
Found in file numeric.c
=back
=head1 Obsolete backwards compatibility functions
Some of these are also deprecated. You can exclude these from
your compiled Perl by adding this option to Configure:
C<-Accflags='-DNO_MATHOMS'>
=over 8
=item custom_op_desc
X<custom_op_desc>
Return the description of a given custom op. This was once used by the
C<OP_DESC> macro, but is no longer: it has only been kept for
compatibility, and should not be used.
const char * custom_op_desc(const OP *o)
=for hackers
Found in file mathoms.c
=item custom_op_name
X<custom_op_name>
Return the name for a given custom op. This was once used by the C<OP_NAME>
macro, but is no longer: it has only been kept for compatibility, and
should not be used.
const char * custom_op_name(const OP *o)
=for hackers
Found in file mathoms.c
=item gv_fetchmethod
X<gv_fetchmethod>
See L</gv_fetchmethod_autoload>.
GV* gv_fetchmethod(HV* stash, const char* name)
=for hackers
Found in file mathoms.c
=item is_utf8_char
X<is_utf8_char>
DEPRECATED! It is planned to remove this function from a
future release of Perl. Do not use it for new code; remove it from
existing code.
Tests if some arbitrary number of bytes begins in a valid UTF-8
character. Note that an INVARIANT (i.e. ASCII on non-EBCDIC machines)
character is a valid UTF-8 character. The actual number of bytes in the UTF-8
character will be returned if it is valid, otherwise 0.
This function is deprecated due to the possibility that malformed input could
cause reading beyond the end of the input buffer. Use L</isUTF8_CHAR>
instead.
STRLEN is_utf8_char(const U8 *s)
=for hackers
Found in file mathoms.c
=item is_utf8_char_buf
X<is_utf8_char_buf>
This is identical to the macro L</isUTF8_CHAR>.
STRLEN is_utf8_char_buf(const U8 *buf,
const U8 *buf_end)
=for hackers
Found in file mathoms.c
=item pack_cat
X<pack_cat>
The engine implementing C<pack()> Perl function. Note: parameters
C<next_in_list> and C<flags> are not used. This call should not be used; use
C<packlist> instead.
void pack_cat(SV *cat, const char *pat,
const char *patend, SV **beglist,
SV **endlist, SV ***next_in_list,
U32 flags)
=for hackers
Found in file mathoms.c
=item pad_compname_type
X<pad_compname_type>
Looks up the type of the lexical variable at position C<po> in the
currently-compiling pad. If the variable is typed, the stash of the
class to which it is typed is returned. If not, C<NULL> is returned.
HV * pad_compname_type(PADOFFSET po)
=for hackers
Found in file mathoms.c
=item sv_2pvbyte_nolen
X<sv_2pvbyte_nolen>
Return a pointer to the byte-encoded representation of the SV.
May cause the SV to be downgraded from UTF-8 as a side-effect.
Usually accessed via the C<SvPVbyte_nolen> macro.
char* sv_2pvbyte_nolen(SV* sv)
=for hackers
Found in file mathoms.c
=item sv_2pvutf8_nolen
X<sv_2pvutf8_nolen>
Return a pointer to the UTF-8-encoded representation of the SV.
May cause the SV to be upgraded to UTF-8 as a side-effect.
Usually accessed via the C<SvPVutf8_nolen> macro.
char* sv_2pvutf8_nolen(SV* sv)
=for hackers
Found in file mathoms.c
=item sv_2pv_nolen
X<sv_2pv_nolen>
Like C<sv_2pv()>, but doesn't return the length too. You should usually
use the macro wrapper C<SvPV_nolen(sv)> instead.
char* sv_2pv_nolen(SV* sv)
=for hackers
Found in file mathoms.c
=item sv_catpvn_mg
X<sv_catpvn_mg>
Like C<sv_catpvn>, but also handles 'set' magic.
void sv_catpvn_mg(SV *sv, const char *ptr,
STRLEN len)
=for hackers
Found in file mathoms.c
=item sv_catsv_mg
X<sv_catsv_mg>
Like C<sv_catsv>, but also handles 'set' magic.
void sv_catsv_mg(SV *dsv, SV *ssv)
=for hackers
Found in file mathoms.c
=item sv_force_normal
X<sv_force_normal>
Undo various types of fakery on an SV: if the PV is a shared string, make
a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
an C<xpvmg>. See also C<L</sv_force_normal_flags>>.
void sv_force_normal(SV *sv)
=for hackers
Found in file mathoms.c
=item sv_iv
X<sv_iv>
A private implementation of the C<SvIVx> macro for compilers which can't
cope with complex macro expressions. Always use the macro instead.
IV sv_iv(SV* sv)
=for hackers
Found in file mathoms.c
=item sv_nolocking
X<sv_nolocking>
Dummy routine which "locks" an SV when there is no locking module present.
Exists to avoid test for a C<NULL> function pointer and because it could
potentially warn under some level of strict-ness.
"Superseded" by C<sv_nosharing()>.
void sv_nolocking(SV *sv)
=for hackers
Found in file mathoms.c
=item sv_nounlocking
X<sv_nounlocking>
Dummy routine which "unlocks" an SV when there is no locking module present.
Exists to avoid test for a C<NULL> function pointer and because it could
potentially warn under some level of strict-ness.
"Superseded" by C<sv_nosharing()>.
void sv_nounlocking(SV *sv)
=for hackers
Found in file mathoms.c
=item sv_nv
X<sv_nv>
A private implementation of the C<SvNVx> macro for compilers which can't
cope with complex macro expressions. Always use the macro instead.
NV sv_nv(SV* sv)
=for hackers
Found in file mathoms.c
=item sv_pv
X<sv_pv>
Use the C<SvPV_nolen> macro instead
char* sv_pv(SV *sv)
=for hackers
Found in file mathoms.c
=item sv_pvbyte
X<sv_pvbyte>
Use C<SvPVbyte_nolen> instead.
char* sv_pvbyte(SV *sv)
=for hackers
Found in file mathoms.c
=item sv_pvbyten
X<sv_pvbyten>
A private implementation of the C<SvPVbyte> macro for compilers
which can't cope with complex macro expressions. Always use the macro
instead.
char* sv_pvbyten(SV *sv, STRLEN *lp)
=for hackers
Found in file mathoms.c
=item sv_pvn
X<sv_pvn>
A private implementation of the C<SvPV> macro for compilers which can't
cope with complex macro expressions. Always use the macro instead.
char* sv_pvn(SV *sv, STRLEN *lp)
=for hackers
Found in file mathoms.c
=item sv_pvutf8
X<sv_pvutf8>
Use the C<SvPVutf8_nolen> macro instead
char* sv_pvutf8(SV *sv)
=for hackers
Found in file mathoms.c
=item sv_pvutf8n
X<sv_pvutf8n>
A private implementation of the C<SvPVutf8> macro for compilers
which can't cope with complex macro expressions. Always use the macro
instead.
char* sv_pvutf8n(SV *sv, STRLEN *lp)
=for hackers
Found in file mathoms.c
=item sv_taint
X<sv_taint>
Taint an SV. Use C<SvTAINTED_on> instead.
void sv_taint(SV* sv)
=for hackers
Found in file mathoms.c
=item sv_unref
X<sv_unref>
Unsets the RV status of the SV, and decrements the reference count of
whatever was being referenced by the RV. This can almost be thought of
as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
being zero. See C<L</SvROK_off>>.
void sv_unref(SV* sv)
=for hackers
Found in file mathoms.c
=item sv_usepvn
X<sv_usepvn>
Tells an SV to use C<ptr> to find its string value. Implemented by
calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
magic. See C<L</sv_usepvn_flags>>.
void sv_usepvn(SV* sv, char* ptr, STRLEN len)
=for hackers
Found in file mathoms.c
=item sv_usepvn_mg
X<sv_usepvn_mg>
Like C<sv_usepvn>, but also handles 'set' magic.
void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
=for hackers
Found in file mathoms.c
=item sv_uv
X<sv_uv>
A private implementation of the C<SvUVx> macro for compilers which can't
cope with complex macro expressions. Always use the macro instead.
UV sv_uv(SV* sv)
=for hackers
Found in file mathoms.c
=item unpack_str
X<unpack_str>
The engine implementing C<unpack()> Perl function. Note: parameters C<strbeg>,
C<new_s> and C<ocnt> are not used. This call should not be used, use
C<unpackstring> instead.
I32 unpack_str(const char *pat, const char *patend,
const char *s, const char *strbeg,
const char *strend, char **new_s,
I32 ocnt, U32 flags)
=for hackers
Found in file mathoms.c
=item utf8_to_uvchr
X<utf8_to_uvchr>
DEPRECATED! It is planned to remove this function from a
future release of Perl. Do not use it for new code; remove it from
existing code.
Returns the native code point of the first character in the string C<s>
which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
length, in bytes, of that character.
Some, but not all, UTF-8 malformations are detected, and in fact, some
malformed input could cause reading beyond the end of the input buffer, which
is why this function is deprecated. Use L</utf8_to_uvchr_buf> instead.
If C<s> points to one of the detected malformations, and UTF8 warnings are
enabled, zero is returned and C<*retlen> is set (if C<retlen> isn't
C<NULL>) to -1. If those warnings are off, the computed value if well-defined (or
the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
is set (if C<retlen> isn't NULL) so that (S<C<s> + C<*retlen>>) is the
next possible position in C<s> that could begin a non-malformed character.
See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is returned.
UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
=for hackers
Found in file mathoms.c
=item utf8_to_uvuni
X<utf8_to_uvuni>
DEPRECATED! It is planned to remove this function from a
future release of Perl. Do not use it for new code; remove it from
existing code.
Returns the Unicode code point of the first character in the string C<s>
which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
length, in bytes, of that character.
Some, but not all, UTF-8 malformations are detected, and in fact, some
malformed input could cause reading beyond the end of the input buffer, which
is one reason why this function is deprecated. The other is that only in
extremely limited circumstances should the Unicode versus native code point be
of any interest to you. See L</utf8_to_uvuni_buf> for alternatives.
If C<s> points to one of the detected malformations, and UTF8 warnings are
enabled, zero is returned and C<*retlen> is set (if C<retlen> doesn't point to
NULL) to -1. If those warnings are off, the computed value if well-defined (or
the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
is set (if C<retlen> isn't NULL) so that (S<C<s> + C<*retlen>>) is the
next possible position in C<s> that could begin a non-malformed character.
See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is returned.
UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
=for hackers
Found in file mathoms.c
=back
=head1 Optree construction
=over 8
=item newASSIGNOP
X<newASSIGNOP>
Constructs, checks, and returns an assignment op. C<left> and C<right>
supply the parameters of the assignment; they are consumed by this
function and become part of the constructed op tree.
If C<optype> is C<OP_ANDASSIGN>, C<OP_ORASSIGN>, or C<OP_DORASSIGN>, then
a suitable conditional optree is constructed. If C<optype> is the opcode
of a binary operator, such as C<OP_BIT_OR>, then an op is constructed that
performs the binary operation and assigns the result to the left argument.
Either way, if C<optype> is non-zero then C<flags> has no effect.
If C<optype> is zero, then a plain scalar or list assignment is
constructed. Which type of assignment it is is automatically determined.
C<flags> gives the eight bits of C<op_flags>, except that C<OPf_KIDS>
will be set automatically, and, shifted up eight bits, the eight bits
of C<op_private>, except that the bit with value 1 or 2 is automatically
set as required.
OP * newASSIGNOP(I32 flags, OP *left, I32 optype,
OP *right)
=for hackers
Found in file op.c
=item newBINOP
X<newBINOP>
Constructs, checks, and returns an op of any binary type. C<type>
is the opcode. C<flags> gives the eight bits of C<op_flags>, except
that C<OPf_KIDS> will be set automatically, and, shifted up eight bits,
the eight bits of C<op_private>, except that the bit with value 1 or
2 is automatically set as required. C<first> and C<last> supply up to
two ops to be the direct children of the binary op; they are consumed
by this function and become part of the constructed op tree.
OP * newBINOP(I32 type, I32 flags, OP *first,
OP *last)
=for hackers
Found in file op.c
=item newCONDOP
X<newCONDOP>
Constructs, checks, and returns a conditional-expression (C<cond_expr>)
op. C<flags> gives the eight bits of C<op_flags>, except that C<OPf_KIDS>
will be set automatically, and, shifted up eight bits, the eight bits of
C<op_private>, except that the bit with value 1 is automatically set.
C<first> supplies the expression selecting between the two branches,
and C<trueop> and C<falseop> supply the branches; they are consumed by
this function and become part of the constructed op tree.
OP * newCONDOP(I32 flags, OP *first, OP *trueop,
OP *falseop)
=for hackers
Found in file op.c
=item newDEFSVOP
X<newDEFSVOP>
Constructs and returns an op to access C<$_>.
OP * newDEFSVOP()
=for hackers
Found in file op.c
=item newFOROP
X<newFOROP>
Constructs, checks, and returns an op tree expressing a C<foreach>
loop (iteration through a list of values). This is a heavyweight loop,
with structure that allows exiting the loop by C<last> and suchlike.
C<sv> optionally supplies the variable that will be aliased to each
item in turn; if null, it defaults to C<$_>.
C<expr> supplies the list of values to iterate over. C<block> supplies
the main body of the loop, and C<cont> optionally supplies a C<continue>
block that operates as a second half of the body. All of these optree
inputs are consumed by this function and become part of the constructed
op tree.
C<flags> gives the eight bits of C<op_flags> for the C<leaveloop>
op and, shifted up eight bits, the eight bits of C<op_private> for
the C<leaveloop> op, except that (in both cases) some bits will be set
automatically.
OP * newFOROP(I32 flags, OP *sv, OP *expr, OP *block,
OP *cont)
=for hackers
Found in file op.c
=item newGIVENOP
X<newGIVENOP>
Constructs, checks, and returns an op tree expressing a C<given> block.
C<cond> supplies the expression that will be locally assigned to a lexical
variable, and C<block> supplies the body of the C<given> construct; they
are consumed by this function and become part of the constructed op tree.
C<defsv_off> must be zero (it used to identity the pad slot of lexical $_).
OP * newGIVENOP(OP *cond, OP *block,
PADOFFSET defsv_off)
=for hackers
Found in file op.c
=item newGVOP
X<newGVOP>
Constructs, checks, and returns an op of any type that involves an
embedded reference to a GV. C<type> is the opcode. C<flags> gives the
eight bits of C<op_flags>. C<gv> identifies the GV that the op should
reference; calling this function does not transfer ownership of any
reference to it.
OP * newGVOP(I32 type, I32 flags, GV *gv)
=for hackers
Found in file op.c
=item newLISTOP
X<newLISTOP>
Constructs, checks, and returns an op of any list type. C<type> is
the opcode. C<flags> gives the eight bits of C<op_flags>, except that
C<OPf_KIDS> will be set automatically if required. C<first> and C<last>
supply up to two ops to be direct children of the list op; they are
consumed by this function and become part of the constructed op tree.
For most list operators, the check function expects all the kid ops to be
present already, so calling C<newLISTOP(OP_JOIN, ...)> (e.g.) is not
appropriate. What you want to do in that case is create an op of type
C<OP_LIST>, append more children to it, and then call L</op_convert_list>.
See L</op_convert_list> for more information.
OP * newLISTOP(I32 type, I32 flags, OP *first,
OP *last)
=for hackers
Found in file op.c
=item newLOGOP
X<newLOGOP>
Constructs, checks, and returns a logical (flow control) op. C<type>
is the opcode. C<flags> gives the eight bits of C<op_flags>, except
that C<OPf_KIDS> will be set automatically, and, shifted up eight bits,
the eight bits of C<op_private>, except that the bit with value 1 is
automatically set. C<first> supplies the expression controlling the
flow, and C<other> supplies the side (alternate) chain of ops; they are
consumed by this function and become part of the constructed op tree.
OP * newLOGOP(I32 type, I32 flags, OP *first,
OP *other)
=for hackers
Found in file op.c
=item newLOOPEX
X<newLOOPEX>
Constructs, checks, and returns a loop-exiting op (such as C<goto>
or C<last>). C<type> is the opcode. C<label> supplies the parameter
determining the target of the op; it is consumed by this function and
becomes part of the constructed op tree.
OP * newLOOPEX(I32 type, OP *label)
=for hackers
Found in file op.c
=item newLOOPOP
X<newLOOPOP>
Constructs, checks, and returns an op tree expressing a loop. This is
only a loop in the control flow through the op tree; it does not have
the heavyweight loop structure that allows exiting the loop by C<last>
and suchlike. C<flags> gives the eight bits of C<op_flags> for the
top-level op, except that some bits will be set automatically as required.
C<expr> supplies the expression controlling loop iteration, and C<block>
supplies the body of the loop; they are consumed by this function and
become part of the constructed op tree. C<debuggable> is currently
unused and should always be 1.
OP * newLOOPOP(I32 flags, I32 debuggable, OP *expr,
OP *block)
=for hackers
Found in file op.c
=item newMETHOP
X<newMETHOP>
Constructs, checks, and returns an op of method type with a method name
evaluated at runtime. C<type> is the opcode. C<flags> gives the eight
bits of C<op_flags>, except that C<OPf_KIDS> will be set automatically,
and, shifted up eight bits, the eight bits of C<op_private>, except that
the bit with value 1 is automatically set. C<dynamic_meth> supplies an
op which evaluates method name; it is consumed by this function and
become part of the constructed op tree.
Supported optypes: C<OP_METHOD>.
OP * newMETHOP(I32 type, I32 flags, OP *first)
=for hackers
Found in file op.c
=item newMETHOP_named
X<newMETHOP_named>
Constructs, checks, and returns an op of method type with a constant
method name. C<type> is the opcode. C<flags> gives the eight bits of
C<op_flags>, and, shifted up eight bits, the eight bits of
C<op_private>. C<const_meth> supplies a constant method name;
it must be a shared COW string.
Supported optypes: C<OP_METHOD_NAMED>.
OP * newMETHOP_named(I32 type, I32 flags,
SV *const_meth)
=for hackers
Found in file op.c
=item newNULLLIST
X<newNULLLIST>
Constructs, checks, and returns a new C<stub> op, which represents an
empty list expression.
OP * newNULLLIST()
=for hackers
Found in file op.c
=item newOP
X<newOP>
Constructs, checks, and returns an op of any base type (any type that
has no extra fields). C<type> is the opcode. C<flags> gives the
eight bits of C<op_flags>, and, shifted up eight bits, the eight bits
of C<op_private>.
OP * newOP(I32 type, I32 flags)
=for hackers
Found in file op.c
=item newPADOP
X<newPADOP>
Constructs, checks, and returns an op of any type that involves a
reference to a pad element. C<type> is the opcode. C<flags> gives the
eight bits of C<op_flags>. A pad slot is automatically allocated, and
is populated with C<sv>; this function takes ownership of one reference
to it.
This function only exists if Perl has been compiled to use ithreads.
OP * newPADOP(I32 type, I32 flags, SV *sv)
=for hackers
Found in file op.c
=item newPMOP
X<newPMOP>
Constructs, checks, and returns an op of any pattern matching type.
C<type> is the opcode. C<flags> gives the eight bits of C<op_flags>
and, shifted up eight bits, the eight bits of C<op_private>.
OP * newPMOP(I32 type, I32 flags)
=for hackers
Found in file op.c
=item newPVOP
X<newPVOP>
Constructs, checks, and returns an op of any type that involves an
embedded C-level pointer (PV). C<type> is the opcode. C<flags> gives
the eight bits of C<op_flags>. C<pv> supplies the C-level pointer, which
must have been allocated using C<PerlMemShared_malloc>; the memory will
be freed when the op is destroyed.
OP * newPVOP(I32 type, I32 flags, char *pv)
=for hackers
Found in file op.c
=item newRANGE
X<newRANGE>
Constructs and returns a C<range> op, with subordinate C<flip> and
C<flop> ops. C<flags> gives the eight bits of C<op_flags> for the
C<flip> op and, shifted up eight bits, the eight bits of C<op_private>
for both the C<flip> and C<range> ops, except that the bit with value
1 is automatically set. C<left> and C<right> supply the expressions
controlling the endpoints of the range; they are consumed by this function
and become part of the constructed op tree.
OP * newRANGE(I32 flags, OP *left, OP *right)
=for hackers
Found in file op.c
=item newSLICEOP
X<newSLICEOP>
Constructs, checks, and returns an C<lslice> (list slice) op. C<flags>
gives the eight bits of C<op_flags>, except that C<OPf_KIDS> will
be set automatically, and, shifted up eight bits, the eight bits of
C<op_private>, except that the bit with value 1 or 2 is automatically
set as required. C<listval> and C<subscript> supply the parameters of
the slice; they are consumed by this function and become part of the
constructed op tree.
OP * newSLICEOP(I32 flags, OP *subscript,
OP *listval)
=for hackers
Found in file op.c
=item newSTATEOP
X<newSTATEOP>
Constructs a state op (COP). The state op is normally a C<nextstate> op,
but will be a C<dbstate> op if debugging is enabled for currently-compiled
code. The state op is populated from C<PL_curcop> (or C<PL_compiling>).
If C<label> is non-null, it supplies the name of a label to attach to
the state op; this function takes ownership of the memory pointed at by
C<label>, and will free it. C<flags> gives the eight bits of C<op_flags>
for the state op.
If C<o> is null, the state op is returned. Otherwise the state op is
combined with C<o> into a C<lineseq> list op, which is returned. C<o>
is consumed by this function and becomes part of the returned op tree.
OP * newSTATEOP(I32 flags, char *label, OP *o)
=for hackers
Found in file op.c
=item newSVOP
X<newSVOP>
Constructs, checks, and returns an op of any type that involves an
embedded SV. C<type> is the opcode. C<flags> gives the eight bits
of C<op_flags>. C<sv> gives the SV to embed in the op; this function
takes ownership of one reference to it.
OP * newSVOP(I32 type, I32 flags, SV *sv)
=for hackers
Found in file op.c
=item newUNOP
X<newUNOP>
Constructs, checks, and returns an op of any unary type. C<type> is
the opcode. C<flags> gives the eight bits of C<op_flags>, except that
C<OPf_KIDS> will be set automatically if required, and, shifted up eight
bits, the eight bits of C<op_private>, except that the bit with value 1
is automatically set. C<first> supplies an optional op to be the direct
child of the unary op; it is consumed by this function and become part
of the constructed op tree.
OP * newUNOP(I32 type, I32 flags, OP *first)
=for hackers
Found in file op.c
=item newUNOP_AUX
X<newUNOP_AUX>
Similar to C<newUNOP>, but creates an C<UNOP_AUX> struct instead, with C<op_aux>
initialised to C<aux>
OP* newUNOP_AUX(I32 type, I32 flags, OP* first,
UNOP_AUX_item *aux)
=for hackers
Found in file op.c
=item newWHENOP
X<newWHENOP>
Constructs, checks, and returns an op tree expressing a C<when> block.
C<cond> supplies the test expression, and C<block> supplies the block
that will be executed if the test evaluates to true; they are consumed
by this function and become part of the constructed op tree. C<cond>
will be interpreted DWIMically, often as a comparison against C<$_>,
and may be null to generate a C<default> block.
OP * newWHENOP(OP *cond, OP *block)
=for hackers
Found in file op.c
=item newWHILEOP
X<newWHILEOP>
Constructs, checks, and returns an op tree expressing a C<while> loop.
This is a heavyweight loop, with structure that allows exiting the loop
by C<last> and suchlike.
C<loop> is an optional preconstructed C<enterloop> op to use in the
loop; if it is null then a suitable op will be constructed automatically.
C<expr> supplies the loop's controlling expression. C<block> supplies the
main body of the loop, and C<cont> optionally supplies a C<continue> block
that operates as a second half of the body. All of these optree inputs
are consumed by this function and become part of the constructed op tree.
C<flags> gives the eight bits of C<op_flags> for the C<leaveloop>
op and, shifted up eight bits, the eight bits of C<op_private> for
the C<leaveloop> op, except that (in both cases) some bits will be set
automatically. C<debuggable> is currently unused and should always be 1.
C<has_my> can be supplied as true to force the
loop body to be enclosed in its own scope.
OP * newWHILEOP(I32 flags, I32 debuggable,
LOOP *loop, OP *expr, OP *block,
OP *cont, I32 has_my)
=for hackers
Found in file op.c
=back
=head1 Optree Manipulation Functions
=over 8
=item alloccopstash
X<alloccopstash>
NOTE: this function is experimental and may change or be
removed without notice.
Available only under threaded builds, this function allocates an entry in
C<PL_stashpad> for the stash passed to it.
PADOFFSET alloccopstash(HV *hv)
=for hackers
Found in file op.c
=item block_end
X<block_end>
Handles compile-time scope exit. C<floor>
is the savestack index returned by
C<block_start>, and C<seq> is the body of the block. Returns the block,
possibly modified.
OP * block_end(I32 floor, OP *seq)
=for hackers
Found in file op.c
=item block_start
X<block_start>
Handles compile-time scope entry.
Arranges for hints to be restored on block
exit and also handles pad sequence numbers to make lexical variables scope
right. Returns a savestack index for use with C<block_end>.
int block_start(int full)
=for hackers
Found in file op.c
=item ck_entersub_args_list
X<ck_entersub_args_list>
Performs the default fixup of the arguments part of an C<entersub>
op tree. This consists of applying list context to each of the
argument ops. This is the standard treatment used on a call marked
with C<&>, or a method call, or a call through a subroutine reference,
or any other call where the callee can't be identified at compile time,
or a call where the callee has no prototype.
OP * ck_entersub_args_list(OP *entersubop)
=for hackers
Found in file op.c
=item ck_entersub_args_proto
X<ck_entersub_args_proto>
Performs the fixup of the arguments part of an C<entersub> op tree
based on a subroutine prototype. This makes various modifications to
the argument ops, from applying context up to inserting C<refgen> ops,
and checking the number and syntactic types of arguments, as directed by
the prototype. This is the standard treatment used on a subroutine call,
not marked with C<&>, where the callee can be identified at compile time
and has a prototype.
C<protosv> supplies the subroutine prototype to be applied to the call.
It may be a normal defined scalar, of which the string value will be used.
Alternatively, for convenience, it may be a subroutine object (a C<CV*>
that has been cast to C<SV*>) which has a prototype. The prototype
supplied, in whichever form, does not need to match the actual callee
referenced by the op tree.
If the argument ops disagree with the prototype, for example by having
an unacceptable number of arguments, a valid op tree is returned anyway.
The error is reflected in the parser state, normally resulting in a single
exception at the top level of parsing which covers all the compilation
errors that occurred. In the error message, the callee is referred to
by the name defined by the C<namegv> parameter.
OP * ck_entersub_args_proto(OP *entersubop,
GV *namegv, SV *protosv)
=for hackers
Found in file op.c
=item ck_entersub_args_proto_or_list
X<ck_entersub_args_proto_or_list>
Performs the fixup of the arguments part of an C<entersub> op tree either
based on a subroutine prototype or using default list-context processing.
This is the standard treatment used on a subroutine call, not marked
with C<&>, where the callee can be identified at compile time.
C<protosv> supplies the subroutine prototype to be applied to the call,
or indicates that there is no prototype. It may be a normal scalar,
in which case if it is defined then the string value will be used
as a prototype, and if it is undefined then there is no prototype.
Alternatively, for convenience, it may be a subroutine object (a C<CV*>
that has been cast to C<SV*>), of which the prototype will be used if it
has one. The prototype (or lack thereof) supplied, in whichever form,
does not need to match the actual callee referenced by the op tree.
If the argument ops disagree with the prototype, for example by having
an unacceptable number of arguments, a valid op tree is returned anyway.
The error is reflected in the parser state, normally resulting in a single
exception at the top level of parsing which covers all the compilation
errors that occurred. In the error message, the callee is referred to
by the name defined by the C<namegv> parameter.
OP * ck_entersub_args_proto_or_list(OP *entersubop,
GV *namegv,
SV *protosv)
=for hackers
Found in file op.c
=item cv_const_sv
X<cv_const_sv>
If C<cv> is a constant sub eligible for inlining, returns the constant
value returned by the sub. Otherwise, returns C<NULL>.
Constant subs can be created with C<newCONSTSUB> or as described in
L<perlsub/"Constant Functions">.
SV* cv_const_sv(const CV *const cv)
=for hackers
Found in file op.c
=item cv_get_call_checker
X<cv_get_call_checker>
Retrieves the function that will be used to fix up a call to C<cv>.
Specifically, the function is applied to an C<entersub> op tree for a
subroutine call, not marked with C<&>, where the callee can be identified
at compile time as C<cv>.
The C-level function pointer is returned in C<*ckfun_p>, and an SV
argument for it is returned in C<*ckobj_p>. The function is intended
to be called in this manner:
entersubop = (*ckfun_p)(aTHX_ entersubop, namegv, (*ckobj_p));
In this call, C<entersubop> is a pointer to the C<entersub> op,
which may be replaced by the check function, and C<namegv> is a GV
supplying the name that should be used by the check function to refer
to the callee of the C<entersub> op if it needs to emit any diagnostics.
It is permitted to apply the check function in non-standard situations,
such as to a call to a different subroutine or to a method call.
By default, the function is
L<Perl_ck_entersub_args_proto_or_list|/ck_entersub_args_proto_or_list>,
and the SV parameter is C<cv> itself. This implements standard
prototype processing. It can be changed, for a particular subroutine,
by L</cv_set_call_checker>.
void cv_get_call_checker(CV *cv,
Perl_call_checker *ckfun_p,
SV **ckobj_p)
=for hackers
Found in file op.c
=item cv_set_call_checker
X<cv_set_call_checker>
The original form of L</cv_set_call_checker_flags>, which passes it the
C<CALL_CHECKER_REQUIRE_GV> flag for backward-compatibility.
void cv_set_call_checker(CV *cv,
Perl_call_checker ckfun,
SV *ckobj)
=for hackers
Found in file op.c
=item cv_set_call_checker_flags
X<cv_set_call_checker_flags>
Sets the function that will be used to fix up a call to C<cv>.
Specifically, the function is applied to an C<entersub> op tree for a
subroutine call, not marked with C<&>, where the callee can be identified
at compile time as C<cv>.
The C-level function pointer is supplied in C<ckfun>, and an SV argument
for it is supplied in C<ckobj>. The function should be defined like this:
STATIC OP * ckfun(pTHX_ OP *op, GV *namegv, SV *ckobj)
It is intended to be called in this manner:
entersubop = ckfun(aTHX_ entersubop, namegv, ckobj);
In this call, C<entersubop> is a pointer to the C<entersub> op,
which may be replaced by the check function, and C<namegv> supplies
the name that should be used by the check function to refer
to the callee of the C<entersub> op if it needs to emit any diagnostics.
It is permitted to apply the check function in non-standard situations,
such as to a call to a different subroutine or to a method call.
C<namegv> may not actually be a GV. For efficiency, perl may pass a
CV or other SV instead. Whatever is passed can be used as the first
argument to L</cv_name>. You can force perl to pass a GV by including
C<CALL_CHECKER_REQUIRE_GV> in the C<flags>.
The current setting for a particular CV can be retrieved by
L</cv_get_call_checker>.
void cv_set_call_checker_flags(
CV *cv, Perl_call_checker ckfun, SV *ckobj,
U32 flags
)
=for hackers
Found in file op.c
=item LINKLIST
X<LINKLIST>
Given the root of an optree, link the tree in execution order using the
C<op_next> pointers and return the first op executed. If this has
already been done, it will not be redone, and C<< o->op_next >> will be
returned. If C<< o->op_next >> is not already set, C<o> should be at
least an C<UNOP>.
OP* LINKLIST(OP *o)
=for hackers
Found in file op.h
=item newCONSTSUB
X<newCONSTSUB>
See L</newCONSTSUB_flags>.
CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
=for hackers
Found in file op.c
=item newCONSTSUB_flags
X<newCONSTSUB_flags>
Creates a constant sub equivalent to Perl S<C<sub FOO () { 123 }>> which is
eligible for inlining at compile-time.
Currently, the only useful value for C<flags> is C<SVf_UTF8>.
The newly created subroutine takes ownership of a reference to the passed in
SV.
Passing C<NULL> for SV creates a constant sub equivalent to S<C<sub BAR () {}>>,
which won't be called if used as a destructor, but will suppress the overhead
of a call to C<AUTOLOAD>. (This form, however, isn't eligible for inlining at
compile time.)
CV* newCONSTSUB_flags(HV* stash, const char* name,
STRLEN len, U32 flags, SV* sv)
=for hackers
Found in file op.c
=item newXS
X<newXS>
Used by C<xsubpp> to hook up XSUBs as Perl subs. C<filename> needs to be
static storage, as it is used directly as CvFILE(), without a copy being made.
=for hackers
Found in file op.c
=item op_append_elem
X<op_append_elem>
Append an item to the list of ops contained directly within a list-type
op, returning the lengthened list. C<first> is the list-type op,
and C<last> is the op to append to the list. C<optype> specifies the
intended opcode for the list. If C<first> is not already a list of the
right type, it will be upgraded into one. If either C<first> or C<last>
is null, the other is returned unchanged.
OP * op_append_elem(I32 optype, OP *first, OP *last)
=for hackers
Found in file op.c
=item op_append_list
X<op_append_list>
Concatenate the lists of ops contained directly within two list-type ops,
returning the combined list. C<first> and C<last> are the list-type ops
to concatenate. C<optype> specifies the intended opcode for the list.
If either C<first> or C<last> is not already a list of the right type,
it will be upgraded into one. If either C<first> or C<last> is null,
the other is returned unchanged.
OP * op_append_list(I32 optype, OP *first, OP *last)
=for hackers
Found in file op.c
=item OP_CLASS
X<OP_CLASS>
Return the class of the provided OP: that is, which of the *OP
structures it uses. For core ops this currently gets the information out
of C<PL_opargs>, which does not always accurately reflect the type used;
in v5.26 onwards, see also the function C<L</op_class>> which can do a better
job of determining the used type.
For custom ops the type is returned from the registration, and it is up
to the registree to ensure it is accurate. The value returned will be
one of the C<OA_>* constants from F<op.h>.
U32 OP_CLASS(OP *o)
=for hackers
Found in file op.h
=item op_contextualize
X<op_contextualize>
Applies a syntactic context to an op tree representing an expression.
C<o> is the op tree, and C<context> must be C<G_SCALAR>, C<G_ARRAY>,
or C<G_VOID> to specify the context to apply. The modified op tree
is returned.
OP * op_contextualize(OP *o, I32 context)
=for hackers
Found in file op.c
=item op_convert_list
X<op_convert_list>
Converts C<o> into a list op if it is not one already, and then converts it
into the specified C<type>, calling its check function, allocating a target if
it needs one, and folding constants.
A list-type op is usually constructed one kid at a time via C<newLISTOP>,
C<op_prepend_elem> and C<op_append_elem>. Then finally it is passed to
C<op_convert_list> to make it the right type.
OP * op_convert_list(I32 type, I32 flags, OP *o)
=for hackers
Found in file op.c
=item OP_DESC
X<OP_DESC>
Return a short description of the provided OP.
const char * OP_DESC(OP *o)
=for hackers
Found in file op.h
=item op_free
X<op_free>
Free an op. Only use this when an op is no longer linked to from any
optree.
void op_free(OP *o)
=for hackers
Found in file op.c
=item OpHAS_SIBLING
X<OpHAS_SIBLING>
Returns true if C<o> has a sibling
bool OpHAS_SIBLING(OP *o)
=for hackers
Found in file op.h
=item OpLASTSIB_set
X<OpLASTSIB_set>
Marks C<o> as having no further siblings. On C<PERL_OP_PARENT> builds, marks
o as having the specified parent. See also C<L</OpMORESIB_set>> and
C<OpMAYBESIB_set>. For a higher-level interface, see
C<L</op_sibling_splice>>.
void OpLASTSIB_set(OP *o, OP *parent)
=for hackers
Found in file op.h
=item op_linklist
X<op_linklist>
This function is the implementation of the L</LINKLIST> macro. It should
not be called directly.
OP* op_linklist(OP *o)
=for hackers
Found in file op.c
=item op_lvalue
X<op_lvalue>
NOTE: this function is experimental and may change or be
removed without notice.
Propagate lvalue ("modifiable") context to an op and its children.
C<type> represents the context type, roughly based on the type of op that
would do the modifying, although C<local()> is represented by C<OP_NULL>,
because it has no op type of its own (it is signalled by a flag on
the lvalue op).
This function detects things that can't be modified, such as C<$x+1>, and
generates errors for them. For example, C<$x+1 = 2> would cause it to be
called with an op of type C<OP_ADD> and a C<type> argument of C<OP_SASSIGN>.
It also flags things that need to behave specially in an lvalue context,
such as C<$$x = 5> which might have to vivify a reference in C<$x>.
OP * op_lvalue(OP *o, I32 type)
=for hackers
Found in file op.c
=item OpMAYBESIB_set
X<OpMAYBESIB_set>
Conditionally does C<OpMORESIB_set> or C<OpLASTSIB_set> depending on whether
C<sib> is non-null. For a higher-level interface, see C<L</op_sibling_splice>>.
void OpMAYBESIB_set(OP *o, OP *sib, OP *parent)
=for hackers
Found in file op.h
=item OpMORESIB_set
X<OpMORESIB_set>
Sets the sibling of C<o> to the non-zero value C<sib>. See also C<L</OpLASTSIB_set>>
and C<L</OpMAYBESIB_set>>. For a higher-level interface, see
C<L</op_sibling_splice>>.
void OpMORESIB_set(OP *o, OP *sib)
=for hackers
Found in file op.h
=item OP_NAME
X<OP_NAME>
Return the name of the provided OP. For core ops this looks up the name
from the op_type; for custom ops from the op_ppaddr.
const char * OP_NAME(OP *o)
=for hackers
Found in file op.h
=item op_null
X<op_null>
Neutralizes an op when it is no longer needed, but is still linked to from
other ops.
void op_null(OP *o)
=for hackers
Found in file op.c
=item op_parent
X<op_parent>
Returns the parent OP of C<o>, if it has a parent. Returns C<NULL> otherwise.
This function is only available on perls built with C<-DPERL_OP_PARENT>.
OP* op_parent(OP *o)
=for hackers
Found in file op.c
=item op_prepend_elem
X<op_prepend_elem>
Prepend an item to the list of ops contained directly within a list-type
op, returning the lengthened list. C<first> is the op to prepend to the
list, and C<last> is the list-type op. C<optype> specifies the intended
opcode for the list. If C<last> is not already a list of the right type,
it will be upgraded into one. If either C<first> or C<last> is null,
the other is returned unchanged.
OP * op_prepend_elem(I32 optype, OP *first, OP *last)
=for hackers
Found in file op.c
=item op_scope
X<op_scope>
NOTE: this function is experimental and may change or be
removed without notice.
Wraps up an op tree with some additional ops so that at runtime a dynamic
scope will be created. The original ops run in the new dynamic scope,
and then, provided that they exit normally, the scope will be unwound.
The additional ops used to create and unwind the dynamic scope will
normally be an C<enter>/C<leave> pair, but a C<scope> op may be used
instead if the ops are simple enough to not need the full dynamic scope
structure.
OP * op_scope(OP *o)
=for hackers
Found in file op.c
=item OpSIBLING
X<OpSIBLING>
Returns the sibling of C<o>, or C<NULL> if there is no sibling
OP* OpSIBLING(OP *o)
=for hackers
Found in file op.h
=item op_sibling_splice
X<op_sibling_splice>
A general function for editing the structure of an existing chain of
op_sibling nodes. By analogy with the perl-level C<splice()> function, allows
you to delete zero or more sequential nodes, replacing them with zero or
more different nodes. Performs the necessary op_first/op_last
housekeeping on the parent node and op_sibling manipulation on the
children. The last deleted node will be marked as as the last node by
updating the op_sibling/op_sibparent or op_moresib field as appropriate.
Note that op_next is not manipulated, and nodes are not freed; that is the
responsibility of the caller. It also won't create a new list op for an
empty list etc; use higher-level functions like op_append_elem() for that.
C<parent> is the parent node of the sibling chain. It may passed as C<NULL> if
the splicing doesn't affect the first or last op in the chain.
C<start> is the node preceding the first node to be spliced. Node(s)
following it will be deleted, and ops will be inserted after it. If it is
C<NULL>, the first node onwards is deleted, and nodes are inserted at the
beginning.
C<del_count> is the number of nodes to delete. If zero, no nodes are deleted.
If -1 or greater than or equal to the number of remaining kids, all
remaining kids are deleted.
C<insert> is the first of a chain of nodes to be inserted in place of the nodes.
If C<NULL>, no nodes are inserted.
The head of the chain of deleted ops is returned, or C<NULL> if no ops were
deleted.
For example:
action before after returns
------ ----- ----- -------
P P
splice(P, A, 2, X-Y-Z) | | B-C
A-B-C-D A-X-Y-Z-D
P P
splice(P, NULL, 1, X-Y) | | A
A-B-C-D X-Y-B-C-D
P P
splice(P, NULL, 3, NULL) | | A-B-C
A-B-C-D D
P P
splice(P, B, 0, X-Y) | | NULL
A-B-C-D A-B-X-Y-C-D
For lower-level direct manipulation of C<op_sibparent> and C<op_moresib>,
see C<L</OpMORESIB_set>>, C<L</OpLASTSIB_set>>, C<L</OpMAYBESIB_set>>.
OP* op_sibling_splice(OP *parent, OP *start,
int del_count, OP* insert)
=for hackers
Found in file op.c
=item OP_TYPE_IS
X<OP_TYPE_IS>
Returns true if the given OP is not a C<NULL> pointer
and if it is of the given type.
The negation of this macro, C<OP_TYPE_ISNT> is also available
as well as C<OP_TYPE_IS_NN> and C<OP_TYPE_ISNT_NN> which elide
the NULL pointer check.
bool OP_TYPE_IS(OP *o, Optype type)
=for hackers
Found in file op.h
=item OP_TYPE_IS_OR_WAS
X<OP_TYPE_IS_OR_WAS>
Returns true if the given OP is not a NULL pointer and
if it is of the given type or used to be before being
replaced by an OP of type OP_NULL.
The negation of this macro, C<OP_TYPE_ISNT_AND_WASNT>
is also available as well as C<OP_TYPE_IS_OR_WAS_NN>
and C<OP_TYPE_ISNT_AND_WASNT_NN> which elide
the C<NULL> pointer check.
bool OP_TYPE_IS_OR_WAS(OP *o, Optype type)
=for hackers
Found in file op.h
=item rv2cv_op_cv
X<rv2cv_op_cv>
Examines an op, which is expected to identify a subroutine at runtime,
and attempts to determine at compile time which subroutine it identifies.
This is normally used during Perl compilation to determine whether
a prototype can be applied to a function call. C<cvop> is the op
being considered, normally an C<rv2cv> op. A pointer to the identified
subroutine is returned, if it could be determined statically, and a null
pointer is returned if it was not possible to determine statically.
Currently, the subroutine can be identified statically if the RV that the
C<rv2cv> is to operate on is provided by a suitable C<gv> or C<const> op.
A C<gv> op is suitable if the GV's CV slot is populated. A C<const> op is
suitable if the constant value must be an RV pointing to a CV. Details of
this process may change in future versions of Perl. If the C<rv2cv> op
has the C<OPpENTERSUB_AMPER> flag set then no attempt is made to identify
the subroutine statically: this flag is used to suppress compile-time
magic on a subroutine call, forcing it to use default runtime behaviour.
If C<flags> has the bit C<RV2CVOPCV_MARK_EARLY> set, then the handling
of a GV reference is modified. If a GV was examined and its CV slot was
found to be empty, then the C<gv> op has the C<OPpEARLY_CV> flag set.
If the op is not optimised away, and the CV slot is later populated with
a subroutine having a prototype, that flag eventually triggers the warning
"called too early to check prototype".
If C<flags> has the bit C<RV2CVOPCV_RETURN_NAME_GV> set, then instead
of returning a pointer to the subroutine it returns a pointer to the
GV giving the most appropriate name for the subroutine in this context.
Normally this is just the C<CvGV> of the subroutine, but for an anonymous
(C<CvANON>) subroutine that is referenced through a GV it will be the
referencing GV. The resulting C<GV*> is cast to C<CV*> to be returned.
A null pointer is returned as usual if there is no statically-determinable
subroutine.
CV * rv2cv_op_cv(OP *cvop, U32 flags)
=for hackers
Found in file op.c
=back
=head1 Pack and Unpack
=over 8
=item packlist
X<packlist>
The engine implementing C<pack()> Perl function.
void packlist(SV *cat, const char *pat,
const char *patend, SV **beglist,
SV **endlist)
=for hackers
Found in file pp_pack.c
=item unpackstring
X<unpackstring>
The engine implementing the C<unpack()> Perl function.
Using the template C<pat..patend>, this function unpacks the string
C<s..strend> into a number of mortal SVs, which it pushes onto the perl
argument (C<@_>) stack (so you will need to issue a C<PUTBACK> before and
C<SPAGAIN> after the call to this function). It returns the number of
pushed elements.
The C<strend> and C<patend> pointers should point to the byte following the
last character of each string.
Although this function returns its values on the perl argument stack, it
doesn't take any parameters from that stack (and thus in particular
there's no need to do a C<PUSHMARK> before calling it, unlike L</call_pv> for
example).
I32 unpackstring(const char *pat,
const char *patend, const char *s,
const char *strend, U32 flags)
=for hackers
Found in file pp_pack.c
=back
=head1 Pad Data Structures
=over 8
=item CvPADLIST
X<CvPADLIST>
NOTE: this function is experimental and may change or be
removed without notice.
CV's can have CvPADLIST(cv) set to point to a PADLIST. This is the CV's
scratchpad, which stores lexical variables and opcode temporary and
per-thread values.
For these purposes "formats" are a kind-of CV; eval""s are too (except they're
not callable at will and are always thrown away after the eval"" is done
executing). Require'd files are simply evals without any outer lexical
scope.
XSUBs do not have a C<CvPADLIST>. C<dXSTARG> fetches values from C<PL_curpad>,
but that is really the callers pad (a slot of which is allocated by
every entersub). Do not get or set C<CvPADLIST> if a CV is an XSUB (as
determined by C<CvISXSUB()>), C<CvPADLIST> slot is reused for a different
internal purpose in XSUBs.
The PADLIST has a C array where pads are stored.
The 0th entry of the PADLIST is a PADNAMELIST
which represents the "names" or rather
the "static type information" for lexicals. The individual elements of a
PADNAMELIST are PADNAMEs. Future
refactorings might stop the PADNAMELIST from being stored in the PADLIST's
array, so don't rely on it. See L</PadlistNAMES>.
The CvDEPTH'th entry of a PADLIST is a PAD (an AV) which is the stack frame
at that depth of recursion into the CV. The 0th slot of a frame AV is an
AV which is C<@_>. Other entries are storage for variables and op targets.
Iterating over the PADNAMELIST iterates over all possible pad
items. Pad slots for targets (C<SVs_PADTMP>)
and GVs end up having &PL_padname_undef "names", while slots for constants
have C<&PL_padname_const> "names" (see C<L</pad_alloc>>). That
C<&PL_padname_undef>
and C<&PL_padname_const> are used is an implementation detail subject to
change. To test for them, use C<!PadnamePV(name)> and
S<C<PadnamePV(name) && !PadnameLEN(name)>>, respectively.
Only C<my>/C<our> variable slots get valid names.
The rest are op targets/GVs/constants which are statically allocated
or resolved at compile time. These don't have names by which they
can be looked up from Perl code at run time through eval"" the way
C<my>/C<our> variables can be. Since they can't be looked up by "name"
but only by their index allocated at compile time (which is usually
in C<PL_op->op_targ>), wasting a name SV for them doesn't make sense.
The pad names in the PADNAMELIST have their PV holding the name of
the variable. The C<COP_SEQ_RANGE_LOW> and C<_HIGH> fields form a range
(low+1..high inclusive) of cop_seq numbers for which the name is
valid. During compilation, these fields may hold the special value
PERL_PADSEQ_INTRO to indicate various stages:
COP_SEQ_RANGE_LOW _HIGH
----------------- -----
PERL_PADSEQ_INTRO 0 variable not yet introduced:
{ my ($x
valid-seq# PERL_PADSEQ_INTRO variable in scope:
{ my ($x);
valid-seq# valid-seq# compilation of scope complete:
{ my ($x); .... }
When a lexical var hasn't yet been introduced, it already exists from the
perspective of duplicate declarations, but not for variable lookups, e.g.
my ($x, $x); # '"my" variable $x masks earlier declaration'
my $x = $x; # equal to my $x = $::x;
For typed lexicals C<PadnameTYPE> points at the type stash. For C<our>
lexicals, C<PadnameOURSTASH> points at the stash of the associated global (so
that duplicate C<our> declarations in the same package can be detected).
C<PadnameGEN> is sometimes used to store the generation number during
compilation.
If C<PadnameOUTER> is set on the pad name, then that slot in the frame AV
is a REFCNT'ed reference to a lexical from "outside". Such entries
are sometimes referred to as 'fake'. In this case, the name does not
use 'low' and 'high' to store a cop_seq range, since it is in scope
throughout. Instead 'high' stores some flags containing info about
the real lexical (is it declared in an anon, and is it capable of being
instantiated multiple times?), and for fake ANONs, 'low' contains the index
within the parent's pad where the lexical's value is stored, to make
cloning quicker.
If the 'name' is C<&> the corresponding entry in the PAD
is a CV representing a possible closure.
Note that formats are treated as anon subs, and are cloned each time
write is called (if necessary).
The flag C<SVs_PADSTALE> is cleared on lexicals each time the C<my()> is executed,
and set on scope exit. This allows the
C<"Variable $x is not available"> warning
to be generated in evals, such as
{ my $x = 1; sub f { eval '$x'} } f();
For state vars, C<SVs_PADSTALE> is overloaded to mean 'not yet initialised',
but this internal state is stored in a separate pad entry.
PADLIST * CvPADLIST(CV *cv)
=for hackers
Found in file pad.c
=item pad_add_name_pvs
X<pad_add_name_pvs>
Exactly like L</pad_add_name_pvn>, but takes a C<NUL>-terminated literal string
instead of a string/length pair.
PADOFFSET pad_add_name_pvs(const char *name, U32 flags,
HV *typestash, HV *ourstash)
=for hackers
Found in file pad.h
=item PadARRAY
X<PadARRAY>
NOTE: this function is experimental and may change or be
removed without notice.
The C array of pad entries.
SV ** PadARRAY(PAD pad)
=for hackers
Found in file pad.h
=item pad_findmy_pvs
X<pad_findmy_pvs>
Exactly like L</pad_findmy_pvn>, but takes a C<NUL>-terminated literal string
instead of a string/length pair.
PADOFFSET pad_findmy_pvs(const char *name, U32 flags)
=for hackers
Found in file pad.h
=item PadlistARRAY
X<PadlistARRAY>
NOTE: this function is experimental and may change or be
removed without notice.
The C array of a padlist, containing the pads. Only subscript it with
numbers >= 1, as the 0th entry is not guaranteed to remain usable.
PAD ** PadlistARRAY(PADLIST padlist)
=for hackers
Found in file pad.h
=item PadlistMAX
X<PadlistMAX>
NOTE: this function is experimental and may change or be
removed without notice.
The index of the last allocated space in the padlist. Note that the last
pad may be in an earlier slot. Any entries following it will be C<NULL> in
that case.
SSize_t PadlistMAX(PADLIST padlist)
=for hackers
Found in file pad.h
=item PadlistNAMES
X<PadlistNAMES>
NOTE: this function is experimental and may change or be
removed without notice.
The names associated with pad entries.
PADNAMELIST * PadlistNAMES(PADLIST padlist)
=for hackers
Found in file pad.h
=item PadlistNAMESARRAY
X<PadlistNAMESARRAY>
NOTE: this function is experimental and may change or be
removed without notice.
The C array of pad names.
PADNAME ** PadlistNAMESARRAY(PADLIST padlist)
=for hackers
Found in file pad.h
=item PadlistNAMESMAX
X<PadlistNAMESMAX>
NOTE: this function is experimental and may change or be
removed without notice.
The index of the last pad name.
SSize_t PadlistNAMESMAX(PADLIST padlist)
=for hackers
Found in file pad.h
=item PadlistREFCNT
X<PadlistREFCNT>
NOTE: this function is experimental and may change or be
removed without notice.
The reference count of the padlist. Currently this is always 1.
U32 PadlistREFCNT(PADLIST padlist)
=for hackers
Found in file pad.h
=item PadMAX
X<PadMAX>
NOTE: this function is experimental and may change or be
removed without notice.
The index of the last pad entry.
SSize_t PadMAX(PAD pad)
=for hackers
Found in file pad.h
=item PadnameLEN
X<PadnameLEN>
NOTE: this function is experimental and may change or be
removed without notice.
The length of the name.
STRLEN PadnameLEN(PADNAME pn)
=for hackers
Found in file pad.h
=item PadnamelistARRAY
X<PadnamelistARRAY>
NOTE: this function is experimental and may change or be
removed without notice.
The C array of pad names.
PADNAME ** PadnamelistARRAY(PADNAMELIST pnl)
=for hackers
Found in file pad.h
=item PadnamelistMAX
X<PadnamelistMAX>
NOTE: this function is experimental and may change or be
removed without notice.
The index of the last pad name.
SSize_t PadnamelistMAX(PADNAMELIST pnl)
=for hackers
Found in file pad.h
=item PadnamelistREFCNT
X<PadnamelistREFCNT>
NOTE: this function is experimental and may change or be
removed without notice.
The reference count of the pad name list.
SSize_t PadnamelistREFCNT(PADNAMELIST pnl)
=for hackers
Found in file pad.h
=item PadnamelistREFCNT_dec
X<PadnamelistREFCNT_dec>
NOTE: this function is experimental and may change or be
removed without notice.
Lowers the reference count of the pad name list.
void PadnamelistREFCNT_dec(PADNAMELIST pnl)
=for hackers
Found in file pad.h
=item PadnamePV
X<PadnamePV>
NOTE: this function is experimental and may change or be
removed without notice.
The name stored in the pad name struct. This returns C<NULL> for a target
slot.
char * PadnamePV(PADNAME pn)
=for hackers
Found in file pad.h
=item PadnameREFCNT
X<PadnameREFCNT>
NOTE: this function is experimental and may change or be
removed without notice.
The reference count of the pad name.
SSize_t PadnameREFCNT(PADNAME pn)
=for hackers
Found in file pad.h
=item PadnameREFCNT_dec
X<PadnameREFCNT_dec>
NOTE: this function is experimental and may change or be
removed without notice.
Lowers the reference count of the pad name.
void PadnameREFCNT_dec(PADNAME pn)
=for hackers
Found in file pad.h
=item PadnameSV
X<PadnameSV>
NOTE: this function is experimental and may change or be
removed without notice.
Returns the pad name as a mortal SV.
SV * PadnameSV(PADNAME pn)
=for hackers
Found in file pad.h
=item PadnameUTF8
X<PadnameUTF8>
NOTE: this function is experimental and may change or be
removed without notice.
Whether PadnamePV is in UTF-8. Currently, this is always true.
bool PadnameUTF8(PADNAME pn)
=for hackers
Found in file pad.h
=item pad_new
X<pad_new>
Create a new padlist, updating the global variables for the
currently-compiling padlist to point to the new padlist. The following
flags can be OR'ed together:
padnew_CLONE this pad is for a cloned CV
padnew_SAVE save old globals on the save stack
padnew_SAVESUB also save extra stuff for start of sub
PADLIST * pad_new(int flags)
=for hackers
Found in file pad.c
=item PL_comppad
X<PL_comppad>
NOTE: this function is experimental and may change or be
removed without notice.
During compilation, this points to the array containing the values
part of the pad for the currently-compiling code. (At runtime a CV may
have many such value arrays; at compile time just one is constructed.)
At runtime, this points to the array containing the currently-relevant
values for the pad for the currently-executing code.
=for hackers
Found in file pad.c
=item PL_comppad_name
X<PL_comppad_name>
NOTE: this function is experimental and may change or be
removed without notice.
During compilation, this points to the array containing the names part
of the pad for the currently-compiling code.
=for hackers
Found in file pad.c
=item PL_curpad
X<PL_curpad>
NOTE: this function is experimental and may change or be
removed without notice.
Points directly to the body of the L</PL_comppad> array.
(I.e., this is C<PAD_ARRAY(PL_comppad)>.)
=for hackers
Found in file pad.c
=back
=head1 Per-Interpreter Variables
=over 8
=item PL_modglobal
X<PL_modglobal>
C<PL_modglobal> is a general purpose, interpreter global HV for use by
extensions that need to keep information on a per-interpreter basis.
In a pinch, it can also be used as a symbol table for extensions
to share data among each other. It is a good idea to use keys
prefixed by the package name of the extension that owns the data.
HV* PL_modglobal
=for hackers
Found in file intrpvar.h
=item PL_na
X<PL_na>
A convenience variable which is typically used with C<SvPV> when one
doesn't care about the length of the string. It is usually more efficient
to either declare a local variable and use that instead or to use the
C<SvPV_nolen> macro.
STRLEN PL_na
=for hackers
Found in file intrpvar.h
=item PL_opfreehook
X<PL_opfreehook>
When non-C<NULL>, the function pointed by this variable will be called each time an OP is freed with the corresponding OP as the argument.
This allows extensions to free any extra attribute they have locally attached to an OP.
It is also assured to first fire for the parent OP and then for its kids.
When you replace this variable, it is considered a good practice to store the possibly previously installed hook and that you recall it inside your own.
Perl_ophook_t PL_opfreehook
=for hackers
Found in file intrpvar.h
=item PL_peepp
X<PL_peepp>
Pointer to the per-subroutine peephole optimiser. This is a function
that gets called at the end of compilation of a Perl subroutine (or
equivalently independent piece of Perl code) to perform fixups of
some ops and to perform small-scale optimisations. The function is
called once for each subroutine that is compiled, and is passed, as sole
parameter, a pointer to the op that is the entry point to the subroutine.
It modifies the op tree in place.
The peephole optimiser should never be completely replaced. Rather,
add code to it by wrapping the existing optimiser. The basic way to do
this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
If the new code wishes to operate on ops throughout the subroutine's
structure, rather than just at the top level, it is likely to be more
convenient to wrap the L</PL_rpeepp> hook.
peep_t PL_peepp
=for hackers
Found in file intrpvar.h
=item PL_rpeepp
X<PL_rpeepp>
Pointer to the recursive peephole optimiser. This is a function
that gets called at the end of compilation of a Perl subroutine (or
equivalently independent piece of Perl code) to perform fixups of some
ops and to perform small-scale optimisations. The function is called
once for each chain of ops linked through their C<op_next> fields;
it is recursively called to handle each side chain. It is passed, as
sole parameter, a pointer to the op that is at the head of the chain.
It modifies the op tree in place.
The peephole optimiser should never be completely replaced. Rather,
add code to it by wrapping the existing optimiser. The basic way to do
this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
If the new code wishes to operate only on ops at a subroutine's top level,
rather than throughout the structure, it is likely to be more convenient
to wrap the L</PL_peepp> hook.
peep_t PL_rpeepp
=for hackers
Found in file intrpvar.h
=item PL_sv_no
X<PL_sv_no>
This is the C<false> SV. See C<L</PL_sv_yes>>. Always refer to this as
C<&PL_sv_no>.
SV PL_sv_no
=for hackers
Found in file intrpvar.h
=item PL_sv_undef
X<PL_sv_undef>
This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
SV PL_sv_undef
=for hackers
Found in file intrpvar.h
=item PL_sv_yes
X<PL_sv_yes>
This is the C<true> SV. See C<L</PL_sv_no>>. Always refer to this as
C<&PL_sv_yes>.
SV PL_sv_yes
=for hackers
Found in file intrpvar.h
=back
=head1 REGEXP Functions
=over 8
=item SvRX
X<SvRX>
Convenience macro to get the REGEXP from a SV. This is approximately
equivalent to the following snippet:
if (SvMAGICAL(sv))
mg_get(sv);
if (SvROK(sv))
sv = MUTABLE_SV(SvRV(sv));
if (SvTYPE(sv) == SVt_REGEXP)
return (REGEXP*) sv;
C<NULL> will be returned if a REGEXP* is not found.
REGEXP * SvRX(SV *sv)
=for hackers
Found in file regexp.h
=item SvRXOK
X<SvRXOK>
Returns a boolean indicating whether the SV (or the one it references)
is a REGEXP.
If you want to do something with the REGEXP* later use SvRX instead
and check for NULL.
bool SvRXOK(SV* sv)
=for hackers
Found in file regexp.h
=back
=head1 Stack Manipulation Macros
=over 8
=item dMARK
X<dMARK>
Declare a stack marker variable, C<mark>, for the XSUB. See C<L</MARK>> and
C<L</dORIGMARK>>.
dMARK;
=for hackers
Found in file pp.h
=item dORIGMARK
X<dORIGMARK>
Saves the original stack mark for the XSUB. See C<L</ORIGMARK>>.
dORIGMARK;
=for hackers
Found in file pp.h
=item dSP
X<dSP>
Declares a local copy of perl's stack pointer for the XSUB, available via
the C<SP> macro. See C<L</SP>>.
dSP;
=for hackers
Found in file pp.h
=item EXTEND
X<EXTEND>
Used to extend the argument stack for an XSUB's return values. Once
used, guarantees that there is room for at least C<nitems> to be pushed
onto the stack.
void EXTEND(SP, SSize_t nitems)
=for hackers
Found in file pp.h
=item MARK
X<MARK>
Stack marker variable for the XSUB. See C<L</dMARK>>.
=for hackers
Found in file pp.h
=item mPUSHi
X<mPUSHi>
Push an integer onto the stack. The stack must have room for this element.
Does not use C<TARG>. See also C<L</PUSHi>>, C<L</mXPUSHi>> and C<L</XPUSHi>>.
void mPUSHi(IV iv)
=for hackers
Found in file pp.h
=item mPUSHn
X<mPUSHn>
Push a double onto the stack. The stack must have room for this element.
Does not use C<TARG>. See also C<L</PUSHn>>, C<L</mXPUSHn>> and C<L</XPUSHn>>.
void mPUSHn(NV nv)
=for hackers
Found in file pp.h
=item mPUSHp
X<mPUSHp>
Push a string onto the stack. The stack must have room for this element.
The C<len> indicates the length of the string. Does not use C<TARG>.
See also C<L</PUSHp>>, C<L</mXPUSHp>> and C<L</XPUSHp>>.
void mPUSHp(char* str, STRLEN len)
=for hackers
Found in file pp.h
=item mPUSHs
X<mPUSHs>
Push an SV onto the stack and mortalizes the SV. The stack must have room
for this element. Does not use C<TARG>. See also C<L</PUSHs>> and
C<L</mXPUSHs>>.
void mPUSHs(SV* sv)
=for hackers
Found in file pp.h
=item mPUSHu
X<mPUSHu>
Push an unsigned integer onto the stack. The stack must have room for this
element. Does not use C<TARG>. See also C<L</PUSHu>>, C<L</mXPUSHu>> and
C<L</XPUSHu>>.
void mPUSHu(UV uv)
=for hackers
Found in file pp.h
=item mXPUSHi
X<mXPUSHi>
Push an integer onto the stack, extending the stack if necessary.
Does not use C<TARG>. See also C<L</XPUSHi>>, C<L</mPUSHi>> and C<L</PUSHi>>.
void mXPUSHi(IV iv)
=for hackers
Found in file pp.h
=item mXPUSHn
X<mXPUSHn>
Push a double onto the stack, extending the stack if necessary.
Does not use C<TARG>. See also C<L</XPUSHn>>, C<L</mPUSHn>> and C<L</PUSHn>>.
void mXPUSHn(NV nv)
=for hackers
Found in file pp.h
=item mXPUSHp
X<mXPUSHp>
Push a string onto the stack, extending the stack if necessary. The C<len>
indicates the length of the string. Does not use C<TARG>. See also
C<L</XPUSHp>>, C<mPUSHp> and C<PUSHp>.
void mXPUSHp(char* str, STRLEN len)
=for hackers
Found in file pp.h
=item mXPUSHs
X<mXPUSHs>
Push an SV onto the stack, extending the stack if necessary and mortalizes
the SV. Does not use C<TARG>. See also C<L</XPUSHs>> and C<L</mPUSHs>>.
void mXPUSHs(SV* sv)
=for hackers
Found in file pp.h
=item mXPUSHu
X<mXPUSHu>
Push an unsigned integer onto the stack, extending the stack if necessary.
Does not use C<TARG>. See also C<L</XPUSHu>>, C<L</mPUSHu>> and C<L</PUSHu>>.
void mXPUSHu(UV uv)
=for hackers
Found in file pp.h
=item ORIGMARK
X<ORIGMARK>
The original stack mark for the XSUB. See C<L</dORIGMARK>>.
=for hackers
Found in file pp.h
=item POPi
X<POPi>
Pops an integer off the stack.
IV POPi
=for hackers
Found in file pp.h
=item POPl
X<POPl>
Pops a long off the stack.
long POPl
=for hackers
Found in file pp.h
=item POPn
X<POPn>
Pops a double off the stack.
NV POPn
=for hackers
Found in file pp.h
=item POPp
X<POPp>
Pops a string off the stack.
char* POPp
=for hackers
Found in file pp.h
=item POPpbytex
X<POPpbytex>
Pops a string off the stack which must consist of bytes i.e. characters < 256.
char* POPpbytex
=for hackers
Found in file pp.h
=item POPpx
X<POPpx>
Pops a string off the stack. Identical to POPp. There are two names for
historical reasons.
char* POPpx
=for hackers
Found in file pp.h
=item POPs
X<POPs>
Pops an SV off the stack.
SV* POPs
=for hackers
Found in file pp.h
=item POPu
X<POPu>
Pops an unsigned integer off the stack.
UV POPu
=for hackers
Found in file pp.h
=item POPul
X<POPul>
Pops an unsigned long off the stack.
long POPul
=for hackers
Found in file pp.h
=item PUSHi
X<PUSHi>
Push an integer onto the stack. The stack must have room for this element.
Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
called to declare it. Do not call multiple C<TARG>-oriented macros to
return lists from XSUB's - see C<L</mPUSHi>> instead. See also C<L</XPUSHi>>
and C<L</mXPUSHi>>.
void PUSHi(IV iv)
=for hackers
Found in file pp.h
=item PUSHMARK
X<PUSHMARK>
Opening bracket for arguments on a callback. See C<L</PUTBACK>> and
L<perlcall>.
void PUSHMARK(SP)
=for hackers
Found in file pp.h
=item PUSHmortal
X<PUSHmortal>
Push a new mortal SV onto the stack. The stack must have room for this
element. Does not use C<TARG>. See also C<L</PUSHs>>, C<L</XPUSHmortal>> and
C<L</XPUSHs>>.
void PUSHmortal()
=for hackers
Found in file pp.h
=item PUSHn
X<PUSHn>
Push a double onto the stack. The stack must have room for this element.
Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
called to declare it. Do not call multiple C<TARG>-oriented macros to
return lists from XSUB's - see C<L</mPUSHn>> instead. See also C<L</XPUSHn>>
and C<L</mXPUSHn>>.
void PUSHn(NV nv)
=for hackers
Found in file pp.h
=item PUSHp
X<PUSHp>
Push a string onto the stack. The stack must have room for this element.
The C<len> indicates the length of the string. Handles 'set' magic. Uses
C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
call multiple C<TARG>-oriented macros to return lists from XSUB's - see
C<L</mPUSHp>> instead. See also C<L</XPUSHp>> and C<L</mXPUSHp>>.
void PUSHp(char* str, STRLEN len)
=for hackers
Found in file pp.h
=item PUSHs
X<PUSHs>
Push an SV onto the stack. The stack must have room for this element.
Does not handle 'set' magic. Does not use C<TARG>. See also
C<L</PUSHmortal>>, C<L</XPUSHs>>, and C<L</XPUSHmortal>>.
void PUSHs(SV* sv)
=for hackers
Found in file pp.h
=item PUSHu
X<PUSHu>
Push an unsigned integer onto the stack. The stack must have room for this
element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
should be called to declare it. Do not call multiple C<TARG>-oriented
macros to return lists from XSUB's - see C<L</mPUSHu>> instead. See also
C<L</XPUSHu>> and C<L</mXPUSHu>>.
void PUSHu(UV uv)
=for hackers
Found in file pp.h
=item PUTBACK
X<PUTBACK>
Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
See C<L</PUSHMARK>> and L<perlcall> for other uses.
PUTBACK;
=for hackers
Found in file pp.h
=item SP
X<SP>
Stack pointer. This is usually handled by C<xsubpp>. See C<L</dSP>> and
C<SPAGAIN>.
=for hackers
Found in file pp.h
=item SPAGAIN
X<SPAGAIN>
Refetch the stack pointer. Used after a callback. See L<perlcall>.
SPAGAIN;
=for hackers
Found in file pp.h
=item XPUSHi
X<XPUSHi>
Push an integer onto the stack, extending the stack if necessary. Handles
'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
declare it. Do not call multiple C<TARG>-oriented macros to return lists
from XSUB's - see C<L</mXPUSHi>> instead. See also C<L</PUSHi>> and
C<L</mPUSHi>>.
void XPUSHi(IV iv)
=for hackers
Found in file pp.h
=item XPUSHmortal
X<XPUSHmortal>
Push a new mortal SV onto the stack, extending the stack if necessary.
Does not use C<TARG>. See also C<L</XPUSHs>>, C<L</PUSHmortal>> and
C<L</PUSHs>>.
void XPUSHmortal()
=for hackers
Found in file pp.h
=item XPUSHn
X<XPUSHn>
Push a double onto the stack, extending the stack if necessary. Handles
'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
declare it. Do not call multiple C<TARG>-oriented macros to return lists
from XSUB's - see C<L</mXPUSHn>> instead. See also C<L</PUSHn>> and
C<L</mPUSHn>>.
void XPUSHn(NV nv)
=for hackers
Found in file pp.h
=item XPUSHp
X<XPUSHp>
Push a string onto the stack, extending the stack if necessary. The C<len>
indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
multiple C<TARG>-oriented macros to return lists from XSUB's - see
C<L</mXPUSHp>> instead. See also C<L</PUSHp>> and C<L</mPUSHp>>.
void XPUSHp(char* str, STRLEN len)
=for hackers
Found in file pp.h
=item XPUSHs
X<XPUSHs>
Push an SV onto the stack, extending the stack if necessary. Does not
handle 'set' magic. Does not use C<TARG>. See also C<L</XPUSHmortal>>,
C<PUSHs> and C<PUSHmortal>.
void XPUSHs(SV* sv)
=for hackers
Found in file pp.h
=item XPUSHu
X<XPUSHu>
Push an unsigned integer onto the stack, extending the stack if necessary.
Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
called to declare it. Do not call multiple C<TARG>-oriented macros to
return lists from XSUB's - see C<L</mXPUSHu>> instead. See also C<L</PUSHu>> and
C<L</mPUSHu>>.
void XPUSHu(UV uv)
=for hackers
Found in file pp.h
=item XSRETURN
X<XSRETURN>
Return from XSUB, indicating number of items on the stack. This is usually
handled by C<xsubpp>.
void XSRETURN(int nitems)
=for hackers
Found in file XSUB.h
=item XSRETURN_EMPTY
X<XSRETURN_EMPTY>
Return an empty list from an XSUB immediately.
XSRETURN_EMPTY;
=for hackers
Found in file XSUB.h
=item XSRETURN_IV
X<XSRETURN_IV>
Return an integer from an XSUB immediately. Uses C<XST_mIV>.
void XSRETURN_IV(IV iv)
=for hackers
Found in file XSUB.h
=item XSRETURN_NO
X<XSRETURN_NO>
Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
XSRETURN_NO;
=for hackers
Found in file XSUB.h
=item XSRETURN_NV
X<XSRETURN_NV>
Return a double from an XSUB immediately. Uses C<XST_mNV>.
void XSRETURN_NV(NV nv)
=for hackers
Found in file XSUB.h
=item XSRETURN_PV
X<XSRETURN_PV>
Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
void XSRETURN_PV(char* str)
=for hackers
Found in file XSUB.h
=item XSRETURN_UNDEF
X<XSRETURN_UNDEF>
Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
XSRETURN_UNDEF;
=for hackers
Found in file XSUB.h
=item XSRETURN_UV
X<XSRETURN_UV>
Return an integer from an XSUB immediately. Uses C<XST_mUV>.
void XSRETURN_UV(IV uv)
=for hackers
Found in file XSUB.h
=item XSRETURN_YES
X<XSRETURN_YES>
Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
XSRETURN_YES;
=for hackers
Found in file XSUB.h
=item XST_mIV
X<XST_mIV>
Place an integer into the specified position C<pos> on the stack. The
value is stored in a new mortal SV.
void XST_mIV(int pos, IV iv)
=for hackers
Found in file XSUB.h
=item XST_mNO
X<XST_mNO>
Place C<&PL_sv_no> into the specified position C<pos> on the
stack.
void XST_mNO(int pos)
=for hackers
Found in file XSUB.h
=item XST_mNV
X<XST_mNV>
Place a double into the specified position C<pos> on the stack. The value
is stored in a new mortal SV.
void XST_mNV(int pos, NV nv)
=for hackers
Found in file XSUB.h
=item XST_mPV
X<XST_mPV>
Place a copy of a string into the specified position C<pos> on the stack.
The value is stored in a new mortal SV.
void XST_mPV(int pos, char* str)
=for hackers
Found in file XSUB.h
=item XST_mUNDEF
X<XST_mUNDEF>
Place C<&PL_sv_undef> into the specified position C<pos> on the
stack.
void XST_mUNDEF(int pos)
=for hackers
Found in file XSUB.h
=item XST_mYES
X<XST_mYES>
Place C<&PL_sv_yes> into the specified position C<pos> on the
stack.
void XST_mYES(int pos)
=for hackers
Found in file XSUB.h
=back
=head1 SV-Body Allocation
=over 8
=item looks_like_number
X<looks_like_number>
Test if the content of an SV looks like a number (or is a number).
C<Inf> and C<Infinity> are treated as numbers (so will not issue a
non-numeric warning), even if your C<atof()> doesn't grok them. Get-magic is
ignored.
I32 looks_like_number(SV *const sv)
=for hackers
Found in file sv.c
=item newRV_noinc
X<newRV_noinc>
Creates an RV wrapper for an SV. The reference count for the original
SV is B<not> incremented.
SV* newRV_noinc(SV *const tmpRef)
=for hackers
Found in file sv.c
=item newSV
X<newSV>
Creates a new SV. A non-zero C<len> parameter indicates the number of
bytes of preallocated string space the SV should have. An extra byte for a
trailing C<NUL> is also reserved. (C<SvPOK> is not set for the SV even if string
space is allocated.) The reference count for the new SV is set to 1.
In 5.9.3, C<newSV()> replaces the older C<NEWSV()> API, and drops the first
parameter, I<x>, a debug aid which allowed callers to identify themselves.
This aid has been superseded by a new build option, C<PERL_MEM_LOG> (see
L<perlhacktips/PERL_MEM_LOG>). The older API is still there for use in XS
modules supporting older perls.
SV* newSV(const STRLEN len)
=for hackers
Found in file sv.c
=item newSVhek
X<newSVhek>
Creates a new SV from the hash key structure. It will generate scalars that
point to the shared string table where possible. Returns a new (undefined)
SV if C<hek> is NULL.
SV* newSVhek(const HEK *const hek)
=for hackers
Found in file sv.c
=item newSViv
X<newSViv>
Creates a new SV and copies an integer into it. The reference count for the
SV is set to 1.
SV* newSViv(const IV i)
=for hackers
Found in file sv.c
=item newSVnv
X<newSVnv>
Creates a new SV and copies a floating point value into it.
The reference count for the SV is set to 1.
SV* newSVnv(const NV n)
=for hackers
Found in file sv.c
=item newSVpv
X<newSVpv>
Creates a new SV and copies a string (which may contain C<NUL> (C<\0>)
characters) into it. The reference count for the
SV is set to 1. If C<len> is zero, Perl will compute the length using
C<strlen()>, (which means if you use this option, that C<s> can't have embedded
C<NUL> characters and has to have a terminating C<NUL> byte).
This function can cause reliability issues if you are likely to pass in
empty strings that are not null terminated, because it will run
strlen on the string and potentially run past valid memory.
Using L</newSVpvn> is a safer alternative for non C<NUL> terminated strings.
For string literals use L</newSVpvs> instead. This function will work fine for
C<NUL> terminated strings, but if you want to avoid the if statement on whether
to call C<strlen> use C<newSVpvn> instead (calling C<strlen> yourself).
SV* newSVpv(const char *const s, const STRLEN len)
=for hackers
Found in file sv.c
=item newSVpvf
X<newSVpvf>
Creates a new SV and initializes it with the string formatted like
C<sv_catpvf>.
SV* newSVpvf(const char *const pat, ...)
=for hackers
Found in file sv.c
=item newSVpvn
X<newSVpvn>
Creates a new SV and copies a string into it, which may contain C<NUL> characters
(C<\0>) and other binary data. The reference count for the SV is set to 1.
Note that if C<len> is zero, Perl will create a zero length (Perl) string. You
are responsible for ensuring that the source buffer is at least
C<len> bytes long. If the C<buffer> argument is NULL the new SV will be
undefined.
SV* newSVpvn(const char *const s, const STRLEN len)
=for hackers
Found in file sv.c
=item newSVpvn_flags
X<newSVpvn_flags>
Creates a new SV and copies a string (which may contain C<NUL> (C<\0>)
characters) into it. The reference count for the
SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
string. You are responsible for ensuring that the source string is at least
C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
If C<SVs_TEMP> is set, then C<sv_2mortal()> is called on the result before
returning. If C<SVf_UTF8> is set, C<s>
is considered to be in UTF-8 and the
C<SVf_UTF8> flag will be set on the new SV.
C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
#define newSVpvn_utf8(s, len, u) \
newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
SV* newSVpvn_flags(const char *const s,
const STRLEN len,
const U32 flags)
=for hackers
Found in file sv.c
=item newSVpvn_share
X<newSVpvn_share>
Creates a new SV with its C<SvPVX_const> pointing to a shared string in the string
table. If the string does not already exist in the table, it is
created first. Turns on the C<SvIsCOW> flag (or C<READONLY>
and C<FAKE> in 5.16 and earlier). If the C<hash> parameter
is non-zero, that value is used; otherwise the hash is computed.
The string's hash can later be retrieved from the SV
with the C<SvSHARED_HASH()> macro. The idea here is
that as the string table is used for shared hash keys these strings will have
C<SvPVX_const == HeKEY> and hash lookup will avoid string compare.
SV* newSVpvn_share(const char* s, I32 len, U32 hash)
=for hackers
Found in file sv.c
=item newSVpvs
X<newSVpvs>
Like C<newSVpvn>, but takes a C<NUL>-terminated literal string instead of a
string/length pair.
SV* newSVpvs(const char* s)
=for hackers
Found in file handy.h
=item newSVpvs_flags
X<newSVpvs_flags>
Like C<newSVpvn_flags>, but takes a C<NUL>-terminated literal string instead of
a string/length pair.
SV* newSVpvs_flags(const char* s, U32 flags)
=for hackers
Found in file handy.h
=item newSVpv_share
X<newSVpv_share>
Like C<newSVpvn_share>, but takes a C<NUL>-terminated string instead of a
string/length pair.
SV* newSVpv_share(const char* s, U32 hash)
=for hackers
Found in file sv.c
=item newSVpvs_share
X<newSVpvs_share>
Like C<newSVpvn_share>, but takes a C<NUL>-terminated literal string instead of
a string/length pair and omits the hash parameter.
SV* newSVpvs_share(const char* s)
=for hackers
Found in file handy.h
=item newSVrv
X<newSVrv>
Creates a new SV for the existing RV, C<rv>, to point to. If C<rv> is not an
RV then it will be upgraded to one. If C<classname> is non-null then the new
SV will be blessed in the specified package. The new SV is returned and its
reference count is 1. The reference count 1 is owned by C<rv>.
SV* newSVrv(SV *const rv,
const char *const classname)
=for hackers
Found in file sv.c
=item newSVsv
X<newSVsv>
Creates a new SV which is an exact duplicate of the original SV.
(Uses C<sv_setsv>.)
SV* newSVsv(SV *const old)
=for hackers
Found in file sv.c
=item newSV_type
X<newSV_type>
Creates a new SV, of the type specified. The reference count for the new SV
is set to 1.
SV* newSV_type(const svtype type)
=for hackers
Found in file sv.c
=item newSVuv
X<newSVuv>
Creates a new SV and copies an unsigned integer into it.
The reference count for the SV is set to 1.
SV* newSVuv(const UV u)
=for hackers
Found in file sv.c
=item sv_2bool
X<sv_2bool>
This macro is only used by C<sv_true()> or its macro equivalent, and only if
the latter's argument is neither C<SvPOK>, C<SvIOK> nor C<SvNOK>.
It calls C<sv_2bool_flags> with the C<SV_GMAGIC> flag.
bool sv_2bool(SV *const sv)
=for hackers
Found in file sv.c
=item sv_2bool_flags
X<sv_2bool_flags>
This function is only used by C<sv_true()> and friends, and only if
the latter's argument is neither C<SvPOK>, C<SvIOK> nor C<SvNOK>. If the flags
contain C<SV_GMAGIC>, then it does an C<mg_get()> first.
bool sv_2bool_flags(SV *sv, I32 flags)
=for hackers
Found in file sv.c
=item sv_2cv
X<sv_2cv>
Using various gambits, try to get a CV from an SV; in addition, try if
possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
The flags in C<lref> are passed to C<gv_fetchsv>.
CV* sv_2cv(SV* sv, HV **const st, GV **const gvp,
const I32 lref)
=for hackers
Found in file sv.c
=item sv_2io
X<sv_2io>
Using various gambits, try to get an IO from an SV: the IO slot if its a
GV; or the recursive result if we're an RV; or the IO slot of the symbol
named after the PV if we're a string.
'Get' magic is ignored on the C<sv> passed in, but will be called on
C<SvRV(sv)> if C<sv> is an RV.
IO* sv_2io(SV *const sv)
=for hackers
Found in file sv.c
=item sv_2iv_flags
X<sv_2iv_flags>
Return the integer value of an SV, doing any necessary string
conversion. If C<flags> has the C<SV_GMAGIC> bit set, does an C<mg_get()> first.
Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
IV sv_2iv_flags(SV *const sv, const I32 flags)
=for hackers
Found in file sv.c
=item sv_2mortal
X<sv_2mortal>
Marks an existing SV as mortal. The SV will be destroyed "soon", either
by an explicit call to C<FREETMPS>, or by an implicit call at places such as
statement boundaries. C<SvTEMP()> is turned on which means that the SV's
string buffer can be "stolen" if this SV is copied. See also
C<L</sv_newmortal>> and C<L</sv_mortalcopy>>.
SV* sv_2mortal(SV *const sv)
=for hackers
Found in file sv.c
=item sv_2nv_flags
X<sv_2nv_flags>
Return the num value of an SV, doing any necessary string or integer
conversion. If C<flags> has the C<SV_GMAGIC> bit set, does an C<mg_get()> first.
Normally used via the C<SvNV(sv)> and C<SvNVx(sv)> macros.
NV sv_2nv_flags(SV *const sv, const I32 flags)
=for hackers
Found in file sv.c
=item sv_2pvbyte
X<sv_2pvbyte>
Return a pointer to the byte-encoded representation of the SV, and set C<*lp>
to its length. May cause the SV to be downgraded from UTF-8 as a
side-effect.
Usually accessed via the C<SvPVbyte> macro.
char* sv_2pvbyte(SV *sv, STRLEN *const lp)
=for hackers
Found in file sv.c
=item sv_2pvutf8
X<sv_2pvutf8>
Return a pointer to the UTF-8-encoded representation of the SV, and set C<*lp>
to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
Usually accessed via the C<SvPVutf8> macro.
char* sv_2pvutf8(SV *sv, STRLEN *const lp)
=for hackers
Found in file sv.c
=item sv_2pv_flags
X<sv_2pv_flags>
Returns a pointer to the string value of an SV, and sets C<*lp> to its length.
If flags has the C<SV_GMAGIC> bit set, does an C<mg_get()> first. Coerces C<sv> to a
string if necessary. Normally invoked via the C<SvPV_flags> macro.
C<sv_2pv()> and C<sv_2pv_nomg> usually end up here too.
char* sv_2pv_flags(SV *const sv, STRLEN *const lp,
const I32 flags)
=for hackers
Found in file sv.c
=item sv_2uv_flags
X<sv_2uv_flags>
Return the unsigned integer value of an SV, doing any necessary string
conversion. If C<flags> has the C<SV_GMAGIC> bit set, does an C<mg_get()> first.
Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
UV sv_2uv_flags(SV *const sv, const I32 flags)
=for hackers
Found in file sv.c
=item sv_backoff
X<sv_backoff>
Remove any string offset. You should normally use the C<SvOOK_off> macro
wrapper instead.
void sv_backoff(SV *const sv)
=for hackers
Found in file sv.c
=item sv_bless
X<sv_bless>
Blesses an SV into a specified package. The SV must be an RV. The package
must be designated by its stash (see C<L</gv_stashpv>>). The reference count
of the SV is unaffected.
SV* sv_bless(SV *const sv, HV *const stash)
=for hackers
Found in file sv.c
=item sv_catpv
X<sv_catpv>
Concatenates the C<NUL>-terminated string onto the end of the string which is
in the SV.
If the SV has the UTF-8 status set, then the bytes appended should be
valid UTF-8. Handles 'get' magic, but not 'set' magic. See
C<L</sv_catpv_mg>>.
void sv_catpv(SV *const sv, const char* ptr)
=for hackers
Found in file sv.c
=item sv_catpvf
X<sv_catpvf>
Processes its arguments like C<sv_catpvfn>, and appends the formatted
output to an SV. As with C<sv_catpvfn> called with a non-null C-style
variable argument list, argument reordering is not supported.
If the appended data contains "wide" characters
(including, but not limited to, SVs with a UTF-8 PV formatted with C<%s>,
and characters >255 formatted with C<%c>), the original SV might get
upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
C<L</sv_catpvf_mg>>. If the original SV was UTF-8, the pattern should be
valid UTF-8; if the original SV was bytes, the pattern should be too.
void sv_catpvf(SV *const sv, const char *const pat,
...)
=for hackers
Found in file sv.c
=item sv_catpvf_mg
X<sv_catpvf_mg>
Like C<sv_catpvf>, but also handles 'set' magic.
void sv_catpvf_mg(SV *const sv,
const char *const pat, ...)
=for hackers
Found in file sv.c
=item sv_catpvn
X<sv_catpvn>
Concatenates the string onto the end of the string which is in the SV.
C<len> indicates number of bytes to copy. If the SV has the UTF-8
status set, then the bytes appended should be valid UTF-8.
Handles 'get' magic, but not 'set' magic. See C<L</sv_catpvn_mg>>.
void sv_catpvn(SV *dsv, const char *sstr, STRLEN len)
=for hackers
Found in file sv.c
=item sv_catpvn_flags
X<sv_catpvn_flags>
Concatenates the string onto the end of the string which is in the SV. The
C<len> indicates number of bytes to copy.
By default, the string appended is assumed to be valid UTF-8 if the SV has
the UTF-8 status set, and a string of bytes otherwise. One can force the
appended string to be interpreted as UTF-8 by supplying the C<SV_CATUTF8>
flag, and as bytes by supplying the C<SV_CATBYTES> flag; the SV or the
string appended will be upgraded to UTF-8 if necessary.
If C<flags> has the C<SV_SMAGIC> bit set, will
C<mg_set> on C<dsv> afterwards if appropriate.
C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
in terms of this function.
void sv_catpvn_flags(SV *const dstr,
const char *sstr,
const STRLEN len,
const I32 flags)
=for hackers
Found in file sv.c
=item sv_catpvs
X<sv_catpvs>
Like C<sv_catpvn>, but takes a C<NUL>-terminated literal string instead of a
string/length pair.
void sv_catpvs(SV* sv, const char* s)
=for hackers
Found in file handy.h
=item sv_catpvs_flags
X<sv_catpvs_flags>
Like C<sv_catpvn_flags>, but takes a C<NUL>-terminated literal string instead
of a string/length pair.
void sv_catpvs_flags(SV* sv, const char* s,
I32 flags)
=for hackers
Found in file handy.h
=item sv_catpvs_mg
X<sv_catpvs_mg>
Like C<sv_catpvn_mg>, but takes a C<NUL>-terminated literal string instead of a
string/length pair.
void sv_catpvs_mg(SV* sv, const char* s)
=for hackers
Found in file handy.h
=item sv_catpvs_nomg
X<sv_catpvs_nomg>
Like C<sv_catpvn_nomg>, but takes a C<NUL>-terminated literal string instead of
a string/length pair.
void sv_catpvs_nomg(SV* sv, const char* s)
=for hackers
Found in file handy.h
=item sv_catpv_flags
X<sv_catpv_flags>
Concatenates the C<NUL>-terminated string onto the end of the string which is
in the SV.
If the SV has the UTF-8 status set, then the bytes appended should
be valid UTF-8. If C<flags> has the C<SV_SMAGIC> bit set, will C<mg_set>
on the modified SV if appropriate.
void sv_catpv_flags(SV *dstr, const char *sstr,
const I32 flags)
=for hackers
Found in file sv.c
=item sv_catpv_mg
X<sv_catpv_mg>
Like C<sv_catpv>, but also handles 'set' magic.
void sv_catpv_mg(SV *const sv, const char *const ptr)
=for hackers
Found in file sv.c
=item sv_catsv
X<sv_catsv>
Concatenates the string from SV C<ssv> onto the end of the string in SV
C<dsv>. If C<ssv> is null, does nothing; otherwise modifies only C<dsv>.
Handles 'get' magic on both SVs, but no 'set' magic. See C<L</sv_catsv_mg>>
and C<L</sv_catsv_nomg>>.
void sv_catsv(SV *dstr, SV *sstr)
=for hackers
Found in file sv.c
=item sv_catsv_flags
X<sv_catsv_flags>
Concatenates the string from SV C<ssv> onto the end of the string in SV
C<dsv>. If C<ssv> is null, does nothing; otherwise modifies only C<dsv>.
If C<flags> has the C<SV_GMAGIC> bit set, will call C<mg_get> on both SVs if
appropriate. If C<flags> has the C<SV_SMAGIC> bit set, C<mg_set> will be called on
the modified SV afterward, if appropriate. C<sv_catsv>, C<sv_catsv_nomg>,
and C<sv_catsv_mg> are implemented in terms of this function.
void sv_catsv_flags(SV *const dsv, SV *const ssv,
const I32 flags)
=for hackers
Found in file sv.c
=item sv_chop
X<sv_chop>
Efficient removal of characters from the beginning of the string buffer.
C<SvPOK(sv)>, or at least C<SvPOKp(sv)>, must be true and C<ptr> must be a
pointer to somewhere inside the string buffer. C<ptr> becomes the first
character of the adjusted string. Uses the C<OOK> hack. On return, only
C<SvPOK(sv)> and C<SvPOKp(sv)> among the C<OK> flags will be true.
Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
refer to the same chunk of data.
The unfortunate similarity of this function's name to that of Perl's C<chop>
operator is strictly coincidental. This function works from the left;
C<chop> works from the right.
void sv_chop(SV *const sv, const char *const ptr)
=for hackers
Found in file sv.c
=item sv_clear
X<sv_clear>
Clear an SV: call any destructors, free up any memory used by the body,
and free the body itself. The SV's head is I<not> freed, although
its type is set to all 1's so that it won't inadvertently be assumed
to be live during global destruction etc.
This function should only be called when C<REFCNT> is zero. Most of the time
you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
instead.
void sv_clear(SV *const orig_sv)
=for hackers
Found in file sv.c
=item sv_cmp
X<sv_cmp>
Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
string in C<sv1> is less than, equal to, or greater than the string in
C<sv2>. Is UTF-8 and S<C<'use bytes'>> aware, handles get magic, and will
coerce its args to strings if necessary. See also C<L</sv_cmp_locale>>.
I32 sv_cmp(SV *const sv1, SV *const sv2)
=for hackers
Found in file sv.c
=item sv_cmp_flags
X<sv_cmp_flags>
Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
string in C<sv1> is less than, equal to, or greater than the string in
C<sv2>. Is UTF-8 and S<C<'use bytes'>> aware and will coerce its args to strings
if necessary. If the flags has the C<SV_GMAGIC> bit set, it handles get magic. See
also C<L</sv_cmp_locale_flags>>.
I32 sv_cmp_flags(SV *const sv1, SV *const sv2,
const U32 flags)
=for hackers
Found in file sv.c
=item sv_cmp_locale
X<sv_cmp_locale>
Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
S<C<'use bytes'>> aware, handles get magic, and will coerce its args to strings
if necessary. See also C<L</sv_cmp>>.
I32 sv_cmp_locale(SV *const sv1, SV *const sv2)
=for hackers
Found in file sv.c
=item sv_cmp_locale_flags
X<sv_cmp_locale_flags>
Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
S<C<'use bytes'>> aware and will coerce its args to strings if necessary. If
the flags contain C<SV_GMAGIC>, it handles get magic. See also
C<L</sv_cmp_flags>>.
I32 sv_cmp_locale_flags(SV *const sv1,
SV *const sv2,
const U32 flags)
=for hackers
Found in file sv.c
=item sv_collxfrm
X<sv_collxfrm>
This calls C<sv_collxfrm_flags> with the SV_GMAGIC flag. See
C<L</sv_collxfrm_flags>>.
char* sv_collxfrm(SV *const sv, STRLEN *const nxp)
=for hackers
Found in file sv.c
=item sv_collxfrm_flags
X<sv_collxfrm_flags>
Add Collate Transform magic to an SV if it doesn't already have it. If the
flags contain C<SV_GMAGIC>, it handles get-magic.
Any scalar variable may carry C<PERL_MAGIC_collxfrm> magic that contains the
scalar data of the variable, but transformed to such a format that a normal
memory comparison can be used to compare the data according to the locale
settings.
char* sv_collxfrm_flags(SV *const sv,
STRLEN *const nxp,
I32 const flags)
=for hackers
Found in file sv.c
=item sv_copypv
X<sv_copypv>
Copies a stringified representation of the source SV into the
destination SV. Automatically performs any necessary C<mg_get> and
coercion of numeric values into strings. Guaranteed to preserve
C<UTF8> flag even from overloaded objects. Similar in nature to
C<sv_2pv[_flags]> but operates directly on an SV instead of just the
string. Mostly uses C<sv_2pv_flags> to do its work, except when that
would lose the UTF-8'ness of the PV.
void sv_copypv(SV *const dsv, SV *const ssv)
=for hackers
Found in file sv.c
=item sv_copypv_flags
X<sv_copypv_flags>
Implementation of C<sv_copypv> and C<sv_copypv_nomg>. Calls get magic iff flags
has the C<SV_GMAGIC> bit set.
void sv_copypv_flags(SV *const dsv, SV *const ssv,
const I32 flags)
=for hackers
Found in file sv.c
=item sv_copypv_nomg
X<sv_copypv_nomg>
Like C<sv_copypv>, but doesn't invoke get magic first.
void sv_copypv_nomg(SV *const dsv, SV *const ssv)
=for hackers
Found in file sv.c
=item sv_dec
X<sv_dec>
Auto-decrement of the value in the SV, doing string to numeric conversion
if necessary. Handles 'get' magic and operator overloading.
void sv_dec(SV *const sv)
=for hackers
Found in file sv.c
=item sv_dec_nomg
X<sv_dec_nomg>
Auto-decrement of the value in the SV, doing string to numeric conversion
if necessary. Handles operator overloading. Skips handling 'get' magic.
void sv_dec_nomg(SV *const sv)
=for hackers
Found in file sv.c
=item sv_eq
X<sv_eq>
Returns a boolean indicating whether the strings in the two SVs are
identical. Is UTF-8 and S<C<'use bytes'>> aware, handles get magic, and will
coerce its args to strings if necessary.
I32 sv_eq(SV* sv1, SV* sv2)
=for hackers
Found in file sv.c
=item sv_eq_flags
X<sv_eq_flags>
Returns a boolean indicating whether the strings in the two SVs are
identical. Is UTF-8 and S<C<'use bytes'>> aware and coerces its args to strings
if necessary. If the flags has the C<SV_GMAGIC> bit set, it handles get-magic, too.
I32 sv_eq_flags(SV* sv1, SV* sv2, const U32 flags)
=for hackers
Found in file sv.c
=item sv_force_normal_flags
X<sv_force_normal_flags>
Undo various types of fakery on an SV, where fakery means
"more than" a string: if the PV is a shared string, make
a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
an C<xpvmg>; if we're a copy-on-write scalar, this is the on-write time when
we do the copy, and is also used locally; if this is a
vstring, drop the vstring magic. If C<SV_COW_DROP_PV> is set
then a copy-on-write scalar drops its PV buffer (if any) and becomes
C<SvPOK_off> rather than making a copy. (Used where this
scalar is about to be set to some other value.) In addition,
the C<flags> parameter gets passed to C<sv_unref_flags()>
when unreffing. C<sv_force_normal> calls this function
with flags set to 0.
This function is expected to be used to signal to perl that this SV is
about to be written to, and any extra book-keeping needs to be taken care
of. Hence, it croaks on read-only values.
void sv_force_normal_flags(SV *const sv,
const U32 flags)
=for hackers
Found in file sv.c
=item sv_free
X<sv_free>
Decrement an SV's reference count, and if it drops to zero, call
C<sv_clear> to invoke destructors and free up any memory used by
the body; finally, deallocating the SV's head itself.
Normally called via a wrapper macro C<SvREFCNT_dec>.
void sv_free(SV *const sv)
=for hackers
Found in file sv.c
=item sv_gets
X<sv_gets>
Get a line from the filehandle and store it into the SV, optionally
appending to the currently-stored string. If C<append> is not 0, the
line is appended to the SV instead of overwriting it. C<append> should
be set to the byte offset that the appended string should start at
in the SV (typically, C<SvCUR(sv)> is a suitable choice).
char* sv_gets(SV *const sv, PerlIO *const fp,
I32 append)
=for hackers
Found in file sv.c
=item sv_get_backrefs
X<sv_get_backrefs>
NOTE: this function is experimental and may change or be
removed without notice.
If C<sv> is the target of a weak reference then it returns the back
references structure associated with the sv; otherwise return C<NULL>.
When returning a non-null result the type of the return is relevant. If it
is an AV then the elements of the AV are the weak reference RVs which
point at this item. If it is any other type then the item itself is the
weak reference.
See also C<Perl_sv_add_backref()>, C<Perl_sv_del_backref()>,
C<Perl_sv_kill_backrefs()>
SV* sv_get_backrefs(SV *const sv)
=for hackers
Found in file sv.c
=item sv_grow
X<sv_grow>
Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
Use the C<SvGROW> wrapper instead.
char* sv_grow(SV *const sv, STRLEN newlen)
=for hackers
Found in file sv.c
=item sv_inc
X<sv_inc>
Auto-increment of the value in the SV, doing string to numeric conversion
if necessary. Handles 'get' magic and operator overloading.
void sv_inc(SV *const sv)
=for hackers
Found in file sv.c
=item sv_inc_nomg
X<sv_inc_nomg>
Auto-increment of the value in the SV, doing string to numeric conversion
if necessary. Handles operator overloading. Skips handling 'get' magic.
void sv_inc_nomg(SV *const sv)
=for hackers
Found in file sv.c
=item sv_insert
X<sv_insert>
Inserts a string at the specified offset/length within the SV. Similar to
the Perl C<substr()> function. Handles get magic.
void sv_insert(SV *const bigstr, const STRLEN offset,
const STRLEN len,
const char *const little,
const STRLEN littlelen)
=for hackers
Found in file sv.c
=item sv_insert_flags
X<sv_insert_flags>
Same as C<sv_insert>, but the extra C<flags> are passed to the
C<SvPV_force_flags> that applies to C<bigstr>.
void sv_insert_flags(SV *const bigstr,
const STRLEN offset,
const STRLEN len,
const char *little,
const STRLEN littlelen,
const U32 flags)
=for hackers
Found in file sv.c
=item sv_isa
X<sv_isa>
Returns a boolean indicating whether the SV is blessed into the specified
class. This does not check for subtypes; use C<sv_derived_from> to verify
an inheritance relationship.
int sv_isa(SV* sv, const char *const name)
=for hackers
Found in file sv.c
=item sv_isobject
X<sv_isobject>
Returns a boolean indicating whether the SV is an RV pointing to a blessed
object. If the SV is not an RV, or if the object is not blessed, then this
will return false.
int sv_isobject(SV* sv)
=for hackers
Found in file sv.c
=item sv_len
X<sv_len>
Returns the length of the string in the SV. Handles magic and type
coercion and sets the UTF8 flag appropriately. See also C<L</SvCUR>>, which
gives raw access to the C<xpv_cur> slot.
STRLEN sv_len(SV *const sv)
=for hackers
Found in file sv.c
=item sv_len_utf8
X<sv_len_utf8>
Returns the number of characters in the string in an SV, counting wide
UTF-8 bytes as a single character. Handles magic and type coercion.
STRLEN sv_len_utf8(SV *const sv)
=for hackers
Found in file sv.c
=item sv_magic
X<sv_magic>
Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if
necessary, then adds a new magic item of type C<how> to the head of the
magic list.
See C<L</sv_magicext>> (which C<sv_magic> now calls) for a description of the
handling of the C<name> and C<namlen> arguments.
You need to use C<sv_magicext> to add magic to C<SvREADONLY> SVs and also
to add more than one instance of the same C<how>.
void sv_magic(SV *const sv, SV *const obj,
const int how, const char *const name,
const I32 namlen)
=for hackers
Found in file sv.c
=item sv_magicext
X<sv_magicext>
Adds magic to an SV, upgrading it if necessary. Applies the
supplied C<vtable> and returns a pointer to the magic added.
Note that C<sv_magicext> will allow things that C<sv_magic> will not.
In particular, you can add magic to C<SvREADONLY> SVs, and add more than
one instance of the same C<how>.
If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
stored, if C<namlen> is zero then C<name> is stored as-is and - as another
special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
to contain an SV* and is stored as-is with its C<REFCNT> incremented.
(This is now used as a subroutine by C<sv_magic>.)
MAGIC * sv_magicext(SV *const sv, SV *const obj,
const int how,
const MGVTBL *const vtbl,
const char *const name,
const I32 namlen)
=for hackers
Found in file sv.c
=item sv_mortalcopy
X<sv_mortalcopy>
Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
The new SV is marked as mortal. It will be destroyed "soon", either by an
explicit call to C<FREETMPS>, or by an implicit call at places such as
statement boundaries. See also C<L</sv_newmortal>> and C<L</sv_2mortal>>.
SV* sv_mortalcopy(SV *const oldsv)
=for hackers
Found in file sv.c
=item sv_newmortal
X<sv_newmortal>
Creates a new null SV which is mortal. The reference count of the SV is
set to 1. It will be destroyed "soon", either by an explicit call to
C<FREETMPS>, or by an implicit call at places such as statement boundaries.
See also C<L</sv_mortalcopy>> and C<L</sv_2mortal>>.
SV* sv_newmortal()
=for hackers
Found in file sv.c
=item sv_newref
X<sv_newref>
Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
instead.
SV* sv_newref(SV *const sv)
=for hackers
Found in file sv.c
=item sv_pos_b2u
X<sv_pos_b2u>
Converts the value pointed to by C<offsetp> from a count of bytes from the
start of the string, to a count of the equivalent number of UTF-8 chars.
Handles magic and type coercion.
Use C<sv_pos_b2u_flags> in preference, which correctly handles strings
longer than 2Gb.
void sv_pos_b2u(SV *const sv, I32 *const offsetp)
=for hackers
Found in file sv.c
=item sv_pos_b2u_flags
X<sv_pos_b2u_flags>
Converts C<offset> from a count of bytes from the start of the string, to
a count of the equivalent number of UTF-8 chars. Handles type coercion.
C<flags> is passed to C<SvPV_flags>, and usually should be
C<SV_GMAGIC|SV_CONST_RETURN> to handle magic.
STRLEN sv_pos_b2u_flags(SV *const sv,
STRLEN const offset, U32 flags)
=for hackers
Found in file sv.c
=item sv_pos_u2b
X<sv_pos_u2b>
Converts the value pointed to by C<offsetp> from a count of UTF-8 chars from
the start of the string, to a count of the equivalent number of bytes; if
C<lenp> is non-zero, it does the same to C<lenp>, but this time starting from
the offset, rather than from the start of the string. Handles magic and
type coercion.
Use C<sv_pos_u2b_flags> in preference, which correctly handles strings longer
than 2Gb.
void sv_pos_u2b(SV *const sv, I32 *const offsetp,
I32 *const lenp)
=for hackers
Found in file sv.c
=item sv_pos_u2b_flags
X<sv_pos_u2b_flags>
Converts the offset from a count of UTF-8 chars from
the start of the string, to a count of the equivalent number of bytes; if
C<lenp> is non-zero, it does the same to C<lenp>, but this time starting from
C<offset>, rather than from the start
of the string. Handles type coercion.
C<flags> is passed to C<SvPV_flags>, and usually should be
C<SV_GMAGIC|SV_CONST_RETURN> to handle magic.
STRLEN sv_pos_u2b_flags(SV *const sv, STRLEN uoffset,
STRLEN *const lenp, U32 flags)
=for hackers
Found in file sv.c
=item sv_pvbyten_force
X<sv_pvbyten_force>
The backend for the C<SvPVbytex_force> macro. Always use the macro
instead.
char* sv_pvbyten_force(SV *const sv, STRLEN *const lp)
=for hackers
Found in file sv.c
=item sv_pvn_force
X<sv_pvn_force>
Get a sensible string out of the SV somehow.
A private implementation of the C<SvPV_force> macro for compilers which
can't cope with complex macro expressions. Always use the macro instead.
char* sv_pvn_force(SV* sv, STRLEN* lp)
=for hackers
Found in file sv.c
=item sv_pvn_force_flags
X<sv_pvn_force_flags>
Get a sensible string out of the SV somehow.
If C<flags> has the C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
implemented in terms of this function.
You normally want to use the various wrapper macros instead: see
C<L</SvPV_force>> and C<L</SvPV_force_nomg>>.
char* sv_pvn_force_flags(SV *const sv,
STRLEN *const lp,
const I32 flags)
=for hackers
Found in file sv.c
=item sv_pvutf8n_force
X<sv_pvutf8n_force>
The backend for the C<SvPVutf8x_force> macro. Always use the macro
instead.
char* sv_pvutf8n_force(SV *const sv, STRLEN *const lp)
=for hackers
Found in file sv.c
=item sv_ref
X<sv_ref>
Returns a SV describing what the SV passed in is a reference to.
dst can be a SV to be set to the description or NULL, in which case a
mortal SV is returned.
If ob is true and the SV is blessed, the description is the class
name, otherwise it is the type of the SV, "SCALAR", "ARRAY" etc.
SV* sv_ref(SV *dst, const SV *const sv,
const int ob)
=for hackers
Found in file sv.c
=item sv_reftype
X<sv_reftype>
Returns a string describing what the SV is a reference to.
If ob is true and the SV is blessed, the string is the class name,
otherwise it is the type of the SV, "SCALAR", "ARRAY" etc.
const char* sv_reftype(const SV *const sv, const int ob)
=for hackers
Found in file sv.c
=item sv_replace
X<sv_replace>
Make the first argument a copy of the second, then delete the original.
The target SV physically takes over ownership of the body of the source SV
and inherits its flags; however, the target keeps any magic it owns,
and any magic in the source is discarded.
Note that this is a rather specialist SV copying operation; most of the
time you'll want to use C<sv_setsv> or one of its many macro front-ends.
void sv_replace(SV *const sv, SV *const nsv)
=for hackers
Found in file sv.c
=item sv_reset
X<sv_reset>
Underlying implementation for the C<reset> Perl function.
Note that the perl-level function is vaguely deprecated.
void sv_reset(const char* s, HV *const stash)
=for hackers
Found in file sv.c
=item sv_rvweaken
X<sv_rvweaken>
Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
push a back-reference to this RV onto the array of backreferences
associated with that magic. If the RV is magical, set magic will be
called after the RV is cleared.
SV* sv_rvweaken(SV *const sv)
=for hackers
Found in file sv.c
=item sv_setiv
X<sv_setiv>
Copies an integer into the given SV, upgrading first if necessary.
Does not handle 'set' magic. See also C<L</sv_setiv_mg>>.
void sv_setiv(SV *const sv, const IV num)
=for hackers
Found in file sv.c
=item sv_setiv_mg
X<sv_setiv_mg>
Like C<sv_setiv>, but also handles 'set' magic.
void sv_setiv_mg(SV *const sv, const IV i)
=for hackers
Found in file sv.c
=item sv_setnv
X<sv_setnv>
Copies a double into the given SV, upgrading first if necessary.
Does not handle 'set' magic. See also C<L</sv_setnv_mg>>.
void sv_setnv(SV *const sv, const NV num)
=for hackers
Found in file sv.c
=item sv_setnv_mg
X<sv_setnv_mg>
Like C<sv_setnv>, but also handles 'set' magic.
void sv_setnv_mg(SV *const sv, const NV num)
=for hackers
Found in file sv.c
=item sv_setpv
X<sv_setpv>
Copies a string into an SV. The string must be terminated with a C<NUL>
character, and not contain embeded C<NUL>'s.
Does not handle 'set' magic. See C<L</sv_setpv_mg>>.
void sv_setpv(SV *const sv, const char *const ptr)
=for hackers
Found in file sv.c
=item sv_setpvf
X<sv_setpvf>
Works like C<sv_catpvf> but copies the text into the SV instead of
appending it. Does not handle 'set' magic. See C<L</sv_setpvf_mg>>.
void sv_setpvf(SV *const sv, const char *const pat,
...)
=for hackers
Found in file sv.c
=item sv_setpvf_mg
X<sv_setpvf_mg>
Like C<sv_setpvf>, but also handles 'set' magic.
void sv_setpvf_mg(SV *const sv,
const char *const pat, ...)
=for hackers
Found in file sv.c
=item sv_setpviv
X<sv_setpviv>
Copies an integer into the given SV, also updating its string value.
Does not handle 'set' magic. See C<L</sv_setpviv_mg>>.
void sv_setpviv(SV *const sv, const IV num)
=for hackers
Found in file sv.c
=item sv_setpviv_mg
X<sv_setpviv_mg>
Like C<sv_setpviv>, but also handles 'set' magic.
void sv_setpviv_mg(SV *const sv, const IV iv)
=for hackers
Found in file sv.c
=item sv_setpvn
X<sv_setpvn>
Copies a string (possibly containing embedded C<NUL> characters) into an SV.
The C<len> parameter indicates the number of
bytes to be copied. If the C<ptr> argument is NULL the SV will become
undefined. Does not handle 'set' magic. See C<L</sv_setpvn_mg>>.
void sv_setpvn(SV *const sv, const char *const ptr,
const STRLEN len)
=for hackers
Found in file sv.c
=item sv_setpvn_mg
X<sv_setpvn_mg>
Like C<sv_setpvn>, but also handles 'set' magic.
void sv_setpvn_mg(SV *const sv,
const char *const ptr,
const STRLEN len)
=for hackers
Found in file sv.c
=item sv_setpvs
X<sv_setpvs>
Like C<sv_setpvn>, but takes a C<NUL>-terminated literal string instead of a
string/length pair.
void sv_setpvs(SV* sv, const char* s)
=for hackers
Found in file handy.h
=item sv_setpvs_mg
X<sv_setpvs_mg>
Like C<sv_setpvn_mg>, but takes a C<NUL>-terminated literal string instead of a
string/length pair.
void sv_setpvs_mg(SV* sv, const char* s)
=for hackers
Found in file handy.h
=item sv_setpv_bufsize
X<sv_setpv_bufsize>
Sets the SV to be a string of cur bytes length, with at least
len bytes available. Ensures that there is a null byte at SvEND.
Returns a char * pointer to the SvPV buffer.
char * sv_setpv_bufsize(SV *const sv, const STRLEN cur,
const STRLEN len)
=for hackers
Found in file sv.c
=item sv_setpv_mg
X<sv_setpv_mg>
Like C<sv_setpv>, but also handles 'set' magic.
void sv_setpv_mg(SV *const sv, const char *const ptr)
=for hackers
Found in file sv.c
=item sv_setref_iv
X<sv_setref_iv>
Copies an integer into a new SV, optionally blessing the SV. The C<rv>
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. The C<classname> argument indicates the package for the
blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
will have a reference count of 1, and the RV will be returned.
SV* sv_setref_iv(SV *const rv,
const char *const classname,
const IV iv)
=for hackers
Found in file sv.c
=item sv_setref_nv
X<sv_setref_nv>
Copies a double into a new SV, optionally blessing the SV. The C<rv>
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. The C<classname> argument indicates the package for the
blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
will have a reference count of 1, and the RV will be returned.
SV* sv_setref_nv(SV *const rv,
const char *const classname,
const NV nv)
=for hackers
Found in file sv.c
=item sv_setref_pv
X<sv_setref_pv>
Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. If the C<pv> argument is C<NULL>, then C<PL_sv_undef> will be placed
into the SV. The C<classname> argument indicates the package for the
blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
will have a reference count of 1, and the RV will be returned.
Do not use with other Perl types such as HV, AV, SV, CV, because those
objects will become corrupted by the pointer copy process.
Note that C<sv_setref_pvn> copies the string while this copies the pointer.
SV* sv_setref_pv(SV *const rv,
const char *const classname,
void *const pv)
=for hackers
Found in file sv.c
=item sv_setref_pvn
X<sv_setref_pvn>
Copies a string into a new SV, optionally blessing the SV. The length of the
string must be specified with C<n>. The C<rv> argument will be upgraded to
an RV. That RV will be modified to point to the new SV. The C<classname>
argument indicates the package for the blessing. Set C<classname> to
C<NULL> to avoid the blessing. The new SV will have a reference count
of 1, and the RV will be returned.
Note that C<sv_setref_pv> copies the pointer while this copies the string.
SV* sv_setref_pvn(SV *const rv,
const char *const classname,
const char *const pv,
const STRLEN n)
=for hackers
Found in file sv.c
=item sv_setref_pvs
X<sv_setref_pvs>
Like C<sv_setref_pvn>, but takes a C<NUL>-terminated literal string instead of
a string/length pair.
SV * sv_setref_pvs(const char* s)
=for hackers
Found in file handy.h
=item sv_setref_uv
X<sv_setref_uv>
Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. The C<classname> argument indicates the package for the
blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
will have a reference count of 1, and the RV will be returned.
SV* sv_setref_uv(SV *const rv,
const char *const classname,
const UV uv)
=for hackers
Found in file sv.c
=item sv_setsv
X<sv_setsv>
Copies the contents of the source SV C<ssv> into the destination SV
C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
function if the source SV needs to be reused. Does not handle 'set' magic on
destination SV. Calls 'get' magic on source SV. Loosely speaking, it
performs a copy-by-value, obliterating any previous content of the
destination.
You probably want to use one of the assortment of wrappers, such as
C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
C<SvSetMagicSV_nosteal>.
void sv_setsv(SV *dstr, SV *sstr)
=for hackers
Found in file sv.c
=item sv_setsv_flags
X<sv_setsv_flags>
Copies the contents of the source SV C<ssv> into the destination SV
C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
function if the source SV needs to be reused. Does not handle 'set' magic.
Loosely speaking, it performs a copy-by-value, obliterating any previous
content of the destination.
If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
C<ssv> if appropriate, else not. If the C<flags>
parameter has the C<SV_NOSTEAL> bit set then the
buffers of temps will not be stolen. C<sv_setsv>
and C<sv_setsv_nomg> are implemented in terms of this function.
You probably want to use one of the assortment of wrappers, such as
C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
C<SvSetMagicSV_nosteal>.
This is the primary function for copying scalars, and most other
copy-ish functions and macros use this underneath.
void sv_setsv_flags(SV *dstr, SV *sstr,
const I32 flags)
=for hackers
Found in file sv.c
=item sv_setsv_mg
X<sv_setsv_mg>
Like C<sv_setsv>, but also handles 'set' magic.
void sv_setsv_mg(SV *const dstr, SV *const sstr)
=for hackers
Found in file sv.c
=item sv_setuv
X<sv_setuv>
Copies an unsigned integer into the given SV, upgrading first if necessary.
Does not handle 'set' magic. See also C<L</sv_setuv_mg>>.
void sv_setuv(SV *const sv, const UV num)
=for hackers
Found in file sv.c
=item sv_setuv_mg
X<sv_setuv_mg>
Like C<sv_setuv>, but also handles 'set' magic.
void sv_setuv_mg(SV *const sv, const UV u)
=for hackers
Found in file sv.c
=item sv_set_undef
X<sv_set_undef>
Equivalent to C<sv_setsv(sv, &PL_sv_undef)>, but more efficient.
Doesn't handle set magic.
The perl equivalent is C<$sv = undef;>. Note that it doesn't free any string
buffer, unlike C<undef $sv>.
Introduced in perl 5.26.0.
void sv_set_undef(SV *sv)
=for hackers
Found in file sv.c
=item sv_tainted
X<sv_tainted>
Test an SV for taintedness. Use C<SvTAINTED> instead.
bool sv_tainted(SV *const sv)
=for hackers
Found in file sv.c
=item sv_true
X<sv_true>
Returns true if the SV has a true value by Perl's rules.
Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
instead use an in-line version.
I32 sv_true(SV *const sv)
=for hackers
Found in file sv.c
=item sv_unmagic
X<sv_unmagic>
Removes all magic of type C<type> from an SV.
int sv_unmagic(SV *const sv, const int type)
=for hackers
Found in file sv.c
=item sv_unmagicext
X<sv_unmagicext>
Removes all magic of type C<type> with the specified C<vtbl> from an SV.
int sv_unmagicext(SV *const sv, const int type,
MGVTBL *vtbl)
=for hackers
Found in file sv.c
=item sv_unref_flags
X<sv_unref_flags>
Unsets the RV status of the SV, and decrements the reference count of
whatever was being referenced by the RV. This can almost be thought of
as a reversal of C<newSVrv>. The C<cflags> argument can contain
C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
(otherwise the decrementing is conditional on the reference count being
different from one or the reference being a readonly SV).
See C<L</SvROK_off>>.
void sv_unref_flags(SV *const ref, const U32 flags)
=for hackers
Found in file sv.c
=item sv_untaint
X<sv_untaint>
Untaint an SV. Use C<SvTAINTED_off> instead.
void sv_untaint(SV *const sv)
=for hackers
Found in file sv.c
=item sv_upgrade
X<sv_upgrade>
Upgrade an SV to a more complex form. Generally adds a new body type to the
SV, then copies across as much information as possible from the old body.
It croaks if the SV is already in a more complex form than requested. You
generally want to use the C<SvUPGRADE> macro wrapper, which checks the type
before calling C<sv_upgrade>, and hence does not croak. See also
C<L</svtype>>.
void sv_upgrade(SV *const sv, svtype new_type)
=for hackers
Found in file sv.c
=item sv_usepvn_flags
X<sv_usepvn_flags>
Tells an SV to use C<ptr> to find its string value. Normally the
string is stored inside the SV, but sv_usepvn allows the SV to use an
outside string. C<ptr> should point to memory that was allocated
by L<C<Newx>|perlclib/Memory Management and String Handling>. It must be
the start of a C<Newx>-ed block of memory, and not a pointer to the
middle of it (beware of L<C<OOK>|perlguts/Offsets> and copy-on-write),
and not be from a non-C<Newx> memory allocator like C<malloc>. The
string length, C<len>, must be supplied. By default this function
will C<Renew> (i.e. realloc, move) the memory pointed to by C<ptr>,
so that pointer should not be freed or used by the programmer after
giving it to C<sv_usepvn>, and neither should any pointers from "behind"
that pointer (e.g. ptr + 1) be used.
If S<C<flags & SV_SMAGIC>> is true, will call C<SvSETMAGIC>. If
S<C<flags> & SV_HAS_TRAILING_NUL>> is true, then C<ptr[len]> must be C<NUL>,
and the realloc
will be skipped (i.e. the buffer is actually at least 1 byte longer than
C<len>, and already meets the requirements for storing in C<SvPVX>).
void sv_usepvn_flags(SV *const sv, char* ptr,
const STRLEN len,
const U32 flags)
=for hackers
Found in file sv.c
=item sv_utf8_decode
X<sv_utf8_decode>
NOTE: this function is experimental and may change or be
removed without notice.
If the PV of the SV is an octet sequence in Perl's extended UTF-8
and contains a multiple-byte character, the C<SvUTF8> flag is turned on
so that it looks like a character. If the PV contains only single-byte
characters, the C<SvUTF8> flag stays off.
Scans PV for validity and returns FALSE if the PV is invalid UTF-8.
bool sv_utf8_decode(SV *const sv)
=for hackers
Found in file sv.c
=item sv_utf8_downgrade
X<sv_utf8_downgrade>
NOTE: this function is experimental and may change or be
removed without notice.
Attempts to convert the PV of an SV from characters to bytes.
If the PV contains a character that cannot fit
in a byte, this conversion will fail;
in this case, either returns false or, if C<fail_ok> is not
true, croaks.
This is not a general purpose Unicode to byte encoding interface:
use the C<Encode> extension for that.
bool sv_utf8_downgrade(SV *const sv,
const bool fail_ok)
=for hackers
Found in file sv.c
=item sv_utf8_encode
X<sv_utf8_encode>
Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
flag off so that it looks like octets again.
void sv_utf8_encode(SV *const sv)
=for hackers
Found in file sv.c
=item sv_utf8_upgrade
X<sv_utf8_upgrade>
Converts the PV of an SV to its UTF-8-encoded form.
Forces the SV to string form if it is not already.
Will C<mg_get> on C<sv> if appropriate.
Always sets the C<SvUTF8> flag to avoid future validity checks even
if the whole string is the same in UTF-8 as not.
Returns the number of bytes in the converted string
This is not a general purpose byte encoding to Unicode interface:
use the Encode extension for that.
STRLEN sv_utf8_upgrade(SV *sv)
=for hackers
Found in file sv.c
=item sv_utf8_upgrade_flags
X<sv_utf8_upgrade_flags>
Converts the PV of an SV to its UTF-8-encoded form.
Forces the SV to string form if it is not already.
Always sets the SvUTF8 flag to avoid future validity checks even
if all the bytes are invariant in UTF-8.
If C<flags> has C<SV_GMAGIC> bit set,
will C<mg_get> on C<sv> if appropriate, else not.
If C<flags> has C<SV_FORCE_UTF8_UPGRADE> set, this function assumes that the PV
will expand when converted to UTF-8, and skips the extra work of checking for
that. Typically this flag is used by a routine that has already parsed the
string and found such characters, and passes this information on so that the
work doesn't have to be repeated.
Returns the number of bytes in the converted string.
This is not a general purpose byte encoding to Unicode interface:
use the Encode extension for that.
STRLEN sv_utf8_upgrade_flags(SV *const sv,
const I32 flags)
=for hackers
Found in file sv.c
=item sv_utf8_upgrade_flags_grow
X<sv_utf8_upgrade_flags_grow>
Like C<sv_utf8_upgrade_flags>, but has an additional parameter C<extra>, which is
the number of unused bytes the string of C<sv> is guaranteed to have free after
it upon return. This allows the caller to reserve extra space that it intends
to fill, to avoid extra grows.
C<sv_utf8_upgrade>, C<sv_utf8_upgrade_nomg>, and C<sv_utf8_upgrade_flags>
are implemented in terms of this function.
Returns the number of bytes in the converted string (not including the spares).
STRLEN sv_utf8_upgrade_flags_grow(SV *const sv,
const I32 flags,
STRLEN extra)
=for hackers
Found in file sv.c
=item sv_utf8_upgrade_nomg
X<sv_utf8_upgrade_nomg>
Like C<sv_utf8_upgrade>, but doesn't do magic on C<sv>.
STRLEN sv_utf8_upgrade_nomg(SV *sv)
=for hackers
Found in file sv.c
=item sv_vcatpvf
X<sv_vcatpvf>
Processes its arguments like C<sv_catpvfn> called with a non-null C-style
variable argument list, and appends the formatted output
to an SV. Does not handle 'set' magic. See C<L</sv_vcatpvf_mg>>.
Usually used via its frontend C<sv_catpvf>.
void sv_vcatpvf(SV *const sv, const char *const pat,
va_list *const args)
=for hackers
Found in file sv.c
=item sv_vcatpvfn
X<sv_vcatpvfn>
void sv_vcatpvfn(SV *const sv, const char *const pat,
const STRLEN patlen,
va_list *const args,
SV **const svargs, const I32 svmax,
bool *const maybe_tainted)
=for hackers
Found in file sv.c
=item sv_vcatpvfn_flags
X<sv_vcatpvfn_flags>
Processes its arguments like C<vsprintf> and appends the formatted output
to an SV. Uses an array of SVs if the C-style variable argument list is
missing (C<NULL>). Argument reordering (using format specifiers like C<%2$d>
or C<%*2$d>) is supported only when using an array of SVs; using a C-style
C<va_list> argument list with a format string that uses argument reordering
will yield an exception.
When running with taint checks enabled, indicates via
C<maybe_tainted> if results are untrustworthy (often due to the use of
locales).
If called as C<sv_vcatpvfn> or flags has the C<SV_GMAGIC> bit set, calls get magic.
Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
void sv_vcatpvfn_flags(SV *const sv,
const char *const pat,
const STRLEN patlen,
va_list *const args,
SV **const svargs,
const I32 svmax,
bool *const maybe_tainted,
const U32 flags)
=for hackers
Found in file sv.c
=item sv_vcatpvf_mg
X<sv_vcatpvf_mg>
Like C<sv_vcatpvf>, but also handles 'set' magic.
Usually used via its frontend C<sv_catpvf_mg>.
void sv_vcatpvf_mg(SV *const sv,
const char *const pat,
va_list *const args)
=for hackers
Found in file sv.c
=item sv_vsetpvf
X<sv_vsetpvf>
Works like C<sv_vcatpvf> but copies the text into the SV instead of
appending it. Does not handle 'set' magic. See C<L</sv_vsetpvf_mg>>.
Usually used via its frontend C<sv_setpvf>.
void sv_vsetpvf(SV *const sv, const char *const pat,
va_list *const args)
=for hackers
Found in file sv.c
=item sv_vsetpvfn
X<sv_vsetpvfn>
Works like C<sv_vcatpvfn> but copies the text into the SV instead of
appending it.
Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
void sv_vsetpvfn(SV *const sv, const char *const pat,
const STRLEN patlen,
va_list *const args,
SV **const svargs, const I32 svmax,
bool *const maybe_tainted)
=for hackers
Found in file sv.c
=item sv_vsetpvf_mg
X<sv_vsetpvf_mg>
Like C<sv_vsetpvf>, but also handles 'set' magic.
Usually used via its frontend C<sv_setpvf_mg>.
void sv_vsetpvf_mg(SV *const sv,
const char *const pat,
va_list *const args)
=for hackers
Found in file sv.c
=back
=head1 SV Flags
=over 8
=item SVt_INVLIST
X<SVt_INVLIST>
Type flag for scalars. See L</svtype>.
=for hackers
Found in file sv.h
=item SVt_IV
X<SVt_IV>
Type flag for scalars. See L</svtype>.
=for hackers
Found in file sv.h
=item SVt_NULL
X<SVt_NULL>
Type flag for scalars. See L</svtype>.
=for hackers
Found in file sv.h
=item SVt_NV
X<SVt_NV>
Type flag for scalars. See L</svtype>.
=for hackers
Found in file sv.h
=item SVt_PV
X<SVt_PV>
Type flag for scalars. See L</svtype>.
=for hackers
Found in file sv.h
=item SVt_PVAV
X<SVt_PVAV>
Type flag for arrays. See L</svtype>.
=for hackers
Found in file sv.h
=item SVt_PVCV
X<SVt_PVCV>
Type flag for subroutines. See L</svtype>.
=for hackers
Found in file sv.h
=item SVt_PVFM
X<SVt_PVFM>
Type flag for formats. See L</svtype>.
=for hackers
Found in file sv.h
=item SVt_PVGV
X<SVt_PVGV>
Type flag for typeglobs. See L</svtype>.
=for hackers
Found in file sv.h
=item SVt_PVHV
X<SVt_PVHV>
Type flag for hashes. See L</svtype>.
=for hackers
Found in file sv.h
=item SVt_PVIO
X<SVt_PVIO>
Type flag for I/O objects. See L</svtype>.
=for hackers
Found in file sv.h
=item SVt_PVIV
X<SVt_PVIV>
Type flag for scalars. See L</svtype>.
=for hackers
Found in file sv.h
=item SVt_PVLV
X<SVt_PVLV>
Type flag for scalars. See L</svtype>.
=for hackers
Found in file sv.h
=item SVt_PVMG
X<SVt_PVMG>
Type flag for scalars. See L</svtype>.
=for hackers
Found in file sv.h
=item SVt_PVNV
X<SVt_PVNV>
Type flag for scalars. See L</svtype>.
=for hackers
Found in file sv.h
=item SVt_REGEXP
X<SVt_REGEXP>
Type flag for regular expressions. See L</svtype>.
=for hackers
Found in file sv.h
=item svtype
X<svtype>
An enum of flags for Perl types. These are found in the file F<sv.h>
in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
The types are:
SVt_NULL
SVt_IV
SVt_NV
SVt_RV
SVt_PV
SVt_PVIV
SVt_PVNV
SVt_PVMG
SVt_INVLIST
SVt_REGEXP
SVt_PVGV
SVt_PVLV
SVt_PVAV
SVt_PVHV
SVt_PVCV
SVt_PVFM
SVt_PVIO
These are most easily explained from the bottom up.
C<SVt_PVIO> is for I/O objects, C<SVt_PVFM> for formats, C<SVt_PVCV> for
subroutines, C<SVt_PVHV> for hashes and C<SVt_PVAV> for arrays.
All the others are scalar types, that is, things that can be bound to a
C<$> variable. For these, the internal types are mostly orthogonal to
types in the Perl language.
Hence, checking C<< SvTYPE(sv) < SVt_PVAV >> is the best way to see whether
something is a scalar.
C<SVt_PVGV> represents a typeglob. If C<!SvFAKE(sv)>, then it is a real,
incoercible typeglob. If C<SvFAKE(sv)>, then it is a scalar to which a
typeglob has been assigned. Assigning to it again will stop it from being
a typeglob. C<SVt_PVLV> represents a scalar that delegates to another scalar
behind the scenes. It is used, e.g., for the return value of C<substr> and
for tied hash and array elements. It can hold any scalar value, including
a typeglob. C<SVt_REGEXP> is for regular
expressions. C<SVt_INVLIST> is for Perl
core internal use only.
C<SVt_PVMG> represents a "normal" scalar (not a typeglob, regular expression,
or delegate). Since most scalars do not need all the internal fields of a
PVMG, we save memory by allocating smaller structs when possible. All the
other types are just simpler forms of C<SVt_PVMG>, with fewer internal fields.
C<SVt_NULL> can only hold undef. C<SVt_IV> can hold undef, an integer, or a
reference. (C<SVt_RV> is an alias for C<SVt_IV>, which exists for backward
compatibility.) C<SVt_NV> can hold any of those or a double. C<SVt_PV> can only
hold C<undef> or a string. C<SVt_PVIV> is a superset of C<SVt_PV> and C<SVt_IV>.
C<SVt_PVNV> is similar. C<SVt_PVMG> can hold anything C<SVt_PVNV> can hold, but it
can, but does not have to, be blessed or magical.
=for hackers
Found in file sv.h
=back
=head1 SV Manipulation Functions
=over 8
=item boolSV
X<boolSV>
Returns a true SV if C<b> is a true value, or a false SV if C<b> is 0.
See also C<L</PL_sv_yes>> and C<L</PL_sv_no>>.
SV * boolSV(bool b)
=for hackers
Found in file sv.h
=item croak_xs_usage
X<croak_xs_usage>
A specialised variant of C<croak()> for emitting the usage message for xsubs
croak_xs_usage(cv, "eee_yow");
works out the package name and subroutine name from C<cv>, and then calls
C<croak()>. Hence if C<cv> is C<&ouch::awk>, it would call C<croak> as:
Perl_croak(aTHX_ "Usage: %" SVf "::%" SVf "(%s)", "ouch" "awk",
"eee_yow");
void croak_xs_usage(const CV *const cv,
const char *const params)
=for hackers
Found in file universal.c
=item get_sv
X<get_sv>
Returns the SV of the specified Perl scalar. C<flags> are passed to
C<gv_fetchpv>. If C<GV_ADD> is set and the
Perl variable does not exist then it will be created. If C<flags> is zero
and the variable does not exist then NULL is returned.
NOTE: the perl_ form of this function is deprecated.
SV* get_sv(const char *name, I32 flags)
=for hackers
Found in file perl.c
=item newRV_inc
X<newRV_inc>
Creates an RV wrapper for an SV. The reference count for the original SV is
incremented.
SV* newRV_inc(SV* sv)
=for hackers
Found in file sv.h
=item newSVpadname
X<newSVpadname>
NOTE: this function is experimental and may change or be
removed without notice.
Creates a new SV containing the pad name.
SV* newSVpadname(PADNAME *pn)
=for hackers
Found in file sv.h
=item newSVpvn_utf8
X<newSVpvn_utf8>
Creates a new SV and copies a string (which may contain C<NUL> (C<\0>)
characters) into it. If C<utf8> is true, calls
C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
SV* newSVpvn_utf8(NULLOK const char* s, STRLEN len,
U32 utf8)
=for hackers
Found in file sv.h
=item sv_catpvn_nomg
X<sv_catpvn_nomg>
Like C<sv_catpvn> but doesn't process magic.
void sv_catpvn_nomg(SV* sv, const char* ptr,
STRLEN len)
=for hackers
Found in file sv.h
=item sv_catpv_nomg
X<sv_catpv_nomg>
Like C<sv_catpv> but doesn't process magic.
void sv_catpv_nomg(SV* sv, const char* ptr)
=for hackers
Found in file sv.h
=item sv_catsv_nomg
X<sv_catsv_nomg>
Like C<sv_catsv> but doesn't process magic.
void sv_catsv_nomg(SV* dsv, SV* ssv)
=for hackers
Found in file sv.h
=item SvCUR
X<SvCUR>
Returns the length of the string which is in the SV. See C<L</SvLEN>>.
STRLEN SvCUR(SV* sv)
=for hackers
Found in file sv.h
=item SvCUR_set
X<SvCUR_set>
Set the current length of the string which is in the SV. See C<L</SvCUR>>
and C<SvIV_set>>.
void SvCUR_set(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
=item sv_derived_from
X<sv_derived_from>
Exactly like L</sv_derived_from_pv>, but doesn't take a C<flags> parameter.
bool sv_derived_from(SV* sv, const char *const name)
=for hackers
Found in file universal.c
=item sv_derived_from_pv
X<sv_derived_from_pv>
Exactly like L</sv_derived_from_pvn>, but takes a nul-terminated string
instead of a string/length pair.
bool sv_derived_from_pv(SV* sv,
const char *const name,
U32 flags)
=for hackers
Found in file universal.c
=item sv_derived_from_pvn
X<sv_derived_from_pvn>
Returns a boolean indicating whether the SV is derived from the specified class
I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
normal Perl method.
Currently, the only significant value for C<flags> is SVf_UTF8.
bool sv_derived_from_pvn(SV* sv,
const char *const name,
const STRLEN len, U32 flags)
=for hackers
Found in file universal.c
=item sv_derived_from_sv
X<sv_derived_from_sv>
Exactly like L</sv_derived_from_pvn>, but takes the name string in the form
of an SV instead of a string/length pair.
bool sv_derived_from_sv(SV* sv, SV *namesv,
U32 flags)
=for hackers
Found in file universal.c
=item sv_does
X<sv_does>
Like L</sv_does_pv>, but doesn't take a C<flags> parameter.
bool sv_does(SV* sv, const char *const name)
=for hackers
Found in file universal.c
=item sv_does_pv
X<sv_does_pv>
Like L</sv_does_sv>, but takes a nul-terminated string instead of an SV.
bool sv_does_pv(SV* sv, const char *const name,
U32 flags)
=for hackers
Found in file universal.c
=item sv_does_pvn
X<sv_does_pvn>
Like L</sv_does_sv>, but takes a string/length pair instead of an SV.
bool sv_does_pvn(SV* sv, const char *const name,
const STRLEN len, U32 flags)
=for hackers
Found in file universal.c
=item sv_does_sv
X<sv_does_sv>
Returns a boolean indicating whether the SV performs a specific, named role.
The SV can be a Perl object or the name of a Perl class.
bool sv_does_sv(SV* sv, SV* namesv, U32 flags)
=for hackers
Found in file universal.c
=item SvEND
X<SvEND>
Returns a pointer to the spot just after the last character in
the string which is in the SV, where there is usually a trailing
C<NUL> character (even though Perl scalars do not strictly require it).
See C<L</SvCUR>>. Access the character as C<*(SvEND(sv))>.
Warning: If C<SvCUR> is equal to C<SvLEN>, then C<SvEND> points to
unallocated memory.
char* SvEND(SV* sv)
=for hackers
Found in file sv.h
=item SvGAMAGIC
X<SvGAMAGIC>
Returns true if the SV has get magic or
overloading. If either is true then
the scalar is active data, and has the potential to return a new value every
time it is accessed. Hence you must be careful to
only read it once per user logical operation and work
with that returned value. If neither is true then
the scalar's value cannot change unless written to.
U32 SvGAMAGIC(SV* sv)
=for hackers
Found in file sv.h
=item SvGROW
X<SvGROW>
Expands the character buffer in the SV so that it has room for the
indicated number of bytes (remember to reserve space for an extra trailing
C<NUL> character). Calls C<sv_grow> to perform the expansion if necessary.
Returns a pointer to the character
buffer. SV must be of type >= C<SVt_PV>. One
alternative is to call C<sv_grow> if you are not sure of the type of SV.
You might mistakenly think that C<len> is the number of bytes to add to the
existing size, but instead it is the total size C<sv> should be.
char * SvGROW(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
=item SvIOK
X<SvIOK>
Returns a U32 value indicating whether the SV contains an integer.
U32 SvIOK(SV* sv)
=for hackers
Found in file sv.h
=item SvIOK_notUV
X<SvIOK_notUV>
Returns a boolean indicating whether the SV contains a signed integer.
bool SvIOK_notUV(SV* sv)
=for hackers
Found in file sv.h
=item SvIOK_off
X<SvIOK_off>
Unsets the IV status of an SV.
void SvIOK_off(SV* sv)
=for hackers
Found in file sv.h
=item SvIOK_on
X<SvIOK_on>
Tells an SV that it is an integer.
void SvIOK_on(SV* sv)
=for hackers
Found in file sv.h
=item SvIOK_only
X<SvIOK_only>
Tells an SV that it is an integer and disables all other C<OK> bits.
void SvIOK_only(SV* sv)
=for hackers
Found in file sv.h
=item SvIOK_only_UV
X<SvIOK_only_UV>
Tells an SV that it is an unsigned integer and disables all other C<OK> bits.
void SvIOK_only_UV(SV* sv)
=for hackers
Found in file sv.h
=item SvIOKp
X<SvIOKp>
Returns a U32 value indicating whether the SV contains an integer. Checks
the B<private> setting. Use C<SvIOK> instead.
U32 SvIOKp(SV* sv)
=for hackers
Found in file sv.h
=item SvIOK_UV
X<SvIOK_UV>
Returns a boolean indicating whether the SV contains an integer that must be
interpreted as unsigned. A non-negative integer whose value is within the
range of both an IV and a UV may be be flagged as either C<SvUOK> or C<SVIOK>.
bool SvIOK_UV(SV* sv)
=for hackers
Found in file sv.h
=item SvIsCOW
X<SvIsCOW>
Returns a U32 value indicating whether the SV is Copy-On-Write (either shared
hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
COW).
U32 SvIsCOW(SV* sv)
=for hackers
Found in file sv.h
=item SvIsCOW_shared_hash
X<SvIsCOW_shared_hash>
Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
scalar.
bool SvIsCOW_shared_hash(SV* sv)
=for hackers
Found in file sv.h
=item SvIV
X<SvIV>
Coerces the given SV to IV and returns it. The returned value in many
circumstances will get stored in C<sv>'s IV slot, but not in all cases. (Use
C<L</sv_setiv>> to make sure it does).
See C<L</SvIVx>> for a version which guarantees to evaluate C<sv> only once.
IV SvIV(SV* sv)
=for hackers
Found in file sv.h
=item SvIV_nomg
X<SvIV_nomg>
Like C<SvIV> but doesn't process magic.
IV SvIV_nomg(SV* sv)
=for hackers
Found in file sv.h
=item SvIV_set
X<SvIV_set>
Set the value of the IV pointer in sv to val. It is possible to perform
the same function of this macro with an lvalue assignment to C<SvIVX>.
With future Perls, however, it will be more efficient to use
C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
void SvIV_set(SV* sv, IV val)
=for hackers
Found in file sv.h
=item SvIVX
X<SvIVX>
Returns the raw value in the SV's IV slot, without checks or conversions.
Only use when you are sure C<SvIOK> is true. See also C<L</SvIV>>.
IV SvIVX(SV* sv)
=for hackers
Found in file sv.h
=item SvIVx
X<SvIVx>
Coerces the given SV to IV and returns it. The returned value in many
circumstances will get stored in C<sv>'s IV slot, but not in all cases. (Use
C<L</sv_setiv>> to make sure it does).
This form guarantees to evaluate C<sv> only once. Only use this if C<sv> is an
expression with side effects, otherwise use the more efficient C<SvIV>.
IV SvIVx(SV* sv)
=for hackers
Found in file sv.h
=item SvLEN
X<SvLEN>
Returns the size of the string buffer in the SV, not including any part
attributable to C<SvOOK>. See C<L</SvCUR>>.
STRLEN SvLEN(SV* sv)
=for hackers
Found in file sv.h
=item SvLEN_set
X<SvLEN_set>
Set the size of the string buffer for the SV. See C<L</SvLEN>>.
void SvLEN_set(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
=item SvMAGIC_set
X<SvMAGIC_set>
Set the value of the MAGIC pointer in C<sv> to val. See C<L</SvIV_set>>.
void SvMAGIC_set(SV* sv, MAGIC* val)
=for hackers
Found in file sv.h
=item SvNIOK
X<SvNIOK>
Returns a U32 value indicating whether the SV contains a number, integer or
double.
U32 SvNIOK(SV* sv)
=for hackers
Found in file sv.h
=item SvNIOK_off
X<SvNIOK_off>
Unsets the NV/IV status of an SV.
void SvNIOK_off(SV* sv)
=for hackers
Found in file sv.h
=item SvNIOKp
X<SvNIOKp>
Returns a U32 value indicating whether the SV contains a number, integer or
double. Checks the B<private> setting. Use C<SvNIOK> instead.
U32 SvNIOKp(SV* sv)
=for hackers
Found in file sv.h
=item SvNOK
X<SvNOK>
Returns a U32 value indicating whether the SV contains a double.
U32 SvNOK(SV* sv)
=for hackers
Found in file sv.h
=item SvNOK_off
X<SvNOK_off>
Unsets the NV status of an SV.
void SvNOK_off(SV* sv)
=for hackers
Found in file sv.h
=item SvNOK_on
X<SvNOK_on>
Tells an SV that it is a double.
void SvNOK_on(SV* sv)
=for hackers
Found in file sv.h
=item SvNOK_only
X<SvNOK_only>
Tells an SV that it is a double and disables all other OK bits.
void SvNOK_only(SV* sv)
=for hackers
Found in file sv.h
=item SvNOKp
X<SvNOKp>
Returns a U32 value indicating whether the SV contains a double. Checks the
B<private> setting. Use C<SvNOK> instead.
U32 SvNOKp(SV* sv)
=for hackers
Found in file sv.h
=item SvNV
X<SvNV>
Coerces the given SV to NV and returns it. The returned value in many
circumstances will get stored in C<sv>'s NV slot, but not in all cases. (Use
C<L</sv_setnv>> to make sure it does).
See C<L</SvNVx>> for a version which guarantees to evaluate C<sv> only once.
NV SvNV(SV* sv)
=for hackers
Found in file sv.h
=item SvNV_nomg
X<SvNV_nomg>
Like C<SvNV> but doesn't process magic.
NV SvNV_nomg(SV* sv)
=for hackers
Found in file sv.h
=item SvNV_set
X<SvNV_set>
Set the value of the NV pointer in C<sv> to val. See C<L</SvIV_set>>.
void SvNV_set(SV* sv, NV val)
=for hackers
Found in file sv.h
=item SvNVX
X<SvNVX>
Returns the raw value in the SV's NV slot, without checks or conversions.
Only use when you are sure C<SvNOK> is true. See also C<L</SvNV>>.
NV SvNVX(SV* sv)
=for hackers
Found in file sv.h
=item SvNVx
X<SvNVx>
Coerces the given SV to NV and returns it. The returned value in many
circumstances will get stored in C<sv>'s NV slot, but not in all cases. (Use
C<L</sv_setnv>> to make sure it does).
This form guarantees to evaluate C<sv> only once. Only use this if C<sv> is an
expression with side effects, otherwise use the more efficient C<SvNV>.
NV SvNVx(SV* sv)
=for hackers
Found in file sv.h
=item SvOK
X<SvOK>
Returns a U32 value indicating whether the value is defined. This is
only meaningful for scalars.
U32 SvOK(SV* sv)
=for hackers
Found in file sv.h
=item SvOOK
X<SvOOK>
Returns a U32 indicating whether the pointer to the string buffer is offset.
This hack is used internally to speed up removal of characters from the
beginning of a C<SvPV>. When C<SvOOK> is true, then the start of the
allocated string buffer is actually C<SvOOK_offset()> bytes before C<SvPVX>.
This offset used to be stored in C<SvIVX>, but is now stored within the spare
part of the buffer.
U32 SvOOK(SV* sv)
=for hackers
Found in file sv.h
=item SvOOK_offset
X<SvOOK_offset>
Reads into C<len> the offset from C<SvPVX> back to the true start of the
allocated buffer, which will be non-zero if C<sv_chop> has been used to
efficiently remove characters from start of the buffer. Implemented as a
macro, which takes the address of C<len>, which must be of type C<STRLEN>.
Evaluates C<sv> more than once. Sets C<len> to 0 if C<SvOOK(sv)> is false.
void SvOOK_offset(NN SV*sv, STRLEN len)
=for hackers
Found in file sv.h
=item SvPOK
X<SvPOK>
Returns a U32 value indicating whether the SV contains a character
string.
U32 SvPOK(SV* sv)
=for hackers
Found in file sv.h
=item SvPOK_off
X<SvPOK_off>
Unsets the PV status of an SV.
void SvPOK_off(SV* sv)
=for hackers
Found in file sv.h
=item SvPOK_on
X<SvPOK_on>
Tells an SV that it is a string.
void SvPOK_on(SV* sv)
=for hackers
Found in file sv.h
=item SvPOK_only
X<SvPOK_only>
Tells an SV that it is a string and disables all other C<OK> bits.
Will also turn off the UTF-8 status.
void SvPOK_only(SV* sv)
=for hackers
Found in file sv.h
=item SvPOK_only_UTF8
X<SvPOK_only_UTF8>
Tells an SV that it is a string and disables all other C<OK> bits,
and leaves the UTF-8 status as it was.
void SvPOK_only_UTF8(SV* sv)
=for hackers
Found in file sv.h
=item SvPOKp
X<SvPOKp>
Returns a U32 value indicating whether the SV contains a character string.
Checks the B<private> setting. Use C<SvPOK> instead.
U32 SvPOKp(SV* sv)
=for hackers
Found in file sv.h
=item SvPV
X<SvPV>
Returns a pointer to the string in the SV, or a stringified form of
the SV if the SV does not contain a string. The SV may cache the
stringified version becoming C<SvPOK>. Handles 'get' magic. The
C<len> variable will be set to the length of the string (this is a macro, so
don't use C<&len>). See also C<L</SvPVx>> for a version which guarantees to
evaluate C<sv> only once.
Note that there is no guarantee that the return value of C<SvPV()> is
equal to C<SvPVX(sv)>, or that C<SvPVX(sv)> contains valid data, or that
successive calls to C<SvPV(sv)> will return the same pointer value each
time. This is due to the way that things like overloading and
Copy-On-Write are handled. In these cases, the return value may point to
a temporary buffer or similar. If you absolutely need the C<SvPVX> field to
be valid (for example, if you intend to write to it), then see
C<L</SvPV_force>>.
char* SvPV(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
=item SvPVbyte
X<SvPVbyte>
Like C<SvPV>, but converts C<sv> to byte representation first if necessary.
char* SvPVbyte(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
=item SvPVbyte_force
X<SvPVbyte_force>
Like C<SvPV_force>, but converts C<sv> to byte representation first if necessary.
char* SvPVbyte_force(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
=item SvPVbyte_nolen
X<SvPVbyte_nolen>
Like C<SvPV_nolen>, but converts C<sv> to byte representation first if necessary.
char* SvPVbyte_nolen(SV* sv)
=for hackers
Found in file sv.h
=item SvPVbytex
X<SvPVbytex>
Like C<SvPV>, but converts C<sv> to byte representation first if necessary.
Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVbyte>
otherwise.
char* SvPVbytex(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
=item SvPVbytex_force
X<SvPVbytex_force>
Like C<SvPV_force>, but converts C<sv> to byte representation first if necessary.
Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVbyte_force>
otherwise.
char* SvPVbytex_force(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
=item SvPVCLEAR
X<SvPVCLEAR>
Ensures that sv is a SVt_PV and that its SvCUR is 0, and that it is
properly null terminated. Equivalent to sv_setpvs(""), but more efficient.
char * SvPVCLEAR(SV* sv)
=for hackers
Found in file sv.h
=item SvPV_force
X<SvPV_force>
Like C<SvPV> but will force the SV into containing a string (C<SvPOK>), and
only a string (C<SvPOK_only>), by hook or by crook. You need force if you are
going to update the C<SvPVX> directly. Processes get magic.
Note that coercing an arbitrary scalar into a plain PV will potentially
strip useful data from it. For example if the SV was C<SvROK>, then the
referent will have its reference count decremented, and the SV itself may
be converted to an C<SvPOK> scalar with a string buffer containing a value
such as C<"ARRAY(0x1234)">.
char* SvPV_force(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
=item SvPV_force_nomg
X<SvPV_force_nomg>
Like C<SvPV_force>, but doesn't process get magic.
char* SvPV_force_nomg(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
=item SvPV_nolen
X<SvPV_nolen>
Like C<SvPV> but doesn't set a length variable.
char* SvPV_nolen(SV* sv)
=for hackers
Found in file sv.h
=item SvPV_nomg
X<SvPV_nomg>
Like C<SvPV> but doesn't process magic.
char* SvPV_nomg(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
=item SvPV_nomg_nolen
X<SvPV_nomg_nolen>
Like C<SvPV_nolen> but doesn't process magic.
char* SvPV_nomg_nolen(SV* sv)
=for hackers
Found in file sv.h
=item SvPV_set
X<SvPV_set>
This is probably not what you want to use, you probably wanted
L</sv_usepvn_flags> or L</sv_setpvn> or L</sv_setpvs>.
Set the value of the PV pointer in C<sv> to the Perl allocated
C<NUL>-terminated string C<val>. See also C<L</SvIV_set>>.
Remember to free the previous PV buffer. There are many things to check.
Beware that the existing pointer may be involved in copy-on-write or other
mischief, so do C<SvOOK_off(sv)> and use C<sv_force_normal> or
C<SvPV_force> (or check the C<SvIsCOW> flag) first to make sure this
modification is safe. Then finally, if it is not a COW, call C<SvPV_free> to
free the previous PV buffer.
void SvPV_set(SV* sv, char* val)
=for hackers
Found in file sv.h
=item SvPVutf8
X<SvPVutf8>
Like C<SvPV>, but converts C<sv> to UTF-8 first if necessary.
char* SvPVutf8(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
=item SvPVutf8x
X<SvPVutf8x>
Like C<SvPV>, but converts C<sv> to UTF-8 first if necessary.
Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVutf8>
otherwise.
char* SvPVutf8x(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
=item SvPVutf8x_force
X<SvPVutf8x_force>
Like C<SvPV_force>, but converts C<sv> to UTF-8 first if necessary.
Guarantees to evaluate C<sv> only once; use the more efficient C<SvPVutf8_force>
otherwise.
char* SvPVutf8x_force(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
=item SvPVutf8_force
X<SvPVutf8_force>
Like C<SvPV_force>, but converts C<sv> to UTF-8 first if necessary.
char* SvPVutf8_force(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
=item SvPVutf8_nolen
X<SvPVutf8_nolen>
Like C<SvPV_nolen>, but converts C<sv> to UTF-8 first if necessary.
char* SvPVutf8_nolen(SV* sv)
=for hackers
Found in file sv.h
=item SvPVX
X<SvPVX>
Returns a pointer to the physical string in the SV. The SV must contain a
string. Prior to 5.9.3 it is not safe
to execute this macro unless the SV's
type >= C<SVt_PV>.
This is also used to store the name of an autoloaded subroutine in an XS
AUTOLOAD routine. See L<perlguts/Autoloading with XSUBs>.
char* SvPVX(SV* sv)
=for hackers
Found in file sv.h
=item SvPVx
X<SvPVx>
A version of C<SvPV> which guarantees to evaluate C<sv> only once.
Only use this if C<sv> is an expression with side effects, otherwise use the
more efficient C<SvPV>.
char* SvPVx(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
=item SvREADONLY
X<SvREADONLY>
Returns true if the argument is readonly, otherwise returns false.
Exposed to to perl code via Internals::SvREADONLY().
U32 SvREADONLY(SV* sv)
=for hackers
Found in file sv.h
=item SvREADONLY_off
X<SvREADONLY_off>
Mark an object as not-readonly. Exactly what this mean depends on the
object type. Exposed to perl code via Internals::SvREADONLY().
U32 SvREADONLY_off(SV* sv)
=for hackers
Found in file sv.h
=item SvREADONLY_on
X<SvREADONLY_on>
Mark an object as readonly. Exactly what this means depends on the object
type. Exposed to perl code via Internals::SvREADONLY().
U32 SvREADONLY_on(SV* sv)
=for hackers
Found in file sv.h
=item SvREFCNT
X<SvREFCNT>
Returns the value of the object's reference count. Exposed
to perl code via Internals::SvREFCNT().
U32 SvREFCNT(SV* sv)
=for hackers
Found in file sv.h
=item SvREFCNT_dec
X<SvREFCNT_dec>
Decrements the reference count of the given SV. C<sv> may be C<NULL>.
void SvREFCNT_dec(SV* sv)
=for hackers
Found in file sv.h
=item SvREFCNT_dec_NN
X<SvREFCNT_dec_NN>
Same as C<SvREFCNT_dec>, but can only be used if you know C<sv>
is not C<NULL>. Since we don't have to check the NULLness, it's faster
and smaller.
void SvREFCNT_dec_NN(SV* sv)
=for hackers
Found in file sv.h
=item SvREFCNT_inc
X<SvREFCNT_inc>
Increments the reference count of the given SV, returning the SV.
All of the following C<SvREFCNT_inc>* macros are optimized versions of
C<SvREFCNT_inc>, and can be replaced with C<SvREFCNT_inc>.
SV* SvREFCNT_inc(SV* sv)
=for hackers
Found in file sv.h
=item SvREFCNT_inc_NN
X<SvREFCNT_inc_NN>
Same as C<SvREFCNT_inc>, but can only be used if you know C<sv>
is not C<NULL>. Since we don't have to check the NULLness, it's faster
and smaller.
SV* SvREFCNT_inc_NN(SV* sv)
=for hackers
Found in file sv.h
=item SvREFCNT_inc_simple
X<SvREFCNT_inc_simple>
Same as C<SvREFCNT_inc>, but can only be used with expressions without side
effects. Since we don't have to store a temporary value, it's faster.
SV* SvREFCNT_inc_simple(SV* sv)
=for hackers
Found in file sv.h
=item SvREFCNT_inc_simple_NN
X<SvREFCNT_inc_simple_NN>
Same as C<SvREFCNT_inc_simple>, but can only be used if you know C<sv>
is not C<NULL>. Since we don't have to check the NULLness, it's faster
and smaller.
SV* SvREFCNT_inc_simple_NN(SV* sv)
=for hackers
Found in file sv.h
=item SvREFCNT_inc_simple_void
X<SvREFCNT_inc_simple_void>
Same as C<SvREFCNT_inc_simple>, but can only be used if you don't need the
return value. The macro doesn't need to return a meaningful value.
void SvREFCNT_inc_simple_void(SV* sv)
=for hackers
Found in file sv.h
=item SvREFCNT_inc_simple_void_NN
X<SvREFCNT_inc_simple_void_NN>
Same as C<SvREFCNT_inc>, but can only be used if you don't need the return
value, and you know that C<sv> is not C<NULL>. The macro doesn't need
to return a meaningful value, or check for NULLness, so it's smaller
and faster.
void SvREFCNT_inc_simple_void_NN(SV* sv)
=for hackers
Found in file sv.h
=item SvREFCNT_inc_void
X<SvREFCNT_inc_void>
Same as C<SvREFCNT_inc>, but can only be used if you don't need the
return value. The macro doesn't need to return a meaningful value.
void SvREFCNT_inc_void(SV* sv)
=for hackers
Found in file sv.h
=item SvREFCNT_inc_void_NN
X<SvREFCNT_inc_void_NN>
Same as C<SvREFCNT_inc>, but can only be used if you don't need the return
value, and you know that C<sv> is not C<NULL>. The macro doesn't need
to return a meaningful value, or check for NULLness, so it's smaller
and faster.
void SvREFCNT_inc_void_NN(SV* sv)
=for hackers
Found in file sv.h
=item sv_report_used
X<sv_report_used>
Dump the contents of all SVs not yet freed (debugging aid).
void sv_report_used()
=for hackers
Found in file sv.c
=item SvROK
X<SvROK>
Tests if the SV is an RV.
U32 SvROK(SV* sv)
=for hackers
Found in file sv.h
=item SvROK_off
X<SvROK_off>
Unsets the RV status of an SV.
void SvROK_off(SV* sv)
=for hackers
Found in file sv.h
=item SvROK_on
X<SvROK_on>
Tells an SV that it is an RV.
void SvROK_on(SV* sv)
=for hackers
Found in file sv.h
=item SvRV
X<SvRV>
Dereferences an RV to return the SV.
SV* SvRV(SV* sv)
=for hackers
Found in file sv.h
=item SvRV_set
X<SvRV_set>
Set the value of the RV pointer in C<sv> to val. See C<L</SvIV_set>>.
void SvRV_set(SV* sv, SV* val)
=for hackers
Found in file sv.h
=item sv_setsv_nomg
X<sv_setsv_nomg>
Like C<sv_setsv> but doesn't process magic.
void sv_setsv_nomg(SV* dsv, SV* ssv)
=for hackers
Found in file sv.h
=item SvSTASH
X<SvSTASH>
Returns the stash of the SV.
HV* SvSTASH(SV* sv)
=for hackers
Found in file sv.h
=item SvSTASH_set
X<SvSTASH_set>
Set the value of the STASH pointer in C<sv> to val. See C<L</SvIV_set>>.
void SvSTASH_set(SV* sv, HV* val)
=for hackers
Found in file sv.h
=item SvTAINT
X<SvTAINT>
Taints an SV if tainting is enabled, and if some input to the current
expression is tainted--usually a variable, but possibly also implicit
inputs such as locale settings. C<SvTAINT> propagates that taintedness to
the outputs of an expression in a pessimistic fashion; i.e., without paying
attention to precisely which outputs are influenced by which inputs.
void SvTAINT(SV* sv)
=for hackers
Found in file sv.h
=item SvTAINTED
X<SvTAINTED>
Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
not.
bool SvTAINTED(SV* sv)
=for hackers
Found in file sv.h
=item SvTAINTED_off
X<SvTAINTED_off>
Untaints an SV. Be I<very> careful with this routine, as it short-circuits
some of Perl's fundamental security features. XS module authors should not
use this function unless they fully understand all the implications of
unconditionally untainting the value. Untainting should be done in the
standard perl fashion, via a carefully crafted regexp, rather than directly
untainting variables.
void SvTAINTED_off(SV* sv)
=for hackers
Found in file sv.h
=item SvTAINTED_on
X<SvTAINTED_on>
Marks an SV as tainted if tainting is enabled.
void SvTAINTED_on(SV* sv)
=for hackers
Found in file sv.h
=item SvTRUE
X<SvTRUE>
Returns a boolean indicating whether Perl would evaluate the SV as true or
false. See C<L</SvOK>> for a defined/undefined test. Handles 'get' magic
unless the scalar is already C<SvPOK>, C<SvIOK> or C<SvNOK> (the public, not the
private flags).
bool SvTRUE(SV* sv)
=for hackers
Found in file sv.h
=item SvTRUE_nomg
X<SvTRUE_nomg>
Returns a boolean indicating whether Perl would evaluate the SV as true or
false. See C<L</SvOK>> for a defined/undefined test. Does not handle 'get' magic.
bool SvTRUE_nomg(SV* sv)
=for hackers
Found in file sv.h
=item SvTYPE
X<SvTYPE>
Returns the type of the SV. See C<L</svtype>>.
svtype SvTYPE(SV* sv)
=for hackers
Found in file sv.h
=item SvUOK
X<SvUOK>
Returns a boolean indicating whether the SV contains an integer that must be
interpreted as unsigned. A non-negative integer whose value is within the
range of both an IV and a UV may be be flagged as either C<SvUOK> or C<SVIOK>.
bool SvUOK(SV* sv)
=for hackers
Found in file sv.h
=item SvUPGRADE
X<SvUPGRADE>
Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
perform the upgrade if necessary. See C<L</svtype>>.
void SvUPGRADE(SV* sv, svtype type)
=for hackers
Found in file sv.h
=item SvUTF8
X<SvUTF8>
Returns a U32 value indicating the UTF-8 status of an SV. If things are set-up
properly, this indicates whether or not the SV contains UTF-8 encoded data.
You should use this I<after> a call to C<SvPV()> or one of its variants, in
case any call to string overloading updates the internal flag.
If you want to take into account the L<bytes> pragma, use C<L</DO_UTF8>>
instead.
U32 SvUTF8(SV* sv)
=for hackers
Found in file sv.h
=item sv_utf8_upgrade_nomg
X<sv_utf8_upgrade_nomg>
Like C<sv_utf8_upgrade>, but doesn't do magic on C<sv>.
STRLEN sv_utf8_upgrade_nomg(NN SV *sv)
=for hackers
Found in file sv.h
=item SvUTF8_off
X<SvUTF8_off>
Unsets the UTF-8 status of an SV (the data is not changed, just the flag).
Do not use frivolously.
void SvUTF8_off(SV *sv)
=for hackers
Found in file sv.h
=item SvUTF8_on
X<SvUTF8_on>
Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
Do not use frivolously.
void SvUTF8_on(SV *sv)
=for hackers
Found in file sv.h
=item SvUV
X<SvUV>
Coerces the given SV to UV and returns it. The returned value in many
circumstances will get stored in C<sv>'s UV slot, but not in all cases. (Use
C<L</sv_setuv>> to make sure it does).
See C<L</SvUVx>> for a version which guarantees to evaluate C<sv> only once.
UV SvUV(SV* sv)
=for hackers
Found in file sv.h
=item SvUV_nomg
X<SvUV_nomg>
Like C<SvUV> but doesn't process magic.
UV SvUV_nomg(SV* sv)
=for hackers
Found in file sv.h
=item SvUV_set
X<SvUV_set>
Set the value of the UV pointer in C<sv> to val. See C<L</SvIV_set>>.
void SvUV_set(SV* sv, UV val)
=for hackers
Found in file sv.h
=item SvUVX
X<SvUVX>
Returns the raw value in the SV's UV slot, without checks or conversions.
Only use when you are sure C<SvIOK> is true. See also C<L</SvUV>>.
UV SvUVX(SV* sv)
=for hackers
Found in file sv.h
=item SvUVx
X<SvUVx>
Coerces the given SV to UV and returns it. The returned value in many
circumstances will get stored in C<sv>'s UV slot, but not in all cases. (Use
C<L</sv_setuv>> to make sure it does).
This form guarantees to evaluate C<sv> only once. Only use this if C<sv> is an
expression with side effects, otherwise use the more efficient C<SvUV>.
UV SvUVx(SV* sv)
=for hackers
Found in file sv.h
=item SvVOK
X<SvVOK>
Returns a boolean indicating whether the SV contains a v-string.
bool SvVOK(SV* sv)
=for hackers
Found in file sv.h
=back
=head1 Unicode Support
L<perlguts/Unicode Support> has an introduction to this API.
See also L</Character classification>,
and L</Character case changing>.
Various functions outside this section also work specially with Unicode.
Search for the string "utf8" in this document.
=over 8
=item BOM_UTF8
X<BOM_UTF8>
This is a macro that evaluates to a string constant of the UTF-8 bytes that
define the Unicode BYTE ORDER MARK (U+FEFF) for the platform that perl
is compiled on. This allows code to use a mnemonic for this character that
works on both ASCII and EBCDIC platforms.
S<C<sizeof(BOM_UTF8) - 1>> can be used to get its length in
bytes.
=for hackers
Found in file unicode_constants.h
=item bytes_cmp_utf8
X<bytes_cmp_utf8>
Compares the sequence of characters (stored as octets) in C<b>, C<blen> with the
sequence of characters (stored as UTF-8)
in C<u>, C<ulen>. Returns 0 if they are
equal, -1 or -2 if the first string is less than the second string, +1 or +2
if the first string is greater than the second string.
-1 or +1 is returned if the shorter string was identical to the start of the
longer string. -2 or +2 is returned if
there was a difference between characters
within the strings.
int bytes_cmp_utf8(const U8 *b, STRLEN blen,
const U8 *u, STRLEN ulen)
=for hackers
Found in file utf8.c
=item bytes_from_utf8
X<bytes_from_utf8>
NOTE: this function is experimental and may change or be
removed without notice.
Converts a string C<s> of length C<len> from UTF-8 into native byte encoding.
Unlike L</utf8_to_bytes> but like L</bytes_to_utf8>, returns a pointer to
the newly-created string, and updates C<len> to contain the new
length. Returns the original string if no conversion occurs, C<len>
is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
0 if C<s> is converted or consisted entirely of characters that are invariant
in UTF-8 (i.e., US-ASCII on non-EBCDIC machines).
U8* bytes_from_utf8(const U8 *s, STRLEN *len,
bool *is_utf8)
=for hackers
Found in file utf8.c
=item bytes_to_utf8
X<bytes_to_utf8>
NOTE: this function is experimental and may change or be
removed without notice.
Converts a string C<s> of length C<len> bytes from the native encoding into
UTF-8.
Returns a pointer to the newly-created string, and sets C<len> to
reflect the new length in bytes.
A C<NUL> character will be written after the end of the string.
If you want to convert to UTF-8 from encodings other than
the native (Latin1 or EBCDIC),
see L</sv_recode_to_utf8>().
U8* bytes_to_utf8(const U8 *s, STRLEN *len)
=for hackers
Found in file utf8.c
=item DO_UTF8
X<DO_UTF8>
Returns a bool giving whether or not the PV in C<sv> is to be treated as being
encoded in UTF-8.
You should use this I<after> a call to C<SvPV()> or one of its variants, in
case any call to string overloading updates the internal UTF-8 encoding flag.
bool DO_UTF8(SV* sv)
=for hackers
Found in file utf8.h
=item foldEQ_utf8
X<foldEQ_utf8>
Returns true if the leading portions of the strings C<s1> and C<s2> (either or both
of which may be in UTF-8) are the same case-insensitively; false otherwise.
How far into the strings to compare is determined by other input parameters.
If C<u1> is true, the string C<s1> is assumed to be in UTF-8-encoded Unicode;
otherwise it is assumed to be in native 8-bit encoding. Correspondingly for C<u2>
with respect to C<s2>.
If the byte length C<l1> is non-zero, it says how far into C<s1> to check for fold
equality. In other words, C<s1>+C<l1> will be used as a goal to reach. The
scan will not be considered to be a match unless the goal is reached, and
scanning won't continue past that goal. Correspondingly for C<l2> with respect to
C<s2>.
If C<pe1> is non-C<NULL> and the pointer it points to is not C<NULL>, that pointer is
considered an end pointer to the position 1 byte past the maximum point
in C<s1> beyond which scanning will not continue under any circumstances.
(This routine assumes that UTF-8 encoded input strings are not malformed;
malformed input can cause it to read past C<pe1>).
This means that if both C<l1> and C<pe1> are specified, and C<pe1>
is less than C<s1>+C<l1>, the match will never be successful because it can
never
get as far as its goal (and in fact is asserted against). Correspondingly for
C<pe2> with respect to C<s2>.
At least one of C<s1> and C<s2> must have a goal (at least one of C<l1> and
C<l2> must be non-zero), and if both do, both have to be
reached for a successful match. Also, if the fold of a character is multiple
characters, all of them must be matched (see tr21 reference below for
'folding').
Upon a successful match, if C<pe1> is non-C<NULL>,
it will be set to point to the beginning of the I<next> character of C<s1>
beyond what was matched. Correspondingly for C<pe2> and C<s2>.
For case-insensitiveness, the "casefolding" of Unicode is used
instead of upper/lowercasing both the characters, see
L<http://www.unicode.org/unicode/reports/tr21/> (Case Mappings).
I32 foldEQ_utf8(const char *s1, char **pe1, UV l1,
bool u1, const char *s2, char **pe2,
UV l2, bool u2)
=for hackers
Found in file utf8.c
=item is_ascii_string
X<is_ascii_string>
This is a misleadingly-named synonym for L</is_utf8_invariant_string>.
On ASCII-ish platforms, the name isn't misleading: the ASCII-range characters
are exactly the UTF-8 invariants. But EBCDIC machines have more invariants
than just the ASCII characters, so C<is_utf8_invariant_string> is preferred.
bool is_ascii_string(const U8* const s,
const STRLEN len)
=for hackers
Found in file utf8.h
=item is_c9strict_utf8_string
X<is_c9strict_utf8_string>
Returns TRUE if the first C<len> bytes of string C<s> form a valid
UTF-8-encoded string that conforms to
L<Unicode Corrigendum #9|http://www.unicode.org/versions/corrigendum9.html>;
otherwise it returns FALSE. If C<len> is 0, it will be calculated using
C<strlen(s)> (which means if you use this option, that C<s> can't have embedded
C<NUL> characters and has to have a terminating C<NUL> byte). Note that all
characters being ASCII constitute 'a valid UTF-8 string'.
This function returns FALSE for strings containing any code points above the
Unicode max of 0x10FFFF or surrogate code points, but accepts non-character
code points per
L<Corrigendum #9|http://www.unicode.org/versions/corrigendum9.html>.
See also
C<L</is_utf8_invariant_string>>,
C<L</is_utf8_string>>,
C<L</is_utf8_string_flags>>,
C<L</is_utf8_string_loc>>,
C<L</is_utf8_string_loc_flags>>,
C<L</is_utf8_string_loclen>>,
C<L</is_utf8_string_loclen_flags>>,
C<L</is_utf8_fixed_width_buf_flags>>,
C<L</is_utf8_fixed_width_buf_loc_flags>>,
C<L</is_utf8_fixed_width_buf_loclen_flags>>,
C<L</is_strict_utf8_string>>,
C<L</is_strict_utf8_string_loc>>,
C<L</is_strict_utf8_string_loclen>>,
C<L</is_c9strict_utf8_string_loc>>,
and
C<L</is_c9strict_utf8_string_loclen>>.
bool is_c9strict_utf8_string(const U8 *s,
const STRLEN len)
=for hackers
Found in file inline.h
=item is_c9strict_utf8_string_loc
X<is_c9strict_utf8_string_loc>
Like C<L</is_c9strict_utf8_string>> but stores the location of the failure (in
the case of "utf8ness failure") or the location C<s>+C<len> (in the case of
"utf8ness success") in the C<ep> pointer.
See also C<L</is_c9strict_utf8_string_loclen>>.
bool is_c9strict_utf8_string_loc(const U8 *s,
const STRLEN len,
const U8 **ep)
=for hackers
Found in file inline.h
=item is_c9strict_utf8_string_loclen
X<is_c9strict_utf8_string_loclen>
Like C<L</is_c9strict_utf8_string>> but stores the location of the failure (in
the case of "utf8ness failure") or the location C<s>+C<len> (in the case of
"utf8ness success") in the C<ep> pointer, and the number of UTF-8 encoded
characters in the C<el> pointer.
See also C<L</is_c9strict_utf8_string_loc>>.
bool is_c9strict_utf8_string_loclen(
const U8 *s, const STRLEN len,
const U8 **ep, STRLEN *el
)
=for hackers
Found in file inline.h
=item isC9_STRICT_UTF8_CHAR
X<isC9_STRICT_UTF8_CHAR>
Evaluates to non-zero if the first few bytes of the string starting at C<s> and
looking no further than S<C<e - 1>> are well-formed UTF-8 that represents some
Unicode non-surrogate code point; otherwise it evaluates to 0. If non-zero,
the value gives how many bytes starting at C<s> comprise the code point's
representation. Any bytes remaining before C<e>, but beyond the ones needed to
form the first code point in C<s>, are not examined.
The largest acceptable code point is the Unicode maximum 0x10FFFF. This
differs from C<L</isSTRICT_UTF8_CHAR>> only in that it accepts non-character
code points. This corresponds to
L<Unicode Corrigendum #9|http://www.unicode.org/versions/corrigendum9.html>.
which said that non-character code points are merely discouraged rather than
completely forbidden in open interchange. See
L<perlunicode/Noncharacter code points>.
Use C<L</isUTF8_CHAR>> to check for Perl's extended UTF-8; and
C<L</isUTF8_CHAR_flags>> for a more customized definition.
Use C<L</is_c9strict_utf8_string>>, C<L</is_c9strict_utf8_string_loc>>, and
C<L</is_c9strict_utf8_string_loclen>> to check entire strings.
STRLEN isC9_STRICT_UTF8_CHAR(const U8 *s, const U8 *e)
=for hackers
Found in file utf8.h
=item is_invariant_string
X<is_invariant_string>
This is a somewhat misleadingly-named synonym for L</is_utf8_invariant_string>.
C<is_utf8_invariant_string> is preferred, as it indicates under what conditions
the string is invariant.
bool is_invariant_string(const U8* const s,
const STRLEN len)
=for hackers
Found in file utf8.h
=item isSTRICT_UTF8_CHAR
X<isSTRICT_UTF8_CHAR>
Evaluates to non-zero if the first few bytes of the string starting at C<s> and
looking no further than S<C<e - 1>> are well-formed UTF-8 that represents some
Unicode code point completely acceptable for open interchange between all
applications; otherwise it evaluates to 0. If non-zero, the value gives how
many bytes starting at C<s> comprise the code point's representation. Any
bytes remaining before C<e>, but beyond the ones needed to form the first code
point in C<s>, are not examined.
The largest acceptable code point is the Unicode maximum 0x10FFFF, and must not
be a surrogate nor a non-character code point. Thus this excludes any code
point from Perl's extended UTF-8.
This is used to efficiently decide if the next few bytes in C<s> is
legal Unicode-acceptable UTF-8 for a single character.
Use C<L</isC9_STRICT_UTF8_CHAR>> to use the L<Unicode Corrigendum
#9|http://www.unicode.org/versions/corrigendum9.html> definition of allowable
code points; C<L</isUTF8_CHAR>> to check for Perl's extended UTF-8;
and C<L</isUTF8_CHAR_flags>> for a more customized definition.
Use C<L</is_strict_utf8_string>>, C<L</is_strict_utf8_string_loc>>, and
C<L</is_strict_utf8_string_loclen>> to check entire strings.
STRLEN isSTRICT_UTF8_CHAR(const U8 *s, const U8 *e)
=for hackers
Found in file utf8.h
=item is_strict_utf8_string
X<is_strict_utf8_string>
Returns TRUE if the first C<len> bytes of string C<s> form a valid
UTF-8-encoded string that is fully interchangeable by any application using
Unicode rules; otherwise it returns FALSE. If C<len> is 0, it will be
calculated using C<strlen(s)> (which means if you use this option, that C<s>
can't have embedded C<NUL> characters and has to have a terminating C<NUL>
byte). Note that all characters being ASCII constitute 'a valid UTF-8 string'.
This function returns FALSE for strings containing any
code points above the Unicode max of 0x10FFFF, surrogate code points, or
non-character code points.
See also
C<L</is_utf8_invariant_string>>,
C<L</is_utf8_string>>,
C<L</is_utf8_string_flags>>,
C<L</is_utf8_string_loc>>,
C<L</is_utf8_string_loc_flags>>,
C<L</is_utf8_string_loclen>>,
C<L</is_utf8_string_loclen_flags>>,
C<L</is_utf8_fixed_width_buf_flags>>,
C<L</is_utf8_fixed_width_buf_loc_flags>>,
C<L</is_utf8_fixed_width_buf_loclen_flags>>,
C<L</is_strict_utf8_string_loc>>,
C<L</is_strict_utf8_string_loclen>>,
C<L</is_c9strict_utf8_string>>,
C<L</is_c9strict_utf8_string_loc>>,
and
C<L</is_c9strict_utf8_string_loclen>>.
bool is_strict_utf8_string(const U8 *s,
const STRLEN len)
=for hackers
Found in file inline.h
=item is_strict_utf8_string_loc
X<is_strict_utf8_string_loc>
Like C<L</is_strict_utf8_string>> but stores the location of the failure (in the
case of "utf8ness failure") or the location C<s>+C<len> (in the case of
"utf8ness success") in the C<ep> pointer.
See also C<L</is_strict_utf8_string_loclen>>.
bool is_strict_utf8_string_loc(const U8 *s,
const STRLEN len,
const U8 **ep)
=for hackers
Found in file inline.h
=item is_strict_utf8_string_loclen
X<is_strict_utf8_string_loclen>
Like C<L</is_strict_utf8_string>> but stores the location of the failure (in the
case of "utf8ness failure") or the location C<s>+C<len> (in the case of
"utf8ness success") in the C<ep> pointer, and the number of UTF-8
encoded characters in the C<el> pointer.
See also C<L</is_strict_utf8_string_loc>>.
bool is_strict_utf8_string_loclen(const U8 *s,
const STRLEN len,
const U8 **ep,
STRLEN *el)
=for hackers
Found in file inline.h
=item is_utf8_fixed_width_buf_flags
X<is_utf8_fixed_width_buf_flags>
Returns TRUE if the fixed-width buffer starting at C<s> with length C<len>
is entirely valid UTF-8, subject to the restrictions given by C<flags>;
otherwise it returns FALSE.
If C<flags> is 0, any well-formed UTF-8, as extended by Perl, is accepted
without restriction. If the final few bytes of the buffer do not form a
complete code point, this will return TRUE anyway, provided that
C<L</is_utf8_valid_partial_char_flags>> returns TRUE for them.
If C<flags> in non-zero, it can be any combination of the
C<UTF8_DISALLOW_I<foo>> flags accepted by C<L</utf8n_to_uvchr>>, and with the
same meanings.
This function differs from C<L</is_utf8_string_flags>> only in that the latter
returns FALSE if the final few bytes of the string don't form a complete code
point.
bool is_utf8_fixed_width_buf_flags(
const U8 * const s, const STRLEN len,
const U32 flags
)
=for hackers
Found in file inline.h
=item is_utf8_fixed_width_buf_loclen_flags
X<is_utf8_fixed_width_buf_loclen_flags>
Like C<L</is_utf8_fixed_width_buf_loc_flags>> but stores the number of
complete, valid characters found in the C<el> pointer.
bool is_utf8_fixed_width_buf_loclen_flags(
const U8 * const s, const STRLEN len,
const U8 **ep, STRLEN *el, const U32 flags
)
=for hackers
Found in file inline.h
=item is_utf8_fixed_width_buf_loc_flags
X<is_utf8_fixed_width_buf_loc_flags>
Like C<L</is_utf8_fixed_width_buf_flags>> but stores the location of the
failure in the C<ep> pointer. If the function returns TRUE, C<*ep> will point
to the beginning of any partial character at the end of the buffer; if there is
no partial character C<*ep> will contain C<s>+C<len>.
See also C<L</is_utf8_fixed_width_buf_loclen_flags>>.
bool is_utf8_fixed_width_buf_loc_flags(
const U8 * const s, const STRLEN len,
const U8 **ep, const U32 flags
)
=for hackers
Found in file inline.h
=item is_utf8_invariant_string
X<is_utf8_invariant_string>
Returns TRUE if the first C<len> bytes of the string C<s> are the same
regardless of the UTF-8 encoding of the string (or UTF-EBCDIC encoding on
EBCDIC machines); otherwise it returns FALSE. That is, it returns TRUE if they
are UTF-8 invariant. On ASCII-ish machines, all the ASCII characters and only
the ASCII characters fit this definition. On EBCDIC machines, the ASCII-range
characters are invariant, but so also are the C1 controls.
If C<len> is 0, it will be calculated using C<strlen(s)>, (which means if you
use this option, that C<s> can't have embedded C<NUL> characters and has to
have a terminating C<NUL> byte).
See also
C<L</is_utf8_string>>,
C<L</is_utf8_string_flags>>,
C<L</is_utf8_string_loc>>,
C<L</is_utf8_string_loc_flags>>,
C<L</is_utf8_string_loclen>>,
C<L</is_utf8_string_loclen_flags>>,
C<L</is_utf8_fixed_width_buf_flags>>,
C<L</is_utf8_fixed_width_buf_loc_flags>>,
C<L</is_utf8_fixed_width_buf_loclen_flags>>,
C<L</is_strict_utf8_string>>,
C<L</is_strict_utf8_string_loc>>,
C<L</is_strict_utf8_string_loclen>>,
C<L</is_c9strict_utf8_string>>,
C<L</is_c9strict_utf8_string_loc>>,
and
C<L</is_c9strict_utf8_string_loclen>>.
bool is_utf8_invariant_string(const U8* const s,
STRLEN const len)
=for hackers
Found in file inline.h
=item is_utf8_string
X<is_utf8_string>
Returns TRUE if the first C<len> bytes of string C<s> form a valid
Perl-extended-UTF-8 string; returns FALSE otherwise. If C<len> is 0, it will
be calculated using C<strlen(s)> (which means if you use this option, that C<s>
can't have embedded C<NUL> characters and has to have a terminating C<NUL>
byte). Note that all characters being ASCII constitute 'a valid UTF-8 string'.
This function considers Perl's extended UTF-8 to be valid. That means that
code points above Unicode, surrogates, and non-character code points are
considered valid by this function. Use C<L</is_strict_utf8_string>>,
C<L</is_c9strict_utf8_string>>, or C<L</is_utf8_string_flags>> to restrict what
code points are considered valid.
See also
C<L</is_utf8_invariant_string>>,
C<L</is_utf8_string_loc>>,
C<L</is_utf8_string_loclen>>,
C<L</is_utf8_fixed_width_buf_flags>>,
C<L</is_utf8_fixed_width_buf_loc_flags>>,
C<L</is_utf8_fixed_width_buf_loclen_flags>>,
bool is_utf8_string(const U8 *s, const STRLEN len)
=for hackers
Found in file inline.h
=item is_utf8_string_flags
X<is_utf8_string_flags>
Returns TRUE if the first C<len> bytes of string C<s> form a valid
UTF-8 string, subject to the restrictions imposed by C<flags>;
returns FALSE otherwise. If C<len> is 0, it will be calculated
using C<strlen(s)> (which means if you use this option, that C<s> can't have
embedded C<NUL> characters and has to have a terminating C<NUL> byte). Note
that all characters being ASCII constitute 'a valid UTF-8 string'.
If C<flags> is 0, this gives the same results as C<L</is_utf8_string>>; if
C<flags> is C<UTF8_DISALLOW_ILLEGAL_INTERCHANGE>, this gives the same results
as C<L</is_strict_utf8_string>>; and if C<flags> is
C<UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE>, this gives the same results as
C<L</is_c9strict_utf8_string>>. Otherwise C<flags> may be any
combination of the C<UTF8_DISALLOW_I<foo>> flags understood by
C<L</utf8n_to_uvchr>>, with the same meanings.
See also
C<L</is_utf8_invariant_string>>,
C<L</is_utf8_string>>,
C<L</is_utf8_string_loc>>,
C<L</is_utf8_string_loc_flags>>,
C<L</is_utf8_string_loclen>>,
C<L</is_utf8_string_loclen_flags>>,
C<L</is_utf8_fixed_width_buf_flags>>,
C<L</is_utf8_fixed_width_buf_loc_flags>>,
C<L</is_utf8_fixed_width_buf_loclen_flags>>,
C<L</is_strict_utf8_string>>,
C<L</is_strict_utf8_string_loc>>,
C<L</is_strict_utf8_string_loclen>>,
C<L</is_c9strict_utf8_string>>,
C<L</is_c9strict_utf8_string_loc>>,
and
C<L</is_c9strict_utf8_string_loclen>>.
bool is_utf8_string_flags(const U8 *s,
const STRLEN len,
const U32 flags)
=for hackers
Found in file inline.h
=item is_utf8_string_loc
X<is_utf8_string_loc>
Like C<L</is_utf8_string>> but stores the location of the failure (in the
case of "utf8ness failure") or the location C<s>+C<len> (in the case of
"utf8ness success") in the C<ep> pointer.
See also C<L</is_utf8_string_loclen>>.
bool is_utf8_string_loc(const U8 *s,
const STRLEN len,
const U8 **ep)
=for hackers
Found in file inline.h
=item is_utf8_string_loclen
X<is_utf8_string_loclen>
Like C<L</is_utf8_string>> but stores the location of the failure (in the
case of "utf8ness failure") or the location C<s>+C<len> (in the case of
"utf8ness success") in the C<ep> pointer, and the number of UTF-8
encoded characters in the C<el> pointer.
See also C<L</is_utf8_string_loc>>.
bool is_utf8_string_loclen(const U8 *s,
const STRLEN len,
const U8 **ep, STRLEN *el)
=for hackers
Found in file inline.h
=item is_utf8_string_loclen_flags
X<is_utf8_string_loclen_flags>
Like C<L</is_utf8_string_flags>> but stores the location of the failure (in the
case of "utf8ness failure") or the location C<s>+C<len> (in the case of
"utf8ness success") in the C<ep> pointer, and the number of UTF-8
encoded characters in the C<el> pointer.
See also C<L</is_utf8_string_loc_flags>>.
bool is_utf8_string_loclen_flags(const U8 *s,
const STRLEN len,
const U8 **ep,
STRLEN *el,
const U32 flags)
=for hackers
Found in file inline.h
=item is_utf8_string_loc_flags
X<is_utf8_string_loc_flags>
Like C<L</is_utf8_string_flags>> but stores the location of the failure (in the
case of "utf8ness failure") or the location C<s>+C<len> (in the case of
"utf8ness success") in the C<ep> pointer.
See also C<L</is_utf8_string_loclen_flags>>.
bool is_utf8_string_loc_flags(const U8 *s,
const STRLEN len,
const U8 **ep,
const U32 flags)
=for hackers
Found in file inline.h
=item is_utf8_valid_partial_char
X<is_utf8_valid_partial_char>
Returns 0 if the sequence of bytes starting at C<s> and looking no further than
S<C<e - 1>> is the UTF-8 encoding, as extended by Perl, for one or more code
points. Otherwise, it returns 1 if there exists at least one non-empty
sequence of bytes that when appended to sequence C<s>, starting at position
C<e> causes the entire sequence to be the well-formed UTF-8 of some code point;
otherwise returns 0.
In other words this returns TRUE if C<s> points to a partial UTF-8-encoded code
point.
This is useful when a fixed-length buffer is being tested for being well-formed
UTF-8, but the final few bytes in it don't comprise a full character; that is,
it is split somewhere in the middle of the final code point's UTF-8
representation. (Presumably when the buffer is refreshed with the next chunk
of data, the new first bytes will complete the partial code point.) This
function is used to verify that the final bytes in the current buffer are in
fact the legal beginning of some code point, so that if they aren't, the
failure can be signalled without having to wait for the next read.
bool is_utf8_valid_partial_char(const U8 * const s,
const U8 * const e)
=for hackers
Found in file inline.h
=item is_utf8_valid_partial_char_flags
X<is_utf8_valid_partial_char_flags>
Like C<L</is_utf8_valid_partial_char>>, it returns a boolean giving whether
or not the input is a valid UTF-8 encoded partial character, but it takes an
extra parameter, C<flags>, which can further restrict which code points are
considered valid.
If C<flags> is 0, this behaves identically to
C<L</is_utf8_valid_partial_char>>. Otherwise C<flags> can be any combination
of the C<UTF8_DISALLOW_I<foo>> flags accepted by C<L</utf8n_to_uvchr>>. If
there is any sequence of bytes that can complete the input partial character in
such a way that a non-prohibited character is formed, the function returns
TRUE; otherwise FALSE. Non character code points cannot be determined based on
partial character input. But many of the other possible excluded types can be
determined from just the first one or two bytes.
bool is_utf8_valid_partial_char_flags(
const U8 * const s, const U8 * const e,
const U32 flags
)
=for hackers
Found in file inline.h
=item isUTF8_CHAR
X<isUTF8_CHAR>
Evaluates to non-zero if the first few bytes of the string starting at C<s> and
looking no further than S<C<e - 1>> are well-formed UTF-8, as extended by Perl,
that represents some code point; otherwise it evaluates to 0. If non-zero, the
value gives how many bytes starting at C<s> comprise the code point's
representation. Any bytes remaining before C<e>, but beyond the ones needed to
form the first code point in C<s>, are not examined.
The code point can be any that will fit in a UV on this machine, using Perl's
extension to official UTF-8 to represent those higher than the Unicode maximum
of 0x10FFFF. That means that this macro is used to efficiently decide if the
next few bytes in C<s> is legal UTF-8 for a single character.
Use C<L</isSTRICT_UTF8_CHAR>> to restrict the acceptable code points to those
defined by Unicode to be fully interchangeable across applications;
C<L</isC9_STRICT_UTF8_CHAR>> to use the L<Unicode Corrigendum
#9|http://www.unicode.org/versions/corrigendum9.html> definition of allowable
code points; and C<L</isUTF8_CHAR_flags>> for a more customized definition.
Use C<L</is_utf8_string>>, C<L</is_utf8_string_loc>>, and
C<L</is_utf8_string_loclen>> to check entire strings.
Note that it is deprecated to use code points higher than what will fit in an
IV. This macro does not raise any warnings for such code points, treating them
as valid.
Note also that a UTF-8 INVARIANT character (i.e. ASCII on non-EBCDIC machines)
is a valid UTF-8 character.
STRLEN isUTF8_CHAR(const U8 *s, const U8 *e)
=for hackers
Found in file utf8.h
=item isUTF8_CHAR_flags
X<isUTF8_CHAR_flags>
Evaluates to non-zero if the first few bytes of the string starting at C<s> and
looking no further than S<C<e - 1>> are well-formed UTF-8, as extended by Perl,
that represents some code point, subject to the restrictions given by C<flags>;
otherwise it evaluates to 0. If non-zero, the value gives how many bytes
starting at C<s> comprise the code point's representation. Any bytes remaining
before C<e>, but beyond the ones needed to form the first code point in C<s>,
are not examined.
If C<flags> is 0, this gives the same results as C<L</isUTF8_CHAR>>;
if C<flags> is C<UTF8_DISALLOW_ILLEGAL_INTERCHANGE>, this gives the same results
as C<L</isSTRICT_UTF8_CHAR>>;
and if C<flags> is C<UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE>, this gives
the same results as C<L</isC9_STRICT_UTF8_CHAR>>.
Otherwise C<flags> may be any combination of the C<UTF8_DISALLOW_I<foo>> flags
understood by C<L</utf8n_to_uvchr>>, with the same meanings.
The three alternative macros are for the most commonly needed validations; they
are likely to run somewhat faster than this more general one, as they can be
inlined into your code.
Use L</is_utf8_string_flags>, L</is_utf8_string_loc_flags>, and
L</is_utf8_string_loclen_flags> to check entire strings.
STRLEN isUTF8_CHAR_flags(const U8 *s, const U8 *e,
const U32 flags)
=for hackers
Found in file utf8.h
=item pv_uni_display
X<pv_uni_display>
Build to the scalar C<dsv> a displayable version of the string C<spv>,
length C<len>, the displayable version being at most C<pvlim> bytes long
(if longer, the rest is truncated and C<"..."> will be appended).
The C<flags> argument can have C<UNI_DISPLAY_ISPRINT> set to display
C<isPRINT()>able characters as themselves, C<UNI_DISPLAY_BACKSLASH>
to display the C<\\[nrfta\\]> as the backslashed versions (like C<"\n">)
(C<UNI_DISPLAY_BACKSLASH> is preferred over C<UNI_DISPLAY_ISPRINT> for C<"\\">).
C<UNI_DISPLAY_QQ> (and its alias C<UNI_DISPLAY_REGEX>) have both
C<UNI_DISPLAY_BACKSLASH> and C<UNI_DISPLAY_ISPRINT> turned on.
The pointer to the PV of the C<dsv> is returned.
See also L</sv_uni_display>.
char* pv_uni_display(SV *dsv, const U8 *spv,
STRLEN len, STRLEN pvlim,
UV flags)
=for hackers
Found in file utf8.c
=item REPLACEMENT_CHARACTER_UTF8
X<REPLACEMENT_CHARACTER_UTF8>
This is a macro that evaluates to a string constant of the UTF-8 bytes that
define the Unicode REPLACEMENT CHARACTER (U+FFFD) for the platform that perl
is compiled on. This allows code to use a mnemonic for this character that
works on both ASCII and EBCDIC platforms.
S<C<sizeof(REPLACEMENT_CHARACTER_UTF8) - 1>> can be used to get its length in
bytes.
=for hackers
Found in file unicode_constants.h
=item sv_cat_decode
X<sv_cat_decode>
C<encoding> is assumed to be an C<Encode> object, the PV of C<ssv> is
assumed to be octets in that encoding and decoding the input starts
from the position which S<C<(PV + *offset)>> pointed to. C<dsv> will be
concatenated with the decoded UTF-8 string from C<ssv>. Decoding will terminate
when the string C<tstr> appears in decoding output or the input ends on
the PV of C<ssv>. The value which C<offset> points will be modified
to the last input position on C<ssv>.
Returns TRUE if the terminator was found, else returns FALSE.
bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv,
int *offset, char* tstr, int tlen)
=for hackers
Found in file sv.c
=item sv_recode_to_utf8
X<sv_recode_to_utf8>
C<encoding> is assumed to be an C<Encode> object, on entry the PV
of C<sv> is assumed to be octets in that encoding, and C<sv>
will be converted into Unicode (and UTF-8).
If C<sv> already is UTF-8 (or if it is not C<POK>), or if C<encoding>
is not a reference, nothing is done to C<sv>. If C<encoding> is not
an C<Encode::XS> Encoding object, bad things will happen.
(See F<cpan/Encode/encoding.pm> and L<Encode>.)
The PV of C<sv> is returned.
char* sv_recode_to_utf8(SV* sv, SV *encoding)
=for hackers
Found in file sv.c
=item sv_uni_display
X<sv_uni_display>
Build to the scalar C<dsv> a displayable version of the scalar C<sv>,
the displayable version being at most C<pvlim> bytes long
(if longer, the rest is truncated and "..." will be appended).
The C<flags> argument is as in L</pv_uni_display>().
The pointer to the PV of the C<dsv> is returned.
char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim,
UV flags)
=for hackers
Found in file utf8.c
=item to_utf8_case
X<to_utf8_case>
DEPRECATED! It is planned to remove this function from a
future release of Perl. Do not use it for new code; remove it from
existing code.
Instead use the appropriate one of L</toUPPER_utf8_safe>,
L</toTITLE_utf8_safe>,
L</toLOWER_utf8_safe>,
or L</toFOLD_utf8_safe>.
This function will be removed in Perl v5.28.
C<p> contains the pointer to the UTF-8 string encoding
the character that is being converted. This routine assumes that the character
at C<p> is well-formed.
C<ustrp> is a pointer to the character buffer to put the
conversion result to. C<lenp> is a pointer to the length
of the result.
C<swashp> is a pointer to the swash to use.
Both the special and normal mappings are stored in F<lib/unicore/To/Foo.pl>,
and loaded by C<SWASHNEW>, using F<lib/utf8_heavy.pl>. C<special> (usually,
but not always, a multicharacter mapping), is tried first.
C<special> is a string, normally C<NULL> or C<"">. C<NULL> means to not use
any special mappings; C<""> means to use the special mappings. Values other
than these two are treated as the name of the hash containing the special
mappings, like C<"utf8::ToSpecLower">.
C<normal> is a string like C<"ToLower"> which means the swash
C<%utf8::ToLower>.
Code points above the platform's C<IV_MAX> will raise a deprecation warning,
unless those are turned off.
UV to_utf8_case(const U8 *p, U8* ustrp,
STRLEN *lenp, SV **swashp,
const char *normal,
const char *special)
=for hackers
Found in file utf8.c
=item to_utf8_fold
X<to_utf8_fold>
DEPRECATED! It is planned to remove this function from a
future release of Perl. Do not use it for new code; remove it from
existing code.
Instead use L</toFOLD_utf8_safe>.
UV to_utf8_fold(const U8 *p, U8* ustrp,
STRLEN *lenp)
=for hackers
Found in file utf8.c
=item to_utf8_lower
X<to_utf8_lower>
DEPRECATED! It is planned to remove this function from a
future release of Perl. Do not use it for new code; remove it from
existing code.
Instead use L</toLOWER_utf8_safe>.
UV to_utf8_lower(const U8 *p, U8* ustrp,
STRLEN *lenp)
=for hackers
Found in file utf8.c
=item to_utf8_title
X<to_utf8_title>
DEPRECATED! It is planned to remove this function from a
future release of Perl. Do not use it for new code; remove it from
existing code.
Instead use L</toTITLE_utf8_safe>.
UV to_utf8_title(const U8 *p, U8* ustrp,
STRLEN *lenp)
=for hackers
Found in file utf8.c
=item to_utf8_upper
X<to_utf8_upper>
DEPRECATED! It is planned to remove this function from a
future release of Perl. Do not use it for new code; remove it from
existing code.
Instead use L</toUPPER_utf8_safe>.
UV to_utf8_upper(const U8 *p, U8* ustrp,
STRLEN *lenp)
=for hackers
Found in file utf8.c
=item utf8n_to_uvchr
X<utf8n_to_uvchr>
THIS FUNCTION SHOULD BE USED IN ONLY VERY SPECIALIZED CIRCUMSTANCES.
Most code should use L</utf8_to_uvchr_buf>() rather than call this directly.
Bottom level UTF-8 decode routine.
Returns the native code point value of the first character in the string C<s>,
which is assumed to be in UTF-8 (or UTF-EBCDIC) encoding, and no longer than
C<curlen> bytes; C<*retlen> (if C<retlen> isn't NULL) will be set to
the length, in bytes, of that character.
The value of C<flags> determines the behavior when C<s> does not point to a
well-formed UTF-8 character. If C<flags> is 0, encountering a malformation
causes zero to be returned and C<*retlen> is set so that (S<C<s> + C<*retlen>>)
is the next possible position in C<s> that could begin a non-malformed
character. Also, if UTF-8 warnings haven't been lexically disabled, a warning
is raised. Some UTF-8 input sequences may contain multiple malformations.
This function tries to find every possible one in each call, so multiple
warnings can be raised for each sequence.
Various ALLOW flags can be set in C<flags> to allow (and not warn on)
individual types of malformations, such as the sequence being overlong (that
is, when there is a shorter sequence that can express the same code point;
overlong sequences are expressly forbidden in the UTF-8 standard due to
potential security issues). Another malformation example is the first byte of
a character not being a legal first byte. See F<utf8.h> for the list of such
flags. Even if allowed, this function generally returns the Unicode
REPLACEMENT CHARACTER when it encounters a malformation. There are flags in
F<utf8.h> to override this behavior for the overlong malformations, but don't
do that except for very specialized purposes.
The C<UTF8_CHECK_ONLY> flag overrides the behavior when a non-allowed (by other
flags) malformation is found. If this flag is set, the routine assumes that
the caller will raise a warning, and this function will silently just set
C<retlen> to C<-1> (cast to C<STRLEN>) and return zero.
Note that this API requires disambiguation between successful decoding a C<NUL>
character, and an error return (unless the C<UTF8_CHECK_ONLY> flag is set), as
in both cases, 0 is returned, and, depending on the malformation, C<retlen> may
be set to 1. To disambiguate, upon a zero return, see if the first byte of
C<s> is 0 as well. If so, the input was a C<NUL>; if not, the input had an
error. Or you can use C<L</utf8n_to_uvchr_error>>.
Certain code points are considered problematic. These are Unicode surrogates,
Unicode non-characters, and code points above the Unicode maximum of 0x10FFFF.
By default these are considered regular code points, but certain situations
warrant special handling for them, which can be specified using the C<flags>
parameter. If C<flags> contains C<UTF8_DISALLOW_ILLEGAL_INTERCHANGE>, all
three classes are treated as malformations and handled as such. The flags
C<UTF8_DISALLOW_SURROGATE>, C<UTF8_DISALLOW_NONCHAR>, and
C<UTF8_DISALLOW_SUPER> (meaning above the legal Unicode maximum) can be set to
disallow these categories individually. C<UTF8_DISALLOW_ILLEGAL_INTERCHANGE>
restricts the allowed inputs to the strict UTF-8 traditionally defined by
Unicode. Use C<UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE> to use the strictness
definition given by
L<Unicode Corrigendum #9|http://www.unicode.org/versions/corrigendum9.html>.
The difference between traditional strictness and C9 strictness is that the
latter does not forbid non-character code points. (They are still discouraged,
however.) For more discussion see L<perlunicode/Noncharacter code points>.
The flags C<UTF8_WARN_ILLEGAL_INTERCHANGE>,
C<UTF8_WARN_ILLEGAL_C9_INTERCHANGE>, C<UTF8_WARN_SURROGATE>,
C<UTF8_WARN_NONCHAR>, and C<UTF8_WARN_SUPER> will cause warning messages to be
raised for their respective categories, but otherwise the code points are
considered valid (not malformations). To get a category to both be treated as
a malformation and raise a warning, specify both the WARN and DISALLOW flags.
(But note that warnings are not raised if lexically disabled nor if
C<UTF8_CHECK_ONLY> is also specified.)
It is now deprecated to have very high code points (above C<IV_MAX> on the
platforms) and this function will raise a deprecation warning for these (unless
such warnings are turned off). This value is typically 0x7FFF_FFFF (2**31 -1)
in a 32-bit word.
Code points above 0x7FFF_FFFF (2**31 - 1) were never specified in any standard,
so using them is more problematic than other above-Unicode code points. Perl
invented an extension to UTF-8 to represent the ones above 2**36-1, so it is
likely that non-Perl languages will not be able to read files that contain
these; nor would Perl understand files
written by something that uses a different extension. For these reasons, there
is a separate set of flags that can warn and/or disallow these extremely high
code points, even if other above-Unicode ones are accepted. These are the
C<UTF8_WARN_ABOVE_31_BIT> and C<UTF8_DISALLOW_ABOVE_31_BIT> flags. These
are entirely independent from the deprecation warning for code points above
C<IV_MAX>. On 32-bit machines, it will eventually be forbidden to have any
code point that needs more than 31 bits to represent. When that happens,
effectively the C<UTF8_DISALLOW_ABOVE_31_BIT> flag will always be set on
32-bit machines. (Of course C<UTF8_DISALLOW_SUPER> will treat all
above-Unicode code points, including these, as malformations; and
C<UTF8_WARN_SUPER> warns on these.)
On EBCDIC platforms starting in Perl v5.24, the Perl extension for representing
extremely high code points kicks in at 0x3FFF_FFFF (2**30 -1), which is lower
than on ASCII. Prior to that, code points 2**31 and higher were simply
unrepresentable, and a different, incompatible method was used to represent
code points between 2**30 and 2**31 - 1. The flags C<UTF8_WARN_ABOVE_31_BIT>
and C<UTF8_DISALLOW_ABOVE_31_BIT> have the same function as on ASCII
platforms, warning and disallowing 2**31 and higher.
All other code points corresponding to Unicode characters, including private
use and those yet to be assigned, are never considered malformed and never
warn.
UV utf8n_to_uvchr(const U8 *s, STRLEN curlen,
STRLEN *retlen, const U32 flags)
=for hackers
Found in file utf8.c
=item utf8n_to_uvchr_error
X<utf8n_to_uvchr_error>
THIS FUNCTION SHOULD BE USED IN ONLY VERY SPECIALIZED CIRCUMSTANCES.
Most code should use L</utf8_to_uvchr_buf>() rather than call this directly.
This function is for code that needs to know what the precise malformation(s)
are when an error is found.
It is like C<L</utf8n_to_uvchr>> but it takes an extra parameter placed after
all the others, C<errors>. If this parameter is 0, this function behaves
identically to C<L</utf8n_to_uvchr>>. Otherwise, C<errors> should be a pointer
to a C<U32> variable, which this function sets to indicate any errors found.
Upon return, if C<*errors> is 0, there were no errors found. Otherwise,
C<*errors> is the bit-wise C<OR> of the bits described in the list below. Some
of these bits will be set if a malformation is found, even if the input
C<flags> parameter indicates that the given malformation is allowed; those
exceptions are noted:
=over 4
=item C<UTF8_GOT_ABOVE_31_BIT>
The code point represented by the input UTF-8 sequence occupies more than 31
bits.
This bit is set only if the input C<flags> parameter contains either the
C<UTF8_DISALLOW_ABOVE_31_BIT> or the C<UTF8_WARN_ABOVE_31_BIT> flags.
=item C<UTF8_GOT_CONTINUATION>
The input sequence was malformed in that the first byte was a a UTF-8
continuation byte.
=item C<UTF8_GOT_EMPTY>
The input C<curlen> parameter was 0.
=item C<UTF8_GOT_LONG>
The input sequence was malformed in that there is some other sequence that
evaluates to the same code point, but that sequence is shorter than this one.
=item C<UTF8_GOT_NONCHAR>
The code point represented by the input UTF-8 sequence is for a Unicode
non-character code point.
This bit is set only if the input C<flags> parameter contains either the
C<UTF8_DISALLOW_NONCHAR> or the C<UTF8_WARN_NONCHAR> flags.
=item C<UTF8_GOT_NON_CONTINUATION>
The input sequence was malformed in that a non-continuation type byte was found
in a position where only a continuation type one should be.
=item C<UTF8_GOT_OVERFLOW>
The input sequence was malformed in that it is for a code point that is not
representable in the number of bits available in a UV on the current platform.
=item C<UTF8_GOT_SHORT>
The input sequence was malformed in that C<curlen> is smaller than required for
a complete sequence. In other words, the input is for a partial character
sequence.
=item C<UTF8_GOT_SUPER>
The input sequence was malformed in that it is for a non-Unicode code point;
that is, one above the legal Unicode maximum.
This bit is set only if the input C<flags> parameter contains either the
C<UTF8_DISALLOW_SUPER> or the C<UTF8_WARN_SUPER> flags.
=item C<UTF8_GOT_SURROGATE>
The input sequence was malformed in that it is for a -Unicode UTF-16 surrogate
code point.
This bit is set only if the input C<flags> parameter contains either the
C<UTF8_DISALLOW_SURROGATE> or the C<UTF8_WARN_SURROGATE> flags.
=back
To do your own error handling, call this function with the C<UTF8_CHECK_ONLY>
flag to suppress any warnings, and then examine the C<*errors> return.
UV utf8n_to_uvchr_error(const U8 *s, STRLEN curlen,
STRLEN *retlen,
const U32 flags,
U32 * errors)
=for hackers
Found in file utf8.c
=item utf8n_to_uvuni
X<utf8n_to_uvuni>
Instead use L</utf8_to_uvchr_buf>, or rarely, L</utf8n_to_uvchr>.
This function was useful for code that wanted to handle both EBCDIC and
ASCII platforms with Unicode properties, but starting in Perl v5.20, the
distinctions between the platforms have mostly been made invisible to most
code, so this function is quite unlikely to be what you want. If you do need
this precise functionality, use instead
C<L<NATIVE_TO_UNI(utf8_to_uvchr_buf(...))|/utf8_to_uvchr_buf>>
or C<L<NATIVE_TO_UNI(utf8n_to_uvchr(...))|/utf8n_to_uvchr>>.
UV utf8n_to_uvuni(const U8 *s, STRLEN curlen,
STRLEN *retlen, U32 flags)
=for hackers
Found in file utf8.c
=item UTF8SKIP
X<UTF8SKIP>
returns the number of bytes in the UTF-8 encoded character whose first (perhaps
only) byte is pointed to by C<s>.
STRLEN UTF8SKIP(char* s)
=for hackers
Found in file utf8.h
=item utf8_distance
X<utf8_distance>
Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
and C<b>.
WARNING: use only if you *know* that the pointers point inside the
same UTF-8 buffer.
IV utf8_distance(const U8 *a, const U8 *b)
=for hackers
Found in file inline.h
=item utf8_hop
X<utf8_hop>
Return the UTF-8 pointer C<s> displaced by C<off> characters, either
forward or backward.
WARNING: do not use the following unless you *know* C<off> is within
the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
on the first byte of character or just after the last byte of a character.
U8* utf8_hop(const U8 *s, SSize_t off)
=for hackers
Found in file inline.h
=item utf8_hop_back
X<utf8_hop_back>
Return the UTF-8 pointer C<s> displaced by up to C<off> characters,
backward.
C<off> must be non-positive.
C<s> must be after or equal to C<start>.
When moving backward it will not move before C<start>.
Will not exceed this limit even if the string is not valid "UTF-8".
U8* utf8_hop_back(const U8 *s, SSize_t off,
const U8 *start)
=for hackers
Found in file inline.h
=item utf8_hop_forward
X<utf8_hop_forward>
Return the UTF-8 pointer C<s> displaced by up to C<off> characters,
forward.
C<off> must be non-negative.
C<s> must be before or equal to C<end>.
When moving forward it will not move beyond C<end>.
Will not exceed this limit even if the string is not valid "UTF-8".
U8* utf8_hop_forward(const U8 *s, SSize_t off,
const U8 *end)
=for hackers
Found in file inline.h
=item utf8_hop_safe
X<utf8_hop_safe>
Return the UTF-8 pointer C<s> displaced by up to C<off> characters,
either forward or backward.
When moving backward it will not move before C<start>.
When moving forward it will not move beyond C<end>.
Will not exceed those limits even if the string is not valid "UTF-8".
U8* utf8_hop_safe(const U8 *s, SSize_t off,
const U8 *start, const U8 *end)
=for hackers
Found in file inline.h
=item UTF8_IS_INVARIANT
X<UTF8_IS_INVARIANT>
Evaluates to 1 if the byte C<c> represents the same character when encoded in
UTF-8 as when not; otherwise evaluates to 0. UTF-8 invariant characters can be
copied as-is when converting to/from UTF-8, saving time.
In spite of the name, this macro gives the correct result if the input string
from which C<c> comes is not encoded in UTF-8.
See C<L</UVCHR_IS_INVARIANT>> for checking if a UV is invariant.
bool UTF8_IS_INVARIANT(char c)
=for hackers
Found in file utf8.h
=item UTF8_IS_NONCHAR
X<UTF8_IS_NONCHAR>
Evaluates to non-zero if the first few bytes of the string starting at C<s> and
looking no further than S<C<e - 1>> are well-formed UTF-8 that represents one
of the Unicode non-character code points; otherwise it evaluates to 0. If
non-zero, the value gives how many bytes starting at C<s> comprise the code
point's representation.
bool UTF8_IS_NONCHAR(const U8 *s, const U8 *e)
=for hackers
Found in file utf8.h
=item UTF8_IS_SUPER
X<UTF8_IS_SUPER>
Recall that Perl recognizes an extension to UTF-8 that can encode code
points larger than the ones defined by Unicode, which are 0..0x10FFFF.
This macro evaluates to non-zero if the first few bytes of the string starting
at C<s> and looking no further than S<C<e - 1>> are from this UTF-8 extension;
otherwise it evaluates to 0. If non-zero, the value gives how many bytes
starting at C<s> comprise the code point's representation.
0 is returned if the bytes are not well-formed extended UTF-8, or if they
represent a code point that cannot fit in a UV on the current platform. Hence
this macro can give different results when run on a 64-bit word machine than on
one with a 32-bit word size.
Note that it is deprecated to have code points that are larger than what can
fit in an IV on the current machine.
bool UTF8_IS_SUPER(const U8 *s, const U8 *e)
=for hackers
Found in file utf8.h
=item UTF8_IS_SURROGATE
X<UTF8_IS_SURROGATE>
Evaluates to non-zero if the first few bytes of the string starting at C<s> and
looking no further than S<C<e - 1>> are well-formed UTF-8 that represents one
of the Unicode surrogate code points; otherwise it evaluates to 0. If
non-zero, the value gives how many bytes starting at C<s> comprise the code
point's representation.
bool UTF8_IS_SURROGATE(const U8 *s, const U8 *e)
=for hackers
Found in file utf8.h
=item utf8_length
X<utf8_length>
Return the length of the UTF-8 char encoded string C<s> in characters.
Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
up past C<e>, croaks.
STRLEN utf8_length(const U8* s, const U8 *e)
=for hackers
Found in file utf8.c
=item utf8_to_bytes
X<utf8_to_bytes>
NOTE: this function is experimental and may change or be
removed without notice.
Converts a string C<s> of length C<len> from UTF-8 into native byte encoding.
Unlike L</bytes_to_utf8>, this over-writes the original string, and
updates C<len> to contain the new length.
Returns zero on failure, setting C<len> to -1.
If you need a copy of the string, see L</bytes_from_utf8>.
U8* utf8_to_bytes(U8 *s, STRLEN *len)
=for hackers
Found in file utf8.c
=item utf8_to_uvchr_buf
X<utf8_to_uvchr_buf>
Returns the native code point of the first character in the string C<s> which
is assumed to be in UTF-8 encoding; C<send> points to 1 beyond the end of C<s>.
C<*retlen> will be set to the length, in bytes, of that character.
If C<s> does not point to a well-formed UTF-8 character and UTF8 warnings are
enabled, zero is returned and C<*retlen> is set (if C<retlen> isn't
C<NULL>) to -1. If those warnings are off, the computed value, if well-defined
(or the Unicode REPLACEMENT CHARACTER if not), is silently returned, and
C<*retlen> is set (if C<retlen> isn't C<NULL>) so that (S<C<s> + C<*retlen>>) is
the next possible position in C<s> that could begin a non-malformed character.
See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is
returned.
Code points above the platform's C<IV_MAX> will raise a deprecation warning,
unless those are turned off.
UV utf8_to_uvchr_buf(const U8 *s, const U8 *send,
STRLEN *retlen)
=for hackers
Found in file utf8.c
=item utf8_to_uvuni_buf
X<utf8_to_uvuni_buf>
DEPRECATED! It is planned to remove this function from a
future release of Perl. Do not use it for new code; remove it from
existing code.
Only in very rare circumstances should code need to be dealing in Unicode
(as opposed to native) code points. In those few cases, use
C<L<NATIVE_TO_UNI(utf8_to_uvchr_buf(...))|/utf8_to_uvchr_buf>> instead.
Returns the Unicode (not-native) code point of the first character in the
string C<s> which
is assumed to be in UTF-8 encoding; C<send> points to 1 beyond the end of C<s>.
C<retlen> will be set to the length, in bytes, of that character.
If C<s> does not point to a well-formed UTF-8 character and UTF8 warnings are
enabled, zero is returned and C<*retlen> is set (if C<retlen> isn't
NULL) to -1. If those warnings are off, the computed value if well-defined (or
the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
is set (if C<retlen> isn't NULL) so that (S<C<s> + C<*retlen>>) is the
next possible position in C<s> that could begin a non-malformed character.
See L</utf8n_to_uvchr> for details on when the REPLACEMENT CHARACTER is returned.
Code points above the platform's C<IV_MAX> will raise a deprecation warning,
unless those are turned off.
UV utf8_to_uvuni_buf(const U8 *s, const U8 *send,
STRLEN *retlen)
=for hackers
Found in file utf8.c
=item UVCHR_IS_INVARIANT
X<UVCHR_IS_INVARIANT>
Evaluates to 1 if the representation of code point C<cp> is the same whether or
not it is encoded in UTF-8; otherwise evaluates to 0. UTF-8 invariant
characters can be copied as-is when converting to/from UTF-8, saving time.
C<cp> is Unicode if above 255; otherwise is platform-native.
bool UVCHR_IS_INVARIANT(UV cp)
=for hackers
Found in file utf8.h
=item UVCHR_SKIP
X<UVCHR_SKIP>
returns the number of bytes required to represent the code point C<cp> when
encoded as UTF-8. C<cp> is a native (ASCII or EBCDIC) code point if less than
255; a Unicode code point otherwise.
STRLEN UVCHR_SKIP(UV cp)
=for hackers
Found in file utf8.h
=item uvchr_to_utf8
X<uvchr_to_utf8>
Adds the UTF-8 representation of the native code point C<uv> to the end
of the string C<d>; C<d> should have at least C<UVCHR_SKIP(uv)+1> (up to
C<UTF8_MAXBYTES+1>) free bytes available. The return value is the pointer to
the byte after the end of the new character. In other words,
d = uvchr_to_utf8(d, uv);
is the recommended wide native character-aware way of saying
*(d++) = uv;
This function accepts any UV as input, but very high code points (above
C<IV_MAX> on the platform) will raise a deprecation warning. This is
typically 0x7FFF_FFFF in a 32-bit word.
It is possible to forbid or warn on non-Unicode code points, or those that may
be problematic by using L</uvchr_to_utf8_flags>.
U8* uvchr_to_utf8(U8 *d, UV uv)
=for hackers
Found in file utf8.c
=item uvchr_to_utf8_flags
X<uvchr_to_utf8_flags>
Adds the UTF-8 representation of the native code point C<uv> to the end
of the string C<d>; C<d> should have at least C<UVCHR_SKIP(uv)+1> (up to
C<UTF8_MAXBYTES+1>) free bytes available. The return value is the pointer to
the byte after the end of the new character. In other words,
d = uvchr_to_utf8_flags(d, uv, flags);
or, in most cases,
d = uvchr_to_utf8_flags(d, uv, 0);
This is the Unicode-aware way of saying
*(d++) = uv;
If C<flags> is 0, this function accepts any UV as input, but very high code
points (above C<IV_MAX> for the platform) will raise a deprecation warning.
This is typically 0x7FFF_FFFF in a 32-bit word.
Specifying C<flags> can further restrict what is allowed and not warned on, as
follows:
If C<uv> is a Unicode surrogate code point and C<UNICODE_WARN_SURROGATE> is set,
the function will raise a warning, provided UTF8 warnings are enabled. If
instead C<UNICODE_DISALLOW_SURROGATE> is set, the function will fail and return
NULL. If both flags are set, the function will both warn and return NULL.
Similarly, the C<UNICODE_WARN_NONCHAR> and C<UNICODE_DISALLOW_NONCHAR> flags
affect how the function handles a Unicode non-character.
And likewise, the C<UNICODE_WARN_SUPER> and C<UNICODE_DISALLOW_SUPER> flags
affect the handling of code points that are above the Unicode maximum of
0x10FFFF. Languages other than Perl may not be able to accept files that
contain these.
The flag C<UNICODE_WARN_ILLEGAL_INTERCHANGE> selects all three of
the above WARN flags; and C<UNICODE_DISALLOW_ILLEGAL_INTERCHANGE> selects all
three DISALLOW flags. C<UNICODE_DISALLOW_ILLEGAL_INTERCHANGE> restricts the
allowed inputs to the strict UTF-8 traditionally defined by Unicode.
Similarly, C<UNICODE_WARN_ILLEGAL_C9_INTERCHANGE> and
C<UNICODE_DISALLOW_ILLEGAL_C9_INTERCHANGE> are shortcuts to select the
above-Unicode and surrogate flags, but not the non-character ones, as
defined in
L<Unicode Corrigendum #9|http://www.unicode.org/versions/corrigendum9.html>.
See L<perlunicode/Noncharacter code points>.
Code points above 0x7FFF_FFFF (2**31 - 1) were never specified in any standard,
so using them is more problematic than other above-Unicode code points. Perl
invented an extension to UTF-8 to represent the ones above 2**36-1, so it is
likely that non-Perl languages will not be able to read files that contain
these that written by the perl interpreter; nor would Perl understand files
written by something that uses a different extension. For these reasons, there
is a separate set of flags that can warn and/or disallow these extremely high
code points, even if other above-Unicode ones are accepted. These are the
C<UNICODE_WARN_ABOVE_31_BIT> and C<UNICODE_DISALLOW_ABOVE_31_BIT> flags. These
are entirely independent from the deprecation warning for code points above
C<IV_MAX>. On 32-bit machines, it will eventually be forbidden to have any
code point that needs more than 31 bits to represent. When that happens,
effectively the C<UNICODE_DISALLOW_ABOVE_31_BIT> flag will always be set on
32-bit machines. (Of course C<UNICODE_DISALLOW_SUPER> will treat all
above-Unicode code points, including these, as malformations; and
C<UNICODE_WARN_SUPER> warns on these.)
On EBCDIC platforms starting in Perl v5.24, the Perl extension for representing
extremely high code points kicks in at 0x3FFF_FFFF (2**30 -1), which is lower
than on ASCII. Prior to that, code points 2**31 and higher were simply
unrepresentable, and a different, incompatible method was used to represent
code points between 2**30 and 2**31 - 1. The flags C<UNICODE_WARN_ABOVE_31_BIT>
and C<UNICODE_DISALLOW_ABOVE_31_BIT> have the same function as on ASCII
platforms, warning and disallowing 2**31 and higher.
U8* uvchr_to_utf8_flags(U8 *d, UV uv, UV flags)
=for hackers
Found in file utf8.c
=item uvoffuni_to_utf8_flags
X<uvoffuni_to_utf8_flags>
THIS FUNCTION SHOULD BE USED IN ONLY VERY SPECIALIZED CIRCUMSTANCES.
Instead, B<Almost all code should use L</uvchr_to_utf8> or
L</uvchr_to_utf8_flags>>.
This function is like them, but the input is a strict Unicode
(as opposed to native) code point. Only in very rare circumstances should code
not be using the native code point.
For details, see the description for L</uvchr_to_utf8_flags>.
U8* uvoffuni_to_utf8_flags(U8 *d, UV uv,
const UV flags)
=for hackers
Found in file utf8.c
=item uvuni_to_utf8_flags
X<uvuni_to_utf8_flags>
Instead you almost certainly want to use L</uvchr_to_utf8> or
L</uvchr_to_utf8_flags>.
This function is a deprecated synonym for L</uvoffuni_to_utf8_flags>,
which itself, while not deprecated, should be used only in isolated
circumstances. These functions were useful for code that wanted to handle
both EBCDIC and ASCII platforms with Unicode properties, but starting in Perl
v5.20, the distinctions between the platforms have mostly been made invisible
to most code, so this function is quite unlikely to be what you want.
U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
=for hackers
Found in file utf8.c
=item valid_utf8_to_uvchr
X<valid_utf8_to_uvchr>
Like C<L</utf8_to_uvchr_buf>>, but should only be called when it is known that
the next character in the input UTF-8 string C<s> is well-formed (I<e.g.>,
it passes C<L</isUTF8_CHAR>>. Surrogates, non-character code points, and
non-Unicode code points are allowed.
UV valid_utf8_to_uvchr(const U8 *s, STRLEN *retlen)
=for hackers
Found in file inline.h
=back
=head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
=over 8
=item newXSproto
X<newXSproto>
Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
the subs.
=for hackers
Found in file XSUB.h
=item XS_APIVERSION_BOOTCHECK
X<XS_APIVERSION_BOOTCHECK>
Macro to verify that the perl api version an XS module has been compiled against
matches the api version of the perl interpreter it's being loaded into.
XS_APIVERSION_BOOTCHECK;
=for hackers
Found in file XSUB.h
=item XS_VERSION
X<XS_VERSION>
The version identifier for an XS module. This is usually
handled automatically by C<ExtUtils::MakeMaker>. See
C<L</XS_VERSION_BOOTCHECK>>.
=for hackers
Found in file XSUB.h
=item XS_VERSION_BOOTCHECK
X<XS_VERSION_BOOTCHECK>
Macro to verify that a PM module's C<$VERSION> variable matches the XS
module's C<XS_VERSION> variable. This is usually handled automatically by
C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
XS_VERSION_BOOTCHECK;
=for hackers
Found in file XSUB.h
=back
=head1 Warning and Dieing
=over 8
=item ckWARN
X<ckWARN>
Returns a boolean as to whether or not warnings are enabled for the warning
category C<w>. If the category is by default enabled even if not within the
scope of S<C<use warnings>>, instead use the L</ckWARN_d> macro.
bool ckWARN(U32 w)
=for hackers
Found in file warnings.h
=item ckWARN2
X<ckWARN2>
Like C<L</ckWARN>>, but takes two warnings categories as input, and returns
TRUE if either is enabled. If either category is by default enabled even if
not within the scope of S<C<use warnings>>, instead use the L</ckWARN2_d>
macro. The categories must be completely independent, one may not be
subclassed from the other.
bool ckWARN2(U32 w1, U32 w2)
=for hackers
Found in file warnings.h
=item ckWARN3
X<ckWARN3>
Like C<L</ckWARN2>>, but takes three warnings categories as input, and returns
TRUE if any is enabled. If any of the categories is by default enabled even
if not within the scope of S<C<use warnings>>, instead use the L</ckWARN3_d>
macro. The categories must be completely independent, one may not be
subclassed from any other.
bool ckWARN3(U32 w1, U32 w2, U32 w3)
=for hackers
Found in file warnings.h
=item ckWARN4
X<ckWARN4>
Like C<L</ckWARN3>>, but takes four warnings categories as input, and returns
TRUE if any is enabled. If any of the categories is by default enabled even
if not within the scope of S<C<use warnings>>, instead use the L</ckWARN4_d>
macro. The categories must be completely independent, one may not be
subclassed from any other.
bool ckWARN4(U32 w1, U32 w2, U32 w3, U32 w4)
=for hackers
Found in file warnings.h
=item ckWARN_d
X<ckWARN_d>
Like C<L</ckWARN>>, but for use if and only if the warning category is by
default enabled even if not within the scope of S<C<use warnings>>.
bool ckWARN_d(U32 w)
=for hackers
Found in file warnings.h
=item ckWARN2_d
X<ckWARN2_d>
Like C<L</ckWARN2>>, but for use if and only if either warning category is by
default enabled even if not within the scope of S<C<use warnings>>.
bool ckWARN2_d(U32 w1, U32 w2)
=for hackers
Found in file warnings.h
=item ckWARN3_d
X<ckWARN3_d>
Like C<L</ckWARN3>>, but for use if and only if any of the warning categories
is by default enabled even if not within the scope of S<C<use warnings>>.
bool ckWARN3_d(U32 w1, U32 w2, U32 w3)
=for hackers
Found in file warnings.h
=item ckWARN4_d
X<ckWARN4_d>
Like C<L</ckWARN4>>, but for use if and only if any of the warning categories
is by default enabled even if not within the scope of S<C<use warnings>>.
bool ckWARN4_d(U32 w1, U32 w2, U32 w3, U32 w4)
=for hackers
Found in file warnings.h
=item croak
X<croak>
This is an XS interface to Perl's C<die> function.
Take a sprintf-style format pattern and argument list. These are used to
generate a string message. If the message does not end with a newline,
then it will be extended with some indication of the current location
in the code, as described for L</mess_sv>.
The error message will be used as an exception, by default
returning control to the nearest enclosing C<eval>, but subject to
modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
function never returns normally.
For historical reasons, if C<pat> is null then the contents of C<ERRSV>
(C<$@>) will be used as an error message or object instead of building an
error message from arguments. If you want to throw a non-string object,
or build an error message in an SV yourself, it is preferable to use
the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
void croak(const char *pat, ...)
=for hackers
Found in file util.c
=item croak_no_modify
X<croak_no_modify>
Exactly equivalent to C<Perl_croak(aTHX_ "%s", PL_no_modify)>, but generates
terser object code than using C<Perl_croak>. Less code used on exception code
paths reduces CPU cache pressure.
void croak_no_modify()
=for hackers
Found in file util.c
=item croak_sv
X<croak_sv>
This is an XS interface to Perl's C<die> function.
C<baseex> is the error message or object. If it is a reference, it
will be used as-is. Otherwise it is used as a string, and if it does
not end with a newline then it will be extended with some indication of
the current location in the code, as described for L</mess_sv>.
The error message or object will be used as an exception, by default
returning control to the nearest enclosing C<eval>, but subject to
modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak_sv>
function never returns normally.
To die with a simple string message, the L</croak> function may be
more convenient.
void croak_sv(SV *baseex)
=for hackers
Found in file util.c
=item die
X<die>
Behaves the same as L</croak>, except for the return type.
It should be used only where the C<OP *> return type is required.
The function never actually returns.
OP * die(const char *pat, ...)
=for hackers
Found in file util.c
=item die_sv
X<die_sv>
Behaves the same as L</croak_sv>, except for the return type.
It should be used only where the C<OP *> return type is required.
The function never actually returns.
OP * die_sv(SV *baseex)
=for hackers
Found in file util.c
=item vcroak
X<vcroak>
This is an XS interface to Perl's C<die> function.
C<pat> and C<args> are a sprintf-style format pattern and encapsulated
argument list. These are used to generate a string message. If the
message does not end with a newline, then it will be extended with
some indication of the current location in the code, as described for
L</mess_sv>.
The error message will be used as an exception, by default
returning control to the nearest enclosing C<eval>, but subject to
modification by a C<$SIG{__DIE__}> handler. In any case, the C<croak>
function never returns normally.
For historical reasons, if C<pat> is null then the contents of C<ERRSV>
(C<$@>) will be used as an error message or object instead of building an
error message from arguments. If you want to throw a non-string object,
or build an error message in an SV yourself, it is preferable to use
the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
void vcroak(const char *pat, va_list *args)
=for hackers
Found in file util.c
=item vwarn
X<vwarn>
This is an XS interface to Perl's C<warn> function.
C<pat> and C<args> are a sprintf-style format pattern and encapsulated
argument list. These are used to generate a string message. If the
message does not end with a newline, then it will be extended with
some indication of the current location in the code, as described for
L</mess_sv>.
The error message or object will by default be written to standard error,
but this is subject to modification by a C<$SIG{__WARN__}> handler.
Unlike with L</vcroak>, C<pat> is not permitted to be null.
void vwarn(const char *pat, va_list *args)
=for hackers
Found in file util.c
=item warn
X<warn>
This is an XS interface to Perl's C<warn> function.
Take a sprintf-style format pattern and argument list. These are used to
generate a string message. If the message does not end with a newline,
then it will be extended with some indication of the current location
in the code, as described for L</mess_sv>.
The error message or object will by default be written to standard error,
but this is subject to modification by a C<$SIG{__WARN__}> handler.
Unlike with L</croak>, C<pat> is not permitted to be null.
void warn(const char *pat, ...)
=for hackers
Found in file util.c
=item warn_sv
X<warn_sv>
This is an XS interface to Perl's C<warn> function.
C<baseex> is the error message or object. If it is a reference, it
will be used as-is. Otherwise it is used as a string, and if it does
not end with a newline then it will be extended with some indication of
the current location in the code, as described for L</mess_sv>.
The error message or object will by default be written to standard error,
but this is subject to modification by a C<$SIG{__WARN__}> handler.
To warn with a simple string message, the L</warn> function may be
more convenient.
void warn_sv(SV *baseex)
=for hackers
Found in file util.c
=back
=head1 Undocumented functions
The following functions have been flagged as part of the public API,
but are currently undocumented. Use them at your own risk, as the
interfaces are subject to change. Functions that are not listed in this
document are not intended for public use, and should NOT be used under any
circumstances.
If you feel you need to use one of these functions, first send email to
L<perl5-porters@perl.org|mailto:perl5-porters@perl.org>. It may be
that there is a good reason for the function not being documented, and it
should be removed from this list; or it may just be that no one has gotten
around to documenting it. In the latter case, you will be asked to submit a
patch to document the function. Once your patch is accepted, it will indicate
that the interface is stable (unless it is explicitly marked otherwise) and
usable by you.
=over
=item GetVars
X<GetVars>
=item Gv_AMupdate
X<Gv_AMupdate>
=item PerlIO_clearerr
X<PerlIO_clearerr>
=item PerlIO_close
X<PerlIO_close>
=item PerlIO_context_layers
X<PerlIO_context_layers>
=item PerlIO_eof
X<PerlIO_eof>
=item PerlIO_error
X<PerlIO_error>
=item PerlIO_fileno
X<PerlIO_fileno>
=item PerlIO_fill
X<PerlIO_fill>
=item PerlIO_flush
X<PerlIO_flush>
=item PerlIO_get_base
X<PerlIO_get_base>
=item PerlIO_get_bufsiz
X<PerlIO_get_bufsiz>
=item PerlIO_get_cnt
X<PerlIO_get_cnt>
=item PerlIO_get_ptr
X<PerlIO_get_ptr>
=item PerlIO_read
X<PerlIO_read>
=item PerlIO_seek
X<PerlIO_seek>
=item PerlIO_set_cnt
X<PerlIO_set_cnt>
=item PerlIO_set_ptrcnt
X<PerlIO_set_ptrcnt>
=item PerlIO_setlinebuf
X<PerlIO_setlinebuf>
=item PerlIO_stderr
X<PerlIO_stderr>
=item PerlIO_stdin
X<PerlIO_stdin>
=item PerlIO_stdout
X<PerlIO_stdout>
=item PerlIO_tell
X<PerlIO_tell>
=item PerlIO_unread
X<PerlIO_unread>
=item PerlIO_write
X<PerlIO_write>
=item amagic_call
X<amagic_call>
=item amagic_deref_call
X<amagic_deref_call>
=item any_dup
X<any_dup>
=item atfork_lock
X<atfork_lock>
=item atfork_unlock
X<atfork_unlock>
=item av_arylen_p
X<av_arylen_p>
=item av_iter_p
X<av_iter_p>
=item block_gimme
X<block_gimme>
=item call_atexit
X<call_atexit>
=item call_list
X<call_list>
=item calloc
X<calloc>
=item cast_i32
X<cast_i32>
=item cast_iv
X<cast_iv>
=item cast_ulong
X<cast_ulong>
=item cast_uv
X<cast_uv>
=item ck_warner
X<ck_warner>
=item ck_warner_d
X<ck_warner_d>
=item ckwarn
X<ckwarn>
=item ckwarn_d
X<ckwarn_d>
=item clear_defarray
X<clear_defarray>
=item clone_params_del
X<clone_params_del>
=item clone_params_new
X<clone_params_new>
=item croak_memory_wrap
X<croak_memory_wrap>
=item croak_nocontext
X<croak_nocontext>
=item csighandler
X<csighandler>
=item cx_dump
X<cx_dump>
=item cx_dup
X<cx_dup>
=item cxinc
X<cxinc>
=item deb
X<deb>
=item deb_nocontext
X<deb_nocontext>
=item debop
X<debop>
=item debprofdump
X<debprofdump>
=item debstack
X<debstack>
=item debstackptrs
X<debstackptrs>
=item delimcpy
X<delimcpy>
=item despatch_signals
X<despatch_signals>
=item die_nocontext
X<die_nocontext>
=item dirp_dup
X<dirp_dup>
=item do_aspawn
X<do_aspawn>
=item do_binmode
X<do_binmode>
=item do_close
X<do_close>
=item do_gv_dump
X<do_gv_dump>
=item do_gvgv_dump
X<do_gvgv_dump>
=item do_hv_dump
X<do_hv_dump>
=item do_join
X<do_join>
=item do_magic_dump
X<do_magic_dump>
=item do_op_dump
X<do_op_dump>
=item do_open
X<do_open>
=item do_open9
X<do_open9>
=item do_openn
X<do_openn>
=item do_pmop_dump
X<do_pmop_dump>
=item do_spawn
X<do_spawn>
=item do_spawn_nowait
X<do_spawn_nowait>
=item do_sprintf
X<do_sprintf>
=item do_sv_dump
X<do_sv_dump>
=item doing_taint
X<doing_taint>
=item doref
X<doref>
=item dounwind
X<dounwind>
=item dowantarray
X<dowantarray>
=item dump_eval
X<dump_eval>
=item dump_form
X<dump_form>
=item dump_indent
X<dump_indent>
=item dump_mstats
X<dump_mstats>
=item dump_sub
X<dump_sub>
=item dump_vindent
X<dump_vindent>
=item filter_add
X<filter_add>
=item filter_del
X<filter_del>
=item filter_read
X<filter_read>
=item foldEQ_latin1
X<foldEQ_latin1>
=item form_nocontext
X<form_nocontext>
=item fp_dup
X<fp_dup>
=item fprintf_nocontext
X<fprintf_nocontext>
=item free_global_struct
X<free_global_struct>
=item free_tmps
X<free_tmps>
=item get_context
X<get_context>
=item get_mstats
X<get_mstats>
=item get_op_descs
X<get_op_descs>
=item get_op_names
X<get_op_names>
=item get_ppaddr
X<get_ppaddr>
=item get_vtbl
X<get_vtbl>
=item gp_dup
X<gp_dup>
=item gp_free
X<gp_free>
=item gp_ref
X<gp_ref>
=item gv_AVadd
X<gv_AVadd>
=item gv_HVadd
X<gv_HVadd>
=item gv_IOadd
X<gv_IOadd>
=item gv_SVadd
X<gv_SVadd>
=item gv_add_by_type
X<gv_add_by_type>
=item gv_autoload4
X<gv_autoload4>
=item gv_autoload_pv
X<gv_autoload_pv>
=item gv_autoload_pvn
X<gv_autoload_pvn>
=item gv_autoload_sv
X<gv_autoload_sv>
=item gv_check
X<gv_check>
=item gv_dump
X<gv_dump>
=item gv_efullname
X<gv_efullname>
=item gv_efullname3
X<gv_efullname3>
=item gv_efullname4
X<gv_efullname4>
=item gv_fetchfile
X<gv_fetchfile>
=item gv_fetchfile_flags
X<gv_fetchfile_flags>
=item gv_fetchpv
X<gv_fetchpv>
=item gv_fetchpvn_flags
X<gv_fetchpvn_flags>
=item gv_fetchsv
X<gv_fetchsv>
=item gv_fullname
X<gv_fullname>
=item gv_fullname3
X<gv_fullname3>
=item gv_fullname4
X<gv_fullname4>
=item gv_handler
X<gv_handler>
=item gv_name_set
X<gv_name_set>
=item he_dup
X<he_dup>
=item hek_dup
X<hek_dup>
=item hv_common
X<hv_common>
=item hv_common_key_len
X<hv_common_key_len>
=item hv_delayfree_ent
X<hv_delayfree_ent>
=item hv_eiter_p
X<hv_eiter_p>
=item hv_eiter_set
X<hv_eiter_set>
=item hv_free_ent
X<hv_free_ent>
=item hv_ksplit
X<hv_ksplit>
=item hv_name_set
X<hv_name_set>
=item hv_placeholders_get
X<hv_placeholders_get>
=item hv_placeholders_set
X<hv_placeholders_set>
=item hv_rand_set
X<hv_rand_set>
=item hv_riter_p
X<hv_riter_p>
=item hv_riter_set
X<hv_riter_set>
=item ibcmp_utf8
X<ibcmp_utf8>
=item init_global_struct
X<init_global_struct>
=item init_stacks
X<init_stacks>
=item init_tm
X<init_tm>
=item instr
X<instr>
=item is_lvalue_sub
X<is_lvalue_sub>
=item leave_scope
X<leave_scope>
=item load_module_nocontext
X<load_module_nocontext>
=item magic_dump
X<magic_dump>
=item malloc
X<malloc>
=item markstack_grow
X<markstack_grow>
=item mess_nocontext
X<mess_nocontext>
=item mfree
X<mfree>
=item mg_dup
X<mg_dup>
=item mg_size
X<mg_size>
=item mini_mktime
X<mini_mktime>
=item moreswitches
X<moreswitches>
=item mro_get_from_name
X<mro_get_from_name>
=item mro_get_private_data
X<mro_get_private_data>
=item mro_set_mro
X<mro_set_mro>
=item mro_set_private_data
X<mro_set_private_data>
=item my_atof
X<my_atof>
=item my_atof2
X<my_atof2>
=item my_bcopy
X<my_bcopy>
=item my_bzero
X<my_bzero>
=item my_chsize
X<my_chsize>
=item my_cxt_index
X<my_cxt_index>
=item my_cxt_init
X<my_cxt_init>
=item my_dirfd
X<my_dirfd>
=item my_exit
X<my_exit>
=item my_failure_exit
X<my_failure_exit>
=item my_fflush_all
X<my_fflush_all>
=item my_fork
X<my_fork>
=item my_lstat
X<my_lstat>
=item my_memcmp
X<my_memcmp>
=item my_memset
X<my_memset>
=item my_pclose
X<my_pclose>
=item my_popen
X<my_popen>
=item my_popen_list
X<my_popen_list>
=item my_setenv
X<my_setenv>
=item my_socketpair
X<my_socketpair>
=item my_stat
X<my_stat>
=item my_strftime
X<my_strftime>
=item newANONATTRSUB
X<newANONATTRSUB>
=item newANONHASH
X<newANONHASH>
=item newANONLIST
X<newANONLIST>
=item newANONSUB
X<newANONSUB>
=item newATTRSUB
X<newATTRSUB>
=item newAVREF
X<newAVREF>
=item newCVREF
X<newCVREF>
=item newFORM
X<newFORM>
=item newGVREF
X<newGVREF>
=item newGVgen
X<newGVgen>
=item newGVgen_flags
X<newGVgen_flags>
=item newHVREF
X<newHVREF>
=item newHVhv
X<newHVhv>
=item newIO
X<newIO>
=item newMYSUB
X<newMYSUB>
=item newPROG
X<newPROG>
=item newRV
X<newRV>
=item newSUB
X<newSUB>
=item newSVREF
X<newSVREF>
=item newSVpvf_nocontext
X<newSVpvf_nocontext>
=item new_stackinfo
X<new_stackinfo>
=item op_refcnt_lock
X<op_refcnt_lock>
=item op_refcnt_unlock
X<op_refcnt_unlock>
=item parser_dup
X<parser_dup>
=item perl_alloc_using
X<perl_alloc_using>
=item perl_clone_using
X<perl_clone_using>
=item pmop_dump
X<pmop_dump>
=item pop_scope
X<pop_scope>
=item pregcomp
X<pregcomp>
=item pregexec
X<pregexec>
=item pregfree
X<pregfree>
=item pregfree2
X<pregfree2>
=item printf_nocontext
X<printf_nocontext>
=item ptr_table_fetch
X<ptr_table_fetch>
=item ptr_table_free
X<ptr_table_free>
=item ptr_table_new
X<ptr_table_new>
=item ptr_table_split
X<ptr_table_split>
=item ptr_table_store
X<ptr_table_store>
=item push_scope
X<push_scope>
=item re_compile
X<re_compile>
=item re_dup_guts
X<re_dup_guts>
=item re_intuit_start
X<re_intuit_start>
=item re_intuit_string
X<re_intuit_string>
=item realloc
X<realloc>
=item reentrant_free
X<reentrant_free>
=item reentrant_init
X<reentrant_init>
=item reentrant_retry
X<reentrant_retry>
=item reentrant_size
X<reentrant_size>
=item ref
X<ref>
=item reg_named_buff_all
X<reg_named_buff_all>
=item reg_named_buff_exists
X<reg_named_buff_exists>
=item reg_named_buff_fetch
X<reg_named_buff_fetch>
=item reg_named_buff_firstkey
X<reg_named_buff_firstkey>
=item reg_named_buff_nextkey
X<reg_named_buff_nextkey>
=item reg_named_buff_scalar
X<reg_named_buff_scalar>
=item regdump
X<regdump>
=item regdupe_internal
X<regdupe_internal>
=item regexec_flags
X<regexec_flags>
=item regfree_internal
X<regfree_internal>
=item reginitcolors
X<reginitcolors>
=item regnext
X<regnext>
=item repeatcpy
X<repeatcpy>
=item rsignal
X<rsignal>
=item rsignal_state
X<rsignal_state>
=item runops_debug
X<runops_debug>
=item runops_standard
X<runops_standard>
=item rvpv_dup
X<rvpv_dup>
=item safesyscalloc
X<safesyscalloc>
=item safesysfree
X<safesysfree>
=item safesysmalloc
X<safesysmalloc>
=item safesysrealloc
X<safesysrealloc>
=item save_I16
X<save_I16>
=item save_I32
X<save_I32>
=item save_I8
X<save_I8>
=item save_adelete
X<save_adelete>
=item save_aelem
X<save_aelem>
=item save_aelem_flags
X<save_aelem_flags>
=item save_alloc
X<save_alloc>
=item save_aptr
X<save_aptr>
=item save_ary
X<save_ary>
=item save_bool
X<save_bool>
=item save_clearsv
X<save_clearsv>
=item save_delete
X<save_delete>
=item save_destructor
X<save_destructor>
=item save_destructor_x
X<save_destructor_x>
=item save_freeop
X<save_freeop>
=item save_freepv
X<save_freepv>
=item save_freesv
X<save_freesv>
=item save_generic_pvref
X<save_generic_pvref>
=item save_generic_svref
X<save_generic_svref>
=item save_hash
X<save_hash>
=item save_hdelete
X<save_hdelete>
=item save_helem
X<save_helem>
=item save_helem_flags
X<save_helem_flags>
=item save_hints
X<save_hints>
=item save_hptr
X<save_hptr>
=item save_int
X<save_int>
=item save_item
X<save_item>
=item save_iv
X<save_iv>
=item save_list
X<save_list>
=item save_long
X<save_long>
=item save_mortalizesv
X<save_mortalizesv>
=item save_nogv
X<save_nogv>
=item save_op
X<save_op>
=item save_padsv_and_mortalize
X<save_padsv_and_mortalize>
=item save_pptr
X<save_pptr>
=item save_pushi32ptr
X<save_pushi32ptr>
=item save_pushptr
X<save_pushptr>
=item save_pushptrptr
X<save_pushptrptr>
=item save_re_context
X<save_re_context>
=item save_scalar
X<save_scalar>
=item save_set_svflags
X<save_set_svflags>
=item save_shared_pvref
X<save_shared_pvref>
=item save_sptr
X<save_sptr>
=item save_svref
X<save_svref>
=item save_vptr
X<save_vptr>
=item savestack_grow
X<savestack_grow>
=item savestack_grow_cnt
X<savestack_grow_cnt>
=item scan_num
X<scan_num>
=item scan_vstring
X<scan_vstring>
=item seed
X<seed>
=item set_context
X<set_context>
=item set_numeric_local
X<set_numeric_local>
=item set_numeric_radix
X<set_numeric_radix>
=item set_numeric_standard
X<set_numeric_standard>
=item share_hek
X<share_hek>
=item si_dup
X<si_dup>
=item ss_dup
X<ss_dup>
=item stack_grow
X<stack_grow>
=item start_subparse
X<start_subparse>
=item str_to_version
X<str_to_version>
=item sv_2iv
X<sv_2iv>
=item sv_2pv
X<sv_2pv>
=item sv_2uv
X<sv_2uv>
=item sv_catpvf_mg_nocontext
X<sv_catpvf_mg_nocontext>
=item sv_catpvf_nocontext
X<sv_catpvf_nocontext>
=item sv_dup
X<sv_dup>
=item sv_dup_inc
X<sv_dup_inc>
=item sv_peek
X<sv_peek>
=item sv_pvn_nomg
X<sv_pvn_nomg>
=item sv_setpvf_mg_nocontext
X<sv_setpvf_mg_nocontext>
=item sv_setpvf_nocontext
X<sv_setpvf_nocontext>
=item sys_init
X<sys_init>
=item sys_init3
X<sys_init3>
=item sys_intern_clear
X<sys_intern_clear>
=item sys_intern_dup
X<sys_intern_dup>
=item sys_intern_init
X<sys_intern_init>
=item sys_term
X<sys_term>
=item taint_env
X<taint_env>
=item taint_proper
X<taint_proper>
=item unlnk
X<unlnk>
=item unsharepvn
X<unsharepvn>
=item utf16_to_utf8
X<utf16_to_utf8>
=item utf16_to_utf8_reversed
X<utf16_to_utf8_reversed>
=item uvuni_to_utf8
X<uvuni_to_utf8>
=item vdeb
X<vdeb>
=item vform
X<vform>
=item vload_module
X<vload_module>
=item vnewSVpvf
X<vnewSVpvf>
=item vwarner
X<vwarner>
=item warn_nocontext
X<warn_nocontext>
=item warner
X<warner>
=item warner_nocontext
X<warner_nocontext>
=item whichsig
X<whichsig>
=item whichsig_pv
X<whichsig_pv>
=item whichsig_pvn
X<whichsig_pvn>
=item whichsig_sv
X<whichsig_sv>
=back
=head1 AUTHORS
Until May 1997, this document was maintained by Jeff Okamoto
<okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
Stephen McCamant, and Gurusamy Sarathy.
API Listing originally by Dean Roehrich <roehrich@cray.com>.
Updated to be autogenerated from comments in the source by Benjamin Stuhl.
=head1 SEE ALSO
L<perlguts>, L<perlxs>, L<perlxstut>, L<perlintern>
=cut
ex: set ro:
|