/usr/share/perl5/Shell/POSIX/Select.pm is in libshell-posix-select-perl 0.08-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 | package Shell::POSIX::Select;
our $VERSION = '0.08';
# TODO: Portable-ize tput stuff
# TODO: Dump user's code-block with same line numbers shown in error
# messages for debugging ease
# TODO: Add option to embolden menu numbers, to distinguish them from
# choices that are also numbers
# See documentation and copyright notice below =pod section below
# Not using Exporter.pm; doing typeglob-based exporting,
# using adapted code from Damian's Switch.pm
our ( @EXPORT_OK );
our ($Reply, $Heading, $Prompt);
@EXPORT_OK = qw( $Heading $Prompt $Reply $Eof );
our ( $U_WARN, $REPORT, $DEBUG, $DEBUG_default, $_DEBUG, );
our ( $U_WARN_default, $_import_called, $U_DEBUG, $DEBUG_FILT );
our ( $sdump, $cdump, $script );
#
our ( @ISA, @EXPORT, $PRODUCTION, $LOGGING, $PKG, $INSTALL_TESTING,$ON,$OFF, $BOLD, $SGR0, $COLS );
# What is the maximum number of columns that the user wants to see
# on-screen? By default, no maximum -- the number of columns will be
# determined by the width of the terminal and the length of the meny
# item strings.
our $MaxColumns = 99;
push @EXPORT_OK, '$MaxColumns';
BEGIN {
$PKG = __PACKAGE__ ;
$LOGGING = 0;
$SIG{TERM}=$SIG{QUIT}=$SIG{INT}= sub {
$DEBUG and warn caller(1), "\n";
# must disable reverse-video, if it was turned on
defined $ON and $ON ne "" and do {
my $reset=($SGR0 || $OFF); defined $reset and warn "$reset\n";
};
$DEBUG and warn "$0: killed by signal\n";
exit 111; # means, killed by signal
};
! defined $_import_called and $_import_called = 0;
( $script = $0 ) =~ s|^.*/||;
}
sub import ; # advance declaration
use File::Spec::Functions (':ALL');
use File::Spec::Functions 0.7;
use Filter::Simple 0.84;
# Damian's been fixing bugs as I report them, so best to have recent version
# This is the oldest version that I know works pretty well
use Text::Balanced 1.97 qw(extract_variable extract_bracketed);
use Carp;
$U_DEBUG=1;
$U_DEBUG=0;
$DEBUG_FILT=4;
# $DEBUG_FILT=0;
$DEBUG=1; # force verbosity level for debugging messages
# $DEBUG=0; # force verbosity level for debugging messages
$REPORT=1; # report subroutines when entered
# $REPORT=0; # report subroutines when entered
$DEBUG > 0 and warn "Logging is $LOGGING\n";
# controls messages and carp vs. warn (but that doesn't do much)
$PRODUCTION=1;
$PRODUCTION and $REPORT=$DEBUG_FILT=$DEBUG=0;
$DEBUG and disable_buffering();
sub _WARN; sub _DIE;
local $_; # avoid clobbering user's by accident
$Shell::POSIX::Select::_default_style='K'; # default loop-style is Kornish
$Shell::POSIX::Select::_default_prompt= "\nEnter number of choice:";
# I detest the shell's default prompt!
$Shell::POSIX::Select::_bash_prompt ='#?';
$Shell::POSIX::Select::_korn_prompt='#?';
$Shell::POSIX::Select::_generic ='#?';
$Shell::POSIX::Select::_arrows_prompt='>>';
$U_WARN_default = 1; # for enabling user-warnings for bad interactive input
# $_import_called > 0 or import(); # ensure initialization of defaults
my $subname=__PACKAGE__ ; # for identifying messages from outside sub's
my $select2foreach;
$select2foreach=1; # just translate select into foreach, for debugging
$select2foreach=0;
# warn "Setting up video modes\n";
# I know about Term::Cap, but this seems more direct and sufficient
$Shell::POSIX::Select::_FILTER_CALLS= $Shell::POSIX::Select::_ENLOOP_CALL_COUNT= $Shell::POSIX::Select::_LOOP_COUNT=0;
# Number of select loops detected
$DEBUG > 3 and $LOGGING and warn "About to call log_files\n";
$LOGGING and log_files(); # open logfiles, depending on DEBUG setting
$DEBUG >2 and warn "Import_called initially set to: $_import_called\n";
FILTER_ONLY
code_no_comments => \&filter,
all => sub { $LOGGING and print SOURCE };
$DEBUG >2 and warn "Import_called set to: $_import_called\n";
$DEBUG >2 and $Shell::POSIX::Select::_testmode and warn "testmode is $Shell::POSIX::Select::_testmode";
use re 'eval';
# Scope for declaration of pre-compiled REs:
{
my $RE_kw1 = qr^
(\bselect\b)
^x; # extended-syntax, allowing comments, etc.
my $RE_kw2 = qr^
\G(\bselect\b)
^x; # extended-syntax, allowing comments, etc.
my $RE_decl = qr^
(\s*
# grab declarator if there
(?: \b my \b| \b local \b| \b our \b )
\s*)
^x; # extended-syntax, allowing comments, etc.
my $RE_kw_and_decl = qr^
\bselect\b
\s*
( # Next, grab optional declarator and varname if there
(?: \b my \b| \b local \b| \b our \b )?
\s*
)?
^x; # extended-syntax, allowing comments, etc.
my $RE_list = qr^
\s*
(
# $RE{balanced}{-parens=>'()'}
)
^x; # extended-syntax, allowing comments, etc.
my $RE_block = qr^
\s*
# Is following really beneficial/necessary? I think I needed it in one case - tfm
(?= { ) # ensure opposite of } comes next
(
# now find the code-block
# $RE{balanced}{-parens=>'{}'}
)
^x; # extended-syntax, allowing comments, etc.
sub matches2fields;
sub enloop_codeblock;
sub filter {
my $subname = sub_name();
my $last_call = 0;
my $orig_string=$_;
my $detect_msg='<unset>';
++$::_FILTER_CALLS;
$orig_string ne $_ and die "$_ got trashed";
#/(..)/ and warn "Matched chars: '$1'\n"; # prime the pos marker
my $loopnum;
# Probably looping out of control if we get this many:
my $maxloops = 25;
my $first_celador;
if ( $last_call = ($_ eq "") ) {
return undef ;
}
else {
# TIMJI: Revisit; why is following the default?
$detect_msg="SELECT LOOP DETECTED";
$orig_string ne $_ and die "$_ got trashed";
$DEBUG > 1 and show_subs("****** Pre-Pre-WHILE ****** \n","");
$DEBUG > 1 and $LOGGING and print LOG "\$_ is '$_'\n";
$loopnum=0;
$DEBUG > 1 and show_subs("****** Pre-WHILE ****** \n","");
while (++$loopnum <= $maxloops) { # keep looping until we can't find any more select loops
$loopnum == 2 and $first_celador=$_;
$DEBUG > 1 and show_subs("****** LOOKING FOR LOOP ****** #$loopnum\n","");
$loopnum > 25 and warn "$subname: Might be stuck in loop\n";
$loopnum > 100 and die "$subname: Probably was stuck in loop\n";
$DEBUG > 3 and pos() and warn "pos is currently: ", pos(), "\n";
pos()=0;
/\S/ or $LOGGING and
print LOG "\$_ is all white space or else empty\n";
# /(..)/ and warn "Matched chars: '$1'\n"; # prime the pos marker
my ($matched, $can_rewrite) = 0;
if ($select2foreach) {
# simple conversion, for debugging basic ops
# change one word, and select loops with all pieces
# present are magically rendered syntactically acceptable
# NOTE: will break select() usage!
s/\bselect\b/foreach /g and $matched = -1;
# All these can be handled in one pass, so exit loop
goto FILTER_EXIT;
}
else {
my $pos;
my ($match, $start_match);
my ($got_kw,$got_decl, $got_loop_var, $got_list, $got_codeblock);
my $iteration=0;
FIND_LOOP:
my ($loop_var, $loop_decl, $loop_list, $loop_block)= ("" x 3);
$DEBUG_FILT > 0 and warn "Pos initially at ", pos($_), "\n";
!defined pos() and warn "AT FIND_LOOP, POS IS UNDEF\n";
$match=$got_kw=$got_decl=$got_loop_var=$got_list=$got_codeblock="";
my $matched=0; # means, currently no detected loops that still need replacement
# my $RE = ( $loopnum == 1 ? $RE_kw1 : $RE_kw2 ) ; # second version uses \G
my $RE = $RE_kw1 ; # always restart from the beginning, of incrementally modified program
# Same pattern good now, since pos() will have been reset by mod
# my $RE = ( $loopnum == 1 ? $RE_kw1 : $RE_kw1 ) ; # second version uses \G
if ( m/$RE/g ) { # try to match keyword, "select"
++$matched ;
$match=$1;
$start_match=pos() - length $1;
$got_kw=1;
$DEBUG_FILT > 1 and show_progress($match, pos(), $_);
}
else {
# no more select keywords to process! # LOOP EXIT #1
goto FILTER_EXIT;
}
$pos=pos(); # remember position
if (/\G$RE_decl/g) {
++$matched ;
$loop_decl=$1;
$match.=" $1";
$got_decl=1;
}
else {
pos()=$pos; # reset to where we left off
}
$DEBUG_FILT > 1 and show_progress($match, pos(), $_);
my @rest;
$DEBUG_FILT > 0 and warn "POS before ext-var is now ", pos(), "\n";
( $loop_var, @rest ) = extract_variable( $_ );
$DEBUG_FILT > 0 and show_subs( "POST- ext-var string is: ", $_, pos(),19);
$DEBUG_FILT > 0 and warn "POS after ext-var is now ", pos(), "\n";
if (defined $loop_var and $loop_var ne "" ) {
$got_loop_var=1;
$DEBUG_FILT > 0 and warn "Got_Loop_Var matched '$loop_var'\n";
$match.=" $loop_var";
}
else {
pos()=$pos; # reset to where we left off
$DEBUG_FILT > 0 and warn "extract_variable failed to match\n";
}
$DEBUG_FILT > 1 and show_progress($match, pos(), $_);
gobble_spaces();
# $DEBUG_FILT > 0 and warn "Pre-extract_bracketed ()\n";
( $loop_list, @rest ) = extract_bracketed($_, '()');
if (defined $loop_list and $loop_list ne "") {
++$matched;
$got_list=1;
$match.=" $loop_list";
$DEBUG_FILT > 1 and show_progress($match, pos(), $_);
}
else { # no loop list; not our kind of select
# warn "extract_bracketed failed to match\n";
# If we didn't find loop var, they're probably using
# select() function or syscall, not select loop
if ($got_loop_var) {
$DEBUG_FILT > 3 and
warn "$PKG: Found keyword and loop variable, but no ( LIST )!\n",
;
# "If { } really there, try placing 'no $PKG;' after loop to fix.\n";
}
else {
$DEBUG_FILT > 3 and warn "$PKG: Found keyword, but no ( LIST )\n",
"Must be some other use of the word\n";
}
$DEBUG_FILT > 0 and warn "giving up on this match; scanning for next keyword (1)";
if (++$iteration < $maxloops) {
goto FIND_LOOP;
}
else {
_DIE "$PKG: Maximum iterations reached while looking for select loop #$loopnum";
}
} # else
gobble_spaces();
# $DEBUG > 1 and warn " DDD sending to extract_bracketed() ===$_===\n";
( $loop_block, @rest ) = extract_bracketed($_, '{}');
# $DEBUG > 1 and warn " DDD extract_bracketed returned ===$loop_block===\n";
if (defined $loop_block and $loop_block ne "") {
++$matched;
$got_codeblock=1;
$match.=" $loop_block";
$DEBUG_FILT > 1 and show_progress($match, pos(), $_);
}
else {
# if $var there, can't possibly be select syscall or function use,
# so 100% sure there's a problem
if ($got_loop_var) {
warn "$PKG: Found loop variable and list, but no code-block!\n",
;
# "If { } really there, try placing 'no $PKG;' after loop to fix.\n";
}
else {
$DEBUG_FILT > 3 and warn "$PKG: Found keyword and list,",
" but no code-block\n",
"Must be some other use of the word\n";
}
$DEBUG_FILT > 0 and warn "giving up on this match; scanning for next keyword (2)";
goto FIND_LOOP;
}
# and print "list_and_block matched '$&'\n";
# defined $& and $match.=$&;
# defined $& and $match.="$1 $2";
#defined $& and ($loop_list, $loop_block) = ($1, $2);
my $end_match;
if ( $matched == 0 ) {
die" Can it ever get here?";
goto FILTER_EXIT;
}
else {
$end_match=pos();
$detect_msg='<unset>';
if ( $matched == 1 ) { # means "select" keyword only
;
}
if ( $matched == 2 ) { # means "select" plus decl, var, list, or block
$detect_msg="select loop incomplete; ";
$got_list or $detect_msg.= "no (LIST) detected\n";
$got_codeblock or $detect_msg.= "no {CODE} detected\n";
}
elsif ( $matched >= 3 ) {
}
}
# print "Entire match: $match\n";
# print "Matched Text: ",
# substr $_, $start_match,
# $end_match-$start_match;
if ( $matched > 1 ) { # 1 just means select->foreach conversion
$::_LOOP_COUNT++; # counts # detected select-loops
$DEBUG > 0 and
warn "$PKG: Set debug to: $Shell::POSIX::Select::DEBUG\n";
}
# $can_rewrite indicates whether we matched the crucial
# parts that allow replacement of the input -- the list and codeblock
# If we got both, the $can_rewrite var shows true now
$can_rewrite = $matched >= 2 ? 1 : 0;
# $DEBUG > 1 and warn "Calling MATCHES2FIELDS with \$loop_list of $loop_list\n";
# $DEBUG > 1 and warn "Calling MATCHES2FIELDS with \$loop_block of ===$loop_block===\n";
if ($can_rewrite) {
my $replacer = enloop_codeblock
matches2fields ( $loop_decl,
$loop_var,
$loop_list,
$loop_block ),
$::_LOOP_COUNT;
substr($_, $start_match, ($end_match-$start_match), $replacer );
# print "\n\nModified \$_ is: \n$_\n";
}
}
} # end while
continue {
$DEBUG_FILT > 2 and warn "CONTINUING FIND_LOOP\n" ;
}
#warn "Leaving $subname 1 \n";
} # else
FILTER_EXIT:
# $Shell::POSIX::Select::filter_output="PRE-LOADING DUMP VAR, loopnum was $loopnum";
if (
0 # and $DEBUG or $Shell::POSIX::Select::dump_data
) {
# print TTY "$detect_msg\nCode 222\n" ;
# print TTY "Code 222\n" ;
if ($loopnum == 1 and
$detect_msg !~ /SELECT LOOP DETECTED/ ) {
# $DEBUG and print STDERR "copacetic\n";
# exit 222;
# We still need to run the program!
}
else {
$DEBUG >2 and print TTY "LOOP DETECTED: $detect_msg\n"; exit 222;
}
} # if 0
$loopnum > 0 and $Shell::POSIX::Select::filter_output=$_;
# Restore original string-like parts of the code:
$Shell::POSIX::Select::filter_output =~ s/$Filter::Simple::placeholder/${$Filter::Simple::components[unpack('N',$1)]}/ge;
$LOGGING and print USERPROG $_; # $_ unset 2nd call; label starts below
$DEBUG_FILT > 2 and _WARN "Leaving $subname on call #$::_FILTER_CALLS\n";
} # end sub filter
} # Scope for declaration of filters' REs
sub show_progress {
my $subname = sub_name();
my ($match, $pos, $string) = @_;
! defined $match or $match eq "" and warn "$subname: \$match is empty\n";
show_subs( "Match so far: ", $match, 0, 99);
defined $pos and warn "POS is now $pos\n";
show_subs( "Remaining string: ", $string, $pos, 19);
} # show_progress
sub show_context {
my $subname = sub_name();
my ($left, $match, $right) = @_;
$DEBUG > 0 and warn "left/match/right: $left/$match/$right";
show_subs( "Left is", $left, -10);
show_subs( "Right is", $right, 0, 10);
} # show_context
# Following sub converts matched elements of users source into the
# fields we need: declaration (optional), loop_varname (optional), codeblock
sub matches2fields {
my $subname = sub_name();
my $default_loopvar = 0;
my ( $debugging_code, $codeblock2, );
my ( $decl, $loop_var, $values, $codeblock, $fullmatch ) = @_;
$debugging_code = "";
if ($U_DEBUG > 3) {
$debugging_code = "\n# USER-MODE DEBUGGING CODE STARTS HERE\n";
$debugging_code .=
'; $,="/"; warn "Caller is now: ", (caller 0), "\n";';
$debugging_code .=
'warn "Caller 3 is now: ", ((caller 0)[3]), "\n";';
$debugging_code .= 'warn "\@_ is: @_\n";';
$debugging_code .= 'warn "\@ARGV is: @ARGV\n";';
# $debugging_code .=
# 'warn "\@looplist is : @Shell::POSIX::Select::looplist\n"';
$debugging_code .= "# USER-MODE DEBUGGING CODE ENDS HERE\n\n";
$debugging_code .= "";
}
if ( !defined $values or $values =~ /^\s*\(\s*\)\s*$/ ) { # ( ) is legit syntax
# warn "values is undef or vacant";
# Code to let user prog figure out if select loop is in sub,
# and if so, selects @_ for default LIST
$values = # supply appropriate default list, depending on programmer's context
'defined ((( caller 0 )[3]) and ' .
' (( caller 0 )[3]) ne "") ? @_ : @ARGV '
;
}
if ( defined $decl and $decl ne "" and
defined $loop_var and $loop_var ne "" ) {
$LOGGING and print LOG
"LOOP: Two-part declaration,",
" scoper is: $decl, varname is $loop_var\n";
}
elsif ( defined $decl and $decl ne "" and
(! defined $loop_var or $loop_var eq "") ) {
$LOGGING and print LOG
"LOOP: Declaration without variable name: $decl" ;
warn "$PKG: variable declarator ($decl) provided without variable name\n";
warn "giving up on this match; scanning for next keyword (3)";
goto FIND_LOOP;
}
elsif ( defined $loop_var and $loop_var ne "" and
(! defined $decl or $decl eq "") ) {
$LOGGING and print LOG
"LOOP: Variable without declaration (okay): $loop_var"
}
else {
$LOGGING and print LOG "LOOP: zero-word declaration\n";
my $default_loopvar = 1;
($decl, $loop_var) = qw (local $_); # default loop var; package scope
}
if ( !defined $codeblock or $codeblock =~ /^\s*{\s*}\s*$/ ) {
# default codeblock prints the selection; good for grep()-like filtering
# NOTE: Following string must start/end with {}
$codeblock = "{
print \"$loop_var\\n\" ; # ** USING DEFAULT CODEBLOCK **
}";
}
# I've already extracted what could be a valid variable name,
# but the regex was kinda sleazy, so it's time to validate
# it using TEXT::BALANCED::extract_variable()
# But I found a bug, it rejects $::var*, so exempt that form from check
unless ($default_loopvar or $loop_var =~ /^\$::\w+/) {
# don't check if I inserted it myself, or is in form $::stuff,
# which extract_variable() doesn't properly extract
$DEBUG > 1 and warn "Pre-extract_variable 3\n";
# Now let's see if Damian likes it:
my ( $loop_var2, @rest ) = extract_variable($loop_var);
if ( $loop_var2 ne $loop_var ) {
$DEBUG > 1 and
warn "$PKG: extracted var diff from parsed var: ",
$DEBUG > 0 and warn
"$PKG: varname for select loop failed validation",
" #$::_LOOP_COUNT: $loop_var\n";
}
}
else {
;
}
!defined $decl and $decl = "";
# okay for this to be empty string; means user wants it global, or
# declared it before loop
# make version of \$codeblock without curlies at either end
( $codeblock2 = $codeblock ) =~ s/\A\s*\{\s*|\s*\}\s*\z//g;
defined $decl and $decl eq 'unset' and undef $decl; # pass as undef
# $DEBUG > 1 and warn " DDD matches2fields() is returning codeblock2 ===$codeblock2===\n";
return ( $decl, $loop_var, $values, $codeblock2, $debugging_code );
} # matches2fields
sub enloop_codeblock {
# Wraps code implementing select-loop around user-supplied codeblock
my $subname = sub_name();
$Shell::POSIX::Select::_ENLOOP_CALL_COUNT++;
my ( $decl, $loop_var, $values, $codestring, $dcode, $loopnum ) = @_;
(defined $values and $values ne "") or do {
$DEBUG > 1 and _WARN "NO VALUES! Using dummy ones";
$values = '( dummy1, dummy2 )';
};
my $declaration =
( defined $decl and $decl ne "" ) ? "$decl $loop_var; " .
' # LOOP-VAR DECLARATION REQUESTED (perhaps by default)' :
" ; # NO DECLARATION OF LOOP-VAR REQUESTED";
my $arrayname = $PKG . '::looplist';
my $NL = '\n';
# Now build the code for the user-prog to run
my @parts;
# Start new scope first, so if user has LOOP: label before select,
# it applies to the whole encapsulated loop
# wrapper scope needed so user can LABEL: select(), and not *my* label
push @parts, qq(
# Code generated by $PKG v$VERSION, by tim(AT)TeachMePerl.com
# NOTA BENE: Line 1 of this segment must start with {, so user can LABEL it
{ # **** NEW WRAPPER SCOPE FOR SELECTLOOP #$loopnum ****
\$${PKG}::DEBUG > 1 and $loopnum == 1 and
warn "LINE NUMBER FOR START OF USER CODE_BLOCK IS: ", __LINE__, "\\n";
_SEL_LOOP$loopnum: { # **** NEW SCOPE FOR SELECTLOOP #$loopnum ****
);
# warn " DDD LOGGING is now $LOGGING\n";
$LOGGING and (print PART1 $parts[0] or _DIE "failed to write to PART1\n");
$DEBUG > 4 and warn "SETTING $arrayname to $values\n";
push @parts, qq(
# critical for values's contents to be resolved in user's scope
local \@$arrayname=$values;
local \$${PKG}::num_values=\@$arrayname;
\$${PKG}::DEBUG > 4 and do {
warn "ARRAY VALUES ARE: \@$arrayname\\n";
warn "NUM VALUES is \$${PKG}::num_values\\n";
warn "user-program debug level is \$${PKG}::U_WARN\\n";
};
$declaration # loop-var declaration appears here
);
$LOGGING and (print PART2 $parts[1] or _DIE "failed to write to PART1\n");
$DEBUG > 4 and do {
warn "\$codestring is: $codestring\n";
warn "\$dcode is: '$dcode'\n";
warn "\$arrayname is: $arrayname\n";
!defined $Shell::POSIX::Select::_autoprompt and warn "autoprompt is unset";
!defined $codestring and warn "codestring is unset";
};
{ # local scope for $^W mod
# getting one pesky "uninit var" warnings I can't resolve
local $^W=0;
push @parts, qq(
$dcode;
local (
\$${PKG}::Prompt[$loopnum],
\$${PKG}::menu
) =
${PKG}::make_menu(
\$${PKG}::Heading || "",
\$${PKG}::Prompt || "" , # Might be overridden in make_menu
\@$arrayname
);
# no point in prompting a pipe!
local \$${PKG}::do_prompt[$loopnum] = (-t) ? 1 : 0 ;
$DEBUG > 2 and warn "do_prompt is \$${PKG}::do_prompt[$loopnum]\\n";
if ( defined \$${PKG}::menu ) { # No list, no iterations!
while (1) { # for repeating prompt for selections
# localize, so I don't have to reset $Reply for
# outer loop on exit from inner
local (\$Reply);
while (1) { # for validating user's input
local \$${PKG}::bad = 0;
# local decl suppresses newline on prompt when -l switch turned on
{
local \$\\;
if (\$${PKG}::do_prompt[$loopnum]) {
# When transferring from INNER to OUTER loop,
# extra NL before prompt is visually desirable
if ( \$${PKG}::_extra_nl) {
print STDERR "\\n\\n";
\$${PKG}::_extra_nl=0;
}
print STDERR
"\$${PKG}::menu$NL$ON\$${PKG}::Prompt[$loopnum]$OFF$BOLD ";
}
}
# \$${PKG}::do_prompt=$Shell::POSIX::Select::_autoprompt;
# constant prompting depends on style
\$${PKG}::do_prompt[$loopnum]= 0;
if ( \$${PKG}::dump_data ) {
\$Reply = undef;
# dump filtered source for comparison against expected
print STDERR "copacetic\n"; # ensure some output, and flush pending
exit 222; # code for graceful, expected, early exit
}
else {
# \$^W=0;
# warn "Waiting for input";
\$Eof=0;
\$Reply = <STDIN>;
# warn "Got input";
# \$^W=1;
if ( !defined( \$Reply ) ) {
defined "$BOLD" and "$BOLD" ne "" and print STDERR "$SGR0";
# need to undef loop var; user may check it!
undef $loop_var;
# last ${PKG}::_SEL_LOOP$loopnum; # Syntax error!
# If returning to outer loop, show the prompt for it
# warn "User hit ^D";
if ( $loopnum > 1 and -t ) { # reset prompting for outer loop
\$${PKG}::do_prompt[$loopnum-1] = 1; \$${PKG}::_extra_nl=1;
}
$DEBUG > 2 and warn "Lasting out of _SEL_LOOP$loopnum\\n";
\$Eof=1;
last _SEL_LOOP$loopnum;
}
!defined \$Reply and die "REPLY accessed, while undefined";
chomp \$Reply;
# undo emboldening of user input
defined "$BOLD" and "$BOLD" ne "" and print STDERR "$SGR0";
#print STDERR "\$${PKG}::menu$NL$ON\$${PKG}::Prompt$OFF$BOLD ";
if ( \$Reply eq "" ) { # interpreted as re-print menu request
# Empty input is legit, means redisplay menu
\$${PKG}::U_WARN > 1 and warn "\\tINPUT IS: empty\\n";
\$${PKG}::bad = \$${PKG}::do_prompt[$loopnum] = 1;
}
elsif ( \$Reply =~ /\\D/ ) { # shouldn't be any non-digit!
\$${PKG}::U_WARN > 0
and warn "\\tINPUT CONTAINS NON-DIGIT: '\$Reply'\\n";
\$${PKG}::bad = 1; # Korn and Bash shell just ignore this case
}
elsif ( \$Reply < 1 or \$Reply > \$${PKG}::num_values ) {
\$${PKG}::U_WARN > 0
and warn
"\\t'\$Reply' IS NOT IN RANGE: 1 - \$${PKG}::num_values\\n";
\$${PKG}::bad = 1; # Korn and Bash shell just ignore this case
}
# warn "BAD is now: \$${PKG}::bad";
\$${PKG}::bad or
$DEBUG > 2 and warn "About to last out of Reply Validator Loop\n";
\$${PKG}::bad or last; # REPLY VALIDATOR EXITED HERE
} # if for validating user input
} # infinite while for validating user input
$loop_var = \$$arrayname\[\$Reply - 1]; # set users' variable
# USER'S LOOP-BLOCK BELOW
$codestring;
# USER'S LOOP-BLOCK ABOVE
# Making sure there's colon (maybe
# even two) after codestring above,
# in case user omitted after last
# statement in block. I might add
# another statement below it someday!
$DEBUG > 2 and warn "At end of prompt-repeating loop \n";
} # infinite while for repeating collection of selections
$DEBUG and warn "BEYOND end of prompt-repeating loop \n";
} # endif (defined \$${PKG}::menu)
else {
\$${PKG}::DEBUG > 0 and warn "$PKG: Select Loop #$loopnum has no list, so no iterations\\n";
if ( \$${PKG}::dump_data ) {
\$Reply = undef;
# dump filtered source for comparison against expected
print STDERR "copacetic\n"; # ensure some output, and flush pending
exit 222; # code for graceful, expected, early exit
}
}
# return omitted above, to get last expression's value
# returned automatically, just like shell's version
); # push onto parts ender
} # local scope for $^W mod
$LOGGING and (print PART3 $parts[2] or _DIE "failed to write to PART3\n");
push @parts, qq(
} # **** END NEW SCOPE FOR SELECTLOOP #$loopnum ****
} # **** END WRAPPER SCOPE FOR SELECTLOOP #$loopnum ****
# vi:ts=2 sw=2:
);
$LOGGING and (print PART4 $parts[3] or _DIE "failed to write to PART4\n");
# Following is portable PART-divider, used to isolate chunk
# with unitialized value causing warning
# ); push @parts, qq(
return ( join "", @parts ); # return assembled code, for user to run
} # enloop_codeblock
sub make_menu {
my $subname = sub_name();
# Replacement of empty list by @_ or @ARGV happens in matches2fields
# Here we check to see if we got arguments from somewhere
# Note that it's not necesssarily an error if there are no values,
# that just means we won't do any iterations
my ($heading) = shift;
my ($prompt) = shift;
my (@values) = @_;
unless (@values) {
return ( undef, undef ); # can't make menu out of nothing!
}
my ( $l, $l_length ) = 0;
my $count = 5;
my ( $sep, $padding ) = "" x 2;
my $choice = "";
# Find longest string value in selection list
my $v_length = 0;
for ( my $i = 0 ; $i < @values ; $i++ ) {
( $l = length $values[$i] ) > $v_length and $v_length = $l;
}
$DEBUG > 3 and $LOGGING and print LOG "Longest value is $v_length chars\n";
# Figure out lengths of labels (numbers on menu selections)
$DEBUG > 3 and $LOGGING and print LOG "Number of values is ", scalar @values, "\n";
@values >= 10_000 ? $l_length = 5 :
@values >= 1_000 ? $l_length = 4 :
@values >= 100 ? $l_length = 3 :
@values >= 10 ? $l_length = 2 :
@values > 0 ? $l_length = 1 :
undef $l_length;
$DEBUG > 3 and $LOGGING and print LOG "Label length is $l_length\n";
if ( !defined $l_length ) { return undef; }
$sep = "\040\040";
my $l_sep = length $sep; # separator 'tween pieces
# Figure out how many columns per line we can print
# 2 is for :<SP> after label
# TIMJI: Convert to using YUMPY's Term::Size::Heuristic here, later on
my $one_label = ( $l_length + 2 ) + $v_length + $l_sep;
my $columns = int( $COLS / $one_label );
$columns < 1 and $columns = 1;
# Do not let the number of columns grow beyond the maximum:
if ($MaxColumns < $columns)
{
$columns = $MaxColumns;
} # if
# $DEBUG > 3 and
#HERE
$LOGGING and print LOG "T-Cols, Columns, label: $COLS, $columns, $one_label\n";
# Prompt may have been set in import() according to a submitted option;
# if so, keep it. If not, use shell's default
$prompt =
(defined $Shell::POSIX::Select::Prompt and
$Shell::POSIX::Select::Prompt ne "") ?
$Shell::POSIX::Select::Prompt :
defined $ENV{Select_POSIX_Shell_Prompt} ? $ENV{Select_POSIX_Shell_Prompt} :
$Shell::POSIX::Select::_default_prompt;
;
$DEBUG > 3 and $LOGGING and print LOG "Making menu\n";
{
local $, = "\n";
}
my $menu;
$menu = defined $heading ? "${ON}$heading$OFF" : "" ;
$menu.="\n";
# $columns == 0 and die "Columns is zero!";
for ( my $i = 0, my $j = 1 ; $i < @values ; $i++, $j++ ) {
$menu .= sprintf "%${l_length}d) %-${v_length}s$sep", $j, $values[$i];
$j % $columns or $menu .= sprintf "\n"; # format $count items per line
# For 385 line list:
# Illegal modulus zero at /pmods/yumpy/Select/Shell/POSIX/Select.pm line 764.
}
return ( $prompt, $menu );
} # make_menu
sub log_files {
my $subname = sub_name();
my ($dir, $sep);
if ( $LOGGING == 1 ) {
$dir = tmpdir();
#
# USERPROG shows my changes, with control-chars
# filling in as placeholders for some pieces. For
# debugging purposes, I find it helpful to print that
# out ASAP so I have something to look at if the
# program bombs out before SOURCE gets written out,
# which is the same apart from placeholders being
# converted to original data.
#
$DEBUG > 1 and $LOGGING > 0 and warn "Opening log files\n";
open LOG, '>', catfile($dir, 'SELECT_log') or _DIE "Open LOG failed, $!\n";
open SOURCE, '>', catfile($dir, 'SELECT_source') or _DIE "Open SOURCE failed, $!\n";
open USERPROG, '>', catfile($dir, 'SELECT_user_program') or _DIE "Open USERPROG failed, $!\n";
open PART1, '>', catfile($dir, 'SELECT_part1') or _DIE "Open PART1 failed, $!\n";
open PART2, '>', catfile($dir, 'SELECT_part2') or _DIE "Open PART2 failed, $!\n";
open PART3, '>', catfile($dir, 'SELECT_part3') or _DIE "Open PART3 failed, $!\n";
open PART4, '>', catfile($dir, 'SELECT_part4') or _DIE "Open PART4 failed, $!\n";
$LOGGING++; # to avoid 2nd invocation
$DEBUG > 1 and $LOGGING > 0 and warn "Finished with log files\n";
}
elsif ($LOGGING > 1) {
$DEBUG > 0 and warn "$subname: Logfiles opened previously\n";
}
else {
$DEBUG > 0 and warn "$subname: Logfiles not opened\n";
}
} # log_files
sub sub_name {
my $callers_name = (caller 1)[3] ;
if ( ! defined $callers_name ) {
$callers_name='Main_program'; # must be call from main
}
else {
$callers_name =~ s/^.*:://; # strip package name
$callers_name .= '()'; # sub_name -> sub_name()
}
return $callers_name;
} # sub_name
sub _WARN {
my $subname = sub_name();
$PRODUCTION ? carp(@_) : warn (@_);
}
sub _DIE {
my $subname = sub_name();
$DEBUG and warn "$0: In _DIE, with PRODUCTION of $PRODUCTION, arg of @_\n";
$PRODUCTION ? croak(@_) : die (@_);
}
sub ignoring_case { lc $a cmp lc $b }
sub import {
local $_;
my $subname = sub_name();
my %import;
$_import_called++;
shift; # discard package name
$Shell::POSIX::Select::U_WARN = $Shell::POSIX::Select::U_WARN_default;
$Shell::POSIX::Select::_style = $Shell::POSIX::Select::_default_style;
# $Shell::POSIX::Select::_prompt =
# Prompt is now established in make_menu, during run-time
$Shell::POSIX::Select::_autoprompt=0;
# First, peel off symbols to import, if any
# warn "Caller of $subname is ", scalar caller, "\n";
my $user_pkg=caller;
# $DEBUG > 2 and
for (my $i=0; $i<@_; $i++) {
my $found=0;
foreach (@EXPORT_OK) { # Handle $Headings, etc.
if ($_[$i] eq $_) { $import{$_} = $i; $found++; last; }
}
# stop as soon as first non-symbol encountered, so as not to
# accidentally mess with following hash-style options
$found==0 and last;
}
%import and export($user_pkg, keys %import); # create aliases for user
# following gets "attempt to delete unreferenced scalar"!
# %import and delete @_[values %import];
# Delete from @_ each
map { delete $_[$_] } values %import; # but this works
# warn "Numvals in array is ", scalar @_, "\n";
@_= grep defined, @_; # reset, to eliminate extracted imports
# warn "Numvals in array is now ", scalar @_, "\n";
# warnings sets user-program debugging level
# debug sets module's debuging level
my @legal_options = qw( style prompt testmode warnings debug logging );
my %options =
hash_options(\@legal_options, @_ ); # style => Korn, etc.
my @styles=qw( bash korn );
my @prompts=qw( generic korn bash arrows );
my @testmodes=qw( make foreach );
my $bad;
# timji: Loopify this section later, once it gets stable
# "logging" enables/disables logging of filter output to file
$_ = $ENV{Shell_POSIX_Select_logging} || $options{logging};
if (defined) {
# unless ( is_unix() ) {
# warn "$PKG\::$subname: logging is only for UNIX-like OSs\n";
# }
if (/^(\d)$/ and 0 <= $1 and $1 <=1 ) {
$LOGGING = $_;
$DEBUG > 0 and warn "$PKG: Set logging to: $LOGGING\n";
}
else {
_WARN "$PKG\::$subname: Invalid logging level '$_'\n";
$DEBUG > 1 and _DIE;
}
}
# "debug" enables/disables informational messages while running user program
$_ = $ENV{Shell_POSIX_Select_warnings} || $options{warnings};
$select2foreach=0;
if (defined) {
if (/^\d+$/) {
$Shell::POSIX::Select::U_WARN = $_;
warn "$PKG: Set warnings to: $Shell::POSIX::Select::U_WARN\n";
}
else {
_WARN "$PKG\::$subname: Invalid warnings level '$_'\n";
$DEBUG > 1 and _DIE;
}
}
# "debug" enables/disables informational messages while running user program
$_ = $ENV{Shell_POSIX_Select_debug} || $options{debug};
if (defined) {
if (/^\d+$/) {
$Shell::POSIX::Select::DEBUG = $_;
}
else {
_WARN "$PKG\::$subname: Invalid debug option '$_'\n";
$DEBUG > 1 and _DIE;
}
}
$_=$ENV{Shell_POSIX_Select_style} || $options{style};
if (defined) {
my $found=0;
foreach my $style (@styles) {
if ($_ =~ /^$style$/i ) { # korn, bash,etc.
# code as K, B, etc.
$Shell::POSIX::Select::_style = uc substr($_,0,1);
$found++; # last one wins
}
}
if (! $found) {
_WARN "$PKG\::$subname: Invalid style option '$_'\n";
$DEBUG > 1 and _DIE;
}
}
# Bash automatically shows prompt every time,
# Ksh only does if user enters input of <CR> only
my $autoprompt=0;
if ( $Shell::POSIX::Select::_style eq 'K' ) { $autoprompt=0; }
elsif ( $Shell::POSIX::Select::_style eq 'B' ) { $autoprompt=1; }
$Shell::POSIX::Select::_autoprompt = $autoprompt;
$_ = $ENV{Shell_POSIX_Select_prompt} || $options{prompt} ;
if (defined) {
$_=lc $_;
my $found=0;
foreach my $prompt (sort @prompts) { # sorting, so "generic" choice beats shell-specific ones
if ($_ =~ /^$prompt$/i ) {
$_ eq 'generic' and do {
$DEBUG > 0 and warn "Set generic prompt";
$Shell::POSIX::Select::_prompt =
$Shell::POSIX::Select::_generic;
++$found and last;
die 33;
};
$_ eq "korn" and do {
$Shell::POSIX::Select::_prompt =
$Shell::POSIX::Select::_korn_prompt;
$found++;
last;
};
$_ eq "bash" and do {
$Shell::POSIX::Select::_prompt =
$Shell::POSIX::Select::_bash_prompt;
$found++;
last;
};
$_ eq "arrows" and do {
$Shell::POSIX::Select::_prompt =
$Shell::POSIX::Select::_arrows_prompt;
$found++;
last;
};
}
# If not a prompt keyword, must be literal prompt
do {
$Shell::POSIX::Select::_prompt = $_;
$found++;
last;
};
}
if (! $found) {
_WARN "$PKG\::$subname: Invalid prompt option '$_'\n";
$DEBUG > 1 and _DIE;
}
}
$Shell::POSIX::Select::dump_data=0;
$_= $ENV{Shell_POSIX_Select_testmode} || $options{testmode} ;
if (defined) {
my $found=0;
#foreach my $mode ( @testmodes ) {
if ($_ =~ /^make$/i ) {
$Shell::POSIX::Select::_testmode= 'make';
$Shell::POSIX::Select::dump_data=1;
$found++;
}
elsif ($_ =~ /^foreach$/i ) {
$Shell::POSIX::Select::_testmode= 'foreach';
$select2foreach=1;
$found++;
}
else {
$Shell::POSIX::Select::_testmode= '';
$DEBUG > 2 and _WARN "Unrecognized testmode: $_\n";
}
#}
if (! $found) {
_WARN "$PKG\::$subname: Invalid testmode option '$_'\n";
$DEBUG > 1 and _DIE;
}
}
# ENV variable overrides program spec
( ! defined $Shell::POSIX::Select::_testmode or
$Shell::POSIX::Select::_testmode eq "" ) and
$Shell::POSIX::Select::_testmode = "";
$DEBUG > 2 and warn "37 Testmode set to $Shell::POSIX::Select::_testmode\n";
$LOGGING and log_files();
$ENV{Shell_POSIX_Select_reference} and
$Shell::POSIX::Select::dump_data = 'Ref_Data';
# Don't assume /dev/tty will work on user's platform!
if ( $Shell::POSIX::Select::dump_data ) {
# must ensure all output gets flushed to dumpfile before exiting
disable_buffering();
#if ( ! $PRODUCTION ) {
$Shell::POSIX::Select::_TTY=0;
# What's the OS-portable equivalent of "/dev/tty" in the above?
if ( -c '/dev/tty' ) {
if ( open TTY, '> /dev/tty' ) {
$Shell::POSIX::Select::_TTY=1;
}
else {
_WARN "Open of /dev/tty failed, $!\n";
}
}
#}
$sdump = qq/$script.sdump/;
if ($Shell::POSIX::Select::dump_data =~ /[a-z]/i)
{
$sdump = catfile($Shell::POSIX::Select::dump_data, $sdump .'_ref');
}
else
{
# TODO: probably should put it in the same
# folder as the original program being
# analyzed, rather than '.':
$sdump = catfile('.', $sdump);
}
($cdump = $sdump) =~ s/$script\.sdump/$script.cdump/; # make code-dump name too
# HERE next two lines squelch
# Make reference copies of dumps for distribution, or test copies,
# depending on ENV{reference} set or testmode=make
close STDERR or
die "$PKG-END(): Failed to close 'STDERR', $!\n";
open STDERR, "> $sdump" or
die "$PKG-END(): Failed to open '$sdump' for writing, $!\n";
open STDOUT, ">&STDERR" or
die "$PKG-END(): Failed to dup STDOUT to STDERR, $!\n";
}
( $ON , $OFF , $BOLD , $SGR0 , $COLS ) =
display_control ($Shell::POSIX::Select::dump_data);
1;
} # import
sub export { # appropriated from Switch.pm
my $subname = sub_name();
# $offset = (caller)[2]+1;
my $pkg = shift;
no strict 'refs';
# All exports are scalard vars, so strip sigils and poke in package name
foreach ( map { s/^\$//; $_ } @_ ) { # must change $Reply to Reply, etc.
*{"${pkg}::$_"} =
\${ "Shell::POSIX::Select::$_" };
# "Shell::POSIX::Select::$_";
}
# *{"${pkg}::__"} = \&__ if grep /__/, @_;
1;
}
sub hash_options {
my $ref_legal_keys = shift;
my %options = @_ ;
my $num_options=keys %options;
my %options2 ;
my $subname = sub_name();
if ($num_options) {
my @legit_options =
grep { "@$ref_legal_keys" =~ /\b $_ \b/x }
sort ignoring_case keys %options;
my @illegit_options =
grep { "@$ref_legal_keys" !~ /\b $_ \b/x }
sort ignoring_case keys %options;
@options2{sort ignoring_case @legit_options} =
@options{sort ignoring_case @legit_options } ;
{ # scope for local change to $,
local $,=' ';
if ($num_options > keys %options2) { # options filtered out?
my $msg= "$PKG\::$subname:\n Invalid options: " ;
$msg .= "@illegit_options\n";
_DIE; # Can't be conditional on DEBUG setting,
# because that comes after this sub returns!
}
}
}
return %options2;
}
sub show_subs {
# show sub-string in reverse video, primarily for debugging
my $subname = sub_name();
@_ >= 1 or die "${PKG}\::subname: no arguments\n" ;
my $msg=shift || '<no msg>';
my $string=(shift || '');
my $start=(shift || 0);
my $length=(shift || 9999);
$string =~ s/[^[:alpha:\d\s]]/-/g; # control-chars screw up printing
# warn "Calling substr for parms $string/$start/$length\n";
warn "$msg", $ON, substr ($string, $start, $length), $OFF, "\n";
}
sub gobble_spaces {
my $subname = sub_name();
my $pos=pos(); # remember current position
if (/\G\s+/g) {
$DEBUG_FILT > 1 and
warn "$subname: space gobbler matched '$&' of length ", length $&, "\n" ;
}
else {
$DEBUG_FILT > 1 and warn "$subname: space gobbler matched nothing\n";
pos()=$pos; # reset to prior position
}
$pos=pos(); # identify current position
}
sub display_control {
my $subname = sub_name();
my $flag=shift;
my ( $on , $off , $bold , $sgr0 , $cols ) ;
# in "make" or "reference" testmodes, mustn't clutter output with coloration
# Disable screen manips for reference source-code dumps
unless ( $flag ) {
if ( is_unix() and
defined $ENV{TERM} and
! system 'tput -V >/dev/null 2>&1' ) {
# Always need column count
# for menu sizing
$cols=`tput cols`; defined $COLS and chomp ($COLS) ;
if ($flag ne 'make') {
$on=`tput smso`;
$off=`tput rmso` || `tput sgr0`;
$bold=`tput bold`; # for prettifying screen captures
$sgr0=`tput sgr0`; # for prettifying screen captures
}
}
else {
}
$DEBUG > 2 and warn "Returning $on , $off , $bold , sgr0 , $cols \n";
}
return ($on || "", $off || "", $bold || "", $sgr0 || "", $cols || 80);
}
END { # END block
# sdump means screen-dump, cdump means code-dump
if ( $Shell::POSIX::Select::dump_data ) {
if ( $ENV{Shell_POSIX_Select_reference} ) {
}
else {
}
my $pwd=curdir();
# $Shell::POSIX::Select::_TTY and
# dump filtered source, for reference or analysis
unless (open SOURCE, "> $cdump") {
$Shell::POSIX::Select::_TTY and
print TTY "$PKG-END(): Failed to open '$cdump' for writing, $!\n" and
warn "$PKG-END(): Failed to open '$cdump' for writing, $!\n" ;
die;
}
defined $Shell::POSIX::Select::filter_output and
(print SOURCE $Shell::POSIX::Select::filter_output or
die "$PKG-END(): Failed to write to '$cdump', $!\n");
# system "ls -li $cdump $sdump";
}
# Screen dumping now arranged in sub import()
# open SCREEN, "> $script.sdump" or
# die "$PKG-END(): Failed to open '$script.sdump' for writing, $!\n";
else {
defined $SGR0 and $SGR0 ne "" and print STDERR "$SGR0"; # ensure turned off
$DEBUG > 1 and $LOGGING and print LOG "\n$PKG finished\n";
print STDERR "\n"; # ensure shell prompt starts on fresh line
}
exit 0;
}
sub is_unix {
if (
# I'm using the $^O from File::Spec, which oughta know
# and guessing at others; help!
$^O =~ /^(MacOS|MSWin32|os2|VMS|epoc|NetWare|dos|cygwin)$/ix
) {
$DEBUG > 2
and warn "Operating System not UNIX;", $^O, "\n";
}
else {
$DEBUG > 2
and warn "Operating System reported as ", $^O, "\n";
}
return defined $1 ? 0 : 1 ;
}
sub disable_buffering {
my $old_fh = select (STDERR);
$|=1;
select ($old_fh);
return 0;
}
=pod
=head1 NAME
Shell::POSIX::Select - The POSIX Shell's "select" loop for Perl
=head1 PURPOSE
This module implements the C<select> loop of the "POSIX" shells (Bash, Korn, and derivatives)
for Perl.
That loop is unique in two ways: it's by far the friendliest feature of any UNIX shell,
and it's the I<only> UNIX shell loop that's missing from the Perl language. Until now!
What's so great about this loop? It automates the generation of a numbered menu
of choices, prompts for a choice, proofreads that choice and complains if it's invalid
(at least in this enhanced implementation), and executes a code-block with a variable
set to the chosen value. That saves a lot of coding for interactive programs --
especially if the menu consists of many values!
The benefit of bringing this loop to Perl is that it obviates the
need for future programmers
to reinvent the I<Choose-From-A-Menu> wheel.
=head1 SYNOPSIS
=for comment
Resist temptation to add more spaces in line below; they cause bad wrapping for text-only document version
=for comment
The damn CPAN html renderer, which doesn't respond to
=for html or =for HTML directives (!), can't get the following
right! It's showing the B<> codes! Postscript and text work fine.
B<select>
[ [ my | local | our ] scalar_var ]
B<(> [LIST] B<)>
B<{> [CODE] B<}>
select [ [my|local|our] scalar_var ] ( [LIST] ) { [CODE] }
In the above, the enclosing square brackets I<(not typed)> identify optional elements, and vertical bars separate mutually-exclusive choices:
The required elements are the keyword C<select>,
the I<parentheses>, and the I<curly braces>.
See L<"SYNTAX"> for details.
=head1 ELEMENTARY EXAMPLES
NOTE: All non-trivial programming examples shown in this document are
distributed with this module, in the B<Scripts> directory.
L<"ADDITIONAL EXAMPLES">, covering more features, are shown below.
=head2 ship2me.plx
use Shell::POSIX::Select;
select $shipper ( 'UPS', 'FedEx' ) {
print "\nYou chose: $shipper\n";
last;
}
ship ($shipper, $ARGV[0]); # prints confirmation message
B<Screen>
ship2me.plx '42 hemp toothbrushes' # program invocation
1) UPS 2) FedEx
Enter number of choice: 2
You chose: FedEx
Your order has been processed. Thanks for your business!
=head2 ship2me2.plx
This variation on the preceding example shows how to use a custom menu-heading and interactive prompt.
It also presents all menus in one column.
use Shell::POSIX::Select qw($Heading $Prompt $MaxColumns);
$Heading = 'Select a Shipper' ;
$Prompt = 'Enter Vendor Number: ' ;
$MaxColumns = 1;
select $shipper ( 'UPS', 'FedEx' ) {
print "\nYou chose: $shipper\n";
last;
}
ship ($shipper, $ARGV[0]); # prints confirmation message
B<Screen>
ship2me2.plx '42 hemp toothbrushes'
Select a Shipper
1) UPS 2) FedEx
Enter Vendor Number: 2
You chose: FedEx
Your order has been processed. Thanks for your business!
=head1 SYNTAX
=head2 Loop Structure
Supported invocation formats include the following:
use Shell::POSIX::Select ;
select () { } # Form 0
select () { CODE } # Form 1
select (LIST) { CODE } # Form 2
select $var (LIST) { CODE } # Form 3
select my $var (LIST) { CODE } # Form 4
select our $var (LIST) { CODE } # Form 5
select local $var (LIST) { CODE } # Form 6
If the loop variable is omitted (as in I<Forms> I<0>, I<1> and I<2> above),
it defaults to C<$_>, C<local>ized to the loop's scope.
If the LIST is omitted (as in I<Forms> I<0> and I<1>),
C<@ARGV> is used by default, unless the loop occurs within a subroutine, in which case
C<@_> is used instead.
If CODE is omitted (as in I<Form> I<0>,
it defaults to a statement that B<prints> the loop variable.
The cases shown above are merely examples; all reasonable permutations are permitted, including:
select $var ( ) { CODE }
select local $var (LIST) { }
The only form that's I<not> allowed is one that specifies the loop-variable's declarator without naming the loop variable, as in:
select our () { } # WRONG! Must name variable with declarator!
=head2 The Loop variable
See L<"SCOPING ISSUES"> for full details about the implications
of different types of declarations for the loop variable.
=head2 The $Reply Variable
When the interactive user responds to the C<select> loop's prompt
with a valid input (i.e., a number in the correct range),
the variable C<$Reply> is set within the loop to that number.
Of course, the actual item selected is usually of great interest than
its number in the menu, but there are cases in which access to this
number is useful (see L<"menu_ls.plx"> for an example).
=head1 OVERVIEW
This loop is syntactically similar to Perl's
C<foreach> loop, and functionally related, so we'll describe it in those terms.
foreach $var ( LIST ) { CODE }
The job of C<foreach> is to run one iteration of CODE for each LIST-item,
with the current item's value placed in C<local>ized C<$var>
(or if the variable is missing, C<local>ized C<$_>).
select $var ( LIST ) { CODE }
In contrast, the C<select> loop displays a numbered menu of
LIST-items on the screen, prompts for (numerical) input, and then runs an iteration
with C<$var> being set that number's LIST-item.
In other words, C<select> is like an interactive, multiple-choice version of a
C<foreach> loop.
And that's cool! What's I<not> so cool is that
C<select> is also the I<only> UNIX shell loop that's been left out of
the Perl language. I<Until now!>
This module implements the C<select> loop of the Korn and Bash
("POSIX") shells for Perl.
It accomplishes this through Filter::Simple's I<Source Code Filtering> service,
allowing the programmer to blithely proceed as if this control feature existed natively in Perl.
The Bash and Korn shells differ slightly in their handling
of C<select> loops, primarily with respect to the layout of the on-screen menu.
This implementation currently follows the Korn shell version most closely
(but see L<"TODO-LIST"> for notes on planned enhancements).
=head1 ENHANCEMENTS
Although the shell doesn't allow the loop variable to be omitted,
for compliance with Perlish expectations,
the C<select> loop uses C<local>ized C<$_> by default
(as does the native C<foreach> loop). See L<"SYNTAX"> for details.
The interface and behavior of the Shell versions has been retained
where deemed desirable,
and sensibly modified along Perlish lines elsewhere.
Accordingly, the (primary) default LIST is B<@ARGV> (paralleling the Shell's B<"$@">),
menu prompts can be customized by having the script import and set B<$Prompt>
(paralleling the Shell's B<$PS3>),
and the user's response to the prompt appears in the
variable B<$Reply> (paralleling the Shell's B<$REPLY>),
C<local>ized to the loop.
A deficiency of the shell implementation is the
inability of the user to provide a I<heading> for each C<select> menu.
Sure, the
shell programmer can B<echo> a heading before the loop is entered and the
menu is displayed, but that approach doesn't help when an I<Outer loop> is
reentered on departure from an I<Inner loop>,
because the B<echo> preceding the I<Outer loop> won't be re-executed.
A similar deficiency surrounds the handling of a custom prompt string, and
the need to automatically display it on moving from an inner loop
to an outer one.
To address these deficiencies, this implementation provides the option of having a heading and prompt bound
to each C<select> loop. See L<"IMPORTS AND OPTIONS"> for details.
Headings and prompts are displayed in reverse video on the terminal,
if possible, to make them more visually distinct.
Some shell versions simply ignore bad input,
such as the entry of a number outside the menu's valid range,
or alphabetic input. I can't imagine any argument
in favor of this behavior being desirable when input is coming from a terminal,
so this implementation gives clear warning messages for such cases by default
(see L<"Warnings"> for details).
After a menu's initial prompt is issued, some shell versions don't
show it again unless the user enters an empty line.
This is desirable in cases where the menu is sufficiently large as to
cause preceding output to scroll off the screen, and undesirable otherwise.
Accordingly, an option is provided to enable or disable automatic prompting
(see L<"Prompts">).
This implementation always issues a fresh prompt
when a terminal user submits EOF as input to a nested C<select> loop.
In such cases, experience shows it's critical to reissue the
menu of the outer loop before accepting any more input.
=head1 SCOPING ISSUES
If the loop variable is named and provided with a I<declarator> (C<my>, C<our>, or C<local>),
the variable is scoped within the loop using that type of declaration.
But if the variable is named but lacks a declarator,
no declaration is applied to the variable.
This allows, for example,
a variable declared as private I<above the loop> to be accessible
from within the loop, and beyond it,
and one declared as private I<for the loop> to be confined to it:
select my $loopvar ( ) { }
print "$loopvar DOES NOT RETAIN last value from loop here\n";
-------------------------------------------------------------
my $loopvar;
select $loopvar ( ) { }
print "$loopvar RETAINS last value from loop here\n";
With this design,
C<select> behaves differently than the
native C<foreach> loop, which nowadays employs automatic
localization.
foreach $othervar ( ) { } # variable localized automatically
print "$othervar DOES NOT RETAIN last value from loop here\n";
select $othervar ( ) { } # variable in scope, or global
print "$othervar RETAINS last value from loop here\n";
This difference in the treatment of variables is intentional, and appropriate.
That's because the whole point of C<select>
is to let the user choose a value from a list, so it's often
critically important to be able to see, even outside the loop,
the value assigned to the loop variable.
In contrast, it's usually considered undesirable and unnecessary
for the value of the
C<foreach> loop's variable to be visible outside the loop, because
in most cases it will simply be that of the last element in the list.
Of course, in situations where the
C<foreach>-like behavior of implicit C<local>ization is desired,
the programmer has the option of declaring the C<select> loop's
variable as C<local>.
Another deficiency of the Shell versions is that it's difficult for the
programmer to differentiate between a
C<select> loop being exited via C<last>,
versus the loop detecting EOF on input.
To correct this situation,
the variable C<$Eof> can be imported and checked for a I<TRUE> value
upon exit from a C<select> loop (see L<"Eof Detection">).
=head1 IMPORTS AND OPTIONS
=head2 Syntax
use Shell::POSIX::Select (
'$Prompt', # to customize per-menu prompt
'$Heading', # to customize per-menu heading
'$MaxColumns', # to limit visual number of columns of choices
'$Eof', # T/F for Eof detection
# Variables must come first, then key/value options
prompt => 'Enter number of choice:', # or 'whatever:'
style => 'Bash', # or 'Korn'
warnings => 1, # or 0
debug => 0, # or 1-5
logging => 0, # or 1
testmode => <unset>, # or 'make', or 'foreach'
);
I<NOTE:> The values shown for options are the defaults, except for C<testmode>, which doesn't have one.
=head2 Prompts
There are two ways to customize the prompt used to solicit choices from
C<select> menus; through use of the prompt I<option>, which applies to
all loops, or the C<$Prompt> variable, which can be set independently for
each loop.
=head3 The prompt option
The C<prompt> option is intended for use in
programs that either contain a single C<select> loop, or are
content to use the same prompt for every loop.
It allows a custom interactive prompt to be set in the B<use> statement.
The prompt string should not end in a whitespace character, because
that doesn't look nice when the prompt is highlighted for display
(usually in I<reverse video>).
To offset the cursor from the prompt's end,
I<one space> is inserted automatically
after display highlighting has been turned off.
If the environment variable C<$ENV{Shell_POSIX_Select_prompt}>
is present,
its value overrides the one in the B<use> statement.
The default prompt is "Enter number of choice:".
To get the same prompt as provided by the Korn or Bash shell,
use C<< prompt =>> Korn >> or C<< prompt => Bash >>.
=head3 The $Prompt variable
The programmer may also modify the prompt during execution,
which may be desirable with nested loops that require different user instructions.
This is accomplished by
importing the $Prompt variable, and setting it to the desired prompt string
before entering the loop. Note that imported variables have to be listed
as the initial arguments to the C<use> directive, and properly quoted.
See L<"order.plx"> for an example.
NOTE: If the program's input channel is not connected to a terminal,
prompting is automatically disabled
(since there's no point in soliciting input from a I<pipe>!).
=head2 $Heading
The programmer has the option of binding a heading to each loop's menu,
by importing C<$Heading> and setting it just before entering the associated loop.
See L<"order.plx"> for an example.
=head2 $Eof
A common concern with the Shell's C<select> loop is distinguishing between
cases where a loop ends due to EOF detection, versus the execution of C<break>
(like Perl's C<last>).
Although the Shell programmer can check the C<$REPLY> variable to make
this distinction, this implementation localizes its version of that variable
(C<$Reply>) to the loop,
obviating that possibility.
Therefore, to make EOF detection as convenient and easy as possible,
the programmer may import C<$Eof> and check it for a
I<TRUE> value after a C<select> loop.
See L<"lc_filename.plx"> for a programming example.
=head2 Number of Columns
By default, the visual length of each option is examined,
and the list is spread across as many columns as will reasonably fit in the terminal.
You can override this behavior by importing and setting C<$MaxColumns>
to the maximum number of columns you wish to display.
See Scripts/max_columns_1.plx in the distribution as an example.
=head2 Styles
The C<style> options I<Korn> and I<Bash> can be used to request a more Kornish or Bashlike style of behavior.
Currently, the only difference is that the former disables, and the latter enables,
prompting for every input. A value can be
provided for the C<style> option
using an argument of the form C<< style => 'Korn' >> to the C<use> directive.
The default setting is C<Bash>.
If the environment variable C<$ENV{Shell_POSIX_Select_style}> is
set to C<Korn> or C<Bash>,
its value overrides the one provided with the B<use> statement.
=head2 Warnings
The C<warnings> option,
whose values range from C<0> to C<1>, enables informational messages meant to help
the interactive user provide correct inputs.
The default setting is C<1>, which provides warnings about incorrect
responses to menu prompts
(I<non-numeric>, I<out of range>, etc.).
Level C<0> turns these off.
If the environment variable C<$ENV{Shell_POSIX_Select_warnings}> is
present, its value takes precedence.
=head2 Logging
The C<logging> option, whose value ranges from C<0> to C<1>,
causes informational messages and source code to be saved in temporary files
(primarily for debugging purposes).
The default setting is C<0>, which disables logging.
If the environment variable C<$ENV{Shell_POSIX_Select_logging}> is
present, its value takes precedence.
=head2 Debug
The C<debug> option,
whose values range from C<0> to C<9>, enables informational messages
to aid in identifying bugs.
If the environment variable C<$ENV{Shell_POSIX_Select_debug}> is
present, and set to one of the acceptable values, it takes precedence.
This option is primarly intended for the author's use, but
users who find bugs may want to enable it and email the output to
L<"AUTHOR">. But before concluding that the problem is truly a bug
in this module, please confirm that the program runs correctly with the option
C<< testmode => foreach >> enabled (see L<"Testmode">).
=head2 Testmode
The C<testmode> option, whose values are 'make' and 'foreach',
changes the way the program is executed. The 'make' option is used
during the module's installation, and causes the program to dump
the modified source code and screen display to files,
and then stop (rather than interacting with the user).
If the environment variable C<$ENV{Shell_POSIX_Select_testmode}> is
present, and set to one of the acceptable values, it takes precedence.
With the C<foreach> option enabled, the program simply translates occurrences
of C<select> into C<foreach>, which provides a useful method for
checking that the program is syntactically correct before any serious
filtering has been applied (which can introduce syntax errors).
This works because the two loops, in their I<full forms>, have identical syntax.
Note that before you use C<< testmode => foreach >>, you I<must> fill in any
missing parts that are required by C<foreach>.
For instance,
C< select () {}>
must be rewritten as follows, to explicitly show "@ARGV" (assuming it's not in a subroutine) and "print":
C< foreach (@ARGV) { print; }>
=head1 ADDITIONAL EXAMPLES
NOTE: All non-trivial programming examples shown in this document are
distributed with this module, in the B<Scripts> directory.
See L<"ELEMENTARY EXAMPLES">
for simpler uses of C<select>.
=head2 pick_file.plx
This program lets the user choose filenames to be sent to the output.
It's sort of like an
interactive Perl C<grep> function, with a live user providing the
filtering service.
As illustrated below,
it could be used with Shell command substitution to provide selected arguments to a command.
use Shell::POSIX::Select (
prompt => 'Pick File(s):' ,
style => 'Korn' # for automatic prompting
);
select ( <*> ) { }
B<Screen>
lp `pick_file`> # Using UNIX-like OS
1) memo1.txt 2) memo2.txt 3) memo3.txt
4) junk1.txt 5) junk2.txt 6) junk3.txt
Pick File(s): 4
Pick File(s): 2
Pick File(s): ^D
request id is yumpy@guru+587
=head2 browse_images.plx
Here's a simple yet highly useful script. It displays a menu of all
the image files in the current directory, and then displays the chosen
ones on-screen using a backgrounded image viewer.
It uses Perl's C<grep> to filter-out filenames that don't
end in the desired extensions.
use Shell::POSIX::Select ;
$viewer='xv'; # Popular image viewer
select ( grep /\.(jpg|gif|tif|png)$/i, <*> ) {
system "$viewer $_ &" ; # run viewer in background
}
=head2 perl_man.plx
Back in the olden days, we only had one Perl man-page. It was
voluminous, but at least you knew what argument to give the B<man>
command to get the documentaton.
Now we have over a hundred Perl man pages, with unpredictable names
that are difficult to remember. Here's the program I use that
allows me to select the man-page of interest from a menu.
use Shell::POSIX::Select ;
# Extract man-page names from the TOC portion of the output of "perldoc perl"
select $manpage ( sort ( `perldoc perl` =~ /^\s+(perl\w+)\s/mg) ) {
system "perldoc $manpage" ;
}
B<Screen>
1) perl5004delta 2) perl5005delta 3) perl561delta
4) perl56delta 5) perl570delta 6) perl571delta
. . .
I<(This large menu spans multiple screens, but all parts can be accessed
using your normal terminal scrolling facility.)>
Enter number of choice: 6
PERL571DELTA(1) Perl Programmers Reference Guide
NAME
perl571delta - what's new for perl v5.7.1
DESCRIPTION
This document describes differences between the 5.7.0
release and the 5.7.1 release.
. . .
=head2 pick.plx
This more general C<pick>-ing program lets the user make selections
from I<arguments>, if they're present, or else I<input>, in the spirit of Perl's
C<-n> invocation option and C<< <> >> input operator.
use Shell::POSIX::Select ;
BEGIN {
if (@ARGV) {
@choices=@ARGV ;
}
else { # if no args, get choices from input
@choices=<STDIN> or die "$0: No data\n";
chomp @choices ;
# STDIN already returned EOF, so must reopen
# for terminal before menu interaction
open STDIN, "/dev/tty" or
die "$0: Failed to open STDIN, $!" ; # UNIX example
}
}
select ( @choices ) { } # prints selections to output
B<Sample invocations (UNIX-like system)>
lp `pick *.txt` # same output as shown for "pick_file"
find . -name '*.plx' -print | pick | xargs lp # includes sub-dirs
who |
awk '{ print $1 }' | # isolate user names
pick | # select user names
Mail -s 'Promote these people!' boss
=head2 delete_file.plx
In this program, the user selects a filename
to be deleted. The outer loop is used to refresh the list,
so the file deleted on the previous iteration gets removed from the next menu.
The outer loop is I<labeled> (as C<OUTER>), so that the inner loop can refer to it when
necessary.
use Shell::POSIX::Select (
'$Eof', # for ^D detection
prompt=>'Choose file for deletion:'
) ;
OUTER:
while ( @files=<*.py> ) { # collect serpentine files
select ( @files ) { # prompt for deletions
print STDERR "Really delete $_? [y/n]: " ;
my $answer = <STDIN> ; # ^D sets $Eof below
defined $answer or last OUTER ; # exit on ^D
$answer eq "y\n" and unlink and last ;
}
$Eof and last;
}
=head2 lc_filename.plx
This example shows the benefit of importing C<$Eof>,
so the outer loop can be exited when the user supplies
C<^D> to the inner one.
Here's how it works.
If the rename succeeds in the inner loop, execution
of C<last> breaks out of the C<select> loop;
$Eof will then be evaluated as I<FALSE>, and
the C<while> loop will start a new C<select> loop,
with a (depleted) filename menu. But if the user
presses C<^D> to the menu prompt, C<$Eof> will test
as I<TRUE>, triggering the exit from the C<while> loop.
use Shell::POSIX::Select (
'$Eof' ,
prompt => 'Enter number (^D to exit):'
style => 'Korn' # for automatic prompting
);
# Rename selected files from current dir to lowercase
while ( @files=<*[A-Z]*> ) { # refreshes select's menu
select ( @files ) { # skip fully lower-case names
if (rename $_, "\L$_") {
last ;
}
else {
warn "$0: rename failed for $_: $!\n";
}
}
$Eof and last ; # Handle ^D to menu prompt
}
B<Screen>
lc_filename.plx
1) Abe.memo 2) Zeke.memo
Enter number (^D to exit): 1
1) Zeke.memo
Enter number (^D to exit): ^D
=head2 order.plx
This program sets a custom prompt and heading for each of
its two loops, and shows the use of a label on the outer loop.
use Shell::POSIX::Select qw($Prompt $Heading);
$Heading="\n\nQuantity Menu:";
$Prompt="Choose Quantity:";
OUTER:
select my $quantity (1..4) {
$Heading="\nSize Menu:" ;
$Prompt='Choose Size:' ;
select my $size ( qw (L XL) ) {
print "You chose $quantity units of size $size\n" ;
last OUTER ; # Order is complete
}
}
B<Screen>
order.plx
Quantity Menu:
1) 1 2) 2 3) 3 4) 4
Choose Quantity: 4
Size Menu:
1) L 2) XL
Choose Size: ^D (changed my mind about the quantity)
Quantity Menu:
1) 1 2) 2 3) 3 4) 4
Choose Quantity: 2
Size Menu:
1) L 2) XL
Choose Size: 2
You chose 2 units of size XL
=head2 browse_records.plx
This program shows how you can implement a "record browser",
that builds a menu from the designated field of each record, and then
shows the record associated with the selected field.
To use a familiar
example, we'll browse the UNIX password file by user-name.
use Shell::POSIX::Select ( style => 'Korn' );
if (@ARGV != 2 and @ARGV != 3) {
die "Usage: $0 fieldnum filename [delimiter]" ;
}
# Could also use Getopt:* module for option parsing
( $field, $file, $delim) = @ARGV ;
if ( ! defined $delim ) {
$delim='[\040\t]+' # SP/TAB sequences
}
$field-- ; # 2->1, 1->0, etc., for 0-based indexing
foreach ( `cat "$file"` ) {
# field is the key in the hash, value is entire record
$f2r{ (split /$delim/, $_)[ $field ] } = $_ ;
}
# Show specified fields in menu, and display associated records
select $record ( sort keys %f2r ) {
print "$f2r{$record}\n" ;
}
B<Screen>
browsrec.plx '1' /etc/passwd ':'
1) at 2) bin 3) contix 4) daemon 5) ftp 6) games
7) lp 8) mail 9) man 10) named 11) news 12) nobody
13) pop 14) postfix 15) root 16) spug 17) sshd 18) tim
Enter number of choice: 18
tim:x:213:100:Tim Maher:/home/tim:/bin/bash
Enter number of choice: ^D
=head2 menu_ls.plx
This program shows a prototype for a menu-oriented front end
to a UNIX command, that prompts the user for command-option choices,
assembles the requested command, and then runs it.
It employs the user's numeric choice,
stored in the C<$Reply> variable, to extract from an array the command
option associated with each option description.
use Shell::POSIX::Select qw($Heading $Prompt $Eof) ;
# following avoids used-only once warning
my ($type, $format) ;
# Would be more Perlish to associate choices with options
# via a Hash, but this approach demonstrates $Reply variable
@formats = ( 'regular', 'long' ) ;
@fmt_opt = ( '', '-l' ) ;
@types = ( 'only non-hidden', 'all files' ) ;
@typ_opt = ( '', '-a' , ) ;
print "** LS-Command Composer **\n\n" ;
$Heading="\n**** Style Menu ****" ;
$Prompt= "Choose listing style:" ;
OUTER:
select $format ( @formats ) {
$user_format=$fmt_opt[ $Reply - 1 ] ;
$Heading="\n**** File Menu ****" ;
$Prompt="Choose files to list:" ;
select $type ( @types ) { # ^D restarts OUTER
$user_type=$typ_opt[ $Reply - 1 ] ;
last OUTER ; # leave loops once final choice obtained
}
}
$Eof and exit ; # handle ^D to OUTER
# Now construct user's command
$command="ls $user_format $user_type" ;
# Show command, for educational value
warn "\nPress <ENTER> to execute \"$command\"\n" ;
# Now wait for input, then run command
defined <> or print "\n" and exit ;
system $command ; # finally, run the command
B<Screen>
menu_ls.plx
** LS-Command Composer **
1) regular 2) long
Choose listing format: 2
1) only non-hidden 2) all files
Choose files to list: 2
Press <ENTER> to execute "ls -l -a" <ENTER>
total 13439
-rw-r--r-- 1 yumpy gurus 1083 Feb 4 15:41 README
-rw-rw-r-- 6 yumpy gurus 277 Dec 17 14:36 .exrc.mmkeys
-rw-rw-r-- 7 yumpy gurus 285 Jan 16 18:45 .exrc.podkeys
$
=head1 BUGS
=head2 UNIX Orientation
I've been a UNIX programmer since 1976, and a Linux proponent since
1992, so it's most natural for me to program for those platforms.
Accordingly, this early release has some minor features that are only
allowed, or perhaps only entirely functional, on UNIX-like systems.
I'm open to suggestions on how to implement some of these features in
a more portable manner.
Some of the programming examples are also
UNIX oriented, but it should be easy enough for those specializing on
other platforms to make the necessary adapations. 8-}
=head2 Terminal Display Modes
These have been tested under UNIX/Linux, and work as expected,
using B<tput>. When time permits, I'll convert to a portable
implementation that will support other OSs.
=head2 Incorrect Line Numbers in Warnings
Because this module inserts new source code into your program,
Perl messages that reference line numbers will refer to a
different source file than you wrote. For this reason,
only messages referring to lines before the first C<select>
loop in your program will be correct.
If you're on a UNIX-like system, by enabling the C<debugging>
and C<logging> options (see L<"Debug"> and L<"Logging">), you can
get an on-screen report of the proper offset to apply to interpret
the line numbers of the source code that gets dumped to the
F</tmp/SELECT_source> file. Of course, if everything works correctly,
you'll have little reason to look at the source. 8-}
=head2 Please Report Bugs!
This is a non-trivial program, that does some fairly complex parsing
and data munging,
so I'm sure there are some latent bugs awaiting your discovery.
Please share them with me, by emailing the offending code,
and/or the diagnostic messages enabled by the I<debug>
option setting (see L<"IMPORTS AND OPTIONS">).
=head1 TODO-LIST
=head2 More Shell-like Menus
In a future release, there could be options for
more accurately emulating Bash and Korn-style behavior,
if anybody cares (the main difference is in how the
items are ordered in the menus).
=head2 More Extensive Test Suite
More tests are needed, especially for the complex and tricky cases.
=head1 MODULE DEPENDENCIES
File::Spec::Functions
Text::Balanced
Filter::Simple
=head1 EXPORTS: Default
$Reply
This variable is C<local>ized to each C<select> loop,
and provides the menu-number of the most recent valid selection.
For an example of its use, see L<"menu_ls.plx">.
=head1 EXPORTS: Optional
$Heading
$Prompt
$MaxColumns
$Eof
See L<"IMPORTS AND OPTIONS"> for details.
=head1 SCRIPTS
browse_images
browse_jpeg
browse_records
delete_file
lc_filename
long_listem
menu_ls
order
perl_man
pick
pick_file
=head1 AUTHOR
Tim Maher
=head1 MAINTAINER
Martin Thurn
mthurn@cpan.org
=begin html
-
=end html
=begin HTML
+
=end HTML
=head1 ACKNOWLEDGEMENTS
I probably never would have even attempted to write this module
if it weren't for the provision of Filter::Simple by Damian Conway,
which I ruthlessly exploited to make a hard job easy.
I<The Damian> also gave useful tips
during the module's development, for which I'm grateful.
I I<definitely> wouldn't have ever written this module, if I hadn't
found myself writing a chapter on I<Looping> for my upcoming
B<Manning Publications> book,
and once again lamenting the fact that the most friendly Shell loop
was still missing from Perl.
So in a fit of zeal, I vowed to rectify that oversight!
I hope you find this module as useful as I do! 8-}
For more examples of how this loop can be used in Perl programs,
watch for my upcoming book, I<Minimal Perl: for Shell Users and Programmers>
(see
L<http://teachmeperl.com/mp4sh.html>) in early fall, 2003.
=head1 SEE ALSO
man ksh # on UNIX or UNIX-like systems
man bash # on UNIX or UNIX-like systems
=head1 DON'T SEE ALSO
B<perldoc -f select>, which has nothing to do with this module
(the names just happen to match up).
=head1 VERSION
This document describes version 0.08.
=head1 LICENSE
Copyright (C) 2002-2003, Timothy F. Maher. All rights reserved.
This module is free software;
you can redistribute it and/or modify it under the same terms as Perl itself.
=cut
# vi:ts=2 sw=2:
1;
# Tim Maher, tim@teachmeperl.com, yumpy@cpan.org
# Fri May 2 10:29:25 PDT 2003
# Mon May 5 10:51:49 PDT 2003
__END__
|