/usr/share/perl5/PostScript/File.pm is in libpostscript-file-perl 2.11+dfsg-1.
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 | #---------------------------------------------------------------------
package PostScript::File;
#
# Copyright 2002, 2003 Christopher P Willmot.
# Copyright 2011 Christopher J. Madsen
#
# Author: Chris Willmot <chris AT willmot.co.uk>
# Christopher J. Madsen <perl AT cjmweb.net>
#
# This program is free software; you can redistribute it and/or modify
# it under the same terms as Perl 5 itself.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See either the
# GNU General Public License or the Artistic License for more details.
#
# ABSTRACT: Base class for creating Adobe PostScript files
#---------------------------------------------------------------------
use 5.008;
our $VERSION = '2.11'; ## no critic
# This file is part of PostScript-File 2.11 (October 11, 2011)
use strict;
use warnings;
use Carp 'croak';
use File::Spec ();
use Scalar::Util 'openhandle';
use Exporter 'import';
our %EXPORT_TAGS = (metrics_methods => [qw(
encode_text decode_text convert_hyphens set_auto_hyphen
)]);
our @EXPORT_OK = (qw(check_tilde check_file incpage_label incpage_roman
array_as_string pstr quote_text str),
# These are only for PostScript::File::Metrics:
@{ $EXPORT_TAGS{metrics_methods} });
# Prototypes for functions only
## no critic (ProhibitSubroutinePrototypes)
sub incpage_label ($);
sub incpage_roman ($);
sub check_tilde ($);
sub check_file ($;$$);
## use critic
# global constants
our %strip_re = (
none => qr{\A\z}, # remove nothing
space => qr{^\s+}m, # remove leading spaces
comments => qr{^\s*(?:%(?![!%]).*\n)?}m, # remove single line comments
);
our %encoding_def; # defined near _set_reencode
our ($t1ascii, $ttftotype42);
BEGIN {
# Program to convert .pfb fonts to .pfa on STDOUT:
$t1ascii = 't1ascii' unless defined $t1ascii;
# Program to convert .ttf fonts to .pfa on STDOUT:
$ttftotype42 = 'ttftotype42' unless defined $ttftotype42;
}
# define page sizes here (a4, letter, etc)
# should be Properly Cased
our %size = (
a0 => '2384 3370',
a1 => '1684 2384',
a2 => '1191 1684',
a3 => "841.88976 1190.5512",
a4 => "595.27559 841.88976",
a5 => "420.94488 595.27559",
a6 => '297 420',
a7 => '210 297',
a8 => '148 210',
a9 => '105 148',
b0 => '2920 4127',
b1 => '2064 2920',
b2 => '1460 2064',
b3 => '1032 1460',
b4 => '729 1032',
b5 => '516 729',
b6 => '363 516',
b7 => '258 363',
b8 => '181 258',
b9 => '127 181 ',
b10 => '91 127',
executive => '522 756',
folio => '595 935',
'half-letter' => '612 397',
letter => "612 792",
'us-letter' => '612 792',
legal => '612 1008',
'us-legal' => '612 1008',
tabloid => '792 1224',
'superb' => '843 1227',
ledger => '1224 792',
'comm #10 envelope' => '297 684',
'envelope-monarch' => '280 542',
'envelope-dl' => '312 624',
'envelope-c5' => '461 648',
'europostcard' => '298 420',
);
# The 13 standard fonts that are available on all PS 1 implementations:
our @fonts = qw(
Courier
Courier-Bold
Courier-BoldOblique
Courier-Oblique
Helvetica
Helvetica-Bold
Helvetica-BoldOblique
Helvetica-Oblique
Times-Roman
Times-Bold
Times-BoldItalic
Times-Italic
Symbol
);
# 5.008-compatible version of defined-or:
sub _def { for (@_) { return $_ if defined $_ } undef }
sub new {
my ($class, @options) = @_;
my $opt = {};
if (@options == 1) {
$opt = $options[0];
} else {
%$opt = @options;
}
## Initialization
my $o = {
# PostScript DSC sections
Comments => "", # must include leading '%%' and end with '\n'
DocSupplied => "",
Preview => "",
Defaults => "",
Fonts => "",
Resources => "",
Functions => "",
Setup => "",
PageSetup => "",
Pages => [], # indexed by $o->{p}, 0 based
PageTrailer => "",
Trailer => "",
# internal
p => 0, # current page (0 based)
pagecount => 0, # number of pages
page => [], # array of labels, indexed by $o->{p}
pagelandsc => [], # orientation of each page individually
pageclip => [], # clip to pagebbox
pagebbox => [], # array of bbox, indexed by $o->{p}
bbox => [], # [ x0, y0, x1, y1 ]
embed_fonts => [], # fonts that have been embedded
needed => {}, # DocumentNeededResources
vars => {}, # permanent user variables
pagevars => {}, # user variables reset with each new page
};
bless $o, $class;
## Paper layout
croak "PNG output is no longer supported. Use PostScript::Convert instead"
if $opt->{png};
$o->{eps} = !!$opt->{eps} + 0;
$o->{file_ext} = $opt->{file_ext};
$o->set_filename(@$opt{qw(file dir)});
$o->set_paper( $opt->{paper} );
$o->set_width( $opt->{width} );
$o->set_height( $opt->{height} );
$o->set_landscape( $opt->{landscape} );
## Debug options
$o->{debug} = $opt->{debug}; # undefined is an option
if ($o->{debug}) {
$o->{db_active} = _def($opt->{db_active}, 1);
$o->{db_bufsize} = _def($opt->{db_bufsize}, 256);
$o->{db_font} = _def($opt->{db_font}, "Courier");
$o->{db_fontsize} = _def($opt->{db_fontsize}, 10);
$o->{db_ytop} = _def($opt->{db_ytop}, ($o->{bbox}[3] - $o->{db_fontsize} - 6));
$o->{db_ybase} = _def($opt->{db_ybase}, 6);
$o->{db_xpos} = _def($opt->{db_xpos}, 6);
$o->{db_xtab} = _def($opt->{db_xtab}, 10);
$o->{db_xgap} = _def($opt->{db_xgap}, ($o->{bbox}[2] - $o->{bbox}[0] - $o->{db_xpos})/4);
$o->{db_color} = _def($opt->{db_color}, "0 setgray");
}
## Bounding box
my $x0 = $o->{bbox}[0] + _def($opt->{left}, 28);
my $y0 = $o->{bbox}[1] + _def($opt->{bottom}, 28);
my $x1 = $o->{bbox}[2] - _def($opt->{right}, 28);
my $y1 = $o->{bbox}[3] - _def($opt->{top}, 28);
$o->set_bounding_box( $x0, $y0, $x1, $y1 );
$o->set_clipping( $opt->{clipping} );
## Other options
$o->{title} = $opt->{title};
$o->{version} = $opt->{version};
$o->{langlevel} = $opt->{langlevel};
$o->{extensions} = $opt->{extensions};
$o->{order} = defined($opt->{order}) ? ucfirst lc $opt->{order} : undef;
$o->set_page_label( $opt->{page} );
$o->set_incpage_handler( $opt->{incpage_handler} );
$o->{errx} = _def($opt->{errx}, 72);
$o->{erry} = _def($opt->{erry}, 72);
$o->{errmsg} = _def($opt->{errmsg}, "ERROR:");
$o->{errfont} = _def($opt->{errfont}, "Courier-Bold");
$o->{errsize} = _def($opt->{errsize}, 12);
$o->{font_suffix} = _def($opt->{font_suffix}, "-iso");
$o->{clipcmd} = _def($opt->{clip_command}, "clip");
$o->{errors} = _def($opt->{errors}, 1);
$o->{headings} = _def($opt->{headings}, 0);
$o->set_strip( $opt->{strip} );
$o->_set_reencode( $opt->{reencode} );
$o->set_auto_hyphen(_def($opt->{auto_hyphen}, 1));
$o->need_resource(font => @{ $opt->{need_fonts} }) if $opt->{need_fonts};
$o->newpage if _def($opt->{newpage}, 1);
## Finish
return $o;
}
sub newpage {
my ($o, $page) = @_;
my $oldpage = $o->{page}[$o->{p}];
# Don't use _def here, because we don't want to call
# incpage_handler if the user supplied a page label:
my $newpage = defined $page
? $page
# If this is the very first page, don't increment the page number:
: ($o->{pagecount}
? $o->{incpage}->($oldpage)
: $oldpage);
my $p = $o->{p} = $o->{pagecount}++;
$o->{page}[$p] = $newpage;
$o->{pagebbox}[$p] = [ @{$o->{bbox}} ];
$o->{pageclip}[$p] = $o->{clipping};
$o->{pagelandsc}[$p] = $o->{landscape};
$o->{Pages}->[$p] = "";
$o->{pagevars} = {};
}
sub pre_pages {
my ($o, $landscape, $clipping, $filename) = @_;
my $docSupplied = $o->{DocSupplied};
## Thanks to Johan Vromans for the ISOLatin1Encoding.
my $fonts = "";
if ($o->{reencode}) {
my $encoding = $o->{reencode};
my $ext = $o->{font_suffix};
$fonts = "% Handle font encoding:\n";
$fonts .= $o->_here_doc(<<"END_FONTS");
/STARTDIFFENC { mark } bind def
/ENDDIFFENC {
% /NewEnc BaseEnc STARTDIFFENC number or glyphname ... ENDDIFFENC -
counttomark 2 add -1 roll 256 array copy
/TempEncode exch def
% pointer for sequential encodings
/EncodePointer 0 def
{
% Get the bottom object
counttomark -1 roll
% Is it a mark?
dup type dup /marktype eq {
% End of encoding
pop pop exit
} {
/nametype eq {
% Insert the name at EncodePointer
% and increment the pointer.
TempEncode EncodePointer 3 -1 roll put
/EncodePointer EncodePointer 1 add def
} {
% Set the EncodePointer to the number
/EncodePointer exch def
} ifelse
} ifelse
} loop
TempEncode def
} bind def
\n$encoding_def{$encoding}
% Name: Re-encode Font
% Description: Creates a new font using the named encoding.
/REENCODEFONT { % /Newfont NewEncoding /Oldfont
findfont dup length 4 add dict
begin
{ % forall
1 index /FID ne
2 index /UniqueID ne and
2 index /XUID ne and
{ def } { pop pop } ifelse
} forall
/Encoding exch def
% defs for DPS
/BitmapWidths false def
/ExactSize 0 def
/InBetweenSize 0 def
/TransformedChar 0 def
currentdict
end
definefont pop
} bind def
END_FONTS
$fonts .= "\n% Reencode the fonts:\n";
# If no fonts listed, assume the standard ones:
$o->{needed}{font} ||= { map { $_ => 1 } @fonts };
for my $font (sort(keys(%{ $o->{needed}{font} }),
@{ $o->{embed_fonts} })) {
next if $font eq 'Symbol'; # doesn't use StandardEncoding
$fonts .= "/${font}$ext $encoding /$font REENCODEFONT\n";
}
$fonts .= "% end font encoding\n";
} # end if reencode
# Prepare the PostScript file
my $postscript = $o->{eps} ? "\%!PS-Adobe-3.0 EPSF-3.0\n" : "\%!PS-Adobe-3.0\n";
if ($o->{eps}) {
$postscript .= $o->bbox_comment('', $o->{bbox});
}
if ($o->{headings}) {
require Sys::Hostname;
my $user = getlogin() || (getpwuid($<))[0] || "Unknown";
my $hostname = Sys::Hostname::hostname();
$postscript .= $o->_here_doc(<<END_TITLES);
\%\%For: $user\@$hostname
\%\%Creator: Perl module ${\( ref $o )} v$PostScript::File::VERSION
\%\%CreationDate: ${\( scalar localtime )}
END_TITLES
$postscript .= $o->_here_doc(<<END_PS_ONLY) if (not $o->{eps});
\%\%DocumentMedia: $o->{paper} $o->{width} $o->{height} 80 ( ) ( )
END_PS_ONLY
}
my $landscapefn = "";
$landscapefn .= $o->_here_doc(<<END_LANDSCAPE) if ($landscape);
% Rotate page 90 degrees
% _ => _
/landscape {
$o->{width} 0 translate
90 rotate
} bind def
END_LANDSCAPE
my $clipfn = "";
if ($clipping) {
my $clipcmd = $o->{clipcmd};
$clipcmd = "gsave 0 setgray 0.5 setlinewidth $clipcmd grestore newpath"
if $clipcmd eq 'stroke';
$clipfn .= $o->_here_doc(<<END_CLIPPING);
% Draw box as clipping path
% x0 y0 x1 y1 => _
/cliptobox {
4 dict begin
/y1 exch def /x1 exch def /y0 exch def /x0 exch def
newpath
x0 y0 moveto x0 y1 lineto x1 y1 lineto x1 y0 lineto
closepath
$clipcmd
end
} bind def
END_CLIPPING
} # end if $clipping
my $errorfn = "";
if ($o->{errors}) {
$o->need_resource(font => $o->{errfont});
$errorfn .= $o->_here_doc(<<END_ERRORS);
/errx $o->{errx} def
/erry $o->{erry} def
/errmsg ($o->{errmsg}) def
/errfont /$o->{errfont} def
/errsize $o->{errsize} def
% Report fatal error on page
% _ str => _
/report_error {
0 setgray
errfont findfont errsize scalefont setfont
errmsg errx erry moveto show
80 string cvs errx erry errsize sub moveto show
stop
} bind def
% PostScript errors printed on page
% not called directly
errordict begin
/handleerror {
\$error begin
false binary
0 setgray
errfont findfont errsize scalefont setfont
errx erry moveto
errmsg show
errx erry errsize sub moveto
errorname 80 string cvs show
stop
} def
end
END_ERRORS
} # end if $o->{errors}
my $debugfn = "";
if ($o->{debug}) {
$o->need_resource(font => $o->{db_font});
$debugfn .= $o->_here_doc(<<END_DEBUG_ON);
/debugdict 25 dict def
debugdict begin
/db_newcol {
debugdict begin
/db_ypos db_ytop def
/db_xpos db_xpos db_xgap add def
end
} bind def
% _ db_newcol => _
/db_down {
debugdict begin
db_ypos db_ybase gt {
/db_ypos db_ypos db_ygap sub def
}{
db_newcol
} ifelse
end
} bind def
% _ db_down => _
/db_indent {
debug_dict begin
/db_xpos db_xpos db_xtab add def
end
} bind def
% _ db_indent => _
/db_unindent {
debugdict begin
/db_xpos db_xpos db_xtab sub def
end
} bind def
% _ db_unindent => _
/db_show {
debugdict begin
db_active 0 ne {
gsave
newpath
$o->{db_color}
/$o->{db_font} findfont $o->{db_fontsize} scalefont setfont
db_xpos db_ypos moveto
dup type
dup (arraytype) eq {
pop db_array
}{
dup (marktype) eq {
pop pop (--mark--) $o->{db_bufsize} string cvs show
}{
pop $o->{db_bufsize} string cvs show
} ifelse
db_down
} ifelse
stroke
grestore
}{ pop } ifelse
end
} bind def
% _ (msg) db_show => _
/db_nshow {
debugdict begin
db_show
/db_num exch def
db_num count gt {
(Not enough on stack) db_show
}{
db_num {
dup db_show
db_num 1 roll
} repeat
(----------) db_show
} ifelse
end
} bind def
% _ n (str) db_nshow => _
/db_stack {
count 0 gt {
count
$o->{debug} 2 ge {
1 sub
} if
(The stack holds...) db_nshow
} {
(Empty stack) db_show
} ifelse
} bind def
% _ db_stack => _
/db_one {
debugdict begin
db_temp cvs
dup length exch
db_buf exch db_bpos exch putinterval
/db_bpos exch db_bpos add def
end
} bind def
% _ any db_one => _
/db_print {
debugdict begin
/db_temp $o->{db_bufsize} string def
/db_buf $o->{db_bufsize} string def
0 1 $o->{db_bufsize} sub 1 { db_buf exch 32 put } for
/db_bpos 0 def
{
db_one
( ) db_one
} forall
db_buf db_show
end
} bind def
% _ [array] db_print => _
/db_array {
mark ([) 2 index aload pop (]) ] db_print pop
} bind def
% _ [array] db_array => _
/db_point {
[ 1 index (\\() 5 index (,) 6 index (\\)) ] db_print
pop
} bind def
% _ x y (str) db_point => _ x y
/db_where {
where {
pop (found) db_show
}{
(not found) db_show
} ifelse
} bind def
% _ var db_where => _
/db_on {
debugdict begin
/db_active 1 def
end
} bind def
% _ db_on => _
/db_off {
debugdict begin
/db_active 0 def
end
} bind def
% _ db_on => _
/db_active $o->{db_active} def
/db_ytop $o->{db_ytop} def
/db_ybase $o->{db_ybase} def
/db_xpos $o->{db_xpos} def
/db_xtab $o->{db_xtab} def
/db_xgap $o->{db_xgap} def
/db_ygap $o->{db_fontsize} def
/db_ypos $o->{db_ytop} def
end
END_DEBUG_ON
} # end if $o->{debug}
$debugfn .= $o->_here_doc(<<END_DEBUG_OFF) if (defined($o->{debug}) and not $o->{debug});
% Define out the db_ functions
/debugdict 25 dict def
debugdict begin
/db_newcol { } bind def
/db_down { } bind def
/db_indent { } bind def
/db_unindent { } bind def
/db_show { pop } bind def
/db_nshow { pop pop } bind def
/db_stack { } bind def
/db_print { pop } bind def
/db_array { pop } bind def
/db_point { pop pop pop } bind def
end
END_DEBUG_OFF
my $supplied = "";
if ($landscapefn or $clipfn or $errorfn or $debugfn) {
$docSupplied .= "\%\%+ procset PostScript_File $VERSION 0\n";
$supplied .= $o->_here_doc(<<END_DOC_SUPPLIED);
\%\%BeginResource: procset PostScript_File $VERSION 0
$landscapefn
$clipfn
$errorfn
$debugfn
\%\%EndResource
END_DOC_SUPPLIED
}
my $docNeeded = $o->_build_needed;
my $title = $o->{title};
$title = $o->quote_text($filename)
if not defined $title and defined $filename;
$postscript .= $o->{Comments} if ($o->{Comments});
$postscript .= "\%\%Orientation: ${\( $o->{landscape} ? 'Landscape' : 'Portrait' )}\n";
$postscript .= $docNeeded if $docNeeded;
$postscript .= "\%\%DocumentSuppliedResources:\n$docSupplied" if $docSupplied;
$postscript .= $o->encode_text("\%\%Title: $title\n") if defined $title;
$postscript .= "\%\%Version: $o->{version}\n" if ($o->{version});
$postscript .= "\%\%Pages: $o->{pagecount}\n" if ((not $o->{eps}) and ($o->{pagecount} > 1));
$postscript .= "\%\%PageOrder: $o->{order}\n" if ((not $o->{eps}) and ($o->{order}));
$postscript .= "\%\%Extensions: $o->{extensions}\n" if ($o->{extensions});
$postscript .= "\%\%LanguageLevel: $o->{langlevel}\n" if ($o->{langlevel});
$postscript .= "\%\%EndComments\n";
$postscript .= $o->{Preview} if ($o->{Preview});
$postscript .= $o->_here_doc(<<END_DEFAULTS) if ($o->{Defaults});
\%\%BeginDefaults
$o->{Defaults}
\%\%EndDefaults
END_DEFAULTS
$postscript .= $o->_here_doc(<<END_PROLOG);
\%\%BeginProlog
$supplied
$o->{Functions}
\%\%EndProlog
END_PROLOG
my $setup = "$o->{Fonts}$fonts$o->{Resources}$o->{Setup}";
$postscript .= "%%BeginSetup\n$setup%%EndSetup\n" if $setup;
return $postscript;
}
# Internal method, used by output()
sub _build_needed
{
my $o = shift;
my $needed = $o->{needed};
return unless %$needed;
my $comment = "%%DocumentNeededResources:\n";
foreach my $type (sort keys %$needed) {
if ($type eq 'font') {
# Remove any embedded fonts from the needed fonts:
delete $needed->{$type}{$_} for @{ $o->{embed_fonts} };
} # end if fonts
next unless %{ $needed->{$type} };
my $prefix = "%%+ $type";
my $maxLen = 79 - length $prefix;
my @list = '';
foreach my $resource (sort keys %{ $needed->{$type} }) {
push @list, ''
if length $list[-1]
and length($resource) + length($list[-1]) >= $maxLen;
$list[-1] .= " $resource";
} # end foreach $resource
$comment .= "$prefix$_\n" for @list;
} # end foreach $type
$comment;
} # end _build_needed
sub post_pages {
my $o = shift;
my $postscript = "";
my $trailer = $o->{Trailer};
$trailer .= "% Local\ Variables:\n% coding: " .
$o->{encoding}->mime_name . "\n% End:\n"
if $o->{encoding};
$postscript .= "%%Trailer\n$trailer" if $trailer;
$postscript .= "\%\%EOF\n";
return $postscript;
}
# Internal method, used by output()
sub output {
my ($o, $filename, $dir) = @_;
my $fh = openhandle $filename;
# Don't permanently change filename:
local $o->{filename} = $o->{filename};
$o->set_filename($filename, $dir) if @_ > 1 and not $fh;
my ($debugbegin, $debugend) = ("", "");
if (defined $o->{debug}) {
$debugbegin = "debugdict begin\nuserdict begin";
$debugend = "end\nend";
if ($o->{debug} >= 2) {
$debugbegin = $o->_here_doc(<<END_DEBUG_BEGIN);
debugdict begin
userdict begin
mark
(Start of page) db_show
END_DEBUG_BEGIN
$debugend = $o->_here_doc(<<END_DEBUG_END);
(End of page) db_show
db_stack
cleartomark
end
end
END_DEBUG_END
}
} else {
$debugbegin = "userdict begin";
$debugend = "end";
}
if ($o->{eps}) {
my @pages;
my $p = 0;
do {
my $epsfile;
if (defined $o->{filename}) {
$epsfile = ($o->{pagecount} > 1) ? "$o->{filename}-$o->{page}[$p]"
: "$o->{filename}";
$epsfile .= defined($o->{file_ext}) ? $o->{file_ext}
: ($o->{Preview} ? ".epsi" : ".epsf");
}
my $postscript = "";
my $page = $o->{page}->[$p];
my @pbox = $o->get_page_bounding_box($page);
$o->set_bounding_box(@pbox);
$postscript .= $o->pre_pages($o->{pagelandsc}[$p], $o->{pageclip}[$p], $epsfile);
$postscript .= "landscape\n" if ($o->{pagelandsc}[$p]);
$postscript .= "$pbox[0] $pbox[1] $pbox[2] $pbox[3] cliptobox\n" if ($o->{pageclip}[$p]);
$postscript .= "$debugbegin\n";
$postscript .= $o->{Pages}->[$p];
$postscript .= "$debugend\n";
$postscript .= $o->post_pages();
push @pages, $o->print_file( $fh || $epsfile, $postscript );
$p++;
} while ($p < $o->{pagecount});
return wantarray ? @pages : $pages[0];
} else {
my $landscape = $o->{landscape};
foreach my $pl (@{$o->{pagelandsc}}) {
$landscape |= $pl;
}
my $clipping = $o->{clipping};
foreach my $cl (@{$o->{pageclip}}) {
$clipping |= $cl;
}
my $psfile = $o->{filename};
$psfile .= defined($o->{file_ext}) ? $o->{file_ext} : '.ps'
if defined $psfile;
my $postscript = $o->pre_pages($landscape, $clipping, $psfile);
for (my $p = 0; $p < $o->{pagecount}; $p++) {
my $page = $o->{page}->[$p];
my @pbox = $o->get_page_bounding_box($page);
my ($landscape, $pagebb);
if ($o->{pagelandsc}[$p]) {
$landscape = "landscape";
$pagebb = $o->bbox_comment(Page => [ @pbox[1,0,3,2] ]);
} else {
$landscape = "";
$pagebb = $o->bbox_comment(Page => \@pbox);
}
my $cliptobox = $o->{pageclip}[$p] ? "$pbox[0] $pbox[1] $pbox[2] $pbox[3] cliptobox" : "";
$postscript .= $o->_here_doc(<<END_PAGE_SETUP);
\%\%Page: $o->{page}->[$p] ${\($p+1)}
$pagebb\%\%BeginPageSetup
/pagelevel save def
$landscape
$cliptobox
$debugbegin
$o->{PageSetup}
\%\%EndPageSetup
END_PAGE_SETUP
$postscript .= $o->{Pages}->[$p];
$postscript =~ s/\n?\z/\n/; # Ensure LF at end
$postscript .= $o->_here_doc(<<END_PAGE_TRAILER);
\%\%PageTrailer
$o->{PageTrailer}
$debugend
pagelevel restore
showpage
END_PAGE_TRAILER
}
$postscript .= $o->post_pages();
return $o->print_file( $fh || $psfile, $postscript );
}
}
sub as_string { shift->output(undef) }
sub testable_output
{
my ($o, $verbatim) = @_;
my $ps = $o->output(undef);
unless ($verbatim) {
# Remove PostScript::File generated code:
$ps =~ s/^%%BeginResource: procset PostScript_File.*?^%%EndResource\n//msg;
$ps =~ s/^%%\+ procset PostScript_File.*\n//mg;
$ps =~ s/^% Handle font encoding:\n.*?^% end font encoding\n//ms;
$ps =~ s/^% Local Variables:\n.*?^% End:\n//ms;
$ps =~ s/^%%Trailer\n(?=%%EOF\n)//m;
} # end unless $verbatim
$ps;
} # end testable_output
#---------------------------------------------------------------------
# Create a BoundingBox: comment,
# and a HiRes version if the box has a fractional part:
sub bbox_comment
{
my ($o, $type, $bbox) = @_;
my $comment = join(' ', @$bbox);
if ($comment =~ /\./) {
$comment = sprintf("%d %d %d %d\n%%%%%sHiResBoundingBox: %s",
(map { $_ + 0.999999 } @$bbox),
$type, $comment);
} # end if fractional bbox
"%%${type}BoundingBox: $comment\n";
} # end bbox_comment
sub print_file
{
my $o = shift;
my $filename = shift;
if (defined $filename) {
my $outfile = openhandle $filename;
if ($outfile) {
print $outfile $_[0];
return;
} # end if passed a filehandle
open($outfile, ">", $filename)
or die "Unable to write to \'$filename\' : $!\nStopped";
print $outfile $_[0];
close $outfile;
return $filename;
} else {
return $_[0];
} # end else no filename
} # end print_file
# Internal method, used by output()
# Expects file name and contents
sub get_auto_hyphen {
my $o = shift;
return $o->{auto_hyphen};
}
sub set_auto_hyphen {
my ($o, $translate) = @_;
$o->{auto_hyphen} = $o->{encoding} && $translate;
}
sub get_filename {
my $o = shift;
return $o->{filename};
}
sub set_filename {
my ($o, $filename, $dir) = @_;
$o->{filename} = ((defined($filename) and length($filename))
? check_file($filename, $dir)
: undef);
}
sub get_file_ext {
shift->{file_ext};
}
sub set_file_ext {
my ($o, $ext) = @_;
$o->{file_ext} = $ext;
}
sub get_eps { my $o = shift; return $o->{eps}; }
sub get_paper {
my $o = shift;
return $o->{paper};
}
sub set_paper {
my $o = shift;
my $paper = shift || "A4";
my ($width, $height) = split(/\s+/, $size{lc($paper)} || '');
if (not $height and $paper =~ /^(\d+(?:\.\d+)?)\s*x\s*(\d+(?:\.\d+)?)$/i) {
$width = $1;
$height = $2;
$paper = 'Custom';
} # end if $paper is 'WIDTH x HEIGHT'
if ($height) {
$o->{paper} = $paper;
$o->{width} = $width;
$o->{height} = $height;
if ($o->{landscape}) {
$o->{bbox}[0] = 0;
$o->{bbox}[1] = 0;
$o->{bbox}[2] = $height;
$o->{bbox}[3] = $width;
} else {
$o->{bbox}[0] = 0;
$o->{bbox}[1] = 0;
$o->{bbox}[2] = $width;
$o->{bbox}[3] = $height;
}
}
}
sub get_width {
my $o = shift;
return $o->{width};
}
sub set_width {
my ($o, $width) = @_;
if (defined($width) and ($width+0)) {
$o->{width} = $width;
$o->{paper} = "Custom";
if ($o->{landscape}) {
$o->{bbox}[1] = 0;
$o->{bbox}[3] = $width;
} else {
$o->{bbox}[0] = 0;
$o->{bbox}[2] = $width;
}
}
}
sub get_height {
my $o = shift;
return $o->{height};
}
sub set_height {
my ($o, $height) = @_;
if (defined($height) and ($height+0)) {
$o->{height} = $height;
$o->{paper} = "Custom";
if ($o->{landscape}) {
$o->{bbox}[0] = 0;
$o->{bbox}[2] = $height;
} else {
$o->{bbox}[1] = 0;
$o->{bbox}[3] = $height;
}
}
}
sub get_landscape {
my $o = shift;
return $o->{landscape};
}
sub set_landscape {
my $o = shift;
my $landscape = (!!shift) + 0;
$o->{landscape} = 0 unless (defined $o->{landscape});
if ($o->{landscape} != $landscape) {
$o->{landscape} = $landscape;
($o->{bbox}[0], $o->{bbox}[1]) = ($o->{bbox}[1], $o->{bbox}[0]);
($o->{bbox}[2], $o->{bbox}[3]) = ($o->{bbox}[3], $o->{bbox}[2]);
}
}
sub get_clipping {
my $o = shift;
return $o->{clipping};
}
sub set_clipping {
my $o = shift;
$o->{clipping} = (!!shift) + 0;
}
our %encoding_name = qw(
iso-8859-1 ISOLatin1Encoding
cp1252 Win1252Encoding
);
%encoding_def = (
ISOLatin1Encoding => <<'END ISOLatin1Encoding',
% Define ISO Latin1 encoding if it doesnt exist
/ISOLatin1Encoding where {
% (ISOLatin1 exists!) =
pop
} {
(ISOLatin1 does not exist, creating...) =
/ISOLatin1Encoding StandardEncoding STARTDIFFENC
45 /minus
144 /dotlessi /grave /acute /circumflex /tilde
/macron /breve /dotaccent /dieresis /.notdef /ring
/cedilla /.notdef /hungarumlaut /ogonek /caron /space
/exclamdown /cent /sterling /currency /yen /brokenbar
/section /dieresis /copyright /ordfeminine
/guillemotleft /logicalnot /hyphen /registered
/macron /degree /plusminus /twosuperior
/threesuperior /acute /mu /paragraph /periodcentered
/cedilla /onesuperior /ordmasculine /guillemotright
/onequarter /onehalf /threequarters /questiondown
/Agrave /Aacute /Acircumflex /Atilde /Adieresis
/Aring /AE /Ccedilla /Egrave /Eacute /Ecircumflex
/Edieresis /Igrave /Iacute /Icircumflex /Idieresis
/Eth /Ntilde /Ograve /Oacute /Ocircumflex /Otilde
/Odieresis /multiply /Oslash /Ugrave /Uacute
/Ucircumflex /Udieresis /Yacute /Thorn /germandbls
/agrave /aacute /acircumflex /atilde /adieresis
/aring /ae /ccedilla /egrave /eacute /ecircumflex
/edieresis /igrave /iacute /icircumflex /idieresis
/eth /ntilde /ograve /oacute /ocircumflex /otilde
/odieresis /divide /oslash /ugrave /uacute
/ucircumflex /udieresis /yacute /thorn /ydieresis
ENDDIFFENC
} ifelse
END ISOLatin1Encoding
Win1252Encoding => <<'END Win1252Encoding',
% Define Windows Latin1 encoding
/Win1252Encoding StandardEncoding STARTDIFFENC
% LanguageLevel 1 may require these to be mapped somewhere:
17 /dotlessi /dotaccent /ring /caron
% Restore glyphs for standard ASCII characters:
45 /minus
96 /grave
% Here are the CP1252 extensions to ISO-8859-1:
128 /Euro /.notdef /quotesinglbase /florin /quotedblbase
/ellipsis /dagger /daggerdbl /circumflex /perthousand
/Scaron /guilsinglleft /OE /.notdef /Zcaron /.notdef
/.notdef /quoteleft /quoteright /quotedblleft /quotedblright
/bullet /endash /emdash /tilde /trademark /scaron
/guilsinglright /oe /.notdef /zcaron /Ydieresis
% We now return you to your ISO-8859-1 character set:
/space
/exclamdown /cent /sterling /currency /yen /brokenbar
/section /dieresis /copyright /ordfeminine
/guillemotleft /logicalnot /hyphen /registered
/macron /degree /plusminus /twosuperior
/threesuperior /acute /mu /paragraph /periodcentered
/cedilla /onesuperior /ordmasculine /guillemotright
/onequarter /onehalf /threequarters /questiondown
/Agrave /Aacute /Acircumflex /Atilde /Adieresis
/Aring /AE /Ccedilla /Egrave /Eacute /Ecircumflex
/Edieresis /Igrave /Iacute /Icircumflex /Idieresis
/Eth /Ntilde /Ograve /Oacute /Ocircumflex /Otilde
/Odieresis /multiply /Oslash /Ugrave /Uacute
/Ucircumflex /Udieresis /Yacute /Thorn /germandbls
/agrave /aacute /acircumflex /atilde /adieresis
/aring /ae /ccedilla /egrave /eacute /ecircumflex
/edieresis /igrave /iacute /icircumflex /idieresis
/eth /ntilde /ograve /oacute /ocircumflex /otilde
/odieresis /divide /oslash /ugrave /uacute
/ucircumflex /udieresis /yacute /thorn /ydieresis
ENDDIFFENC
END Win1252Encoding
); # end %encoding_def
sub _set_reencode
{
my ($o, $encoding) = @_;
return unless $encoding;
if ($encoding eq 'ISOLatin1Encoding') {
$o->{reencode} = $encoding;
return;
} # end if backwards compatible ISOLatin1Encoding
$o->{reencode} = $encoding_name{$encoding}
or croak "Invalid reencode setting $encoding";
require Encode; Encode->VERSION(2.21); # Need mime_name method
$o->{encoding} = Encode::find_encoding($encoding)
or croak "Can't find encoding $encoding";
} # end _set_reencode
our %encode_char = (
8208 => pack(C => 0xAD), # U+2010 HYPHEN
8209 => pack(C => 0xAD), # U+2011 NON-BREAKING HYPHEN
8722 => pack(C => 0x2D), # U+2212 MINUS SIGN
65533 => pack(C => 0x3F), # U+FFFD REPLACEMENT CHARACTER
);
sub encode_text
{
my $o = shift;
my $encoding = $o->{encoding};
if ($encoding and Encode::is_utf8( $_[0] )) {
$encoding->encode($_[0], sub {
$encode_char{$_[0]} || do {
if ($_[0] < 0x100) {
pack C => $_[0]; # Unmapped chars stay themselves
} else {
warn sprintf("PostScript::File can't convert U+%04X to %s\n",
$_[0], $encoding->name);
'?'
}
}; # end invalid character
});
} else {
$_[0];
}
} # end encode_text
sub decode_text
{
my $o = shift; # $text, $preserve_minus
my $encoding = $o->{encoding};
if ($encoding and not Encode::is_utf8( $_[0] )) {
my $text = $encoding->decode($_[0], sub { pack U => shift });
# Protect - from hyphen-minus processing if $preserve_minus:
$text =~ s/-/\x{2212}/g if $_[1];
$text;
} else {
$_[0];
}
} # end decode_text
sub convert_hyphens
{
my $o = shift;
if ($_[0] =~ /-/) {
# Text contains at least one hyphen-minus character:
my $text = $o->decode_text(shift);
# If it's surrounded by whitespace, or
# it's preceded by whitespace and followed by a digit,
# it's a minus sign (U+2212):
$text =~ s/(?: ^ | (?<=\s) ) - (?= \d | \s | $ ) /\x{2212}/gx;
# If it's surrounded by digits, or
# it's preceded by punctuation and followed by a digit,
# it's a minus sign (U+2212):
$text =~ s/ (?<=[\d[:punct:]]) - (?=\d) /\x{2212}/gx;
# If it's followed by a currency symbol, it's a minus sign (U+2212):
$text =~ s/ - (?=\p{Sc}) /\x{2212}/gx;
# Otherwise, it's a hyphen (U+2010):
$text =~ s/-/\x{2010}/gx;
$text;
} else {
shift; # Return text unmodified
}
} # end convert_hyphens
sub get_metrics
{
my ($o, $font, $size, $encoding) = @_;
# Figure out what encoding to ask for:
unless ($encoding) {
if ($font eq 'Symbol') {
$encoding = 'sym';
}
elsif ($o->{reencode} and $font =~ s/\Q$o->{font_suffix}\E$//) {
$encoding = $o->{encoding}->name || 'iso-8859-1';
} else {
$encoding = 'std';
}
} # end unless $encoding supplied as parameter
# Create the Metrics object:
require PostScript::File::Metrics;
my $metrics = PostScript::File::Metrics->new($font, $size, $encoding);
# Whatever encoding they asked for, make sure that the
# auto-translation matches what we're doing:
$metrics->{encoding} = $o->{encoding};
$metrics->{auto_hyphen} = $o->{auto_hyphen};
$metrics;
} # end get_metrics
sub get_strip {
my $o = shift;
return $o->{strip_type};
}
sub set_strip {
my ($o, $strip) = @_;
if (not defined $strip) { $strip = 'space' }
else { $strip = lc $strip }
$o->{strip} = $strip_re{$strip}
or croak "Invalid strip type $strip";
$o->{strip_type} = $strip;
}
sub get_page_landscape {
my $o = shift;
my $p = $o->get_ordinal( shift );
return $o->{pagelandsc}[$p];
}
sub set_page_landscape {
my $o = shift;
my $p = (@_ == 2) ? $o->get_ordinal(shift) : $o->{p};
my $landscape = (!!shift) + 0;
$o->{pagelandsc}[$p] = 0 unless (defined $o->{pagelandsc}[$p]);
if ($o->{pagelandsc}[$p] != $landscape) {
($o->{pagebbox}[$p][0], $o->{pagebbox}[$p][1]) = ($o->{pagebbox}[$p][1], $o->{pagebbox}[$p][0]);
($o->{pagebbox}[$p][2], $o->{pagebbox}[$p][3]) = ($o->{pagebbox}[$p][3], $o->{pagebbox}[$p][2]);
}
$o->{pagelandsc}[$p] = $landscape;
}
sub get_page_clipping {
my $o = shift;
my $p = $o->get_ordinal( shift );
return $o->{pageclip}[$p];
}
sub set_page_clipping {
my $o = shift;
my $p = (@_ == 2) ? $o->get_ordinal(shift) : $o->{p};
$o->{pageclip}[$p] = (!!shift) + 0;
}
sub get_page_label {
my $o = shift;
return $o->{page}[$o->{p}];
}
sub set_page_label {
my $o = shift;
my $page = shift || 1;
$o->{page}[$o->{p}] = $page;
}
sub get_incpage_handler {
my $o = shift;
return $o->{incpage};
}
sub set_incpage_handler {
my $o = shift;
$o->{incpage} = shift || \&incpage_label;
}
sub get_order {
my $o = shift;
return $o->{order};
}
sub get_title {
my $o = shift;
return $o->{title};
}
sub get_version {
my $o = shift;
return $o->{version};
}
sub get_langlevel {
my $o = shift;
return $o->{langlevel};
}
sub get_extensions {
my $o = shift;
return $o->{extensions};
}
sub get_bounding_box {
my $o = shift;
return @{$o->{bbox}};
}
sub set_bounding_box {
my ($o, $x0, $y0, $x1, $y1) = @_;
$o->{bbox} = [ $x0, $y0, $x1, $y1 ] if (defined $y1);
$o->set_clipping(1);
}
sub get_printable_width
{
my $bb = shift->{bbox};
return $bb->[2] - $bb->[0];
} # end get_printable_width
sub get_printable_height
{
my $bb = shift->{bbox};
return $bb->[3] - $bb->[1];
} # end get_printable_height
sub get_page_bounding_box {
my $o = shift;
my $p = $o->get_ordinal( shift );
return @{$o->{pagebbox}[$p]};
}
sub set_page_bounding_box {
my $o = shift;
my $page = (@_ == 5) ? shift : "";
if (@_ == 4) {
my $p = $o->get_ordinal($page);
$o->{pagebbox}[$p] = [ @_ ];
$o->set_page_clipping($page, 1);
}
}
sub get_page_printable_width
{
my $o = shift;
my $bb = $o->{pagebbox}[$o->get_ordinal( shift )];
return $bb->[2] - $bb->[0];
} # end get_page_printable_width
sub get_page_printable_height
{
my $o = shift;
my $bb = $o->{pagebbox}[$o->get_ordinal( shift )];
return $bb->[3] - $bb->[1];
} # end get_page_printable_height
sub set_page_margins {
my $o = shift;
my $page = (@_ == 5) ? shift : "";
if (@_ == 4) {
my ($left, $bottom, $right, $top) = @_;
my $p = $o->get_ordinal($page);
if ($o->{pagelandsc}[$p]) {
$o->{pagebbox}[$p] = [ $left, $bottom, $o->{height}-$right, $o->{width}-$top ];
} else {
$o->{pagebbox}[$p] = [ $left, $bottom, $o->{width}-$right, $o->{height}-$top ];
}
$o->set_page_clipping($page, 1);
}
}
sub get_ordinal {
my ($o, $page) = @_;
if ($page) {
for (my $i = 0; $i <= $o->{pagecount}; $i++) {
my $here = $o->{page}->[$i] || "";
return $i if ($here eq $page);
}
}
return $o->{p};
}
sub get_pagecount {
my $o = shift;
return $o->{pagecount};
}
sub set_variable {
my ($o, $key, $value) = @_;
$o->{vars}{$key} = $value;
}
sub get_variable {
my ($o, $key) = @_;
return $o->{vars}{$key};
}
sub set_page_variable {
my ($o, $key, $value) = @_;
$o->{pagevars}{$key} = $value;
}
sub get_page_variable {
my ($o, $key) = @_;
return $o->{pagevars}{$key};
}
sub get_comments {
my $o = shift;
return $o->{Comments};
}
sub add_comment {
my ($o, $entry) = @_;
$o->{Comments} .= "\%\%$entry\n" if defined($entry);
}
sub get_preview {
my $o = shift;
return $o->{Preview};
}
sub add_preview {
my ($o, $width, $height, $depth, $lines, $entry) = @_;
if (defined $entry) {
$entry =~ s/$o->{strip}//gm;
$o->{Preview} = $o->_here_doc(<<END_PREVIEW);
\%\%BeginPreview: $width $height $depth $lines
$entry
\%\%EndPreview
END_PREVIEW
}
}
sub get_defaults {
my $o = shift;
return $o->{Defaults};
}
sub add_default {
my ($o, $entry) = @_;
$o->{Defaults} .= "\%\%$entry\n" if defined($entry);
}
sub get_resources {
my $o = shift;
return $o->{Fonts} . $o->{Resources};
}
our %supplied_type = (qw(
Document file
Feature) => ''
);
our %add_resource_accepts = map { $_ => 1 } qw(
encoding file font form pattern
);
# add_resource does not accept procset, but need_resource does:
$add_resource_accepts{procset} = undef;
sub add_resource {
my ($o, $type, $name, $params, $resource) = @_;
my $suptype = $supplied_type{$type};
my $restype = '';
croak "add_resource does not accept type $type"
unless defined($suptype) or $add_resource_accepts{lc $type};
unless (defined $suptype) {
$suptype = lc $type;
$restype = "$suptype ";
$type = 'Resource';
} # end unless Document or Feature
if (defined($resource)) {
$resource =~ s/$o->{strip}//gm;
$name = $o->quote_text($name);
$o->{DocSupplied} .= $o->encode_text("\%\%+ $suptype $name\n")
if $suptype;
# Store fonts separately, because they need to come first:
my $storage = 'Resources';
if ($suptype eq 'font') {
$storage = 'Fonts';
push @{ $o->{embed_fonts} }, $name; # Remember to reencode it
} # end if adding Font
$name .= " $params" if defined $params and length $params;
$o->{$storage} .= $o->_here_doc(<<END_USER_RESOURCE);
\%\%Begin${type}: $restype$name
$resource
\%\%End$type
END_USER_RESOURCE
}
}
sub get_functions {
my $o = shift;
return $o->{Functions};
}
sub add_function {
my ($o, $name, $entry, $version, $revision) = @_;
if (defined($name) and defined($entry)) {
return if $o->has_function($name);
$entry =~ s/$o->{strip}//gm;
$name = sprintf('%s %g %d', $o->quote_text($name),
$version||0, $revision||0);
$o->{DocSupplied} .= $o->encode_text("\%\%+ procset $name\n");
$o->{Functions} .= $o->_here_doc(<<END_USER_FUNCTIONS);
\%\%BeginResource: procset $name
$entry
\%\%EndResource
END_USER_FUNCTIONS
return 1;
}
return;
}
sub has_function {
my ($o, $name) = @_;
$name = $o->quote_text($name);
return ($o->{DocSupplied} =~ /^\%\%\+ procset \Q$name\E /m);
}
sub embed_document
{
my ($o, $filename) = @_;
my $id = $o->quote_text(substr($filename, -234)); # in case it's long
my $supplied = $o->encode_text("%%+ file $id\n");
$o->{DocSupplied} .= $supplied
unless index($o->{DocSupplied}, $supplied) >= 0;
local $/; # Read entire file
open(my $in, '<:raw', $filename) or croak "Unable to open $filename: $!";
my $content = <$in>;
close $in;
# Remove TIFF or WMF preview image:
if ($content =~ /^\xC5\xD0\xD3\xC6/) {
my ($pos, $len) = unpack('V2', substr($content, 4, 8));
$content = substr($content, $pos, $len);
} # end if EPS file with TIFF or WMF preview image
# Do CR or CRLF -> LF processing, since we read in RAW mode:
$content =~ s/\r\n?/\n/g;
# Remove EPSI preview:
$content =~ s/^\s*%%BeginPreview:.*\n
(?:\s*%(?!%).*\n)*
\s*%%EndPreview.*\n//gmx;
return "\%\%BeginDocument: $id\n$content\n\%\%EndDocument\n";
} # end embed_document
sub embed_font
{
my ($o, $filename, $type) = @_;
unless ($type) {
$filename =~ /\.([^\\\/.]+)$/ or croak "No extension in $filename";
$type = $1;
}
$type = uc $type;
my $in;
if ($type eq 'PFA') {
open($in, '<:raw', $filename) or croak "Unable to open $filename: $!";
} elsif ($type eq 'PFB') {
open($in, '-|:raw', $t1ascii, $filename)
or croak "Unable to run $t1ascii $filename: $!";
} elsif ($type eq 'TTF') {
open($in, '-|:raw', $ttftotype42, $filename)
or croak "Unable to run $ttftotype42 $filename: $!";
# Type 42 was introduced in LanguageLevel 2:
$o->{langlevel} = 2 unless ($o->{langlevel} || 0) >= 2;
}
my $content = do { local $/; <$in> }; # Read entire file
close $in;
$content =~ s/\r\n?/\n/g; # CR or CRLF to LF
$content =~ m!/FontName\s+/(\S+)\s+def\b!
or croak "Unable to find font name in $filename";
my $fontName = $1;
$o->add_resource(Font => $fontName, undef, $content);
return $fontName;
} # end embed_font
sub need_resource
{
my $o = shift;
my $type = shift;
croak "Unknown resource type $type"
unless exists $add_resource_accepts{$type};
my $hash = $o->{needed}{$type} ||= {};
foreach my $res (@_) {
$hash->{ $o->encode_text(
join(' ', map { $o->quote_text($_) } (ref $res ? @$res : $res))
)} = 1;
} # end foreach $res
} # end need_resource
sub get_setup {
my $o = shift;
return $o->{Setup};
}
sub add_setup {
my ($o, $entry) = @_;
$entry =~ s/$o->{strip}//gm;
$o->{Setup} .= $o->encode_text($entry) if (defined $entry);
}
sub get_page_setup {
my $o = shift;
return $o->{PageSetup};
}
sub add_page_setup {
my ($o, $entry) = @_;
$entry =~ s/$o->{strip}//gm;
$o->{PageSetup} .= $o->encode_text($entry) if (defined $entry);
}
sub get_page {
my $o = shift;
my $page = shift || $o->get_page_label();
my $ord = $o->get_ordinal($page);
return $o->{Pages}->[$ord];
}
sub add_to_page {
my $o = shift;
my $page = (@_ == 2) ? shift : "";
my $entry = shift || "";
if ($page) {
my $ord = $o->get_ordinal($page);
if (($ord == $o->{p}) and ($page ne $o->{page}[$ord])) {
$o->newpage($page);
} else {
$o->{p} = $ord;
}
}
$entry =~ s/$o->{strip}//gm;
$o->{Pages}[$o->{p}] .= $o->encode_text($entry);
}
sub get_page_trailer {
my $o = shift;
return $o->{PageTrailer};
}
sub add_page_trailer {
my ($o, $entry) = @_;
$entry =~ s/$o->{strip}//gm;
$o->{PageTrailer} .= $o->encode_text($entry) if (defined $entry);
}
sub get_trailer {
my $o = shift;
return $o->{Trailer};
}
sub add_trailer {
my ($o, $entry) = @_;
$entry =~ s/$o->{strip}//gm;
$o->{Trailer} .= $o->encode_text($entry) if (defined $entry);
}
#=============================================================================
sub draw_bounding_box {
my $o = shift;
$o->{clipcmd} = "stroke";
}
sub clip_bounding_box {
my $o = shift;
$o->{clipcmd} = "clip";
}
# Strip leading spaces off a here document:
sub _here_doc
{
my ($o, $text) = @_;
if ($o->{strip_type} ne 'none') {
$text =~ s/$o->{strip}//gm;
} elsif ($text =~ /^([ \t]+)/) {
my $space = $1;
$text =~ s/^$space//gm;
$text =~ s/^[ \t]+\n/\n/gm;
} # end elsif no strip but $text is indented
$o->encode_text($text);
} # end _here_doc
sub incpage_label ($) { ## no critic (ProhibitSubroutinePrototypes)
my $page = shift;
return ++$page;
}
our $roman_max = 40;
our @roman = qw(0 i ii iii iv v vi vii viii ix x xi xii xiii xiv xv xvi xvii xviii xix
xx xi xxii xxii xxiii xxiv xxv xxvi xxvii xxviii xxix
xxx xxi xxxii xxxii xxxiii xxxiv xxxv xxxvi xxxvii xxxviii xxxix );
our %roman = ();
for (my $i = 1; $i <= $roman_max; $i++) {
$roman{$roman[$i]} = $i;
}
sub incpage_roman ($) { ## no critic (ProhibitSubroutinePrototypes)
my $page = shift;
my $pos = $roman{$page};
return $roman[++$pos];
}
sub check_file ($;$$) { ## no critic (ProhibitSubroutinePrototypes)
my ($filename, $dir, $create) = @_;
$create = 0 unless (defined $create);
if (not defined $filename or not length $filename) {
$filename = File::Spec->devnull();
} else {
$filename = check_tilde($filename);
$filename = File::Spec->canonpath($filename);
unless (File::Spec->file_name_is_absolute($filename)) {
if (defined($dir)) {
$dir = check_tilde($dir);
$dir = File::Spec->canonpath($dir);
$dir = File::Spec->rel2abs($dir) unless (File::Spec->file_name_is_absolute($dir));
$filename = File::Spec->catfile($dir, $filename);
} else {
$filename = File::Spec->rel2abs($filename);
}
}
my @subdirs = ();
my ($volume, $directories, $file) = File::Spec->splitpath($filename);
@subdirs = File::Spec->splitdir( $directories );
my $path = $volume;
foreach my $dir (@subdirs) {
$path = File::Spec->catdir( $path, $dir );
mkdir $path unless (-d $path);
}
$filename = File::Spec->catfile($path, $file);
if ($create) {
unless (-e $filename) {
open(my $file, ">", $filename)
or die "Unable to open \'$filename\' for writing : $!\nStopped";
close $file;
}
}
}
return $filename;
}
sub check_tilde ($) { ## no critic (ProhibitSubroutinePrototypes)
my ($dir) = @_;
$dir = "" unless $dir;
$dir =~ s{^~([^/]*)}{$1 ? (getpwnam($1))[7] : ($ENV{HOME} || $ENV{LOGDIR} || (getpwuid($>))[7]) }ex;
return $dir;
}
sub array_as_string (@) { ## no critic (ProhibitSubroutinePrototypes)
my $array = "[ ";
foreach my $f (@_) { $array .= "$f "; }
$array .= "]";
return $array;
}
sub str ($) { ## no critic (ProhibitSubroutinePrototypes)
my $arg = shift;
if (ref($arg) eq "ARRAY") {
return array_as_string( @$arg );
} else {
return $arg;
}
}
my %special = (
"\n" => '\n', "\r" => '\r', "\t" => '\t', "\b" => '\b',
"\f" => '\f', "\\" => "\\\\", "(" => '\(', ")" => '\)',
);
my $specialKeys = join '', keys %special;
$specialKeys =~ s/\\/\\\\/; # Have to quote backslash
sub pstr {
my $o;
$o = shift if @_ > 1; # We were called as a method
my $string = shift;
my $nowrap = shift; # Pass this ONLY when method call
# Possibly convert \x2D (hyphen-minus) to hyphen or minus sign:
$string = $o->convert_hyphens($string)
if ref $o and $o->{auto_hyphen} and $string =~ /-/;
# Now form the parenthesized string:
$string =~ s/([$specialKeys])/$special{$1}/go;
$string = "($string)";
# A PostScript file should not have more than 255 chars per line:
$string =~ s/(.{240}[^\\])/$1\\\n/g unless $nowrap;
$string =~ s/^([ %])/\\$1/mg; # Make sure it doesn't get stripped
$string;
} # end pstr
sub quote_text
{
my $o;
$o = shift if @_ > 1; # We were called as a method
my $string = shift;
return $string if $string =~ m(^[-+_./*A-Za-z0-9]+\z);
__PACKAGE__->pstr($string, 1);
} # end quote_text
#=============================================================================
1;
__END__
=head1 NAME
PostScript::File - Base class for creating Adobe PostScript files
=head1 VERSION
This document describes version 2.11 of
PostScript::File, released October 11, 2011
as part of PostScript-File version 2.11.
=head1 SYNOPSIS
use PostScript::File qw(check_tilde check_file
incpage_label incpage_roman);
=head2 Simplest
An 'hello world' program:
use PostScript::File;
my $ps = PostScript::File->new();
$ps->add_to_page( <<END_PAGE );
/Helvetica findfont
12 scalefont
setfont
72 300 moveto
(hello world) show
END_PAGE
$ps->output( "~/test" );
=head2 All options
my $ps = PostScript::File->new(
paper => 'Letter',
height => 500,
width => 400,
bottom => 30,
top => 30,
left => 30,
right => 30,
clip_command => 'stroke',
clipping => 1,
eps => 1,
dir => '~/foo',
file => "bar",
landscape => 0,
headings => 1,
reencode => 'cp1252',
font_suffix => '-iso',
need_fonts => [qw(Helvetica Helvetica-Bold)],
errors => 1,
errmsg => 'Failed:',
errfont => 'Helvetica',
errsize => 12,
errx => 72,
erry => 300,
debug => 2,
db_active => 1,
db_xgap => 120,
db_xtab => 8,
db_base => 300,
db_ytop => 500,
db_color => '1 0 0 setrgbcolor',
db_font => 'Times-Roman',
db_fontsize => 11,
db_bufsize => 256,
);
=head1 DESCRIPTION
This module is designed to support other PostScript:: modules. For top level modules that output
something useful, see
PostScript::Calendar
PostScript::Report
PostScript::Graph::Bar
PostScript::Graph::Stock
PostScript::Graph::XY
An outline Adobe PostScript file is constructed. Functions allow access to each of Adobe's Document
Structuring Convention (DSC) sections and control how the pages are constructed. It is possible to
construct and output files in either normal PostScript (*.ps files) or as Encapsulated PostScript (*.epsf or
*.epsi files). By default a minimal file is output, but support for font encoding, PostScript error reporting and
debugging can be built in if required.
Documents can typically be built using only these functions:
new The constructor, with many options
add_function Add PostScript functions to the prolog
add_to_page Add PostScript to construct each page
newpage Begins a new page in the document
output Construct the file and saves it
The rest of the module involves fine-tuning this. Some settings only really make sense when given once, while
others can control each page independently. See B<new> for the functions that duplicate option settings, they all
have B<get_> counterparts. The following provide additional support.
get/set_bounding_box
get/set_page_bounding_box
get/set_page_clipping
get/set_page_landscape
set_page_margins
get_ordinal
get_pagecount
draw_bounding_box
clip_bounding_box
The functions which insert entries into each of the DSC sections all begin with 'add_'. They also have B<get_>
counterparts.
add_comment
add_preview
add_default
add_resource
add_function
add_setup
add_page_setup
add_to_page
add_page_trailer
add_trailer
Finally, there are a few stand-alone functions. These are not methods and are available for export if requested.
check_tilde
check_file
incpage_label
incpage_roman
=head2 Hyphens and Minus Signs
In ASCII, the character C<\x2D> (C<\055>) is used as both a hyphen and
a minus sign. Unicode calls this character HYPHEN-MINUS (U+002D).
PostScript has two characters, which it calls C</hyphen> and
C</minus>. The difference is that C</minus> is usually wider than
C</hyphen> (except in Courier, of course).
In PostScript's StandardEncoding (what you get if you don't use
L</reencode>), character C<\x2D> is C</hyphen>, and C</minus> is not
available. In the Latin1-based encodings created by C<reencode>,
character C<\x2D> is C</minus>, and character C<\xAD> is C</hyphen>.
(C<\xAD> is supposed to be a "soft hyphen" (U+00AD) that appears only
if the line is broken at that point, but it doesn't work that way in
PostScript.)
Unicode has additional non-ambiguous characters: HYPHEN (U+2010),
NON-BREAKING HYPHEN (U+2011), and MINUS SIGN (U+2212). The first two
always indicate C</hyphen>, and the last is always C</minus>. When you set
C<reencode> to C<cp1252> or C<iso-8859-1>, those characters will be
handled automatically.
To make it easier to handle strings containing HYPHEN-MINUS,
PostScript::File provides the L</auto_hyphen> attribute. When this is
true (the default when using C<cp1252> or C<iso-8859-1>), the L<pstr>
method will automatically translate HYPHEN-MINUS to either HYPHEN or
MINUS SIGN. (This happens only when C<pstr> is called as an object method.)
The rule is that if a HYPHEN-MINUS is surrounded by whitespace, or
surrounded by digits, or it's preceded by whitespace or punctuation
and followed by a digit, or it's followed by a currency symbol, it's
translated to MINUS SIGN. Otherwise, it's translated to HYPHEN.
=head1 CONSTRUCTOR
=head2 new( options )
Create a new PostScript::File object, either a set of pages or an Encapsulated PostScript (EPS) file. Options are
hash keys and values. All values should be in the native PostScript units of 1/72 inch.
Example
$ps = PostScript::File->new(
eps => 1,
landscape => 1,
width => 216,
height => 288,
left => 36,
right => 44,
clipping => 1 );
This creates an Encapsulated PostScript document, 4 by 3 inch pages printing landscape with left and right margins of
around half an inch. The width is always the shortest side, even in landscape mode. 3*72=216 and 4*72=288.
Being in landscape mode, these would be swapped. The bounding box used for clipping would then be from
(50,0) to (244,216).
C<options> may be a single hash reference instead of an options list, but the hash must have the same structure.
This is more convenient when used as a base class.
In addition, the following keys are recognized.
=head2 File size keys
There are four options which control how much gets put into the resulting file.
=head3 debug
=over 6
=item undef
No debug code is added to the file. Of course there must be no calls to debug functions in the PostScript code.
=item 0
B<db_> functions are replaced by dummy functions which do nothing.
=item 1
A range of functions are added to the file to support debugging PostScript. This switch is similar to the 'C'
C<NDEBUG> macro in that debugging statements may be left in the PostScript code but their effect is removed.
Of course, being an interpreted language, it is not quite the same as the calls still takes up space - they just
do nothing. See L</"POSTSCRIPT DEBUGGING SUPPORT"> for details of the functions.
=item 2
Loads the debug functions and gives some reassuring output at the start and a stack dump at the end of each page.
A mark is placed on the stack at the beginning of each page and 'cleartomark' is given at the end, avoiding
potential C<invalidrestore> errors. Note, however, that if the page does not end with a clean stack, it will fail
when debugging is turned off.
=back
=head3 errors
PostScript has a nasty habit of failing silently. Setting this to 1 prints fatal error messages on the bottom left
of the paper. For user functions, a PostScript function B<report_error> is defined. This expects a message
string on the stack, which it prints before stopping. (Default: 1)
=head3 headings
Enable PostScript comments such as the date of creation and user's name.
=head3 reencode
Requests that a font re-encode function be added and that the fonts
used by this document get re-encoded in the specified encoding.
The only allowed values are C<cp1252>, C<iso-8859-1>, and
C<ISOLatin1Encoding>. In most cases, you should set this to
C<cp1252>, even if you are not using Windows.
The list of fonts to re-encode comes from the L<need_fonts> parameter,
the L<need_resource> method, and all fonts added using L<embed_font>
or L<add_resource>. The Symbol font is never re-encoded, because it
uses a non-standard character set.
Setting this to C<cp1252> or C<iso-8859-1> also causes the document to
be encoded in that character set. Any strings you add to the document
that have the UTF8 flag set will be re-encoded automatically. Strings
that do not have the UTF8 flag are expected to be in the correct
character set already. This means that you should be able to set this
to C<cp1252>, use Unicode characters in your code and the "-iso"
versions of the fonts, and just have it do the right thing.
Windows code page 1252 (aka WinLatin1) is a superset of the printable
characters in iso-8859-1 (aka Latin1). It adds a number of characters
that are not in Latin1, especially common punctuation marks like the
curly quotation marks, en & em dashes, Euro sign, and ellipsis. These
characters exist in the standard PostScript fonts, but there's no easy
way to access them when using the standard or ISOLatin1 encodings.
L<http://en.wikipedia.org/wiki/Windows-1252>
For backwards compatibility with versions of PostScript::File older
than 1.05, setting this to C<ISOLatin1Encoding> re-encodes the fonts,
but does not do any character set translation in the document.
=head2 Initialization keys
There are a few initialization settings that are only relevant when the file object is constructed.
=head3 bottom
The margin in from the paper's bottom edge, specifying the non-printable area. Remember to specify C<clipping> if
that is what is wanted. (Default: 28)
=head3 clip_command
The bounding box is used for clipping if this is set to "clip" or is drawn with "stroke". This also makes the
whole page area available for debugging output. (Default: "clip").
=head3 clipping
Set whether printing will be clipped to the file's bounding box. (Default: 0)
=head3 dir
An optional directory for the output file. See </set_filename>.
If no C<file> is specified, C<dir> is ignored.
=head3 eps
Set to 1 to produce Encapsulated PostScript. B<get_eps> returns the value set here. (Default: 0)
=head3 file
The name of the output file. See </set_filename>.
=head3 file_ext
The extension for the output file. See </set_file_ext>.
=head3 font_suffix
This string is appended to each font name as it is re-encoded. (Default: "-iso")
The string value is appended to these to make the new names.
Example
$ps = PostScript::File->new(
font_suffix => "-iso",
reencode => "ISOLatin1Encoding"
);
"Courier" still has the standard mapping while "Courier-iso" includes the additional European characters.
=head3 height
Set the page height, the longest edge of the paper. (Default taken from C<paper>)
The paper size is set to "Custom". B<get_width> and B<get_height> return the values set here.
=head3 landscape
Set whether the page is oriented horizontally (C<1>) or vertically (C<0>). (Default: 0)
In landscape mode the coordinates are rotated 90 degrees and the origin moved to the bottom left corner. Thus the
coordinate system appears the same to the user, with the origin at the bottom left.
=head3 left
The margin in from the paper's left edge, specifying the non-printable area.
Remember to specify C<clipping> if that is what is wanted. (Default: 28)
=head3 need_fonts
An arrayref of font names required by this document. This is
equivalent to calling C<< $ps->need_resource(font => @$arrayref) >>.
See L<need_resource> for details.
=head3 paper
Set the paper size of each page. A document can be created using a standard paper size without
having to remember the size of paper using PostScript points. Valid choices are currently A0, A1, A2, A3, A4, A5,
A6, A7, A8, A9, B0, B1, B2, B3, B4, B5, B6, B7, B8, B9, B10, Executive, Folio, 'Half-Letter', Letter, 'US-Letter',
Legal, 'US-Legal', Tabloid, 'SuperB', Ledger, 'Comm #10 Envelope', 'Envelope-Monarch', 'Envelope-DL',
'Envelope-C5', 'EuroPostcard'. (Default: "A4")
You can also give a string in the form 'WIDTHxHEIGHT', where WIDTH and
HEIGHT are numbers (in points). This sets the paper size to "Custom".
This also sets C<width> and C<height>. B<get_paper> returns the value set here.
=head3 right
The margin in from the paper's right edge. It is a positive offset, so C<right=36> will leave a half inch no-go
margin on the right hand side of the page. Remember to specify C<clipping> if that is what is wanted. (Default: 28)
=head3 top
The margin in from the paper's top edge. It is a positive offset, so C<top=36> will leave a half inch no-go
margin at the top of the page. Remember to specify C<clipping> if that is what is wanted. (Default: 28)
=head3 width
Set the page width, the shortest edge of the paper. (Default taken from C<paper>)
=head2 Debugging support keys
This makes most sense in the PostScript code rather than perl. However, it is convenient to be able to set
defaults for the output position and so on. See L</"POSTSCRIPT DEBUGGING SUPPORT"> for further details.
=head3 db_active
Set to 0 to temporarily suppress the debug output. (Default: 1)
=head3 db_base
Debug printing will not occur below this point. (Default: 6)
=head3 db_bufsize
The size of string buffers used. Output must be no longer than this. (Default: 256)
=head3 db_color
This is the whole PostScript command (with any parameters) to specify the colour of the text printed by the debug
routines. (Default: "0 setgray")
=head3 db_font
The name of the font to use. (Default: "Courier")
Courier
Courier-Bold
Courier-BoldOblique
Courier-Oblique
Helvetica
Helvetica-Bold
Helvetica-BoldOblique
Helvetica-Oblique
Times-Roman
Times-Bold
Times-BoldItalic
Times-Italic
Symbol
=head3 db_fontsize
The size of the font. PostScript uses its own units, but they are almost points. (Default: 10)
=head3 db_xgap
Typically, the output comprises single values such as a column showing the stack contents. C<db_xgap> specifies
the width of each column. By default, this is calculated to allow 4 columns across the page.
=head3 db_xpos
The left edge, where debug output starts. (Default: 6)
=head3 db_xtab
The amount indented by C<db_indent>. (Default: 10)
=head3 db_ytop
The top line of debugging output. Defaults to 6 below the top of the page.
=head2 Error handling keys
If C<errors> is set, the position of any fatal error message can be controlled with the following options. Each
value is placed into a PostScript variable of the same name, so they can be overridden from within the code if
necessary.
=head3 errfont
The name of the font used to show the error message. (Default: "Courier-Bold")
=head3 errmsg
The error message comprises two lines. The second is the name of the PostScript error. This sets the first line.
(Default: "ERROR:")
=head3 errsize
Size of the error message font. (Default: 12)
=head3 errx
X position of the error message on the page. (Default: (72))
=head3 erry
Y position of the error message on the page. (Default: (72))
=head2 Document structure
There are options which only affect the DSC comments. They all have B<get_> functions which return the
values set here, e.g. B<get_title> returns the value given to the title option.
=head3 extensions
Declare and PostScript language extensions that need to be available. (No default)
=head3 langlevel
Set the PostScript language level. (No default)
=head3 order
Set the order the pages are defined in the document. It should one of
"Ascend", "Descend" or "Special" if a document manager must not
reorder the pages. (No default)
=head3 title
Set the document's title as recorded in PostScript's Document Structuring Conventions. (No default)
=head3 version
Set the document's version as recorded in PostScript's Document Structuring Conventions. This should be a string
with a major, minor and revision numbers. For example "1.5 8" signifies revision 8 of version 1.5. (No default)
=head2 Miscellaneous
A few options that may be changed between pages or set here for the first page.
=head3 incpage_handler
Set the initial value for the function which increments page labels. See L</set_incpage_handler>.
=head3 newpage
Normally, an initial page is created automatically (using the label
specified by C<page>). But starting with PostScript::File 2.10, you
can pass S<C<< newpage => 0 >>> to override this. This makes for more
natural loops:
use PostScript::File 2.10;
my $ps = PostScript::File->new(newpage => 0);
for (@pages) {
$ps->newpage; # don't need "unless first page"
...
}
It's important to require PostScript::File 2.10 if you do this, because
older versions would produce an initial blank page.
If you don't pass a page label to the first call to C<newpage>, it
will be taken from the C<page> option. After the first page, the page
label will increment as specified by L</incpage_handler>.
=head3 page
Set the label (text or number) for the initial page. See L</set_page_label>. (Default: "1")
=head3 strip
Set whether the PostScript code is filtered. C<space> strips leading spaces so the user can indent freely
without increasing the file size. C<comments> remove lines beginning with '%' as well. C<none> does no filtering. (Default: "space")
=head3 auto_hyphen
Controls whether the L</pstr> method does hyphen-minus translation as
described in L</"Hyphens and Minus Signs">. This can only be enabled
when the document is using character set translation. (Default: 1).
=head1 MAIN METHODS
=head2 newpage( [page] )
Generate a new PostScript page, unless in a EPS file when it is ignored.
If C<page> is not specified the page number is increased each time a new page is requested.
C<page> can be a string or a number. If anything other than a simple integer, you probably should register
your own counting function with B<set_incpage_handler>. Of course there is no need to do this if a page string is
given to every B<newpage> call.
=head2 output( [filename [, dir]] )
If C<filename> is an open filehandle, write the PostScript document to
that filehandle and return nothing.
If a filename has been given either here, to C<new>, or to
C<set_filename>, write the PostScript document to that file and return
its pathname.
If no filename has been given, or C<filename> is undef, return the
PostScript document as a string.
In C<eps> mode, each page of the document becomes a separate EPS file.
In list context, returns a list of these files (either the pathname or
the PostScript code as explained above). In scalar context, only the
first page is returned (but all pages will still be processed). If
you pass a filehandle when you have multiple pages, all the documents
are written to that filehandle, which is probably not what you want.
Use this option whenever output is required to disk. The current PostScript document in memory is not cleared, and
can still be extended or output again.
=head2 as_string
This returns the PostScript document as a string. It is equivalent to
C<< $ps->output(undef) >>.
=head2 testable_output( [verbatim] )
This returns the PostScript document as a string, but with the
PostScript::File generated code removed (unless C<verbatim> is true).
This is intended for use in test scripts, so they won't see changes in
the output caused by different versions of PostScript::File. The
PostScript code returned by this method will probably not work in a
PostScript interpreter.
If C<verbatim> is true, this is equivalent to C<< $ps->output(undef) >>.
=head1 ACCESS METHODS
Use these B<get_> and B<set_> methods to access a PostScript::File object's data.
=head2 get_auto_hyphen()
=head2 set_auto_hyphen( translate )
If translate is a true value, then L</pstr> will do automatic
hyphen-minus translation when called as an object method (but only if
the document uses character set translation).
See L</"Hyphens and Minus Signs">.
=head2 get_filename()
=head2 set_filename( file, [dir] )
=over 4
=item C<file>
An optional fully qualified path-and-file, a simple file name, or "" which stands for the special file
File::Spec->devnull().
=item C<dir>
An optional directory C<dir>. If present (and C<file> is not already an absolute path), it is prepended to
C<file>. If no C<file> was specified, C<dir> is ignored.
=back
Specify the root file name for the output file(s) and ensure the resulting absolute path exists. This should not
include any extension. C<.ps> will be added for ordinary PostScript files. EPS files have an extension of
C<.epsf> without or C<.epsi> with a preview image.
(Unless you set the extension manually; see L</set_file_ext>.)
If C<eps> has been set, multiple pages will have the page label appended to the file name.
Example
$ps = PostScript::File->new( eps => 1 );
$ps->set_filename( "pics", "~/book" );
$ps->newpage("vi");
... draw page
$ps->newpage("7");
... draw page
$ps->newpage();
... draw page
$ps->output();
The three pages for user 'chris' on a unix system would be:
/home/chris/book/pics-vi.epsf
/home/chris/book/pics-7.epsf
/home/chris/book/pics-8.epsf
It would be wise to use B<set_page_bounding_box> explicitly for each page if using multiple pages in EPS files.
=head2 get_file_ext()
=head2 set_file_ext( file_ext )
If the C<file_ext> is undef (the default), then the extension is set
automatically based on the output type, as explained under
L</set_filename>. If C<file_ext> is the empty string, then no
extension will be added to the filename. Otherwise, it should be a
string like '.ps' or '.eps'. (But setting this has no effect on the
actual type of the output file, only its name.)
=head2 get_metrics( font, [size, [encoding]] )
Construct a L<PostScript::File::Metrics> object for C<font>. The
C<encoding> is normally determined automatically from the font name
and the document's encoding. The default C<size> is 1000.
If this document uses L</reencode>, and the font ends with
L</font_suffix>, then the Metrics object will use that encoding.
Otherwise, the encoding is C<std> (except for the Symbol font, which
always uses C<sym>).
No matter what encoding the font uses, the Metrics object will always
use the same Unicode translation setting as this document. It also
inherits the current value of the L</auto_hyphen> attribute.
=head2 get_strip
=head2 set_strip( "none" | "space" | "comments" )
Determine whether the PostScript code is filtered. C<space> strips leading spaces so the user can indent freely
without increasing the file size. C<comments> remove lines beginning with '%' as well.
=head2 get_page_landscape( [page] )
=head2 set_page_landscape( [[page,] landscape] )
Inspect and change whether the page specified is oriented horizontally (C<1>) or vertically (C<0>). The default
is the global setting as returned by B<get_landscape>. If C<page> is omitted, the current page is assumed.
=head2 get_page_clipping( [page] )
=head2 set_page_clipping( [[page,] clipping] )
Inspect and change whether printing will be clipped to the page's bounding box. (Default: 0)
=head2 get_page_label()
=head2 set_page_label( [page] )
Inspect and change the number or label for the current page. (Default: "1")
This will be automatically incremented using the function set by B<set_incpage_hander>.
=head2 get_incpage_handler()
=head2 set_incpage_handler( [handler] )
Inspect and change the function used to increment the page number or label. The following suitable values for
C<handler> refer to functions defined in the module:
\&PostScript::File::incpage_label
\&PostScript::File::incpage_roman
The default (B<incpage_label>) increments numbers and letters, the other one handles roman numerals up to
39. C<handler> should be a reference to a subroutine that takes the current page label as its only argument and
returns the new one. Use this to increment pages using roman numerals or custom orderings.
=head2 get_bounding_box()
=head2 set_bounding_box( x0, y0, x1, y1 )
Inspect or change the bounding box for the whole document, showing only the area inside.
Setting the bounding box enables clipping. Call L</set_clipping> with
0 afterwards to undo that.
=head2 get_printable_width()
=head2 get_printable_height()
These return the width or height of the document's bounding box
(S<C<x1 - x0>> or S<C<y1 - y0>>, respectively). These methods were
added in version 2.10.
=head2 get_page_bounding_box( [page] )
=head2 set_page_bounding_box( [page], x0, y0, x1, y1 )
Inspect or change the bounding box for a specified page. If C<page> is not specified, the current page is
assumed, otherwise it should be a page label already given to B<newpage> or B<set_page_label>. The page bounding
box defaults to the paper area.
Note that calling C<set_page_bounding_box> automatically enables
clipping for the page. If this isn't what you want, call
L</set_page_clipping> with 0 afterwards.
=head2 get_page_printable_width( [page] )
=head2 get_page_printable_height( [page] )
These return the width or height of the specified page's bounding box
(S<C<x1 - x0>> or S<C<y1 - y0>>, respectively). If C<page> is not
specified, the current page is assumed. These methods were added in
version 2.10.
=head2 set_page_margins( [page], left, bottom, right, top )
An alternative way of changing a single page's bounding box. Unlike the options given to B<new>, the parameters here
are the gaps around the image, not the paper. So C<left=36> will set the left side in by half an inch, this might
be a short side if C<landscape> is set.
Note that this automatically enables clipping for the page. If this isn't what you want, call
B<set_page_clipping> with 0.
=head2 get_ordinal( [page] )
Return the internal number for the page label specified. (Default: current page)
Example
Say pages are numbered "i", "ii", "iii, "iv", "1", "2", "3".
get_ordinal("i") == 0
get_ordinal("iv") == 3
get_ordinal("1") == 4
=head2 get_pagecount()
Return the number of pages currently known.
=head2 set_variable( key, value )
Assign a user defined hash key and value. Provided to keep track of states within the PostScript code, such as
which dictionaries are currently open. PostScript::File does not use this - it is provided for client programs.
It is recommended that C<key> is the module name to avoid clashes. This entry could then be a hash holding any
number of user variables.
=head2 get_variable
Retrieve a user defined value.
=head2 set_page_variable( key, value )
Assign a user defined hash key and value only valid on the current page. Provided to keep track of states within
the PostScript code, such as which styles are currently active. PostScript::File does not use this (except to
clear it at the start of each page). It is recommended that C<key> is the module name to avoid clashes. This entry
could then be a hash holding any number of user variables.
=head2 get_page_variable
Retrieve a user defined value.
=head1 CONTENT METHODS
=head2 get_comments()
=head2 add_comment( comment )
Most of the required and recommended comments are set directly, so this function should rarely be needed. It is
provided for completeness so that comments not otherwise supported can be added. The comment should
be the bare PostScript DSC name and value, with additional lines merely prefixed by C<+>.
Programs written for older versions of PostScript::File might use this
to add a C<DocumentNeededResources> comment. That is now deprecated;
you should use L<need_resource> instead.
Example
$ps->add_comment("ProofMode: NotifyMe");
$ps->add_comment("Requirements: manualfeed");
=head2 get_preview()
=head2 add_preview( width, height, depth, lines, preview )
Use this to add a Preview in EPSI format - an ASCII representation of a bitmap. If an EPS file has a preview it
becomes an EPSI file rather than EPSF.
=head2 get_defaults()
=head2 add_default( default )
Use this to add any PostScript DSC comments to the Defaults section. These would be typically values like
PageCustomColors: or PageRequirements:.
=head2 get_resources()
=head2 add_resource( type, name, params, resource )
=over 4
=item C<type>
A string indicating the DSC type of the resource. It should be one of
C<Document>, C<Feature>, C<encoding>, C<file>, C<font>, C<form>, or
C<pattern> (case sensitive).
=item C<name>
An arbitrary identifier of this resource. (For a Font, it must be the
PostScript name of the font, without a leading slash.)
=item C<params>
Some resource types require parameters. See the Adobe documentation for details.
=item C<resource>
A string containing the PostScript code. Probably best provided a 'here' document.
=back
Use this to add fonts or images (although you may prefer L<embed_font>
or L<embed_document>). B<add_function> is provided for functions.
Example
$ps->add_resource( "File", "My_File1",
"", <<END_FILE1 );
...PostScript resource definition
END_FILE1
Note that B<get_resources> returns I<all> resources added, including those added by any inheriting modules.
=head2 get_functions()
=head2 add_function( name, code, [version, [revision]] )
Add a ProcSet containing user defined functions to the PostScript
prolog. Despite the name, it is better to add related functions in
the same code section. C<name> is an arbitrary identifier of this
resource. Best used with a 'here' document. If the document already
contains ProcSet C<name> (as reported by C<has_function>, then
C<add_function> does nothing.
C<version> is a real number, and C<revision> is an integer. They both
default to 0. PostScript::File does not make any use of these, but a
PostScript document manager may assume that a procset with a higher
revision number may be substituted for a procset with the same name
and version but a lower revision.
Returns true if the ProcSet was added, or false if it already existed.
Example
$ps->add_function( "My_Functions", <<END_FUNCTIONS );
% PostScript code can be freely indented
% as leading spaces and blank lines
% (and comments, if desired) are stripped
% foo does this...
/foo {
... definition of foo
} bind def
% bar does that...
/bar {
... definition of bar
} bind def
END_FUNCTIONS
Note that B<get_functions> (in common with the others) will return I<all> user defined functions possibly
including those added by other classes.
=head2 has_function( name )
This returns true if C<name> has already been included in the file. The name
should identical to that given to L</"add_function">.
=head2 embed_document( filename )
This reads the contents of C<filename>, which should be a PostScript
file. It returns a string with the contents of the file surrounded by
%%BeginDocument and %%EndDocument comments, and adds C<filename> to
the list of document supplied resources.
You must pass the returned string to add_to_page or some other method
that will actually include it in the document.
=head2 embed_font( filename, [type] )
This reads the contents of C<filename>, which must contain a
PostScript font. It calls L<add_resource> to add the font to the
document, and returns the name of the font (without a leading slash).
If C<type> is omitted, the C<filename>'s extension is used as the
type. Type names are not case sensitive. The currently supported
types are:
=over
=item PFA
A PostScript font in ASCII format
=item PFB
A PostScript font in binary format. This requires the t1ascii program
from L<http://www.lcdf.org/type/#t1utils>. (You can set
C<$PostScript::File::t1ascii> to the name of the program to use. It
defaults to F<t1ascii>.)
=item TTF
A TrueType font. This requires the ttftotype42 program from
L<http://www.lcdf.org/type/#typetools>. (You can set
C<$PostScript::File::ttftotype42> to the name of the program to use.
It defaults to F<ttftotype42>.)
Since TrueType (aka Type42) font support was introduced in PostScript
level 2, embedding a TTF font automatically sets C<langlevel> to 2
(unless it was already set to a higher level). Be aware that not all
printers can handle Type42 fonts. (Even PostScript level 2 printers
need not support them.) Ghostscript does support Type42 fonts (when
compiled with the C<ttfont> option).
=back
=head2 need_resource( type, resource... )
This adds a resource to the DocumentNeededResources comment. C<type>
is one of C<encoding>, C<file>, C<font>, C<form>, C<pattern>, or
C<procset> (case sensitive).
Any number of resources (of a single type) may be added in one call.
For most types, C<resource> is just the resource name. But for
C<procset>, each C<resource> should be an arrayref of 3 elements:
C<[name, version, revision]>. Names that contain special characters
such as spaces will be quoted automatically.
If C<need_resource> is never called for the C<font> type (and
C<need_fonts> is not used), it assumes the document requires all 13 of
the standard PostScript fonts: Courier, Courier-Bold,
Courier-BoldOblique, Courier-Oblique, Helvetica, Helvetica-Bold,
Helvetica-BoldOblique, Helvetica-Oblique, Times-Roman, Times-Bold,
Times-BoldItalic, Times-Italic, and Symbol. But this behaviour is
deprecated; a document should explicitly list the fonts it requires.
If you don't use any of the standard fonts, pass C<< need_fonts => [] >>
to the constructor (or call C<< $ps->need_resource('font') >>) to
indicate that.
=head2 get_setup()
=head2 add_setup( code )
Direct access to the C<%%Begin(End)Setup> section. Use this for C<setpagedevice>, C<statusdict> or other settings
that initialize the device or document.
=head2 get_page_setup()
=head2 add_page_setup( code )
Code added here is output before each page. As there is no special provision for %%Page... DSC comments, they
should be included here.
Note that any settings defined here will be active for each page separately. Use B<add_setup> if you want to
carry settings from one page to another.
=head2 get_page( [page] )
=head2 add_to_page( [page], code )
The main function for building the PostScript output. C<page> can be any label, typically one given to
B<set_page_label>. (Default: current page)
If C<page> is not recognized, a new page is added with that label. Note that this is added on the end, not in the
order you might expect. So adding "vi" to page set "iii, iv, v, 6, 7, 8" would create a new page after "8" not
after "v".
Examples
$ps->add_to_page( <<END_PAGE );
...PostScript building this page
END_PAGE
$ps->add_to_page( "3", <<END_PAGE );
...PostScript building page 3
END_PAGE
The first example adds code onto the end of the current page. The second one either adds additional code to page
3 if it exists, or starts a new one.
=head2 get_page_trailer()
=head2 add_page_trailer( code )
Code added here is output after each page. It may refer to settings made during B<add_page_setup> or
B<add_to_page>.
=head2 get_trailer()
=head2 add_trailer( code )
Add code to the PostScript C<%%Trailer> section. Use this for any tidying up after all the pages are output.
=head1 POSTSCRIPT DEBUGGING SUPPORT
This section documents the PostScript functions which provide debugging output. Please note that any clipping or
bounding boxes will also hide the debugging output which by default starts at the top left of the page. Typical
B<new> options required for debugging would include the following.
$ps = PostScript::File->new (
errors => "page",
debug => 2,
clipcmd => "stroke" );
The debugging output is printed on the page being drawn. In practice this works fine, especially as it is
possible to move the output around. Where the text appears is controlled by a number of PostScript variables,
most of which may also be given as options to B<new>.
The main controller is C<db_active> which needs to be non-zero for any output to be seen. It might be useful to
set this to 0 in B<new>, then at some point in your code enable it. Remember that the C<debugdict> dictionary
needs to be selected in order for any of its variables to be changed. This is better done with C<db_on> but it
illustrates the point.
/debugdict begin
/db_active 1 def
end
(this will now show) db_show
At any time, the next output will appear at C<db_xpos> and C<db_ypos>. These can of course be set directly.
However, after most prints, the equivalent of a 'newline' is executed. It moves down C<db_fontsize> and left to
C<db_xpos>. If, however, that would take it below C<db_ybase>, C<db_ypos> is reset to C<db_ytop> and the
x coordinate will have C<db_xgap> added to it, starting a new column.
The positioning of the debug output is changed by setting C<db_xpos> and C<db_ytop> to the top left starting
position, with C<db_ybase> guarding the bottom. Extending to the right is controlled by not printing too much!
Judicious use of C<db_active> can help there.
=head2 PostScript functions
=head3 x0 y0 x1 y1 B<cliptobox>
This function is only available if 'clipping' is set. By calling the perl method B<draw_bounding_box> (and
resetting with B<clip_bounding_box>) it is possible to use this to identify areas on the page.
$ps->draw_bounding_box();
$ps->add_to_page( <<END_CODE );
...
my_l my_b my_r my_t cliptobox
...
END_CODE
$ps->clip_bounding_box();
=head3 msg B<report_error>
If 'errors' is enabled, this call allows you to report a fatal error from within your PostScript code. It expects
a string on the stack and it does not return.
All the C<db_> variables (including function names) are defined within their own dictionary (C<debugdict>). But
this can be ignored by all calls originating from within code passed to B<add_to_page> (usually including
B<add_function> code) as the dictionary is automatically put on the stack before each page and taken off as each
finishes.
=head3 any B<db_show>
The workhorse of the system. This takes the item off the top of the stack and outputs a string representation of
it. So you can call it on numbers or strings and it will show them. Arrays are printed using C<db_array> and
marks are shown as '--mark--'.
=head3 n msg B<db_nshow>
This shows top C<n> items on the stack. It requires a number and a string on the stack, which it removes. It
prints out C<msg> then the top C<n> items on the stack, assuming there are that many. It can be used to do
a labelled stack dump. Note that if B<new> was given the option C<debug => 2>, There will always be a '--mark--'
entry at the base of the stack. See L</debug>.
count (at this point) db_nshow
=head3 B<db_stack>
Prints out the contents of the stack. No stack requirements.
The stack contents is printed top first, the last item printed is the lowest one inspected.
=head3 array B<db_print>
The closest this module has to a print statement. It takes an array of strings and/or numbers off the top of the
stack and prints them with a space in between each item.
[ (myvar1=) myvar1 (str2=) str2 ] db_print
will print something like the following.
myvar= 23.4 str2= abc
When printing something from the stack you need to take into account the array-building items, too. In the next
example, at the point '2 index' fetches 111, the stack holds '222 111 [ (top=)' but 'index' requires 5 to get at
222 because the stack now holds '222 111 [ (top=) 111 (next=)'.
222 111
[ (top=) 2 index (next=) 5 index ] db_print
willl output this.
top= 111 next= 222
It is important that the output does not exceed the string buffer size. The default is 256, but it can be changed
by giving B<new> the option C<bufsize>.
=head3 x y msg B<db_point>
It is common to have coordinates as the top two items on the stack. This call inspects them. It pops the message
off the stack, leaving x and y in place, then prints all three.
450 666
(starting point=) db_print
moveto
would produce:
starting point= ( 450 , 666 )
=head3 array B<db_array>
Like L</db_print> but the array is printed enclosed within square brackets.
=head3 var B<db_where>
A 'where' search is made to find the dictionary containing C<var>. The messages 'found' or 'not found' are output
accordingly. Of course, C<var> should be quoted with '/' to put the name on the stack, otherwise it will either
be executed or force an error.
=head3 B<db_newcol>
Starts the next debugging column. No stack requirements.
=head3 B<db_on>
Enable debug output
=head3 B<db_off>
Disable debug output
=head3 B<db_down>
Does a 'carriage-return, line-feed'. No stack requirements.
=head3 B<db_indent>
Moves output right by C<db_xtab>. No stack requirements. Useful for indenting output within loops.
=head3 B<db_unindent>
Moves output left by C<db_xtab>. No stack requirements.
=head1 EXPORTED FUNCTIONS
No functions are exported by default, they must be named as required.
use PostScript::File qw(
check_tilde check_file
incpage_label incpage_roman
array_as_string str
);
=head2 incpage_label( label )
The default function for B<set_incpage_handler> which just increases the number passed to it. A useful side
effect is that letters are also incremented.
=head2 incpage_roman( label )
An alternative function for B<set_incpage_handler> which increments lower case roman numerals. It only handles
values from "i" to "xxxix", but that should be quite enough for numbering the odd preface.
=head2 check_file( file, [dir, [create]] )
=over 4
=item C<file>
An optional fully qualified path-and-file or a simple file name. If omitted, the special file
File::Spec->devnull() is returned.
=item C<dir>
An optional directory C<dir>. If present (and C<file> is not already an absolute path), it is prepended to
C<file>.
=item C<create>
If non-zero, ensure the file exists. It may be necessary to set C<dir> to "" or undef.
=back
This ensures the filename returned is valid and in a directory tree which is created if it doesn't exist.
Any leading '~' is expanded to the users home directory. If no absolute directory is given either as part of
C<file>, it is placed within the current directory. Intervening directories are always created. If C<create> is
set, C<file> is created as an empty file, possible erasing any previous file of the same name.
L<File::Spec> is used throughout so file access should be portable.
=head2 check_tilde( dir )
Expands any leading '~' to the home directory.
=head2 array_as_string( array )
Converts a perl array to its PostScript representation.
=head2 str( arrayref )
Converts the referenced array to a string representation suitable for PostScript code. If C<arrayref> is not an
array reference, it is passed through unchanged. This function was designed to simplify passing colours for the
PostScript function b<gpapercolor> which expects either an RGB array or a greyscale decimal. See
L<PostScript::Graph::Paper/gpapercolor>.
=head2 pstr( string )
Converts the string to a string representation suitable for PostScript
code. If the result is more than 240 characters, it will be broken
into multiple lines. (A PostScript file should not contain lines with
more than 255 characters.)
This may also be called as a class or object method. In this case,
you can pass a second parameter C<nowrap>. If this optional parameter
is true, then the string will not be wrapped.
When called as an object method, C<pstr> will do automatic
hyphen-minus translation if L</auto_hyphen> is true. This has the
side-effect of setting the UTF8 flag on the returned string. (If the
UTF8 flag was not set on the input string, it will be decoded using
the document's character set.) See L</"Hyphens and Minus Signs">.
=head2 quote_text( string )
Quotes the string if it contains special characters, making it
suitable for a DSC comment. Strings without special characters are
returned unchanged.
This may also be called as a class or object method.
=head1 BUGS AND LIMITATIONS
When making EPS files, the landscape transformation throws the coordinates off. To work around this, avoid the
landscape flag and set width and height differently.
Most of these functions have only had a couple of tests, so please feel free to report all you find.
=head1 AUTHOR
Chris Willmot S<C<< <chris AT willmot.co.uk> >>>
Thanks to Johan Vromans for the ISOLatin1Encoding.
As of September 2009, PostScript::File is now being maintained by
Christopher J. Madsen S<C<< <perl AT cjmweb.net> >>>.
Please report any bugs or feature requests to
S<C<< <bug-PostScript-File AT rt.cpan.org> >>>,
or through the web interface at
L<http://rt.cpan.org/Public/Bug/Report.html?Queue=PostScript-File>
You can follow or contribute to PostScript::File's development at
L<http://github.com/madsen/postscript-file>.
=head1 COPYRIGHT AND LICENSE
Copyright 2002, 2003 Christopher P Willmot. All rights reserved.
Copyright 2011 Christopher J. Madsen. All rights reserved.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=head1 SEE ALSO
I<PostScript Language Document Structuring Conventions Specification
Version 3.0> and I<Encapsulated PostScript File Format Specification
Version 3.0> published by Adobe, 1992. L<http://partners.adobe.com/asn/developer/technotes/postscript.html>
L<PostScript::Convert>, for PDF or PNG output.
L<PostScript::Graph::Paper>,
L<PostScript::Graph::Style>,
L<PostScript::Graph::Key>,
L<PostScript::Graph::XY>,
L<PostScript::Graph::Bar>.
L<PostScript::Graph::Stock>.
L<PostScript::Calendar>.
L<PostScript::Report>.
=head1 DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
=cut
|