/usr/lib/x86_64-linux-gnu/perl5/5.22/GetData.pm is in libgetdata-perl 0.9.0-2.2.
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 | # Copyright (C) 2011-2013, 2015 D. V. Wiebe
#
##########################################################################
#
# This file is part of the GetData project.
#
# GetData is free software; you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the
# Free Software Foundation; either version 2.1 of the License, or (at your
# option) any later version.
#
# GetData is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
# License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with GetData; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#
package GetData;
use 5.00800;
use strict;
use warnings;
require Exporter;
require XSLoader;
require Math::Complex;
our @ISA = qw(Exporter);
our %EXPORT_TAGS = ('all' => [qw(VERSION DESTROY add add_alias add_bit add_carray add_const add_divide add_lincom add_linterp add_mplex add_multiply add_phase add_polynom add_raw add_recip add_sbit add_spec add_string add_window alias_target aliases alter_affixes alter_bit alter_carray alter_const alter_divide alter_encoding alter_endianness alter_entry alter_frameoffset alter_lincom alter_linterp alter_mplex alter_multiply alter_phase alter_polynom alter_protection alter_raw alter_recip alter_sbit alter_spec alter_window array_len bof carray_len carrays close constants delete desync dirfile_standards dirfilename discard encoding endianness entry entry_list eof error error_count error_string field_list field_list_by_type flags flush fragment_affixes fragment_index fragmentname fragments framenum frameoffset get_carray get_carray_slice get_constant get_string getdata hidden hide include invalid_dirfile linterp_tablename madd madd_alias madd_bit madd_carray madd_const madd_divide madd_lincom madd_linterp madd_mplex madd_multiply madd_phase madd_polynom madd_recip madd_sbit madd_spec madd_string madd_window malter_spec mcarrays mconstants metaflush mfield_list mfield_list_by_type move mplex_lookback mstrings mvector_list native_type nframes open parent_fragment parser_callback protection put_carray put_carray_slice put_constant put_string putdata raw_close raw_filename reference rename rewrite_fragment seek spf strings strtok sync tell unhide uninclude validate vector_list verbose_prefix E_OK E_FORMAT E_CREAT E_BAD_CODE E_BAD_TYPE E_IO E_INTERNAL_ERROR E_ALLOC E_RANGE E_LUT E_RECURSE_LEVEL E_BAD_DIRFILE E_BAD_FIELD_TYPE E_ACCMODE E_UNSUPPORTED E_UNKNOWN_ENCODING E_BAD_ENTRY E_DUPLICATE E_DIMENSION E_BAD_INDEX E_BAD_SCALAR E_BAD_REFERENCE E_PROTECTED E_DELETE E_ARGUMENT E_CALLBACK E_EXISTS E_UNCLEAN_DB E_DOMAIN E_BAD_REPR E_BOUNDS E_LINE_TOO_LONG E_BAD_ENDIANNESS E_BAD_PROTECTION E_BAD_VERSION E_OPEN_LINFILE E_FLUSH E_OPEN E_OPEN_FRAGMENT E_OPEN_INCLUDE E_RAW_IO E_TRUNC RDONLY RDWR FORCE_ENDIAN BIG_ENDIAN LITTLE_ENDIAN CREAT EXCL TRUNC PEDANTIC FORCE_ENCODING VERBOSE IGNORE_DUPS IGNORE_REFS PRETTY_PRINT ARM_ENDIAN NOT_ARM_ENDIAN PERMISSIVE TRUNCSUB AUTO_ENCODED BZIP2_ENCODED FLAC_ENCODED GZIP_ENCODED LZMA_ENCODED SIE_ENCODED SLIM_ENCODED TEXT_ENCODED UNENCODED ZZSLIM_ENCODED ZZIP_ENCODED NO_ENTRY RAW_ENTRY LINCOM_ENTRY LINTERP_ENTRY BIT_ENTRY MULTIPLY_ENTRY PHASE_ENTRY INDEX_ENTRY POLYNOM_ENTRY SBIT_ENTRY DIVIDE_ENTRY RECIP_ENTRY WINDOW_ENTRY MPLEX_ENTRY CONST_ENTRY CARRAY_ENTRY STRING_ENTRY NULL UINT8 INT8 UINT16 INT16 UINT32 INT32 UINT64 INT64 FLOAT32 FLOAT64 COMPLEX64 COMPLEX128 DEL_META DEL_DATA DEL_DEREF DEL_FORCE REN_DATA REN_UPDB REN_DANGLE REN_FORCE PROTECT_NONE PROTECT_FORMAT PROTECT_DATA PROTECT_ALL SYNTAX_ABORT SYNTAX_RESCAN SYNTAX_IGNORE SYNTAX_CONTINUE E_FORMAT_BAD_SPF E_FORMAT_N_FIELDS E_FORMAT_N_TOK E_FORMAT_NUMBITS E_FORMAT_BITNUM E_FORMAT_BITSIZE E_FORMAT_CHARACTER E_FORMAT_BAD_LINE E_FORMAT_RES_NAME E_FORMAT_ENDIAN E_FORMAT_BAD_TYPE E_FORMAT_BAD_NAME E_FORMAT_UNTERM E_FORMAT_METARAW E_FORMAT_NO_PARENT E_FORMAT_DUPLICATE E_FORMAT_LOCATION E_FORMAT_PROTECT E_FORMAT_LITERAL E_FORMAT_WINDOP E_FORMAT_META_META E_FORMAT_ALIAS E_FORMAT_MPLEXVAL VERSION_CURRENT VERSION_LATEST VERSION_EARLIEST SEEK_SET SEEK_CUR SEEK_END SEEK_WRITE WINDOP_UNK WINDOP_EQ WINDOP_GE WINDOP_GT WINDOP_LE WINDOP_LT WINDOP_NE WINDOP_SET WINDOP_CLR DESYNC_PATHCHECK DESYNC_REOPEN ALL_ENTRIES VECTOR_ENTRIES SCALAR_ENTRIES ALIAS_ENTRIES ENTRIES_HIDDEN ENTRIES_NOALIAS EN_CALC EN_HIDDEN EN_COMPSCAL ALL_FRAGMENTS DEFAULT_LOOKBACK DIRFILE_STANDARDS_VERSION HERE LOOKBACK_ALL MAX_LINE_LENGTH )],
'constants' => [qw(VERSION E_OK E_FORMAT E_CREAT E_BAD_CODE E_BAD_TYPE E_IO E_INTERNAL_ERROR E_ALLOC E_RANGE E_LUT E_RECURSE_LEVEL E_BAD_DIRFILE E_BAD_FIELD_TYPE E_ACCMODE E_UNSUPPORTED E_UNKNOWN_ENCODING E_BAD_ENTRY E_DUPLICATE E_DIMENSION E_BAD_INDEX E_BAD_SCALAR E_BAD_REFERENCE E_PROTECTED E_DELETE E_ARGUMENT E_CALLBACK E_EXISTS E_UNCLEAN_DB E_DOMAIN E_BAD_REPR E_BOUNDS E_LINE_TOO_LONG E_BAD_ENDIANNESS E_BAD_PROTECTION E_BAD_VERSION E_OPEN_LINFILE E_FLUSH E_OPEN E_OPEN_FRAGMENT E_OPEN_INCLUDE E_RAW_IO E_TRUNC RDONLY RDWR FORCE_ENDIAN BIG_ENDIAN LITTLE_ENDIAN CREAT EXCL TRUNC PEDANTIC FORCE_ENCODING VERBOSE IGNORE_DUPS IGNORE_REFS PRETTY_PRINT ARM_ENDIAN NOT_ARM_ENDIAN PERMISSIVE TRUNCSUB AUTO_ENCODED BZIP2_ENCODED FLAC_ENCODED GZIP_ENCODED LZMA_ENCODED SIE_ENCODED SLIM_ENCODED TEXT_ENCODED UNENCODED ZZSLIM_ENCODED ZZIP_ENCODED NO_ENTRY RAW_ENTRY LINCOM_ENTRY LINTERP_ENTRY BIT_ENTRY MULTIPLY_ENTRY PHASE_ENTRY INDEX_ENTRY POLYNOM_ENTRY SBIT_ENTRY DIVIDE_ENTRY RECIP_ENTRY WINDOW_ENTRY MPLEX_ENTRY CONST_ENTRY CARRAY_ENTRY STRING_ENTRY NULL UINT8 INT8 UINT16 INT16 UINT32 INT32 UINT64 INT64 FLOAT32 FLOAT64 COMPLEX64 COMPLEX128 DEL_META DEL_DATA DEL_DEREF DEL_FORCE REN_DATA REN_UPDB REN_DANGLE REN_FORCE PROTECT_NONE PROTECT_FORMAT PROTECT_DATA PROTECT_ALL SYNTAX_ABORT SYNTAX_RESCAN SYNTAX_IGNORE SYNTAX_CONTINUE E_FORMAT_BAD_SPF E_FORMAT_N_FIELDS E_FORMAT_N_TOK E_FORMAT_NUMBITS E_FORMAT_BITNUM E_FORMAT_BITSIZE E_FORMAT_CHARACTER E_FORMAT_BAD_LINE E_FORMAT_RES_NAME E_FORMAT_ENDIAN E_FORMAT_BAD_TYPE E_FORMAT_BAD_NAME E_FORMAT_UNTERM E_FORMAT_METARAW E_FORMAT_NO_PARENT E_FORMAT_DUPLICATE E_FORMAT_LOCATION E_FORMAT_PROTECT E_FORMAT_LITERAL E_FORMAT_WINDOP E_FORMAT_META_META E_FORMAT_ALIAS E_FORMAT_MPLEXVAL VERSION_CURRENT VERSION_LATEST VERSION_EARLIEST SEEK_SET SEEK_CUR SEEK_END SEEK_WRITE WINDOP_UNK WINDOP_EQ WINDOP_GE WINDOP_GT WINDOP_LE WINDOP_LT WINDOP_NE WINDOP_SET WINDOP_CLR DESYNC_PATHCHECK DESYNC_REOPEN ALL_ENTRIES VECTOR_ENTRIES SCALAR_ENTRIES ALIAS_ENTRIES ENTRIES_HIDDEN ENTRIES_NOALIAS EN_CALC EN_HIDDEN EN_COMPSCAL ALL_FRAGMENTS DEFAULT_LOOKBACK DIRFILE_STANDARDS_VERSION HERE LOOKBACK_ALL MAX_LINE_LENGTH )], 'functions' => [qw(DESTROY add add_alias add_bit add_carray add_const add_divide add_lincom add_linterp add_mplex add_multiply add_phase add_polynom add_raw add_recip add_sbit add_spec add_string add_window alias_target aliases alter_affixes alter_bit alter_carray alter_const alter_divide alter_encoding alter_endianness alter_entry alter_frameoffset alter_lincom alter_linterp alter_mplex alter_multiply alter_phase alter_polynom alter_protection alter_raw alter_recip alter_sbit alter_spec alter_window array_len bof carray_len carrays close constants delete desync dirfile_standards dirfilename discard encoding endianness entry entry_list eof error error_count error_string field_list field_list_by_type flags flush fragment_affixes fragment_index fragmentname fragments framenum frameoffset get_carray get_carray_slice get_constant get_string getdata hidden hide include invalid_dirfile linterp_tablename madd madd_alias madd_bit madd_carray madd_const madd_divide madd_lincom madd_linterp madd_mplex madd_multiply madd_phase madd_polynom madd_recip madd_sbit madd_spec madd_string madd_window malter_spec mcarrays mconstants metaflush mfield_list mfield_list_by_type move mplex_lookback mstrings mvector_list native_type nframes open parent_fragment parser_callback protection put_carray put_carray_slice put_constant put_string putdata raw_close raw_filename reference rename rewrite_fragment seek spf strings strtok sync tell unhide uninclude validate vector_list verbose_prefix)]);
our @EXPORT_OK = (@{$EXPORT_TAGS{'all'}});
our @EXPORT = qw();
our $VERSION = 0.0900;
our $E_OK = 0;
our $E_FORMAT = 2;
our $E_CREAT = 4;
our $E_BAD_CODE = 5;
our $E_BAD_TYPE = 6;
our $E_IO = 7;
our $E_INTERNAL_ERROR = 9;
our $E_ALLOC = 10;
our $E_RANGE = 11;
our $E_LUT = 12;
our $E_RECURSE_LEVEL = 13;
our $E_BAD_DIRFILE = 14;
our $E_BAD_FIELD_TYPE = 15;
our $E_ACCMODE = 16;
our $E_UNSUPPORTED = 17;
our $E_UNKNOWN_ENCODING = 18;
our $E_BAD_ENTRY = 19;
our $E_DUPLICATE = 20;
our $E_DIMENSION = 21;
our $E_BAD_INDEX = 22;
our $E_BAD_SCALAR = 23;
our $E_BAD_REFERENCE = 24;
our $E_PROTECTED = 25;
our $E_DELETE = 26;
our $E_ARGUMENT = 27;
our $E_CALLBACK = 28;
our $E_EXISTS = 29;
our $E_UNCLEAN_DB = 30;
our $E_DOMAIN = 31;
our $E_BAD_REPR = 5;
our $E_BOUNDS = 35;
our $E_LINE_TOO_LONG = 36;
our $E_BAD_ENDIANNESS = 27;
our $E_BAD_PROTECTION = 27;
our $E_BAD_VERSION = 27;
our $E_OPEN_LINFILE = 12;
our $E_FLUSH = 7;
our $E_OPEN = 7;
our $E_OPEN_FRAGMENT = 7;
our $E_OPEN_INCLUDE = 7;
our $E_RAW_IO = 7;
our $E_TRUNC = 7;
our $RDONLY = 0;
our $RDWR = 1;
our $FORCE_ENDIAN = 2;
our $BIG_ENDIAN = 4;
our $LITTLE_ENDIAN = 8;
our $CREAT = 16;
our $EXCL = 32;
our $TRUNC = 64;
our $PEDANTIC = 128;
our $FORCE_ENCODING = 256;
our $VERBOSE = 512;
our $IGNORE_DUPS = 1024;
our $IGNORE_REFS = 2048;
our $PRETTY_PRINT = 4096;
our $ARM_ENDIAN = 8192;
our $NOT_ARM_ENDIAN = 0;
our $PERMISSIVE = 16384;
our $TRUNCSUB = 32768;
our $AUTO_ENCODED = 0;
our $BZIP2_ENCODED = 83886080;
our $FLAC_ENCODED = 167772160;
our $GZIP_ENCODED = 67108864;
our $LZMA_ENCODED = 100663296;
our $SIE_ENCODED = 117440512;
our $SLIM_ENCODED = 50331648;
our $TEXT_ENCODED = 33554432;
our $UNENCODED = 16777216;
our $ZZSLIM_ENCODED = 150994944;
our $ZZIP_ENCODED = 134217728;
our $NO_ENTRY = 0;
our $RAW_ENTRY = 1;
our $LINCOM_ENTRY = 2;
our $LINTERP_ENTRY = 3;
our $BIT_ENTRY = 4;
our $MULTIPLY_ENTRY = 5;
our $PHASE_ENTRY = 6;
our $INDEX_ENTRY = 7;
our $POLYNOM_ENTRY = 8;
our $SBIT_ENTRY = 9;
our $DIVIDE_ENTRY = 10;
our $RECIP_ENTRY = 11;
our $WINDOW_ENTRY = 12;
our $MPLEX_ENTRY = 13;
our $CONST_ENTRY = 16;
our $CARRAY_ENTRY = 18;
our $STRING_ENTRY = 17;
our $NULL = 0;
our $UINT8 = 1;
our $INT8 = 33;
our $UINT16 = 2;
our $INT16 = 34;
our $UINT32 = 4;
our $INT32 = 36;
our $UINT64 = 8;
our $INT64 = 40;
our $FLOAT32 = 132;
our $FLOAT64 = 136;
our $COMPLEX64 = 264;
our $COMPLEX128 = 272;
our $DEL_META = 1;
our $DEL_DATA = 2;
our $DEL_DEREF = 4;
our $DEL_FORCE = 8;
our $REN_DATA = 1;
our $REN_UPDB = 2;
our $REN_DANGLE = 4;
our $REN_FORCE = 8;
our $PROTECT_NONE = 0;
our $PROTECT_FORMAT = 1;
our $PROTECT_DATA = 2;
our $PROTECT_ALL = 3;
our $SYNTAX_ABORT = 0;
our $SYNTAX_RESCAN = 1;
our $SYNTAX_IGNORE = 2;
our $SYNTAX_CONTINUE = 3;
our $E_FORMAT_BAD_SPF = 1;
our $E_FORMAT_N_FIELDS = 2;
our $E_FORMAT_N_TOK = 3;
our $E_FORMAT_NUMBITS = 4;
our $E_FORMAT_BITNUM = 5;
our $E_FORMAT_BITSIZE = 6;
our $E_FORMAT_CHARACTER = 7;
our $E_FORMAT_BAD_LINE = 8;
our $E_FORMAT_RES_NAME = 9;
our $E_FORMAT_ENDIAN = 10;
our $E_FORMAT_BAD_TYPE = 11;
our $E_FORMAT_BAD_NAME = 12;
our $E_FORMAT_UNTERM = 13;
our $E_FORMAT_METARAW = 14;
our $E_FORMAT_NO_PARENT = 15;
our $E_FORMAT_DUPLICATE = 16;
our $E_FORMAT_LOCATION = 17;
our $E_FORMAT_PROTECT = 18;
our $E_FORMAT_LITERAL = 19;
our $E_FORMAT_WINDOP = 20;
our $E_FORMAT_META_META = 21;
our $E_FORMAT_ALIAS = 22;
our $E_FORMAT_MPLEXVAL = 23;
our $VERSION_CURRENT = -1;
our $VERSION_LATEST = -2;
our $VERSION_EARLIEST = -3;
our $SEEK_SET = 0;
our $SEEK_CUR = 1;
our $SEEK_END = 2;
our $SEEK_WRITE = 4;
our $WINDOP_UNK = 0;
our $WINDOP_EQ = 1;
our $WINDOP_GE = 2;
our $WINDOP_GT = 3;
our $WINDOP_LE = 4;
our $WINDOP_LT = 5;
our $WINDOP_NE = 6;
our $WINDOP_SET = 7;
our $WINDOP_CLR = 8;
our $DESYNC_PATHCHECK = 1;
our $DESYNC_REOPEN = 2;
our $ALL_ENTRIES = 0;
our $VECTOR_ENTRIES = 33;
our $SCALAR_ENTRIES = 34;
our $ALIAS_ENTRIES = -1;
our $ENTRIES_HIDDEN = 1;
our $ENTRIES_NOALIAS = 2;
our $EN_CALC = 2;
our $EN_HIDDEN = 4;
our $EN_COMPSCAL = 1;
our $ALL_FRAGMENTS = -1;
our $DEFAULT_LOOKBACK = 10;
our $DIRFILE_STANDARDS_VERSION = 9;
our $HERE = -1;
our $LOOKBACK_ALL = -1;
our $MAX_LINE_LENGTH = 4096;
XSLoader::load('GetData', $VERSION);
1;
__END__
=head1 NAME
GetData - Perl bindings to the GetData library for Dirfile access
=head1 SYNOPSIS
use GetData;
my $DIRFILE = GetData::open("./dirfile/", $GetData::RDONLY);
# the following calls are equivalent
my $data = GetData::getdata($DIRFILE, "field", 5, 0, 1,
$GetData::UINT8);
my $data = $DIRFILE->getdata("field", 5, 0, 1, $GetData::UINT8);
=head1 DESCRIPTION
This module provides simple, lightweight bindings from Perl to the C GetData
library. It provides a simple mapping between public C functions and Perl
methods. All C functions and constants are replicated in the GetData package.
These methods have the same name as their C counterparts, excluding the C
namespace prefix `gd_' (or `GD_', for C preprocessor constants).
The dirfile lvalue returned by GetData::open is a simplistic object. Any
GetData method which takes a dirfile as a parameter, may instead be called as
method of the dirfile object itself. (See the synopsis above for an example.)
Dirfile metadata entries (which are C structs of type gd_entry_t) are
represented as simple hashes.
By default, GetData does not export any symbols. All symbols in the GetData
package may be exported with:
use GetData "all";
but this is discouraged, as it will overwrite useful things like &CORE::open.
Throughout the module, complex data are generally represented as
C<Math::Complex> objects, but may be simplified to ordinary floating point
numbers if the imaginary part is zero.
=head1 CONSTANTS
The module defines a large number of symbolic constants used by the API which
mirror the constants defined in the C API. The "constants" tag may be used to
export just the constants from the module, if desired. Some genericly useful
sets of constants are discussed below. Other constants are discussed in the
method descriptions where they are used.
=head2 Data Types
GetData knows the following data types:
=over
=item $GetData::NULL
the null data type, which returns no data.
=item $GetData::UINT8
unsigned 8-bit integer
=item $GetData::INT8
signed (two's complement) 8-bit integer
=item $GetData::UINT16
unsigned 16-bit integer
=item $GetData::INT16
signed (two's complement) 16-bit integer
=item $GetData::UINT32
unsigned 32-bit integer
=item $GetData::INT32
signed (two's complement) 32-bit integer
=item $GetData::UINT64
unsigned 64-bit integer
=item $GetData::INT64
signed (two's complement) 64-bit integer
=item $GetData::FLOAT32
IEEE-754 standard 32-bit single precision floating point number
=item $GetData::FLOAT64
IEEE-754 standard 64-bit double precision floating point number
=item $GetData::COMPLEX64
FORTRAN and C99 conformant 64-bit single precision floating point complex number
=item $GetData::COMPLEX128
FORTRAN and C99 conformant 128-bit double precision floating point complex
number
=back
=head2 Encoding Types
The following encoding types are known by GetData:
=over
$GetData::BZIP2_ENCODED,
$GetData::FLAC_ENCODED,
$GetData::GZIP_ENCODED,
$GetData::LZMA_ENCODED,
$GetData::SIE_ENCODED,
$GetData::SLIM_ENCODED,
$GetData::TEXT_ENCODED,
$GetData::ZZIP_ENCODED,
$GetData::ZZSLIM_ENCODED,
$GetData::UNENCODED.
=back
Details of these encoding types are given in the dirfile-format(5) manual page.
=head2 Entry Types
The following symbols are used to indicate entry types:
=over
$GetData::NO_ENTRY,
$GetData::BIT_ENTRY,
$GetData::CARRAY_ENTRY,
$GetData::CONST_ENTRY,
$GetData::DIVIDE_ENTRY,
$GetData::INDEX_ENTRY,
$GetData::LINCOM_ENTRY,
$GetData::LINTERP_ENTRY,
$GetData::MPLEX_ENTRY,
$GetData::MULTIPLY_ENTRY,
$GetData::PHASE_ENTRY,
$GetData::POLYNOM_ENTRY,
$GetData::RAW_ENTRY,
$GetData::RECIP_ENTRY,
$GetData::SBIT_ENTRY,
$GetData::STRING_ENTRY,
$GetData::WINDOW_ENTRY
=back
Of these, C<$GetData::NO_ENTRY> is used to flag invalid entry types and
C<$GetData::INDEX_ENTRY> is used only for the implicit B<INDEX> field. See
gd_entry(3) and dirfile-format(5) for details of the other entry types.
=head2 WINDOW Operators
The following symbols are used to indicate WINDOW operators:
=over
$GetData::WINDOP_EQ,
$GetData::WINDOP_GE,
$GetData::WINDOP_GT,
$GetData::WINDOP_LE,
$GetData::WINDOP_LT,
$GetData::WINDOP_NE,
$GetData::WINDOP_CLR,
$GetData::WINDOP_SET.
=back
=head1 INPUT DATA
Functions which take sets of data as input (L<add_carray>, L<madd_carray>,
L<put_carray>, L<put_carray_slice>, and L<putdata>) accept data in a number of
ways. The arguments specifying the data always appear at the end of the
argument list. They are represented as C<{DATA...}> in the method descriptions
below. Input data arguments are parsed as follows.
=over
=item 1.
If the first data argument is undef, then it is ignored and all subsequent
arguments are taken as data:
$dirfile->putdata("field_code", $first_frame, $first_sample,
undef, @data)
or
$dirfile->putdata("field_code", $first_frame, $first_sample,
undef, $data[0], $data[1], $data[2], ...)
=item 2.
Otherwise, if the first data argument is a reference to an array, the array is
taken as data (and any further arguments are ignored):
$dirfile->putdata("field_code", $first_frame, $first_sample,
\@data)
=item 3.
Otherwise, if only two arguments make up the data argument list, and the second
is a reference to an array, the first is taken as a type code specifing the
conversion type, and the second is taken as the data:
$dirfile->putdata("field_code", $first_frame, $first_sample,
$GetData::UINT8, \@data)
=item 4.
Otherwise, if only two arguments make up the data argument list, and the second
is not a reference to an array, the first is, again, taken as a type code, and
the second is assumed to be a packed string containing the data in a format
appropriate for the type code specified:
$packed_data = pack("C", @data)
$dirfile->putdata("field_code", $first_frame, $first_sample,
$GetData::UINT8, $packed_data)
=item 5.
Otherwise, finally, the data argument list elements are simply taken as data
themselves:
$dirfile->putdata("field_code", $first_frame, $first_sample,
@data)
or
$dirfile->putdata("field_code", $first_frame, $first_sample,
$data[0], $data[1], $data[2], ...)
=back
GetData internally converts the Perl data into a format readable by the C API.
In cases 3 and 4 above, the type the data is converted into is specified
explicitly in the call. In the other cases, GetData must guess an appropriate
C type into which to convert the data. It does so by looking at the first
data value:
=over
=item *
if the value is a C<Math::Complex> object, the data are converted to double
precision complex data (C<COMPLEX128>)
=item *
if the value is an integer, the data are converted to a 64-bit signed integer
(C<INT64>)
=item *
otherwise, the data are converted to a double precision float (C<FLOAT64>).
=back
Of the above methods, the first is only necessary when the data array has only
two elements, and so would be mistaken for method four if specified without the
initial undef. Furthermore, the fourth method is typically the most efficient,
since the packed data scalar can often be used as the input to the C API without
need for type conversion.
=head1 ENTRY HASHES
The replacement for the C<gd_entry_t> object of the C API is a simple hash. The
key names are the same as the names of the C<gd_entry_t> members. (See
gd_entry(3) for details).
In entry hashes returned by GetData, only those keys appropriate for the entry
type specified will be present. Entry hashes passed to GetData from the caller
may have other keys than those required by the entry type. They will be
ignored.
The value associated with the C<field_type> key will be one of the symbols
listed under L</"Entry Types"> above. For entry types which have (potentially)
more than one input field (DIVIDE, LINCOM, MPLEX, MULTIPLY, WINDOW), the value
associated with the C<"in_fields"> key will be a list of strings, regardless of
how many elements it has; other entry types which provide C<"in_fields"> will be
a scalar, even though the key name is still plural.
Elements of the C<scalar> array which are undef indicate literal parameters
(equivalent to C<NULL> in the C<gd_entry_t>'s C<scalar> member). Similarly,
undef is used in C<scalar_ind> where the C API uses -1, to indicate CONST
fields, instead of CARRAYs.
=head1 NON-MEMBER FUNCTIONS
=over
=item encoding_support ($ENCODING)
Returns C<$GetData::RDWR> if the library can both read and write the specified
encoding, C<$GetData::RDONLY> if it can only read, or -1 otherwise.
C<$ENCODING> should be one of the encoding symbols listed above in the
L</"Encoding Types"> section.
=back
=head1 DIRFILE CREATION METHODS
=over
=item open ($DIRFILENAME, $FLAGS, $SEHANDLER=undef, $EXTRA=undef)
Create or open a Dirfile database called C<$DIRFILENAME>. C<$FLAGS> should be
either C<$GetData::RDONLY> (for read-only access) or C<$GetData::RDWR> (for
read-write access), optionally bitwise or'd with any of the following flags:
=over
$GetData::ARM_ENDIAN,
$GetData::BIG_ENDIAN,
$GetData::CREAT,
$GetData::EXCL,
$GetData::FORCE_ENCODING,
$GetData::FORCE_ENDIAN,
$GetData::IGNORE_DUPS,
$GetData::IGNORE_REFS,
$GetData::LITTLE_ENDIAN,
$GetData::NOT_ARM_ENDIAN,
$GetData::PEDANTIC,
$GetData::PERMISSIVE,
$GetData::PRETTY_PRINT,
$GetData::TRUNC,
$GetData::TRUNCSUB,
$GetData::VERBOSE,
=back
and at most one of the encoding symbols listed above in the L</"Encoding Types">
section or else C<$GetData::AUTO_ENCODED> indicating that GetData should attempt
to automatically determine the encoding. The meaning of the dirfile flags
may be found in the gd_cbopen(3) manual page.
$SEHANDLER is a Perl callback function which will be executed whenever a syntax
error is encountered. It may be undef, if no callback is desired. When
called, C<$SEHANDLER> will be passed two arguments. The first is a reference to
a hash containing the parser data. The second is the C<$EXTRA> scalar passed to
this method. C<$SEHANDLER> is called in scalar context, and should return
either:
=over
=item *
an integer, one of the symbolic constants:
=over
$GetData::SYNTAX_ABORT,
$GetData::SYNTAX_CONTINUE,
$GetData::SYNTAX_IGNORE,
$GetData::SYNTAX_RESCAN;
=back
(see gd_cbopen(3) for their meaning), or
=item *
a string containing the corrected line, in which case C<$GetData::SYNTAX_RESCAN>
is assumed; or,
=item *
a reference to a list consisting of an integer, one of the
C<$GetData::SYNTAX_...> constants listed above, and then, optionally, a string
containing the corrected line.
=back
This function always returns a Dirfile object, even if the call failed;
the caller should use the returned dirfile's L<error>() method to test for
success. On error, the returned object will be flagged as invalid.
=item invalid_dirfile ()
This function always returns a newly created, but invalid, Dirfile object.
Unlike an invalid dirfile created (either accidentally or purposefully) using
L<open>(), the dirfile returned by this function always has a zero error code.
See gd_invalid_dirfile(3).
=back
=head1 DIRFILE OBJECT METHODS
The following methods all operate on a dirfile object returned by one of the
above methods and can either be called as:
$GetData::method($dirfile, ...)
or else, as
$dirfile->method(...)
without change in operation.
=head2 List of Methods
=over
=item $dirfile->add_carray ($FIELD_NAME, $DATA_TYPE, $FRAGMENT_INDEX,
{DATA...})
Adds a new CARRAY field called C<$FIELD_NAME> to the metadata fragment indexed
by C<$FRAGMENT_INDEX>. The storage type of the CARRAY is given by
C<$DATA_TYPE>, which should be one of the symbols listed above under
L</"Data Types">. The value of the CARRAY is then set to the data given in
the C<{DATA...}> argument list, which also determines its length. See the
L</"Input Data"> section above for details on the allowed forms of C<{DATA...}>.
See gd_add_carray(3).
=item $dirfile->add_const ($FIELD_NAME, $DATA_TYPE, [$VALUE, $FRAGMENT_INDEX])
Adds a new CONST field called C<$FIELD_NAME> to the metadata fragment indexed
by C<$FRAGMENT_INDEX>, or to the primary format file if omitted. The
C<$DATA_TYPE> argument indicates the storage type, which should be one of the
symbols listed above under L</"Data Types">. If given, the value of the field
is set to C<$VALUE>, otherwise the field will be initialised to zero. See
gd_add_const(3).
=item $dirfile->aliases ($FIELD_CODE)
In scalar context, returns the number of aliases of C<$FIELD_CODE>. In list
context, returns an array of alias names for C<$FIELD_CODE>. See gd_naliases(3)
and gd_aliases(3).
=item $dirfile->carrays ($RETURN_TYPE)
Returns the value of all carrays (excluding metafields) in the dirfile after
converting them to the return type C<$RETURN_TYPE>, which should be one of the
symbols listed under L</"Data Types"> above. If called in scalar context,
returns a reference to an array of packed string data. If called in list
context, returns an array of arrays of unpacked data. See gd_carrays(3).
=item $dirfile->close ()
Closes the dirfile, writing changes to disk. Upon successful completion, the
dirfile object will be invalidated, prohibiting further operation on it. A
dirfile which is destroyed by garbage collection is discarded (see L</"discard">
below). This function should be called if metadata need to be written to disk
before the object goes out of scope. See gd_close(3).
=item $dirfile->constants ($RETURN_TYPE)
Returns the value of all constants (excluding metafields) in the dirfile after
converting them to the return type C<$RETURN_TYPE>, which should be one of the
symbols listed under L</"Data Types"> above. If called in scalar context,
returns a packed string containing the data. If called in list context, the
data will be unpacked and returned as an array. See gd_constants(3).
=item $dirfile->discard ()
Closes the dirfile, ignoring changes to metadata, but writing changed data to
disk. Upon successful completion, the dirfile object will be invalidated,
prohibiting further operation on it. This function is called automatically by
the dirfile destructor, and need not be called explicitly. To save the metadata
on close, use L</close>. See gd_discard(3).
=item $dirfile->entry ($FIELD_CODE)
If called in scalar context, returns the entry type of C<$FIELD_CODE>, one
of the symbols listed above under L</"Entry Types">. In array context, returns
a hash describing the indicated field. See gd_entry_type(3) and gd_entry(3).
=item $dirfile->entry_list ($PARENT, $TYPE, $FLAGS)
In scalar context, returns the number of entries matching the supplied criteria.
In list context, returns an array of the names of the entries. If C<$PARENT>
is undef, top-level entries are considered, otherwise meta entries under
C<$PARENT> are considered. If C<$TYPE> is one of the entry types listed above
under L</"Entry Types">, only entries of that type are considered. Alternatley,
C<$TYPE> may be one of:
=over
$GetData::ALL_ENTRIES,
$GetData::SCALAR_ENTRIES,
$GetData::VECTOR_ENTRIES.
=back
Setting C<$TYPE> to undef is equivalent to setting it to
C<$GetData::ALL_ENTRIES>. If not undef, which is treated as zero, C<$FLAGS>
should be zero or more of the following flags:
=over
$GetData::ENTRIES_HIDDEN,
$GetData::ENTRIES_NOALIAS.
=back
See gd_nentries(3) and gd_entry_list(3) for the meaning of these symbols.
=item $dirfile->error ()
Returns the error code of the last operation on this dirfile. See gd_error(3).
=item $dirfile->error_string ()
Returns a string describing the error encountered (if any) by the last operation
on this dirfile. See gd_error_string(3).
=item $dirfile->field_list ()
Equivalent to: C<$dirfile-E<gt>entry_list(undef, undef, undef)>.
=item $dirfile->field_list_by_type ($TYPE)
Equivalent to: C<$dirfile-E<gt>entry_list(undef, $TYPE, undef)>.
=item $dirfile->fragment_affixes ($FRAGMENT_INDEX)
Returns an array containing the prefix (first) and suffix (second) of the
fragment indexed by C<$FRAGMENT_INDEX>. See gd_fragment_affixes(3).
=item $dirfile->fragments ()
In scalar context, returns the number of metadata fragments in the dirfile.
In list context, returns an array of pathnames to the fragments on disk, in the
order that they're indexed. See gd_nfragments(3) and gd_fragmentname(3).
=item $dirfile->get_carray ($FIELD_CODE, $RETURN_TYPE)
Returns the value of the CARRAY named C<$FIELD_CODE> after converting its
elements to the return type C<$RETURN_TYPE>, which should be one of the symbols
listed under L</"Data Types"> above. If called in scalar context, returns a
packed string containing the data. If called in list context, the data will be
unpacked and returned as an array. See gd_get_carray(3).
=item $dirfile->get_carray_slice ($FIELD_CODE, $START, $LEN, $RETURN_TYPE)
Returns the value of a portion of the CARRAY named C<$FIELD_CODE> after
converting its elements to the return type C<$RETURN_TYPE>, which should be one
of the symbols listed under L</"Data Types"> above. The first element returned
is given by C<$START>, and the number of elements by C<$LEN>. If called in
scalar context, returns a packed string containing the data. If called in list
context, the data will be unpacked and returned as an array. Less data than
requested may be returned, if insufficient data exists. See
gd_get_carray_slice(3).
=item $dirfile->get_constant ($FIELD_CODE, $RETURN_TYPE)
Returns the value of the CONST named C<$FIELD_CODE> after converting it to the
return type C<$RETURN_TYPE>, which should be one of the symbols listed under
L</"Data Types"> above. See gd_get_constant(3).
=item $dirfile->getdata ($FIELD_CODE, $FIRST_FRAME, $FIRST_SAMP, $NUM_FRAMES,
$NUM_SAMP, $RETURN_TYPE)
Returns data from the field specified by C<$FIELD_CODE> after converting them
to the return type C<$RETURN_TYPE>, which should be one of the symbols listed
under L</"Data Types"> above. The first sample returned is C<$FIRST_SAMP>
samples after the start of C<$FIRST_FRAME> and the amount of data returned is
C<$NUM_FRAMES> frames plus C<$NUM_SAMP> samples. If called in scalar context
returns a string of packed data. If called in array context, the data will be
unpacked and returned as an array. Complex data are returned as
C<Math::Complex> objects. See gd_getdata(3).
=item $dirfile->get_string ($FIELD_CODE)
Returns the value of the STRING named C<$FIELD_CODE>. See gd_get_string(3).
=item $dirfile->include ($FILE, $PARENT_FRAGMENT, $FLAGS, [$PREFIX, $SUFFIX])
Includes the fragment metadata file C<$FILE> under the fragment indexed by
C<$PARENT_FRAGMENT>. C<$FLAGS> should be a bitwise or'd collection of zero or
more of the following flags:
=over
$GetData::BIG_ENDIAN,
$GetData::CREAT,
$GetData::EXCL,
$GetData::FORCE_ENCODING,
$GetData::FORCE_ENDIAN,
$GetData::IGNORE_DUPS,
$GetData::IGNORE_REFS,
$GetData::LITTLE_ENDIAN,
$GetData::PEDANTIC,
$GetData::TRUNC,
=back
and at most one of the encoding symbols listed above in the L</"Encoding Types">
section or else C<$GetData::AUTO_ENCODED> indicating that GetData should attempt
to automatically determine the encoding. If C<$PREFIX> or C<$SUFFIX> are
omitted or undef, the added fragment will contain no such affix. See
gd_include_affix(3).
=item $dirfile->madd_carray ($PARENT, $FIELD_NAME, $DATA_TYPE, {DATA...})
Adds a new CARRAY metafield called C<$FIELD_NAME> under the parent field
C<$PARENT>. The storage type of the CARRAY is given by C<$DATA_TYPE>, which
should be one of the symbols listed above under L</"Data Types">. The value of
the CARRAY is then set to the data given in the C<{DATA...}> argument list,
which also determines its length. See the L</"Input Data"> section above for
details on the allowed forms of C<{DATA...}>. See gd_madd_carray(3).
=item $dirfile->madd_const ($PARENT, $FIELD_NAME, $DATA_TYPE, [$VALUE])
Adds a new CONST metafield called C<$FIELD_NAME> under the field C<$PARENT>.
The C<$DATA_TYPE> argument indicates the storage type, which should be one of
the symbols listed above under L</"Data Types">. If given, the value of the
field is set to C<$VALUE>, otherwise the field will be initialised to zero.
See gd_madd_const(3).
=item $dirfile->mcarrays ($PARENT, $RETURN_TYPE)
Behaves analogously to L<carrays>() (I<q.v.>), but returns CARRAYs which are
metafields under the parent specified by C<$PARENT>.
=item $dirfile->mconstants ($PARENT, $RETURN_TYPE)
Behaves analogously to L<constants>() (I<q.v.>), but returns CONSTs which are
metafields under the parent specified by C<$PARENT>.
=item $dirfile->mfield_list ($PARENT)
Equivalent to C<$dirfile-E<gt>entry_list($PARENT, undef, undef)>.
=item $dirfile->mfield_list_by_type ($PARENT, $TYPE)
Equivalent to C<$dirfile-E<gt>entry_list($PARENT, $TYPE, undef)>.
=item $dirfile->mstrings ($PARENT)
Behaves analogously to L<strings>() (I<q.v.>), but returns STRINGs which are
metafields under the parent specified by C<$PARENT>.
=item $dirfile->mvector_list ($PARENT)
Equivalent to:
$dirfile-E<gt>entry_list($PARENT, $GetData::VECTOR_ENTRIES, undef).
=item $dirfile->parser_callback ($SEHANDLER, $EXTRA=undef)
Sets the registered parser callback function for the dirfile to C<$SEHANDLER>,
or to nothing if undef, and updates the C<$EXTRA> parameter. See
gd_parser_callback(3).
=item $dirfile->put_carray ($FIELD_CODE, {DATA...})
Sets the value of the CARRAY named C<$FIELD_CODE> to the values contained in
the C<{DATA...}> argument list. See the L</"Input Data"> section above for
details on the allowed forms of C<{DATA...}>. See gd_put_carray(3).
=item $dirfile->put_carray_slice ($FIELD_CODE, $START, {DATA...})
Sets a value of the portion of the CARRAY named C<$FIELD_CODE> beginning with
element numbered C<$START> to the values contained in the C<{DATA...}> argument
list. See the L</"Input Data"> section above for details on the allowed forms
of C<{DATA...}>. See gd_put_carray_slice(3).
=item $dirfile->put_constant ($FIELD_CODE, $DATUM)
Sets the value of the CONST field C<$FIELD_CODE> to the value C<$DATUM>. See
gd_put_constant(3).
=item $dirfile->putdata ($FIELD_CODE, $FIRST_FRAME, $FIRST_SAMPLE, {DATA...})
Sets a portion of the vector given by C<$FIELD_CODE> to the values contained in
the C<{DATA...}> argument list. The first sample written is C<$FIRST_SAMPLE>
samples after the start of C<$FIRST_FRAME>. See the L</"Input Data"> section
above for details on the allowed forms of C<{DATA...}>. See gd_putdata(3).
=item $dirfile->strings ()
In scalar context, returns the number of STRING fields. In list context,
returns an array of strings containing the values of all the STRING fields.
See gd_strings(3).
=item $dirfile->strtok ($STRING)
Tokenises C<$STRING>, returning an array of tokens. See gd_strtok(3).
=item $dirfile->vector_list ()
Equivalent to:
$dirfile-E<gt>entry_list(undef, $GetData::VECTOR_ENTRIES, undef).
=back
=head2 Other Methods
For the most part, following methods behave identically to their C API
counterpart. See the corresponding C API manual page for details. Different
behaviour, if any, is indicated.
=over
=item $dirfile->add ($ENTRY)
C<$ENTRY> should be a reference to an entry hash; see L</"ENTRY HASHES"> above.
=item $dirfile->add_alias ($FIELD_CODE, $TARGET, [$FRAGMENT_INDEX])
C<$FRAGMENT_INDEX> = 0 is assumed if not specified.
=item $dirfile->add_bit ($FIELD_CODE, $IN_FIELD, $BITNUM, $NUMBITS,
[$FRAGMENT_INDEX])
C<$FRAGMENT_INDEX> = 0 is assumed if not specified.
=item $dirfile->add_divide ($FIELD_CODE, $IN_FIELD1, $IN_FIELD2,
[$FRAGMENT_INDEX])
C<$FRAGMENT_INDEX> = 0 is assumed if not specified.
=item $dirfile->add_lincom ($FIELD_CODE, $N_FIELDS, $IN_FIELDS, $M, $B,
[$FRAGMENT_INDEX])
C<$IN_FIELDS>, C<$M>, and C<$B> should be references to arrays of the
appropriate length. The elements of C<$M> and C<$B> may be of any numerical
type, including C<Math::Complex>. C<$FRAGMENT_INDEX> = 0 is assumed if not
specified.
=item $dirfile->add_linterp ($FIELD_CODE, $IN_FIELD, $TABLE, [$FRAGMENT_INDEX])
C<$FRAGMENT_INDEX> = 0 is assumed if not specified.
=item $dirfile->add_mplex ($FIELD_CODE, $IN_FIELD, $COUNT_FIELD, $COUNT_VAL,
$COUNT_MAX, [$FRAGMENT_INDEX])
C<$FRAGMENT_INDEX> = 0 is assumed if not specified.
=item $dirfile->add_multiply ($FIELD_CODE, $IN_FIELD1, $IN_FIELD2,
[$FRAGMENT_INDEX])
C<$FRAGMENT_INDEX> = 0 is assumed if not specified.
=item $dirfile->add_phase ($FIELD_CODE, $IN_FIELD, $SHIFT, [$FRAGMENT_INDEX])
C<$FRAGMENT_INDEX> = 0 is assumed if not specified.
=item $dirfile->add_polynom ($FIELD_CODE, $POLY_ORD, $IN_FIELD, $A,
[$FRAGMENT_INDEX])
C<$A> should be a reference to an array of numbers (of any numerical type,
including C<Math::Complex>) of the appropriate length. C<$FRAGMENT_INDEX> = 0
is assumed if not specified.
=item $dirfile->add_raw ($FIELD_CODE, $DATA_TYPE, $SPF, [$FRAGMENT_INDEX])
C<$DATA_TYPE> should be one of the symbols listed under L</"Data Types"> above.
C<$FRAGMENT_INDEX> = 0 is assumed if not specified.
=item $dirfile->add_recip ($FIELD_CODE, $IN_FIELD, $DIVIDEND, [$FRAGMENT_INDEX])
C<$DIVIDEND> may be of any numerical type, including C<Math::Complex>.
C<$FRAGMENT_INDEX> = 0 is assumed if not specified.
=item $dirfile->add_sbit ($FIELD_CODE, $IN_FIELD, $BITNUM, $NUMBITS,
[$FRAGMENT_INDEX])
C<$FRAGMENT_INDEX> = 0 is assumed if not specified.
=item $dirfile->add_spec ($LINE, [$FRAGMENT_INDEX])
C<$FRAGMENT_INDEX> = 0 is assumed if not specified.
=item $dirfile->add_string ($FIELD_CODE, $VALUE, [$FRAGMENT_INDEX])
C<$FRAGMENT_INDEX> = 0 is assumed if not specified.
=item $dirfile->add_window ($FIELD_CODE, $IN_FIELD, $CHECK_FIELD, $WINDOP,
$THRESHOLD, [$FRAGMENT_INDEX])
C<$WINDOP> should be one of the symbols listed under L</WINDOW Operators> above.
C<$FRAGMENT_INDEX> = 0 is assumed if not specified.
=item $dirfile->alias_target ($FIELD_CODE)
Z<>
=item $dirfile->alter_affixes ($FRAGMENT_INDEX, $PREFIX, [$SUFFIX])
If C<$PREFIX> or C<$SUFFIX> are undef, or if C<$SUFFIX> is omitted, that
affix is not changed.
=item $dirfile->alter_bit ($FIELD_CODE, [$IN_FIELD, $BITNUM, $NUMBITS])
Arguments not given or set to undef are not changed.
Additionally, if C<$BITNUM == -1>, or C<$NUMBITS == 0>, that parameter is not
changed.
=item $dirfile->alter_carray ($FIELD_CODE, $CONST_TYPE, $ARRAY_LEN)
C<$CONST_TYPE> should be one of the symbols listed under L</"Data Types"> above.
=item $dirfile->alter_const ($FIELD_CODE, [$CONST_TYPE])
If C<$CONST_TYPE> is omitted, or equal to C<$GetData::NULL>, it is not changed;
otherwise, it should be one of the symbols listed under L</"Data Types"> above.
=item $dirfile->alter_divide ($FIELD_CODE, [$IN_FIELD1, $IN_FIELD2])
Arguments not given or set to undef are not changed.
=item $dirfile->alter_encoding ($ENCODING, [$FRAGMENT_INDEX, $RECODE])
Both C<$FRAGMENT_INDEX> and C<$RECODE> default to 0 if not given.
=item $dirfile->alter_endianness ($BYTE_SEX, [$FRAGMENT_INDEX, $RECODE])
Both C<$FRAGMENT_INDEX> and C<$RECODE> default to 0 if not given.
=item $dirfile->alter_entry ($FIELD_CODE, $ENTRY, [$RECODE])
C<$ENTRY> should be a reference to an entry hash; see L</"ENTRY HASHES"> above.
If not given, C<$RECODE> defaults to 0.
=item $dirfile->alter_frameoffset ($OFFSET, [$FRAGMENT_INDEX, $RECODE])
Both C<$FRAGMENT_INDEX> and C<$RECODE> default to 0 if not given.
=item $dirfile->alter_lincom ($FIELD_CODE, [$N_FIELDS, $IN_FIELDS, $M, $B])
Arguments not given or set to undef are not changed.
If given, C<$IN_FIELDS>, C<$M>, and C<$B> should be references to arrays of the
appropriate length.
=item $dirfile->alter_linterp ($FIELD_CODE, [$IN_FIELD, $TABLE, $RENAME_TABLE])
Arguments not given or set to undef are not changed.
If not given, C<$RENAME_TABLE> defaults to 0.
=item $dirfile->alter_mplex ($FIELD_CODE, [$IN_FIELD, $COUNT_FIELD, $COUNT_VAL,
$COUNT_MAX])
Arguments not given or set to undef are not changed.
Additionally, if C<$COUNT_VAL> or C<$COUNT_MAX> are -1, that parameter is not
chaged.
=item $dirfile->alter_multiply ($FIELD_CODE, [$IN_FIELD1, $IN_FIELD2])
Arguments not given or set to undef are not changed.
=item $dirfile->alter_phase ($FIELD_CODE, $IN_FIELD, $SHIFT)
If C<$IN_FIELD == undef>, it is not changed.
=item $dirfile->alter_polynom ($FIELD_CODE, [$POLY_ORD, $IN_FIELD, $A])
Arguments not given or set to undef are not changed.
Additionally, if C<$POLY_ORD == 0>, it is not changed.
=item $dirfile->alter_protection ($PROTECTION_LEVEL, $FRAGMENT_INDEX)
Z<>
=item $dirfile->alter_raw ($FIELD_CODE, [$DATA_TYPE, $SPF, $RECODE])
Arguments not given or set to undef are not changed.
Additionally, if C<$DATA_TYPE == $GetData::NULL> or C<$SPF == 0>, that parameter
is not changed.
If not given, C<$RECODE> defaults to 0.
=item $dirfile->alter_recip ($FIELD_CODE, [$IN_FIELD, $DIVIDEND])
Arguments not given or set to undef are not changed.
Additionally, if C<$DIVIDEND == 0>, it is not changed.
C<$DIVIDEND> may be of any numerical type, including C<Math::Complex>.
=item $dirfile->alter_sbit ($FIELD_CODE, [$IN_FIELD, $BITNUM, $NUMBITS])
Arguments not given or set to undef are not changed.
Additionally, if C<$BITNUM == -1>, or C<$NUMBITS == 0>, that parameter is not
changed.
=item $dirfile->alter_spec ($LINE, [$RECODE])
If not given, C<$RECODE> defaults to 0.
=item $dirfile->alter_window ($FIELD_CODE, $IN_FIELD, $CHECK_FIELD, $WINDOP,
$THRESHOLD)
If C<$IN_FIELD> or C<$CHECK_FIELD> are undef, or if C<$WINDOP ==
$GetData::WINDOP_UNK>, that paremeter is not changed. Otherwise,
C<$WINDOP> should be one of the symbols listed under L</WINDOW Operators> above.
=item $dirfile->array_len ($FIELD_CODE)
Z<>
=item $dirfile->bof ($FIELD_CODE)
Z<>
=item $dirfile->delete ($FIELD_CODE, [$FLAGS])
If not given, C<$FLAGS> defaults to 0. Otherwise, it should be a bitwise or'd
collection of zero or more of the following flags:
=over
$GetData::DEL_DATA,
$GetData::DEL_DEREF,
$GetData::DEL_FORCE,
$GetData::DEL_META.
=back
=item $dirfile->desync ([$FLAGS])
If omitted, C<$FLAGS> defaults to zero. Otherwise, it should be zero or more
of the following flags bitwise or'd together:
=over
$GetData::DESYNC_PATHCHECK,
$GetData::DESYNC_REOPEN.
=back
=item $dirfile->dirfilename ()
Z<>
=item $dirfile->dirfile_standards ([$VERSION])
In addition to a simple integer verison number, C<$VERSION> may be one of the
symbols
=over
$GetData::VERSION_CURRENT,
$GetData::VERSION_EARLIEST,
$GetData::VERSION_LATEST.
=back
If not given, C<$GetData::VERSION_CURRENT> is assumed.
=item $dirfile->encoding ($FRAGMENT_INDEX)
Z<>
=item $dirfile->endianness ($FRAGMENT_INDEX)
Z<>
=item $dirfile->eof ($FIELD_CODE)
Z<>
=item $dirfile->error_count ()
Z<>
=item $dirfile->flags ([$SET, $RESET])
If omitted, C<$SET> and C<$RESET> default to 0. Otherwise, they should be
zero or more of the following flags, bitwise or'd together:
=over
$GetData::PRETTY_PRINT,
$GetData::VERBOSE.
=back
=item $dirfile->flush ($FIELD_CODE)
Z<>
=item $dirfile->fragment_index ($FIELD_CODE)
Z<>
=item $dirfile->fragmentname ($FRAGMENT_INDEX)
Z<>
=item $dirfile->frameoffset ($FRAGMENT_INDEX)
Z<>
=item $dirfile->framenum ($FIELD_CODE, $VALUE, [$START, $END])
C<$START> and C<$END> default to 0 if not given.
=item $dirfile->hidden ($FIELD_CODE)
Z<>
=item $dirfile->hide ($FIELD_CODE)
Z<>
=item $dirfile->madd ($ENTRY, $PARENT)
C<$ENTRY> should be a reference to an entry hash; see L</"ENTRY HASHES"> above.
=item $dirfile->madd_alias ($PARENT, $FIELD_CODE, $TARGET)
Z<>
=item $dirfile->madd_bit ($PARENT, $FIELD_CODE, $IN_FIELD, $BITNUM, $NUMBITS)
Z<>
=item $dirfile->madd_divide ($PARENT, $FIELD_CODE, $IN_FIELD1, $IN_FIELD2)
Z<>
=item $dirfile->madd_lincom ($PARENT, $FIELD_CODE, $N_FIELDS, $IN_FIELDS, $M,
$B)
C<$IN_FIELDS>, C<$M>, and C<$B> should be references to arrays of the
appropriate length. The elements of C<$M> and C<$B> may be of any numerical
type, including C<Math::Complex>.
=item $dirfile->madd_linterp ($PARENT, $FIELD_CODE, $IN_FIELD, $TABLE)
Z<>
=item $dirfile->madd_mplex ($PARENT, $FIELD_CODE, $IN_FIELD, $COUNT_FIELD,
$COUNT_VAL, $COUNT_MAX)
Z<>
=item $dirfile->madd_multiply ($PARENT, $FIELD_CODE, $IN_FIELD1, $IN_FIELD2)
Z<>
=item $dirfile->madd_phase ($PARENT, $FIELD_CODE, $IN_FIELD, $SHIFT)
Z<>
=item $dirfile->madd_polynom ($PARENT, $FIELD_CODE, $POLY_ORD, $IN_FIELD, $A)
C<$A> should be a reference to an array of numbers (of any numerical type,
including C<Math::Complex>) of the appropriate length.
=item $dirfile->madd_recip ($PARENT, $FIELD_CODE, $IN_FIELD, $DIVIDEND)
C<$DIVIDEND> may be of any numerical type, including C<Math::Complex>.
=item $dirfile->madd_sbit ($PARENT, $FIELD_CODE, $IN_FIELD, $BITNUM, $NUMBITS)
Z<>
=item $dirfile->madd_spec ($LINE, $PARENT)
Z<>
=item $dirfile->madd_string ($PARENT, $FIELD_CODE, $VALUE)
Z<>
=item $dirfile->madd_window ($PARENT, $FIELD_CODE, $IN_FIELD, $CHECK_FIELD,
$WINDOP, $THRESHOLD)
C<$WINDOP> should be one of the symbols listed under L</WINDOW Operators> above.
=item $dirfile->malter_spec ($LINE, $PARENT, [$RECODE])
If not given, C<$RECODE> defaults to 0.
=item $dirfile->metaflush ()
Z<>
=item $dirfile->move ($FIELD_CODE, $NEW_FRAGMENT, [$MOVE_DATA])
If not given, C<$FLAGS> defaults to 0. Otherwise, it should be a bitwise or'd
collection of zero or more of the following flags:
=over
$GetData::REN_DANGLE,
$GetData::REN_DATA,
$GetData::REN_FORCE,
$GetData::REN_UPDB.
=back
=item $dirfile->mplex_lookback ($LOOKBACK)
Z<>
=item $dirfile->native_type ($FIELD_CODE)
The returned value will be one of the symbols listed above under
L</"Data Types">.
=item $dirfile->nframes ()
Z<>
=item $dirfile->parent_fragment ($FRAGMENT_INDEX)
Z<>
=item $dirfile->protection ($FRAGMENT_INDEX)
Z<>
=item $dirfile->put_string ($FIELD_CODE, $STRING)
Z<>
=item $dirfile->raw_close ($FIELD_CODE)
Z<>
=item $dirfile->raw_filename ($FIELD_CODE)
Z<>
=item $dirfile->reference ([$FIELD_CODE])
If C<$FIELD_CODE> is not given or undef, this function simply reports the
current reference field.
=item $dirfile->rename ($OLD_CODE, $NEW_NAME, [$FLAGS])
If not given, C<$FLAGS> defaults to 0. Otherwise, it should be a bitwise or'd
collection of zero or more of the following flags:
=over
$GetData::REN_DANGLE,
$GetData::REN_DATA,
$GetData::REN_FORCE,
$GetData::REN_UPDB.
=back
=item $dirfile->rewrite_fragment ($FRAGMENT_INDEX)
Z<>
=item $dirfile->seek ($FIELD_CODE, $FRAME_NUM, $SAMPLE_NUM, [$FLAGS])
If not given, C<$FLAGS> defaults to C<$GetData::SEEK_SET>. Otherwise, it should
be one of:
=over
$GetData::SEEK_CUR,
$GetData::SEEK_END,
$GetData::SEEK_SET.
=back
Furthermore, this value should be bitwise or'd with C<$GetData::SEEK_WRITE> if
the next operation on the field is a write (via L</putdata>).
=item $dirfile->spf ($FIELD_CODE)
Z<>
=item $dirfile->sync ($FIELD_CODE)
Z<>
=item $dirfile->tell ($FIELD_CODE)
Z<>
=item $dirfile->unhide ($FIELD_CODE)
Z<>
=item $dirfile->uninclude ($FRAGMENT_INDEX, [$DEL])
If not given, C<$DEL> defaults to 0.
=item $dirfile->validate ($FIELD_CODE)
Z<>
=item $dirfile->verbose_prefix ([$PREFIX])
If C<$PREFIX> is omitted or undef, the prefix is removed.
=back
=head1 COPYRIGHT
Copyright (C) 2012-2015 D. V. Wiebe
GetData is free software; you can redistribute it and/or modify it under the
terms of the GNU Lesser General Public License as published by the Free Software
Foundation: either version 2.1 of the License, or (at your option) any later
version.
GetData is distributed in the hope that it will be useful, but without any
warranty; without even the implied warranty of merchantability or fitness for
a particular purpose. See the GNU Lesser General Public License for more
details.
=head1 SEE ALSO
Math::Complex(3), dirfile(5)
=cut
|