/usr/share/perl5/Text/CSV.pm is in libtext-csv-perl 1.95-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 | package Text::CSV;
use strict;
use Exporter;
use Carp ();
use vars qw( $VERSION $DEBUG @ISA @EXPORT_OK );
@ISA = qw( Exporter );
@EXPORT_OK = qw( csv );
BEGIN {
$VERSION = '1.95';
$DEBUG = 0;
}
# if use CSV_XS, requires version
my $Module_XS = 'Text::CSV_XS';
my $Module_PP = 'Text::CSV_PP';
my $XS_Version = '1.02';
my $Is_Dynamic = 0;
my @PublicMethods = qw/
version new error_diag error_input
known_attributes csv
PV IV NV
/;
#
# Check the environment variable to decide worker module.
unless ($Text::CSV::Worker) {
$Text::CSV::DEBUG and Carp::carp("Check used worker module...");
if ( exists $ENV{PERL_TEXT_CSV} ) {
if ($ENV{PERL_TEXT_CSV} eq '0' or $ENV{PERL_TEXT_CSV} eq 'Text::CSV_PP') {
_load_pp() or Carp::croak $@;
}
elsif ($ENV{PERL_TEXT_CSV} eq '1' or $ENV{PERL_TEXT_CSV} =~ /Text::CSV_XS\s*,\s*Text::CSV_PP/) {
_load_xs() or _load_pp() or Carp::croak $@;
}
elsif ($ENV{PERL_TEXT_CSV} eq '2' or $ENV{PERL_TEXT_CSV} eq 'Text::CSV_XS') {
_load_xs() or Carp::croak $@;
}
else {
Carp::croak "The value of environmental variable 'PERL_TEXT_CSV' is invalid.";
}
}
else {
_load_xs() or _load_pp() or Carp::croak $@;
}
}
sub new { # normal mode
my $proto = shift;
my $class = ref($proto) || $proto;
unless ( $proto ) { # for Text::CSV_XS/PP::new(0);
return eval qq| $Text::CSV::Worker\::new( \$proto ) |;
}
#if (ref $_[0] and $_[0]->{module}) {
# Carp::croak("Can't set 'module' in non dynamic mode.");
#}
if ( my $obj = $Text::CSV::Worker->new(@_) ) {
$obj->{_MODULE} = $Text::CSV::Worker;
bless $obj, $class;
return $obj;
}
else {
return;
}
}
sub require_xs_version { $XS_Version; }
sub module {
my $proto = shift;
return !ref($proto) ? $Text::CSV::Worker
: ref($proto->{_MODULE}) ? ref($proto->{_MODULE}) : $proto->{_MODULE};
}
*backend = *module;
sub is_xs {
return $_[0]->module eq $Module_XS;
}
sub is_pp {
return $_[0]->module eq $Module_PP;
}
sub is_dynamic { $Is_Dynamic; }
sub _load_xs { _load($Module_XS, $XS_Version) }
sub _load_pp { _load($Module_PP) }
sub _load {
my ($module, $version) = @_;
$version ||= '';
$Text::CSV::DEBUG and Carp::carp "Load $module.";
eval qq| use $module $version |;
return if $@;
push @Text::CSV::ISA, $module;
$Text::CSV::Worker = $module;
local $^W;
no strict qw(refs);
for my $method (@PublicMethods) {
*{"Text::CSV::$method"} = \&{"$module\::$method"};
}
return 1;
}
1;
__END__
=pod
=head1 NAME
Text::CSV - comma-separated values manipulator (using XS or PurePerl)
=head1 SYNOPSIS
use Text::CSV;
my @rows;
my $csv = Text::CSV->new ( { binary => 1 } ) # should set binary attribute.
or die "Cannot use CSV: ".Text::CSV->error_diag ();
open my $fh, "<:encoding(utf8)", "test.csv" or die "test.csv: $!";
while ( my $row = $csv->getline( $fh ) ) {
$row->[2] =~ m/pattern/ or next; # 3rd field should match
push @rows, $row;
}
$csv->eof or $csv->error_diag();
close $fh;
$csv->eol ("\r\n");
open $fh, ">:encoding(utf8)", "new.csv" or die "new.csv: $!";
$csv->print ($fh, $_) for @rows;
close $fh or die "new.csv: $!";
#
# parse and combine style
#
$status = $csv->combine(@columns); # combine columns into a string
$line = $csv->string(); # get the combined string
$status = $csv->parse($line); # parse a CSV string into fields
@columns = $csv->fields(); # get the parsed fields
$status = $csv->status (); # get the most recent status
$bad_argument = $csv->error_input (); # get the most recent bad argument
$diag = $csv->error_diag (); # if an error occurred, explains WHY
$status = $csv->print ($io, $colref); # Write an array of fields
# immediately to a file $io
$colref = $csv->getline ($io); # Read a line from file $io,
# parse it and return an array
# ref of fields
$csv->column_names (@names); # Set column names for getline_hr ()
$ref = $csv->getline_hr ($io); # getline (), but returns a hashref
$eof = $csv->eof (); # Indicate if last parse or
# getline () hit End Of File
$csv->types(\@t_array); # Set column types
=head1 DESCRIPTION
Text::CSV is a thin wrapper for L<Text::CSV_XS>-compatible modules now.
All the backend modules provide facilities for the composition and
decomposition of comma-separated values. Text::CSV uses Text::CSV_XS
by default, and when Text::CSV_XS is not available, falls back on
L<Text::CSV_PP>, which is bundled in the same distribution as this module.
=head1 CHOOSING BACKEND
This module respects an environmental variable called C<PERL_TEXT_CSV>
when it decides a backend module to use. If this environmental variable
is not set, it tries to load Text::CSV_XS, and if Text::CSV_XS is not
available, falls back on Text::CSV_PP;
If you always don't want it to fall back on Text::CSV_PP, set the variable
like this (C<export> may be C<setenv>, C<set> and the likes, depending
on your environment):
> export PERL_TEXT_CSV=Text::CSV_XS
If you prefer Text::CSV_XS to Text::CSV_PP (default), then:
> export PERL_TEXT_CSV=Text::CSV_XS,Text::CSV_PP
You may also want to set this variable at the top of your test files, in order
not to be bothered with incompatibilities between backends (you need to wrap
this in C<BEGIN>, and set before actually C<use>-ing Text::CSV module, as it
decides its backend as soon as it's loaded):
BEGIN { $ENV{PERL_TEXT_CSV}='Text::CSV_PP'; }
use Text::CSV;
=head1 NOTES
This section is taken from Text::CSV_XS.
=head2 Embedded newlines
B<Important Note>: The default behavior is to accept only ASCII characters
in the range from C<0x20> (space) to C<0x7E> (tilde). This means that the
fields can not contain newlines. If your data contains newlines embedded in
fields, or characters above C<0x7E> (tilde), or binary data, you B<I<must>>
set C<< binary => 1 >> in the call to L</new>. To cover the widest range of
parsing options, you will always want to set binary.
But you still have the problem that you have to pass a correct line to the
L</parse> method, which is more complicated from the usual point of usage:
my $csv = Text::CSV->new ({ binary => 1, eol => $/ });
while (<>) { # WRONG!
$csv->parse ($_);
my @fields = $csv->fields ();
}
this will break, as the C<while> might read broken lines: it does not care
about the quoting. If you need to support embedded newlines, the way to go
is to B<not> pass L<C<eol>|/eol> in the parser (it accepts C<\n>, C<\r>,
B<and> C<\r\n> by default) and then
my $csv = Text::CSV->new ({ binary => 1 });
open my $io, "<", $file or die "$file: $!";
while (my $row = $csv->getline ($io)) {
my @fields = @$row;
}
The old(er) way of using global file handles is still supported
while (my $row = $csv->getline (*ARGV)) { ... }
=head2 Unicode
Unicode is only tested to work with perl-5.8.2 and up.
The simplest way to ensure the correct encoding is used for in- and output
is by either setting layers on the filehandles, or setting the L</encoding>
argument for L</csv>.
open my $fh, "<:encoding(UTF-8)", "in.csv" or die "in.csv: $!";
or
my $aoa = csv (in => "in.csv", encoding => "UTF-8");
open my $fh, ">:encoding(UTF-8)", "out.csv" or die "out.csv: $!";
or
csv (in => $aoa, out => "out.csv", encoding => "UTF-8");
On parsing (both for L</getline> and L</parse>), if the source is marked
being UTF8, then all fields that are marked binary will also be marked UTF8.
On combining (L</print> and L</combine>): if any of the combining fields
was marked UTF8, the resulting string will be marked as UTF8. Note however
that all fields I<before> the first field marked UTF8 and contained 8-bit
characters that were not upgraded to UTF8, these will be C<bytes> in the
resulting string too, possibly causing unexpected errors. If you pass data
of different encoding, or you don't know if there is different encoding,
force it to be upgraded before you pass them on:
$csv->print ($fh, [ map { utf8::upgrade (my $x = $_); $x } @data ]);
For complete control over encoding, please use L<Text::CSV::Encoded>:
use Text::CSV::Encoded;
my $csv = Text::CSV::Encoded->new ({
encoding_in => "iso-8859-1", # the encoding comes into Perl
encoding_out => "cp1252", # the encoding comes out of Perl
});
$csv = Text::CSV::Encoded->new ({ encoding => "utf8" });
# combine () and print () accept *literally* utf8 encoded data
# parse () and getline () return *literally* utf8 encoded data
$csv = Text::CSV::Encoded->new ({ encoding => undef }); # default
# combine () and print () accept UTF8 marked data
# parse () and getline () return UTF8 marked data
=head1 METHODS
This whole section is also taken from Text::CSV_XS.
=head2 version ()
(Class method) Returns the current backend module version.
=head2 new (\%attr)
(Class method) Returns a new instance of Text::CSV backend. The attributes
are described by the (optional) hash ref C<\%attr>.
my $csv = Text::CSV->new ({ attributes ... });
The following attributes are available:
=head3 eol
my $csv = Text::CSV->new ({ eol => $/ });
$csv->eol (undef);
my $eol = $csv->eol;
The end-of-line string to add to rows for L</print> or the record separator
for L</getline>.
When not passed in a B<parser> instance, the default behavior is to accept
C<\n>, C<\r>, and C<\r\n>, so it is probably safer to not specify C<eol> at
all. Passing C<undef> or the empty string behave the same.
When not passed in a B<generating> instance, records are not terminated at
all, so it is probably wise to pass something you expect. A safe choice for
C<eol> on output is either C<$/> or C<\r\n>.
Common values for C<eol> are C<"\012"> (C<\n> or Line Feed), C<"\015\012">
(C<\r\n> or Carriage Return, Line Feed), and C<"\015"> (C<\r> or Carriage
Return). The L<C<eol>|/eol> attribute cannot exceed 7 (ASCII) characters.
If both C<$/> and L<C<eol>|/eol> equal C<"\015">, parsing lines that end on
only a Carriage Return without Line Feed, will be L</parse>d correct.
=head3 sep_char
my $csv = Text::CSV->new ({ sep_char => ";" });
$csv->sep_char (";");
my $c = $csv->sep_char;
The char used to separate fields, by default a comma. (C<,>). Limited to a
single-byte character, usually in the range from C<0x20> (space) to C<0x7E>
(tilde). When longer sequences are required, use L<C<sep>|/sep>.
The separation character can not be equal to the quote character or to the
escape character.
=head3 sep
my $csv = Text::CSV->new ({ sep => "\N{FULLWIDTH COMMA}" });
$csv->sep (";");
my $sep = $csv->sep;
The chars used to separate fields, by default undefined. Limited to 8 bytes.
When set, overrules L<C<sep_char>|/sep_char>. If its length is one byte it
acts as an alias to L<C<sep_char>|/sep_char>.
=head3 quote_char
my $csv = Text::CSV->new ({ quote_char => "'" });
$csv->quote_char (undef);
my $c = $csv->quote_char;
The character to quote fields containing blanks or binary data, by default
the double quote character (C<">). A value of undef suppresses quote chars
(for simple cases only). Limited to a single-byte character, usually in the
range from C<0x20> (space) to C<0x7E> (tilde). When longer sequences are
required, use L<C<quote>|/quote>.
C<quote_char> can not be equal to L<C<sep_char>|/sep_char>.
=head3 quote
my $csv = Text::CSV->new ({ quote => "\N{FULLWIDTH QUOTATION MARK}" });
$csv->quote ("'");
my $quote = $csv->quote;
The chars used to quote fields, by default undefined. Limited to 8 bytes.
When set, overrules L<C<quote_char>|/quote_char>. If its length is one byte
it acts as an alias to L<C<quote_char>|/quote_char>.
=head3 escape_char
my $csv = Text::CSV->new ({ escape_char => "\\" });
$csv->escape_char (undef);
my $c = $csv->escape_char;
The character to escape certain characters inside quoted fields. This is
limited to a single-byte character, usually in the range from C<0x20>
(space) to C<0x7E> (tilde).
The C<escape_char> defaults to being the double-quote mark (C<">). In other
words the same as the default L<C<quote_char>|/quote_char>. This means that
doubling the quote mark in a field escapes it:
"foo","bar","Escape ""quote mark"" with two ""quote marks""","baz"
If you change the L<C<quote_char>|/quote_char> without changing the
C<escape_char>, the C<escape_char> will still be the double-quote (C<">).
If instead you want to escape the L<C<quote_char>|/quote_char> by doubling
it you will need to also change the C<escape_char> to be the same as what
you have changed the L<C<quote_char>|/quote_char> to.
The escape character can not be equal to the separation character.
=head3 binary
my $csv = Text::CSV->new ({ binary => 1 });
$csv->binary (0);
my $f = $csv->binary;
If this attribute is C<1>, you may use binary characters in quoted fields,
including line feeds, carriage returns and C<NULL> bytes. (The latter could
be escaped as C<"0>.) By default this feature is off.
If a string is marked UTF8, C<binary> will be turned on automatically when
binary characters other than C<CR> and C<NL> are encountered. Note that a
simple string like C<"\x{00a0}"> might still be binary, but not marked UTF8,
so setting C<< { binary => 1 } >> is still a wise option.
=head3 decode_utf8
my $csv = Text::CSV->new ({ decode_utf8 => 1 });
$csv->decode_utf8 (0);
my $f = $csv->decode_utf8;
This attributes defaults to TRUE.
While I<parsing>, fields that are valid UTF-8, are automatically set to be
UTF-8, so that
$csv->parse ("\xC4\xA8\n");
results in
PV("\304\250"\0) [UTF8 "\x{128}"]
Sometimes it might not be a desired action. To prevent those upgrades, set
this attribute to false, and the result will be
PV("\304\250"\0)
=head3 auto_diag
my $csv = Text::CSV->new ({ auto_diag => 1 });
$csv->auto_diag (2);
my $l = $csv->auto_diag;
Set this attribute to a number between C<1> and C<9> causes L</error_diag>
to be automatically called in void context upon errors.
In case of error C<2012 - EOF>, this call will be void.
If C<auto_diag> is set to a numeric value greater than C<1>, it will C<die>
on errors instead of C<warn>. If set to anything unrecognized, it will be
silently ignored.
Future extensions to this feature will include more reliable auto-detection
of C<autodie> being active in the scope of which the error occurred which
will increment the value of C<auto_diag> with C<1> the moment the error is
detected.
=head3 diag_verbose
my $csv = Text::CSV->new ({ diag_verbose => 1 });
$csv->diag_verbose (2);
my $l = $csv->diag_verbose;
Set the verbosity of the output triggered by C<auto_diag>. Currently only
adds the current input-record-number (if known) to the diagnostic output
with an indication of the position of the error.
=head3 blank_is_undef
my $csv = Text::CSV->new ({ blank_is_undef => 1 });
$csv->blank_is_undef (0);
my $f = $csv->blank_is_undef;
Under normal circumstances, C<CSV> data makes no distinction between quoted-
and unquoted empty fields. These both end up in an empty string field once
read, thus
1,"",," ",2
is read as
("1", "", "", " ", "2")
When I<writing> C<CSV> files with either L<C<always_quote>|/always_quote>
or L<C<quote_empty>|/quote_empty> set, the unquoted I<empty> field is the
result of an undefined value. To enable this distinction when I<reading>
C<CSV> data, the C<blank_is_undef> attribute will cause unquoted empty
fields to be set to C<undef>, causing the above to be parsed as
("1", "", undef, " ", "2")
note that this is specifically important when loading C<CSV> fields into a
database that allows C<NULL> values, as the perl equivalent for C<NULL> is
C<undef> in L<DBI> land.
=head3 empty_is_undef
my $csv = Text::CSV->new ({ empty_is_undef => 1 });
$csv->empty_is_undef (0);
my $f = $csv->empty_is_undef;
Going one step further than L<C<blank_is_undef>|/blank_is_undef>, this
attribute converts all empty fields to C<undef>, so
1,"",," ",2
is read as
(1, undef, undef, " ", 2)
Note that this effects only fields that are originally empty, not fields
that are empty after stripping allowed whitespace. YMMV.
=head3 allow_whitespace
my $csv = Text::CSV->new ({ allow_whitespace => 1 });
$csv->allow_whitespace (0);
my $f = $csv->allow_whitespace;
When this option is set to true, the whitespace (C<TAB>'s and C<SPACE>'s)
surrounding the separation character is removed when parsing. If either
C<TAB> or C<SPACE> is one of the three characters L<C<sep_char>|/sep_char>,
L<C<quote_char>|/quote_char>, or L<C<escape_char>|/escape_char> it will not
be considered whitespace.
Now lines like:
1 , "foo" , bar , 3 , zapp
are parsed as valid C<CSV>, even though it violates the C<CSV> specs.
Note that B<all> whitespace is stripped from both start and end of each
field. That would make it I<more> than a I<feature> to enable parsing bad
C<CSV> lines, as
1, 2.0, 3, ape , monkey
will now be parsed as
("1", "2.0", "3", "ape", "monkey")
even if the original line was perfectly acceptable C<CSV>.
=head3 allow_loose_quotes
my $csv = Text::CSV->new ({ allow_loose_quotes => 1 });
$csv->allow_loose_quotes (0);
my $f = $csv->allow_loose_quotes;
By default, parsing unquoted fields containing L<C<quote_char>|/quote_char>
characters like
1,foo "bar" baz,42
would result in parse error 2034. Though it is still bad practice to allow
this format, we cannot help the fact that some vendors make their
applications spit out lines styled this way.
If there is B<really> bad C<CSV> data, like
1,"foo "bar" baz",42
or
1,""foo bar baz"",42
there is a way to get this data-line parsed and leave the quotes inside the
quoted field as-is. This can be achieved by setting C<allow_loose_quotes>
B<AND> making sure that the L<C<escape_char>|/escape_char> is I<not> equal
to L<C<quote_char>|/quote_char>.
=head3 allow_loose_escapes
my $csv = Text::CSV->new ({ allow_loose_escapes => 1 });
$csv->allow_loose_escapes (0);
my $f = $csv->allow_loose_escapes;
Parsing fields that have L<C<escape_char>|/escape_char> characters that
escape characters that do not need to be escaped, like:
my $csv = Text::CSV->new ({ escape_char => "\\" });
$csv->parse (qq{1,"my bar\'s",baz,42});
would result in parse error 2025. Though it is bad practice to allow this
format, this attribute enables you to treat all escape character sequences
equal.
=head3 allow_unquoted_escape
my $csv = Text::CSV->new ({ allow_unquoted_escape => 1 });
$csv->allow_unquoted_escape (0);
my $f = $csv->allow_unquoted_escape;
A backward compatibility issue where L<C<escape_char>|/escape_char> differs
from L<C<quote_char>|/quote_char> prevents L<C<escape_char>|/escape_char>
to be in the first position of a field. If L<C<quote_char>|/quote_char> is
equal to the default C<"> and L<C<escape_char>|/escape_char> is set to C<\>,
this would be illegal:
1,\0,2
Setting this attribute to C<1> might help to overcome issues with backward
compatibility and allow this style.
=head3 always_quote
my $csv = Text::CSV->new ({ always_quote => 1 });
$csv->always_quote (0);
my $f = $csv->always_quote;
By default the generated fields are quoted only if they I<need> to be. For
example, if they contain the separator character. If you set this attribute
to C<1> then I<all> defined fields will be quoted. (C<undef> fields are not
quoted, see L</blank_is_undef>). This makes it quite often easier to handle
exported data in external applications.
=head3 quote_space
my $csv = Text::CSV->new ({ quote_space => 1 });
$csv->quote_space (0);
my $f = $csv->quote_space;
By default, a space in a field would trigger quotation. As no rule exists
this to be forced in C<CSV>, nor any for the opposite, the default is true
for safety. You can exclude the space from this trigger by setting this
attribute to 0.
=head3 quote_empty
my $csv = Text::CSV->new ({ quote_empty => 1 });
$csv->quote_empty (0);
my $f = $csv->quote_empty;
By default the generated fields are quoted only if they I<need> to be. An
empty (defined) field does not need quotation. If you set this attribute to
C<1> then I<empty> defined fields will be quoted. (C<undef> fields are not
quoted, see L</blank_is_undef>). See also L<C<always_quote>|/always_quote>.
=head3 quote_binary
my $csv = Text::CSV->new ({ quote_binary => 1 });
$csv->quote_binary (0);
my $f = $csv->quote_binary;
By default, all "unsafe" bytes inside a string cause the combined field to
be quoted. By setting this attribute to C<0>, you can disable that trigger
for bytes >= C<0x7F>.
=head3 escape_null or quote_null (deprecated)
my $csv = Text::CSV->new ({ escape_null => 1 });
$csv->escape_null (0);
my $f = $csv->escape_null;
By default, a C<NULL> byte in a field would be escaped. This option enables
you to treat the C<NULL> byte as a simple binary character in binary mode
(the C<< { binary => 1 } >> is set). The default is true. You can prevent
C<NULL> escapes by setting this attribute to C<0>.
The default when using the C<csv> function is C<false>.
=head3 keep_meta_info
my $csv = Text::CSV->new ({ keep_meta_info => 1 });
$csv->keep_meta_info (0);
my $f = $csv->keep_meta_info;
By default, the parsing of input records is as simple and fast as possible.
However, some parsing information - like quotation of the original field -
is lost in that process. Setting this flag to true enables retrieving that
information after parsing with the methods L</meta_info>, L</is_quoted>,
and L</is_binary> described below. Default is false for performance.
If you set this attribute to a value greater than 9, than you can control
output quotation style like it was used in the input of the the last parsed
record (unless quotation was added because of other reasons).
my $csv = Text::CSV->new ({
binary => 1,
keep_meta_info => 1,
quote_space => 0,
});
my $row = $csv->parse (q{1,,"", ," ",f,"g","h""h",help,"help"});
$csv->print (*STDOUT, \@row);
# 1,,, , ,f,g,"h""h",help,help
$csv->keep_meta_info (11);
$csv->print (*STDOUT, \@row);
# 1,,"", ," ",f,"g","h""h",help,"help"
=head3 verbatim
my $csv = Text::CSV->new ({ verbatim => 1 });
$csv->verbatim (0);
my $f = $csv->verbatim;
This is a quite controversial attribute to set, but makes some hard things
possible.
The rationale behind this attribute is to tell the parser that the normally
special characters newline (C<NL>) and Carriage Return (C<CR>) will not be
special when this flag is set, and be dealt with as being ordinary binary
characters. This will ease working with data with embedded newlines.
When C<verbatim> is used with L</getline>, L</getline> auto-C<chomp>'s
every line.
Imagine a file format like
M^^Hans^Janssen^Klas 2\n2A^Ja^11-06-2007#\r\n
where, the line ending is a very specific C<"#\r\n">, and the sep_char is a
C<^> (caret). None of the fields is quoted, but embedded binary data is
likely to be present. With the specific line ending, this should not be too
hard to detect.
By default, Text::CSV' parse function is instructed to only know about
C<"\n"> and C<"\r"> to be legal line endings, and so has to deal with the
embedded newline as a real C<end-of-line>, so it can scan the next line if
binary is true, and the newline is inside a quoted field. With this option,
we tell L</parse> to parse the line as if C<"\n"> is just nothing more than
a binary character.
For L</parse> this means that the parser has no more idea about line ending
and L</getline> C<chomp>s line endings on reading.
=head3 types
A set of column types; the attribute is immediately passed to the L</types>
method.
=head3 callbacks
See the L</Callbacks> section below.
=head3 accessors
To sum it up,
$csv = Text::CSV->new ();
is equivalent to
$csv = Text::CSV->new ({
eol => undef, # \r, \n, or \r\n
sep_char => ',',
sep => undef,
quote_char => '"',
quote => undef,
escape_char => '"',
binary => 0,
decode_utf8 => 1,
auto_diag => 0,
diag_verbose => 0,
blank_is_undef => 0,
empty_is_undef => 0,
allow_whitespace => 0,
allow_loose_quotes => 0,
allow_loose_escapes => 0,
allow_unquoted_escape => 0,
always_quote => 0,
quote_empty => 0,
quote_space => 1,
escape_null => 1,
quote_binary => 1,
keep_meta_info => 0,
verbatim => 0,
types => undef,
callbacks => undef,
});
For all of the above mentioned flags, an accessor method is available where
you can inquire the current value, or change the value
my $quote = $csv->quote_char;
$csv->binary (1);
It is not wise to change these settings halfway through writing C<CSV> data
to a stream. If however you want to create a new stream using the available
C<CSV> object, there is no harm in changing them.
If the L</new> constructor call fails, it returns C<undef>, and makes the
fail reason available through the L</error_diag> method.
$csv = Text::CSV->new ({ ecs_char => 1 }) or
die "".Text::CSV->error_diag ();
L</error_diag> will return a string like
"INI - Unknown attribute 'ecs_char'"
=head2 known_attributes
@attr = Text::CSV->known_attributes;
@attr = Text::CSV::known_attributes;
@attr = $csv->known_attributes;
This method will return an ordered list of all the supported attributes as
described above. This can be useful for knowing what attributes are valid
in classes that use or extend Text::CSV.
=head2 print
$status = $csv->print ($io, $colref);
Similar to L</combine> + L</string> + L</print>, but much more efficient.
It expects an array ref as input (not an array!) and the resulting string
is not really created, but immediately written to the C<$io> object,
typically an IO handle or any other object that offers a L</print> method.
For performance reasons C<print> does not create a result string, so all
L</string>, L</status>, L</fields>, and L</error_input> methods will return
undefined information after executing this method.
If C<$colref> is C<undef> (explicit, not through a variable argument) and
L</bind_columns> was used to specify fields to be printed, it is possible
to make performance improvements, as otherwise data would have to be copied
as arguments to the method call:
$csv->bind_columns (\($foo, $bar));
$status = $csv->print ($fh, undef);
=head2 say
$status = $csv->say ($io, $colref);
Like L<C<print>|/print>, but L<C<eol>|/eol> defaults to C<$\>.
=head2 print_hr
$csv->print_hr ($io, $ref);
Provides an easy way to print a C<$ref> (as fetched with L</getline_hr>)
provided the column names are set with L</column_names>.
It is just a wrapper method with basic parameter checks over
$csv->print ($io, [ map { $ref->{$_} } $csv->column_names ]);
=head2 combine
$status = $csv->combine (@fields);
This method constructs a C<CSV> record from C<@fields>, returning success
or failure. Failure can result from lack of arguments or an argument that
contains an invalid character. Upon success, L</string> can be called to
retrieve the resultant C<CSV> string. Upon failure, the value returned by
L</string> is undefined and L</error_input> could be called to retrieve the
invalid argument.
=head2 string
$line = $csv->string ();
This method returns the input to L</parse> or the resultant C<CSV> string
of L</combine>, whichever was called more recently.
=head2 getline
$colref = $csv->getline ($io);
This is the counterpart to L</print>, as L</parse> is the counterpart to
L</combine>: it parses a row from the C<$io> handle using the L</getline>
method associated with C<$io> and parses this row into an array ref. This
array ref is returned by the function or C<undef> for failure. When C<$io>
does not support C<getline>, you are likely to hit errors.
When fields are bound with L</bind_columns> the return value is a reference
to an empty list.
The L</string>, L</fields>, and L</status> methods are meaningless again.
=head2 getline_all
$arrayref = $csv->getline_all ($io);
$arrayref = $csv->getline_all ($io, $offset);
$arrayref = $csv->getline_all ($io, $offset, $length);
This will return a reference to a list of L<getline ($io)|/getline> results.
In this call, C<keep_meta_info> is disabled. If C<$offset> is negative, as
with C<splice>, only the last C<abs ($offset)> records of C<$io> are taken
into consideration.
Given a CSV file with 10 lines:
lines call
----- ---------------------------------------------------------
0..9 $csv->getline_all ($io) # all
0..9 $csv->getline_all ($io, 0) # all
8..9 $csv->getline_all ($io, 8) # start at 8
- $csv->getline_all ($io, 0, 0) # start at 0 first 0 rows
0..4 $csv->getline_all ($io, 0, 5) # start at 0 first 5 rows
4..5 $csv->getline_all ($io, 4, 2) # start at 4 first 2 rows
8..9 $csv->getline_all ($io, -2) # last 2 rows
6..7 $csv->getline_all ($io, -4, 2) # first 2 of last 4 rows
=head2 getline_hr
The L</getline_hr> and L</column_names> methods work together to allow you
to have rows returned as hashrefs. You must call L</column_names> first to
declare your column names.
$csv->column_names (qw( code name price description ));
$hr = $csv->getline_hr ($io);
print "Price for $hr->{name} is $hr->{price} EUR\n";
L</getline_hr> will croak if called before L</column_names>.
Note that L</getline_hr> creates a hashref for every row and will be much
slower than the combined use of L</bind_columns> and L</getline> but still
offering the same ease of use hashref inside the loop:
my @cols = @{$csv->getline ($io)};
$csv->column_names (@cols);
while (my $row = $csv->getline_hr ($io)) {
print $row->{price};
}
Could easily be rewritten to the much faster:
my @cols = @{$csv->getline ($io)};
my $row = {};
$csv->bind_columns (\@{$row}{@cols});
while ($csv->getline ($io)) {
print $row->{price};
}
Your mileage may vary for the size of the data and the number of rows.
=head2 getline_hr_all
$arrayref = $csv->getline_hr_all ($io);
$arrayref = $csv->getline_hr_all ($io, $offset);
$arrayref = $csv->getline_hr_all ($io, $offset, $length);
This will return a reference to a list of L<getline_hr ($io)|/getline_hr>
results. In this call, L<C<keep_meta_info>|/keep_meta_info> is disabled.
=head2 parse
$status = $csv->parse ($line);
This method decomposes a C<CSV> string into fields, returning success or
failure. Failure can result from a lack of argument or the given C<CSV>
string is improperly formatted. Upon success, L</fields> can be called to
retrieve the decomposed fields. Upon failure calling L</fields> will return
undefined data and L</error_input> can be called to retrieve the invalid
argument.
You may use the L</types> method for setting column types. See L</types>'
description below.
The C<$line> argument is supposed to be a simple scalar. Everything else is
supposed to croak and set error 1500.
=head2 fragment
This function tries to implement RFC7111 (URI Fragment Identifiers for the
text/csv Media Type) - http://tools.ietf.org/html/rfc7111
my $AoA = $csv->fragment ($io, $spec);
In specifications, C<*> is used to specify the I<last> item, a dash (C<->)
to indicate a range. All indices are C<1>-based: the first row or column
has index C<1>. Selections can be combined with the semi-colon (C<;>).
When using this method in combination with L</column_names>, the returned
reference will point to a list of hashes instead of a list of lists. A
disjointed cell-based combined selection might return rows with different
number of columns making the use of hashes unpredictable.
$csv->column_names ("Name", "Age");
my $AoH = $csv->fragment ($io, "col=3;8");
If the L</after_parse> callback is active, it is also called on every line
parsed and skipped before the fragment.
=over 2
=item row
row=4
row=5-7
row=6-*
row=1-2;4;6-*
=item col
col=2
col=1-3
col=4-*
col=1-2;4;7-*
=item cell
In cell-based selection, the comma (C<,>) is used to pair row and column
cell=4,1
The range operator (C<->) using C<cell>s can be used to define top-left and
bottom-right C<cell> location
cell=3,1-4,6
The C<*> is only allowed in the second part of a pair
cell=3,2-*,2 # row 3 till end, only column 2
cell=3,2-3,* # column 2 till end, only row 3
cell=3,2-*,* # strip row 1 and 2, and column 1
Cells and cell ranges may be combined with C<;>, possibly resulting in rows
with different number of columns
cell=1,1-2,2;3,3-4,4;1,4;4,1
Disjointed selections will only return selected cells. The cells that are
not specified will not be included in the returned set, not even as
C<undef>. As an example given a C<CSV> like
11,12,13,...19
21,22,...28,29
: :
91,...97,98,99
with C<cell=1,1-2,2;3,3-4,4;1,4;4,1> will return:
11,12,14
21,22
33,34
41,43,44
Overlapping cell-specs will return those cells only once, So
C<cell=1,1-3,3;2,2-4,4;2,3;4,2> will return:
11,12,13
21,22,23,24
31,32,33,34
42,43,44
=back
L<RFC7111|http://tools.ietf.org/html/rfc7111> does B<not> allow different
types of specs to be combined (either C<row> I<or> C<col> I<or> C<cell>).
Passing an invalid fragment specification will croak and set error 2013.
=head2 column_names
Set the "keys" that will be used in the L</getline_hr> calls. If no keys
(column names) are passed, it will return the current setting as a list.
L</column_names> accepts a list of scalars (the column names) or a single
array_ref, so you can pass the return value from L</getline> too:
$csv->column_names ($csv->getline ($io));
L</column_names> does B<no> checking on duplicates at all, which might lead
to unexpected results. Undefined entries will be replaced with the string
C<"\cAUNDEF\cA">, so
$csv->column_names (undef, "", "name", "name");
$hr = $csv->getline_hr ($io);
Will set C<< $hr->{"\cAUNDEF\cA"} >> to the 1st field, C<< $hr->{""} >> to
the 2nd field, and C<< $hr->{name} >> to the 4th field, discarding the 3rd
field.
L</column_names> croaks on invalid arguments.
=head2 header
This method does NOT work in perl-5.6.x
Parse the CSV header and set L<C<sep>|/sep>, column_names and encoding.
my @hdr = $csv->header ($fh);
$csv->header ($fh, { sep_set => [ ";", ",", "|", "\t" ] });
$csv->header ($fh, { detect_bom => 1, munge_column_names => "lc" });
The first argument should be a file handle.
Assuming that the file opened for parsing has a header, and the header does
not contain problematic characters like embedded newlines, read the first
line from the open handle then auto-detect whether the header separates the
column names with a character from the allowed separator list.
If any of the allowed separators matches, and none of the I<other> allowed
separators match, set L<C<sep>|/sep> to that separator for the current
CSV_PP instance and use it to parse the first line, map those to lowercase,
and use that to set the instance L</column_names>:
my $csv = Text::CSV->new ({ binary => 1, auto_diag => 1 });
open my $fh, "<", "file.csv";
binmode $fh; # for Windows
$csv->header ($fh);
while (my $row = $csv->getline_hr ($fh)) {
...
}
If the header is empty, contains more than one unique separator out of the
allowed set, contains empty fields, or contains identical fields (after
folding), it will croak with error 1010, 1011, 1012, or 1013 respectively.
If the header contains embedded newlines or is not valid CSV in any other
way, this method will croak and leave the parse error untouched.
A successful call to C<header> will always set the L<C<sep>|/sep> of the
C<$csv> object. This behavior can not be disabled.
=head3 return value
On error this method will croak.
In list context, the headers will be returned whether they are used to set
L</column_names> or not.
In scalar context, the instance itself is returned. B<Note>: the values as
found in the header will effectively be B<lost> if C<set_column_names> is
false.
=head3 Options
=over 2
=item sep_set
$csv->header ($fh, { sep_set => [ ";", ",", "|", "\t" ] });
The list of legal separators defaults to C<[ ";", "," ]> and can be changed
by this option. As this is probably the most often used option, it can be
passed on its own as an unnamed argument:
$csv->header ($fh, [ ";", ",", "|", "\t", "::", "\x{2063}" ]);
Multi-byte sequences are allowed, both multi-character and Unicode. See
L<C<sep>|/sep>.
=item detect_bom
$csv->header ($fh, { detect_bom => 1 });
The default behavior is to detect if the header line starts with a BOM. If
the header has a BOM, use that to set the encoding of C<$fh>. This default
behavior can be disabled by passing a false value to C<detect_bom>.
Supported encodings from BOM are: UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, and
UTF-32LE. BOM's also support UTF-1, UTF-EBCDIC, SCSU, BOCU-1, and GB-18030
but L<Encode> does not (yet). UTF-7 is not supported.
The encoding is set using C<binmode> on C<$fh>.
If the handle was opened in a (correct) encoding, this method will B<not>
alter the encoding, as it checks the leading B<bytes> of the first line.
=item munge_column_names
This option offers the means to modify the column names into something that
is most useful to the application. The default is to map all column names
to lower case.
$csv->header ($fh, { munge_column_names => "lc" });
The following values are available:
lc - lower case
uc - upper case
none - do not change
\&cb - supply a callback
$csv->header ($fh, { munge_column_names => sub { fc } });
$csv->header ($fh, { munge_column_names => sub { "column_".$col++ } });
$csv->header ($fh, { munge_column_names => sub { lc (s/\W+/_/gr) } });
As this callback is called in a C<map>, you can use C<$_> directly.
=item set_column_names
$csv->header ($fh, { set_column_names => 1 });
The default is to set the instances column names using L</column_names> if
the method is successful, so subsequent calls to L</getline_hr> can return
a hash. Disable setting the header can be forced by using a false value for
this option.
=back
=head3 Validation
When receiving CSV files from external sources, this method can be used to
protect against changes in the layout by restricting to known headers (and
typos in the header fields).
my %known = (
"record key" => "c_rec",
"rec id" => "c_rec",
"id_rec" => "c_rec",
"kode" => "code",
"code" => "code",
"vaule" => "value",
"value" => "value",
);
my $csv = Text::CSV->new ({ binary => 1, auto_diag => 1 });
open my $fh, "<", $source or die "$source: $!";
$csv->header ($fh, { munge_column_names => sub {
s/\s+$//;
s/^\s+//;
$known{lc $_} or die "Unknown column '$_' in $source";
}});
while (my $row = $csv->getline_hr ($fh)) {
say join "\t", $row->{c_rec}, $row->{code}, $row->{value};
}
=head2 bind_columns
Takes a list of scalar references to be used for output with L</print> or
to store in the fields fetched by L</getline>. When you do not pass enough
references to store the fetched fields in, L</getline> will fail with error
C<3006>. If you pass more than there are fields to return, the content of
the remaining references is left untouched.
$csv->bind_columns (\$code, \$name, \$price, \$description);
while ($csv->getline ($io)) {
print "The price of a $name is \x{20ac} $price\n";
}
To reset or clear all column binding, call L</bind_columns> with the single
argument C<undef>. This will also clear column names.
$csv->bind_columns (undef);
If no arguments are passed at all, L</bind_columns> will return the list of
current bindings or C<undef> if no binds are active.
Note that in parsing with C<bind_columns>, the fields are set on the fly.
That implies that if the third field of a row causes an error, the first
two fields already have been assigned the values of the current row, while
the rest will still hold the values of the previous row.
=head2 eof
$eof = $csv->eof ();
If L</parse> or L</getline> was used with an IO stream, this method will
return true (1) if the last call hit end of file, otherwise it will return
false (''). This is useful to see the difference between a failure and end
of file.
Note that if the parsing of the last line caused an error, C<eof> is still
true. That means that if you are I<not> using L</auto_diag>, an idiom like
while (my $row = $csv->getline ($fh)) {
# ...
}
$csv->eof or $csv->error_diag;
will I<not> report the error. You would have to change that to
while (my $row = $csv->getline ($fh)) {
# ...
}
+$csv->error_diag and $csv->error_diag;
=head2 types
$csv->types (\@tref);
This method is used to force that (all) columns are of a given type. For
example, if you have an integer column, two columns with doubles and a
string column, then you might do a
$csv->types ([Text::CSV::IV (),
Text::CSV::NV (),
Text::CSV::NV (),
Text::CSV::PV ()]);
Column types are used only for I<decoding> columns while parsing, in other
words by the L</parse> and L</getline> methods.
You can unset column types by doing a
$csv->types (undef);
or fetch the current type settings with
$types = $csv->types ();
=over 4
=item IV
Set field type to integer.
=item NV
Set field type to numeric/float.
=item PV
Set field type to string.
=back
=head2 fields
@columns = $csv->fields ();
This method returns the input to L</combine> or the resultant decomposed
fields of a successful L</parse>, whichever was called more recently.
Note that the return value is undefined after using L</getline>, which does
not fill the data structures returned by L</parse>.
=head2 meta_info
@flags = $csv->meta_info ();
This method returns the "flags" of the input to L</combine> or the flags of
the resultant decomposed fields of L</parse>, whichever was called more
recently.
For each field, a meta_info field will hold flags that inform something
about the field returned by the L</fields> method or passed to the
L</combine> method. The flags are bit-wise-C<or>'d like:
=over 2
=item C< >0x0001
The field was quoted.
=item C< >0x0002
The field was binary.
=back
See the C<is_***> methods below.
=head2 is_quoted
my $quoted = $csv->is_quoted ($column_idx);
Where C<$column_idx> is the (zero-based) index of the column in the last
result of L</parse>.
This returns a true value if the data in the indicated column was enclosed
in L<C<quote_char>|/quote_char> quotes. This might be important for fields
where content C<,20070108,> is to be treated as a numeric value, and where
C<,"20070108",> is explicitly marked as character string data.
This method is only valid when L</keep_meta_info> is set to a true value.
=head2 is_binary
my $binary = $csv->is_binary ($column_idx);
Where C<$column_idx> is the (zero-based) index of the column in the last
result of L</parse>.
This returns a true value if the data in the indicated column contained any
byte in the range C<[\x00-\x08,\x10-\x1F,\x7F-\xFF]>.
This method is only valid when L</keep_meta_info> is set to a true value.
=head2 is_missing
my $missing = $csv->is_missing ($column_idx);
Where C<$column_idx> is the (zero-based) index of the column in the last
result of L</getline_hr>.
$csv->keep_meta_info (1);
while (my $hr = $csv->getline_hr ($fh)) {
$csv->is_missing (0) and next; # This was an empty line
}
When using L</getline_hr>, it is impossible to tell if the parsed fields
are C<undef> because they where not filled in the C<CSV> stream or because
they were not read at all, as B<all> the fields defined by L</column_names>
are set in the hash-ref. If you still need to know if all fields in each
row are provided, you should enable L<C<keep_meta_info>|/keep_meta_info> so
you can check the flags.
If L<C<keep_meta_info>|/keep_meta_info> is C<false>, C<is_missing> will
always return C<undef>, regardless of C<$column_idx> being valid or not. If
this attribute is C<true> it will return either C<0> (the field is present)
or C<1> (the field is missing).
A special case is the empty line. If the line is completely empty - after
dealing with the flags - this is still a valid CSV line: it is a record of
just one single empty field. However, if C<keep_meta_info> is set, invoking
C<is_missing> with index C<0> will now return true.
=head2 status
$status = $csv->status ();
This method returns the status of the last invoked L</combine> or L</parse>
call. Status is success (true: C<1>) or failure (false: C<undef> or C<0>).
=head2 error_input
$bad_argument = $csv->error_input ();
This method returns the erroneous argument (if it exists) of L</combine> or
L</parse>, whichever was called more recently. If the last invocation was
successful, C<error_input> will return C<undef>.
=head2 error_diag
Text::CSV->error_diag ();
$csv->error_diag ();
$error_code = 0 + $csv->error_diag ();
$error_str = "" . $csv->error_diag ();
($cde, $str, $pos, $rec, $fld) = $csv->error_diag ();
If (and only if) an error occurred, this function returns the diagnostics
of that error.
If called in void context, this will print the internal error code and the
associated error message to STDERR.
If called in list context, this will return the error code and the error
message in that order. If the last error was from parsing, the rest of the
values returned are a best guess at the location within the line that was
being parsed. Their values are 1-based. The position currently is index of
the byte at which the parsing failed in the current record. It might change
to be the index of the current character in a later release. The records is
the index of the record parsed by the csv instance. The field number is the
index of the field the parser thinks it is currently trying to parse. See
F<examples/csv-check> for how this can be used.
If called in scalar context, it will return the diagnostics in a single
scalar, a-la C<$!>. It will contain the error code in numeric context, and
the diagnostics message in string context.
When called as a class method or a direct function call, the diagnostics
are that of the last L</new> call.
=head2 record_number
$recno = $csv->record_number ();
Returns the records parsed by this csv instance. This value should be more
accurate than C<$.> when embedded newlines come in play. Records written by
this instance are not counted.
=head2 SetDiag
$csv->SetDiag (0);
Use to reset the diagnostics if you are dealing with errors.
=head1 ADDITIONAL METHODS
=over
=item backend
Returns the backend module name called by Text::CSV.
C<module> is an alias.
=item is_xs
Returns true value if Text::CSV uses an XS backend.
=item is_pp
Returns true value if Text::CSV uses a pure-Perl backend.
=back
=head1 FUNCTIONS
This whole section is also taken from Text::CSV_XS.
=head2 csv
This function is not exported by default and should be explicitly requested:
use Text::CSV qw( csv );
This is an high-level function that aims at simple (user) interfaces. This
can be used to read/parse a C<CSV> file or stream (the default behavior) or
to produce a file or write to a stream (define the C<out> attribute). It
returns an array- or hash-reference on parsing (or C<undef> on fail) or the
numeric value of L</error_diag> on writing. When this function fails you
can get to the error using the class call to L</error_diag>
my $aoa = csv (in => "test.csv") or
die Text::CSV->error_diag;
This function takes the arguments as key-value pairs. This can be passed as
a list or as an anonymous hash:
my $aoa = csv ( in => "test.csv", sep_char => ";");
my $aoh = csv ({ in => $fh, headers => "auto" });
The arguments passed consist of two parts: the arguments to L</csv> itself
and the optional attributes to the C<CSV> object used inside the function
as enumerated and explained in L</new>.
If not overridden, the default option used for CSV is
auto_diag => 1
escape_null => 0
The option that is always set and cannot be altered is
binary => 1
As this function will likely be used in one-liners, it allows C<quote> to
be abbreviated as C<quo>, and C<escape_char> to be abbreviated as C<esc>
or C<escape>.
Alternative invocations:
my $aoa = Text::CSV::csv (in => "file.csv");
my $csv = Text::CSV->new ();
my $aoa = $csv->csv (in => "file.csv");
In the latter case, the object attributes are used from the existing object
and the attribute arguments in the function call are ignored:
my $csv = Text::CSV->new ({ sep_char => ";" });
my $aoh = $csv->csv (in => "file.csv", bom => 1);
will parse using C<;> as C<sep_char>, not C<,>.
=head3 in
Used to specify the source. C<in> can be a file name (e.g. C<"file.csv">),
which will be opened for reading and closed when finished, a file handle
(e.g. C<$fh> or C<FH>), a reference to a glob (e.g. C<\*ARGV>), the glob
itself (e.g. C<*STDIN>), or a reference to a scalar (e.g. C<\q{1,2,"csv"}>).
When used with L</out>, C<in> should be a reference to a CSV structure (AoA
or AoH) or a CODE-ref that returns an array-reference or a hash-reference.
The code-ref will be invoked with no arguments.
my $aoa = csv (in => "file.csv");
open my $fh, "<", "file.csv";
my $aoa = csv (in => $fh);
my $csv = [ [qw( Foo Bar )], [ 1, 2 ], [ 2, 3 ]];
my $err = csv (in => $csv, out => "file.csv");
If called in void context without the L</out> attribute, the resulting ref
will be used as input to a subsequent call to csv:
csv (in => "file.csv", filter => { 2 => sub { length > 2 }})
will be a shortcut to
csv (in => csv (in => "file.csv", filter => { 2 => sub { length > 2 }}))
where, in the absence of the C<out> attribute, this is a shortcut to
csv (in => csv (in => "file.csv", filter => { 2 => sub { length > 2 }}),
out => *STDOUT)
=head3 out
In output mode, the default CSV options when producing CSV are
eol => "\r\n"
The L</fragment> attribute is ignored in output mode.
C<out> can be a file name (e.g. C<"file.csv">), which will be opened for
writing and closed when finished, a file handle (e.g. C<$fh> or C<FH>), a
reference to a glob (e.g. C<\*STDOUT>), or the glob itself (e.g. C<*STDOUT>).
csv (in => sub { $sth->fetch }, out => "dump.csv");
csv (in => sub { $sth->fetchrow_hashref }, out => "dump.csv",
headers => $sth->{NAME_lc});
When a code-ref is used for C<in>, the output is generated per invocation,
so no buffering is involved. This implies that there is no size restriction
on the number of records. The C<csv> function ends when the coderef returns
a false value.
=head3 encoding
If passed, it should be an encoding accepted by the C<:encoding()> option
to C<open>. There is no default value. This attribute does not work in perl
5.6.x. C<encoding> can be abbreviated to C<enc> for ease of use in command
line invocations.
If C<encoding> is set to the literal value C<"auto">, the method L</header>
will be invoked on the opened stream to check if there is a BOM and set the
encoding accordingly. This is equal to passing a true value in the option
L<C<detect_bom>|/detect_bom>.
=head3 detect_bom
If C<detect_bom> is given, the method L</header> will be invoked on the
opened stream to check if there is a BOM and set the encoding accordingly.
C<detect_bom> can be abbreviated to C<bom>.
This is the same as setting L<C<encoding>|/encoding> to C<"auto">.
Note that as L</header> is invoked, its default is to also set the headers.
=head3 headers
If this attribute is not given, the default behavior is to produce an array
of arrays.
If C<headers> is supplied, it should be an anonymous list of column names,
an anonymous hashref, a coderef, or a literal flag: C<auto>, C<lc>, C<uc>,
or C<skip>.
=over 2
=item skip
When C<skip> is used, the header will not be included in the output.
my $aoa = csv (in => $fh, headers => "skip");
=item auto
If C<auto> is used, the first line of the C<CSV> source will be read as the
list of field headers and used to produce an array of hashes.
my $aoh = csv (in => $fh, headers => "auto");
=item lc
If C<lc> is used, the first line of the C<CSV> source will be read as the
list of field headers mapped to lower case and used to produce an array of
hashes. This is a variation of C<auto>.
my $aoh = csv (in => $fh, headers => "lc");
=item uc
If C<uc> is used, the first line of the C<CSV> source will be read as the
list of field headers mapped to upper case and used to produce an array of
hashes. This is a variation of C<auto>.
my $aoh = csv (in => $fh, headers => "uc");
=item CODE
If a coderef is used, the first line of the C<CSV> source will be read as
the list of mangled field headers in which each field is passed as the only
argument to the coderef. This list is used to produce an array of hashes.
my $aoh = csv (in => $fh,
headers => sub { lc ($_[0]) =~ s/kode/code/gr });
this example is a variation of using C<lc> where all occurrences of C<kode>
are replaced with C<code>.
=item ARRAY
If C<headers> is an anonymous list, the entries in the list will be used
as field names. The first line is considered data instead of headers.
my $aoh = csv (in => $fh, headers => [qw( Foo Bar )]);
csv (in => $aoa, out => $fh, headers => [qw( code description price )]);
=item HASH
If C<headers> is an hash reference, this implies C<auto>, but header fields
for that exist as key in the hashref will be replaced by the value for that
key. Given a CSV file like
post-kode,city,name,id number,fubble
1234AA,Duckstad,Donald,13,"X313DF"
using
csv (headers => { "post-kode" => "pc", "id number" => "ID" }, ...
will return an entry like
{ pc => "1234AA",
city => "Duckstad",
name => "Donald",
ID => "13",
fubble => "X313DF",
}
=back
See also L<C<munge_column_names>|/munge_column_names> and
L<C<set_column_names>|/set_column_names>.
=head3 munge_column_names
If C<munge_column_names> is set, the method L</header> is invoked on the
opened stream with all matching arguments to detect and set the headers.
C<munge_column_names> can be abbreviated to C<munge>.
=head3 key
If passed, will default L<C<headers>|/headers> to C<"auto"> and return a
hashref instead of an array of hashes.
my $ref = csv (in => "test.csv", key => "code");
with test.csv like
code,product,price,color
1,pc,850,gray
2,keyboard,12,white
3,mouse,5,black
will return
{ 1 => {
code => 1,
color => 'gray',
price => 850,
product => 'pc'
},
2 => {
code => 2,
color => 'white',
price => 12,
product => 'keyboard'
},
3 => {
code => 3,
color => 'black',
price => 5,
product => 'mouse'
}
}
=head3 fragment
Only output the fragment as defined in the L</fragment> method. This option
is ignored when I<generating> C<CSV>. See L</out>.
Combining all of them could give something like
use Text::CSV qw( csv );
my $aoh = csv (
in => "test.txt",
encoding => "utf-8",
headers => "auto",
sep_char => "|",
fragment => "row=3;6-9;15-*",
);
say $aoh->[15]{Foo};
=head3 sep_set
If C<sep_set> is set, the method L</header> is invoked on the opened stream
to detect and set L<C<sep_char>|/sep_char> with the given set.
C<sep_set> can be abbreviated to C<seps>.
Note that as L</header> is invoked, its default is to also set the headers.
=head3 set_column_names
If C<set_column_names> is passed, the method L</header> is invoked on the
opened stream with all arguments meant for L</header>.
=head2 Callbacks
Callbacks enable actions triggered from the I<inside> of Text::CSV.
While most of what this enables can easily be done in an unrolled loop as
described in the L</SYNOPSIS> callbacks can be used to meet special demands
or enhance the L</csv> function.
=over 2
=item error
$csv->callbacks (error => sub { $csv->SetDiag (0) });
the C<error> callback is invoked when an error occurs, but I<only> when
L</auto_diag> is set to a true value. A callback is invoked with the values
returned by L</error_diag>:
my ($c, $s);
sub ignore3006
{
my ($err, $msg, $pos, $recno, $fldno) = @_;
if ($err == 3006) {
# ignore this error
($c, $s) = (undef, undef);
Text::CSV->SetDiag (0);
}
# Any other error
return;
} # ignore3006
$csv->callbacks (error => \&ignore3006);
$csv->bind_columns (\$c, \$s);
while ($csv->getline ($fh)) {
# Error 3006 will not stop the loop
}
=item after_parse
$csv->callbacks (after_parse => sub { push @{$_[1]}, "NEW" });
while (my $row = $csv->getline ($fh)) {
$row->[-1] eq "NEW";
}
This callback is invoked after parsing with L</getline> only if no error
occurred. The callback is invoked with two arguments: the current C<CSV>
parser object and an array reference to the fields parsed.
The return code of the callback is ignored unless it is a reference to the
string "skip", in which case the record will be skipped in L</getline_all>.
sub add_from_db
{
my ($csv, $row) = @_;
$sth->execute ($row->[4]);
push @$row, $sth->fetchrow_array;
} # add_from_db
my $aoa = csv (in => "file.csv", callbacks => {
after_parse => \&add_from_db });
This hook can be used for validation:
=over 2
=item FAIL
Die if any of the records does not validate a rule:
after_parse => sub {
$_[1][4] =~ m/^[0-9]{4}\s?[A-Z]{2}$/ or
die "5th field does not have a valid Dutch zipcode";
}
=item DEFAULT
Replace invalid fields with a default value:
after_parse => sub { $_[1][2] =~ m/^\d+$/ or $_[1][2] = 0 }
=item SKIP
Skip records that have invalid fields (only applies to L</getline_all>):
after_parse => sub { $_[1][0] =~ m/^\d+$/ or return \"skip"; }
=back
=item before_print
my $idx = 1;
$csv->callbacks (before_print => sub { $_[1][0] = $idx++ });
$csv->print (*STDOUT, [ 0, $_ ]) for @members;
This callback is invoked before printing with L</print> only if no error
occurred. The callback is invoked with two arguments: the current C<CSV>
parser object and an array reference to the fields passed.
The return code of the callback is ignored.
sub max_4_fields
{
my ($csv, $row) = @_;
@$row > 4 and splice @$row, 4;
} # max_4_fields
csv (in => csv (in => "file.csv"), out => *STDOUT,
callbacks => { before print => \&max_4_fields });
This callback is not active for L</combine>.
=back
=head3 Callbacks for csv ()
The L</csv> allows for some callbacks that do not integrate in XS internals
but only feature the L</csv> function.
csv (in => "file.csv",
callbacks => {
filter => { 6 => sub { $_ > 15 } }, # first
after_parse => sub { say "AFTER PARSE"; }, # first
after_in => sub { say "AFTER IN"; }, # second
on_in => sub { say "ON IN"; }, # third
},
);
csv (in => $aoh,
out => "file.csv",
callbacks => {
on_in => sub { say "ON IN"; }, # first
before_out => sub { say "BEFORE OUT"; }, # second
before_print => sub { say "BEFORE PRINT"; }, # third
},
);
=over 2
=item filter
This callback can be used to filter records. It is called just after a new
record has been scanned. The callback accepts a hashref where the keys are
the index to the row (the field number, 1-based) and the values are subs to
return a true or false value.
csv (in => "file.csv", filter => {
3 => sub { m/a/ }, # third field should contain an "a"
5 => sub { length > 4 }, # length of the 5th field minimal 5
});
csv (in => "file.csv", filter => "not_blank");
csv (in => "file.csv", filter => "not_empty");
csv (in => "file.csv", filter => "filled");
If the keys to the filter hash contain any character that is not a digit it
will also implicitly set L</headers> to C<"auto"> unless L</headers> was
already passed as argument. When headers are active, returning an array of
hashes, the filter is not applicable to the header itself.
csv (in => "file.csv", filter => { foo => sub { $_ > 4 }});
All sub results should match, as in AND.
The context of the callback sets C<$_> localized to the field indicated by
the filter. The two arguments are as with all other callbacks, so the other
fields in the current row can be seen:
filter => { 3 => sub { $_ > 100 ? $_[1][1] =~ m/A/ : $_[1][6] =~ m/B/ }}
If the context is set to return a list of hashes (L</headers> is defined),
the current record will also be available in the localized C<%_>:
filter => { 3 => sub { $_ > 100 && $_{foo} =~ m/A/ && $_{bar} < 1000 }}
If the filter is used to I<alter> the content by changing C<$_>, make sure
that the sub returns true in order not to have that record skipped:
filter => { 2 => sub { $_ = uc }}
will upper-case the second field, and then skip it if the resulting content
evaluates to false. To always accept, end with truth:
filter => { 2 => sub { $_ = uc; 1 }}
B<Predefined filters>
Given a file like (line numbers prefixed for doc purpose only):
1:1,2,3
2:
3:,
4:""
5:,,
6:, ,
7:"",
8:" "
9:4,5,6
=over 2
=item not_blank
Filter out the blank lines
This filter is a shortcut for
filter => { 0 => sub { @{$_[1]} > 1 or
defined $_[1][0] && $_[1][0] ne "" } }
Due to the implementation, it is currently impossible to also filter lines
that consists only of a quoted empty field. These lines are also considered
blank lines.
With the given example, lines 2 and 4 will be skipped.
=item not_empty
Filter out lines where all the fields are empty.
This filter is a shortcut for
filter => { 0 => sub { grep { defined && $_ ne "" } @{$_[1]} } }
A space is not regarded being empty, so given the example data, lines 2, 3,
4, 5, and 7 are skipped.
=item filled
Filter out lines that have no visible data
This filter is a shortcut for
filter => { 0 => sub { grep { defined && m/\S/ } @{$_[1]} } }
This filter rejects all lines that I<not> have at least one field that does
not evaluate to the empty string.
With the given example data, this filter would skip lines 2 through 8.
=back
=item after_in
This callback is invoked for each record after all records have been parsed
but before returning the reference to the caller. The hook is invoked with
two arguments: the current C<CSV> parser object and a reference to the
record. The reference can be a reference to a HASH or a reference to an
ARRAY as determined by the arguments.
This callback can also be passed as an attribute without the C<callbacks>
wrapper.
=item before_out
This callback is invoked for each record before the record is printed. The
hook is invoked with two arguments: the current C<CSV> parser object and a
reference to the record. The reference can be a reference to a HASH or a
reference to an ARRAY as determined by the arguments.
This callback can also be passed as an attribute without the C<callbacks>
wrapper.
This callback makes the row available in C<%_> if the row is a hashref. In
this case C<%_> is writable and will change the original row.
=item on_in
This callback acts exactly as the L</after_in> or the L</before_out> hooks.
This callback can also be passed as an attribute without the C<callbacks>
wrapper.
This callback makes the row available in C<%_> if the row is a hashref. In
this case C<%_> is writable and will change the original row. So e.g. with
my $aoh = csv (
in => \"foo\n1\n2\n",
headers => "auto",
on_in => sub { $_{bar} = 2; },
);
C<$aoh> will be:
[ { foo => 1,
bar => 2,
}
{ foo => 2,
bar => 2,
}
]
=item csv
The I<function> L</csv> can also be called as a method or with an existing
Text::CSV object. This could help if the function is to be invoked a lot
of times and the overhead of creating the object internally over and over
again would be prevented by passing an existing instance.
my $csv = Text::CSV->new ({ binary => 1, auto_diag => 1 });
my $aoa = $csv->csv (in => $fh);
my $aoa = csv (in => $fh, csv => $csv);
both act the same. Running this 20000 times on a 20 lines CSV file, showed
a 53% speedup.
=back
=head1 DIAGNOSTICS
This section is also taken from Text::CSV_XS.
If an error occurs, C<< $csv->error_diag >> can be used to get information
on the cause of the failure. Note that for speed reasons the internal value
is never cleared on success, so using the value returned by L</error_diag>
in normal cases - when no error occurred - may cause unexpected results.
If the constructor failed, the cause can be found using L</error_diag> as a
class method, like C<< Text::CSV_PP->error_diag >>.
The C<< $csv->error_diag >> method is automatically invoked upon error when
the contractor was called with L<C<auto_diag>|/auto_diag> set to C<1> or
C<2>, or when L<autodie> is in effect. When set to C<1>, this will cause a
C<warn> with the error message, when set to C<2>, it will C<die>. C<2012 -
EOF> is excluded from L<C<auto_diag>|/auto_diag> reports.
Errors can be (individually) caught using the L</error> callback.
The errors as described below are available. I have tried to make the error
itself explanatory enough, but more descriptions will be added. For most of
these errors, the first three capitals describe the error category:
=over 2
=item *
INI
Initialization error or option conflict.
=item *
ECR
Carriage-Return related parse error.
=item *
EOF
End-Of-File related parse error.
=item *
EIQ
Parse error inside quotation.
=item *
EIF
Parse error inside field.
=item *
ECB
Combine error.
=item *
EHR
HashRef parse related error.
=back
And below should be the complete list of error codes that can be returned:
=over 2
=item *
1001 "INI - sep_char is equal to quote_char or escape_char"
X<1001>
The L<separation character|/sep_char> cannot be equal to L<the quotation
character|/quote_char> or to L<the escape character|/escape_char>, as this
would invalidate all parsing rules.
=item *
1002 "INI - allow_whitespace with escape_char or quote_char SP or TAB"
X<1002>
Using the L<C<allow_whitespace>|/allow_whitespace> attribute when either
L<C<quote_char>|/quote_char> or L<C<escape_char>|/escape_char> is equal to
C<SPACE> or C<TAB> is too ambiguous to allow.
=item *
1003 "INI - \r or \n in main attr not allowed"
X<1003>
Using default L<C<eol>|/eol> characters in either L<C<sep_char>|/sep_char>,
L<C<quote_char>|/quote_char>, or L<C<escape_char>|/escape_char> is not
allowed.
=item *
1004 "INI - callbacks should be undef or a hashref"
X<1004>
The L<C<callbacks>|/Callbacks> attribute only allows one to be C<undef> or
a hash reference.
=item *
1005 "INI - EOL too long"
X<1005>
The value passed for EOL is exceeding its maximum length (16).
=item *
1006 "INI - SEP too long"
X<1006>
The value passed for SEP is exceeding its maximum length (16).
=item *
1007 "INI - QUOTE too long"
X<1007>
The value passed for QUOTE is exceeding its maximum length (16).
=item *
1008 "INI - SEP undefined"
X<1008>
The value passed for SEP should be defined and not empty.
=item *
1010 "INI - the header is empty"
X<1010>
The header line parsed in the L</header> is empty.
=item *
1011 "INI - the header contains more than one valid separator"
X<1011>
The header line parsed in the L</header> contains more than one (unique)
separator character out of the allowed set of separators.
=item *
1012 "INI - the header contains an empty field"
X<1012>
The header line parsed in the L</header> is contains an empty field.
=item *
1013 "INI - the header contains nun-unique fields"
X<1013>
The header line parsed in the L</header> contains at least two identical
fields.
=item *
1014 "INI - header called on undefined stream"
X<1014>
The header line cannot be parsed from an undefined sources.
=item *
1500 "PRM - Invalid/unsupported argument(s)"
X<1500>
Function or method called with invalid argument(s) or parameter(s).
=item *
2010 "ECR - QUO char inside quotes followed by CR not part of EOL"
X<2010>
When L<C<eol>|/eol> has been set to anything but the default, like
C<"\r\t\n">, and the C<"\r"> is following the B<second> (closing)
L<C<quote_char>|/quote_char>, where the characters following the C<"\r"> do
not make up the L<C<eol>|/eol> sequence, this is an error.
=item *
2011 "ECR - Characters after end of quoted field"
X<2011>
Sequences like C<1,foo,"bar"baz,22,1> are not allowed. C<"bar"> is a quoted
field and after the closing double-quote, there should be either a new-line
sequence or a separation character.
=item *
2012 "EOF - End of data in parsing input stream"
X<2012>
Self-explaining. End-of-file while inside parsing a stream. Can happen only
when reading from streams with L</getline>, as using L</parse> is done on
strings that are not required to have a trailing L<C<eol>|/eol>.
=item *
2013 "INI - Specification error for fragments RFC7111"
X<2013>
Invalid specification for URI L</fragment> specification.
=item *
2021 "EIQ - NL char inside quotes, binary off"
X<2021>
Sequences like C<1,"foo\nbar",22,1> are allowed only when the binary option
has been selected with the constructor.
=item *
2022 "EIQ - CR char inside quotes, binary off"
X<2022>
Sequences like C<1,"foo\rbar",22,1> are allowed only when the binary option
has been selected with the constructor.
=item *
2023 "EIQ - QUO character not allowed"
X<2023>
Sequences like C<"foo "bar" baz",qu> and C<2023,",2008-04-05,"Foo, Bar",\n>
will cause this error.
=item *
2024 "EIQ - EOF cannot be escaped, not even inside quotes"
X<2024>
The escape character is not allowed as last character in an input stream.
=item *
2025 "EIQ - Loose unescaped escape"
X<2025>
An escape character should escape only characters that need escaping.
Allowing the escape for other characters is possible with the attribute
L</allow_loose_escape>.
=item *
2026 "EIQ - Binary character inside quoted field, binary off"
X<2026>
Binary characters are not allowed by default. Exceptions are fields that
contain valid UTF-8, that will automatically be upgraded if the content is
valid UTF-8. Set L<C<binary>|/binary> to C<1> to accept binary data.
=item *
2027 "EIQ - Quoted field not terminated"
X<2027>
When parsing a field that started with a quotation character, the field is
expected to be closed with a quotation character. When the parsed line is
exhausted before the quote is found, that field is not terminated.
=item *
2030 "EIF - NL char inside unquoted verbatim, binary off"
X<2030>
=item *
2031 "EIF - CR char is first char of field, not part of EOL"
X<2031>
=item *
2032 "EIF - CR char inside unquoted, not part of EOL"
X<2032>
=item *
2034 "EIF - Loose unescaped quote"
X<2034>
=item *
2035 "EIF - Escaped EOF in unquoted field"
X<2035>
=item *
2036 "EIF - ESC error"
X<2036>
=item *
2037 "EIF - Binary character in unquoted field, binary off"
X<2037>
=item *
2110 "ECB - Binary character in Combine, binary off"
X<2110>
=item *
2200 "EIO - print to IO failed. See errno"
X<2200>
=item *
3001 "EHR - Unsupported syntax for column_names ()"
X<3001>
=item *
3002 "EHR - getline_hr () called before column_names ()"
X<3002>
=item *
3003 "EHR - bind_columns () and column_names () fields count mismatch"
X<3003>
=item *
3004 "EHR - bind_columns () only accepts refs to scalars"
X<3004>
=item *
3006 "EHR - bind_columns () did not pass enough refs for parsed fields"
X<3006>
=item *
3007 "EHR - bind_columns needs refs to writable scalars"
X<3007>
=item *
3008 "EHR - unexpected error in bound fields"
X<3008>
=item *
3009 "EHR - print_hr () called before column_names ()"
X<3009>
=item *
3010 "EHR - print_hr () called with invalid arguments"
X<3010>
=back
=head1 SEE ALSO
L<Text::CSV_PP>, L<Text::CSV_XS> and L<Text::CSV::Encoded>.
=head1 AUTHORS and MAINTAINERS
Alan Citterman F<E<lt>alan[at]mfgrtl.comE<gt>> wrote the original Perl
module. Please don't send mail concerning Text::CSV to Alan, as
he's not a present maintainer.
Jochen Wiedmann F<E<lt>joe[at]ispsoft.deE<gt>> rewrote the encoding and
decoding in C by implementing a simple finite-state machine and added
the variable quote, escape and separator characters, the binary mode
and the print and getline methods. See ChangeLog releases 0.10 through
0.23.
H.Merijn Brand F<E<lt>h.m.brand[at]xs4all.nlE<gt>> cleaned up the code,
added the field flags methods, wrote the major part of the test suite,
completed the documentation, fixed some RT bugs. See ChangeLog releases
0.25 and on.
Makamaka Hannyaharamitu, E<lt>makamaka[at]cpan.orgE<gt> wrote Text::CSV_PP
which is the pure-Perl version of Text::CSV_XS.
New Text::CSV (since 0.99) is maintained by Makamaka, and Kenichi Ishigaki
since 1.91.
=head1 COPYRIGHT AND LICENSE
Text::CSV
Copyright (C) 1997 Alan Citterman. All rights reserved.
Copyright (C) 2007-2015 Makamaka Hannyaharamitu.
Copyright (C) 2017- Kenichi Ishigaki
A large portion of the doc is taken from Text::CSV_XS. See below.
Text::CSV_PP:
Copyright (C) 2005-2015 Makamaka Hannyaharamitu.
Copyright (C) 2017- Kenichi Ishigaki
A large portion of the code/doc are also taken from Text::CSV_XS. See below.
Text:CSV_XS:
Copyright (C) 2007-2016 H.Merijn Brand for PROCURA B.V.
Copyright (C) 1998-2001 Jochen Wiedmann. All rights reserved.
Portions Copyright (C) 1997 Alan Citterman. All rights reserved.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
|