1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563 12564 12565 12566 12567 12568 12569 12570 12571 12572 12573 12574 12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893 12894 12895 12896 12897 12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993 12994 12995 12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016 13017 13018 13019 13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115 13116 13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 13167 13168 13169 13170 13171 13172 13173 13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 13204 13205 13206 13207 13208 13209 13210 13211 13212 13213 13214 13215 13216 13217 13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228 13229 13230 13231 13232 13233 13234 13235 13236 13237 13238 13239 13240 13241 13242 13243 13244 13245 13246 13247 13248 13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259 13260 13261 13262 13263 13264 13265 13266 13267 13268 13269 13270 13271 13272 13273 13274 13275 13276 13277 13278 13279 13280 13281 13282 13283 13284 13285 13286 13287 13288 13289 13290 13291 13292 13293 13294 13295 13296 13297 13298 13299 13300 13301 13302 13303 13304 13305 13306 13307 13308 13309 13310 13311 13312 13313 13314 13315 13316 13317 13318 13319 13320 13321 13322 13323 13324 13325 13326 13327 13328 13329 13330 13331 13332 13333 13334 13335 13336 13337 13338 13339 13340 13341 13342 13343 13344 13345 13346 13347 13348 13349 13350 13351 13352 13353 13354 13355 13356 13357 13358 13359 13360 13361 13362 13363 13364 13365 13366 13367 13368 13369 13370 13371 13372 13373 13374 13375 13376 13377 13378 13379 13380 13381 13382 13383 13384 13385 13386 13387 13388 13389 13390 13391 13392 13393 13394 13395 13396 13397 13398 13399 13400 13401 13402 13403 13404 13405 13406 13407 13408 13409 13410 13411 13412 13413 13414 13415 13416 13417 13418 13419 13420 13421 13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 13451 13452 13453 13454 13455 13456 13457 13458 13459 13460 13461 13462 13463 13464 13465 13466 13467 13468 13469 13470 13471 13472 13473 13474 13475 13476 13477 13478 13479 13480 13481 13482 13483 13484 13485 13486 13487 13488 13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 13499 13500 13501 13502 13503 13504 13505 13506 13507 13508 13509 13510 13511 13512 13513 13514 13515 13516 13517 13518 13519 13520 13521 13522 13523 13524 13525 13526 13527 13528 13529 13530 13531 13532 13533 13534 13535 13536 13537 13538 13539 13540 13541 13542 13543 13544 13545 13546 13547 13548 13549 13550 13551 13552 13553 13554 13555 13556 13557 13558 13559 13560 13561 13562 13563 13564 13565 13566 13567 13568 13569 13570 13571 13572 13573 13574 13575 13576 13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 13610 13611 13612 13613 13614 13615 13616 13617 13618 13619 13620 13621 13622 13623 13624 13625 13626 13627 13628 13629 13630 13631 13632 13633 13634 13635 13636 13637 13638 13639 13640 13641 13642 13643 13644 13645 13646 13647 13648 13649 13650 13651 13652 13653 13654 13655 13656 13657 13658 13659 13660 13661 13662 13663 13664 13665 13666 13667 13668 13669 13670 13671 13672 13673 13674 13675 13676 13677 13678 13679 13680 13681 13682 13683 13684 13685 13686 13687 13688 13689 13690 13691 13692 13693 13694 13695 13696 13697 13698 13699 13700 13701 13702 13703 13704 13705 13706 13707 13708 13709 13710 13711 13712 13713 13714 13715 13716 13717 13718 13719 13720 13721 13722 13723 13724 13725 13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 13753 13754 13755 13756 13757 13758 13759 13760 13761 13762 13763 13764 13765 13766 13767 13768 13769 13770 13771 13772 13773 13774 13775 13776 13777 13778 13779 13780 13781 13782 13783 13784 13785 13786 13787 13788 13789 13790 13791 13792 13793 13794 13795 13796 13797 13798 13799 13800 13801 13802 13803 13804 13805 13806 13807 13808 13809 13810 13811 13812 13813 13814 13815 13816 13817 13818 13819 13820 13821 13822 13823 13824 13825 13826 13827 13828 13829 13830 13831 13832 13833 13834 13835 13836 13837 13838 13839 13840 13841 13842 13843 13844 13845 13846 13847 13848 13849 13850 13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 13871 13872 13873 13874 13875 13876 13877 13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 13890 13891 13892 13893 13894 13895 13896 13897 13898 13899 13900 13901 13902 13903 13904 13905 13906 13907 13908 13909 13910 13911 13912 13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 13942 13943 13944 13945 13946 13947 13948 13949 13950 13951 13952 13953 13954 13955 13956 13957 13958 13959 13960 13961 13962 13963 13964 13965 13966 13967 13968 13969 13970 13971 13972 13973 13974 13975 13976 13977 13978 13979 13980 13981 13982 13983 13984 13985 13986 13987 13988 13989 13990 13991 13992 13993 13994 13995 13996 13997 13998 13999 14000 14001 14002 14003 14004 14005 14006 14007 14008 14009 14010 14011 14012 14013 14014 14015 14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 14054 14055 14056 14057 14058 14059 14060 14061 14062 14063 14064 14065 14066 14067 14068 14069 14070 14071 14072 14073 14074 14075 14076 14077 14078 14079 14080 14081 14082 14083 14084 14085 14086 14087 14088 14089 14090 14091 14092 14093 14094 14095 14096 14097 14098 14099 14100 14101 14102 14103 14104 14105 14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133 14134 14135 14136 14137 14138 14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168 14169 14170 14171 14172 14173 14174 14175 14176 14177 14178 14179 14180 14181 14182 14183 14184 14185 14186 14187 14188 14189 14190 14191 14192 14193 14194 14195 14196 14197 14198 14199 14200 14201 14202 14203 14204 14205 14206 14207 14208 14209 14210 14211 14212 14213 14214 14215 14216 14217 14218 14219 14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235 14236 14237 14238 14239 14240 14241 14242 14243 14244 14245 14246 14247 14248 14249 14250 14251 14252 14253 14254 14255 14256 14257 14258 14259 14260 14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271 14272 14273 14274 14275 14276 14277 14278 14279 14280 14281 14282 14283 14284 14285 14286 14287 14288 14289 14290 14291 14292 14293 14294 14295 14296 14297 14298 14299 14300 14301 14302 14303 14304 14305 14306 14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319 14320 14321 14322 14323 14324 14325 14326 14327 14328 14329 14330 14331 14332 14333 14334 14335 14336 14337 14338 14339 14340 14341 14342 14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353 14354 14355 14356 14357 14358 14359 14360 14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377 14378 14379 14380 14381 14382 14383 14384 14385 14386 14387 14388 14389 14390 14391 14392 14393 14394 14395 14396 14397 14398 14399 14400 14401 14402 14403 14404 14405 14406 14407 14408 14409 14410 14411 14412 14413 14414 14415 14416 14417 14418 14419 14420 14421 14422 14423 14424 14425 14426 14427 14428 14429 14430 14431 14432 14433 14434 14435 14436 14437 14438 14439 14440 14441 14442 14443 14444 14445 14446 14447 14448 14449 14450 14451 14452 14453 14454 14455 14456 14457 14458 14459 14460 14461 14462 14463 14464 14465 14466 14467 14468 14469 14470 14471 14472 14473 14474 14475 14476 14477 14478 14479 14480 14481 14482 14483 14484 14485 14486 14487 14488 14489 14490 14491 14492 14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 14503 14504 14505 14506 14507 14508 14509 14510 14511 14512 14513 14514 14515 14516 14517 14518 14519 14520 14521 14522 14523 14524 14525 14526 14527 14528 14529 14530 14531 14532 14533 14534 14535 14536 14537 14538 14539 14540 14541 14542 14543 14544 14545 14546 14547 14548 14549 14550 14551 14552 14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563 14564 14565 14566 14567 14568 14569 14570 14571 14572 14573 14574 14575 14576 14577 14578 14579 14580 14581 14582 14583 14584 14585 14586 14587 14588 14589 14590 14591 14592 14593 14594 14595 14596 14597 14598 14599 14600 14601 14602 14603 14604 14605 14606 14607 14608 14609 14610 14611 14612 14613 14614 14615 14616 14617 14618 14619 14620 14621 14622 14623 14624 14625 14626 14627 14628 14629 14630 14631 14632 14633 14634 14635 14636 14637 14638 14639 14640 14641 14642 14643 14644 14645 14646 14647 14648 14649 14650 14651 14652 14653 14654 14655 14656 14657 14658 14659 14660 14661 14662 14663 14664 14665 14666 14667 14668 14669 14670 14671 14672 14673 14674 14675 14676 14677 14678 14679 14680 14681 14682 14683 14684 14685 14686 14687 14688 14689 14690 14691 14692 14693 14694 14695 14696 14697 14698 14699 14700 14701 14702 14703 14704 14705 14706 14707 14708 14709 14710 14711 14712 14713 14714 14715 14716 14717 14718 14719 14720 14721 14722 14723 14724 14725 14726 14727 14728 14729 14730 14731 14732 14733 14734 14735 14736 14737 14738 14739 14740 14741 14742 14743 14744 14745 14746 14747 14748 14749 14750 14751 14752 14753 14754 14755 14756 14757 14758 14759 14760 14761 14762 14763 14764 14765 14766 14767 14768 14769 14770 14771 14772 14773 14774 14775 14776 14777 14778 14779 14780 14781 14782 14783 14784 14785 14786 14787 14788 14789 14790 14791 14792 14793 14794 14795 14796 14797 14798 14799 14800 14801 14802 14803 14804 14805 14806 14807 14808 14809 14810 14811 14812 14813 14814 14815 14816 14817 14818 14819 14820 14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835 14836 14837 14838 14839 14840 14841 14842 14843 14844 14845 14846 14847 14848 14849 14850 14851 14852 14853 14854 14855 14856 14857 14858 14859 14860 14861 14862 14863 14864 14865 14866 14867 14868 14869 14870 14871 14872 14873 14874 14875 14876 14877 14878 14879 14880 14881 14882 14883 14884 14885 14886 14887 14888 14889 14890 14891 14892 14893 14894 14895 14896 14897 14898 14899 14900 14901 14902 14903 14904 14905 14906 14907 14908 14909 14910 14911 14912 14913 14914 14915 14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926 14927 14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938 14939 14940 14941 14942 14943 14944 14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960 14961 14962 14963 14964 14965 14966 14967 14968 14969 14970 14971 14972 14973 14974 14975 14976 14977 14978 14979 14980 14981 14982 14983 14984 14985 14986 14987 14988 14989 14990 14991 14992 14993 14994 14995 14996 14997 14998 14999 15000 15001 15002 15003 15004 15005 15006 15007 15008 15009 15010 15011 15012 15013 15014 15015 15016 15017 15018 15019 15020 15021 15022 15023 15024 15025 15026 15027 15028 15029 15030 15031 15032 15033 15034 15035 15036 15037 15038 15039 15040 15041 15042 15043 15044 15045 15046 15047 15048 15049 15050 15051 15052 15053 15054 15055 15056 15057 15058 15059 15060 15061 15062 15063 15064 15065 15066 15067 15068 15069 15070 15071 15072 15073 15074 15075 15076 15077 15078 15079 15080 15081 15082 15083 15084 15085 15086 15087 15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 15102 15103 15104 15105 15106 15107 15108 15109 15110 15111 15112 15113 15114 15115 15116 15117 15118 15119 15120 15121 15122 15123 15124 15125 15126 15127 15128 15129 15130 15131 15132 15133 15134 15135 15136 15137 15138 15139 15140 15141 15142 15143 15144 15145 15146 15147 15148 15149 15150 15151 15152 15153 15154 15155 15156 15157 15158 15159 15160 15161 15162 15163 15164 15165 15166 15167 15168 15169 15170 15171 15172 15173 15174 15175 15176 15177 15178 15179 15180 15181 15182 15183 15184 15185 15186 15187 15188 15189 15190 15191 15192 15193 15194 15195 15196 15197 15198 15199 15200 15201 15202 15203 15204 15205 15206 15207 15208 15209 15210 15211 15212 15213 15214 15215 15216 15217 15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 15229 15230 15231 15232 15233 15234 15235 15236 15237 15238 15239 15240 15241 15242 15243 15244 15245 15246 15247 15248 15249 15250 15251 15252 15253 15254 15255 15256 15257 15258 15259 15260 15261 15262 15263 15264 15265 15266 15267 15268 15269 15270 15271 15272 15273 15274 15275 15276 15277 15278 15279 15280 15281 15282 15283 15284 15285 15286 15287 15288 15289 15290 15291 15292 15293 15294 15295 15296 15297 15298 15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 15312 15313 15314 15315 15316 15317 15318 15319 15320 15321 15322 15323 15324 15325 15326 15327 15328 15329 15330 15331 15332 15333 15334 15335 15336 15337 15338 15339 15340 15341 15342 15343 15344 15345 15346 15347 15348 15349 15350 15351 15352 15353 15354 15355 15356 15357 15358 15359 15360 15361 15362 15363 15364 15365 15366 15367 15368 15369 15370 15371 15372 15373 15374 15375 15376 15377 15378 15379 15380 15381 15382 15383 15384 15385 15386 15387 15388 15389 15390 15391 15392 15393 15394 15395 15396 15397 15398 15399 15400 15401 15402 15403 15404 15405 15406 15407 15408 15409 15410 15411 15412 15413 15414 15415 15416 15417 15418 15419 15420 15421 15422 15423 15424 15425 15426 15427 15428 15429 15430 15431 15432 15433 15434 15435 15436 15437 15438 15439 15440 15441 15442 15443 15444 15445 15446 15447 15448 15449 15450 15451 15452 15453 15454 15455 15456 15457 15458 15459 15460 15461 15462 15463 15464 15465 15466 15467 15468 15469 15470 15471 15472 15473 15474 15475 15476 15477 15478 15479 15480 15481 15482 15483 15484 15485 15486 15487 15488 15489 15490 15491 15492 15493 15494 15495 15496 15497 15498 15499 15500 15501 15502 15503 15504 15505 15506 15507 15508 15509 15510 15511 15512 15513 15514 15515 15516 15517 15518 15519 15520 15521 15522 15523 15524 15525 15526 15527 15528 15529 15530 15531 15532 15533 15534 15535 15536 15537 15538 15539 15540 15541 15542 15543 15544 15545 15546 15547 15548 15549 15550 15551 15552 15553 15554 15555 15556 15557 15558 15559 15560 15561 15562 15563 15564 15565 15566 15567 15568 15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 15589 15590 15591 15592 15593 15594 15595 15596 15597 15598 15599 15600 15601 15602 15603 15604 15605 15606 15607 15608 15609 15610 15611 15612 15613 15614 15615 15616 15617 15618 15619 15620 15621 15622 15623 15624 15625 15626 15627 15628 15629 15630 15631 15632 15633 15634 15635 15636 15637 15638 15639 15640 15641 15642 15643 15644 15645 15646 15647 15648 15649 15650 15651 15652 15653 15654 15655 15656 15657 15658 15659 15660 15661 15662 15663 15664 15665 15666 15667 15668 15669 15670 15671 15672 15673 15674 15675 15676 15677 15678 15679 15680 15681 15682 15683 15684 15685 15686 15687 15688 15689 15690 15691 15692 15693 15694 15695 15696 15697 15698 15699 15700 15701 15702 15703 15704 15705 15706 15707 15708 15709 15710 15711 15712 15713 15714 15715 15716 15717 15718 15719 15720 15721 15722 15723 15724 15725 15726 15727 15728 15729 15730 15731 15732 15733 15734 15735 15736 15737 15738 15739 15740 15741 15742 15743
|
/*
* Project: The SPD Image correction and azimuthal regrouping
* http://forge.epn-campus.eu/projects/show/azimuthal
*
* Copyright (C) 2005-2010 European Synchrotron Radiation Facility
* Grenoble, France
*
* Principal authors: P. Boesecke (boesecke@esrf.fr)
* R. Wilcke (wilcke@esrf.fr)
*
* This program 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 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* and the GNU Lesser General Public License along with this program.
* If not, see <http://www.gnu.org/licenses/>.
*/
# define EDFIO_VERSION "edfio : V2.38 Peter Boesecke 2011-09-01"
/*+++------------------------------------------------------------------------
NAME
edfio --- EDF data format specific file access routines
SYNOPSIS
# include edfio.h
INCLUDE FILES
edfio.h
bslio.h
raster.h
numio.h
TO LINK WITH
bslio.c
RESTRICTIONS
The file size is limited by the long integer format. On machines with
4 byte long integers additional blocks after 2^31 bytes = 2Gbytes cannot
be accessed. Therefore, if a file contains several data blocks the
absolute size of a single data file should not exceed 2GBytes.
DESCRIPTION
EDF data format specific file access routines (read and write routines)
The file format is described in SaxsKeywords.pdf. The data files can
contain several data blocks that can be accessed by data numbers and
chain numbers. Chain numbers are positive integer numbers. A data block
consists of a text block ("ASCII header") followed by a binary block
("binary data"). The block type is written at the top of the text block
after the keyword "EDF_DataBlockID". The value "1.Image.Psd" marks
data block number 1 of DataChain 1. Data chain 1 contains always primary
(scientific) data, therefore the extension ".Psd". The value
"1.Image.2" marks data block number 1 of DataChain 2 with additional
image data. As a convention the associated variance data is stored
with a negative chain number: data chain -m contains variance data of
data chain +m (m>=1).
The following convention should be followed:
primary image data : chain number 1;
error image data : chain number -1;
Internally, a general chain is defined. It has chain number 0 and
data number 0.
Data blocks with different chain numbers but the same data numbers
belong together (e.g. data array (chain number 1) and associated
error array (chain number -1)).
ChainNumber DataNumber chain key block key block id
+1 n Image.Psd n n.Image.Psd
-1 n Image.Error n n.Image.Error
+m n Image.Psd.m n n.Image.Psd.m
-m n Image.Error.m n n.Image.Error.m
The input routines can also read bsl files. Bsl frame numbers (franum)
and memory numbers (memnum) are in the following way internally
converted to edf data numbers and chain numbers:
memnum franum ChainNumber DataNumber chain key block key block id
1 n 1 n Image.Psd n n.Image.Psd
m n m n Image.Psd.m n n.Image.Psd.m
HISTORY
02-Jan-1996 Peter Boesecke
17-Mar-1998 Peter Boesecke V1.00
19-Mar-1998 Peter Boesecke locate_blocks
20-Mar-1998 Peter Boesecke search_general
21-Mar-1998 file->Buffer = (char *) NULL; in init_file
22-Mar-1998
28-Mar-1998 block->BinaryFilePos only used together with BinaryFileName
17-May-1998 PB V1.002 indexing error in reorder_raster and
raster_normalization corrected
17-May-1998 PB V1.003 open of old files read-only with mode="read"
18-May-1998 PB V1.004 open_data_file and open_as_bsl_file:
opening mode must be either Old or Read
01-Jun-1998 PB V1.01 set_bsl_input_byteorder
20-Jun-1998 PB V1.011 locate_blocks (corrected): if in V1x V1_IMAGE_KEY
is missing, the header id number is used as image
number.
22-Jul-1998 PB V1.012 read_header_string: debug info added (keyword, value)
30-Aug-1998 PB V1.013 numbers string: closing '\0' added (was missing)
18-Apr-1999 PB V1.02 all public routines start with edf_ or edfio_
18-Apr-1999 PB V1.021 Return value of edf_read_data_2d_dimension
is only FALSE if open_read_block terminated with
the error value: CouldNotFindHeader.
30-Apr-1999 PB V1.022 edf_read_data_2d_raw
16-Jun-1999 PB V1.023 write_header_string debug info added
23-Jun-1999 PB V1.024 Restrictions split into PUBLIC and PRIVATE
24-Jun-1999 PB V1.03 Module history added, restrictions again only PRIVATE
26-Jun-1999 PB V1.04 History_Line renamed to Header_Line, now public
edf_read_header, edf_write_header
17-Jul-1999 PB V1.05 edf_history_argv: strlen(argument)+3 (instead +2)
17-Jul-1999 PB V1.06 MaxLinLen increased from 127 to 255
in SaxsInput.h: InputLineLength increased to 256
23-Jul-1999 PB V1.07 DataValueOffset (EDF_DataFormatVersion = 2.20)
"DataKey_" changed to "DataKey-"
26-Jul-1999 PB V1.08 Block boundary warning only given if binary lenght
is different from zero,
warning on BlockBoundaryKey missing removed, use
internal default (512 bytes) without notice
08-Nov-1999 PB V1.09 raster_normalization added
08-Nov-1999 PB V1.10 in HSymb: shortlen and required added,
new functions: edf_history_skip(), edf_history_take()
26-Nov-1999 PB V1.11 for cc on dec alpha:
- some length values were not defined as constant and
were changed to const.
- all statements of the type *ps++=tolower(*ps);
changed to { *ps=tolower(*ps); ps++; }
19-Dec-1999 PB V1.12 reorder_raster corrected,
Data2FloatIEEE32 bad size check also for output data
07-Jan-2000 PB V1.13 for cc on dec alpha:
all calls of the form "c=(char)ic=fgetc(channel);"
changed to {ic=fgetc(channel); c=(char)ic;}
otherwise ic == c and EOF cannot be checked;
16-Mar-2000 PB V1.14 Comments revised
17-Mar-2000 PB V1.15 ChainKey generally defined as "Image.<ChainNum>"
18-Mar-2000 PB V1.16 DEFAULT_CHAIN_KEY changed to CLASS_KEY
DBClass and DBInstance
19-Mar-2000 PB V1.17 locate_block: using SequenceNumber, if IDs are missing
06-Apr-2000 PB V1.18 new breakval, val2str adapted, MAX_LINE_WIDTH
07-Apr-2000 PB V1.19 new function: edf_set_max_line_width
30-Apr-2000 PB V1.20 new in edfio.h:
-> enum MType,
-> edf_data2machine,
-> edf_showdatatypes,
bswap -> edf_bswap
raster_normalization -> edf_rasternormalization
dim_product -> edf_dim_product
in DTypeStrings:
Unsigned64 and Signed64 renamed to UnsignedLong and
SignedLong (unchanged in DTypeStringsAliases),
in DSize:
Size of DoubleValue (DoubleIEEE64) corrected from 4
to 8 bytes
01-May-2000 PB V1.21 new in edfio.h:
-> edf_showmachinetypes
22-May-2000 PB V1.22 in open_as_bsl_file
If bsl-file is read-only, opening as read-write can
cause a segmentation error (linux). Therefore, bsl file
is now opened read-only ("read").
28-Jul-2000 PB V1.23 all arrays declared with constants
30-Jul-2000 PB V1.24 new functions: raster_multiplication,
raster_inversion
10-Nov-2000 PB V1.30 RasterOrientation -> DataRasterConfiguration,
Dim_0 is not written any more,
calculation of DataLen from all dimensions,
write keywords of all dimensions
edf_write_data_2d_raw -> edf_write_data_raw
edf_write_data_2d_float -> edf_write_data_float
11-Nov-2000 PB V1.31 ExternalDimAlloc, ExternalDataAlloc
disk_write_block and free_data_block_list release
only internally allocated DataDim and Data arrays,
externally allocated arrays are not released
12-Nov-2000 PB V1.32 edf_write_data_float -> edf_write_data(...,MFloat,...)
V1.33 long * pDataArraySize -> size_t * pDataArraySize
newdim() in edf_write_data_raw
V1.34 edf_read_data_...(... , long Dim[], ...)
--> edf_read_data_...(... , long **pDim, ...)
edf_read_data_2d_... -> edf_read_data_...
edf_read_data_float -> edf_read_data(...,MFloat,...)
13-Nov-2000 PB V1.35 read_data_array( block, ... )
29-Dec-2000 PB V1.36 new in data block:
DataByteOrder, DataRasterConfiguration, DataCompression
renorm_data_array
block->DataBufferLen: number of allocated data bytes
2000-01-01 PB V1.37 all i/o to Dim[Dim[0]+1] removed
History_Symbol_List, module header_list
print_bsl_filetable
DBFlags.BadBlock, sync_data_block
2000-01-12 PB V1.38 for VisualC++ compatibility:
typedefs for u_char, u_short, u_int and u_long
removed and unsigned char, unsigned short, unsigned int
and unsigned long used instead
still undefined in VCC: getcwd
2000-01-15 PB V1.39 GETCWD
2001-01-24 PB V1.40 _getcwd <dirent.h> for ms visual c
2001-02-05 PB V1.41 remove unused variables
2001-02-05 PB V1.42 <unistd.h> not included for WIN32
2001-03-06 PB V1.43 on DEC alpha station: two fabs corrected to labs
2001-03-30 PB V1.44 opening binary file with empty extension (adding ".")
if fopen fails the first time (just for some cdroms)
2001-04-11 PB V1.45 __MSVC__ -> WIN32
2001-05-15 PB V1.46 get_data_dim: i/o to Dim[Dim[0]+1] found and removed
description corrected
2001-05-18 PB V1.47 edf_dump
2001-05-21 PB V1.48 edf_free_all: variables are only freed if != NULL
2001-06-02 PB V1.49 edf_dump new arguments
2001-06-07 PB V1.50 read_header_string: *pstatus = status_error for
unsuccessful search in header
write_header_string: *pstatus = status_error for
unsuccessful write to header
2001-06-08 PB V1.51 edf_read_data_dimension, get_binary_array:
block->DataDim array is not reallocated any more,
if it exists it is only updated with copydim
2001-06-13 PB V1.52 edf_dump \n -> \r\n
2001-07-06 PB V1.53 new function edf_search_data_file, check_mode
2001-07-06 PB V1.54 InvalidStream
2001-07-08 PB V1.55 EdfMaxKeyLen etc., edf_byteorder
2001-07-10 PB V1.56 open_as_edf_file: ErrorCreatingGeneralBlock; return(-1);
instead of ErrorCreatingGeneralBlock; return(0);
2001-07-11 PB V1.57 accept empty files as edf-files without general header
2001-08-05 PB V1.58 mode = "temp" (temporary files) see edf_open_data_file
temporary files with binary data are not fully
implemented, missing: edf_read_data_raw cannot be used,
no internal memory allocation, no data type conversion.
2001-09-02 PB V1.59 Data2Float -> Convert2Float, edf_set_datatype
edf_data2machine -> edf_machine2machine
Convert2UnsignedShort
2001-09-03 PB V1.60 Convert2UnsignedShort: round MFloat and MDouble
2001-09-04 PB V1.61 edf_write_data: error removed for data_type_out == 0
2001-09-13 PB V1.62 call of edf_history routines with history_key,
currently without function
2001-09-15 PB V1.63 new_header_history -> clear_header_history
2001-09-15 PB V1.64 edf_history V1.2
2001-09-16 PB V1.65 UCharMin etc.
2001-09-17 PB V1.66 edf_write_data_raw: remove non compulsary keywords
read_header_string: debug output corrected
2001-10-27 PB V1.67 DataKey- starts now with DATA_FORMAT_PREFIX
2001-11-18 PB V1.68 edf_read_header: general block is now read first
2001-11-18 PB V1.69 HEFlags, KeyOrderNo
2001-11-25 PB V1.70 SEFlags, KeyOrderNo, KeyOrderNextSymbol
module keyorder, module header_list
2001-11-25 PB V1.71 print_data_block_list corrected
2001-11-28 PB V1.72 keyorder_DefaultTable updated
2001-11-28 PB V1.73 edf_dump str2val added
2001-11-29 PB V1.74 keyorder_DefaultTable updated
2001-12-08 PB V1.75 edf_add_header_element, edf_delete_header_element
2002-01-08 PB V1.76 edf_search_header_element, CouldNotFindHeaderKey
2002-01-09 PB V1.77 edf_print_header for single header
2002-01-21 PB V1.78 read_header_list, write_header_list:
value-string-conversion added
2002-02-12 PB V1.79 edf_datatype2machinetype, edf_machine_sizeof
2002-04-25 PB V1.80 edf_history_read_header, edf_history_write_header,
edf_history_copy
2002-06-01 PB V1.81 write only non-empty history lines
2002-11-27 PB V1.82 keyorder_DefaultTable updated (info keys added)
2003-04-06 PB V1.83 keyorder_DefaultTable updated (info keys added)
2003-04-06 PB V1.84 get_binary_array: BinaryFileName printed as string
2003-08-13 PB edf_read_header_...: Explicitely specified, that
Value is not changed when return value is 0
2003-11-29 PB V1.85 keyorder_DefaultTable changed: BSize*, Psic*
2004-02-19 PB V1.86 To avoid problems when variables are copied to itself:
tmp created before a variable is deleted ( in
replace_string, insert_symbol, insert_symbol_root,
insert_header_element ),
additional check in copy_history_block
2004-03-16 PB V1.87 includes numio.h, must be linked with numio.c
edf_read_header_float: s2float replaced by num_str2double,
edf_read_header_long, get_data_dim, get_data_value_offset,
get_raster_configuration: s2long replaced by num_str2long
2004-03-24 PB V1.88 EdfNDigitsFloat: number of significant float digits
edf_write_header_unit: new function
edf_write_header_float: float2s replaced by num_double2str
2004-04-02 PB V1.89 num_str2double, num_str2long have new parameter tail
2004-04-05 PB V1.90 removing memory leaks in
history_line_new: allocated memory of newhline is
now released in case of an error,
get_binary_array: allocated memory of data_dim is
now released if it was copied to
block or in case of an error
2004-04-05 PB V1.90a insert_symbol: allocated memory of newsymbol is
now released in case of an error
2004-04-06 PB V1.91 Previously temporarily allocated memory released in
case that newstr fails ( free(tmp...); return ):
insert_symbol_root (3 changes),
insert_data_block (1 change),
insert_data_chain (1 change),
insert_history_block (1 change),
history_line_new (1 change)
2004-04-08 PB V1.92 To prevent memory leaks:
history_free: free(hline->key) added
remove_history_block: free(hblock->key) added
PB V1.92a remove_history_block: if (hblock->key) added
2004-04-12 PB V1.93 write header size into header
2004-06-19 PB V1.94 edfio_debug: numio_debug added
2004-07-17 PB V1.95 edf_set_minimumheadersize, sync_data_block updated
2004-07-17 PB V1.96 default of minimum_headersize_out increased to 4096
2004-09-27 PB V1.97 keyorder_DefaultTable: RasterOrientation -> Raster*,
Projection*,
needquotes: quotes required for empty strings
2004-10-04 PB V1.98 keyorder_DefaultTable: Rotation_* -> DetectorRotation_*
2005-02-23 PB V1.99 Size of DataType UnsignedLong and SignedLong changed
to 4 bytes to be in agreement with the Daly routines.
UnsignedLong and SignedLong are now synonyms for
UnsignedInteger and SignedInteger.
2005-02-23 PB V2.00 Start of implementation of continuation keys:
Continuation character defined
compare_keys: the base key of a continuation key is
sorted according to sort_mode, different keys with
the same base key are sorted according to their
continuation depth number.
Continuation keys are sorted immediately after their
base key. It is not necessary to search for continuation
keys.
str2val: pointer to rest of the string returned
continuation_key, continuation_depth created
is_prefix was accessing 1 bytes after end of buffer
with keybuf[MaxKeyLen+1]='\0', but keybuf and prebuf
are defined as keybuf[MaxKeyLen+1] -> corrected to
keybuf[MaxKeyLen]='\0'. The same applies to prebuf.
2005-02-24 PB V2.01 byteorder() function
2005-02-25 PB V2.02 continuation_key: a continuation key for depth > 0 is
only created if the basekey does not contain a
continuation marker.
SElement: new element String
new: insert_string, search_string, remove_string
remove_symbol: argument Next added
delete_symbol OK, insert_string OK, search_string OK,
remove_string OK, search_general OK,
read_header_list OK, write_header_list OK.
All output keywords are written with insert_string
get_symbol_list uses insert_symbol
All data format specific keywords are still written
and read with insert_symbol(_root) and search_symbol.
str2val: also encapsulation when first or last
character is a quote
read_header_value renamed to read_header_string
write_header_value renamed to write_header_string
read_header_string: The returned constant character
string must not be released any more.
new: edf_write_header_string, edf_read_header_string
2005-03-03 PB V2.03 MaxConLen defined as MaxLinLen,
insert_string: written continuation line length is
limited to MaxConLen. MaxConLen should be smaller or
equal to MaxValLen because longer values cannot be read.
2005-04-11 PB V2.04 default of minimum_headersize_out increased to 8192
2005-07-18 PB V2.05 for gcc 3.4.4.: all statements of the type
c = (char) ic = (int) ' '; splitted into
ic = (int) ' '; c = (char) ic;
all statements of the form *px++ = y splitted into
*px = y; px++; where possible, except in while of
keyorder_wildcmp,
flush_data_block: psymbol=psymbol++ -> psymbol++
2005-08-04 PB V2.06 get_binary_array: data_read_len, do not read more
bytes than can be read from the
binary block.
newstrn: all keys are truncated after
MaxKeyLen characters
all error messages written to stderr,
only exits for SEVERE ERROR (=programming errors)
2005-08-05 PB V2.07 edf_free_header: debug info corrected
2005-10-13 PB V2.08 get_binary_array: unnecessary memset statement removed
(for cc)
2005-10-19 PB V2.09 compare_keys: replaced by compare_keys of version V2.04,
the modified version had errors in the
if statement.
It should also work with gcc 3.4.4,
because it does not contain redundant
statements of the kind a=a++.
2006-03-15 PB V2.10 val2str, str2val: statements without effect removed
edf_dim_product: 0.0l changed to 0l
lcc warning: inconsistent linkage of ByteOrder2String,
edf_compression2string, byteorder could not be solved
2006-12-01 PB V2.11 str2val: missing incrementation (pb++) added. Before,
a new line (\n) was converted to l instead to \l.
2007-02-01 PB V2.12 strtrm added
continuation_depth: strncpy replaced with strtrm
continuation_key: strtrm added for depth>1
update_string: incrementation of next corrected
2007-02-02 PB V2.13 update_string: 2nd while loop corrected for the case
that the string buffer is too small
for the values of all continuation
keys (should be impossible as long
as val2str does not increase the
length of the input string).
2007-02-11 PB V2.14 Andor EDF files:
Keywords cannot contain carriage returns or
line feeds. Only the last portion containing '='
is used as keyword. Empty lines between quotes without
separator '=' are ignored.
Modifications:
DTypeStringsAliases1: FloatValue => Float
DCompressionStringsAliases1: None => NoSpecificValue
edf_string2compression: DCompressionStringsAliases1 added
get_key: Keywords that are not followed by an equal
sign are skipped. get_key continues until
a valid keyword is found (or EOF etc).
newstring: allocates 1 byte for '\0' when stringlen
is zero (originally nothing was allocated
and the return value NULL).
2007-03-07 PB V2.15 edfio_version returns EVERSION if defined
2007-03-08 PB V2.16 prototypes updated for __LCC__ (to reduce warnings)
2007-03-14 PB V2.17 open_as_edf_file: update and increment sequence number
of general block only if it will be physically written
or if it was read (NoGeneralHeader not set), otherwise
the first HeaderID number can be wrong.
2007-04-20 PB V2.18 code corrected to avoid compiler warnings with -Wall
most %zu formats complemented with %lu, except in
edf_show* (%z is not recognized, neither by sun, nor
by cygwin on pc), Flag formats %u changed to %hu
2007-06-15 PB V2.19 locate_block: reads FIT2D specific edf format (KLORA)
2007-06-17 PB V2.20 edf_dump: format 10000, 10001
2007-09-07 PB V2.21 prototype for get_data_type
2007-11-23 PB V2.22 DATA_FORMAT_VERSION increased to 2.4
The output files are now written without starting
newline. The starting newline has been removed from
the variable header_begin. Originally, the start byte
of an EDF file was a newline (0x0A) followed by an
opening curly brace (0x7B). The use of the newline
was not imposed. In recent versions of some software
packages (SPEC, FIT2D) the newline is omitted and the
files start directly with an opening curly brace.
Because one of the software packages does not even
want to read the original file format it has now been
changed here. Hopefully, it will not do too much
trouble to users. As before, all files with and without
newline are read.
2007-12-05 PB V2.23 keyorder_DefaultTable: AxisType_ included
Unsigned64, Signed64
public raster_order2raster
Convert2Float: bug corrected (double incrementation
in ushort and uint caused segmentation fault)
2008-04-23 PB V2.24 keyorder_DefaultTable: Msensi, Pslits, Sample*
2008-05-27 PB V2.25 edf_dump: print file name for format=10000, 10001
2010-07-07 PB V2.26 raster functions extracted to raster.c/raster.h
xxx_order2raster -> xxx_order2number
edf_raster2number -> edf_raster_order2number
raster_normalization calls updated.
2010-07-08 PB V2.27 Convert2Double added
2010-07-09 PB V2.28 pErrorValue and pstatus can be NULL in
edf_open_data_file, edf_close_data_file,
edf_search_stream, edf_read_data_dimension,
edf_search_minmax_number, edf_test_header,
edf_write_data_raw, edf_write_data,
edf_read_data_raw, edf_read_data,
2010-09-08 PB V2.29 exit -> exit(-1)
2010-09-09 PB V2.30 edf_delete_key added
2010-09-09 PB V2.31 range of input variable stream checked
(to avoid memory fault error if outside range)
2010-12-18 PB V2.32 GzipCompression added: binary block output
compression can be chosen with
edf_set_datacompression( DCompression ).
DBlock->Raw, RawBufferLen, RawLen
disk_write_block: put_compressed_block added
sync_data_block, flush_data_block updated,
edf_set_datacompression added.
get_binary_array: updated, data_read_len changed
to bytes_to_read, bytes_read added
2011-01-05 PB V2.33 new public routines:
edf_string2compression, edf_compression2string.
some updates and cleanup in internal block routines:
*pstatus parameter replaced by return value:
disk_write_block
get_data_header (disk_read_header removed),
open_read_block, close_read_block,
open_write_block, close_write_block
updated:
edf_write_data_raw, edf_write_data,
edf_read_header, edf_write_header,
locate_block, put_data_block,
get_data_header, update_general, rewrite_symbol,
update_symbol
2011-01-31 PB V2.34 history_line_add: strncat (non-ansic) replaced
with strncpy
2011-05-25 PB V2.35 newdim -> newcopydim,
newdim allocates only dimension array,
get_data_dim: use newdim
historically, data_dim is allocated with n+2
elements but only n+1 elements are used.
2011-06-01 PB V2.36 read_header_string: status used
2011-06-16 PB V2.37 edf_dump_format: line feed corrected
2011-09-01 PB V2.38 Convert2Long, Convert2Integer, Convert2Short
--------------------------------------------------------------------------*/
/***************************************************************************
* Private part *
***************************************************************************/
/***************************************************************************
* Defines *
***************************************************************************/
#ifdef sun
# include <sys/param.h>
# define GETCWD(x,y) getwd (x)
#else
# ifdef WIN32
# include <direct.h>
# define GETCWD(x,y) _getcwd(x, y)
# else
# define GETCWD(x,y) getcwd (x, y)
# endif
#endif
/***************************************************************************
* Include files *
***************************************************************************/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#ifndef WIN32
# include <unistd.h>
#endif
#include <ctype.h>
#ifdef sun /* sun specific stuff */
# include <sys/time.h>
# include <floatingpoint.h>
#else
# include <time.h>
#endif
# include "edfio.h"
# include "bslio.h"
# include "raster.h"
# include "numio.h"
# include "cmpr.h"
/***************************************************************************
* Macros *
***************************************************************************/
#ifdef sun /* sun specific stuff */
# define ATOF(s) (float) atof (s) /* Sun/gcc doesn't work with strtod */
#else
# define ATOF(s) (float) strtod (s, (char **) NULL)
#endif
# define STRLEN(s) (s == (char *) NULL ? 0 : strlen ( (char *) s))
# define STRCMP(s1,s2) strcmp ( (char *) s1, (char *) s2 )
# define STRCPY(s1,s2) strcpy ( (char *) s1, (char *) s2 )
# define ATOI(s) (int) strtol (s, (char **) NULL, 10)
# define BLANK(c) (c == ' ' || c == '\t' ? True : False)
# define NEWLINE(c) (c == '\n' || c == '\r' ? True : False)
/* CEILMOD: Round N up to the next full multiple of DIV */
# define CEILMOD(N,DIV) (((N)%(DIV))?((DIV)+(N)-(N)%(DIV)):(N))
# define MAX(A,B) ((A)>(B))?(A):(B)
# define MIN(A,B) ((A)<(B))?(A):(B)
/***************************************************************************
* History Line Structure Definition *
***************************************************************************/
typedef struct History_Symbol_List {
char * key; /* pointer to the history key string */
char * line;/*Pointer to the allocated character string with size_t bytes*/
size_t size; /* Allocated number of bytes, including terminating zero */
int required;/*if set, the next argument sets shortlen to strlen(line)*/
size_t shortlen; /* short length, excluding not required parameters */
struct History_Symbol_List *Previous,*Next;/*the previous and next symbols*/
} HSymb;
typedef struct History_Block {
char * key; /* pointer to the history block key string */
HSymb * history_line_root; /* previously created history lines */
HSymb * history_argv_root; /* actually created history line */
char * current_history_line_key;
struct History_Block *Previous, *Next; /* the previous and next block */
} HBlock;
/***************************************************************************
* Header List Structure Definition *
***************************************************************************/
typedef struct Header_Element_Flags {
unsigned short Read; /* header element was already read */
} HEFlags;
typedef struct Header_Element {
char * Key; /* pointer to the header key string */
char * Value; /* Pointer to the allocated character string */
HEFlags Flags;
struct Header_Element *Previous,*Next; /* the previous and next elements */
} HElement;
typedef struct Header_List {
char * Key; /* pointer to the header key string */
HElement * ElementRoot; /* pointer to the allocated character string */
short KeyOrderNo; /* currently used order key */
struct Header_List *Previous,*Next; /* the previous and next elements */
} HList;
/***************************************************************************
* Internal Data Representation *
***************************************************************************/
/*------------------------------------------------------------------------
Internal Data Representation
Data_Block :
BlockKey is the unique name of this data block (usually a number).
BlockKeyLen is the length of the BlockKey (without stop character '\0')
TextPos is the displacement of the header section relative to the
begin of the file.
BinaryPos is the displacement of the binary section relative to the
begin of the file.
TextLen is the actual length of the header section, including padded
white spaces. It must be a multiple of BlockBoundary.
BinaryLen is the length of the binary data section of the data block on
disk. It must be a multiple of BlockBoundary.
Flags are reserved for future use.
PadLen are the number of white-spaces that must be added to adjust
the header section to a multiple of BlockBoundary.
SymbolList is the list of all keywords and values that are listed in
the header.
KeyOrderNo is a temporary variable
DataLen is the number of meaningful bytes that should be written to the
file out of the data buffer or that have been read from a file into the
data buffer. It cannot be larger than BinaryLen.
Data is a typeless pointer to the data buffer. After writing, the data
buffer is automatically discarded, before reading, a sufficiently large
data buffer is allocated, if the NULL pointer is supplied.
---------------------------------------------------------------------------*/
typedef struct Data_Format_Version {
unsigned short Major, /* major version number */
Minor; /* minor version number */
} DFVersion;
typedef struct Data_File_Flags {
unsigned short ExistingFile, /* The file exists and was not
opened with new or temp */
ReadOnlyFile, /* This file is read-only */
TemporaryFile, /* The file was opened with temp*/
NoGeneralHeader; /* The file has no general header */
} DFFlags;
typedef struct Data_Block_Flags {
unsigned short InternalHeader, /* Keep header, but do not write it to disk */
InternalData, /* Keep data internally, never write to disk */
DiskBlockUsed, /* Disk block is used */
DiskBlockFixed, /* Position and length of disk block is fixed */
HeaderExternal, /* The header contents must be read from disk */
HeaderChanged, /* The header contents must be written to disk */
DataExternal, /* The data must be read from disk */
DataChanged, /* The data needs to be written to disk */
ExternalDimAlloc, /* DataDim buffer is externally allocated */
ExternalDataAlloc, /* Data buffer is externally allocated */
BadBlock; /* Do not write this block */
} DBFlags;
typedef struct Symbol_Element_Flags {
unsigned short Read; /* header element was already read */
} SEFlags;
typedef struct Symbol_Element {
char *Key, /* the keyword itself */
*Value; /* it's value */
unsigned long KeyPos, /* position of keyword in file */
ValPos; /* position of value in file */
unsigned short KeyLen, /* length of keyword */
ValLen; /* length of value */
char *String; /* string of all continuation keys, if base key */
unsigned short StringLen; /* length of string buffer */
SEFlags Flags; /* various flags */
struct Symbol_Element *Previous, *Next; /* the previous and next symbols */
struct Data_Block *Block; /* the owning block */
} SElement;
typedef struct Data_Block {
char *BlockKey; /* the block key value of this data block */
unsigned short BlockKeyLen; /* the length of the block key */
unsigned long TextPos, /* start position of this header in the file */
BinaryPos, /* start position of binary section in the file */
TextLen, /* actual length of the ASCII header in bytes */
BinaryLen, /* actual length of the binary section */
PadLen; /* the number of white-spaces for padding */
char *BinaryFileName; /* name of the file with the binary data,
NULL means this file */
unsigned long BinaryFilePos, /* position of binary data in BinaryFileName */
BinaryFileLen; /* actual length of the binary file section */
/* specification of the actually read and converted data in memory */
void *Data; /* pointer to the typeless data buffer */
size_t DataBufferLen; /* allocated length of data buffer in bytes */
size_t DataLen; /* meaningful length of data buffer in bytes */
long DataByteOrder; /* actual byte order of the data */
long DataRasterConfiguration; /* data raster configuration type */
long DataCompression; /* the actual data compression type */
long DataType; /* the actual data type */
long DataValueOffset; /* offset must be added to each data item */
long *DataDim; /* the actual dimensions */
void *Raw; /* pointer to the typeless raw buffer */
size_t RawBufferLen; /* allocated length of raw buffer in bytes */
size_t RawLen; /* meaningful length of raw buffer in bytes */
DBFlags Flags; /* various flags */
unsigned long SequenceNumber; /* the sequential number of the block */
SElement *SymbolList; /* the symbol list of this data block */
short KeyOrderNo; /* currently used order key */
SElement *KeyOrderNextSymbol; /* points to next symbol to ordered */
struct Data_Block *Previous, *Next; /* previous and next data block */
struct Data_Chain *Chain; /* the owning chain */
} DBlock;
typedef struct Data_Chain {
char *ChainKey; /* the key string of this chain */
unsigned short ChainKeyLen; /* the length of the chain key */
unsigned short Flags; /* various flags */
DBlock *BlockList; /* the block list of this chain */
struct Data_Chain *Previous, *Next; /* previous and next data block */
struct Data_File *File; /* the owning file */
} DChain;
typedef struct Data_File { /* Definition of a file table */
int Used; /* 1 if in use, 0 if not */
char *Name; /* file name */
FILE *Channel; /* i/o channel */
char *Buffer; /* pointer to IO Buffer */
DFVersion Version; /* data format version */
unsigned long BlockBoundary; /* BlockBoundary of this file */
DFFlags Flags; /* various flags */
DBlock *GeneralBlock; /* pointer to the general block of this file */
DBlock *ActiveBlock; /* pointer to the current active block */
unsigned long NextSequenceNumber; /* sequence number of next
written data block */
DBlock *LastBlockInFile; /* pointer to the last block in the file */
DChain *ChainList; /* the list of data chains in this file */
} DFile;
/***************************************************************************
* Restrictions *
***************************************************************************/
#define MaxFiles EdfMaxFiles /* maximum number of files streams */
#define MaxKeyLen EdfMaxKeyLen /* maximum length of keywords */
#define MaxValLen EdfMaxValLen /* maximum length of values */
#define MaxLinLen EdfMaxLinLen /* maximum line length */
#define MaxConLen MaxLinLen /* maximum continuation line length,*/
/* must be smaller than MaxValLen */
#define MaxDataChains EdfMaxDataChains /* max. number of user data chains */
#define BufferSize EdfBufferSize /* size of input buffer */
#define MaxDimensions EdfMaxDimensions /* limiting number of dimensions */
#define StartHeader '{' /* used to mark the start of a header */
#define EndHeader '}' /* used to mark the end of a header */
#define Separator '=' /* used to separate keyword from value */
#define Terminator ';' /* marker for end of statement */
#define FirstHeader 1 /* Header Numbers start at this value,
Header Numbers are incremented by one
each time a data block is written. */
#define Comment '#' /* comment if first character in line */
#define Continuation '~' /* separator between key and continuation number*/
/***************************************************************************
* General strings *
***************************************************************************/
# define NONE "None"
# define UNDETERMINED "Undetermined"
# define INVALID "Invalid"
/***************************************************************************
* Version and general setup values *
***************************************************************************/
# define DATA_FORMAT_NAME "EDF"
# define DATA_FORMAT_VERSION "2.40"
# define DATA_BLOCKS_DEFAULT UNDETERMINED /* undetermined value */
# define BLOCK_BOUNDARY 512 /* bytes */
# define PAD_WIDTH 78 /* width of padded text +2-0 chars */
# define MAX_LINE_WIDTH 0ul /* maximum width of text lines */
/***************************************************************************
* Header Keywords *
* All keywords that are relevant for the physical data structure start *
* with DATA_FORMAT_PREFIX *
***************************************************************************/
# define DATA_FORMAT_PREFIX DATA_FORMAT_NAME"_"
# define DATA_FORMAT_VERSION_KEY DATA_FORMAT_PREFIX"DataFormatVersion"
# define DATA_BLOCKS_KEY DATA_FORMAT_PREFIX"DataBlocks"
# define BLOCK_BOUNDARY_KEY DATA_FORMAT_PREFIX"BlockBoundary"
# define BLOCK_ID_KEY DATA_FORMAT_PREFIX"DataBlockID"
# define BINARY_SIZE_KEY DATA_FORMAT_PREFIX"BinarySize"
# define HEADER_SIZE_KEY DATA_FORMAT_PREFIX"HeaderSize"
# define BINARY_FILE_NAME_KEY DATA_FORMAT_PREFIX"BinaryFileName"
# define BINARY_FILE_POSITION_KEY DATA_FORMAT_PREFIX"BinaryFilePosition"
# define BINARY_FILE_SIZE_KEY DATA_FORMAT_PREFIX"BinaryFileSize"
/* Version 1.xx keywords relevant for the physical data structure */
# define V1_HEADER_ID_KEY "HeaderID"
# define V1_SIZE_KEY "Size"
# define V1_IMAGE_KEY "Image"
# define V1_SUPPRESS ".Psd"
/* Version 2.xx keywords relevant for the data ordering */
# define GENERAL_CHAIN_KEY "General"
# define GENERAL_BLOCK_KEY "All"
//+++++++++++++ # define DEFAULT_BLOCK_KEY "Default"
# define CHAIN_KEY_DEFINITION DATA_FORMAT_PREFIX"DataKey-"
//+++++++++++++ # define CLASS_KEY "Image"
/* keywords describing the binary data */
# define DIMENSION_KEY_PREFIX "Dim_" /* key prefix for array dimension */
# define BYTE_ORDER_KEY "ByteOrder" /* byte order of a single item */
# define LOW_BYTE_FIRST "LowByteFirst" /* byte order value */
# define HIGH_BYTE_FIRST "HighByteFirst" /* byte order value */
# define FIXED_BYTE_ORDER "FixedByteOrder" /* byte order is fixed */
# define RASTER_CONFIGURATION_KEY "DataRasterConfiguration"
# define COMPRESSION_KEY "Compression"
# define DATA_TYPE_KEY "DataType" /* data type of a single item */
# define DATA_VALUE_OFFSET_KEY "DataValueOffset"
# define FLOAT_IEEE32 "FloatValue" /* data type value */
/* optional keywords */
# define HISTORY_KEY_PREFIX "History-"
/* Version 1.xx keywords */
# define V1_HEADER_ID_KEY "HeaderID"
# define V1_SIZE_KEY "Size"
# define V1_IMAGE_KEY "Image"
/***************************************************************************
* The following translation tables correspond to public enumerated *
* constants. The enums start with 1. 0 to specify an invalid value. *
* The string tables start with INVALID and end with (char *) NULL. *
***************************************************************************/
/***************************************************************************
* Data Type Translation Tables *
* The indices of the tables correspond to enum DType. *
***************************************************************************/
PRIVATE const char * DTypeStringsAliases[18] =
{ INVALID,
"Unsigned8", "Signed8", "Unsigned16", "Signed16",
"Unsigned32", "Signed32", "Unsigned64", "Signed64",
"FloatIEEE32", "DoubleIEEE64", "UnAssigned", "UnAssigned",
"FloatVAX32", "DoubleVAX64", "FloatConvex32", "DoubleConvex64",
(const char *) NULL };
PRIVATE const char * DTypeStringsAliases1[18] =
{ INVALID,
"UnsignedByte", "SignedByte", "UnsignedShort", "SignedShort",
"UnsignedLong", "SignedLong", "Unsigned64", "Signed64",
"Float", "DoubleValue", "UnAssigned", "UnAssigned",
"FloatVAX32", "DoubleVAX64", "FloatConvex32", "DoubleConvex64",
(const char *) NULL };
PRIVATE const char * DTypeStrings[18] =
{ INVALID,
"UnsignedByte", "SignedByte", "UnsignedShort", "SignedShort",
"UnsignedInteger", "SignedInteger", "Unsigned64", "Signed64",
"FloatValue", "DoubleValue", "UnAssigned", "UnAssigned",
"FloatVAX32", "DoubleVAX64", "FloatConvex32", "DoubleConvex64",
(const char *) NULL };
PRIVATE const size_t DSize[17] =
{ 0lu,
1lu, 1lu, 2lu, 2lu,
4lu, 4lu, 8lu, 8lu,
4lu, 8lu, 0lu, 0lu,
4lu, 8lu, 4lu, 8lu };
/***************************************************************************
* Byte Order Translation Tables *
* The constants correspond to enum BOrder. *
***************************************************************************/
PRIVATE const char * BOrderStrings[5] = { INVALID,
LOW_BYTE_FIRST, HIGH_BYTE_FIRST,
FIXED_BYTE_ORDER,
(const char *) NULL };
/***************************************************************************
* Data Compression Translation Tables *
* The constants correspond to enum DCompression. *
***************************************************************************/
PRIVATE const char * DCompressionStrings[] = { INVALID,
NONE,
"GzipCompression",
"ZCompression",
(const char *) NULL };
PRIVATE const char * DCompressionStringsAliases[] = { INVALID,
"UnCompressed" ,
"GzipCompression",
"ZCompression",
(const char *) NULL };
PRIVATE const char * DCompressionStringsAliases1[] = { INVALID,
"NoSpecificValue" ,
"Gzip",
"Z",
(const char *) NULL };
/***************************************************************************
* Data block classes and instances *
* The constants correspond to enum DBClass and enum DBInstance. *
***************************************************************************/
PRIVATE const char * DBClassStrings[4] = { INVALID,
"General",
"Image",
(const char *) NULL };
PRIVATE const char * DBInstanceStrings[4] = { INVALID,
"Psd" ,
"Error",
(const char *) NULL };
/***************************************************************************
* Private constants and variables *
***************************************************************************/
PRIVATE char *DataFormatVersion = DATA_FORMAT_VERSION;
PRIVATE char *New = "new", *Old = "old", *Any = "any", *Read = "read";
PRIVATE char *Temp = "temp";
PRIVATE char white_spaces[7] = { ' ', '\t', '\r', '\n', '\f', '\v', '\0' };
PRIVATE char quote_chars[2] = { '\"', '\0' };
PRIVATE char numbers[11] = { '0','1','2','3','4','5','6','7','8','9', '\0' };
PRIVATE char tobequoted[8] = { '(', ')', '[', ']', '{', '}', '*' , '\0' };
// PRIVATE char header_begin[5] = { '\n', StartHeader, '\r', '\n', '\0' };
PRIVATE char header_begin[4] = { StartHeader, '\r', '\n', '\0' };
PRIVATE char header_end[5] = { '\r', '\n', EndHeader, '\n', '\0' };
PRIVATE char symbol_separator[4] = { ' ', Separator, ' ', '\0' };
PRIVATE char symbol_terminator[5] = { ' ', Terminator, '\r', '\n', '\0' };
PRIVATE char line_feed[3] = { '\n', '\0', '\0' }; /* DOS { '\r', '\n', '\0' }*/
PRIVATE int InitTable = 0;
PRIVATE DFile FileTable[MaxFiles];
PRIVATE char IDBuffer[3*MaxKeyLen+1];
PRIVATE int EDFIO_debug = 0;
PRIVATE int write_general_block = 0; /* default without general header */
PRIVATE int write_headersize = 1; /* default: with header size */
PRIVATE unsigned long minimum_headersize_out = 8192l; /* minimum header size */
PRIVATE int data_type_out = InValidDType;/* no specific data type */
PRIVATE int data_compression_out= InValidDCompression; /* unspcfc cmpr */
PRIVATE long data_value_offset_out = 0l; /* default is no offset */
PRIVATE int bsl_input_byteorder = InValidBOrder; /* default: not spec. */
PRIVATE unsigned long max_line_width = MAX_LINE_WIDTH; /* default line width */
enum DFType { InValidDFType, EdfType, BslType }; /* data format types */
enum SMode { CaseSensitiveSort, UpperCaseSort, NumberSort };
/***************************************************************************
* Prototypes *
***************************************************************************/
PRIVATE const char * ByteOrder2String( int byte_order );
PRIVATE SElement ** keyorder_ordersymbols( DBlock * block );
PRIVATE int byteorder ( void );
PRIVATE int history_line_new ( HSymb ** proot,
const char * history_line_key, size_t history_size,
HSymb ** phline );
PRIVATE int keyorder_compare( const char *key, const char *criterion );
PRIVATE long *get_data_dim ( DBlock * block );
PRIVATE int get_data_type ( DBlock * block );
/***************************************************************************
* Routines that return internal parameters *
***************************************************************************/
unsigned long edf_maxfiles( void )
{ return ( MaxFiles ); }
unsigned long edf_maxkeylen ( void )
{ return ( MaxKeyLen ); }
unsigned long edf_maxvallen ( void )
{ return ( MaxValLen ); }
unsigned long edf_maxlinlen ( void )
{ return ( MaxLinLen ); }
unsigned long edf_maxdatachains ( void )
{ return ( MaxDataChains ); }
unsigned long edf_buffersize ( void )
{ return ( BufferSize ); }
unsigned long edf_maxdimensions ( void )
{ return ( MaxDimensions ); }
int edf_byteorder ( void )
{ return ( byteorder ( ) ); }
/***************************************************************************
* Routines *
***************************************************************************/
/*+++------------------------------------------------------------------------
NAME
edfio_version
SYNOPSIS
char *edfio_version ( void )
DESCRIPTION
Returns a pointer to the version string of the module edfio
RETURN VALUE
Pointer to the version string
-------------------------------------------------------------------------+*/
char *edfio_version ( void ) /*---*/
{
# ifdef EVERSION
# define _EDFIO_VERSION EDFIO_VERSION" ("EVERSION")"
# else
# define _EDFIO_VERSION EDFIO_VERSION
# endif
return ( _EDFIO_VERSION );
} /* edfio_version */
/*+++------------------------------------------------------------------------
NAME
byteorder
SYNOPSIS
int byteorder ( void )
DESCRIPTION
Checks the byte order of the machine
byteorder : HighByteFirst, big endian byte order
byteorder : LowByteFirst, little endian byte order
RETURN VALUE
byteorder : HighByteFirst | LowByteFirst
-------------------------------------------------------------------------+*/
PRIVATE int byteorder ( void )
{ short int one = 1;
int value;
switch ((int) *(char *) &one) {
case 1: value = LowByteFirst; break;
case 0: value = HighByteFirst; break;
default: value = InValidBOrder;
}
return( value );
} // byteorder
/*+++------------------------------------------------------------------------
NAME
edf_general_block --- write/dont write file with general header
SYNOPSIS
int edf_general_block ( int writetodisk );
DESCRIPTION
writetodisk : 1, write general header
writetodisk : 0, do not write general header (default)
RETURN VALUE
SUCCESS: 0
---------------------------------------------------------------------------*/
int edf_general_block ( int writetodisk ) /*---*/
{ write_general_block = writetodisk;
return(0);
} /* edf_general_block */
/*+++------------------------------------------------------------------------
NAME
edf_headersize --- write/dont write header size into header
SYNOPSIS
int edf_headersize ( int writetodisk );
DESCRIPTION
writetodisk : 1, write header size into header (default)
writetodisk : 0, do not write header size
RETURN VALUE
SUCCESS: 0
---------------------------------------------------------------------------*/
int edf_headersize ( int writetodisk ) /*---*/
{ write_headersize = writetodisk;
return(0);
} /* edf_headersize */
/*+++------------------------------------------------------------------------
NAME
edf_set_minimumheadersize --- sets minimum header size
SYNOPSIS
int edf_set_minimumheadersize( unsigned long minimumheadersize_out )
DESCRIPTION
The actual output headersize is rounded to the next multiple of
BLOCK_BOUNDARY that is larger or equal to the maximum of
minimumheadersize_out and the minimum required size to write all
header values.
RETURN VALUE
SUCCESS: 0
---------------------------------------------------------------------------*/
int edf_set_minimumheadersize ( unsigned long minimumheadersize_out )
{ minimum_headersize_out = minimumheadersize_out;
return(0);
} /* edf_set_minimumheadersize */
/*+++------------------------------------------------------------------------
NAME
edf_set_datatype --- set data type of all output files
SYNOPSIS
int edf_set_datatype ( int datatype_out );
DESCRIPTION
edf_set_datatype sets the output data type for all output data written
with edf_write_data. If necessary a data type conversion will be done. If
datatype_out is InValidDType (default) the machine data are written without
conversion. This change is immediately active globally. It can be done before
each call to edf_write_data.
edf_set_datatype modifies only the action of edf_write_data. It has no
effect on any other function.
edf_set_datatype(InValidDType) returns to the default.
RETURN VALUE
SUCCESS: 0
---------------------------------------------------------------------------*/
int edf_set_datatype ( int datatype_out ) /*---*/
{ data_type_out = datatype_out;
return(0);
} /* edf_set_datatype */
/*+++------------------------------------------------------------------------
NAME
edf_set_datacompression --- set data compression of all output files
SYNOPSIS
int edf_set_datacompression ( int datacompression_out );
DESCRIPTION
edf_set_datacompression sets the output data compression for all data
written with edf_write_data and edf_write_data_raw. If
datacompression_out is InValidDCompression (default) or UnCompressed
the data are written without compression. This change is immediately
active globally. It can be done before each call to edf_write_data or
edf_write_data_raw.
edf_set_datatype influences only edf_write_data and edf_write_data_raw.
It has no effect on any other function.
edf_set_datacompression(InValidDCompression) returns to the default.
RETURN VALUE
SUCCESS: 0
---------------------------------------------------------------------------*/
int edf_set_datacompression ( int datacompression_out ) /*---*/
{ data_compression_out = datacompression_out;
return(0);
} /* edf_set_datacompression */
/*+++------------------------------------------------------------------------
NAME
edf_set_datavalueoffset --- set data value offset of all output files
SYNOPSIS
int edf_set_datavalueoffset ( long int datavalueoffset_out );
DESCRIPTION
RETURN VALUE
SUCCESS: 0
---------------------------------------------------------------------------*/
int edf_set_datavalueoffset ( long int datavalueoffset_out ) /*---*/
{ data_value_offset_out = datavalueoffset_out;
return(0);
} /* edf_set_datavalueoffset */
/*+++------------------------------------------------------------------------
NAME
edf_set_bsl_input_byteorder --- set the byteorder for all bsl input files
SYNOPSIS
int edf_set_bsl_input_byteorder ( int byteorder )
DESCRIPTION
Changes the byte order of all bsl input files to byteorder
byteorder : HighByteFirst, big endian byte order
byteorder : LowByteFirst, little endian byte order
(default byte order: INTERNAL_BYTEORDER)
RETURN VALUE
0: success
--------------------------------------------------------------------------+*/
int edf_set_bsl_input_byteorder ( int byteorder ) /*---*/
{ bsl_input_byteorder = byteorder;
return(0);
} /* edf_set_bsl_input_byteorder */
/*+++------------------------------------------------------------------------
NAME
edf_set_max_line_width --- set maximum line width
SYNOPSIS
int edf_set_max_line_width ( unsigned long width );
DESCRIPTION
width = 0 : no limitation
width > 0 : length of header line limited to width (text lines only)
RETURN VALUE
SUCCESS: 0
HISTORY
2000-04-07 : Peter Boesecke
---------------------------------------------------------------------------*/
int edf_set_max_line_width ( unsigned long width ) /*---*/
{ max_line_width = width;
return(0);
} /* edf_set_max_line_width */
/*---------------------------------------------------------------------------
NAME
getpath_edf --- extract path from filename
SYNOPSIS
char *getpath_edf ( char *buffer, size_t buflen, const char * filename );
DESCRIPTION
Extract path from filename and copies it into buffer. If the buffer is
too short or another error has occurred NULL is returned. If filename
has no path the current working directory is determined with
getcwd and returned.
HISTORY
23-Mar-1998 Peter Boesecke
---------------------------------------------------------------------------*/
char * getpath_edf ( char * buffer, size_t buflen, const char * filename )
{ size_t str_len;
char *ps;
str_len = strlen(filename);
if (str_len>=buflen) return( (char *) NULL );
if ((ps = strrchr( filename, (int) '/' ))) {
memcpy( buffer, filename, (ps-filename) );
buffer[(ps-filename)]='\0'; }
else GETCWD( buffer, buflen );
str_len = strlen(buffer);
if (str_len<buflen) { buffer[str_len]='/';buffer[str_len+1]='\0'; }
else buffer[0] = '\0';
return ( buffer );
} /* getpath_edf */
/*===string_access BEGIN===================================================*/
/*---------------------------------------------------------------------------
NAME
catstr --- allocates memory and copies two character strings into it
SYNOPSIS
char * catstr( const char * a, const char * b );
DESCRIPTION
Allocates strlen(a)+strlen('b')+1 bytes of memory and copies a and 'b'
into it. In case of success the pointer to the allocated memory is returned.
The null pointer is returned in case of an error.
If a or 'b' are NULL pointers the NULL pointer is returned.
RETURN VALUE
Returns the pointer to the allocated string or (char *) NULL in case
of an error.
---------------------------------------------------------------------------*/
char * catstr( const char * a, const char * b )
{ char * value;
size_t lena, lenb;
if (!(a&&b)) return( (char *) NULL );
lena = strlen(a);
lenb = strlen(b);
if (!(value = (char *) malloc(lena+lenb+1)))
return((char *) NULL);
(void) STRCPY(value,a);
(void) STRCPY((value+lena),b);
return( value );
} /* catstr */
/*---------------------------------------------------------------------------
NAME
newstr --- allocate memory and copy a character string into it
SYNOPSIS
char * newstr( const char * string );
DESCRIPTION
Allocates strlen(string)+1 bytes of memory and copies string into it.
In case of success the pointer to the allocated memory is returned. The
null pointer is returned in case of an error.
If string is the NULL pointer the NULL pointer is returned.
RETURN VALUE
Returns the pointer to the allocated string or (char *) NULL in case
of an error.
---------------------------------------------------------------------------*/
char * newstr( const char * string )
{ char * value;
if (!string) return( (char *) NULL );
if (!(value = (char *) malloc(STRLEN(string)+1))) return((char *) NULL);
(void) STRCPY(value,string);
return( value );
} /* newstr */
/*---------------------------------------------------------------------------
NAME
newstrn --- create new string with maximum length
SYNOPSIS
char * newstr( const char * string, size_t maxlen );
DESCRIPTION
Allocates MIN(maxlen,strlen(string))+1 bytes of memory and copies not
more than maxlen characters of 'string' into it.
In case of success the pointer to the allocated memory is returned. The
null pointer is returned in case of an error.
If string is the NULL pointer the NULL pointer is returned.
RETURN VALUE
Returns the pointer to the allocated string or (char *) NULL in case
of an error.
---------------------------------------------------------------------------*/
char * newstrn( const char * string, size_t maxlen )
{ size_t newlen;
char * value;
if (!string) return( (char *) NULL );
if (!maxlen) return( (char *) NULL );
newlen = MIN(maxlen,STRLEN(string));
if (!(value = (char *) malloc(newlen+1))) return((char *) NULL);
(void) strncpy(value,string,newlen);
value[newlen]='\0'; // terminating zero
return( value );
} /* newstrn */
/*---------------------------------------------------------------------------
NAME
newstring --- allocates and initializes memory for a string with stringlen
SYNOPSIS
char * newstring( size_t stringlen );
DESCRIPTION
Allocates stringlen+1 bytes of memory and initializes the first element
with a terminating 0.
In case of success the pointer to the allocated memory is returned. The
null pointer is returned in case of an error.
RETURN VALUE
Returns the pointer to the allocated string or (char *) NULL in case
of an error.
---------------------------------------------------------------------------*/
char * newstring( size_t stringlen )
{ char * value;
if (!(value = (char *) malloc(stringlen+1))) return((char *) NULL);
value[0] = '\0';
return( value );
} /* newstring */
/*---------------------------------------------------------------------------
NAME
newdim --- allocate N+1 elements for dimension array
SYNOPSIS
long * newdim( long N );
DESCRIPTION
Allocates a long array with N+2 elements and copies N to newdim[0].
RETURN VALUE
Returns the pointer to the allocated dimension array and (long *) NULL
in case of an error.
---------------------------------------------------------------------------*/
long * newdim( long N )
{ long * newdimension;
long idim;
if (!(newdimension = (long *) malloc(sizeof(long)*(N+2l)) ))
return((long *) NULL);
/* copy dim to newdimension */
newdimension[0]=N;
for (idim=1;idim<=N;idim++) newdimension[idim] = 0l;
newdimension[N+1l]=0l;
return( newdimension );
} /* newdim */
/*---------------------------------------------------------------------------
NAME
newcopydim --- allocate memory and copy the data dimension into it
SYNOPSIS
long * newcopydim( const long * dim );
DESCRIPTION
Creates a duplicate of the dimension array dim.
If dim is the NULL pointer the NULL pointer is returned.
RETURN VALUE
Returns the pointer to the allocated dimension array and (long *) NULL
in case of an error. In case of an error no memory is allocated.
---------------------------------------------------------------------------*/
long * newcopydim( const long * dim )
{ long * newdimension;
long N, idim;
if (!dim) return( (long *) NULL );
N = dim[0];
if ( !(newdimension = newdim( N )) )
return((long *) NULL);
/* copy dim to newdimension */
for (idim=0;idim<=N;idim++) newdimension[idim] = dim[idim];
return( newdimension );
} /* newcopydim */
/*---------------------------------------------------------------------------
NAME
copydim --- copy the data dimension from dim to buffer
SYNOPSIS
long * copydim( long buffer[], long N, const long dim[] )
DESCRIPTION
Copies the elements of dim[] between dim[0] and dim[dim[0]] to buffer.
N is the required output dimension number. At least N+1 elements must have
been allocated for buffer (long buffer[N+2]). buffer[0] is set to N.
If N is larger than dim[0] the remaining elements of buffer are filled
with 1. If N is smaller than dim[0] the routine does generally stop with
an error, except in the case where all elements dim[>N] are 1.
N must be at least
equal to dim[0],
RETURN VALUE
Returns the pointer to buffer or (long *) NULL in case of an error.
---------------------------------------------------------------------------*/
long * copydim( long buffer[], long N, const long dim[] )
{
long idim, idim_max;
if ( (!dim) || (!buffer) ) return ( (long *) NULL );
if (dim[0]<N) idim_max = dim[0]; else idim_max = N;
/* number of output dimensions */
buffer[0] = N;
/* copy the input dims */
for (idim=1l;idim<=idim_max;idim++) {
buffer[idim] = dim[idim];
}
/* set the remaining output dims to 1 */
for (idim=idim_max+1l;idim<=N;idim++) {
buffer[idim] = 1l;
}
/* are the remaining input dims 1? */
for (idim=N+1l;idim<=dim[0];idim++) {
if (dim[idim]!=1l) return( (long *) NULL );
}
return ( buffer );
} /* copydim */
/*+++------------------------------------------------------------------------
NAME
edf_dataformat_version --- return edf data format version string
SYNOPSIS
char * edf_dataformat_version ( void )
DESCRIPTION
Returns the edf data format version string.
RETURN VALUE
Pointer to edf data format version string.
-------------------------------------------------------------------------+*/
char * edf_dataformat_version ( void ) /*---*/
{ return( DataFormatVersion );
} /* edf_dataformat_version */
/*---------------------------------------------------------------------------
s2u_long( string )
Conversion of a string to unsigned long. In case of an error the return
value is 0.
---------------------------------------------------------------------------*/
unsigned long s2u_long( const char * string )
{ unsigned long value;
if ( sscanf(string,"%lu", &value ) < 1 ) return( 0u );
return(value);
} /* s2u_long */
/*---------------------------------------------------------------------------
u_long2s( buffer, value )
Conversion of an unsigned long integer to a string and output to buffer. The
pointer to buffer is returned. In case of an error the null pointer is returned.
---------------------------------------------------------------------------*/
char * u_long2s( char buffer[], unsigned long value )
{
if ( sprintf(buffer,"%lu", value ) < 1 ) return( (char *) NULL);
return(buffer);
} /* u_long2s */
/*---------------------------------------------------------------------------
long2s( buffer, value )
Conversion of a long integer to a string and output to buffer. The pointer to
buffer is returned. In case of an error the null pointer is returned.
---------------------------------------------------------------------------*/
char * long2s( char buffer[], long int value )
{
if ( sprintf(buffer,"%ld", value ) < 1 ) return( (char *) NULL);
return(buffer);
} /* long2s */
/*---------------------------------------------------------------------------
float2s( buffer, value )
Conversion of float to string and output to buffer. The pointer to
buffer is returned. In case of an error the null pointer is returned.
---------------------------------------------------------------------------*/
char * float2s( char buffer[], float value )
{
if ( sprintf(buffer,"%g", value ) < 1 ) return( (char *) NULL);
return(buffer);
} /* float2s */
/*---------------------------------------------------------------------------
strtolower
DESCRIPTION
Converts the character string str into lower case.
---------------------------------------------------------------------------*/
char *strtolower ( char *str )
{ char *ps=str;
while (*ps) { *ps=tolower(*ps); ps++; }
return(str);
} /*strtolower*/
/*---------------------------------------------------------------------------
NAME
has_extension
SYNOPSIS
int has_extension ( const char * str );
DESCRIPTION
Returns 1 if str contains a '.', 0, if not.
HISTORY
30-Mar-2001 Peter Boesecke
---------------------------------------------------------------------------*/
int has_extension ( const char * str )
{ int dot = (int) '.';
if ( strchr( str, dot ) )
return(1); /* with extension */ else return(0); /* no extension */
} /* has_extension */
/*---------------------------------------------------------------------------
NAME
is_white
SYNOPSIS
int is_white ( char c );
DESCRIPTION
Returns 1 if c is a white space, 0, if not.
HISTORY
18-Jan-1998 Peter Boesecke
---------------------------------------------------------------------------*/
int is_white ( char c )
{
if ( strchr( white_spaces, (int) c ) )
return(1); /* white space */ else return(0); /* no white space */
} /* is_white */
/*---------------------------------------------------------------------------
NAME
is_quote
SYNOPSIS
int is_quote ( char c );
DESCRIPTION
Returns 1 if c is a quotation character, 0, if not.
HISTORY
27-Feb-2005 Peter Boesecke
---------------------------------------------------------------------------*/
int is_quote ( char c )
{
if ( strchr( quote_chars, (int) c ) )
return(1); /* quote */ else return(0); /* no quote */
} /* is_quote */
/*---------------------------------------------------------------------------
NAME
is_number
SYNOPSIS
int is_number ( char c );
DESCRIPTION
Returns 1 if c is a number ('0'..'9'), 0 if not.
HISTORY
15-Feb-1998 Peter Boesecke
---------------------------------------------------------------------------*/
int is_number ( char c )
{
if ( strchr( numbers, (int) c ) )
return(1); /* number */ else return(0); /* no number */
} /* is_number */
/*---------------------------------------------------------------------------
NAME
is_tobequoted
SYNOPSIS
int is_tobequoted ( char c );
DESCRIPTION
Returns 1 if c is a character that must be quoted on a command line, 0, if not.
HISTORY
1999-06-26 Peter Boesecke
---------------------------------------------------------------------------*/
int is_tobequoted ( char c )
{
if ( strchr( tobequoted, (int) c ) )
return(1); /* must be quoted */ else return(0); /* no quotes */
} /* is_tobequoted */
/*---------------------------------------------------------------------------
NAME
white2space
SYNOPSIS
char white2space ( const char c );
DESCRIPTION
If c is a white space it is replaced by space, otherwise c.
HISTORY
18-Jan-1998 Peter Boesecke
---------------------------------------------------------------------------*/
char white2space ( const char c )
{ if (is_white(c)) return(' '); else return(c);
} /* white2space */
/*---------------------------------------------------------------------------
strtrm
DESCRIPTION
Removes leading and trailing white spaces from input string str and copies
it to buffer. The buffer is filled as much as possible, buffer and str can
be identical. If str is the NULL pointer it is handled like an empty string.
In case of success, the pointer to buffer is returned, otherwise NULL.
The routine fails if buffer is the NULL pointer or buflen <1.
---------------------------------------------------------------------------*/
char *strtrm ( char buffer[], unsigned long buflen, const char *str )
{ const char *ps, *pstart, *pend;
char *pb;
unsigned long len;
long unsigned int i;
if ((!buffer)||(buflen<1)) return ( (char*) NULL );
buffer[0]='\0';
if (!str) return( buffer );
len=strlen(str);
pstart=str;
pend=str+len;
// search start (first non-white character in str)
while ( (pstart<pend) && is_white(*pstart) ) pstart++;
// search end (last non-white character in str)
pend--;
while ( (pstart<pend) && is_white(*pend) ) pend--;
ps=pstart;
pb=&buffer[0];
for (i=1;i<buflen;i++) {
if (ps>pend) break;
*pb++=*ps++;
}
*pb='\0';
return( buffer );
} /* strtrm */
/*---------------------------------------------------------------------------
NAME
replace_string -- replaces *pstring with string.
SYNOPSIS
int replace_string( char ** pstring, const char * string );
DESCRIPTION
The memory to which pstring points is released. pstring is replaced
by a pointer to a new allocated memory with strlen(string)+1 bytes.
string is copied into this memory.
CHANGED
The memory at *pstring is released, new memory is allocated and filled
with string, pstring is replaced by a pointer to this memory.
RETURN VALUE
0: OK
-1: error, probably memory could not be allocated.
---------------------------------------------------------------------------*/
int replace_string( char ** pstring, const char * string )
{ const char * nix = { '\0' };
char * tmp;
if (!(pstring)) return(-1); /* cannot be changed */
if (!(string)) string = nix;
tmp = newstr( string ); if (!tmp ) return(-1);
if (*pstring) free(*pstring);
*pstring = tmp;
return(0);
} /* replace_string */
/*---------------------------------------------------------------------------
NAME
breakval - break a value string
SYNOPSIS
char * breakval( char buffer[], unsigned long buflen, const char * string,
unsigned long pos1, unsigned long pos2 )
DESCRIPTION
Breaks a value string into several lines. A symbol break ("'\r''\n''\'")
is inserted after the last space in a line before pos1. If no space appears
the string is broken at pos1. After the first inserted break the position
is reset to 1 and the following lines are broken at pos2. The input string
must be a result of str2val. '\r' and '\n' characters are ignored. This
transformation should only be applied once.
If pos1 or pos2 are less or equal to 1 the line is not broken.
Appends a
RETURN VALUES
pointer to the value
HISTORY
2000-04-06 Peter Boesecke
---------------------------------------------------------------------------*/
char * breakval( char buffer[], unsigned long buflen, const char * string,
unsigned long pos1, unsigned long pos2 )
{ unsigned long i, is;
unsigned long pos, poss;
unsigned long breakpos = pos1;
char *pb = buffer, *pbs;
const char *ps = string, *pss;
char c;
/* initialize buffer */
buffer[0] = '\0';
if (!string) return( buffer );
if (pos1<=1) pos1 = 0U; // minimum length 2 characters
if (pos2<=1) pos2 = 0U; // minimum length 2 characters
i = 0U;
pbs = pb; pss = ps;
while ( (i<buflen-1) && (*ps) ) {
pos = 0U;
poss = pos; is = i;
// break at last space
while ( (i<buflen-1) && (*ps) && (pos<breakpos-1) ) {
if ((*ps) == '\r') ps++; // ignore cr
else if ((*ps) == '\n') ps++; // ignore lf
else if ((*ps) == '\\') { // copy escape sequence ...
c = *ps; ps++;
if ((*ps) == ('\r')) { ps++; c = (char) 0; }
if ((*ps) == ('\n')) { ps++; c = (char) 0; }
if ((c) && (i<buflen-2)) { // but ignore '\'[cr]lf
*pb = c; pb++; *pb = *ps; pb++; ps++;
i+=2; pos+=2;
}
}
else if (((*ps) == ' ') && (i<buflen-4)) { // copy space and remember
if (i<buflen-1) {
*pb = *ps; pb++; ps++; i++; pos++;
}
pbs = pb; pss = ps; poss = pos; is = i; // remember position
}
else { *pb = *ps; pb++; ps++; i++; pos++; }
}
// break
if ((poss!=0U) && (*ps)) { pb = pbs; ps = pss; pos = poss; i = is; }
if (*ps) {
if (ps[1]) {
if (i<buflen-3) {
*pb = '\\'; pb++; *pb = '\r'; pb++; *pb = '\n'; pb++;
i+=3; pos=0U;
pbs = pb; pss = ps; poss = pos; is = i; breakpos = pos2;
}
} else { if (*ps!='\\') { *pb = *ps; pb++; ps++; i++; pos++; } }
}
}
// copy rest
while ( (i<buflen-1) && (*ps) ) {
if ((*ps) == '\r') ps++; // ignore cr
else if ((*ps) == '\n') ps++; // ignore lf
else if ((*ps) == '\\') { // copy escape sequence ...
c = *ps; ps++;
if ((*ps) == ('\r')) { ps++; c = (char) 0; }
if ((*ps) == ('\n')) { ps++; c = (char) 0; }
if ((c)&&(i<buflen-2)) { // but ignore '\'[cr]lf
*pb = c; pb++; *pb = *ps; pb++; ps++;
i+=2; pos+=2;
}
}
else { *pb = *ps; pb++; ps++; i++; pos++;
}
}
// terminate string
*pb = '\0'; pb++;
return( buffer );
} /* breakval */
/*---------------------------------------------------------------------------
NAME
val2str - transform a value string to a standard string
SYNOPSIS
char *val2str( char buffer[], unsigned long buflen, const char * value );
DESCRIPTION
Transformation of a value string to a string. A value string contains
'\' escape sequence for some characters which must not appear in the header
section. The result is written to buffer, which has the size buflen. The
maximum length of the output string is buflen-1. The transformation starts
witht the first non white-space in value and stops with the last non
white-space of value. If buffer is too short the value is only partially
transformed.
A NULL pointer (value) is handled like an empty string.
The following transformations are done:
- Removing leading and trailing white spaces.
- Removing encapsulation between double quotes.
- Transformation of escape sequences to ASCII characters:
'\''l' => line_feed
'\''r' => '\r'
'\''n' => '\n'
'\''s' => ' '
'\''t' => '\t'
'\''v' => '\v'
'\''f' => '\f'
'\''(' => '{'
'\'')' => '}'
'\'':' => ';'
'\''\r' => skipped
'\''\n' => skipped
'\'<character> => <character>
'\r' and '\n' are skipped
A single '\' at the end of the string is skipped.
RETURN VALUES
pointer to string
HISTORY
25-Jan-1998 Peter Boesecke
06-Apr-2000 PB '\''\r' => skipped and '\''\n' => skipped
---------------------------------------------------------------------------*/
char *val2str( char buffer[], unsigned long buflen, const char * value )
{ unsigned long i;
unsigned long last; /* points after the last non-white character */
char *pb = buffer;
const char *pv = value;
/* initialize buffer */
*pb = '\0';
/* return empty string if value is NULL */
if (!value) return( buffer );
/* skip everything before the first non-white character */
while ( is_white(*pv) && (*pv) ) { pv++; }
/* Remove leading double quote */
if ( (*pv) == '"' ) pv++;
/* Read value until end of value string or until buffer full */
last = i = 0U;
while ( (i<buflen-strlen(line_feed)) && (*pv) ) {
if ( ((*pv) == '\r') || ((*pv) == '\n') ) { pv++; } else
if ((*pv) == '\\') {
pv++;
if (*pv) {
if ((*pv) == ':') { *pb = ';'; pb++; i++; }
else if ((*pv) == ')') { *pb = '}'; pb++; i++; }
else if ((*pv) == '(') { *pb = '{'; pb++; i++; }
else if ((*pv) == 's') { *pb = ' '; pb++; i++; }
else if ((*pv) == 't') { *pb = '\t'; pb++; i++; }
else if ((*pv) == 'f') { *pb = '\f'; pb++; i++; }
else if ((*pv) == 'v') { *pb = '\v'; pb++; i++; }
else if ((*pv) == 'n') { *pb = '\n'; pb++; i++; }
else if ((*pv) == 'r') { *pb = '\r'; pb++; i++; }
else if ((*pv) == 'l') {
*pb='\0';strcat(pb,line_feed);
pb+=strlen(line_feed);
i+=strlen(line_feed); }
else if ( ((*pv) == '\r') || ((*pv) == '\n') ) { pv++; }
else {*pb = *pv; pb++; i++; }
pv++; last = i;
}
} else { *pb = *pv; pv++; i++; if (!(is_white(*pb))) last = i; pb++; }
} /* while */
/* Remove all trailing white spaces */
pb += (last-i); i = last;
/* Remove trailing double quote */
if ( (i>0) && ( buffer[i-1] == '"' ) ) { pb--; i--; }
/* String end marker */
*pb = '\0'; pb++; i++;
return(buffer);
} /* val2str */
/*---------------------------------------------------------------------------
NAME
str2val - transformation of a string to a value string
SYNOPSIS
char *str2val( char buffer[], unsigned long buflen, const char * string,
const char ** pnext );
DESCRIPTION
Transformation of a string to a value string which can be used in
a key/value statement. The transformed string is written to buffer, which
has the size buflen. The input string is converted until the buffer is filled.
A pointer to the unconverted part of the input string is returned in *pnext.
The syntax of the resulting string is in all cases correct and it can
always be used in a key/value statement. The returned pointer
does not necessarily point to the beginning of buffer.
To write the rest of the string to a subsequent value pnext can be used as
input string in a subsequent call of str2val.
The following transformations are done:
- Encapsulation of the buffer value between double quotes if the first or the
last character of the buffer is a white space.
- Transformation to escape sequences:
'\r''\n' => '\''l'
'\n' => '\''l'
'{' => '\''('
'}' => '\'')'
';' => '\'':'
'\' => '\''\'
To reduce the length of a line '\r''\n' is added after a linefeed escape
symbol '\''l'.
ARGUMENTS
char buffer[] calculation buffer, needs at least 3 elements
unsigned long buflen length of buffer
const char * string input string
const char **pnext pointer to the uncoverted rest of string,
unused if NULL
RETURN VALUES
pointer to output value (points to a position inside buffer, not necessarily
to its start)
HISTORY
1998-01-25 Peter Boesecke
2005-02-20 PB pnext added
---------------------------------------------------------------------------*/
char *str2val( char buffer[], unsigned long buflen, const char * string,
const char ** pnext )
{ unsigned long i;
char *pb = buffer;
char *value;
const char *ps = string;
/* Read string until end of string or until buffer full */
i = 0U;
*pb = '"'; pb++; i++; // first character is reserved for double quote
*pb = '\0'; // second character is initialized with terminating zero
if (!string) return(pb); // return empty string if input pointer is NULL
while ( (i<buflen-2) && (*ps) ) {
if ((*ps) == '\r') {
*pb='\\'; pb++; *pb='l'; pb++; i+=2; ps++; if ((*ps) == '\n') ps++;
if (i<buflen-4) { *pb='\r'; pb++; *pb='\n'; pb++; i+=2; } }
else if ((*ps) == '\n') { *pb='\\'; pb++; *pb='l'; pb++; i+=2; ps++;
if (i<buflen-4) { *pb='\r'; pb++; *pb='\n'; pb++; i+=2; } }
else if ((*ps) == '{') { *pb='\\'; pb++; *pb='('; pb++; i+=2; ps++; }
else if ((*ps) == '}') { *pb='\\'; pb++; *pb=')'; pb++; i+=2; ps++; }
else if ((*ps) == ';') { *pb='\\'; pb++; *pb=':'; pb++; i+=2; ps++; }
else if ((*ps) == '\\') { *pb='\\'; pb++; *pb='\\'; pb++; i+=2; ps++; }
else { *pb = *ps; pb++; ps++; i++; }
} /* while */
if (pnext) *pnext = ps;
// encapsulation
if (is_white(buffer[1])||is_white(*(pb-1)) ||
is_quote(buffer[1])||is_quote(*(pb-1))) {
*pb = '"'; pb++; i++; value=buffer;
} else value=&buffer[1];
*pb = '\0'; pb++; i++;
return(value);
} /* str2val */
/*---------------------------------------------------------------------------
NAME
strnpad - copy a string to memory and pad
SYNOPSIS
char *strnpad(char *dest, const char *src, size_t n, int pad);
DESCRIPTION
Copies not more than n characters from src to dest. The copying
stops after n characters. In the case where the length of src is
less than n, the remainder of dest will be padded with the
byte pad. Thus, if there is no null byte among the first n bytes
of src, the result will not be terminated by the byte pad.
If pad is the null byte strnpad works exactly like strncpy.
RETURN VALUE
The strnpad() function returns a pointer to the destination
string dest.
AUTHOR
Peter Boesecke 11-Jan-1998
--------------------------------------------------------------------------*/
char *strnpad(char *dest, const char *src, size_t n, int pad)
{
const char *ps=src;
char *pd=dest;
size_t i=0;
while ((i<n)&&(*ps)) {
*pd=*ps; pd++; ps++;
i++;
}
while (i<n) {
*pd=(char) pad; pd++;
i++;
}
return(dest);
} /* strnpad */
/*---------------------------------------------------------------------------
NAME
suppress_suffix
DESCRIPTION
If the character string key ends with the character string suffix only
the characters before suffix are copied into buffer. If key does not
end with suffix all characters of key are copied into buffer. The
pointer to buffer is returned. If csens is TRUE the comparison is case
sensitive. The length of buffer must be sufficiently long.
---------------------------------------------------------------------------*/
char * suppress_suffix ( char buffer[], const char *key,
const char * suffix, int csens )
{ const char *ps;
char *ps_end, *ps_out;
char sfxbuf[MaxKeyLen+1];
/* copy strings into buffers */
if (key ==(char *) NULL) return((char *) NULL);
if (buffer==(char *) NULL) return((char *) NULL); else STRCPY( buffer, key );
if (suffix==(char *) NULL) sfxbuf[0]='\0'; else STRCPY( sfxbuf, suffix );
/* keep case, if csens is set */
if (!csens) { (void) strtolower(buffer); (void) strtolower(sfxbuf);}
/* compare strings */
ps_end = strstr(buffer,sfxbuf);
if (!((ps_end) && ((ps_end+strlen(sfxbuf))==(buffer+strlen(buffer)))))
ps_end = buffer+strlen(buffer);
/* copy key to buffer */
ps = key;
ps_out = buffer;
while (ps_out<ps_end) {
*ps_out = *ps; ps_out++; ps++;
}
*ps_out='\0'; ps_out++;
return(buffer);
} /* suppress_suffix */
/*---------------------------------------------------------------------------
NAME
is_prefix - returns 1 if key starts with prefix
SYNOPSIS
int is_prefix ( const char *key, const char *prefix, int csens );
DESCRIPTION
If 'key' starts with prefix 1 is returned, in all other cases 0.
(char *) NULL strings are handled like empty strings.
If prefix is an empty string, the returned value is always 0.
If csens is 1 the comparison is case sensitive.
RETURN VALUE
if key start with prefix: 1
if key does not start with prefix or is an empty string: 0
---------------------------------------------------------------------------*/
int is_prefix ( const char *key, const char *prefix, int csens )
{ char keybuf[MaxKeyLen+1];
char prebuf[MaxKeyLen+1];
/* copy strings into buffers */
if (key ==(char*) NULL) keybuf[0]='\0';
else { strncpy(keybuf,key,MaxKeyLen); keybuf[MaxKeyLen]='\0'; }
if (prefix==(char*) NULL) prebuf[0]='\0';
else { strncpy(prebuf,prefix,MaxKeyLen); prebuf[MaxKeyLen]='\0'; }
/* empty prefix? */
if (strlen(prebuf)==0) return(0);
/* convert to lower case */
if (!csens) {
strtolower(prebuf);
strtolower(keybuf);
}
/* compare buffers */
if (keybuf == strstr(keybuf,prebuf))
return(1); else return(0);
} /* is_prefix */
/*---------------------------------------------------------------------------
continuation_key
returns a continuation key according to depth, e.g.
depth key continuation_key
0 History-1 History-1
1 History-1 History-1~1
2 History-2 History-1~2
etc.
The return value is NULL if the buffer is too short to create the
continuation key or, in case that depth is larger than zero, if key
contains already a continuation marker.
---------------------------------------------------------------------------*/
const char * continuation_key( char buffer[], unsigned long buflen,
const char *key, int depth )
{ const char *value;
char newkey[MaxKeyLen+1];
if (depth<1) value = key;
else {
strtrm( newkey, MaxKeyLen+1, key );
if ( ( (strlen(newkey)+2+(int)log10(depth)) < buflen )
&& ( !(strchr(newkey,Continuation)) ) ) {
sprintf(buffer,"%s%c%u",newkey,Continuation,depth);
value = buffer;
} else {
value = (const char *) NULL;
}
}
return ( value );
} // continuation_key
/*---------------------------------------------------------------------------
NAME
continuation_depth - returns the continuation depth of key
SYNOPSIS
long continuation_depth ( const char *key );
DESCRIPTION
If 'key' terminates with the continuation marker '~' followed by a positive
integer number the integer number is returned as continuation number. If
'key' does not contain a continuation marker 0 is returned. A valid
continuation key is defined as
<key> := <keybase>['~'<continuation number>]
<continuation number> := 1|2|...|n|n+1... (positive decimal number)
(char *) NULL strings are handled like empty strings. The value 0 is
returned. If the number after a continuation marker is invalid -1 is returned.
RETURN VALUE
continuation number
---------------------------------------------------------------------------*/
long continuation_depth ( const char *key )
{ char keybuf[MaxKeyLen+1];
const char *ps;
long tmp, number=0l;
int numc=0;
char rest;
/* copy strings into buffers */
if (key ==(char*) NULL) keybuf[0]='\0';
else strtrm(keybuf,MaxKeyLen+1,key);
/* search for first occurence of continuation marker */
ps=strchr(keybuf, (int) Continuation );
if (ps) {
numc=sscanf(++ps,"%ld%c",&tmp,&rest);
if ((numc==1)&&(tmp>0)) number=tmp;
else number=-1l;
}
return( number );
} /* continuation_depth */
/*---------------------------------------------------------------------------
NAME
compare_keys --- compares two strings (<0, 0, >0)
SYNOPSIS
enum SMode { CaseSensitiveSort, UpperCaseSort, NumberSort };
SMode sortmode;
int compare_keys( const char *key1, const char *key2, int sortmode );
DESCRIPTION
The comparison is done for printable characters only, except spaces. Other
characters are suppressed. The comparison is done for a maximum of MaxKeyLen
characters (including all characters, printable and non-printable).
In sort mode NumberSort all characters are converted to uppercase, a leading
'+' or '-' sign and multiple leading '0's are removed.
The comparison is only done for the key base until the first occurrence of a
continuation marker. The part after the continuation marker is converted to
a continuation number. If the comparison of two key bases returns 0 the key
order is determined from the continuation numbers.
NULL pointers (key1 and key2) are handled like empty strings.
GCC AND G++
For compatibility between g++ and gcc the variable declaration
"SMode sortmode" has been changed back to "int sortmode". The g++ declaration
was:
int compare_keys( const char *key1, const char *key2, SMode sortmode );
It could not be compiled with gcc
RETURN VALUES
The routine returnes as result:
input cont. number output
key1 < key2 any -1
num1 < num2 -1
key1 = key2 num1 = num2 0
num1 > num2 +1
key1 > key2 any +1
In the case that a key (marked with TRUE) starts with DATA_FORMAT_PREFIX
the following values are returned:
TRUE = key starts with DATA_FORMAT_PREFIX
FALSE = key does not start with DATA_FORMAT_PREFIX
key1 key2 result
FALSE FALSE normal comparison
FALSE TRUE +1
TRUE TRUE normal comparison
TRUE FALSE -1
HISTORY
Peter Boesecke
---------------------------------------------------------------------------*/
int compare_keys( const char * key1, const char * key2, int sortmode )
{ register int i,j;
char buf1[MaxKeyLen+1], buf2[MaxKeyLen+1];
char *pc1, *pc1o, *pc2, *pc2o;
const char *prefix = DATA_FORMAT_PREFIX;
long num1, num2;
char stop1='\0', stop2='\0';
int l1,l2;
int vz1=1, vz2=1;
int p1, p2;
int comparison;
/* check prefix */
p1 = is_prefix ( key1, prefix, False );
p2 = is_prefix ( key2, prefix, False );
if ((!p1) && p2) return(+1); /* key2 has prefix */
if (p1 && (!p2)) return(-1); /* key1 has prefix */
num1 = continuation_depth ( key1 );
if (num1>0) stop1=Continuation; // don't stop if depth invalid
num2 = continuation_depth ( key2 );
if (num2>0) stop2=Continuation; // don't stop if depth invalid
/* compare key bases before first occurence of a stop marker */
pc1 = &buf1[0]; pc2 = &buf2[0];
switch ( sortmode ) {
case CaseSensitiveSort :
if (key1) for (i=0;(i<MaxKeyLen)&&(*key1)&&(*key1!=stop1);i++) {
if (isgraph(*key1)) *pc1++=*key1++; else key1++;
}
*pc1='\0';
if (key2) for (i=0;(i<MaxKeyLen)&&(*key2)&&(*key2!=stop2);i++) {
if (isgraph(*key2)) *pc2++=*key2++; else key2++;
}
*pc2='\0';
break;
case UpperCaseSort :
if (key1) for (i=0;(i<MaxKeyLen)&&(*key1)&&(*key1!=stop1);i++) {
if (isgraph(*key1)) *pc1++=toupper(*key1++); else key1++;
}
*pc1='\0';
if (key2) for (i=0;(i<MaxKeyLen)&&(*key2)&&(*key2!=stop2);i++) {
if (isgraph(*key2)) *pc2++=toupper(*key2++); else key2++;
}
*pc2='\0';
break;
case NumberSort :
if (key1) for (i=0;(i<MaxKeyLen)&&(*key1)&&(*key1!=stop1);i++) {
if (isgraph(*key1)) *pc1++=toupper(*key1++); else key1++;
}
*pc1='\0';
if (key2) for (i=0;(i<MaxKeyLen)&&(*key2)&&(*key2!=stop2);i++) {
if (isgraph(*key2)) *pc2++=toupper(*key2++); else key2++;
}
*pc2='\0';
/* remove a leading '+' or a leading '-' and
remove afterwards multiple leading '0's */
pc1o = pc1 = &buf1[0];
if (*pc1=='+') pc1++; else if (*pc1=='-') {vz1=-1;pc1++;}
pc2o = pc2 = &buf2[0];
if (*pc2=='+') pc2++; else if (*pc2=='-') {vz2=-1;pc2++;}
if (vz1<vz2) return(-1); else if (vz2<vz1) return(1);
while (*pc1 == '0') pc1++; if (*pc1 == '\0') *pc1o++='0';
while (*pc1) *pc1o++ = *pc1++; *pc1o='\0';
while (*pc2 == '0') pc2++; if (*pc2 == '\0') *pc2o++='0';
while (*pc2) *pc2o++ = *pc2++; *pc2o='\0';
/* pad strings with leading '0's to same lengths */
l1=STRLEN(buf1); l2=STRLEN(buf2);
if (l1!=l2) {
if ( l1<l2) {
for (i=l2,j=l1;j>=0;i--,j--) buf1[i]=buf1[j];
for (;i>=0;i--) buf1[i]='0';
} else {
for (i=l1,j=l2;j>=0;i--,j--) buf2[i]=buf2[j];
for (i=i;i>=0;i--) buf2[i]='0';
}
}
break;
default : printf("ERROR: Unknown sortmode\n"); exit(-1); break;
}
comparison = vz1*STRCMP(buf1,buf2);
/* continuation keys are placed after their base keys in the order
of the continuation depth, keys with the same base keys but
invalid depth are placed after all continuation keys */
if (comparison==0) {
if ((num1>=0)&&(num2>=0)) { // no change if both are equal
if (num1<num2) comparison = -1;
else if (num1>num2) comparison = 1;
} else { // no change if both are negative
if ((num1<0)&&(num2>=0)) comparison = 1;
else if ((num1>=0)&&(num2<0)) comparison = -1;
}
}
return( comparison );
} /* compare_keys */
/*--------------------------------------------------------------------------
NAME
str2version --- convert string to version
SYNOPSIS
DFVersion str2version( const char * string )
DESCRIPTION
The version string must have the following format: Vmajor.minor. It must
not contain white spaces. V is a non-numeric character string. It is
ignored and can be omitted. major and minor are numeric character strings
of type "unsigned short". major and minor are separated by '.'. If '.'
or minor is missing the value of minor is set to 0.
In case of an error the program is terminated.
RETURN VALUE
DFVersion version, the converted version
---------------------------------------------------------------------------*/
DFVersion str2version( const char * string )
{ const char * ConversionError = "SEVERE ERROR converting version string ";
const char * vs = string;
DFVersion version;
unsigned long int major = 0u, minor = 0u;
int npar;
while ( (*vs) && (!(is_number(*vs))) ) vs++;
npar = sscanf(vs, "%lu.%lu",&major, &minor);
if ( npar < 1 ) {
fprintf(stderr,"%s\"%s\"\n", ConversionError, string);
exit(-1);
} else if ( npar < 2 ) minor = 0u;
version.Major = (unsigned short int) major;
version.Minor = (unsigned short int) minor;
return(version);
} /* str2version */
/*--------------------------------------------------------------------------
NAME
version2str --- write version to string
SYNOPSIS
char * version2str( char buffer[], unsigned long buflen, DFVersion version );
DESCRIPTION
The created version string has the following format:
version.Major.version.Minor .
In case of an error -1 is returned.
RETURN VALUE
pointer to string
---------------------------------------------------------------------------*/
char * version2str( char buffer[], unsigned long buflen, DFVersion version )
{ const unsigned long outlen = MaxValLen+1;
char out[MaxValLen+1], *pi, *pd;
unsigned long length;
sprintf(out, "%u.%2u", version.Major, version.Minor);
length = (outlen<buflen)?(outlen-1):(buflen-1);
memset(buffer,'0',length);
pd = &buffer[0]; pi = &out[0];
while (*pi) { if (*pi!=' ') *pd=*pi; pi++; pd++; }
*pd = '\0';
return( &buffer[0] );
} /* version2str */
/*--------------------------------------------------------------------------
NAME
compare_versions --- compare versions (v1<v2:-1,v1==v2:0,v1>v2:1)
SYNOPSIS
typedef struct Data_Format_Version {
unsigned short Major, Minor;
} DFVersion;
int compare_versions( DFVersion version1, DFVersion version2 );
DESCRIPTION
The comparison is done in the following way:
major1 = version1.Major, etc.
major1<major2 -1
major1=major2, minor1<minor2 -1
major1=major2, minor1=minor2 0
major1=major2, minor1>minor2 1
major1>major2 1
RETURN VALUE
-1, 0, 1 depending on the comparison
---------------------------------------------------------------------------*/
int compare_versions( DFVersion version1, DFVersion version2 )
{ int result;
if ( version1.Major<version2.Major ) result = -1;
else if ( version1.Major>version2.Major ) result = +1;
else if ( version1.Minor<version2.Minor ) result = -1;
else if ( version1.Minor>version2.Minor ) result = +1;
else result = 0;
return(result);
} /* compare_versions */
/*===string_access END==================================================---*/
/*===data_structure BEGIN==================================================*/
/*---------------------------------------------------------------------------
NAME
init_data_file_flags --- initialize data file flags
SYNOPSIS
init init_data_file_flags( DFFlags * Flags )
RETURN VALUE
success: 0
error: not 0
---------------------------------------------------------------------------*/
int init_data_file_flags( DFFlags * Flags )
{
Flags->ExistingFile = (unsigned short) False;
Flags->ReadOnlyFile = (unsigned short) False;
Flags->TemporaryFile = (unsigned short) False;
if (write_general_block)
Flags->NoGeneralHeader = (unsigned short) False;
else Flags->NoGeneralHeader = (unsigned short) True;
return(0);
} /* init_data_file_flags */
/*---------------------------------------------------------------------------
print_data_file_flags (success:0, error:-1)
---------------------------------------------------------------------------*/
int print_data_file_flags ( FILE * out, const DFFlags * Flags )
{
fprintf(out,"Flags\n");
fprintf(out," ExistingFile = %hu\n",Flags->ExistingFile);
fprintf(out," ReadOnlyFile = %hu\n",Flags->ReadOnlyFile);
fprintf(out," TemporaryFile = %hu\n",Flags->TemporaryFile);
fprintf(out," NoGeneralHeader = %hu\n",Flags->NoGeneralHeader);
return(0);
} /* print_data_file_flags */
/*---------------------------------------------------------------------------
init_file
---------------------------------------------------------------------------*/
void init_file ( DFile * file )
{
file->Used = False;
file->Name = (char *) NULL;
file->Channel = (FILE *) NULL;
file->Buffer = (char *) NULL;
file->Version = str2version( DataFormatVersion );
file->BlockBoundary = (unsigned long) BLOCK_BOUNDARY;
init_data_file_flags( &(file->Flags) );
file->GeneralBlock = (DBlock *) NULL;
file->ActiveBlock = (DBlock *) NULL;
file->NextSequenceNumber = (unsigned long) FirstHeader;
file->LastBlockInFile = (DBlock *) NULL;
file->ChainList = (DChain *) NULL;
} /* init_file */
/*---------------------------------------------------------------------------
init_file_table
---------------------------------------------------------------------------*/
void init_file_table( DFile ftb[] )
/* Init file table, set InitTable to 1 */
{ register int i;
for (i=0;i<MaxFiles;i++) init_file ( &ftb[i] );
InitTable = 1;
} /* init_file_table */
/*---------------------------------------------------------------------------
search_free_stream (success:0, error:-1)
---------------------------------------------------------------------------*/
int search_free_stream( DFile *ftb )
/* Return the index of the first unused file table cell, return
-1 if failed */
{ register int i;
for (i=0;i<MaxFiles;i++) {
if (!ftb[i].Used) return(i);
}
return(-1);
} /* search_free_stream */
/*---------------------------------------------------------------------------
search_stream (success:0, error:-1)
---------------------------------------------------------------------------*/
int search_stream( DFile *ftb, const char * fname )
/* Return the index of the first opened file called fname,
return -1 if failed */
{ register int i;
for (i=0;i<MaxFiles;i++) {
if (ftb[i].Used) {
if (!strcmp(ftb[i].Name,fname)) return(i);
}
}
return(-1);
} /* search_stream */
/*---------------------------------------------------------------------------
NAME
init_symbol_element_flags --- initialize symbol element flags
SYNOPSIS
init init_symbol_element_flags( SEFlags * Flags )
RETURN VALUE
success: 0
error: not 0
---------------------------------------------------------------------------*/
int init_symbol_element_flags( SEFlags * Flags )
{
Flags->Read = (unsigned short) 0;
return(0);
} /* init_symbol_element_flags */
/*---------------------------------------------------------------------------
print_symbol_element_flags (success:0, error:-1)
---------------------------------------------------------------------------*/
int print_symbol_element_flags ( FILE * out, const SEFlags * Flags )
{
fprintf(out," Flags\n");
fprintf(out," Read = %hu\n",Flags->Read);
return(0);
} /* print_symbol_element_flags */
/*---------------------------------------------------------------------------
NAME
insert_symbol -- insert/update key in symbol-list of block
SYNOPSIS
int insert_symbol( DBlock * block, const char * Key,
const char * Value, SElement ** symbol );
DESCRIPTION
If 'Key' already exists (success), its 'Value' is updated and the 'symbol'
pointer is returned in *symbol if symbol is not the NULL pointer. Data
format keys are inserted before all others. 'String' is not updated.
RETURN VALUE
Key successfully updated, symbol pointer to symbol returned
in *symbol, return value 0
Key updated failed: -1, *symbol set to NULL pointer
---------------------------------------------------------------------------*/
int insert_symbol( DBlock * block, const char * Key,
const char * Value, SElement ** symbol )
{
SElement * newsymbol, * next, * previous;
char * tmp;
int notfound = -1;
/* initialize *symbol */
if (symbol) *symbol = (SElement *) NULL;
/* check Key */
if ( Key == (const char *) NULL ) return(-1); // Key required
/* check Value */
if ( Value == (const char *) NULL ) return(-1); // Value required
/* check block */
if ( block == (DBlock *) NULL ) return(-1); // block cannot be NULL
/* warning, if Key too long */
if ( strlen(Key)>MaxKeyLen ) {
// fprintf(stderr,"\nWARNING: The length %zu of %10s... exceeds %d\n",
fprintf(stderr,"\nWARNING: The length %zu | %lu of %10s... exceeds %d\n",
strlen(Key), strlen(Key), Key, MaxKeyLen ); }
previous = (SElement *) NULL;
next = block->SymbolList;
/* search insertion point (insertion before next) */
while( ( next!=(SElement *) NULL ) && (notfound<0) ) {
notfound = compare_keys(next->Key,Key,UpperCaseSort);
if (notfound<0) {previous = next; next = next->Next;}
}
/* create new symbol, if (notfound) */
if ( notfound ) {
/* create new symbol */
if (!(newsymbol = (SElement *) malloc( sizeof(SElement) ) )) return(-1);
newsymbol->Key = newstrn( Key, MaxKeyLen );
if (!newsymbol->Key) { free(newsymbol); return(-1); }
newsymbol->Value = (char *) NULL;
newsymbol->KeyPos = (unsigned long) 0;
newsymbol->ValPos = (unsigned long) 0;
newsymbol->KeyLen = (unsigned short) STRLEN(Key);
newsymbol->ValLen = (unsigned short) 0;
newsymbol->String = (char *) NULL;
newsymbol->StringLen = (unsigned short) 0;
init_symbol_element_flags( &(newsymbol->Flags) );
/* insert newsymbol before next */
if (next) next->Previous = newsymbol;
newsymbol->Next=next;
newsymbol->Previous=previous;
if (previous) previous->Next=newsymbol;
else block->SymbolList = newsymbol;
/* link to owning block */
newsymbol->Block = block;
next = newsymbol;
}
/* update Value (Value and original next->Value can be identical!) */
tmp = newstr( Value ); if (!tmp) return(-1);
if ( next->Value ) free ( next->Value );
next->Value = tmp;
next->ValLen = (unsigned short) STRLEN(Value);
if (symbol) *symbol = next;
block->KeyOrderNextSymbol = block->SymbolList;
block->KeyOrderNo = 0;
return(0);
} /* insert_symbol */
/*---------------------------------------------------------------------------
NAME
search_symbol -- search for Key in symbol-list of block
SYNOPSIS
int search_symbol( DBlock * block, const char * Key, SElement ** symbol );
DESCRIPTION
Searches for 'Key' and returns a pointer to it in *symbol, if symbol is not
the NULL pointer. 'String' is not updated.
RETURN VALUE
Key found, symbol pointer returned in **symbol, return value 0
Key not found: -1, pointer (SElement *) NULL returned in **symbol
---------------------------------------------------------------------------*/
int search_symbol( DBlock * block, const char * Key, SElement ** symbol )
{
SElement * current;
/* initialize *symbol */
if (symbol) *symbol = (SElement *) NULL;
/* check Key */
if ( Key == (const char *) NULL ) return(-1); // Key required
/* check block */
if ( block == (DBlock *) NULL ) return(-1); // block cannot be NULL
/* warning, if Key too long */
if ( strlen(Key)>MaxKeyLen ) {
// fprintf(stderr,"\nWARNING (search_symbol): The length %zu of %10s... exceeds %d\n",
fprintf(stderr,"\nWARNING (search_symbol): The length %zu | %lu of %10s... exceeds %d\n",
strlen(Key), strlen(Key), Key, MaxKeyLen ); }
/* search symbol */
current = block->SymbolList;
if ( current!=(SElement *) NULL )
while( ( current!=(SElement *) NULL ) &&
( compare_keys(current->Key,Key,UpperCaseSort)!=0 ) ) {
current = current->Next;
}
if (symbol) *symbol = current;
if (current==(SElement *) NULL) return(-1);
return(0);
} /* search_symbol */
/*---------------------------------------------------------------------------
NAME
delete_symbol -- deletes 'symbol' from symbol-list of block
SYNOPSIS
int delete_symbol( DBlock * block, SElement * symbol, SElement ** Next )
DESCRIPTION
The routine ends with success if the symbol 'symbol' is not any more present,
even if it symbol is the NULL pointer. A pointer to the element after the
deleted element is returned (ignored if Next is the NULL pointer).
RETURN VALUE
success:0, error:-1
---------------------------------------------------------------------------*/
int delete_symbol( DBlock * block, SElement * symbol, SElement ** Next )
{ SElement *previous, *next;
/* initialize *Next */
if (Next) *Next = (SElement *) NULL;
/* check symbol */
if (!symbol) return(0); // nothing to delete
/* check block */
if ( block == (DBlock *) NULL ) return(-1); // block cannot be NULL
/* change links */
previous = symbol->Previous;
next = symbol->Next;
if ( next != (SElement *) NULL ) next->Previous = previous;
if ( previous != (SElement *) NULL ) previous->Next = next;
else block->SymbolList = next;
/* remove symbol */
free(symbol->Key);
free(symbol->Value);
if (symbol->String) free(symbol->String);
free(symbol);
block->KeyOrderNextSymbol = block->SymbolList;
block->KeyOrderNo = 0;
if (Next) *Next = next;
return(0);
} // delete_symbol
/*---------------------------------------------------------------------------
NAME
remove_symbol -- removes key from symbol-list of block
SYNOPSIS
int remove_symbol( DBlock * block, const char * Key, SElement ** Next );
DESCRIPTION
The routine ends with success if the symbol is not any more present, even
if it does not exist before the call of this function. A pointer to the
element after the removed element is returned (ignored if Next is the NULL
pointer).
RETURN VALUE
success:0, error:-1
---------------------------------------------------------------------------*/
int remove_symbol( DBlock * block, const char * Key, SElement ** Next )
{
SElement * current;
/* initialize *Next */
if (Next) *Next = (SElement *) NULL;
/* check Key */
if ( Key == (const char *) NULL ) return(0); // nothing to remove any more
/* check block */
if ( block == (DBlock *) NULL ) return(-1); // block cannot be NULL
/* warning, if Key too long */
if ( strlen(Key)>MaxKeyLen ) {
// fprintf(stderr,"\nWARNING: The length %zu of %10s... exceeds %d\n",
fprintf(stderr,"\nWARNING: The length %zu | %lu of %10s... exceeds %d\n",
strlen(Key), strlen(Key), Key, MaxKeyLen ); }
/* search symbol */
current = block->SymbolList;
if ( current!=(SElement *) NULL )
while( ( current!=(SElement *) NULL ) &&
( compare_keys(current->Key,Key,UpperCaseSort)!=0 ) ) {
current = current->Next;
}
/* stop, if no symbol found */
if (current==(SElement *) NULL) return(0);
/* remove current */
if (delete_symbol( block, current, Next )) return(-1);
return(0);
} /* remove_symbol */
/*---------------------------------------------------------------------------
insert_symbol_root (success:0, error:-1)
The symbol is inserted directly at the root of the list. A symbol with
the same name is removed before inserting.
---------------------------------------------------------------------------*/
int insert_symbol_root( DBlock * block, const char * Key,
const char * Value, SElement ** symbol )
{
SElement * newsymbol, * next, * previous;
char * tmpKey, * tmpValue;
/* warning, if Key too long */
if ( strlen(Key)>MaxKeyLen ) {
// fprintf(stderr,"\nWARNING: The length %zu of %10s... exceeds %d\n",
fprintf(stderr,"\nWARNING: The length %zu | %lu of %10s... exceeds %d\n",
strlen(Key), strlen(Key), Key, MaxKeyLen ); }
if ( block == (DBlock *) NULL) return(-1);
/* allocate memory and copy Key and Value to new variables
(Value/Key and original next->Value/Key can be identical!) */
tmpKey = newstrn( Key, MaxKeyLen ); if (!tmpKey) return(-1);
tmpValue = newstr( Value ); if (!tmpValue) {free(tmpKey);return(-1);}
/* remove old symbol */
if ( remove_symbol(block, Key, NULL) ) {free(tmpKey);free(tmpValue);return(-1);}
*symbol = (SElement *) NULL;
previous = (SElement *) NULL;
next = block->SymbolList;
/* create new symbol */
if (!(newsymbol = (SElement *) malloc( sizeof(SElement) ) )) {
free(tmpKey);free(tmpValue);return(-1);
}
newsymbol->Key = tmpKey;
newsymbol->Value = tmpValue;
newsymbol->KeyPos = (unsigned long) 0;
newsymbol->ValPos = (unsigned long) 0;
newsymbol->KeyLen = (unsigned short) STRLEN(tmpKey);
newsymbol->ValLen = (unsigned short) STRLEN(tmpValue);
newsymbol->String = (char *) NULL;
newsymbol->StringLen = (unsigned short) 0;
init_symbol_element_flags( &(newsymbol->Flags) );
/* insert newsymbol before next */
if (next) next->Previous = newsymbol;
newsymbol->Next=next;
newsymbol->Previous=previous;
if (previous) previous->Next=newsymbol;
else block->SymbolList=newsymbol;
/* link to owning block */
newsymbol->Block = block;
*symbol = newsymbol;
block->KeyOrderNextSymbol = block->SymbolList;
block->KeyOrderNo = 0;
return(0);
} /* insert_symbol_root */
/*---------------------------------------------------------------------------
free_symbol_list (success:0, error:-1)
---------------------------------------------------------------------------*/
int free_symbol_list( DBlock * block )
{
SElement * symbol, * next;
next = block->SymbolList;
block->SymbolList = (SElement *) NULL;
while(next!=(SElement*) NULL) {
symbol = next;
next=next->Next;
free(symbol->Value);
free(symbol->Key);
if (symbol->String) free(symbol->String);
free(symbol);
}
block->KeyOrderNextSymbol = block->SymbolList;
block->KeyOrderNo = 0;
return(0);
} /* free_symbol_list */
/*---------------------------------------------------------------------------
netto_header_length (success:0, error:-1)
Calculation of the netto header length (without PadLen). It includes:
length(header_begin)
+ [ Symbol->KeyLen + length(symbol_separator)
+ Symbol->ValLen + length(symbol_terminator) ] (for symbols)
+ length(header_end)
---------------------------------------------------------------------------*/
unsigned long netto_header_length( DBlock * block )
{ const unsigned long h_begin=(unsigned long) strlen(header_begin);
const unsigned long s_syms =(unsigned long) (strlen(symbol_separator) +
strlen(symbol_terminator));
const unsigned long h_end =(unsigned long) strlen(header_end);
unsigned long h_len;
SElement * symbol;
symbol = block->SymbolList;
h_len = h_begin;
while (symbol!=(SElement*) NULL) {
h_len += (unsigned long) symbol->KeyLen + (unsigned long) symbol->ValLen + s_syms;
symbol=symbol->Next;
}
h_len += h_end;
return(h_len);
} /* netto_header_length */
/*---------------------------------------------------------------------------
print_symbol_list (success:0, error:-1)
---------------------------------------------------------------------------*/
int print_symbol_list( FILE * out, DBlock * block, int level, int verbose )
{ const char * SeparationLine =
"- - - - - - - -";
SElement * symbol;
if (level<1) return(0);
symbol = block->SymbolList;
while (symbol!=(SElement*) NULL) {
if (verbose) {
fprintf(out," %s\n",SeparationLine);
fprintf(out," Key = %s\n",symbol->Key);
fprintf(out," Value = %s\n",symbol->Value);
fprintf(out," KeyPos = %lu\n",symbol->KeyPos);
fprintf(out," ValPos = %lu\n",symbol->ValPos);
fprintf(out," KeyLen = %u\n",symbol->KeyLen);
fprintf(out," ValLen = %u\n",symbol->ValLen);
fprintf(out," String = %s\n",
(symbol->String)?(symbol->String):"(not set)");
fprintf(out," StringLen = %u\n",symbol->StringLen);
print_symbol_element_flags ( out, &(symbol->Flags) );
fprintf(out," Previous Key = ");
if ((symbol->Previous)!=(SElement*) NULL)
fprintf(out,"%s\n", symbol->Previous->Key);
else fprintf(out,"(no previous symbol)\n");
fprintf(out," Next Key = ");
if ((symbol->Next)!=(SElement*) NULL)
fprintf(out,"%s\n", symbol->Next->Key);
else fprintf(out,"(no next symbol)\n");
fprintf(out," Owner Block = %s\n",symbol->Block->BlockKey);
} else {
fprintf(out," '%s' = '%s'\n",symbol->Key,symbol->Value);
}
symbol=symbol->Next;
}
if (verbose) fprintf(out," %s\n",SeparationLine);
return(0);
} /* print_symbol_list */
/*---------------------------------------------------------------------------
NAME
init_data_block_flags --- initialize data block flags
SYNOPSIS
init init_data_block_flags( DBFlags * Flags )
RETURN VALUE
success: 0
error: not 0
---------------------------------------------------------------------------*/
int init_data_block_flags( DBFlags * Flags )
{
Flags->InternalHeader = (unsigned short) 0;
Flags->InternalData = (unsigned short) 0;
Flags->DiskBlockUsed = (unsigned short) 0;
Flags->DiskBlockFixed = (unsigned short) 0;
Flags->HeaderExternal = (unsigned short) 0;
Flags->HeaderChanged = (unsigned short) 0;
Flags->DataExternal = (unsigned short) True;
Flags->DataChanged = (unsigned short) 0;
Flags->ExternalDimAlloc = (unsigned short) 0;
Flags->ExternalDataAlloc = (unsigned short) 0;
Flags->BadBlock = (unsigned short) 0;
return(0);
} /* init_data_block_flags */
/*---------------------------------------------------------------------------
print_data_block_flags (success:0, error:-1)
---------------------------------------------------------------------------*/
int print_data_block_flags ( FILE * out, const DBFlags * Flags )
{
fprintf(out," Flags\n");
fprintf(out," InternalHeader = %hu\n",Flags->InternalHeader);
fprintf(out," InternalData = %hu\n",Flags->InternalData);
fprintf(out," DiskBlockUsed = %hu\n",Flags->DiskBlockUsed);
fprintf(out," DiskBlockFixed = %hu\n",Flags->DiskBlockFixed);
fprintf(out," HeaderExternal = %hu\n",Flags->HeaderExternal);
fprintf(out," HeaderChanged = %hu\n",Flags->HeaderChanged);
fprintf(out," DataExternal = %hu\n",Flags->DataExternal);
fprintf(out," DataChanged = %hu\n",Flags->DataChanged);
fprintf(out," ExternalDimAlloc = %hu\n",Flags->ExternalDimAlloc);
fprintf(out," ExternalDataAlloc = %hu\n",Flags->ExternalDataAlloc);
fprintf(out," BadBlock = %hu\n",Flags->BadBlock);
return(0);
} /* print_data_block_flags */
/*---------------------------------------------------------------------------
insert_data_block (success:0, error:-1)
If 'BlockKey' already exists (success), only the 'block' pointer is returned.
---------------------------------------------------------------------------*/
int insert_data_block( DChain * chain, const char * BlockKey, DBlock ** block )
{
DBlock * newblock, * next, * previous;
int notfound = -1;
/* warning, if BlockKey too long */
if ( strlen(BlockKey)>MaxKeyLen ) {
// fprintf(stderr,"\nWARNING: The length %zu of %10s... exceeds %d\n",
fprintf(stderr,"\nWARNING: The length %zu | %lu of %10s... exceeds %d\n",
strlen(BlockKey), strlen(BlockKey), BlockKey, MaxKeyLen ); }
if ( chain == (DChain *) NULL ) return(-1);
*block = (DBlock *) NULL;
previous = (DBlock *) NULL;
next = chain->BlockList;
/* search insertion point (insertion before *pnext) */
while( ( next!=(DBlock *) NULL ) && (notfound<0) ) {
notfound = compare_keys(next->BlockKey,BlockKey,NumberSort);
if (notfound<0) {previous = next; next = next->Next;}
}
/* create new block, if (notfound) */
if ( notfound ) {
/* create new block */
if (!(newblock = (DBlock *) malloc( sizeof(DBlock) ) )) return(-1);
newblock->BlockKey = newstrn( BlockKey, MaxKeyLen );
if (!newblock->BlockKey) {free(newblock);return(-1);}
newblock->BlockKeyLen = (unsigned short) STRLEN(BlockKey);
newblock->TextPos = (unsigned long) 0;
newblock->BinaryPos = (unsigned long) 0;
newblock->TextLen = (unsigned long) 0;
newblock->BinaryLen = (unsigned long) 0;
newblock->PadLen = (unsigned long) 0;
newblock->BinaryFileName = (char *) NULL;
newblock->BinaryFilePos = (unsigned long) 0;
newblock->BinaryFileLen = (unsigned long) 0;
newblock->Data = (void *) NULL;
newblock->DataBufferLen = (size_t) 0;
newblock->DataLen = (size_t) 0;
newblock->DataType = (long) 0;
newblock->DataByteOrder = (long) 0;
newblock->DataRasterConfiguration = (long) 0;
newblock->DataCompression = (long) 0;
newblock->DataValueOffset = (long) 0;
newblock->DataDim = (long *) NULL;
newblock->Raw = (void *) NULL;
newblock->RawBufferLen = (size_t) 0;
newblock->RawLen = (size_t) 0;
if ( init_data_block_flags( &(newblock->Flags) ) ) return(-1);
newblock->SequenceNumber = (unsigned long) 0;
newblock->SymbolList = (SElement *) NULL;
newblock->KeyOrderNo = 0;
newblock->KeyOrderNextSymbol = (SElement *) NULL;
/* insert newblock before *pnext */
if (next) next->Previous = newblock;
newblock->Next=next;
newblock->Previous=previous;
if (previous) previous->Next=newblock;
else chain->BlockList=newblock;
/* link to owning chain */
newblock->Chain = chain;
next = newblock;
}
*block = next;
return(0);
} /* insert_data_block */
/*---------------------------------------------------------------------------
search_data_block (success:0, error:-1)
---------------------------------------------------------------------------*/
int search_data_block( DChain * chain, const char * BlockKey, DBlock ** block )
{
DBlock * current;
/* warning, if BlockKey too long */
if ( strlen(BlockKey)>MaxKeyLen ) {
// fprintf(stderr,"\nWARNING: The length %zu of %10s... exceeds %d\n",
fprintf(stderr,"\nWARNING: The length %zu | %lu of %10s... exceeds %d\n",
strlen(BlockKey), strlen(BlockKey), BlockKey, MaxKeyLen ); }
/* search block */
current = chain->BlockList;
if (current!=(DBlock *) NULL )
while( ( current!=(DBlock *) NULL ) &&
( compare_keys(current->BlockKey,BlockKey,NumberSort)!=0 ) ) {
current = current->Next;
}
*block = current;
if (current==(DBlock *) NULL) return(-1);
return(0);
} /* search_data_block */
/*---------------------------------------------------------------------------
free_data_block_list (success:0, error:-1)
---------------------------------------------------------------------------*/
int free_data_block_list( DChain * chain )
{
DBlock * block, * next;
next = chain->BlockList;
chain->BlockList = (DBlock *) NULL;
while(next!=(DBlock*) NULL) {
block = next;
next=next->Next;
if ( free_symbol_list( block ) ) return(-1);
if ( block->BinaryFileName ) free( block->BinaryFileName );
if ( block->BlockKey ) free( block->BlockKey );
if ( ( block->DataDim ) && ( !block->Flags.ExternalDimAlloc ) )
free( block->DataDim );
if ( ( block->Data ) && ( !block->Flags.ExternalDataAlloc ) )
free ( block->Data );
if ( block->Raw )
free ( block->Raw );
free(block);
}
return(0);
} /* free_data_block_list */
/*---------------------------------------------------------------------------
print_data_block_list (success:0, error:-1)
---------------------------------------------------------------------------*/
int print_data_block_list( FILE * out, DChain * chain, int level, int verbose )
{ const char * SeparationLine =
"- - - - - - - - - - - - - - -";
long i_dim;
DBlock * block;
if (level<1) return(0);
block = chain->BlockList;
while(block!=(DBlock*) NULL) {
if (verbose) {
fprintf(out," %s\n",SeparationLine);
fprintf(out," BlockKey = %s\n",block->BlockKey);
fprintf(out," BlockKeyLen = %u\n",block->BlockKeyLen);
fprintf(out," TextPos = %lu\n",block->TextPos);
fprintf(out," BinaryPos = %lu\n",block->BinaryPos);
fprintf(out," TextLen = %lu\n",block->TextLen);
fprintf(out," BinaryLen = %lu\n",block->BinaryLen);
fprintf(out," PadLen = %lu\n",block->PadLen);
if ( block->BinaryFileName )
fprintf(out," BinaryFileName = %s\n",block->BinaryFileName);
else
fprintf(out," BinaryFileName = %s\n","(this file)");
fprintf(out," BinaryFilePos = %lu\n",block->BinaryFilePos);
fprintf(out," BinaryFileLen = %lu\n",block->BinaryFileLen);
fprintf(out," Data = %p\n",block->Data);
// fprintf(out," DataLen (DataBufferLen) = %zu (%zu)\n",
fprintf(out," DataLen (DataBufferLen) = %zu | %lu (%lu)\n",
block->DataLen,block->DataLen,block->DataBufferLen);
fprintf(out," DataType = %ld\n",block->DataType);
fprintf(out," DataByteOrder = %s\n",
ByteOrder2String(block->DataByteOrder));
fprintf(out," DataRasterConfiguration = %ld\n",
block->DataRasterConfiguration);
fprintf(out," DataCompression = %s\n",
edf_compression2string(block->DataCompression));
fprintf(out," DataValueOffset = %ld\n",block->DataValueOffset);
fprintf(out," DataDim = %p\n",block->DataDim);
fprintf(out," Raw = %p\n",block->Raw);
// fprintf(out," RawLen (RawBufferLen) = %zu (%zu)\n",
fprintf(out," RawLen (RawBufferLen) = %zu | %lu (%lu)\n",
block->RawLen,block->RawLen,block->RawBufferLen);
if (block->DataDim) for (i_dim=0;i_dim<=block->DataDim[0];i_dim++)
fprintf(out," DataDim[%1lu] = %ld\n",
i_dim,(block->DataDim)[i_dim]);
print_data_block_flags( out, &(block->Flags) );
fprintf(out," SequenceNumber = %lu\n",block->SequenceNumber);
print_symbol_list( out, block, level-1, verbose );
fprintf(out," KeyOrderNo = %d\n",block->KeyOrderNo);
if (block->KeyOrderNextSymbol == (SElement *) NULL ) {
fprintf(out," KeyOrderNextSymbol= (no next symbol)\n");
} else {
fprintf(out," KeyOrderNextSymbol= %s\n",block->KeyOrderNextSymbol->Key);
}
fprintf(out," Previous BlockKey = ");
if ((block->Previous)!=(DBlock*) NULL)
fprintf(out,"%s\n", block->Previous->BlockKey);
else fprintf(out,"(no previous block)\n");
fprintf(out," Next BlockKey = ");
if ((block->Next)!=(DBlock*) NULL)
fprintf(out,"%s\n", block->Next->BlockKey);
else fprintf(out,"(no next block)\n");
fprintf(out," Owner Chain = %s\n",block->Chain->ChainKey);
} else {
fprintf(out," BlockKey = '%s'\n",block->BlockKey);
print_symbol_list( out, block, level-1, verbose );
}
block=block->Next;
}
if (verbose) fprintf(out," %s\n",SeparationLine);
return(0);
} /* print_data_block_list */
/*---------------------------------------------------------------------------
insert_data_chain (success:0, error:-1)
If 'ChainKey' already exists (success), only the 'chain' pointer is returned.
---------------------------------------------------------------------------*/
int insert_data_chain( DFile * file, const char * ChainKey, DChain ** chain )
{
DChain * newchain, * next, * previous;
int notfound = -1;
/* warning, if ChainKey too long */
if ( strlen(ChainKey)>MaxKeyLen ) {
// fprintf(stderr,"\nWARNING: The length %zu of %10s... exceeds %d\n",
fprintf(stderr,"\nWARNING: The length %zu | %lu of %10s... exceeds %d\n",
strlen(ChainKey), strlen(ChainKey), ChainKey, MaxKeyLen ); }
if ( file == (DFile *) NULL ) return(-1);
*chain = (DChain *) NULL;
previous = (DChain *) NULL;
next = file->ChainList;
/* search insertion point (insertion before *pnext) */
while( ( next!=(DChain *) NULL ) && (notfound<0) ) {
notfound = compare_keys(next->ChainKey,ChainKey,UpperCaseSort);
if (notfound<0) { previous = next; next = next->Next; }
}
/* create new chain, if (notfound) */
if ( notfound ) {
/* create new chain */
if (!(newchain = (DChain *) malloc( sizeof(DChain) ) )) return(-1);
newchain->ChainKey = newstrn( ChainKey, MaxKeyLen );
if (!newchain->ChainKey) {free(newchain);return(-1);}
newchain->ChainKeyLen = (unsigned short) STRLEN(ChainKey);
newchain->Flags = (unsigned short) 0;
newchain->BlockList = (DBlock *) NULL;
/* insert newchain before *pnext */
if (next) next->Previous = newchain;
newchain->Next=next;
newchain->Previous=previous;
if (previous) previous->Next = newchain;
else file->ChainList = newchain;
/* link to owning file */
newchain->File = file;
next = newchain;
}
*chain = next;
return(0);
} /* insert_data_chain */
/*---------------------------------------------------------------------------
search_data_chain (success:0, error:-1)
---------------------------------------------------------------------------*/
int search_data_chain( DFile * file, const char * ChainKey, DChain ** chain )
{
DChain * current;
/* warning, if ChainKey too long */
if ( strlen(ChainKey)>MaxKeyLen ) {
// fprintf(stderr,"\nWARNING: The length %zu of %10s... exceeds %d\n",
fprintf(stderr,"\nWARNING: The length %zu | %lu of %10s... exceeds %d\n",
strlen(ChainKey), strlen(ChainKey), ChainKey, MaxKeyLen ); }
/* search chain */
current = file->ChainList;
if ( current!=(DChain *) NULL )
while( ( current!=(DChain *) NULL ) &&
( compare_keys(current->ChainKey,ChainKey,UpperCaseSort)!=0 ) ) {
current = current->Next;
}
*chain = current;
if (current==(DChain *) NULL) return(-1);
return(0);
} /* search_data_chain */
/*---------------------------------------------------------------------------
NAME
free_data_chain --- deletes a data chain and all of its contents
SYNOPSIS
int free_data_chain( DChain * chain );
DESCRIPTION
The memory of all blocks and symbols of the data chain chain is
removed. The data chain is removed from the chain list of the owning
file. If chain was the only chain in chain->File->ChainList
chain->File->ChainList is set to (DChain *) NULL. If chain is
NULL, nothing is done and 0 (success) is returned.
RETURN VALUES
success: 0
error : -1
---------------------------------------------------------------------------*/
int free_data_chain( DChain * chain )
{
DChain **proot, *previous, *next;
if (chain!=(DChain*) NULL) {
proot = &(chain->File->ChainList);
previous = chain->Previous;
next = chain->Next; }
else return(0);
if (next!=(DChain*) NULL) next->Previous = previous;
if (previous!=(DChain*) NULL) previous->Next = next;
if (*proot==chain) { *proot = ((DChain*) NULL); }
if (free_data_block_list( chain )) return(-1);
free(chain->ChainKey);
free(chain);
return(0);
} /* free_data_chain */
/*---------------------------------------------------------------------------
free_data_chain_list (success:0, error:-1)
---------------------------------------------------------------------------*/
int free_data_chain_list( DFile * file )
{
DChain * chain, * next;
next = file->ChainList;
file->ChainList = (DChain *) NULL;
while ( next!=(DChain*) NULL ) {
chain = next;
next=next->Next;
if (free_data_block_list( chain )) return(-1);
free(chain->ChainKey);
free(chain);
}
return(0);
} /* free_data_chain_list */
/*---------------------------------------------------------------------------
print_data_chain_list (success:0, error:-1)
---------------------------------------------------------------------------*/
int print_data_chain_list( FILE * out, DFile * file, int level, int verbose )
{ const char * SeparationLine =
"- - - - - - - - - - - - - - - - - - - - - - - - - - - - -";
DChain * chain;
if (level<1) return(0);
chain = file->ChainList;
while(chain!=(DChain*) NULL) {
if (verbose) {
fprintf(out," %s\n",SeparationLine);
fprintf(out," ChainKey = %s\n",chain->ChainKey);
fprintf(out," ChainKeyLen = %u\n",chain->ChainKeyLen);
fprintf(out," Flags = %#x\n", chain->Flags);
print_data_block_list( out, chain, level-1, verbose );
fprintf(out," Previous ChainKey = ");
if ((chain->Previous)!=(DChain*) NULL)
fprintf(out,"%s\n", chain->Previous->ChainKey);
else fprintf(out,"(no previous chain)\n");
fprintf(out," Next ChainKey = ");
if ((chain->Next)!=(DChain*) NULL)
fprintf(out,"%s\n", chain->Next->ChainKey);
else fprintf(out,"(no next chain)\n");
// fprintf(out," Owner file = %#x\n",chain->File->Channel);
fprintf(out," Owner file = %p\n",chain->File->Channel);
} else {
fprintf(out," ChainKey = '%s'\n",chain->ChainKey);
print_data_block_list( out, chain, level-1, verbose );
}
chain=chain->Next;
}
if (verbose) fprintf(out," %s\n",SeparationLine);
return(0);
} /* print_data_chain_list */
/*+++------------------------------------------------------------------------
NAME
edf_print_filetable (success:0, error:-1)
SYNOPSIS
int edf_print_filetable( FILE * out, int level, int verbose )
DESCRIPTION
Prints the current filetable to the file out
RETURN VALUE
0: success
-1: failed
---------------------------------------------------------------------------*/
int edf_print_filetable( FILE * out, int level, int verbose ) /*---*/
{ const int buflen = MaxValLen+1;
char buffer[MaxValLen+1];
const char * SeparationLine =
"=========================================================";
int stream;
if (level<1) return(0);
if (!InitTable) return(-1);
if (!out) return(-1);
for (stream=0;stream<MaxFiles;stream++)
if (FileTable[stream].Used) {
if (verbose) {
fprintf(out,"%s\n",SeparationLine);
fprintf(out,"Stream = %d\n",stream);
fprintf(out,"Name = %s\n",FileTable[stream].Name);
// fprintf(out,"Channel = %#x\n",FileTable[stream].Channel);
fprintf(out,"Channel = %p\n",FileTable[stream].Channel);
fprintf(out,"Version = %s\n",
version2str(buffer,buflen,FileTable[stream].Version));
fprintf(out,"BlockBoundary = %lu\n",
FileTable[stream].BlockBoundary);
print_data_file_flags ( out, &(FileTable[stream].Flags) );
fprintf(out,"GeneralBlock = ");
if (FileTable[stream].GeneralBlock) {
if (FileTable[stream].GeneralBlock->BlockKey)
fprintf(out,"%s\n",FileTable[stream].GeneralBlock->BlockKey);
else fprintf(out,"(no block key)\n");
} else fprintf(out,"(block not defined)\n");
fprintf(out,"ActiveBlock = ");
if (FileTable[stream].ActiveBlock) {
if (FileTable[stream].ActiveBlock->BlockKey)
fprintf(out,"%s\n",FileTable[stream].ActiveBlock->BlockKey);
else fprintf(out,"(no block key)\n");
} else fprintf(out,"(block not defined)\n");
fprintf(out,"NextSequenceNumber = %lu\n",
FileTable[stream].NextSequenceNumber);
fprintf(out,"LastBlockInFile = ");
if (FileTable[stream].LastBlockInFile) {
if (FileTable[stream].LastBlockInFile->BlockKey)
fprintf(out,"%s\n",FileTable[stream].LastBlockInFile->BlockKey);
else fprintf(out,"(no block key)\n");
} else fprintf(out,"(no block written)\n");
fprintf(out,"ChainList = %p\n",FileTable[stream].ChainList);
print_data_chain_list(out,&FileTable[stream],level-1,verbose);
} else {
fprintf(out,"Stream = '%d'\n",stream);
print_data_chain_list(out,&FileTable[stream],level-1,verbose);
}
}
if (verbose) fprintf(out,"%s\n",SeparationLine);
return(0);
} /* edf_print_filetable */
/*---------------------------------------------------------------------------
NAME
delete_continuationkeys -- delete continuation keys starting at current
SYNOPSIS
int delete_continuationkeys( DBlock * block, SElement *current );
DESCRIPTION
The routine removes any continuation key starting at current, independent
of its name and depth, until the first key with depth <1. If current is
the NULL pointer nothing is done and the return value is 0.
RETURN VALUE
success:0, error:-1
---------------------------------------------------------------------------*/
int delete_continuationkeys( DBlock * block, SElement *current )
{
while ( ( current ) && ( continuation_depth( current->Key ) > 0 ) )
if ( delete_symbol( block, current, ¤t ) ) return(-1);
return(0);
} // delete_continuationkeys
/*---------------------------------------------------------------------------
NAME
update_string --- update symbol string with continuation key values
SYNOPSIS
int update_string( SElement *base, SElement **next );
DESCRIPTION
Updates the base string with continuation key values
RETURN VALUE
0: successful update
-1: failure
---------------------------------------------------------------------------*/
int update_string( SElement *base, SElement **next )
{ SElement *current;
long stringlen=0l, nxtlen;
char *ps;
unsigned long keybuflen = MaxKeyLen+1;
char keybuffer[MaxKeyLen+1];
const char *fkey;
int depth=1;
if (next) *next = (SElement *) NULL;
/* Calculate required string length from accumalated value lengths
The length of a string values is at least the length of the string. */
depth = 0;
current = base;
stringlen = 0l;
fkey = continuation_key( keybuffer, keybuflen, base->Key, depth++ );
while ( (current) && (fkey) ) {
if (compare_keys(current->Key,fkey,UpperCaseSort)==0) {
stringlen += STRLEN( current->Value );
fkey = continuation_key( keybuffer, keybuflen, base->Key, depth++ );
current = current->Next;
} else fkey = (char *) NULL; // stop
}
// allocate and update base String
if ( (base->StringLen<stringlen)||(!(base->String)) ) {
if (base->String) free(base->String);
base->String = newstring( stringlen );
base->StringLen = stringlen;
} else {
stringlen = base->StringLen;
}
(base->String)[0] = '\0';
// copy continuation key values to base string
depth = 0;
current = base;
fkey = continuation_key( keybuffer, keybuflen, base->Key, depth++ );
// read base->string
ps = base->String;
while ( (current) && (fkey) ) {
if (compare_keys(current->Key,fkey,UpperCaseSort)==0) {
if (stringlen>0) {
/* transform value to string and append it to base->String */
val2str( ps, stringlen+1, current->Value );
nxtlen=STRLEN(ps);
ps=&ps[nxtlen];
stringlen-=nxtlen;
}
fkey = continuation_key( keybuffer, keybuflen, base->Key, depth++ );
current = current->Next; // increment only when Key==fkey
} else fkey = (char *) NULL; // stop
}
if (next) *next = current;
return(0);
} // update_string
/*---------------------------------------------------------------------------
NAME
insert_string -- insert/update continuation keys in symbol-list of block
SYNOPSIS
int insert_string( DBlock * block, const char * BaseKey,
const char * String, SElement ** symbol );
DESCRIPTION
The value of 'BaseKey' and all its continuation keys are updated with 'String'.
'String' is copied into the string-symbol of symbol.
Unused continuation keys are removed. If 'BaseKey' does not exist
it is created. 'String' is splitted into values that are each smaller than
MaxConLen (MaxConLen+1 including terminating zero). The pointer to the
created/modified base symbol (with continuation depth 0) is returned.
RETURN VALUE
All continuation keys of 'BaseKey' successfully inserted/updated, symbol
pointer to 'BaseKey' returned in **symbol, return value 0
Insertion/update failed, *symbol set to NULL pointer, return value -1
---------------------------------------------------------------------------*/
int insert_string( DBlock * block, const char * BaseKey,
const char * String, SElement ** symbol )
{
unsigned long buflen = MaxConLen+1;
char buffer1[MaxConLen+1], buffer2[MaxConLen+1];
unsigned long keybuflen = MaxKeyLen+1;
char keybuffer[MaxKeyLen+1];
SElement *current;
const char *val, *bkval, *ps;
const char *fkey;
unsigned long pos1, pos2;
int depth=0;
size_t stringlen;
if (symbol) *symbol = (SElement *) NULL;
// split String
ps = String;
pos2 = max_line_width;
do {
fkey = continuation_key( keybuffer, keybuflen, BaseKey, depth );
if (fkey) {
pos1 = MAX(2, max_line_width - STRLEN(symbol_separator) - STRLEN(fkey));
val = str2val( buffer1, buflen, ps, &ps );
bkval = breakval ( buffer2, buflen, val, pos1, pos2 ); // break line
if ( insert_symbol( block, fkey, bkval, ¤t ) ) return( -1 );
// update base string with input string, allocate memory if necessary
if (depth==0) {
stringlen = STRLEN( String );
if ( ( (current->StringLen) < stringlen ) || (!(current->String)) ) {
if ( current->String ) {
free( current->String );
}
current->String = newstr( String );
current->StringLen = stringlen;
} else {
strcpy(current->String, String );
}
}
}
depth++;
} while ( (*ps)&&(fkey) ); // stop if fkey could not be created
if (symbol) *symbol = current;
// delete unused continuation keys that follow immediately
if ( delete_continuationkeys( block, current->Next ) ) return(-1);
return(0);
} // insert_string
/*---------------------------------------------------------------------------
NAME
search_string -- searches for BaseKey in symbol-list of block
SYNOPSIS
int search_string( DBlock *block, const char *BaseKey, SElement **symbol );
DESCRIPTION
Searches for 'BaseKey' in symbol-list of block. If it was found the
symbol-string is created from the values of 'BaseKey' and of all its
continuation keys. The pointer to 'BaseKey' is returned in symbol if it
is not NULL.
RETURN VALUE
BaseKey found, symbol pointer returned in *symbol, return value 0
BaseKey not found, *symbol set to NULL pointer, return value -1
---------------------------------------------------------------------------*/
int search_string( DBlock *block, const char *BaseKey, SElement **symbol )
{ SElement *base;
// initialize *symbol
if (symbol) *symbol = (SElement *) NULL;
// search BaseKey
if (search_symbol( block, BaseKey, &base )) return(-1);
// update *symbol
if (symbol) *symbol = base;
if ( update_string( base, NULL ) ) return(-1);
return(0);
} // search_string
/*---------------------------------------------------------------------------
NAME
remove_string -- removes continuation keys from symbol-list of block
SYNOPSIS
int remove_string( DBlock * block, const char * Key );
DESCRIPTION
The routine ends with success if neither 'Key' nor its continuation 'Key's
are any more present, even if no key was actually removed.
RETURN VALUE
success:0, error:-1
---------------------------------------------------------------------------*/
int remove_string( DBlock * block, const char * Key )
{ SElement *next;
if ( remove_symbol( block, Key, &next ) ) return(-1);
// delete unused continuation keys that follow immediately
if ( delete_continuationkeys( block, next ) ) return(-1);
return(0);
} // remove_string
/*---------------------------------------------------------------------------
NAME
search_general -- search for key in block and GeneralBlock
SYNOPSIS
int search_general( DBlock * block, const char * Key, SElement ** symbol );
DESCRIPTION
Searches for a key in the symbol list of block. If key was not found
and if it is a user key, it searches afterwards in the general block. A user
key is a key that does not start with DATA_FORMAT_PREFIX. If key was
found the pointer to the symbol element is returned.
RETURN VALUE
key found, symbol pointer returned in **symbol, return value 0
key not found: -1, pointer (SElement *) NULL returned in **symbol
---------------------------------------------------------------------------*/
int search_general( DBlock * block, const char * Key, SElement ** symbol )
{ int return_status;
if ((return_status = search_string( block, Key, symbol ))) {
if (!is_prefix(Key,DATA_FORMAT_PREFIX,UpperCaseSort)) {
return_status = search_string( block->Chain->File->GeneralBlock,
Key, symbol ); }
}
return( return_status );
} /* search_general */
/*===data_structure END=================================================---*/
/*===raster_conversion BEGIN=================================================*/
/* temporarily redefined, should everywhere be replaced by raster.h functions */
int edf_raster_normalization ( void * dest, const void * src,
const long data_dim[],
long raster_configuration, size_t item )
{
return( raster_normalization ( dest, src, data_dim,
raster_configuration, item, NULL ) );
}
long edf_raster_multiplication ( long a, long x )
{
return( raster_multiplication( a, x ) );
} // edf_raster_multiplication
long edf_raster_inversion ( long x )
{
return( raster_inversion ( x ) );
} // edf_raster_inversion
long edf_raster_order2number ( const long order[] )
{
return( raster_order2number( order ) );
} // edf_raster_order2number
/*===raster_conversion END===================================================*/
/*===block_access BEGIN====================================================*/
/*---------------------------------------------------------------------------
NAME
DBClass2String --- converts db_class to a string
SYNOPSIS
DBClass dbclass;
const char * DBClass2String( int db_class );
DESCRIPTION
GCC AND G++
For compatibility between gcc and g++ the declaration of the variable
with its enumerated type has been replaced by "int".
RETURN VALUE
Pointer to a constant result string.
AUTHOR
18-Mar-2000 PB Specification
-------------------------------------------------------------------------*/
const char * DBClass2String( int db_class )
{
if ((db_class<0)||(db_class>=EndDBClass)) db_class = InValidDBClass;
return( DBClassStrings[db_class] );
} /* DBClass2String */
/*---------------------------------------------------------------------------
NAME
String2DBClass --- converts a string to a data block class
SYNOPSIS
(DBClass) int String2DBClass( const char * string );
DESCRIPTION
GCC AND G++
For compatibility between gcc and g++ the declaration of the return
value with its enumerated type has been replaced by "int".
RETURN VALUE
0 : error, e.g. cannot convert
>0 : valid data block class value
AUTHOR
18-Mar-2000 PB Specification
-------------------------------------------------------------------------*/
int String2DBClass( const char * string )
{ int NE=True;
long i = 0;
while ( (NE && DBClassStrings[i]) )
NE = compare_keys( string, DBClassStrings[i++], UpperCaseSort );
i = MAX(0,i-1);
if (NE) return( InValidDBClass );
else return( i );
} /* String2DBClass */
/*---------------------------------------------------------------------------
NAME
DBInstance2String --- converts db_instance to a string
SYNOPSIS
DBInstance db_instance;
const char * DBInstance2String( int db_instance );
DESCRIPTION
GCC AND G++
For compatibility between gcc and g++ the declaration of the variable
with its enumerated type has been replaced by "int".
RETURN VALUE
Pointer to a constant result string.
AUTHOR
18-Mar-2000 PB Specification
-------------------------------------------------------------------------*/
const char * DBInstance2String( int db_instance )
{
if ((db_instance<0)||(db_instance>=EndDBInstance))
db_instance = InValidDBInstance;
return( DBInstanceStrings[db_instance] );
} /* DBInstance2String */
/*---------------------------------------------------------------------------
NAME
String2DBInstance --- converts a string to a data block instance
SYNOPSIS
(DBInstance) int String2DBInstance( const char * string );
DESCRIPTION
GCC AND G++
For compatibility between gcc and g++ the declaration of the return
value with its enumerated type has been replaced by "int".
RETURN VALUE
0 : error, e.g. cannot convert
>0 : valid data block instance value
AUTHOR
18-Mar-2000 PB Specification
-------------------------------------------------------------------------*/
int String2DBInstance( const char * string )
{ int NE=True;
long i = 0;
while ( (NE && DBInstanceStrings[i]) )
NE = compare_keys( string, DBInstanceStrings[i++], UpperCaseSort );
i = MAX(0,i-1);
if (NE) return( InValidDBInstance );
else return( i );
} /* String2DBInstance */
/*---------------------------------------------------------------------------
header_id
Example: HeaderID = EH:000001:000000:000000 ;
---------------------------------------------------------------------------*/
char * header_id( DBlock * block )
{ char KeyVal[MaxKeyLen+1];
char *ps=KeyVal, *pd=IDBuffer;
memset(IDBuffer,'0',MaxKeyLen+1);
(void) sprintf(KeyVal,"EH:%6lu:%6u:%6u",block->SequenceNumber,0,0);
while (*ps) {
if (*ps!=' ') *pd=*ps;
ps++; pd++;
}
*pd = *ps;
return(IDBuffer);
} /* header_id */
/*---------------------------------------------------------------------------
header_id_number
Returns the first header id number
Example: HeaderID = EH:000009:000000:000000 ; -> 9
---------------------------------------------------------------------------*/
long header_id_number( const char * header_id )
{ const char *ps;
long number;
ps=strchr(header_id, (int) ':');
sscanf(++ps,"%ld",&number);
return( number );
} /* header_id_number */
/*---------------------------------------------------------------------------
NAME
block_id
SYNOPSIS
char * block_id( DBlock * block )
DESCRIPTION
If block exists, its block ID string is returned, otherwise NULL.
The block ID is written into IDBuffer and a pointer to IDBuffer is returned.
---------------------------------------------------------------------------*/
char * block_id( DBlock * block )
{
if ( block )
(void) sprintf(IDBuffer,"%s.%s",
block->BlockKey,
block->Chain->ChainKey );
else return ( (char *) NULL );
return(IDBuffer);
} /* block_id */
/*---------------------------------------------------------------------------
NAME
default_chain_key
SYNOPSIS
char *default_chain_key ( char buffer[], long memnum );
DESCRIPTION
The default chainkey for a given memory number (memnum) is written into
the buffer. The generated chainkey has the format:
Image.<DBInstance>.memnum, e.g. "Image.Error.3"
Positive memnum means primary data, negative memnum for variance data. Zero
memnum is not allowed. In case of abs(memnum)==1 the memnum number
is suppressed, e.g. "Image.Psd".
Zero memnum is the general chain.
RETURN VALUE
Pointer to buffer in case of success, otherwise NULL.
---------------------------------------------------------------------------*/
char *default_chain_key ( char buffer[], long memnum )
{ int db_class = DBImage;
int db_instance;
db_instance = InValidDBInstance;
if (memnum<0) db_instance = DBError;
else if (memnum>0) db_instance = DBPrimaryData;
memnum = abs(memnum);
if (memnum==0)
strncpy(buffer,GENERAL_CHAIN_KEY,MaxKeyLen+1);
else if (memnum!=1)
sprintf(buffer,"%s.%s.%lu",
DBClass2String( db_class ), DBInstance2String( db_instance ),
memnum );
else sprintf(buffer,"%s.%s",
DBClass2String( db_class ),DBInstance2String( db_instance ));
return ( buffer );
} /* default_chain_key */
/*---------------------------------------------------------------------------
NAME
print_file_warning
SYNOPSIS
void print_file_warning ( FILE * out, DFile * file, unsigned long position,
const char * warning );
DESCRIPTION
Prints a warning message to out.
---------------------------------------------------------------------------*/
void print_file_warning ( FILE * out, DFile * file, unsigned long position,
const char * warning )
{
fprintf(out,"\n %s FILE WARNING\n",DATA_FORMAT_NAME);
if (warning) fprintf(out," %s\n",warning );
fprintf(out," File name : %s\n", file->Name);
// fprintf(out," File position: %lu (0x%lx)\n", position, position );
fprintf(out," File position: %lu (%#lx)\n", position, position );
if ( block_id(file->LastBlockInFile))
fprintf(out," Last block ID: %s\n",block_id(file->LastBlockInFile));
else fprintf(out," Last block ID: (no block read)\n");
fprintf(out,"\n");
} /* print_file_warning */
/*---------------------------------------------------------------------------
NAME
print_file_error
SYNOPSIS
void print_file_error ( FILE * out, DFile * file, unsigned long position,
const char * error );
DESCRIPTION
Prints a error message to out.
---------------------------------------------------------------------------*/
void print_file_error ( FILE * out, DFile * file, unsigned long position,
const char * error )
{
fprintf(out,"\n %s FILE ERROR\n",DATA_FORMAT_NAME);
if (error) fprintf(out," %s\n",error );
fprintf(out," File name : %s\n", file->Name);
// fprintf(out," File position: %lu (0x%lx)\n", position, position );
fprintf(out," File position: %lu (%#lx)\n", position, position );
if ( block_id(file->LastBlockInFile))
fprintf(out," Last block ID: %s\n",block_id(file->LastBlockInFile));
else fprintf(out," Last block ID: (no block read)\n");
fprintf(out,"\n");
} /* print_file_error */
/*---------------------------------------------------------------------------
NAME
split_block_id --- split block_id into BlockKey and ChainKey
SYNOPSIS
int split_block_id( char buffer[], const char * block_id,
char ** pBlockKey, char ** pChainKey );
DESCRIPTION
block_id is copied into buffer. buffer is split into BlockKey
and ChainKey by replacing the first '.' in buffer with '\0'. The pointer
to the leading substring is returned in BlockKey, the pointer to the trailing
substring is returned in ChainKey. The minimum length of buffer is
strlen(block_id)+1, the maximum length is MaxValLen+1.
RETURN VALUE
success: 0
---------------------------------------------------------------------------*/
int split_block_id( char buffer[], int buflen, const char * block_id,
char ** pBlockKey, char ** pChainKey )
{ int dot = (int) '.';
char *pc;
buflen = MIN((int) strlen(block_id),buflen);
strncpy(buffer, block_id, buflen);
buffer[buflen] = '\0';
pc = strchr(buffer, dot);
if (pc) { *pc='\0';pc++;*pChainKey=pc; } else { *pChainKey=&buffer[buflen]; }
*pBlockKey = buffer;
return(0);
} /* split_block_id */
/*---------------------------------------------------------------------------
NAME
is_general_block ( block )
DESCRIPTION
Returns 1 if block is the general block. In all other cases 0.
---------------------------------------------------------------------------*/
int is_general_block ( DBlock *block )
{
if (block==block->Chain->File->GeneralBlock) return(1); else return(0);
} /* is_general_block */
/*---------------------------------------------------------------------------
block_boundary ( block )
Returns the block_boundary of the file
---------------------------------------------------------------------------*/
unsigned long block_boundary ( DBlock * block )
{ return ( block->Chain->File->BlockBoundary );
} /* block_boundary */
/*---------------------------------------------------------------------------
set_block_boundary ( block, bboundary )
Sets the block_boundary of the file
---------------------------------------------------------------------------*/
int set_block_boundary( DBlock * block, unsigned long bboundary )
{
block->Chain->File->BlockBoundary = bboundary;
return(0);
} /* set_block_boundary */
/*---------------------------------------------------------------------------
NAME
set_data_format_version ( block, version )
SYNOPSIS
int set_data_format_version ( DBlock * block, DFVersion version );
DESCRIPTION
Sets the datat_format_version of the file
RETURN VALUE
success: 0
error: -1
---------------------------------------------------------------------------*/
int set_data_format_version ( DBlock * block, DFVersion version )
{
if (!(block->Chain->File->GeneralBlock->BinaryPos))
block->Chain->File->Version = version;
else return(-1); /* general block exist already on disk */
return(0);
} /* set_data_format_version */
/*---------------------------------------------------------------------------
NAME
set_no_general_block ( block )
SYNOPSIS
int set_no_general_block ( DBlock * block );
DESCRIPTION
Sets the file flag NoGeneralHeader to TRUE.
RETURN VALUE
success: 0
error: -1
---------------------------------------------------------------------------*/
int set_no_general_block ( DBlock * block )
{
block->Chain->File->Flags.NoGeneralHeader = True;
return(0);
} /* set_no_general_block */
/*---------------------------------------------------------------------------
int pad_spaces ( channel, padwidth, padlen ) (success:0, error:-1)
Writes exactly padlen bytes to channel. If padwith is positive,
two bytes "\r\n" are written after every padwidth number of spaces.
---------------------------------------------------------------------------*/
int pad_spaces ( FILE * channel, int padwidth, int padlen )
{ int i_pad, i_col;
/* pad with white spaces, next line after padwidth characters */
i_pad=0; i_col=0;
if (padwidth>=0)
while (i_pad<padlen-2) {
if ( i_col<padwidth ) {
if ( fputs ( " " , channel) < 0 ) return(-1);
i_pad++;i_col++;
} else {
if ( fputs ( "\r\n" , channel) < 0 ) return(-1);
i_pad+=2;i_col=0;
}
} /* while */
while (i_pad<padlen) {
if ( fputs ( " " , channel) < 0 ) return(-1);
i_pad++;
} /* while */
return(0);
} /* pad_spaces */
/*---------------------------------------------------------------------------
NAME
sync_data_block --- updates symbol list, calculates TextLen and BinaryLen
SYNOPSIS
int sync_data_block ( block )
DESCRIPTION
Synchronizes the header information with the actual data. Writes the
data format specific keywords into the header.
a) Calculates BinaryLen from DataLen
if RawLen is >0 BinaryLen is calculated from RawLen
b) Updates the symbol list with the required keywords and values, for:
the general block and for the normal data blocks.
c) Recalculates the header length and the number of bytes that
must be added to reach a multiple of block_boundary. The values
are updated in block->TextLen and block->PadLen.
If ( block->Flags.DiskBlockFixed ) BinaryLen and TextLen are kept constant.
If this is not possible, an error is returned.
If RawLen is >0 BinaryLen is calculated from RawLen
RETURN VALUE
Returns 0 in case of success.
HISTORY
2001-01-01 PB calculation of block->BinaryLen for DiskBlockFixed is now
done before keyword is written to header.
2010-12-16 PB if RawLen is >0 BinaryLen is calculated from RawLen
---------------------------------------------------------------------------*/
int sync_data_block ( DBlock * block )
{
unsigned long nh_len, mh_len, dif_len=0;
char keybuf[MaxKeyLen+1];
char valbuf[MaxValLen+1];
DChain * chain;
DFile * file;
SElement * symbol;
unsigned long text_len = block->TextLen;
unsigned long binary_len = block->BinaryLen;
chain = block->Chain;
file = chain->File;
if (block == (DBlock *) NULL) return(-1);
/* Round up binary length to the next full multiple of block_boundary */
if (block->RawLen) {
block->BinaryLen =
CEILMOD ( (unsigned long) block->RawLen, block_boundary(block));
} else {
block->BinaryLen =
CEILMOD ( (unsigned long) block->DataLen, block_boundary(block));
}
if ( block->Flags.DiskBlockFixed ) {
/* keep lengths fixed */
block->BinaryLen = MAX(block->BinaryLen,binary_len);
if ( (block->BinaryLen) != binary_len ) return(-1);
}
/* write keywords */
if ( is_general_block ( block ) ) {
/* GeneralBlock */
if (write_headersize) {
/* write temporary value */
if (insert_symbol_root(block,HEADER_SIZE_KEY, UNDETERMINED,&symbol))
return(-1);
}
/* if block boundary defined in symbol list, use this value */
if (search_symbol( block, BLOCK_BOUNDARY_KEY, &symbol ) ) {
if (insert_symbol_root(block, BLOCK_BOUNDARY_KEY,
u_long2s( valbuf, block_boundary(block) ),&symbol))
return(-1);
} else {
if ( set_block_boundary( block, s2u_long( symbol->Value ) ) ) {
fprintf(stderr,"ERROR: Cannot change block boundary\n");
return(-1);
}
}
if (insert_symbol_root(block, DATA_BLOCKS_KEY,
DATA_BLOCKS_DEFAULT, &symbol))
return(-1);
if (insert_symbol_root(block, DATA_FORMAT_VERSION_KEY,
DATA_FORMAT_VERSION, &symbol))
return(-1);
} else {
/* normal DataBlock */
if (write_headersize) {
/* write temporary value */
if (insert_symbol_root(block,HEADER_SIZE_KEY, UNDETERMINED,&symbol))
return(-1);
}
if (insert_symbol_root(block,BINARY_SIZE_KEY,
u_long2s( valbuf, block->BinaryLen),&symbol))
return(-1);
if (insert_symbol_root(block, BLOCK_ID_KEY, block_id(block),&symbol))
return(-1);
/* +++ compatibility to old data format, Image = NN */
if (insert_string( block,
suppress_suffix(keybuf, chain->ChainKey, V1_SUPPRESS, False),
block->BlockKey, &symbol))
return(-1);
/* --- end old data format */
} /* END normal DataBlock */
/* +++ compatibility to old data format */
if ( !(block->Flags.DiskBlockFixed) )
block->SequenceNumber = file->NextSequenceNumber;
if (insert_string(block, V1_HEADER_ID_KEY, header_id(block),&symbol))
return(-1);
if (insert_string(block, V1_SIZE_KEY,
u_long2s( valbuf, block->BinaryLen),&symbol))
return(-1);
/* --- end old data format */
/* Round up header length to the next full multiple of block_boundary */
nh_len = netto_header_length( block );
mh_len = MAX( nh_len, minimum_headersize_out );
block->TextLen = CEILMOD ( mh_len, block_boundary(block));
if ( block->Flags.DiskBlockFixed ) {
/* keep lengths fixed */
block->TextLen = MAX(block->TextLen,text_len);
if ( (block->TextLen) != text_len ) return(-1);
}
if (write_headersize) {
/* correct temporary header size value */
if (search_symbol( block, HEADER_SIZE_KEY, &symbol ) )
return(-1);
dif_len = strlen(symbol->Value)-strlen(u_long2s(valbuf,block->TextLen));
if ( insert_symbol( block, HEADER_SIZE_KEY, valbuf, &symbol ) )
return(-1);
}
block->PadLen = block->TextLen - nh_len + dif_len;
return(0);
} /* sync_data_block */
/*---------------------------------------------------------------------------
NAME
get_block_pos --- get start position of block in file
SYNOPSIS
int get_block_pos( DBlock * block, unsigned long *ptext_pos );
DESCRIPTION
Calculates the start position of the text header section of block
relative to the start of the file.
RETURN VALUE
success:0, error:-1
---------------------------------------------------------------------------*/
int get_block_pos( DBlock * block, unsigned long *ptext_pos )
{
DBlock * LastBlockInFile = block->Chain->File->LastBlockInFile;
if (block->Flags.DiskBlockFixed) *ptext_pos = block->TextPos;
else /* goto end of file */
if (LastBlockInFile) {
*ptext_pos = LastBlockInFile->TextPos
+ LastBlockInFile->TextLen + LastBlockInFile->BinaryLen; }
else *ptext_pos = 0ul;
return(0);
} /* get_block_pos */
/*---------------------------------------------------------------------------
NAME
flush_data_block
SYNOPSIS
int flush_data_block ( block );
DESCRIPTION
Writes header section and binary section, ordered, into the main EDF
data file. Before calling this routine the data block must be synchronized
with sync_data_block. The header section is written according to the
currently defined keyorder_KeyOrderTable (defined with edf_keyorder_set_table.
Nothing is written if the flag block->Flags.BadBlock is set.
The flags block->Flags.HeaderChanged and DataChanged are checked.
The header is only written to disk if HeaderChanged or DataChanged is set.
The header is never written to disk if InternalHeader is set.
The header symbol list is never released when InternalHeader is set.
The data is only written to disk if DataChanged is set.
The data is never written to disk if InternalData is set.
The data is never released if InternalData is set.
Data is only written to disk if the header could be written. When
InternalHeader is set, data is never written to disk.
The following parameters are updated:
TextPos, BinaryPos, KeyPos, ValPos, BinaryFilePos, BinaryFileLen
2010-12-16 PB if RawLen is >0 Raw is written instead of Data
---------------------------------------------------------------------------*/
int flush_data_block ( DBlock *block )
{
const unsigned long h_begin =(unsigned long) strlen(header_begin);
const unsigned long s_sepa =(unsigned long) strlen(symbol_separator);
const unsigned long s_term =(unsigned long) strlen(symbol_terminator);
unsigned long cur_pos;
DChain * chain;
DFile * file;
FILE * channel;
SElement ** table, ** psymbol;
chain = block->Chain;
file = chain->File;
channel = file->Channel;
if (block)
/* the data is only written if the header can be written */
if ( ((block->Flags.HeaderChanged)||(block->Flags.DataChanged)) &&
(!block->Flags.InternalHeader) ) {
/* get block position */
if (get_block_pos( block, &cur_pos )) {
perror("flush_data_block->get_block_pos");return(-1); }
block->TextPos = cur_pos;
/* search block position */
if ( fseek( channel, cur_pos, SEEK_SET) ) {
perror("flush_data_block->fseek"); return(-1); }
/* write header section */
if ( fputs ( header_begin , channel ) < 0 ) {
perror("flush_data_block->header_begin"); return(-1); }
cur_pos += h_begin;
/* get ordered table of symbols */
table = keyorder_ordersymbols ( block );
if (!table) {
perror("flush_data_block ordersymbols"); return(-1); }
psymbol = table;
while (*psymbol!=(SElement*) NULL) {
(*psymbol)->KeyPos = cur_pos;
if ( fputs ( (*psymbol)->Key , channel ) < 0 ) {
perror("flush_data_block->Key"); free(table); return(-1); }
if ( fputs ( symbol_separator, channel ) < 0 ) {
perror("flush_data_block->symbol_separator"); free(table);return(-1);}
cur_pos += s_sepa + (unsigned long) (*psymbol)->KeyLen;
(*psymbol)->ValPos = cur_pos;
if ( fputs ( (*psymbol)->Value, channel ) < 0 ) {
perror("flush_data_block->Value"); free(table); return(-1); }
if ( fputs ( symbol_terminator, channel) < 0 ) {
perror("flush_data_block->symbol_terminator");free(table);return(-1);}
cur_pos += s_term + (unsigned long) (*psymbol)->ValLen;
psymbol++;
}
/* free table */
free(table);
/* pad header block with white spaces */
if (pad_spaces ( channel, PAD_WIDTH, block->PadLen )) {
perror("flush_data_block->pad_spaces"); return(-1); }
if ( fputs ( header_end , channel) < 0 ) {
perror("flush_data_block->header_end"); return(-1); }
block->Flags.HeaderChanged = False;
if ( (block->Flags.DataChanged) && (!block->Flags.InternalData) ) {
/* Calculate BinaryPos */
block->BinaryPos = block->TextPos + (unsigned long) block->TextLen;
/* stored in main EDF file, no BinaryFileName */
if (block->BinaryFileName) free (block->BinaryFileName);
block->BinaryFilePos = block->BinaryPos;
block->BinaryFileLen = block->BinaryLen;
/* write binary data section and fill rest with spaces */
if (block->RawLen) {
if ( fwrite(block->Raw,1,block->RawLen,channel) < block->RawLen ) {
perror("flush_data_block->fwrite"); return(-1); }
if ( pad_spaces( channel,-1,
block->BinaryLen-(unsigned long)block->RawLen) ) {
perror("flush_data_block->pad_spaces"); return(-1); }
} else {
if ( fwrite(block->Data,1,block->DataLen,channel) < block->DataLen ) {
perror("flush_data_block->fwrite"); return(-1); }
if ( pad_spaces( channel,-1,
block->BinaryLen-(unsigned long)block->DataLen) ) {
perror("flush_data_block->pad_spaces"); return(-1); }
}
if ( fflush( channel ) ) {
perror("flush_data_block->fflush"); return(-1); }
block->Flags.DataChanged = False;
}
/* data block is written, increment block number for next time */
if (block->SequenceNumber == file->NextSequenceNumber) {
file->LastBlockInFile=block;
file->NextSequenceNumber++;
}
/* update data block flags */
block->Flags.DiskBlockUsed = True;
block->Flags.DiskBlockFixed = True;
}
return(0);
} /* flush_data_block */
/*---------------------------------------------------------------------------
NAME
update_symbol --- Replaces the value of Key in block with Value
SYNOPSIS
int update_symbol( DBlock * block, const char * Key,
const char * Value, SElement ** symbol )
DESCRIPTION
The key value of the symbol Key is replaced with Value. The original
value length is not changed. If Value is shorter than the original key
value, the remaining bytes are padded with spaces. If Value is longer
than the original key value (symbol->ValLen), the routine stops with an
error.
RETURN VALUE
success: 0, *symbol != NULL
error: -1, *symbol == NULL
---------------------------------------------------------------------------*/
int update_symbol( DBlock * block, const char * Key,
const char * Value, SElement ** symbol )
{
*symbol = (SElement *) NULL;
if ( block == (DBlock *) NULL) goto update_symbol_error;
if ( Value == (const char *) NULL ) goto update_symbol_error;
if (search_symbol( block, Key, symbol )) {
*symbol = (SElement *) NULL;
goto update_symbol_error;
}
/* replace key value with value */
strnpad((*symbol)->Value, Value, (size_t) (*symbol)->ValLen, ' ');
block->KeyOrderNextSymbol = block->SymbolList;
block->KeyOrderNo = 0;
/* success */
return(0);
update_symbol_error:
/* error */
return(-1);
} /* update_symbol */
/*---------------------------------------------------------------------------
NAME
rewrite_symbol - rewrite the value of a symbol in a header section
SYNOPSIS
int rewrite_symbol ( const SElement * symbol );
DESCRIPTION
If the key value was already written to the file the value in the
file is replaced. If symbol->KeyPos is zero, it is assumed that the key
value was not already written and no output to the file is done.
The file pointer is either repositioned at the position of the key value
or remains at the original position. Before continuing writing data to
the end of the file the file pointer must be repositioned with
fseek(channel, 0L, SEEK_END).
RETURN VALUE
In case of succes the return value is 0 otherwise -1.
---------------------------------------------------------------------------*/
int rewrite_symbol ( const SElement * symbol )
{
FILE * channel = symbol->Block->Chain->File->Channel;
long pos;
if (!symbol) goto rewrite_symbol_error;
/* rewrite value in the file, if it was already written */
pos = (long) symbol->ValPos;
if ( pos > 0L ) {
/* seek position of Value */
if ( fseek( channel, pos, SEEK_SET) ) {
perror("rewrite_symbol->fseek");
goto rewrite_symbol_error;
}
/* replace old value */
if ( fputs(symbol->Value, channel) < 0 ) {
perror("rewrite_symbol->fputs");
goto rewrite_symbol_error;
}
}
/* success */
return(0);
rewrite_symbol_error:
/* error */
return(-1);
} /* rewrite_symbol */
/*---------------------------------------------------------------------------
NAME
update_general - updates the general header after writing a data block
SYNOPSIS
int update_general ( DBlock * block );
DESCRIPTION
Updates the following file informations in the general block:
Number of data blocks in the file (the general block is not counted)
DataBlocks = NextSequenceNumber - FirstHeader;
If GeneralBlock->Flags.InternalHeader is set, the value is only
updated in memory but not in the file.
If the file is not a temporary file, the file pointer is repositioned
at the end of the file.
RETURN VALUE
In case of succes the return value is 0 otherwise -1.
---------------------------------------------------------------------------*/
int update_general ( DBlock * block )
{
DBlock * general = block->Chain->File->GeneralBlock;
DFile * file = block->Chain->File;
SElement * symbol;
char KeyVal[MaxKeyLen+1];
FILE * channel = block->Chain->File->Channel;
unsigned long data_blocks;
if (!block) goto update_general_error;
/* calculate number of data blocks without counting general block */
data_blocks = block->Chain->File->NextSequenceNumber-FirstHeader-1;
if (file->Flags.NoGeneralHeader) data_blocks-= 1; /* subtract general block */
/* rewrite DataBlocks */
if (!(u_long2s(KeyVal,data_blocks))) goto update_general_error;
update_symbol( general, DATA_BLOCKS_KEY, KeyVal, &symbol );
if (!(general->Flags.InternalHeader))
if ( symbol ) if ( rewrite_symbol ( symbol ) ) goto update_general_error;
/* seek end of file */
if (!(file->Flags.TemporaryFile))
if ( fseek( channel, 0L, SEEK_END) ) {
perror("update_general->fseek");
goto update_general_error;
}
block->KeyOrderNextSymbol = block->SymbolList;
block->KeyOrderNo = 0;
/* success */
return(0);
update_general_error:
/* error */
return(-1);
} /* update_general */
/*---------------------------------------------------------------------------
NAME
put_data_block (success:0, error:-1)
SYNOPSIS
int put_data_block( DBlock * block );
DESCRIPTION
Writes header and binary data to the stream if they were changed
(HeaderChanged, DataChanged). The format specific symbols are
written into the header.
block is only written physically to the file if the flag
file->Flags.NoGeneralHeader is False.
RETURN VALUE
success: 0
otherwise: -1
---------------------------------------------------------------------------*/
int put_data_block( DBlock * block )
{
if ( block )
if ( !block->Flags.BadBlock )
if ( (block->Flags.HeaderChanged)||(block->Flags.DataChanged) ) {
/* Dont write general header if NoGeneralHeader is set */
if ( !( block->Chain->File->Flags.NoGeneralHeader ) ||
!( is_general_block ( block ) ) ) {
/* synchronize header, binary data and data file format */
if (sync_data_block ( block )) {
block->Flags.BadBlock = True; goto put_data_block_error;
}
/* flush data block to file */
if (flush_data_block( block )) {
block->Flags.BadBlock = True; goto put_data_block_error;
}
/* write block number into general block */
if ( !block->Chain->File->Flags.NoGeneralHeader )
if (update_general ( block )) {
block->Flags.BadBlock = True; goto put_data_block_error;
}
}
}
/* success */
return(0);
put_data_block_error:
/* error */
return(-1);
} /* put_data_block */
/*---------------------------------------------------------------------------
NAME
check_start
SYNOPSIS
int check_start( FILE * channel );
DESCRIPTION
Checks whether the first characters in the file contain either:
'\r' '\n' 'StartHeader,
'\n' 'StartHeader or
'StartHeader.
The file pointer is positioned at the first character after StartHeader.
If the patterns do not match or if EOF was read the return value is -1.
The file cannot be processed further.
The correct pattern should be:
'\n' 'StartHeader immediately followed by '\r' '\n'.
RETURN VALUE
Success, this is a header start: 0
This is not a header start : 1
End of file : -1
Any other error, e.g. char(0) : -2
---------------------------------------------------------------------------*/
int check_start( FILE * channel )
{ char c;
int ic;
ic = fgetc( channel ); c = (char) ic;
if (ic==EOF) return(-1); else if (!ic) return(-2);
if (c=='\r') { ic = fgetc( channel ); c = (char) ic; }
if (ic==EOF) return(-1); else if (!ic) return(-2);
if (c=='\n') { ic = fgetc( channel ); c = (char) ic; }
if (ic==EOF) return(-1); else if (!ic) return(-2);
if (c!=StartHeader) return (1);
return ( 0 );
} /* check_start */
/*---------------------------------------------------------------------------
NAME
check_end
SYNOPSIS
int check_end( FILE * channel );
DESCRIPTION
Checks, whether the file pointer is positioned at the end of a header
section. If EOF or '\0' is read the routine stops with an error
(return value is -1). The file cannot be processed further. If the
first read character is not the EndHeader character the return value
is 1. If one of the following characters do not match the end header
marker, this character is returned to channel.
The routine returns 1 if one of the following patterns were found:
{ 'EndHeader, '\r', '\n } or
{ 'EndHeader, '\n' }
At least 1 character is read from channel. If it is not equal to
EndHeader the routine stops with the return value 1. By this way the
routine can be used to scan a header section for a header end marker.
RETURN VALUE
In case of success
end of header: 0, file pointer positioned after \n
not end of header: 1, wrong character is returned to channel
error: negative number
EOF or '\0' : -1, end of file or char NULL
fatal error: -2
HISTORY
01-Mar-1997 PB error if ungetc corrected
------------------------------------------------------------------------------*/
int check_end( FILE * channel )
{ char c;
int ic;
ic = fgetc( channel ); c = (char) ic; if ((ic==EOF)||(!ic)) return(-1);
if (c!=EndHeader) return(1);
else {ic=fgetc(channel);c=(char)ic; if ((ic==EOF)||(!ic)) return(-1);}
if (c=='\r') {ic=fgetc(channel);c=(char)ic; if ((ic==EOF)||(!ic)) return(-1);}
if (c!='\n') {if ( ic != ungetc ( ic , channel) ) return(-2); return(1);}
return ( 0 );
} /* check_end */
/*---------------------------------------------------------------------------
NAME
search_end - search the end of a header section
SYNOPSIS
int search_end( FILE * channel,
unsigned long start, unsigned long block_boundary );
DESCRIPTION
If block_boundary is larger or equal to the the length of the header end
marker the full header end marker "\r\n}\n" is searched relative to
start at the positions (n=1, 2, 3, ...)
start + n * blockboundary - strlen(header_end)
If the block boundary is smaller than strlen(header_end) the file is
checked byte for byte with check_end starting at start for the
EndHeader character. If no header end marker is found -1 is returned.
If the header end marker was found the file pointer is positioned
immediately after the marker (immediately after the '\n').
RETURN VALUE
success: 0
no success a negative number
EOF or \0 -1
fatal error: -2
---------------------------------------------------------------------------*/
int search_end( FILE * channel,
unsigned long start, unsigned long block_boundary )
{
unsigned long he_len = strlen(header_end);
int ic, res;
char *pb, buffer[MaxKeyLen+1];
long pos;
unsigned long i;
/* start position */
pos = (long) start;
buffer[0] = '\0';
if ( block_boundary >= he_len ) {
while ( strcmp(buffer, header_end ) ) {
/* seek position */
pos += (long) block_boundary ;
if ( fseek( channel, pos - he_len, SEEK_SET) ) {
perror("search_end->fseek"); return(-2); }
pb = buffer;
for (i=0;i<he_len;i++) {
ic = fgetc( channel );
*pb = (char) ic; pb++; if ((ic==EOF)||(!ic)) return(-1);
}
*pb = '\0'; pb++;
} /* while */
} else {
if ( fseek( channel, pos, SEEK_SET) ) {
perror("search_end->fseek"); return(-2); }
res = 1;
while ( res ) {
res = check_end( channel );
if ( res < -1 ) return(-2); /* fatal error */
else if ( res < 0 ) return(-1); /* end of file or char NULL */
}
}
return ( 0 ); /* header end found */
} /* search_end */
/*---------------------------------------------------------------------------
NAME
nextline
SYNOPSIS
int nextline( FILE * channel )
DESCRIPTION
Skip all characters until end of line or end of header. In case
of success (not eof or '\0') the file pointer is positioned at first
character after '\n'.
RETURN VALUE
In case of success: 0
end of header: 1
in case of an error: a negative number
---------------------------------------------------------------------------*/
int nextline( FILE * channel )
{ char c;
int ic;
ic = (int) ' '; c = (char) ic;
/* Skip everything until EOF or line end */
while ( (ic!=EOF) && (ic) && (c!=EndHeader) && (c!='\r') && (c!='\n') ) {
ic = fgetc( channel ); c = (char) ic;
} /* while */
if ((ic==EOF) || (!ic)) return (-1);
/* Read '\n' character, if line was terminated by '\r' */
if (c == '\r') { ic = fgetc( channel ); c = (char) ic; }
/* unget last character if it is EndHeader and check end */
if (c == EndHeader) {
ungetc( (int) c, channel );
if ( check_end( channel ) ) {
long tmp;
tmp = ftell(channel);
fprintf(stderr,"\nERROR: position %ld, end marker %c not followed by eol\n",
tmp, c); return(-1);
} else return(1);
}
return(0);
} /* nextline */
/*---------------------------------------------------------------------------
NAME
skipcomment
SYNOPSIS
int skipcomment( FILE * channel )
DESCRIPTION
Skip all characters until end of line, ignoring end of header marker.
In case of success (not eof or '\0') the file pointer is positioned
at first character after '\n'. This routine is only good for
skipping comment lines which start with Comment character.
RETURN VALUE
In case of success: 0
in case of an error: a negative number
---------------------------------------------------------------------------*/
int skipcomment( FILE * channel )
{ char c;
int ic;
ic = (int) ' '; c = (char) ic;
/* Skip everything until EOF or line end */
while ( (ic!=EOF) && (ic) && (c!='\r') && (c!='\n') ) {
ic = fgetc( channel ); c = (char) ic;
} /* while */
if ((ic==EOF) || (!ic)) return (-1);
/* Read '\n' character, if line was terminated by '\r' */
if (c == '\r') { ic = fgetc( channel ); c = (char) ic; }
return(0);
} /* skipcomment */
/*---------------------------------------------------------------------------
NAME
get_key
SYNOPSIS
int get_key( char buffer[], unsigned long buflen, FILE * channel,
unsigned long * pkey_pos, unsigned long *pkey_len);
DESCRIPTION
Reads key starting at the first non-white character and positions
the file pointer after Separator.
{white-space} (EndHeader | ({key} [white-space]
(Separator | '\r' | '\n') ) )
Starts at the first non-white character after the current position.
key is returned in buffer with white spaces replaced by space. A white-space
character immediately before Separator is not returned in key. If
Separator was read the read pointer is positioned immediately after
Separator.
If the first non-white-character is the EndHeader character the routine
stops and returns this character to channel. If the Separator character
could not be read before {'\r', '\n'} or \n, EOR or '\0' the routine
stops with an error and returns -1.
key is returned as a string with not more than MIN(MaxKeyLen,buflen-1)
characters (including white spaces). The string is terminated with \0
(buflen). buflen is the size of buffer.
RETURN VALUES
In case of success: 0
end of header: 1
in case of an error (Separator not read, EOF or '\0'): a negative number
The key is returned in buffer[].
*pkey_pos is the position of the first character of key in the file.
*pkey_len is the length of key, not including '\0'.
HISTORY
21-Jan-1998 Peter Boesecke
---------------------------------------------------------------------------*/
int get_key( char buffer[], unsigned long buflen, FILE * channel,
unsigned long * pkey_pos, unsigned long *pkey_len)
{ unsigned long i;
char *pb;
char prev_c;
int ic;
/* determine minimum of MaxKeyLen+1 and buflen */
if ((MaxKeyLen+1) < buflen) buflen = MaxKeyLen+1;
ic = (int) ' ';
do {
pb = buffer; // start again
*pb = (char) ic;
/* skip everything before the first non-white character, skip empty lines,
skip comments */
while ((is_white(*pb)||(*pb==Terminator)) && (*pb!=EndHeader)) {
prev_c = *pb;
ic = fgetc( channel ); *pb = (char) ic;
if ( (ic==EOF) || (!(ic)) ) return(-1);
/* Skip comment line */
if ( (prev_c=='\n') && (*pb==Comment) ) {
if ( skipcomment( channel ) < 0 ) return(-1);
*pb = '\n'; }
} /* while */
/* unget last character if it is EndHeader and check end */
if (*pb == EndHeader) { ungetc( (int) *pb, channel );
if ( check_end( channel ) ) {
long tmp;
tmp = ftell(channel);
fprintf(stderr,"\nERROR: position %ld, end marker %c not followed by eol\n",
tmp, *pb); return(-1);
} else return(1);
}
*pkey_pos = (unsigned long) ftell( channel ) - 1;
/* Read key until Separator or Terminator or until buffer full */
i = 0U;
while ( (i<buflen-1) && (*pb!=Separator) && (ic!=EOF) && (ic)
&& (*pb!=EndHeader) && (*pb!='\r') && (*pb!='\n')
&& (*pb!=Terminator) ) {
*pb = white2space(*pb); pb++;
ic = fgetc( channel ); *pb = (char) ic;
i++;
} /* while */
/* Skip everything until Separator or Terminator */
while ( (*pb!=Separator) && (*pb!=Terminator)
&& (ic!=EOF) && (ic) && (*pb!=EndHeader)
&& (*pb!='\r') && (*pb!='\n') ) {
ic = fgetc( channel ); *pb = (char) ic;
} /* while */
} while ((*pb==Terminator)||(*pb=='\r')||(*pb=='\n'));
/* stop, if separator not read */
if ((ic==EOF) || (!ic) || (*pb != Separator)) {
long tmp;
tmp = ftell(channel);
fprintf(stderr,"\nERROR: position %ld, '%c' read, separator '%c' not found\n",
tmp, *pb, Separator); return (-1);
}
/* Space character before Separator does not belong to key */
if ( (*pb==Separator) && (i>0) && (is_white(buffer[i-1])) ) { i--; pb--; }
/* Replace terminating character with end of string */
*pb = '\0';
*pkey_len = (unsigned long) i;
return(0);
} /* get_key */
/*---------------------------------------------------------------------------
NAME
get_val
SYNOPSIS
int get_val( char buffer[], unsigned long buflen, FILE * channel,
unsigned long * pval_pos, unsigned long *pval_len);
DESCRIPTION
Reads value starting at the first non-white character and positions the
file read pointer after Terminator. The routine get_key should be
called beforehand. The first buflen-1 read characters are returned in
buffer, all following until Terminator are skipped.
{white-space} ( {value} [white-space]
(Terminator | '\r' | '\n') )
Starts reading at the first non-white character after the current position,
which is normally after Separator. value is returned in buffer. A
white-space character immediately before Terminator is not returned
in value. If Terminator was read the read pointer is positioned at the
first character after Terminator. The EndHeader and '\r' or '\n'
characters are passed without change. The only terminating conditions are:
Terminator read (success), '\0' read (error) or EOF reached (error).
The routine returns -1 on error and 0 on success.
RETURN VALUES
The routine returns -1 on error (EOF, '\0', Terminator not found).
The routine returns 0 on success.
The value is returned in buffer[].
*pval_pos is the position of the first character of value in the file.
*pval_len is the length of value, not including '\0'.
HISTORY
20-Jan-1998 Peter Boesecke
---------------------------------------------------------------------------*/
int get_val( char buffer[], unsigned long buflen, FILE * channel,
unsigned long * pval_pos, unsigned long *pval_len)
{ unsigned long i;
char *pb = buffer;
int ic;
/* skip everything before the first non-white character */
i = 0U;
ic = (int) ' '; *pb = (char) ic;
while ( is_white(*pb) && (ic!=EOF) && (ic) ) {
ic = fgetc( channel ); *pb = (char) ic;
i++;
} /* while */
*pval_pos = (unsigned long) ftell ( channel ) - 1;
/* Read key until Terminator or until buffer full */
i = 0U;
while ( (i<buflen-1) &&
(*pb!=Terminator) && (ic!=EOF) && (ic) ) {
ic = fgetc( channel ); pb++; *pb = (char) ic;
i++;
} /* while */
/* Skip everything until Terminator */
while ( (*pb!=Terminator) && (ic!=EOF) && (ic) ) {
ic = fgetc( channel ); *pb = (char) ic;
} /* while */
/* Stop, if Terminator not read */
if ((ic==EOF) || (!ic) || (*pb!=Terminator)) {
long tmp;
tmp = ftell(channel);
fprintf(stderr,"\nERROR: position %ld,'%c' read, terminator '%c' not found\n",
tmp, *pb, Terminator); return (-1);
}
/* white space before Terminator does not belong to value */
if ( (*pb==Terminator) && (i>0) && (is_white(buffer[i-1])) ) { i--; pb--; }
/* Replace terminating character with end of string */
*pb = '\0';
*pval_len = (unsigned long) i;
return(0);
} /* get_val */
/*---------------------------------------------------------------------------
NAME
get_symbol_list --- read all symbols, starting at current file position
SYNOPSIS
int get_symbol_list( DBlock * block, int level );
DESCRIPTION
Starting at the current file position, all key/value pairs are read and
inserted into the symbol list of block. According to the level argument
only the data format keys (level=0) or all keys (level=1) are read.
level = 0 Only keys starting with DATA_FORMAT_PREFIX are read. The read
stops at the first key not starting with DATA_FORMAT_PREFIX or
after header_end. To read all keys the file pointer has to be
repositioned after the header_start marker and then read with
level=1. In case of success, the file pointer is positioned at
the beginning of the first key that does not start with
DATA_FORMAT_PREFIX or it is pointing to the EndHeader character.
level = 1 All keys are read. The read stops at the end of the header. In
case of success, the file pointer is pointing to the EndHeader
character.
RETURN VALUES
Returns 0 in case of success and -1 if no success.
HISTORY
30-Jan-1998 Peter Boesecke
---------------------------------------------------------------------------*/
int get_symbol_list( DBlock * block, int level )
{ const int kblen = MaxKeyLen+1;
char kbuf[MaxKeyLen+1];
const int vblen = MaxValLen+1;
char vbuf[MaxValLen+1];
unsigned long key_pos, val_pos;
unsigned long key_len, val_len;
FILE * channel = block->Chain->File->Channel;
SElement * symbol;
int stop;
/* read keywords */
stop = get_key(kbuf, kblen, channel, &key_pos, &key_len);
if ( stop < 0 ) return(-1);
/* stop on error */
if ( !stop )
while ( level ? 1 : (is_prefix ( kbuf, DATA_FORMAT_PREFIX, False )) ) {
/* read value */
stop=get_val( vbuf, vblen, channel, &val_pos, &val_len );
// if (stop) if ( stop < 0 ) return(-1); else break;
if (stop) { if ( stop < 0 ) return(-1); else break; }
/* insert symbol */
if ( insert_symbol( block, kbuf, vbuf, &symbol ) ) return(-1);
symbol->KeyPos = key_pos;
symbol->KeyLen = (unsigned short) key_len;
symbol->ValPos = val_pos;
symbol->ValLen = (unsigned short) val_len;
/* read next key */
stop=get_key( kbuf, kblen, channel, &key_pos, &key_len );
// if (stop) if ( stop < 0 ) return(-1); else break;
if (stop) { if ( stop < 0 ) return(-1); else break; }
/* printf("Key = %s, KeyPos = %u, KeyLen = %u\n", kbuf, key_pos, key_len); */
} /* while is_prefix */
/* go back to previous key position */
if (!stop) fseek( channel, (size_t) key_pos, SEEK_SET );
return(0);
} /* get_symbol_list */
/*---------------------------------------------------------------------------
NAME
new_general_block
SYNOPSIS
int new_general_block( DFile * file );
DESCRIPTION
Creates a general block with default values and updates the file strucure.
RETURN VALUES
Returns 0 in case of success and -1 if no success.
HISTORY
18-Jan-1998 Peter Boesecke
16-Mar-2000 PB default_chain_key
---------------------------------------------------------------------------*/
int new_general_block( DFile * file )
{ char ChainKeyDefinition[MaxKeyLen+1];
char ChainKey[MaxKeyLen+1];
DChain * chain;
DBlock * block;
SElement * symbol;
if (insert_data_chain( file, GENERAL_CHAIN_KEY, &chain) ) return(-1);
if (insert_data_block( chain, GENERAL_BLOCK_KEY, &block) ) return(-1);
if (!(file->GeneralBlock)) file->GeneralBlock = block;
else return(-1); /* cannot create a second general block */
/* Defaults */
/* define default DataChain */
if ( sprintf(ChainKeyDefinition,"%s%u",CHAIN_KEY_DEFINITION,1)<1 ) return(-1);
if (!(default_chain_key(ChainKey,1))) return(-1);
if (insert_string( block, ChainKeyDefinition, ChainKey, &symbol)) return(-1);
file->ActiveBlock = block;
/* dont write general block to disk, if NoGeneralHeader or TemporaryFile
are set */
if ( (file->Flags.NoGeneralHeader)||(file->Flags.TemporaryFile) ) {
block->Flags.InternalHeader = True; block->Flags.InternalData = True; }
return(0);
} /* new_general_block */
/*---------------------------------------------------------------------------
NAME
read_general_block
SYNOPSIS
int read_general_block( DFile * file );
DESCRIPTION
Reads the general block from the file. Can only be called once after
new_general_block. The general block must be at the start of the file
and MUST begin with
header_begin DATA_FORMAT_PREFIX.
Otherwise it is assumed that this file has no general block. If the header
contains a BLOCK_ID_KEY the version number V2.0 is assumed with default
block boundary. In the other case a block boudary of 1 byte is assumed.
In all successful cases the file pointer is positioned at the beginning of
the first data block.
RETURN VALUES
Returns 0 in case of success and -1 if no success.
HISTORY
18-Mar-1998 Peter Boesecke
11-Jul-2001 PB accepts empty files as edf-files without genereal header
---------------------------------------------------------------------------*/
int read_general_block( DFile * file )
{ static char errmsg[MaxValLen+1];
int stop=0;
int check_status;
const size_t buflen = MaxValLen+1;
char fullname[MaxValLen+1], path[MaxValLen+1];
unsigned long text_pos, binary_pos;
unsigned long binary_len;
FILE * channel = file->Channel;
DBlock * block;
SElement * symbol;
/* get block */
block = file->GeneralBlock;
/* block must be created */
if (!(block)) return(-1);
/* goto start of file */
rewind( channel );
/* remember start position */
text_pos = (unsigned long) ftell (channel);
/* check StartHeader */
switch( check_start( channel ) ) {
case 0: /* read ALL keywords with and without DATA_FORMAT_PREFIX */
if ( get_symbol_list( block, 1 ) ) {
sprintf(errmsg, "Error reading header values");
print_file_error ( stderr, file, text_pos, errmsg );
return(-1); }
break; // OK
case -1: stop=1; break; // EOF (empty file, without keywords)
default: {
sprintf(errmsg, "This file is not a %s file",DATA_FORMAT_NAME);
print_file_error ( stderr, file, text_pos, errmsg );
return(-1);
}
} // switch
/* DATA_FORMAT_VERSION_KEY */
if ( search_symbol( block, DATA_FORMAT_VERSION_KEY, &symbol ) ) {
/* this file has no general block */
set_no_general_block ( block );
/* BLOCK_ID_KEY */
if ( (stop)||(!search_symbol( block, BLOCK_ID_KEY, &symbol )) ) {
/* this file is empty or has a BLOCK_ID_KEY. It must be
version 2.xx without header */
set_data_format_version ( block, str2version( "2.00" ) ); }
else {
set_data_format_version ( block, str2version( "1.00" ) );
set_block_boundary ( block, 1U ); /* block boundary 1 */
}
/* recreate general block, because it contains wrong symbols */
free_data_block_list( block->Chain ); /* remove general block */
file->GeneralBlock = (DBlock *) NULL;
if ( new_general_block( file ) ) return(-1);
rewind( channel );
return(0);
} /* DATA_FORMAT_VERSION_KEY */
/* BLOCK_BOUNDARY_KEY (alt: internal default) */
if (search_symbol( block, BLOCK_BOUNDARY_KEY, &symbol ) ) {
; /* set_block_boundary( block, 1U ); +++++++++++++++*/
// fprintf(stderr,"WARNING: Key \"%s\" not found\n", BLOCK_BOUNDARY_KEY);
} else {
if ( set_block_boundary( block, s2u_long( symbol->Value ) )) {
sprintf(errmsg,"ERROR: Cannot change block boundary.");
print_file_error ( stderr, file, text_pos, errmsg );
return(-1);
}
}
/* BINARY_SIZE_KEY (alt: 0U) */
if (search_symbol( block, BINARY_SIZE_KEY, &symbol ) ) {
binary_len = 0U; }
else { binary_len = s2u_long( symbol->Value ); }
/* BINARY_FILE_NAME_KEY (alt: null pointer */
if ( !search_symbol( block, BINARY_FILE_NAME_KEY, &symbol ) ) {
/* get full path of header file and apply to binary file */
getpath_edf( path, buflen, file->Name );
sprintf( fullname, "%s%s", path, symbol->Value );
block->BinaryFileName = newstr( fullname );
if (!block->BinaryFileName) return(-1);
/* BINARY_FILE_POSITION_KEY (alt: ERROR) */
if ( !search_symbol( block, BINARY_FILE_POSITION_KEY, &symbol ) ) {
block->BinaryFilePos = s2u_long( symbol->Value ); }
else { fprintf(stderr,"ERROR: %s requires %s\n",
BINARY_FILE_NAME_KEY,BINARY_FILE_POSITION_KEY); return(-1); }
/* BINARY_FILE_SIZE_KEY (alt: 0U) */
if ( !search_symbol( block, BINARY_FILE_SIZE_KEY, &symbol ) ) {
block->BinaryFileLen = s2u_long( symbol->Value ); }
else block->BinaryFileLen = 0U;
} /* BINARY_FILE_NAME_KEY */
/* HEADER END */
if (stop) { if ( check_end ( channel ) < 0 ) return(-1); }
else { /* search end of this header section */
check_status = search_end( channel,text_pos,block_boundary( block ));
if ( check_status == -1) /* search againg in 1 byte steps */
check_status = search_end( channel,text_pos,1);
if ( check_status ) {
sprintf(errmsg,"Header end marker not found");
print_file_error ( stderr, file, text_pos, errmsg );
return(-1); }
}
binary_pos = (unsigned long) ftell (channel);
block->TextPos = text_pos;
block->TextLen = binary_pos - text_pos;
block->BinaryPos = binary_pos;
block->BinaryLen = binary_len;
/* check position relative to block boundary of end marker if */
if ( binary_pos % block_boundary( block ) ) {
/* Warning only if binary section exist (mixed text binary file)*/
if ( binary_len ) {
fprintf(stderr,
"WARNING: The binary section of this block starts at position %lu.\n",
binary_pos);
fprintf(stderr," This is not a multiple of the block boundary %lu.\n",
block_boundary( block ));
}
fprintf(stderr,"\nINFO: Reading the file %s with block boundary 1.\n\n",
block->Chain->File->Name);
set_block_boundary( block, 1U );
}
/* update data block flags */
block->Flags.DiskBlockUsed = True;
block->Flags.DiskBlockFixed = True;
block->Flags.HeaderExternal = False;
file->LastBlockInFile=block;
/* search start position of next block */
if ( fseek( channel, binary_pos+binary_len, SEEK_SET) ) {
perror("read_general_block->fseek"); return(-1); }
return(0);
} /* read_general_block */
/*---------------------------------------------------------------------------
NAME
locate_block
SYNOPSIS
int locate_block( DFile * file, DBlock ** pblock );
DESCRIPTION
Reads a block from the file, starting at the current position.
The block must start with:
header_begin
In versions < 2.0 the full header is scanned, for version >= 2.0
only the format specific symbols are read and the end of the header
is searched at multiples of BlockBoundary positions from the start of
the header. The file pointer is located after the binary section of
this block at the start of the next block.
For V2.xx the data block id is used, for V1.xx the V1_IMAGE_KEY or
alternatively, if this was not found, V1_HEADER_ID_KEY is used to
get the image number.
RETURN VALUES
further read not possible: 2, all temporary memory is released,
previously read file OK
end of file: 1, all temporary memory is released.
previously read file OK
success: 0, all temporary memory is released
fatal error: -1, temporary memory might not be released.
program should be terminated.
Pointer *pblock to the located block.
---------------------------------------------------------------------------*/
int locate_block( DFile * file , DBlock **pblock )
{ int stop=0;
int check_status;
const size_t buflen = MaxValLen+1;
char fullname[MaxValLen+1], path[MaxValLen+1];
unsigned long text_pos, binary_pos;
unsigned long text_len, binary_len;
FILE * channel;
DChain * chain, *chain_tmp;
DBlock * block, *block_tmp;
SElement * symbol;
long *data_dim;
size_t data_len;
DFVersion version;
char BlockIDBuffer[MaxValLen+1];
char ChainKeyBuffer[MaxValLen+1];
char *BlockKey, *ChainKey;
// const DFVersion V1_0 = str2version("1.00");
const DFVersion V2_0 = str2version("2.00");
if (!file) goto locate_block_fatal;
if (pblock) *pblock = NULL;
channel = file->Channel;
version = file->Version;
/* remember start position */
text_pos = (unsigned long) ftell (channel);
/* CHECK HEADER START */
check_status = check_start( channel );
if ( check_status ) {
if ( check_status == -1 ) goto locate_block_eof;
else {
print_file_warning ( stderr, file, text_pos,
"Expecting EOF or header start" );
goto locate_block_trunc;
}
}
/* create temporary structure */
if ( insert_data_chain( file, "_TEMP_", &chain_tmp ) ) goto locate_block_fatal;
if ( insert_data_block( chain_tmp, "_TEMP_", &block_tmp ) ) goto locate_block_fatal;
/* READ FORMAT SPECIFIC KEYWORDS (if Version<2.00 read all) */
if ( compare_versions( version, V2_0 ) < 0 ) { /* VERSION < 2.00 */
if ( get_symbol_list( block_tmp, 1 ) ) {
if ( free_data_chain( chain_tmp ) ) goto locate_block_fatal;
print_file_warning ( stderr, file, text_pos,
"Error reading header values V1.xx");
goto locate_block_trunc;
}
} else { /* VERSION >= 2.00 */
if ( get_symbol_list( block_tmp, 0 ) ) {
if ( free_data_chain( chain_tmp ) ) goto locate_block_fatal;
print_file_warning ( stderr, file, text_pos,
"Error reading header values");
goto locate_block_trunc;
}
}
/* BLOCK_ID_KEY (alt: V1_IMAGE_KEY, alt2: HeaderID, alt3: SequenceNumber) */
if ( !search_symbol( block_tmp, BLOCK_ID_KEY, &symbol ) ) {
if ( split_block_id( BlockIDBuffer, MaxValLen+1, symbol->Value,
&BlockKey, &ChainKey ) ) {
if ( free_data_chain( chain_tmp ) ) goto locate_block_fatal;
print_file_warning ( stderr, file, text_pos,
"Error reading block id");
goto locate_block_trunc;
}
} else if ( !search_symbol( block_tmp, V1_IMAGE_KEY, &symbol ) ) {
// alt1: V1_IMAGE_KEY
sprintf(BlockIDBuffer,"%s.%s",
symbol->Value,default_chain_key(ChainKeyBuffer,1));
if ( split_block_id( BlockIDBuffer, MaxValLen+1, BlockIDBuffer,
&BlockKey, &ChainKey ) ) {
if ( free_data_chain( chain_tmp ) ) goto locate_block_fatal;
print_file_warning ( stderr, file, text_pos,
"Error reading block id");
goto locate_block_trunc;
}
} else if ( !search_symbol( block_tmp, V1_HEADER_ID_KEY, &symbol ) ) {
// alt2: HeaderID
sprintf(BlockIDBuffer,"%ld.%s",
header_id_number(symbol->Value),default_chain_key(ChainKeyBuffer,1));
if ( split_block_id( BlockIDBuffer, MaxValLen+1, BlockIDBuffer,
&BlockKey, &ChainKey ) ) {
if ( free_data_chain( chain_tmp ) ) goto locate_block_fatal;
print_file_warning ( stderr, file, text_pos,
"Error reading V1.xx header id");
goto locate_block_trunc;
}
} else {
// alt3: SequenceNumber
fprintf(stderr,"WARNING: Missing block ID, using sequence number\n");
sprintf(BlockIDBuffer,"%ld.%s",
file->NextSequenceNumber-1,
default_chain_key(ChainKeyBuffer,1));
if ( split_block_id( BlockIDBuffer, MaxValLen+1, BlockIDBuffer,
&BlockKey, &ChainKey ) ) {
if ( free_data_chain( chain_tmp ) ) goto locate_block_fatal;
print_file_warning ( stderr, file, text_pos,
"Failed using sequence number");
goto locate_block_trunc;
}
}
/* BINARY_SIZE_KEY (alt: V1_SIZE_KEY) */
if ( !search_symbol( block_tmp, BINARY_SIZE_KEY, &symbol ) )
binary_len = s2u_long( symbol->Value );
else if ( !search_symbol( block_tmp, V1_SIZE_KEY, &symbol ) )
binary_len = s2u_long( symbol->Value );
else if ( (data_dim = get_data_dim ( block_tmp )) ) {
/* FIT2D KLORA FORMAT (V1_SIZE_KEY missing, but dimensions given) */
data_len = edf_dim_product(data_dim)*edf_data_sizeof(get_data_type(block_tmp));
if (EDFIO_debug) {
printf ("FIT2D KLORA FORMAT dim[0]=%lu, dim[1]=%lu, dim[2]=%lu, data_len=%lu\n",\
data_dim[0],data_dim[1],data_dim[2],data_len);
}
binary_len = data_len;
} else binary_len = 0U;
/* BINARY_FILE_NAME_KEY (alt: null pointer */
if ( !search_symbol( block_tmp, BINARY_FILE_NAME_KEY, &symbol ) ) {
/* get full path of header file and apply to binary file */
getpath_edf( path, buflen, file->Name );
sprintf( fullname, "%s%s", path, symbol->Value );
block_tmp->BinaryFileName = newstr( fullname );
if (!block_tmp->BinaryFileName) {
if ( free_data_chain( chain_tmp ) ) goto locate_block_fatal;
print_file_warning ( stderr, file, text_pos,
"Error reading binary file name");
goto locate_block_trunc;
}
/* BINARY_FILE_POSITION_KEY (alt: ERROR) */
if ( !search_symbol( block_tmp, BINARY_FILE_POSITION_KEY, &symbol ) ) {
block_tmp->BinaryFilePos = s2u_long( symbol->Value );
} else {
fprintf(stderr,"ERROR: The key \"%s\" requires the key \"%s\"\n",
BINARY_FILE_NAME_KEY,BINARY_FILE_POSITION_KEY);
if ( free_data_chain( chain_tmp ) ) goto locate_block_fatal;
print_file_warning ( stderr, file, text_pos,
"Missing binary file position");
goto locate_block_trunc;
}
if ( !search_symbol( block_tmp, BINARY_FILE_SIZE_KEY, &symbol ) ) {
block_tmp->BinaryFileLen = s2u_long( symbol->Value );
} else block_tmp->BinaryFileLen = 0U;
} /* BINARY_FILE_NAME_KEY */
/* SEARCH HEADER END */
if (stop) {
if ( check_end ( channel ) < 0 ) goto locate_block_eof;
} else {
/* search end of this header section */
check_status = search_end( channel, text_pos, file->BlockBoundary );
/* in case of EOF or '\0' search again */
if ( check_status == -1 ) /* search again in 1 byte steps */
check_status = search_end( channel, text_pos, 1 );
if ( check_status ) {
if ( free_data_chain( chain_tmp ) ) goto locate_block_fatal;
print_file_warning ( stderr, file, text_pos,
"Header end marker not found");
goto locate_block_trunc;
}
} /* if (stop) */
binary_pos = (unsigned long) ftell (channel);
text_len = binary_pos - text_pos;
/* CHECK POSITION relative to block boundary of end marker */
if ( binary_pos % file->BlockBoundary ) {
if (binary_len) {
fprintf(stderr,
"WARNING: The binary section of this block starts at position %lu.\n",
binary_pos);
fprintf(stderr," This is not a multiple of the block boundary %lu\n",
block_boundary( block_tmp ) );
}
fprintf(stderr,"\nINFO: Reading the file %s with block boundary 1.\n\n",
block_tmp->Chain->File->Name);
set_block_boundary( block_tmp, 1U );
}
if ( insert_data_chain( file, ChainKey, &chain ) ) goto locate_block_fatal;
if ( insert_data_block( chain, BlockKey, &block ) ) goto locate_block_fatal;
/* data block positions */
block->TextPos = text_pos;
block->TextLen = text_len;
block->BinaryPos = binary_pos;
block->BinaryLen = binary_len;
block->BinaryFileName = newstr(block_tmp->BinaryFileName);
block->BinaryFilePos = block_tmp->BinaryFilePos;
block->BinaryFileLen = block_tmp->BinaryFileLen;
/* data block flags */
block->Flags.DiskBlockUsed = True;
block->Flags.DiskBlockFixed = True;
block->Flags.HeaderExternal = True;
block->Flags.HeaderChanged = False;
block->Flags.DataExternal = True;
block->Flags.DataChanged = False;
block->Flags.ExternalDimAlloc = False;
block->Flags.ExternalDataAlloc = False;
block->Flags.BadBlock = False;
/* remove temporary data_chain */
if ( free_data_chain( chain_tmp ) ) goto locate_block_fatal;
if (pblock) *pblock = block;
file->LastBlockInFile=block;
/* search start position of next block */
if ( fseek( channel, binary_pos+binary_len, SEEK_SET) ) {
print_file_warning ( stderr, file, binary_pos+binary_len,
"Cannot find start of next block");
goto locate_block_trunc;
}
/* success */
return(0);
locate_block_eof:
/* end of file reached */
return(1);
locate_block_trunc:
/* further read not possible */
return(2);
locate_block_fatal:
/* fatal error */
return(-1);
} /* locate_block */
/*---------------------------------------------------------------------------
NAME
get_data_header --- read data block header from disk
SYNOPSIS
int get_data_header( DBlock * block );
DESCRIPTION
Reads all data block symbols from the stream.
RETURN VALUE
success: 0;
otherwise: -1;
---------------------------------------------------------------------------*/
int get_data_header( DBlock * block )
{ unsigned long cur_pos;
FILE * channel = block->Chain->File->Channel;
if (block)
if (block->Flags.HeaderExternal) {
/* get block position */
cur_pos = block->TextPos;
/* search block position */
if ( fseek( channel, cur_pos, SEEK_SET) ) {
perror("get_data_header->fseek");
goto get_data_header_error;
}
/* check StartHeader */
if ( check_start( channel ) ) {
perror("get_data_header->check_start");
goto get_data_header_error;
}
/* read symbols */
if ( get_symbol_list( block, 1 ) ) {
perror("get_data_header->get_symbol_list");
goto get_data_header_error;
}
/* update data block flags */
block->Flags.DiskBlockUsed = True;
block->Flags.DiskBlockFixed = True;
block->Flags.HeaderExternal = False;
block->Flags.HeaderChanged = False;
}
/* success */
return(0);
get_data_header_error:
return(-1);
} /* get_data_header */
/*===block_access END===================================================---*/
/*---get_binary_array BEGIN================================================*/
/*---------------------------------------------------------------------------
NAME
edf_bswap - byte swapping inside an item
SYNOPSIS
void edf_bswap( void * dest, const void * src, size_t item, unsigned long n );
DESCRIPTION
Swaps all bytes inside an item of src consisting of item bytes and
writes the result to the output buffer dest. The output and input
buffers can be identical. The minimum size of both buffers in bytes
is item * n.
byte byte byte byte byte byte byte byte
src : 0 | 1 | 2 | 3 | ... | item-3 | item-2 | item-1 |
dest : item-1 | item-2 | item-3 | ... | 3 | 2 | 1 | 0 |
ARGUMENTS
void * dest ouput buffer<br>
void * src input buffer<br>
size_t item size of a single item in bytes <br>
unsigned long n number of items<br>
AUTHOR
Peter Boesecke 14-Jan-1998
HISTORY
30-Apr-2000 PB renamed to edf_bswap
--------------------------------------------------------------------------*/
void edf_bswap ( void * dest, const void * src, size_t item, unsigned long n )
{
const unsigned char *in;
const unsigned char *pi1, *pi2;
unsigned char *out;
unsigned char *po1, *po2, temp;
unsigned long i, j;
size_t step = item;
unsigned long jmax = (step + 1u) / 2u;
if ( (!dest)||(!src) ) {
fprintf(stderr, "SEVERE: edf_bswap: NULL pointer\n");
exit(-1);
}
pi1 = in = (const unsigned char *) src;
pi2 = in + step;
po1 = out = (unsigned char *) dest;
po2 = out + step;
for (i=0;i<n;i++) {
/* swap */
for (j=0;j<jmax;j++) {
temp=*pi1;pi1++;
pi2--;*po1=*pi2;po1++;
po2--;*po2=temp;
}
pi1 = in += step; pi2 = in + step;
po1 = out += step; po2 = out + step;
} /* for */
} /* edf_bswap */
/*------------------------------------------------------------------------
NAME
strarrlen --- returns the length of a string array. it must stop with NULL
SYNOPSIS
long strarrlen( const char * strarr[] );
DESCRIPTION
Returns the length of an array of strings. The string array must end with
(char *) NULL.
RETURN VALUE
long : length of the string array
AUTHOR
------------------------------------------------------------------------*/
long strarrlen( const char * strarr[] )
{ long i=0;
while (strarr[i]) i++;
return(i);
} /* strarrlen */
/*---------------------------------------------------------------------------
NAME
ByteOrder2String --- converts byte order to a string
SYNOPSIS
BOrder byte_order;
const char * ByteOrder2String( int byte_order );
DESCRIPTION
GCC AND G++
For compatibility between gcc and g++ the declaration of the variable
with its enumerated type has been replaced by "int".
RETURN VALUE
Pointer to a constant result string.
AUTHOR
03-Mar-1998 PB Specification
-------------------------------------------------------------------------*/
PRIVATE const char * ByteOrder2String( int byte_order )
{
if ((byte_order<0)||(byte_order>=EndBOrder)) byte_order = InValidBOrder;
return( BOrderStrings[byte_order] );
} /* ByteOrder2String */
/*---------------------------------------------------------------------------
NAME
String2ByteOrder --- converts a string to a byte order value
SYNOPSIS
(BOrder) int String2ByteOrder( const char * string );
DESCRIPTION
GCC AND G++
For compatibility between gcc and g++ the declaration of the return
value with its enumerated type has been replaced by "int".
RETURN VALUE
BOrder == 0 : error, e.g. cannot convert
BOrder > 0 : valid byte order value
AUTHOR
03-Mar-1998 PB Specification
-------------------------------------------------------------------------*/
int String2ByteOrder( const char * string )
{ int NE=True;
long i = 0;
while ( (NE && BOrderStrings[i]) )
NE = compare_keys( string, BOrderStrings[i++], UpperCaseSort );
i = MAX(0,i-1);
if (NE) return( InValidBOrder );
else return( i );
} /* String2ByteOrder */
/*---------------------------------------------------------------------------
NAME
edf_datatype2string --- converts data type to a string
SYNOPSIS
DType data_type;
const char * edf_datatype2string( int data_type )
DESCRIPTION
GCC AND G++
For compatibility between gcc and g++ the declaration of the variable
with its enumerated type has been replaced by "int".
RETURN VALUE
Pointer to a constant result string.
AUTHOR
03-Mar-1998 PB Specification
-------------------------------------------------------------------------*/
const char * edf_datatype2string( int data_type )
{
if ((data_type<0)||(data_type>=EndDType)) data_type = InValidDType;
return( DTypeStrings[data_type] );
} /* edf_datatype2string */
/*---------------------------------------------------------------------------
NAME
edf_string2datatype --- converts a string to DType
SYNOPSIS
(DType) int edf_string2datatype( const char * string );
DESCRIPTION
GCC AND G++
For compatibility between gcc and g++ the declaration of the return
value with its enumerated type has been replaced by "int".
RETURN VALUE
DType == 0 : error, e.g. cannot convert
DType > 0 : valid byte order value
AUTHOR
03-Mar-1998 PB Specification
--------------------------------------------------------------------------*/
int edf_string2datatype( const char * string )
{ int NE=True;
long i = 0;
while ( (NE && DTypeStrings[i]) )
NE = compare_keys( string, DTypeStrings[i++], UpperCaseSort );
/* aliases */
if (NE) { i=0;
while ( (NE && DTypeStringsAliases[i]) )
NE = compare_keys( string, DTypeStringsAliases[i++], UpperCaseSort );
}
/* aliases */
if (NE) { i=0;
while ( (NE && DTypeStringsAliases1[i]) )
NE = compare_keys( string, DTypeStringsAliases1[i++], UpperCaseSort );
}
i = MAX(0,i-1);
if (NE) return( InValidDType );
else return( i );
} /* edf_string2datatype */
/*---------------------------------------------------------------------------
NAME
edf_compression2string --- converts compression to a string
SYNOPSIS
DCompression data_compression;
const char * edf_compression2string( int data_compression )
DESCRIPTION
GCC AND G++
For compatibility between gcc and g++ the declaration of the variable
with its enumerated type has been replaced by "int".
RETURN VALUE
Pointer to a constant result string.
-------------------------------------------------------------------------*/
const char * edf_compression2string( int data_compression )
{
if ( (data_compression < 0) || (data_compression >= EndDCompression) )
data_compression = InValidDCompression;
return( DCompressionStrings[data_compression] );
} /* edf_compression2string */
/*---------------------------------------------------------------------------
NAME
edf_string2compression --- converts a string to a compression value
SYNOPSIS
(DCompression) int edf_string2compression( const char * string );
DESCRIPTION
GCC AND G++
For compatibility between gcc and g++ the declaration of the return
value with its enumerated type has been replaced by "int".
RETURN VALUE
DCompression == 0 : error, e.g. cannot convert
DCompression > 0 : valid compression
-------------------------------------------------------------------------*/
int edf_string2compression( const char * string )
{ int NE=True;
int i = 0;
int value=InValidDCompression;
while ( (NE && DCompressionStrings[i]) ) {
NE = compare_keys( string, DCompressionStrings[i++], UpperCaseSort );
}
/* aliases */
if (NE) { i=0;
while ( (NE && DCompressionStringsAliases[i]) ) {
NE = compare_keys(string,DCompressionStringsAliases[i++],UpperCaseSort);
}
}
/* aliases1 */
if (NE) { i=0;
while ( (NE && DCompressionStringsAliases1[i]) ) {
NE = compare_keys(string,DCompressionStringsAliases1[i++],UpperCaseSort);
}
}
i = MAX(0,i-1);
if (NE) {
i=(long) s2u_long( string );
if ( (0<i)&&(i<EndDCompression) ) NE = FALSE;
}
if (!NE) value= i;
return( value );
} /* edf_string2compression */
/*---------------------------------------------------------------------------
NAME
edf_dim_product --- returns the product of dim[] in all dimensions
SYNOPSIS
unsigned long edf_dim_product ( const long * dim );
DESCRIPTION
The product of dim[nn] from nn=1 to dim[0] is returned as an unsigned
long value. If one of the dim[nn] is zero or negative, 0 is returned.
RETURN VALUE
unsigned long == 0 : error
unsigned long > 0 : product of dim[] of all dimensions
AUTHOR
03-Mar-1998 PB Specification
-------------------------------------------------------------------------*/
unsigned long edf_dim_product ( const long * dim )
{ unsigned long product;
long i;
if ( dim ) {
product = (unsigned long) 1;
for (i=1;i<=dim[0];i++) {
if (dim[i]<=0l) return(0lu);
product *= (unsigned long) dim[i];
}
} else product = 0;
return(product);
} /* edf_dim_product */
/*+++------------------------------------------------------------------------
NAME
edf_data_sizeof --- returns the size of a data type element
SYNOPSIS
DType data_type;
size_t edf_data_sizeof ( int data_type );
DESCRIPTION
The size required for a data_type element is returned. Where data_type
is the enum type DType.
RETURN VALUE
NULL : error (e.g. for invalid data type)
>NULL : size of data_type
AUTHOR
03-Mar-1998 PB Specification
--------------------------------------------------------------------------+*/
size_t edf_data_sizeof ( int data_type ) /*---*/
{
if (!((0<data_type) && (data_type<EndDType))) data_type = InValidDType;
return( DSize[data_type] );
} /* edf_data_sizeof */
/*---------------------------------------------------------------------------
NAME
get_data_type --- get data type from the symbol list of block
SYNOPSIS
(DType) int get_data_type ( DBlock * block );
DESCRIPTION
The data type is read from the symbol list of block and converted
to the enumerated type DType, using the tables DTypeStrings and
DTypeStringsAliases.
If data type is not found the default is FloatIEEE32.
RETURN VALUE
long integer
error : 0
DType : positive number
AUTHOR
03-Mar-1998 PB Specification
-------------------------------------------------------------------------*/
PRIVATE int get_data_type ( DBlock * block )
{ int data_type;
SElement * symbol;
if ( search_general( block, DATA_TYPE_KEY, &symbol ) )
data_type = FloatIEEE32;
else data_type = edf_string2datatype( symbol->String );
return( data_type );
} /* get_data_type */
/*--------------------------------------------------------------------------
NAME
get_data_dim --- get data dimension from the symbol list of block
SYNOPSIS
long *get_data_dim ( DBlock * block );
DESCRIPTION
The dimension values are read successively from the symbol list of block,
starting with Dim_1 and stopping when Dim_nn does not exist. Memory for
an array is allocated that contains { nn, Dim_1, Dim_2, ... , Dim_nn }.
An array to store the dimensions is allocated. It must be freed explicitely.
Attention, the result is not written to block.
Keyword Dim_0 is ignored.
If Dim_1 is not found an error is returned ((long *) NULL)
RETURN VALUE
error : (long *) NULL
DIM[0] : nn = number of dimensions
DIM[1] : number of elements in first dimension
...
DIM[nn] : number of elements in nn-th dimension
AUTHOR
03-Mar-1998 PB Specification
15-May-2001 PB dim[n+1] is not longer used (as foreseen in edfio V1.37)
-------------------------------------------------------------------------*/
PRIVATE long *get_data_dim ( DBlock * block )
{ char Key[MaxKeyLen+1];
long dim, *data_dim, maxdim;
long product;
int errval;
SElement *symbol;
/* first run: determine dimension */
dim = 1l;
sprintf(Key,"%s%lu",DIMENSION_KEY_PREFIX,dim);
while ( !search_general( block, Key, &symbol )) {
dim++;
sprintf(Key,"%s%lu",DIMENSION_KEY_PREFIX,dim);
}
dim--;
data_dim = (long *) NULL;
if ( dim > 0 ) {
/* second run: store data_dim */
if ( !(data_dim = newdim( dim )) )
return( (long *) NULL );
//++++++++ if ( !(data_dim = (long *) malloc( sizeof( long )*(dim+1) )) )
//++++++++ return( (long *) NULL );
product = 1l;
data_dim[0] = maxdim = dim;
for (dim = 1; dim<=maxdim; dim++) {
sprintf(Key,"%s%lu",DIMENSION_KEY_PREFIX,dim);
search_general( block, Key, &symbol );
product *= data_dim[dim] = num_str2long( symbol->String, NULL, &errval );
if (errval) {
fprintf(stderr,"ERROR: Failed to read header value %s\n",Key);
free( data_dim ); return((long *) NULL);
}
}
}
return( data_dim );
} /* get_data_dim */
/*---------------------------------------------------------------------------
NAME
get_byte_order --- get the byte order from the symbol list of block
SYNOPSIS
(BOrder) int get_byte_order ( DBlock * block );
DESCRIPTION
The byte order is read from the symbol list of block and converted
to the enumerated type BOrder, using the table BOrderStrings.
If byte order is not found the default is HighByteFirst.
RETURN VALUE
integer
error : 0
BOrder : positive number
AUTHOR
03-Mar-1998 PB Specification
---------------------------------------------------------------------------*/
int get_byte_order ( DBlock * block )
{ int byte_order;
SElement * symbol;
if ( search_general( block, BYTE_ORDER_KEY, &symbol ) )
byte_order = HighByteFirst;
else byte_order = String2ByteOrder( symbol->String );
return( byte_order );
} /* get_byte_order */
/*---------------------------------------------------------------------------
NAME
get_compression --- get the compression type from the symbol list of block
SYNOPSIS
(DCompression) int get_compression ( DBlock * block );
DESCRIPTION
The compression is read from the symbol list of block and converted
to the enumerated type DCompression, using the table DCompressionStrings
and DCompressionStringsAliases.
If compresssion is not found the default is UnCompressed.
RETURN VALUE
integer
error : 0
DCompression : positive number
AUTHOR
03-Mar-1998 PB Specification
--------------------------------------------------------------------------*/
int get_compression ( DBlock * block )
{ int compression;
SElement * symbol;
if ( search_general( block, COMPRESSION_KEY, &symbol ) )
compression = UnCompressed;
else compression = edf_string2compression( symbol->String );
return( compression );
} /* get_compression */
/*---------------------------------------------------------------------------
NAME
get_data_value_offset--- get data_value_offset from the symbol list of block
SYNOPSIS
long int get_data_value_offset ( DBlock * block );
DESCRIPTION
The data_value_offset is read from the symbol list of block and converted
to long integer.
If data_value_offset is not found the default is 0l.
RETURN VALUE
long integer
AUTHOR
23-Jul-1999 PB Specification (EDF_DataFormatVersion 2.20)
--------------------------------------------------------------------------*/
long int get_data_value_offset ( DBlock * block )
{ long int data_value_offset;
SElement * symbol;
int errval;
if ( search_general( block, DATA_VALUE_OFFSET_KEY, &symbol ) )
data_value_offset = 0l;
else {
data_value_offset = num_str2long( symbol->String, NULL, &errval );
if (errval) {
fprintf(stderr,"WARNING: Failed to convert header value %s = %s\n",
DATA_VALUE_OFFSET_KEY, symbol->String );
fprintf(stderr," Using %s = 0\n",DATA_VALUE_OFFSET_KEY);
data_value_offset = 0l;
}
}
return( data_value_offset );
} /* get_data_value_offset */
/*---------------------------------------------------------------------------
NAME
get_raster_configuration --- get the raster configuration number
SYNOPSIS
long get_raster_configuration ( DBlock * block );
DESCRIPTION
The raster_configuration is read from the symbol list of block and
returned as a long integer value.
If raster_configuration is not found the default is 1.
RETURN VALUE
long integer
error : 0
DCompression : positive number
AUTHOR
14-Mar-1998 PB Specification
---------------------------------------------------------------------------*/
long get_raster_configuration ( DBlock * block )
{ long raster_configuration;
SElement * symbol;
int errval;
if ( search_general( block, RASTER_CONFIGURATION_KEY, &symbol ) )
raster_configuration = 1l;
else {
raster_configuration = num_str2long( symbol->String, NULL, &errval );
if (errval) {
fprintf(stderr,"WARNING: Failed to convert header value %s = %s\n",
RASTER_CONFIGURATION_KEY, symbol->String);
fprintf(stderr," Using %s = 1\n",RASTER_CONFIGURATION_KEY);
raster_configuration = 1l;
}
}
return( raster_configuration );
} /* get_raster_configuration */
/*---------------------------------------------------------------------------
NAME
get_binary_array --- read data array (decompressed, with endian correction)
SYNOPSIS
int get_binary_array ( DBlock * block, void * buffer, size_t buflen,
int must_use_buffer );
DESCRIPTION
The binary data of block is read from disk. block must have been
opened with open_read_block and the header must be in memory.
If buffer is the NULL-pointer a memory section is internally allocated
for the data. It has the size
DataLen = PRODUCT(DataDim_nn)[nn=1,NN]*sizeof(DataType) bytes
Otherwise, if buffer is not the NULL-pointer and must_use_buffer
is set (True) the read data will be written to buffer.
If the buffer length (buflen) is too short to read all data the routine
exits with an error (return value -1).
If buffer is not the NULL-pointer and must_use_buffer is not set
(False) the read data will be written to buffer only if the buffer
length (buflen) is sufficiently large to read all data, otherwise
a memory section is allocated like in the case where buffer is the
NULL-pointer.
DataDim_nn stands for the nn-th dimension and NN for the
dimensionality of the array. PRODUCT indicates the product over all
array dimensions Dim_nn from nn=1 to NN.
The data are read like they are on stored. No transformation is applied.
The following key words are read
Dim_1, Dim_2, ... (default 1, 0, ...)
DataType (default FloatIEEE32)
ByteOrder (default HighByteFirst)
Compression (default None)
DataValueOffset (default 0)
The following parameter are updated in block:
block->Data = pointer to the allocated data buffer
block->DataBufferLen = length of the data buffer in bytes
block->DataLen = length of the meaningful data in bytes
block->DataType = DataType of a single data element in the data buffer
block->DataByteOrder = ByteOrder of a single data element in the data buffer
block->DataRasterConfiguration = RasterConfiguration of the data array
block->DataCompression = Compression type of the data in the data array
block->DataValueOffset = offset to be added to each data item
*block->DataDim = pointer to the allocated dimension array
with DataDim[0] = NN.
block->Raw = pointer to the allocated raw data buffer
block->RawBufferLen = length of the raw data buffer in bytes
block->RawLen = length of the meaningful raw data in bytes
DATA SOURCE
According to block->BinaryFileName the binary data is read from the channel
of the main file (block->Chain->File->Channel) or from an external file.
The file pointer is in both cases positioned at block->BinaryFilePos of
the data file.
block->BinaryFileName input channel
(char *) NULL block->Chain->File->Channel
<filename> open <filename>
RETURN VALUE
success : 0
error : -1
AUTHOR
03-Mar-1998 PB Specification
29-Dec-2000 PB buffer, buflen, test block->Flags.DataExternal
30-Mar-2001 PB alt_binaryname
---------------------------------------------------------------------------*/
int get_binary_array ( DBlock * block, void * buffer, size_t buflen,
int must_use_buffer )
{ static const char * GBA_Error = "ERROR: get_binary_array:" ;
int i;
int intern = True;
char *alt_binaryname;
long *data_dim;
int data_type;
int byte_order;
int compression;
long data_value_offset;
long raster_configuration;
size_t data_size, data_len, data_buffer_len;
size_t bytes_to_read=(size_t) -1; // set to absolute maximum
size_t bytes_read; // number of read bytes
unsigned long data_pos, data_number;
FILE *channel;
int errval;
/* check whether block exists */
if (!block) return(-1);
/* get binary data description */
data_dim = get_data_dim ( block ); /* is free'ed when block is free'ed */
if (!data_dim) return(-1); // MissingArrayDimensions
data_type = get_data_type ( block );
byte_order = get_byte_order ( block );
compression = get_compression ( block );
data_value_offset = get_data_value_offset ( block );
raster_configuration = get_raster_configuration ( block );
/* determine maximum number of bytes of uncompressed data */
data_size = edf_data_sizeof ( data_type );
data_number = edf_dim_product ( data_dim ) ;
data_len = data_size * data_number ; // uncompressed length
/* determine start and restrict bytes_to_read to length of block/binaryfile */
if (block->BinaryFileName) {
data_pos = block->BinaryFilePos;
if (block->BinaryFileLen) // only if BinaryFileLen is set
bytes_to_read = block->BinaryFileLen;
} else {
data_pos = block->BinaryPos;
bytes_to_read = block->BinaryLen;
}
/* restrict length of bytes_to_read to length of uncompressed data */
if ( compression>UnCompressed ) bytes_to_read = MIN(bytes_to_read,data_len);
if (EDFIO_debug) {
printf(" ---- get_binary_array BEGIN\n");
printf(" block = %p\n", block);
printf(" buffer = %p\n", buffer);
// printf(" buflen = %zu\n", buflen);
printf(" buflen = %zu | %lu\n", buflen, buflen);
printf(" data_dim[0] = %ld\n", data_dim[0]);
for (i=1;i<=data_dim[0];i++)
printf(" data_dim[%d] = %ld\n", i, data_dim[i]);
printf(" data_type = %d\n", data_type);
printf(" byte_order = %d\n", byte_order);
printf(" data_value_offset = %ld\n", data_value_offset);
printf(" raster_configuration = %ld\n", raster_configuration);
// printf(" data_size = %zu\n", data_size);
printf(" data_size = %zu | %lu\n", data_size, data_size);
printf(" data_number = %ld\n", data_number);
// printf(" data_len = %zu\n", data_len);
printf(" data_len = %zu | %lu\n", data_len, data_len);
printf(" compression = %s\n", edf_compression2string(compression));
printf(" data_pos = %ld\n", data_pos);
// printf(" bytes_to_read = %zu\n", bytes_to_read);
printf(" bytes_to_read = %zu | %lu\n", bytes_to_read, bytes_to_read);
} /* EDFIO_debug */
/* update DataDim array in block */
if ((block->DataDim)&&(block->DataDim[0]>=data_dim[0])) {
// copy dimensions into existing array, release data_dim
if ( !(copydim( block->DataDim, block->DataDim[0], data_dim ) ) ) {
free(data_dim); fprintf(stderr,"%s copydim\n",GBA_Error); return(-1); }
free(data_dim);
} else block->DataDim = data_dim; // use already allocated buffer
if (block->BinaryFileName) {
/* open external source read only */
if (EDFIO_debug) printf(" BinaryFileName = %s\n",block->BinaryFileName);
if (!(channel = fopen( block->BinaryFileName,"rb"))) {
if (!has_extension ( block->BinaryFileName )) {
/* add an empty extension */
if (!(alt_binaryname = catstr( block->BinaryFileName, "." ))) {
fprintf(stderr,"%s fopen 1\n",GBA_Error); return(-1); }
channel = fopen( alt_binaryname,"rb");
free( alt_binaryname );
if (!(channel)) { fprintf(stderr,"%s fopen 2\n",GBA_Error); return(-1);}
} else { fprintf(stderr,"%s fopen\n",GBA_Error); return(-1); }
}
intern = False;
} else channel = block->Chain->File->Channel;
/* search data start position */
if ( fseek( channel, data_pos, SEEK_SET) ) {
fprintf(stderr,"%s fseek\n",GBA_Error); return(-1); }
/* do not use buffer if it is equal to block->Data */
if ( (block->Data == buffer) && (!must_use_buffer) ) {
buffer = (void *) NULL; buflen = (size_t) 0; }
/* unlink externally allocated memory or release internally allocated memory */
if (block->Flags.ExternalDataAlloc) {
block->Data = (void *) NULL;
block->DataBufferLen = (unsigned long) 0;
block->DataLen = (unsigned long) 0;
block->Flags.ExternalDataAlloc = False;
} else {
if ( ( (block->Data) && (block->DataBufferLen<data_len) ) ||
(must_use_buffer) ) {
free(block->Data); block->Data = (void *) NULL;
block->DataBufferLen = (unsigned long) 0;
block->DataLen = (unsigned long) 0;
}
}
if ( (buffer == (void *) NULL) ||
((buflen<data_len)&&(!must_use_buffer)) ) {
/* allocate memory, if necessary */
if (EDFIO_debug) printf(" Allocate new memory, if necessary\n");
if (block->DataBufferLen<data_len)
if (!(block->Data = malloc( data_len ))) {
fprintf(stderr,"%s malloc\n",GBA_Error); return(-1); }
data_buffer_len = data_len;
block->Flags.ExternalDataAlloc = False;
} else {
if (EDFIO_debug) printf(" Use supplied buffer\n");
if (buflen<data_len) {
// fprintf(stderr,"%s supplied buffer < %zu bytes\n",GBA_Error,data_len);
fprintf(stderr,"%s supplied buffer < %zu | %lu bytes\n",
GBA_Error,data_len,data_len);
return(-1); }
block->Flags.ExternalDataAlloc = True;
block->Data = buffer;
data_buffer_len = buflen;
}
/* read data from file */
switch ( compression ) {
case GzipCompression:
case ZCompression:
/* read and decompress data */
if ( cmpr_frinflate ( block->Data, data_buffer_len, channel,
bytes_to_read, compression, &bytes_read, &errval ) ) {
fprintf(stderr,"%s cmpr_frinflate errval=%d\n",GBA_Error,errval);
return(-1); }
break;
default: // no decompression
/* restrict length of bytes_to_read to length of uncompressed data */
bytes_to_read = MIN(bytes_to_read,data_len);
/* read data */
if ( (bytes_read = fread(block->Data,1,bytes_to_read,channel)) < bytes_to_read ) {
fprintf(stderr,"%s fread\n",GBA_Error); return(-1); }
} // switch
/* check length */
if (data_len-bytes_read>0) {
// fprintf(stderr,"%s read bytes %zu less than array size %zu\n",
fprintf(stderr,"%s read bytes %zu | %lu less than array size %zu | %lu\n",
GBA_Error, bytes_read, bytes_read, data_len, data_len ); return(-1); }
/* close external file */
if ( !intern )
if (fclose( channel )) {
fprintf(stderr,"%s fclose\n",GBA_Error); return(-1); }
/* update block */
block->DataLen = data_len;
block->DataBufferLen = data_buffer_len;
block->DataType = data_type;
block->DataByteOrder = byte_order;
block->DataRasterConfiguration = raster_configuration;
block->DataValueOffset = data_value_offset;
block->DataCompression = UnCompressed;
block->Flags.DataExternal = False; /* data are read from file */
if (EDFIO_debug) printf(" ---- get_binary_array END\n");
return(0);
} /* get_binary_array */
/*===get_binary_array END================================================---*/
/****************************************************************************/
/*---------------------------------------------------------------------------
NAME
find_chainkey --- returns ChainKey for DataChain
SYNOPSIS
int find_chainkey ( int stream, int DataChain, char ChainKey[] )
DESCRIPTON
Searches a chain key definition for DataChain and copies it to ChainKey.
ChainKey must be sufficiently long (MaxKeyLen+1). First, it searches a
chain key definition in the general block, then it takes the default
chain key. DataChain must be zero or a positive number.
RETURN VALUE
0 : success
-1 : failed
---------------------------------------------------------------------------*/
int find_chainkey ( int stream, int DataChain, char ChainKey[] )
{
SElement *symbol;
DFile *file = NULL;
char ChainKeyDefinition[MaxKeyLen+1];
if ( (stream>=0)&&(stream<MaxFiles) ) {
file = &FileTable[stream];
if (DataChain==0) {
strncpy(ChainKey,GENERAL_CHAIN_KEY,MaxKeyLen+1);
} else {
/* test, if general block exists */
if (file->GeneralBlock == (DBlock *) NULL) return(-1);
/* search chainkey in general block */
sprintf(ChainKeyDefinition,"%s%u",CHAIN_KEY_DEFINITION,DataChain);
if (!( search_symbol( file->GeneralBlock,
ChainKeyDefinition, &symbol ) ) ) {
strncpy(ChainKey,symbol->Value,MaxKeyLen+1);
} else { if (!(default_chain_key(ChainKey, DataChain))) return(-1); }
}
return(0);
} else return(-1);
} /* find_chainkey */
/*---------------------------------------------------------------------------
find_blockkey (found : 0, failed : -1)
BlockKey must be sufficiently long (MaxKeyLen+1)
---------------------------------------------------------------------------*/
int find_blockkey ( int DataChain, int DataNumber, char BlockKey[] )
{
if ( DataChain==0 ) strncpy(BlockKey,GENERAL_BLOCK_KEY,MaxKeyLen+1);
else long2s(BlockKey,DataNumber);
return(0);
} /* find_blockkey */
/*---------------------------------------------------------------------------
NAME
put_compressed_block
SYNOPSIS
int put_compressed_block( DBlock * block, int * pErrorValue );
DESCRIPTION
Writes block->Data compressed or uncompressed, depending on
DataCompression.
If the flags HeaderChanged or DataChanged are set the data are
compressed and written.
INPUT VALUES
DBlock * block;
OUTPUT VALUES
*pErrorValue update if not NULL
MODIFIED
RETURN VALUE
In case of success the returned value is 0 otherwise -1.
*pErrorValue is updated, if not NULL
--------------------------------------------------------------------------*/
int put_compressed_block( DBlock * block, int * pErrorValue )
{ int errval=RoutineFailed;
static const char * PCB_Error = "ERROR: put_compressed_block" ;
if (block) {
// the data need only to be compressed when they will be really written
if ( ((block->Flags.HeaderChanged)||(block->Flags.DataChanged)) &&
(!block->Flags.InternalData) ) {
// write the compressed data to Raw
switch ( block->DataCompression ) {
case GzipCompression:
case ZCompression: // assuming compressed<=uncompressed
if (!(block->Raw = malloc( block->DataLen ))) {
fprintf(stderr,"%s malloc\n",PCB_Error);
goto put_compressed_block_error;
}
block->RawBufferLen = block->DataLen;
if ( cmpr_deflate( block->Raw, block->RawBufferLen, block->Data,
block->DataLen, block->DataCompression, &(block->RawLen),
&errval ) ) {
fprintf(stderr,"%s cmpr_deflate (errval=%d)\n",PCB_Error,errval);
goto put_compressed_block_error;
}
break;
default: ; // no compression here
}
}
if ( put_data_block( block ) ) {
errval = WriteDataError;
goto put_compressed_block_error;
}
if (block->RawBufferLen)
if (block->Raw)
free (block->Raw);
block->Raw=NULL;
block->RawBufferLen = (size_t) 0;
block->RawLen = (size_t) 0;
}
errval = RoutineSucceeded;
if (pErrorValue) *pErrorValue=errval;
return(0);
put_compressed_block_error:
if (block->RawBufferLen)
if (block->Raw)
free (block->Raw);
block->Raw=NULL;
block->RawBufferLen = (size_t) 0;
block->RawLen = (size_t) 0;
if (pErrorValue) *pErrorValue=errval;
return(-1);
} // put_compressed_block
/*---------------------------------------------------------------------------
NAME
disk_write_block
SYNOPSIS
int disk_write_block ( DBlock * block, int * pErrorValue );
DESCRIPTION
If block exists header and binary data are written to disk.
The symbol list and the link to the data are removed. DataLen
is set to 0. The data block flags DiskBlockUsed, DiskBlockFixed,
HeaderExternal and DataExternal are set to True, HeaderChanged
and DataChanged are set to False. Before reusing this data block
it must be read back from the file.
INPUT VALUES
DBlock * block;
OUTPUT VALUES
*pErrorValue
MODIFIED
Block is written to the output file and afterwards the symbol list
is removed from block. The data specification is cleared and the
dynamic arrays (Data and DataDim) are released if they were not
externally allocated. Externally allocated arrays must be released
separately. block->DataLen binary bytes of block->Data are written.
RETURN VALUE
In case of success the returned value is 0 otherwise -1.
A more precise description of the error is returned in *pErrorValue.
--------------------------------------------------------------------------*/
int disk_write_block ( DBlock * block, int * pErrorValue )
{ DFile * file;
int errval;
if ( block ) {
file = block->Chain->File;
if ( put_compressed_block( block, &errval ) )
goto disk_write_block_error;
/* free symbol list only if InternalHeader is not set
and if block is not the general block */
if (( !block->Flags.InternalHeader ) && (block != file->GeneralBlock)) {
if ( free_symbol_list( block ) ) {
errval = CouldNotFreeHeaders;
goto disk_write_block_error;
}
/* update data block flags for header*/
block->Flags.HeaderExternal = True;
}
/* unlink data only if InternalData is not set
and if block is not the general block */
if (( !block->Flags.InternalData ) && (block != file->GeneralBlock)) {
/* clear data specification and release dynamic arrays */
if ( (!block->Flags.ExternalDataAlloc) && (block->Data) )
free( block->Data );
block->Data = NULL;
block->DataLen = (size_t) 0;
block->DataType = InValidDType;
block->DataValueOffset = 0l;
block->DataByteOrder = InValidBOrder;
block->DataRasterConfiguration = 0l;
block->DataCompression = InValidDCompression;
if ( (!block->Flags.ExternalDimAlloc) && (block->DataDim) )
free( block->DataDim );
block->DataDim = (long*) NULL;
/* update data block flags for data*/
block->Flags.DataExternal = True;
block->Flags.ExternalDataAlloc = False;
block->Flags.ExternalDimAlloc = False;
}
} /* if (block) ... */
errval = RoutineSucceeded;
if (pErrorValue) *pErrorValue = errval;
return(0);
disk_write_block_error:
if (pErrorValue) *pErrorValue = errval;
return(-1);
} /* disk_write_block */
/*---------------------------------------------------------------------------
NAME
open_write_block - open a single write to a data block
SYNOPSIS
int open_write_block( int stream, long int DataNumber, int DataChain,
DBlock ** pblock, int * pErrorValue );
DESCRIPTION
Opens a single write to the data_block file.
Searches for header 'DataNumber' in 'DataChain' and returns pblock.
If it does not exists, it is created. DataChain zero is the
general block. It must be at the beginning of the file.
RETURN VALUE
In case of success the returned value is 0 otherwise -1. A more precise
description of the error is returned in *pErrorValue.
--------------------------------------------------------------------------*/
int open_write_block( int stream, long int DataNumber, int DataChain,
DBlock ** pblock, int * pErrorValue )
{
DFile * file = NULL;
DChain * chain;
DBlock * block;
int errval;
char BlockKey[MaxKeyLen+1];
char ChainKey[MaxKeyLen+1];
/* check stream */
if ( (stream<0)||(stream>=MaxFiles) ) {
errval = InvalidStream;
goto open_write_block_error;
}
file = &FileTable[stream];
/* GeneralBlock can only be modified when active */
if (DataChain==0)
if (file->GeneralBlock!=file->ActiveBlock) {
errval=GeneralBlockNotFirst;
goto open_write_block_error;
}
/* get Channel */
if ( !file->Used ) {
errval=NoFileOpen;
goto open_write_block_error;
}
/* find 'ChainKey' */
if ( find_chainkey ( stream, DataChain, ChainKey ) ) {
errval=MissingKeyDefinition;
goto open_write_block_error;
}
/* find 'BlockKey' */
if ( find_blockkey ( DataChain, DataNumber, BlockKey ) ) {
errval=MissingKeyDefinition;
goto open_write_block_error;
}
/* insert header */
if (insert_data_chain( file, ChainKey, &chain) ) {
errval=CouldNotInsertChain;
goto open_write_block_error;
}
if (insert_data_block( chain, BlockKey, &block) ) {
errval=CouldNotInsertBlock;
goto open_write_block_error;
}
/* update data block flags */
if ( file->Flags.TemporaryFile ) {
block->Flags.InternalHeader = True;
block->Flags.InternalData = True;
block->Flags.HeaderExternal = False;
block->Flags.DataExternal = False;
}
/* flush previously active block */
if ( file->ActiveBlock != block) {
/* flush ActiveBlock */
if ( disk_write_block ( block->Chain->File->ActiveBlock, &errval ) )
goto open_write_block_error;
/* update ActiveBlock */
file->ActiveBlock = block;
}
if (pblock) *pblock = block;
errval=RoutineSucceeded;
if (pErrorValue) *pErrorValue=errval;
return(0);
open_write_block_error:
if (pErrorValue) *pErrorValue=errval;
return(-1);
} /* open_write_block */
/*---------------------------------------------------------------------------
NAME
close_write_block - close a single write to a data block
SYNOPSIS
int close_write_block(DBlock * block, int * pErrorValue );
DESCRIPTION
Closes a single write to the data_block, currently a dummy routine.
RETURN VALUE
In case of success the returned value is 0 otherwise -1. A more
precise description of the error is returned in *pErrorValue.
--------------------------------------------------------------------------*/
int close_write_block( DBlock * block, int * pErrorValue )
{
DFile * file;
DChain * chain;
// int GeneralBlock = is_general_block ( block ); // unused
chain = block->Chain;
file = chain->File;
*pErrorValue = RoutineSucceeded;
return(0);
} /* close_write_block */
/*---------------------------------------------------------------------------
NAME
open_read_block - open a single read from a data block
SYNOPSIS
int open_read_block(int stream, long int DataNumber, int DataChain,
DBlock ** pblock, int * pErrorValue );
DESCRIPTION
Opens a single read from the data_block
file. In case of success the return value is 1, otherwise 0.
RETURN VALUE
In case of success the returned value is 0. If the header was not found
and without other error the return value is 1. In case of an error the
return value is -1.
A more detailed description of the error is returned in *pErrorValue.
return value 1 : Warning
DataNumber or DataChain not found, no other error
*pErrorValue=CouldNotFindHeader;
0 : OK, data header found
*pErrorValue=RoutineSucceeded
-1 : Error,
*pErrorValue = <any>
--------------------------------------------------------------------------*/
int open_read_block( int stream, long int DataNumber, int DataChain,
DBlock ** pblock, int * pErrorValue )
{
DFile * file;
DChain * chain;
DBlock * block;
int errval;
char BlockKey[MaxKeyLen+1];
char ChainKey[MaxKeyLen+1];
/* check stream */
if ((stream<0)||(stream>=MaxFiles)) {
errval = InvalidStream;
goto open_read_block_error;
}
/* get file */
file = &FileTable[stream];
if ( !file->Used ) {
errval = NoFileOpen;
goto open_read_block_error;
}
/* find 'ChainKey' */
if ( find_chainkey ( stream, DataChain, ChainKey ) ) {
errval = MissingKeyDefinition;
goto open_read_block_error;
}
/* find 'BlockKey' */
if ( find_blockkey ( DataChain, DataNumber, BlockKey ) ) {
errval = MissingKeyDefinition;
goto open_read_block_error;
}
/* search header */
if (search_data_chain( file, ChainKey, &chain) ) {
errval = CouldNotFindHeader;
goto open_read_block_notfound;
}
if (search_data_block( chain, BlockKey, &block) ) {
errval = CouldNotFindHeader;
goto open_read_block_notfound;
}
/* update data block flags */
if ( file->Flags.TemporaryFile ) {
block->Flags.InternalHeader = True;
block->Flags.InternalData = True;
block->Flags.HeaderExternal = False;
block->Flags.DataExternal = False;
}
/* flush previously active block and get block from disk */
if ( file->ActiveBlock != block) {
/* flush ActiveBlock */
if ( disk_write_block( file->ActiveBlock, &errval ) )
goto open_read_block_error;
/* read header */
if ( get_data_header( block ) ) {
errval = ReadDataError; // error reading header
goto open_read_block_error;
}
/* update ActiveBlock */
file->ActiveBlock = block;
}
*pblock = block;
errval = RoutineSucceeded;
/* success */
if (pErrorValue) *pErrorValue = errval;
return(0);
open_read_block_notfound:
/* warning */
if (pErrorValue) *pErrorValue = errval;
return(1);
open_read_block_error:
/* error */
if (pErrorValue) *pErrorValue = errval;
return(-1);
} /* open_read_block */
/*---------------------------------------------------------------------------
NAME
close_read_block - close a single read from a data block
SYNOPSIS
int close_read_block(DBlock * block, int * pErrorValue);
DESCRIPTION
Closes a single read from a data_block, currently a dummy routine.
RETURN VALUE
In case of success the returned value is 0 otherwise -1.
A more precise description of the error is returned in *pErrorValue.
--------------------------------------------------------------------------*/
int close_read_block( DBlock * block, int * pErrorValue )
{
DFile * file;
DChain * chain;
// int GeneralBlock = is_general_block ( block ); // unused
chain = block->Chain;
file = chain->File;
if (pErrorValue) *pErrorValue = RoutineSucceeded;
return(0);
} /* close_read_block */
/*---------------------------------------------------------------------------
NAME
read_header_string --- read a string from the header
DESCRIPTION
Searches for 'keyword' in the header 'DataNumber' in 'DataChain'.
If the header or the keyword does not exists, the return value is 0 and a
specific error value is returned. This error is not fatal and can be used
as a test for the existence of the keyword or the header.
The returned argument *pString is a pointer to a location that contains
the string of the element 'keyword'.
This string is not accesible any more when the file is closed or if
the file header is not kept in memory when another block is accessed.
RETURN VALUE
return value 0 if not found and no other error
return( int ) 0 : data header not found or keyword not found
*pstatus = status_error;
*pErrorValue= ( CouldNotFindHeader,
CouldNotFindSymbol,
RoutineSucceeded );
1 : data header found or error,
*pstatus = Success or status_error;
*pErrorValue = <any>
--------------------------------------------------------------------------+*/
int read_header_string ( int stream, long int DataNumber, int DataChain,
const char * keyword, const char ** pString,
int * pErrorValue, int * pstatus ) /*---*/
{
DBlock * block;
SElement * symbol;
const char *String;
int errval, status=status_error;
if (EDFIO_debug) printf("read_header_string");
switch ( open_read_block (stream, DataNumber, DataChain,
&block, &errval) ) {
case 1: /* data header not found */
if (EDFIO_debug) printf("\n");
goto read_header_string_notfound;
case -1: /* error */
goto read_header_string_error;
}
/* read keyword value from symbol list */
if (search_general( block, keyword, &symbol) ) {
if (EDFIO_debug) printf(" %s missing;\n",keyword);
errval = CouldNotFindSymbol;
goto read_header_string_notfound;
}
if ( close_read_block( block, &errval ) )
goto read_header_string_error;
String = symbol->String;
if (pString) *pString = String;
if (EDFIO_debug) printf(" %s = \"%s\";\n",keyword,String);
errval = RoutineSucceeded;
status = status_success;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
return(1);
read_header_string_notfound:
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
return(0);
read_header_string_error:
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
return(1);
} /* read_header_string */
/*---------------------------------------------------------------------------
NAME
write_header_string --- write character string into header
DESCRIPTION
Searches for header 'DataNumber' in 'DataChain'.
If it does not exists, it is created. It writes keyword and value with
insert_string into the header. This routine writes, if necessary, the
input string with several continuation keys into the header.
RETURN VALUE
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int write_header_string ( int stream, long int DataNumber, int DataChain,
const char * keyword, const char *String,
int * pErrorValue, int * pstatus ) /*---*/
{
DBlock * block;
SElement * symbol;
if (EDFIO_debug) printf("write_header_string %s = \"%s\";\n",keyword,String);
if ( open_write_block (stream, DataNumber, DataChain,
&block, pErrorValue ) ) {
*pstatus=status_error;
return(0);
}
/* create/replace keyword and value in header */
if (insert_string( block, keyword, String, &symbol) ) {
*pstatus = status_error;
*pErrorValue = CouldNotInsertSymbol; return(0); }
if ( close_write_block( block, pErrorValue ) ) {
*pstatus = status_error;
return(0);
}
/* The header was changed and must be written to disk */
block->Flags.HeaderChanged = True;
*pErrorValue = RoutineSucceeded;
*pstatus = status_success;
return(1);
} /* write_header_string */
/*---------------------------------------------------------------------------
NAME
delete_key --- delete key, continuation keys and values
DESCRIPTION
Searches for header 'DataNumber' in 'DataChain'.
and deletes non DATA FORMAT SPECIFIC keys, otherwise error.
RETURN VALUE
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int delete_key ( int stream, long int DataNumber, int DataChain,
const char * keyword,
int * pErrorValue, int * pstatus ) /*---*/
{
DBlock * block;
int errval, status;
if (EDFIO_debug) printf("delete_key %s BEGIN\n",keyword);
// check, if keyword is data format specific
if (!is_prefix(keyword,DATA_FORMAT_PREFIX,UpperCaseSort)) {
if ( edf_test_header ( stream, DataNumber,DataChain, NULL, NULL ) ) {
/* read header */
if ( open_read_block (stream, DataNumber, DataChain,
&block, &errval) )
goto delete_key_error;
if ( close_read_block( block, &errval ) )
goto delete_key_error;
/* modify and write header */
if ( open_write_block (stream, DataNumber, DataChain,
&block, &errval ) )
goto delete_key_error;
/* remove keyword, continuation keys and values from header */
if ( remove_string( block, keyword ) ) {
errval = CouldNotDeleteString;
goto delete_key_error;
}
if ( close_write_block( block, &errval ) )
goto delete_key_error;
/* The header was changed and must be written to disk */
block->Flags.HeaderChanged = True;
}
errval = RoutineSucceeded;
} else {
errval = CouldNotDeleteString;
goto delete_key_error;
}
status = status_success;
if (pstatus) *pstatus=status;
if (pErrorValue) *pErrorValue=errval;
if (EDFIO_debug) printf("delete_key END 1\n");
return(1);
delete_key_error:
status=status_error;
if (pstatus) *pstatus=status;
if (pErrorValue) *pErrorValue=errval;
if (EDFIO_debug) printf("delete_key END (status=%d) 0\n",status);
return(0);
} /* delete_key */
/*===machinetype BEGIN====================================================*/
/*+++ public interface of machinetypes------------------------------------
DESCRIPTION
The function edf_datatype2machinetype returns a machine type for data type.
If a machine type does not exist to a given data type the return value
is zero.
If MachineTypeInit is set, MachineType contains a translation table from
DType to MType, e.g mtype = MachineType[dtype].
PUBLIC enum MType; // defined in edfio.h
PUBLIC const char * MachineType2String ( int mtype );
PUBLIC int String2MachineType( const char * string );
PUBLIC int edf_datatype2machinetype ( int dtype );
PUBLIC int edf_machinetype2datatype ( int mtype );
PUBLIC size_t edf_machine_sizeof( int mtype );
PUBLIC void edf_showdatatypes ( int full );
PUBLIC void edf_showmachinetypes ( int full );
----------------------------------------------- end of machinetypes ---*/
# define Unsigned8Max 255UL
# define Unsigned8Min 0UL
# define Unsigned16Max 65535UL
# define Unsigned16Min 0UL
# define Unsigned32Max 4294967295UL
# define Unsigned32Min 0UL
# if __WORDSIZE == 64
# define Unsigned64Max 18446744073709551615UL
# else
# define Unsigned64Max 0UL
# endif
# define Unsigned64Min 0UL
# define Signed8Max 127L
# define Signed8Min ( -Signed8Max -1L )
# define Signed16Max 32767L
# define Signed16Min ( -Signed16Max -1L )
# define Signed32Max 2147483647L
# define Signed32Min ( -Signed32Max -1L )
# if __WORDSIZE == 64
# define Signed64Max 9223372036854775807L
# else
# define Signed64Max 0UL
# endif
# define Signed64Min (-Signed64Max - 1L)
PRIVATE unsigned long UCharMin, UCharMax, UShortMin, UShortMax;
PRIVATE unsigned long UIntMin, UIntMax, ULongMin, ULongMax;
PRIVATE long CharMin, CharMax, ShortMin, ShortMax;
PRIVATE long IntMin, IntMax, LongMin, LongMax;
PRIVATE int MachineType[EndDType];
PRIVATE int DataType[EndMType];
PRIVATE int MachineTypeInit = 0; // not initialized
const char * MTypeStrings[EndMType+1] =
{ "Invalid",
"unsigned char", "char", "unsigned short", "short",
"unsigned int", "int", "unsigned long", "long",
"float", "double",
(const char *) NULL };
/*+++------------------------------------------------------------------------
NAME
edf_machine_sizeof --- returns the size of a machine data type element
SYNOPSIS
MType mtype;
size_t edf_machine_sizeof( int mtype )
DESCRIPTION
The size required for a MType element is returned.
RETURN VALUE
NULL : error (e.g. for invalid mtype)
>NULL : size of mtype
AUTHOR
30-Apr-2000 PB
--------------------------------------------------------------------------+*/
size_t edf_machine_sizeof( int mtype )
{ switch ( mtype ) {
case MUnsignedChar : return ( sizeof( unsigned char ) );
case MChar : return ( sizeof( char ) );
case MUnsignedShort : return ( sizeof( unsigned short ) );
case MShort : return ( sizeof( short ) );
case MUnsignedInteger : return ( sizeof( unsigned int ) );
case MInteger : return ( sizeof( int ) );
case MUnsignedLong : return ( sizeof( unsigned long ) );
case MLong : return ( sizeof( long ) );
case MFloat : return ( sizeof( float ) );
case MDouble : return ( sizeof( double ) );
};
return ( (size_t) 0 );
} /* edf_machine_sizeof */
/*---------------------------------------------------------------------------
NAME
MachineType2String --- returns mtype as string
SYNOPSIS
const char * MachineType2String ( int mtype )
DESCRIPTION
shows internal data types
---------------------------------------------------------------------------*/
const char * MachineType2String ( int mtype )
{ if ((mtype<0)||(mtype>=EndMType)) mtype = InValidMType;
return( MTypeStrings[mtype] );
} /* MachineType2String */
/*---------------------------------------------------------------------------
NAME
String2MachineType --- converts a string to MType
SYNOPSIS
(MType) int String2MachineType( const char * string );
DESCRIPTION
GCC AND G++
For compatibility between gcc and g++ the declaration of the return
value with its enumerated type has been replaced by "int".
RETURN VALUE
MType == 0 : error, e.g. cannot convert
MType > 0 : valid machine type value
AUTHOR
30-Apr-2000 PB from edf_string2datatype
--------------------------------------------------------------------------*/
int String2MachineType( const char * string )
{ int NE=True;
long i = 0;
while ( (NE && MTypeStrings[i]) )
NE = compare_keys( string, MTypeStrings[i++], UpperCaseSort );
i = MAX(0,i-1);
if (NE) return( InValidMType );
else return( i );
} /* String2MachineType */
/*---------------------------------------------------------------------------
NAME
initmachinetypes
SYNOPSIS
void initmachinetypes ( void )
DESCRIPTION
inits machine type array
---------------------------------------------------------------------------*/
void initmachinetypes ( void )
{ int i;
int * machinetype = MachineType;
int * datatype = DataType;
for (i=0;i<EndDType;i++) machinetype[i] = InValidMType;
for (i=0;i<EndMType;i++) datatype[i] = InValidDType;
// unsigned char
switch (sizeof( unsigned char ) ) {
case 1 : machinetype[Unsigned8] = MUnsignedChar;
datatype[MUnsignedChar] = Unsigned8;
UCharMin = Unsigned8Min;
UCharMax = Unsigned8Max;
break;
case 2 : machinetype[Unsigned16] = MUnsignedChar;
datatype[MUnsignedChar] = Unsigned16;
UCharMin = Unsigned16Min;
UCharMax = Unsigned16Max;
break;
}
// unsigned short int
switch (sizeof( unsigned short int ) ) {
case 1 : machinetype[Unsigned8] = MUnsignedShort;
datatype[MUnsignedShort] = Unsigned8;
UShortMin = Unsigned8Min;
UShortMax = Unsigned8Max;
break;
case 2 : machinetype[Unsigned16] = MUnsignedShort;
datatype[MUnsignedShort] = Unsigned16;
UShortMin = Unsigned16Min;
UShortMax = Unsigned16Max;
break;
case 4 : machinetype[Unsigned32] = MUnsignedShort;
datatype[MUnsignedShort] = Unsigned32;
UShortMin = Unsigned32Min;
UShortMax = Unsigned32Max;
break;
}
// unsigned int
switch (sizeof( unsigned int ) ) {
case 1 : machinetype[Unsigned8] = MUnsignedInteger;
datatype[MUnsignedInteger] = Unsigned8;
UIntMin = Unsigned8Min;
UIntMax = Unsigned8Max;
break;
case 2 : machinetype[Unsigned16] = MUnsignedInteger;
datatype[MUnsignedInteger] = Unsigned16;
UIntMin = Unsigned16Min;
UIntMax = Unsigned16Max;
break;
case 4 : machinetype[Unsigned32] = MUnsignedInteger;
datatype[MUnsignedInteger] = Unsigned32;
UIntMin = Unsigned32Min;
UIntMax = Unsigned32Max;
break;
case 8 : machinetype[Unsigned64] = MUnsignedInteger;
datatype[MInteger] = Unsigned64;
UIntMin = Unsigned64Min;
UIntMax = Unsigned64Max;
break;
}
// unsigned long
switch (sizeof( unsigned long ) ) {
case 1 : machinetype[Unsigned8] = MUnsignedLong;
datatype[MUnsignedLong] = Unsigned8;
ULongMin = Unsigned8Min;
ULongMax = Unsigned8Max;
break;
case 2 : machinetype[Unsigned16] = MUnsignedLong;
datatype[MUnsignedLong] = Unsigned16;
ULongMin = Unsigned16Min;
ULongMax = Unsigned16Max;
break;
case 4 : machinetype[Unsigned32] = MUnsignedLong;
datatype[MUnsignedLong] = Unsigned32;
ULongMin = Unsigned32Min;
ULongMax = Unsigned32Max;
break;
case 8 : machinetype[Unsigned64] = MUnsignedLong;
datatype[MUnsignedLong] = Unsigned64;
ULongMin = Unsigned64Min;
ULongMax = Unsigned64Max;
break;
}
// char
switch (sizeof( char ) ) {
case 1 : machinetype[Signed8] = MChar;
datatype[MChar] = Signed8;
CharMin = Signed8Min;
CharMax = Signed8Max;
break;
case 2 : machinetype[Signed16] = MChar;
datatype[MChar] = Signed16;
CharMin = Signed16Min;
CharMax = Signed16Max;
break;
}
// short int
switch (sizeof( short int ) ) {
case 1 : machinetype[Signed8] = MShort;
datatype[MShort] = Signed8;
ShortMin = Signed8Min;
ShortMax = Signed8Max;
break;
case 2 : machinetype[Signed16] = MShort;
datatype[MShort] = Signed16;
ShortMin = Signed16Min;
ShortMax = Signed16Max;
break;
case 4 : machinetype[Signed32] = MShort;
datatype[MShort] = Signed32;
ShortMin = Signed32Min;
ShortMax = Signed32Max;
break;
}
// int
switch (sizeof( int ) ) {
case 1 : machinetype[Signed8] = MInteger;
datatype[MInteger] = Signed8;
IntMin = Signed8Min;
IntMax = Signed8Max;
break;
case 2 : machinetype[Signed16] = MInteger;
datatype[MInteger] = Signed16;
IntMin = Signed16Min;
IntMax = Signed16Max;
break;
case 4 : machinetype[Signed32] = MInteger;
datatype[MInteger] = Signed32;
IntMin = Signed32Min;
IntMax = Signed32Max;
break;
case 8 : machinetype[Signed64] = MInteger;
datatype[MInteger] = Signed64;
IntMin = Signed64Min;
IntMax = Signed64Max;
break;
}
// long
switch (sizeof( long ) ) {
case 1 : machinetype[Signed8] = MLong;
datatype[MLong] = Signed8;
LongMin = Signed8Min;
LongMax = Signed8Max;
break;
case 2 : machinetype[Signed16] = MLong;
datatype[MLong] = Signed16;
LongMin = Signed16Min;
LongMax = Signed16Max;
break;
case 4 : machinetype[Signed32] = MLong;
datatype[MLong] = Signed32;
LongMin = Signed32Min;
LongMax = Signed32Max;
break;
case 8 : machinetype[Signed64] = MLong;
datatype[MLong] = Signed64;
LongMin = Signed64Min;
LongMax = Signed64Max;
break;
}
// float
switch (sizeof( float ) ) {
case 4 : machinetype[FloatIEEE32] = MFloat;
datatype[MFloat] = FloatIEEE32;
break;
case 8 : machinetype[DoubleIEEE64] = MFloat;
datatype[MFloat] = DoubleIEEE64;
break;
}
// double
switch (sizeof( double ) ) {
case 4 : machinetype[FloatIEEE32] = MDouble;
datatype[MDouble] = FloatIEEE32;
break;
case 8 : machinetype[DoubleIEEE64] = MDouble;
datatype[MDouble] = DoubleIEEE64;
break;
}
MachineTypeInit = 1;
} /* initmachinetype */
/*---------------------------------------------------------------------------
NAME
edf_datatype2machinetype --- returns the machine data type of a data type
SYNOPSIS
int edf_datatype2machinetype ( int dtype )
---------------------------------------------------------------------------*/
int edf_datatype2machinetype ( int dtype )
{ if (!MachineTypeInit) initmachinetypes();
if ((dtype<0)||(dtype>=EndDType)) dtype = InValidDType;
return( MachineType[dtype] );
} /* edf_datatype2machinetype */
/*---------------------------------------------------------------------------
NAME
edf_machinetype2datatype --- returns the data type of a machine type
SYNOPSIS
int edf_machinetype2datatype ( int mtype )
---------------------------------------------------------------------------*/
int edf_machinetype2datatype ( int mtype )
{ if (!MachineTypeInit) initmachinetypes();
if ((mtype<0)||(mtype>=EndMType)) mtype = InValidMType;
return( DataType[mtype] );
} /* edf_machinetype2datatype */
/*---------------------------------------------------------------------------
NAME
edf_showdatatypes
SYNOPSIS
void edf_showdatatypes ( int full )
DESCRIPTION
Shows data types and the corresponding machine data types.
If full is 0 only data types are shown that can be converted.
---------------------------------------------------------------------------*/
void edf_showdatatypes ( int full )
{ int i;
if (full)
printf(" %15s = %15s\n", "DataType", "MachineType");
for (i=1; i<EndDType; i++) {
if ( (full) || (edf_datatype2machinetype(i)) ) {
printf(" %15s (%5lu bytes) = %15s (%5lu bytes)\n",
edf_datatype2string(i), edf_data_sizeof(i),
MachineType2String(edf_datatype2machinetype(i)),
edf_machine_sizeof(edf_datatype2machinetype(i)) );
}
}
} /* edf_showdatatypes */
/*---------------------------------------------------------------------------
NAME
edf_showmachinetypes
SYNOPSIS
void edf_showmachinetypes ( int full )
DESCRIPTION
Shows machine data types and the corresponding data types.
If full is 0 only machine types are shown that can be converted
---------------------------------------------------------------------------*/
void edf_showmachinetypes ( int full )
{ int i;
if (full)
printf(" %15s = %15s\n", "MachineType", "DataType");
for (i=1; i<EndMType; i++) {
if ( (full) || (edf_machinetype2datatype(i)) ) {
printf(" %15s (%5lu bytes) = %15s (%5lu bytes)\n",
MachineType2String(i), edf_machine_sizeof(i),
edf_datatype2string(edf_machinetype2datatype(i)),
edf_data_sizeof(edf_machinetype2datatype(i)) );
}
}
} /* edf_showmachinetypes */
/*===machinetype END=======================================================*/
/*===data_conversion BEGIN===============================================---*/
//add UOFF and clip at 0 and UMAX (signed in, unsigned out)
# define ACLIP_S2U( X, UOFF, UMAX) (( UOFF)<-( X))?0UL:((( UMAX)-( UOFF))<( X))?( UMAX):( ( UOFF) + ( X))
//subtract UOFF and clip at 0 and UMAX (signed in, unsigned out)
# define SCLIP_S2U( X, UOFF, UMAX) ((UOFF)>( X))?0UL:(( UMAX)<( ( X) - ( UOFF)))?( UMAX):( ( X) - ( UOFF) )
//add UOFF and clip at 0 and UMAX (unsigned in, unsigned out)
# define ACLIP_U2U( UX, UOFF, UMAX) ((UMAX)-( UOFF))<( UX)?( UMAX):( ( UOFF) + ( UX) )
//subtract UOFF and clip at 0 and UMAX (unsigned in, unsigned out)
# define SCLIP_U2U( UX, UOFF, UMAX) (( UOFF)>( UX))?0UL:(( UMAX)<(( UX)-( UOFF)))?UMAX:(( UX)-( UOFF))
//clip at MIN and MAX (float in)
# define CLIP_FLOAT(X, MIN, MAX) (( X)<( MIN))?( MIN):( (( X)>( MAX))?( MAX):( X) )
/*---------------------------------------------------------------------------
NAME
Convert2UnsignedShort
SYNOPSIS
DType DataTypeIn;
int Convert2UnsignedShort( unsigned short * Out,
const void * In, long ValueOffset,
int MachineTypeIn, unsigned long DataCount);
DESCRIPTION
Conversion of MachineTypeIn array In to unsigned short (MUnsignedShort)
array Out. The input data buffer In with elements of the type
MachineTypeIn is copied to the output data buffer Out with elements
of the type unsigned short. Both buffers contain DataCount elements.
The allocated memory for the output buffer must be sufficiently large.
If the required memory for the output buffer is smaller or equal to the
input buffer, the same buffer can be used for input and output.
RETURN VALUE
success: 0
error: -1
AUTHOR
Peter Boesecke
HISTORY
2001-09-02 PB from Convert2Float
--------------------------------------------------------------------------*/
int Convert2UnsignedShort( unsigned short * Out,
const void * In, long ValueOffset,
int MachineTypeIn, unsigned long DataCount)
{ register unsigned long i;
const unsigned char * pinuchar;
const char * pinchar;
const unsigned short * pinushort;
const short * pinshort;
const unsigned int * pinuint;
const int * pinint;
const unsigned long * pinulong;
const long * pinlong;
const float * pinfloat;
const double * pindouble;
unsigned short * pout;
long dvo = ValueOffset;
unsigned long advo = (ValueOffset<0)?-ValueOffset:ValueOffset;
double tmp;
size_t t_in, t_out = edf_machine_sizeof ( MUnsignedShort );
if (EDFIO_debug) {
printf("Convert2UnsignedShort\n");
} // EDFIO_debug
switch ( MachineTypeIn ) {
// conversion to long, add dvo, conversion to unsigned short
case MUnsignedChar : t_in = edf_machine_sizeof( MUnsignedChar );
if (t_in<t_out) {
pinuchar = (unsigned char *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pinuchar;
if (dvo<0)
*(--pout) = SCLIP_U2U(*pinuchar,advo,UShortMax);
else
*(--pout) = ACLIP_U2U(*pinuchar,advo,UShortMax);
}
} else {
pinuchar = (unsigned char *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
if (dvo<0)
*pout = SCLIP_U2U(*pinuchar,advo,UShortMax);
else
*pout = ACLIP_U2U(*pinuchar,advo,UShortMax);
pout++; pinuchar++;
}
}
break;
case MChar : t_in = edf_machine_sizeof( MChar );
if (t_in<t_out) {
pinchar = (char *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pinchar;--pout;
if (dvo<0)
*pout = SCLIP_S2U(*pinchar,advo,UShortMax);
else
*pout = ACLIP_S2U(*pinchar,advo,UShortMax);
}
} else {
pinchar = (char *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
if (dvo<0)
*pout = SCLIP_S2U(*pinchar,advo,UShortMax);
else
*pout = ACLIP_S2U(*pinchar,advo,UShortMax);
pout++; pinchar++;
}
}
break;
case MUnsignedShort: t_in = edf_machine_sizeof( MUnsignedShort );
if ((In!=Out)||(ValueOffset!=0)) {
pinushort = (unsigned short *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pinushort;
if (dvo<0)
*(--pout) = SCLIP_U2U(*pinushort,advo,UShortMax);
else
*(--pout) = ACLIP_U2U(*pinushort,advo,UShortMax);
}
}
break;
case MShort : t_in = edf_machine_sizeof( MShort );
if (t_in<t_out) {
pinshort = (short *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pinshort;
if (dvo<0)
*(--pout) = SCLIP_S2U(*pinshort,advo,UShortMax);
else
*(--pout) = ACLIP_S2U(*pinshort,advo,UShortMax);
}
} else {
pinshort = (short *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
if (dvo<0)
*pout = SCLIP_S2U(*pinshort,advo,UShortMax);
else
*pout = ACLIP_S2U(*pinshort,advo,UShortMax);
pout++; pinshort++;
}
}
break;
case MUnsignedInteger: t_in = edf_machine_sizeof( MUnsignedInteger );
if (t_in<t_out) {
pinuint = (unsigned int *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pinuint; --pout;
if (dvo<0)
*pout = SCLIP_U2U(*pinuint,advo,UShortMax);
else
*pout = ACLIP_U2U(*pinuint,advo,UShortMax);
}
} else {
pinuint = (unsigned int *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
if (dvo<0)
*pout = SCLIP_U2U(*pinuint,advo,UShortMax);
else
*pout = ACLIP_U2U(*pinuint,advo,UShortMax);
pout++; pinuint++;
}
}
break;
case MInteger : t_in = edf_machine_sizeof( MInteger );
if (t_in<t_out) {
pinint = (int *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pinint;--pout;
if (dvo<0)
*pout = SCLIP_S2U(*pinint,advo,UShortMax);
else
*pout = ACLIP_S2U(*pinint,advo,UShortMax);
}
} else {
pinint = (int *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
if (dvo<0)
*pout = SCLIP_S2U(*pinint,advo,UShortMax);
else
*pout = ACLIP_S2U(*pinint,advo,UShortMax);
pout++; pinint++;
}
}
break;
case MUnsignedLong: t_in = edf_machine_sizeof( MUnsignedLong );
if (t_in<t_out) {
pinulong = (unsigned long *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pinulong; --pout;
if (dvo<0)
*pout = SCLIP_U2U(*pinulong,advo,UShortMax);
else
*pout = ACLIP_U2U(*pinulong,advo,UShortMax);
}
} else {
pinulong = (unsigned long *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
if (dvo<0)
*pout = SCLIP_U2U(*pinulong,advo,UShortMax);
else
*pout = ACLIP_U2U(*pinulong,advo,UShortMax);
pout++; pinulong++;
}
}
break;
case MLong : t_in = edf_machine_sizeof( MLong );
if (t_in<t_out) {
pinlong = (long *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pinlong; --pout;
if (dvo<0)
*pout = SCLIP_S2U(*pinlong,advo,UShortMax);
else
*pout = ACLIP_S2U(*pinlong,advo,UShortMax);
}
} else {
pinlong = (long *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
if (dvo<0)
*pout = SCLIP_S2U(*pinlong,advo,UShortMax);
else
*pout = ACLIP_S2U(*pinlong,advo,UShortMax);
pout++; pinlong++;
}
}
break;
case MFloat: t_in = edf_machine_sizeof( MFloat );
if (t_in<t_out) {
pinfloat = (float *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) { // round
pout--; --pinfloat;
tmp = floor( *pinfloat + 0.5 + dvo );
*pout = (short) CLIP_FLOAT(tmp, UShortMin, UShortMax);
}
} else {
pinfloat = (float *) In;
pout = Out;
for (i=0;i<DataCount;i++) { // round
tmp = floor( *pinfloat + 0.5 + dvo );
*pout = (short) CLIP_FLOAT(tmp, UShortMin, UShortMax);
pout++; pinfloat++;
}
}
break;
case MDouble : t_in = edf_machine_sizeof( MDouble );
if (t_in<t_out) {
pindouble = (double *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pindouble;
tmp = floor( *pindouble + 0.5 + dvo );
*pout = (short) CLIP_FLOAT(tmp, UShortMin, UShortMax);
}
} else {
pindouble = (double *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
tmp = floor( *pindouble + 0.5 + dvo );
*pout = (short) CLIP_FLOAT(tmp, UShortMin, UShortMax);
pout++; pindouble++;
}
}
break;
default : return(-1);
break;
} /* switch */
return(0);
} /* Convert2UnsignedShort */
/*---------------------------------------------------------------------------
NAME
Convert2Short
SYNOPSIS
DType DataTypeIn;
int Convert2Short( short * Out,
const void * In, long ValueOffset,
int MachineTypeIn, unsigned long DataCount);
DESCRIPTION
Conversion of MachineTypeIn array In to signed integer (MInteger)
array Out. The input data buffer In with elements of the type
MachineTypeIn is copied to the output data buffer Out with elements
of the type signed integer. Both buffers contain DataCount elements.
The allocated memory for the output buffer must be sufficiently large.
If the required memory for the output buffer is smaller or equal to the
input buffer, the same buffer can be used for input and output.
RETURN VALUE
success: 0
error: -1
AUTHOR
Peter Boesecke
HISTORY
2011-09-01 PB from Convert2Long
--------------------------------------------------------------------------*/
int Convert2Short( short * Out, const void * In, long ValueOffset,
int MachineTypeIn, unsigned long DataCount)
{ register unsigned long i;
const unsigned char * pinuchar;
const char * pinchar;
const unsigned short * pinushort;
const short * pinshort;
const unsigned int * pinuint;
const int * pinint;
const unsigned long * pinulong;
const long * pinlong;
const float * pinfloat;
const double * pindouble;
short * pout;
short dvo = (short) ValueOffset;
double tmp;
size_t t_in, t_out = edf_machine_sizeof ( MShort );
if (EDFIO_debug) {
printf("Convert2Short\n");
} // EDFIO_debug
switch ( MachineTypeIn ) {
case MUnsignedChar : t_in = edf_machine_sizeof( MUnsignedChar );
if (t_in<t_out) {
pinuchar = (unsigned char *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinuchar;
*pout = dvo + (short) *pinuchar;
}
} else {
pinuchar = (unsigned char *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (short) *pinuchar;
pout++; pinuchar++;
}
}
break;
case MChar : t_in = edf_machine_sizeof( MChar );
if (t_in<t_out) {
pinchar = (char *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinchar;
*pout = dvo + (short) *pinchar;
}
} else {
pinchar = (char *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (short) *pinchar;
pout++; pinchar++;
}
}
break;
case MUnsignedShort: t_in = edf_machine_sizeof( MUnsignedShort );
if (t_in<t_out) {
pinushort = (unsigned short *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinushort;
*pout = dvo + (short) *pinushort;
}
} else {
pinushort = (unsigned short *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (short) *pinushort;
pout++; pinushort++;
}
}
break;
case MShort: t_in = edf_machine_sizeof( MShort );
if ((In!=Out)||(ValueOffset!=0)) {
pinshort = (short *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinshort;
*pout = dvo + (short) *pinshort;
}
}
break;
case MUnsignedInteger: t_in = edf_machine_sizeof( MUnsignedInteger );
if (t_in<t_out) {
pinuint = (unsigned int *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinuint;
*pout = dvo + (short) *pinuint;
}
} else {
pinuint = (unsigned int *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (short) *pinuint;
pout++; pinuint++;
}
}
break;
case MInteger : t_in = edf_machine_sizeof( MInteger );
if (t_in<t_out) {
pinint = (int *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinint;
*pout = dvo + (short) *pinint;
}
} else {
pinint = (int *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (short) *pinint;
pout++; pinint++;
}
}
break;
case MUnsignedLong: t_in = edf_machine_sizeof( MUnsignedLong );
if (t_in<t_out) {
pinulong = (unsigned long *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinulong;
*pout = dvo + (short) *pinulong;
}
} else {
pinulong = (unsigned long *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (short) *pinulong;
pout++; pinulong++;
}
}
break;
case MLong : t_in = edf_machine_sizeof( MLong );
if (t_in<t_out) {
pinlong = (long *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinlong;
*pout = dvo + (short) *pinlong;
}
} else {
pinlong = (long *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (short) *pinlong;
pout++; pinlong++;
}
}
break;
case MFloat: t_in = edf_machine_sizeof( MFloat );
if (t_in<t_out) {
pinfloat = (float *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) { // round
pout--; --pinfloat;
tmp = floor( *pinfloat + 0.5 + dvo );
*pout = (short) CLIP_FLOAT(tmp, ShortMin, ShortMax);
}
} else {
pinfloat = (float *) In;
pout = Out;
for (i=0;i<DataCount;i++) { // round
tmp = floor( *pinfloat + 0.5 + dvo );
*pout = (short) CLIP_FLOAT(tmp, ShortMin, ShortMax);
pout++; pinfloat++;
}
}
break;
case MDouble : t_in = edf_machine_sizeof( MDouble );
if (t_in<t_out) {
pindouble = (double *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pindouble;
tmp = floor( *pindouble + 0.5 + dvo );
*pout = (short) CLIP_FLOAT(tmp, ShortMin, ShortMax);
}
} else {
pindouble = (double *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
tmp = floor( *pindouble + 0.5 + dvo );
*pout = (short) CLIP_FLOAT(tmp, ShortMin, ShortMax);
pout++; pindouble++;
}
}
break;
default : return(-1);
break;
} /* switch */
return(0);
} /* Convert2Short */
/*---------------------------------------------------------------------------
NAME
Convert2Integer
SYNOPSIS
DType DataTypeIn;
int Convert2Integer( int * Out,
const void * In, long ValueOffset,
int MachineTypeIn, unsigned long DataCount);
DESCRIPTION
Conversion of MachineTypeIn array In to signed integer (MInteger)
array Out. The input data buffer In with elements of the type
MachineTypeIn is copied to the output data buffer Out with elements
of the type signed integer. Both buffers contain DataCount elements.
The allocated memory for the output buffer must be sufficiently large.
If the required memory for the output buffer is smaller or equal to the
input buffer, the same buffer can be used for input and output.
RETURN VALUE
success: 0
error: -1
AUTHOR
Peter Boesecke
HISTORY
2011-09-01 PB from Convert2Long
--------------------------------------------------------------------------*/
int Convert2Integer( int * Out, const void * In, long ValueOffset,
int MachineTypeIn, unsigned long DataCount)
{ register unsigned long i;
const unsigned char * pinuchar;
const char * pinchar;
const unsigned short * pinushort;
const short * pinshort;
const unsigned int * pinuint;
const int * pinint;
const unsigned long * pinulong;
const long * pinlong;
const float * pinfloat;
const double * pindouble;
int * pout;
int dvo = (int) ValueOffset;
double tmp;
size_t t_in, t_out = edf_machine_sizeof ( MInteger );
if (EDFIO_debug) {
printf("Convert2Integer\n");
} // EDFIO_debug
switch ( MachineTypeIn ) {
case MUnsignedChar : t_in = edf_machine_sizeof( MUnsignedChar );
if (t_in<t_out) {
pinuchar = (unsigned char *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinuchar;
*pout = dvo + (int) *pinuchar;
}
} else {
pinuchar = (unsigned char *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (int) *pinuchar;
pout++; pinuchar++;
}
}
break;
case MChar : t_in = edf_machine_sizeof( MChar );
if (t_in<t_out) {
pinchar = (char *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinchar;
*pout = dvo + (int) *pinchar;
}
} else {
pinchar = (char *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (int) *pinchar;
pout++; pinchar++;
}
}
break;
case MUnsignedShort: t_in = edf_machine_sizeof( MUnsignedShort );
if (t_in<t_out) {
pinushort = (unsigned short *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinushort;
*pout = dvo + (int) *pinushort;
}
} else {
pinushort = (unsigned short *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (int) *pinushort;
pout++; pinushort++;
}
}
break;
case MShort : t_in = edf_machine_sizeof( MShort );
if (t_in<t_out) {
pinshort = (short *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinshort;
*pout = dvo + (int) *pinshort;
}
} else {
pinshort = (short *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (int) *pinshort;
pout++; pinshort++;
}
}
break;
case MUnsignedInteger: t_in = edf_machine_sizeof( MUnsignedInteger );
if (t_in<t_out) {
pinuint = (unsigned int *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinuint;
*pout = dvo + (int) *pinuint;
}
} else {
pinuint = (unsigned int *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (int) *pinuint;
pout++; pinuint++;
}
}
break;
case MInteger: t_in = edf_machine_sizeof( MInteger );
if ((In!=Out)||(ValueOffset!=0)) {
pinint = (int *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinint;
*pout = dvo + (int) *pinint;
}
}
break;
case MUnsignedLong: t_in = edf_machine_sizeof( MUnsignedLong );
if (t_in<t_out) {
pinulong = (unsigned long *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinulong;
*pout = dvo + (int) *pinulong;
}
} else {
pinulong = (unsigned long *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (int) *pinulong;
pout++; pinulong++;
}
}
break;
case MLong : t_in = edf_machine_sizeof( MLong );
if (t_in<t_out) {
pinlong = (long *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinlong;
*pout = dvo + (int) *pinlong;
}
} else {
pinlong = (long *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (int) *pinlong;
pout++; pinlong++;
}
}
break;
case MFloat: t_in = edf_machine_sizeof( MFloat );
if (t_in<t_out) {
pinfloat = (float *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) { // round
pout--; --pinfloat;
tmp = floor( *pinfloat + 0.5 + dvo );
*pout = (int) CLIP_FLOAT(tmp, IntMin, IntMax);
}
} else {
pinfloat = (float *) In;
pout = Out;
for (i=0;i<DataCount;i++) { // round
tmp = floor( *pinfloat + 0.5 + dvo );
*pout = (int) CLIP_FLOAT(tmp, IntMin, IntMax);
pout++; pinfloat++;
}
}
break;
case MDouble : t_in = edf_machine_sizeof( MDouble );
if (t_in<t_out) {
pindouble = (double *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pindouble;
tmp = floor( *pindouble + 0.5 + dvo );
*pout = (int) CLIP_FLOAT(tmp, IntMin, IntMax);
}
} else {
pindouble = (double *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
tmp = floor( *pindouble + 0.5 + dvo );
*pout = (int) CLIP_FLOAT(tmp, IntMin, IntMax);
pout++; pindouble++;
}
}
break;
default : return(-1);
break;
} /* switch */
return(0);
} /* Convert2Integer */
/*---------------------------------------------------------------------------
NAME
Convert2Long
SYNOPSIS
DType DataTypeIn;
int Convert2Long( long * Out,
const void * In, long ValueOffset,
int MachineTypeIn, unsigned long DataCount);
DESCRIPTION
Conversion of MachineTypeIn array In to signed long (MLong)
array Out. The input data buffer In with elements of the type
MachineTypeIn is copied to the output data buffer Out with elements
of the type signed long. Both buffers contain DataCount elements.
The allocated memory for the output buffer must be sufficiently large.
If the required memory for the output buffer is smaller or equal to the
input buffer, the same buffer can be used for input and output.
RETURN VALUE
success: 0
error: -1
AUTHOR
Peter Boesecke
HISTORY
2011-09-01 PB from Convert2Float
--------------------------------------------------------------------------*/
int Convert2Long( long * Out, const void * In, long ValueOffset,
int MachineTypeIn, unsigned long DataCount)
{ register unsigned long i;
const unsigned char * pinuchar;
const char * pinchar;
const unsigned short * pinushort;
const short * pinshort;
const unsigned int * pinuint;
const int * pinint;
const unsigned long * pinulong;
const long * pinlong;
const float * pinfloat;
const double * pindouble;
long * pout;
long dvo = ValueOffset;
double tmp;
size_t t_in, t_out = edf_machine_sizeof ( MLong );
if (EDFIO_debug) {
printf("Convert2Long\n");
} // EDFIO_debug
switch ( MachineTypeIn ) {
case MUnsignedChar : t_in = edf_machine_sizeof( MUnsignedChar );
if (t_in<t_out) {
pinuchar = (unsigned char *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinuchar;
*pout = dvo + (long) *pinuchar;
}
} else {
pinuchar = (unsigned char *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (long) *pinuchar;
pout++; pinuchar++;
}
}
break;
case MChar : t_in = edf_machine_sizeof( MChar );
if (t_in<t_out) {
pinchar = (char *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinchar;
*pout = dvo + (long) *pinchar;
}
} else {
pinchar = (char *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (long) *pinchar;
pout++; pinchar++;
}
}
break;
case MUnsignedShort: t_in = edf_machine_sizeof( MUnsignedShort );
if (t_in<t_out) {
pinushort = (unsigned short *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinushort;
*pout = dvo + (long) *pinushort;
}
} else {
pinushort = (unsigned short *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (long) *pinushort;
pout++; pinushort++;
}
}
break;
case MShort : t_in = edf_machine_sizeof( MShort );
if (t_in<t_out) {
pinshort = (short *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinshort;
*pout = dvo + (long) *pinshort;
}
} else {
pinshort = (short *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (long) *pinshort;
pout++; pinshort++;
}
}
break;
case MUnsignedInteger: t_in = edf_machine_sizeof( MUnsignedInteger );
if (t_in<t_out) {
pinuint = (unsigned int *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinuint;
*pout = dvo + (long) *pinuint;
}
} else {
pinuint = (unsigned int *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (long) *pinuint;
pout++; pinuint++;
}
}
break;
case MInteger : t_in = edf_machine_sizeof( MInteger );
if (t_in<t_out) {
pinint = (int *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinint;
*pout = dvo + (long) *pinint;
}
} else {
pinint = (int *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (long) *pinint;
pout++; pinint++;
}
}
break;
case MUnsignedLong: t_in = edf_machine_sizeof( MUnsignedLong );
if (t_in<t_out) {
pinulong = (unsigned long *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinulong;
*pout = dvo + (long) *pinulong;
}
} else {
pinulong = (unsigned long *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (long) *pinulong;
pout++; pinulong++;
}
}
break;
case MLong: t_in = edf_machine_sizeof( MLong );
if ((In!=Out)||(ValueOffset!=0)) {
pinlong = (long *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinlong;
*pout = dvo + (long) *pinlong;
}
}
break;
case MFloat: t_in = edf_machine_sizeof( MFloat );
if (t_in<t_out) {
pinfloat = (float *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) { // round
pout--; --pinfloat;
tmp = floor( *pinfloat + 0.5 + dvo );
*pout = (long) CLIP_FLOAT(tmp, LongMin, LongMax);
}
} else {
pinfloat = (float *) In;
pout = Out;
for (i=0;i<DataCount;i++) { // round
tmp = floor( *pinfloat + 0.5 + dvo );
*pout = (long) CLIP_FLOAT(tmp, LongMin, LongMax);
pout++; pinfloat++;
}
}
break;
case MDouble : t_in = edf_machine_sizeof( MDouble );
if (t_in<t_out) {
pindouble = (double *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pindouble;
tmp = floor( *pindouble + 0.5 + dvo );
*pout = (long) CLIP_FLOAT(tmp, LongMin, LongMax);
}
} else {
pindouble = (double *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
tmp = floor( *pindouble + 0.5 + dvo );
*pout = (long) CLIP_FLOAT(tmp, LongMin, LongMax);
pout++; pindouble++;
}
}
break;
default : return(-1);
break;
} /* switch */
return(0);
} /* Convert2Long */
/*---------------------------------------------------------------------------
NAME
Convert2Float
SYNOPSIS
DType DataTypeIn;
int Convert2Float( float * Out,
const void * In, long ValueOffset,
int MachineTypeIn, unsigned long DataCount);
DESCRIPTION
Conversion of MachineTypeIn array In to float (MFloat) array Out.
The input data buffer In with elements of the type MachineTypeIn
is copied to the output data buffer Out with elements of the
type float. Both buffers contain DataCount elements.
The allocated memory for the output buffer must be sufficiently large.
If the required memory for the output buffer is smaller or equal to the
input buffer, the same buffer can be used for input and output.
RETURN VALUE
success: 0
error: -1
AUTHOR
Peter Boesecke 08-Mar-1998
HISTORY
1999-07-23 PB DataValueOffset
1999-11-26 PB t_out initialized with sizeof(float)
2000-04-30 PB name changed to Data2Float, MType for output
2001-09-02 PB name changed to Convert2Float:
DataTypeIn -> MachineTypeIn
DataValueOffset -> ValueOffset
--------------------------------------------------------------------------*/
int Convert2Float( float * Out, const void * In, long ValueOffset,
int MachineTypeIn, unsigned long DataCount)
{ register unsigned long i;
const unsigned char * pinuchar;
const char * pinchar;
const unsigned short * pinushort;
const short * pinshort;
const unsigned int * pinuint;
const int * pinint;
const unsigned long * pinulong;
const long * pinlong;
const float * pinfloat;
const double * pindouble;
float * pout;
float dvo = (float) ValueOffset;
size_t t_in, t_out = edf_machine_sizeof ( MFloat );
if (EDFIO_debug) {
printf("Convert2Float\n");
} // EDFIO_debug
switch ( MachineTypeIn ) {
case MUnsignedChar : t_in = edf_machine_sizeof( MUnsignedChar );
if (t_in<t_out) {
pinuchar = (unsigned char *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinuchar;
*pout = dvo + (float) *pinuchar;
}
} else {
pinuchar = (unsigned char *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (float) *pinuchar;
pout++; pinuchar++;
}
}
break;
case MChar : t_in = edf_machine_sizeof( MChar );
if (t_in<t_out) {
pinchar = (char *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinchar;
*pout = dvo + (float) *pinchar;
}
} else {
pinchar = (char *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (float) *pinchar;
pout++; pinchar++;
}
}
break;
case MUnsignedShort: t_in = edf_machine_sizeof( MUnsignedShort );
if (t_in<t_out) {
pinushort = (unsigned short *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinushort;
*pout = dvo + (float) *pinushort;
}
} else {
pinushort = (unsigned short *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (float) *pinushort;
pout++; pinushort++;
}
}
break;
case MShort : t_in = edf_machine_sizeof( MShort );
if (t_in<t_out) {
pinshort = (short *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinshort;
*pout = dvo + (float) *pinshort;
}
} else {
pinshort = (short *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (float) *pinshort;
pout++; pinshort++;
}
}
break;
case MUnsignedInteger: t_in = edf_machine_sizeof( MUnsignedInteger );
if (t_in<t_out) {
pinuint = (unsigned int *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinuint;
*pout = dvo + (float) *pinuint;
}
} else {
pinuint = (unsigned int *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (float) *pinuint;
pout++; pinuint++;
}
}
break;
case MInteger : t_in = edf_machine_sizeof( MInteger );
if (t_in<t_out) {
pinint = (int *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinint;
*pout = dvo + (float) *pinint;
}
} else {
pinint = (int *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (float) *pinint;
pout++; pinint++;
}
}
break;
case MUnsignedLong: t_in = edf_machine_sizeof( MUnsignedLong );
if (t_in<t_out) {
pinulong = (unsigned long *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinulong;
*pout = dvo + (float) *pinulong;
}
} else {
pinulong = (unsigned long *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (float) *pinulong;
pout++; pinulong++;
}
}
break;
case MLong : t_in = edf_machine_sizeof( MLong );
if (t_in<t_out) {
pinlong = (long *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinlong;
*pout = dvo + (float) *pinlong;
}
} else {
pinlong = (long *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (float) *pinlong;
pout++; pinlong++;
}
}
break;
case MFloat : t_in = edf_machine_sizeof( MFloat );
if ((In!=Out)||(ValueOffset!=0)) {
pinfloat = (float *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i)
*(--pout) = dvo + *(--pinfloat);
}
break;
case MDouble : t_in = edf_machine_sizeof( MDouble );
if (t_in<t_out) {
pindouble = (double *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pindouble;
*pout = dvo + (float) *pindouble;
}
} else {
pindouble = (double *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (float) *pindouble;
pout++; pindouble++;
}
}
break;
default : return(-1);
break;
} /* switch */
return(0);
} /* Convert2Float */
/*---------------------------------------------------------------------------
NAME
Convert2Double
SYNOPSIS
DType DataTypeIn;
int Convert2Double( double * Out,
const void * In, long ValueOffset,
int MachineTypeIn, unsigned long DataCount);
DESCRIPTION
Conversion of MachineTypeIn array In to double (MDouble) array Out.
The input data buffer In with elements of the type MachineTypeIn
is copied to the output data buffer Out with elements of the
type double. Both buffers contain DataCount elements.
The allocated memory for the output buffer must be sufficiently large.
If the required memory for the output buffer is smaller or equal to the
input buffer, the same buffer can be used for input and output.
RETURN VALUE
success: 0
error: -1
HISTORY
2010-07-08 PB from Convert2Float
--------------------------------------------------------------------------*/
int Convert2Double( double * Out, const void * In, long ValueOffset,
int MachineTypeIn, unsigned long DataCount)
{ register unsigned long i;
const unsigned char * pinuchar;
const char * pinchar;
const unsigned short * pinushort;
const short * pinshort;
const unsigned int * pinuint;
const int * pinint;
const unsigned long * pinulong;
const long * pinlong;
const float * pinfloat;
const double * pindouble;
double * pout;
double dvo = (double) ValueOffset;
size_t t_in, t_out = edf_machine_sizeof ( MFloat );
if (EDFIO_debug) {
printf("Convert2Double\n");
} // EDFIO_debug
switch ( MachineTypeIn ) {
case MUnsignedChar : t_in = edf_machine_sizeof( MUnsignedChar );
if (t_in<t_out) {
pinuchar = (unsigned char *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinuchar;
*pout = dvo + (double) *pinuchar;
}
} else {
pinuchar = (unsigned char *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (double) *pinuchar;
pout++; pinuchar++;
}
}
break;
case MChar : t_in = edf_machine_sizeof( MChar );
if (t_in<t_out) {
pinchar = (char *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinchar;
*pout = dvo + (double) *pinchar;
}
} else {
pinchar = (char *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (double) *pinchar;
pout++; pinchar++;
}
}
break;
case MUnsignedShort: t_in = edf_machine_sizeof( MUnsignedShort );
if (t_in<t_out) {
pinushort = (unsigned short *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinushort;
*pout = dvo + (double) *pinushort;
}
} else {
pinushort = (unsigned short *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (double) *pinushort;
pout++; pinushort++;
}
}
break;
case MShort : t_in = edf_machine_sizeof( MShort );
if (t_in<t_out) {
pinshort = (short *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinshort;
*pout = dvo + (double) *pinshort;
}
} else {
pinshort = (short *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (double) *pinshort;
pout++; pinshort++;
}
}
break;
case MUnsignedInteger: t_in = edf_machine_sizeof( MUnsignedInteger );
if (t_in<t_out) {
pinuint = (unsigned int *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinuint;
*pout = dvo + (double) *pinuint;
}
} else {
pinuint = (unsigned int *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (double) *pinuint;
pout++; pinuint++;
}
}
break;
case MInteger : t_in = edf_machine_sizeof( MInteger );
if (t_in<t_out) {
pinint = (int *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinint;
*pout = dvo + (double) *pinint;
}
} else {
pinint = (int *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (double) *pinint;
pout++; pinint++;
}
}
break;
case MUnsignedLong: t_in = edf_machine_sizeof( MUnsignedLong );
if (t_in<t_out) {
pinulong = (unsigned long *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinulong;
*pout = dvo + (double) *pinulong;
}
} else {
pinulong = (unsigned long *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (double) *pinulong;
pout++; pinulong++;
}
}
break;
case MLong : t_in = edf_machine_sizeof( MLong );
if (t_in<t_out) {
pinlong = (long *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinlong;
*pout = dvo + (double) *pinlong;
}
} else {
pinlong = (long *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (double) *pinlong;
pout++; pinlong++;
}
}
break;
case MFloat : t_in = edf_machine_sizeof( MFloat );
if (t_in<t_out) {
pinfloat = (float *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i) {
--pout; --pinfloat;
*pout = dvo + (double) *pinfloat;
}
} else {
pinfloat = (float *) In;
pout = Out;
for (i=0;i<DataCount;i++) {
*pout = dvo + (double) *pinfloat;
pout++; pinfloat++;
}
}
break;
case MDouble : t_in = edf_machine_sizeof( MDouble );
if ((In!=Out)||(ValueOffset!=0)) {
pindouble = (double *) In + DataCount;
pout = Out + DataCount;
for (i=DataCount;i>0;--i)
*(--pout) = dvo + *(--pindouble);
}
break;
default : return(-1);
break;
} /* switch */
return(0);
} /* Convert2Double */
/*---------------------------------------------------------------------------
NAME
edf_machine2machine
SYNOPSIS
MType mtype_src;
MType mtype_dest;
int edf_machine2machine ( void * dest, int mtype_dest,
const void * src, long data_value_offset,
int mtype_src, unsigned long n)
DESCRIPTION
The input data buffer src with element of the type mtype_src
is copied to the output data buffer dest with elements of the
type mtype_dest. Both buffers consists of n elements.
The data types are listed in MType.
The allocated memory for the output buffer must be sufficiently large.
If the required memory for the output buffer is smaller or equal to the
length of the input buffer both buffers can be identical.
RETURN VALUE
success: 0
error: -1
AUTHOR
Peter Boesecke 08-Mar-1998
HISTORY
23-Jul-1999 DataValueOffset (_DataVersion 2.20)
30-Apr-2000 Name changed to edf_data2machine and MachineType introduced.
02-Sep-2001 dtype_src changed to mtype_src,
name changed to edf_machine2machine
--------------------------------------------------------------------------*/
int edf_machine2machine ( void * dest, int mtype_dest,
const void * src, long value_offset,
int mtype_src, unsigned long n)
{ int failed = True;
void *out = dest;
const void *in = src;
if (EDFIO_debug) {
printf("edf_machine2machine\n");
edf_showmachinetypes( True );
printf("Conversion of %s to %s\n",
MachineType2String( mtype_src ),
MachineType2String( mtype_dest ) );
} // EDFIO_debug
if ( (!dest)||(!src) ) {
fprintf(stderr, "SEVERE: edf_machine2machine: NULL pointer\n");
exit(-1);
}
if (!mtype_src) return(-1);
switch ( mtype_dest ) {
case MUnsignedChar : break;
case MChar : break;
case MUnsignedShort : failed = Convert2UnsignedShort(
(unsigned short *) out, in,
value_offset, mtype_src, n );
break;
case MShort : failed = Convert2Short(
(short *) out, in,
value_offset, mtype_src, n );
break;
case MUnsignedInteger: break;
case MInteger : failed = Convert2Integer(
(int *) out, in,
value_offset, mtype_src, n );
break;
case MUnsignedLong : break;
case MLong : failed = Convert2Long(
(long *) out, in,
value_offset, mtype_src, n );
break;
case MFloat : failed = Convert2Float(
(float *) out, in,
value_offset, mtype_src, n );
break;
case MDouble : failed = Convert2Double(
(double *) out, in,
value_offset, mtype_src, n );
break;
default : break;
} /* switch */
if (failed) return(-1);
return(0);
} /* edf_machine2machine */
/*===data_conversion END=================================================---*/
/*===history BEGIN========================================================*/
/*+++ public interface of history -------------------------------------------
DESCRIPTION
The routines of this module are used to read and write history lines.
'edf_history_new' must be called first. It clears and initializes the
internal history list and argument list.
'edf_history_skip' marks the next argument as not required
'edf_history_take' marks the next argument as required (default)
'edf_history_argv' is used to store the arguments of the call in an
internal list. It can be called several times to pass all arguments.
'edf_read_header_history' initializes the history list and reads the
history strings from the file header.
'edf_write_header_history' writes the history strings into the output
file header.
'edf_history_free' releases all internal lists. 'edf_history_new' must
be called before using one of the routines again.
'hist_debug' sets the module into debug mode.
The length of a history line is limited to MaxHistoryLineSize-1.
HISTORY
1999-06-24 V1.0 Peter Boesecke
1999-11-08 V1.1 PB
2001-09-13 PB history_key
2001-09-15 V1.2 PB history_root -> history_line_root
history_root used for HBlock
PUBLIC extern int
edf_history_new ( const char * history_key ),
edf_history_skip ( const char * history_key ),
edf_history_take ( const char * history_key ),
edf_history_argv ( const char * history_key,
const char * substring ),
edf_read_header_history ( int stream, long int DataNumber,
int DataChain, const char * history_key,
int * pErrorValue, int * pstatus ),
edf_write_header_history ( int stream, long int DataNumber,
int DataChain, const char * history_key,
int * pErrorValue, int * pstatus ),
edf_history_read_header ( const char * header_key,
const char * history_key,
int * pErrorValue, int * pstatus ),
edf_history_write_header ( const char * header_key,
const char * history_key,
int * pErrorValue, int * pstatus ),
edf_history_copy ( const char * history_copy,
const char * history_key ),
edf_history_free ( const char * history_key );
PUBLIC extern void
hist_debug ( int debug );
---------------------------------- end of public interface of history ---*/
/****************************************************************************
* Constants *
****************************************************************************/
//# define MaxHistoryLineSize (MaxLinLen+1) no restriction 2005-02-27
# define MaxHistoryLineSize (2048+1)
# define MaxHistoryKeySize (MaxKeyLen+1)
# define HistoryKeyBufferSize 1024
/****************************************************************************
* Static Variables *
****************************************************************************/
static int HIST_debug = 0;
static int InitHistory = 0;
static HBlock * history_root = (HBlock *) NULL;
static const char * argv_key = "_argv_key" ;
static const char * default_history_line_key = HISTORY_KEY_PREFIX"1" ;
/*---------------------------------------------------------------------------
NAME
needquotes
SYNOPSIS
int needquotes( const char * string );
DESCRIPTION
Tests, whether the string must be encapsulated between double quotes.
Conditions:
string starts with '\"' -> return value 0
string contains white spaces or characters that must be quoted
-> return value >0 , otherwise 0
string has zero length -> return value 1
RETURN VALUES
Returns a positive number when the string must be encapsulated, otherwise 0
---------------------------------------------------------------------------*/
int needquotes( const char * string )
{ int encapsulation = 0;
const char * ps = string;
if (string[0]!='\"') {
while ( (*ps) && (!(encapsulation)) ) {
encapsulation = is_white(*ps) + is_tobequoted ( *ps );
ps++;
}
} else encapsulation = 0;
if ( strlen(string)==0 ) encapsulation = 1;
return ( encapsulation );
} /* needquotes */
/*--------------------------------------------------------------------------
NAME
hist_debug --- set / reset module history into debug mode
SYNOPSIS
void hist_debug ( int debug );
DESCRPTION
Writes debug into HIST_debug.
-----------------------------------------------------------------------------*/
void hist_debug ( int debug )
{ HIST_debug = debug;
} /* hist_debug */
/*---------------------------------------------------------------------------
print_history_list (success:0, error:-1)
---------------------------------------------------------------------------*/
int print_history_list( FILE * out, int level, int verbose, HSymb * root )
{ const char * SeparationLine =
"- - - - - - - -";
HSymb * hline = root;
if (level<1) return(0);
while (hline!=(HSymb*) NULL) {
if (verbose) {
fprintf(out," %s\n",SeparationLine);
fprintf(out," key = %s\n",hline->key);
fprintf(out," line = %s\n",hline->line);
// fprintf(out," size = %zu\n",hline->size);
fprintf(out," size = %zu | %lu\n",
hline->size,hline->size);
fprintf(out," required = %d\n",hline->required);
// fprintf(out," shortlen = %zu\n",hline->shortlen);
fprintf(out," shortlen = %zu | %lu\n",
hline->shortlen, hline->shortlen);
fprintf(out," Previous key = ");
if ((hline->Previous)!=(HSymb*) NULL)
fprintf(out,"%s\n", hline->Previous->key);
else fprintf(out,"(no previous history line)\n");
fprintf(out," Next key = ");
if ((hline->Next)!=(HSymb*) NULL)
fprintf(out,"%s\n", hline->Next->key);
else fprintf(out,"(no next history line)\n");
} else {
fprintf(out," '%s' = '%s'\n",hline->key,hline->line);
}
hline=hline->Next;
}
if (verbose) fprintf(out," %s\n",SeparationLine);
return(0);
} /* print_history_list */
/*---------------------------------------------------------------------------
NAME
init_history
SYNOPSIS
int init_history( void )
DESCRIPTION
Inits history module
RETURN VALUES
Returns 0 in case of success and -1 if no success.
---------------------------------------------------------------------------*/
int init_history( void )
{ history_root = (HBlock *) NULL;
InitHistory = 1;
return(0);
} /* init_history */
/*---------------------------------------------------------------------------
NAME
copy_history_list
SYNOPSIS
int copy_history_list(HSymb **proot, HSymb *src);
DESCRIPTION
Copies all history lines from src to *proot
RETURN VALUES
In case of success the return value is 0, otherwise -1.
---------------------------------------------------------------------------*/
int copy_history_list(HSymb **proot, HSymb *src)
{ HSymb * hline;
while (src!=(HSymb*) NULL) {
if (history_line_new ( proot, src->key, src->size, &hline )) return(-1);
hline->line = strncpy(hline->line,src->line,src->size);
hline->required = src->required;
hline->shortlen = src->shortlen;
src=src->Next;
}
return(0);
} /* copy_history_list */
/*---------------------------------------------------------------------------
NAME
history_free
SYNOPSIS
DESCRIPTION
Removes all history lines.
RETURN VALUES
In case of success the return value is 0, otherwise -1.
---------------------------------------------------------------------------*/
int history_free ( HSymb **proot )
{ HSymb * hline, * next;
next = *proot;
while (next) {
hline = next;
next = hline->Next;
if (hline->key) free(hline->key);
if (hline->line) free(hline->line);
if (hline) free(hline);
}
*proot = (HSymb *) NULL;
return(0);
} /* history_free */
/*+++------------------------------------------------------------------------
NAME
clear_header_history
SYNOPSIS
int clear_header_history ( HBlock * hblock )
DESCRIPTION
Releases all allocated history lines of hblock
RETURN VALUES
In case of success the return value is 0, otherwise -1.
---------------------------------------------------------------------------*/
int clear_header_history ( HBlock * hblock ) /*---*/
{
if (!InitHistory) return(-1);
if (history_free( &hblock->history_line_root ) ) return(-1);
if (hblock->current_history_line_key ) {
free( hblock->current_history_line_key );
hblock->current_history_line_key = (char *) NULL;
}
return(0);
} /* clear_header_history */
/*+++------------------------------------------------------------------------
NAME
insert_history_block
SYNOPSIS
int insert_history_block( const char * history_key, HBlock **hblock );
DESCRIPTION
Searches for a history block with history_key and clears it or inserts
an empty history block with history_key. The pointer to the history
block is returned in *hblock.
RETURN VALUES
In case of success the return value is 0, otherwise -1.
---------------------------------------------------------------------------*/
int insert_history_block( const char * history_key, HBlock **hblock ) /*---*/
{
HBlock * newhblock, * previous, * next;
int notfound = 1;
/* search for history_key */
*hblock = (HBlock *) NULL;
previous = (HBlock *) NULL;
next = history_root;
/* search insertion point (insertion before next) */
while( ( next!=(HBlock *) NULL ) && (notfound>0) ) {
notfound = compare_keys(next->key,history_key,UpperCaseSort);
if (notfound>0) {previous = next; next = next->Next;}
}
if (notfound) {
/* create new hblock */
if (!(newhblock = (HBlock *) malloc(sizeof(HBlock)))) return(-1);
newhblock->key = newstr(history_key);
if (!newhblock->key) {free(newhblock);return(-1);}
newhblock->history_argv_root = (HSymb *) NULL;
newhblock->history_line_root = (HSymb *) NULL;
newhblock->current_history_line_key = (char *) NULL;
/* insert newhblock before next */
if (next) next->Previous = newhblock;
newhblock->Next=next;
newhblock->Previous=previous;
if (previous) previous->Next=newhblock;
else history_root = newhblock;
next = newhblock;
}
/* clear block (next) */
if (history_free( &next->history_argv_root )) return(-1);
if (clear_header_history( next )) return(-1);
*hblock = next;
return(0);
} /* insert_history_block */
/*+++------------------------------------------------------------------------
NAME
copy_history_block
SYNOPSIS
int copy_history_block( const char * history_key, HBlock **hblock,
HBlock *src )
DESCRIPTION
Searches for a history block with history_key and clears it or inserts
an empty history block with history_key. The contents of src is copied
into this block. The pointer to the history block is returned in *hblock.
RETURN VALUES
In case of success the return value is 0, otherwise -1.
---------------------------------------------------------------------------*/
int copy_history_block( const char * history_key, HBlock **hblock,
HBlock *src ) /*---*/
{ HBlock * dest;
if (insert_history_block( history_key, hblock )) return(-1);
// already done if src is identical to *hblock
if (src == *hblock) return(0);
// copy src to *hbloc
dest = *hblock;
if (copy_history_list(&(dest->history_line_root),src->history_line_root))
return(-1);
if (copy_history_list(&(dest->history_argv_root),src->history_argv_root))
return(-1);
if (!(dest->current_history_line_key=newstr(src->current_history_line_key)))
return(-1);
return(0);
} /* copy_history_block */
/*+++------------------------------------------------------------------------
NAME
search_history_block
SYNOPSIS
int search_history_block( const char * history_key, HBlock ** hblock );
DESCRIPTION
Searches for history block history_key and returns it in *hblock
RETURN VALUES
In case of success the return value is 0, otherwise -1.
---------------------------------------------------------------------------*/
int search_history_block( const char * history_key, HBlock ** hblock )
{ HBlock * previous, * next;
int notfound = 1;
/* search for history_key */
*hblock = (HBlock *) NULL;
previous = (HBlock *) NULL;
next = history_root;
/* search history_key */
while( ( next!=(HBlock *) NULL ) && (notfound) ) {
notfound = compare_keys(next->key,history_key,UpperCaseSort);
if (notfound) {previous = next; next = next->Next;}
}
*hblock = next;
if (*hblock==(HBlock *) NULL) return(-1); else return(0);
} /* search_history_block */
/*+++------------------------------------------------------------------------
NAME
remove_history_block
SYNOPSIS
int remove_history_block( HBlock * hblock );
DESCRIPTION
Removes history block hblock from history_root and releases its contents
RETURN VALUES
In case of success the return value is 0, otherwise -1.
---------------------------------------------------------------------------*/
int remove_history_block( HBlock * hblock )
{ HBlock * previous, *next;
/* stop, if no symbol found */
if (hblock==(HBlock *) NULL) return(-1);
/* change links */
previous = hblock->Previous;
next = hblock->Next;
if ( next != (HBlock *) NULL ) next->Previous = previous;
if ( previous != (HBlock *) NULL ) previous->Next = next;
else history_root = next;
/* free history block and its elements */
if (history_free( &hblock->history_argv_root ) ) return(-1);
if (clear_header_history ( hblock ) ) return(-1);
if (hblock->key) free(hblock->key);
free(hblock);
return(0);
} /* remove_history_block */
/*---------------------------------------------------------------------------
NAME
history_line_new
SYNOPSIS
int history_line_new ( HSymb ** proot,
const char * history_line_key, size_t history_size,
HSymb ** phline )
DESCRIPTION
Adds a new history line with the key 'history_line_key' to the list and
allocates 'history_size' bytes for the line. If the key already exists, only
the line is cleared and reallocated with 'history_size' bytes. The key list is
ordered in reverse alphabetical order. If phline is not NULL a pointer to the
history line is returned.
RETURN VALUES
Returns 0 in case of success and -1 if no success.
---------------------------------------------------------------------------*/
PRIVATE int history_line_new ( HSymb ** proot,
const char * history_line_key, size_t history_size,
HSymb ** phline )
{
HSymb * newhline, * previous, * next;
// HSymb * hline; // unused
int notfound = 1;
/* search for history_line_key */
if (phline!=(HSymb **)NULL) *phline = (HSymb *) NULL;
previous = (HSymb *) NULL;
next = *proot;
/* search insertion point (insertion before next) */
while( ( next!=(HSymb *) NULL ) && (notfound>0) ) {
notfound = compare_keys(next->key,history_line_key,UpperCaseSort);
if (notfound>0) {previous = next; next = next->Next;}
}
if (notfound) {
/* create new hline */
if (!(newhline = (HSymb *) malloc(sizeof(HSymb)))) return(-1);
newhline->key = newstr(history_line_key);
if (!newhline->key) {free(newhline); return(-1);}
newhline->line = (char *) NULL;
newhline->size = (size_t) 0;
newhline->required = 1;
newhline->shortlen = 0;
/* insert newhline before next */
if (next) next->Previous = newhline;
newhline->Next=next;
newhline->Previous=previous;
if (previous) previous->Next=newhline;
else *proot = newhline;
next = newhline;
}
/* update next->line */
if (phline!=(HSymb **)NULL) *phline = next;
if ( next->line ) {
free ( next->line );
next->line = (char *) NULL;
next->size = (size_t) 0;
next->required = 1;
next->shortlen = 0;
}
if (history_size<1) return(-1);
if (!(next->line = (char *) malloc(history_size))) return(-1);
next->line[0] = '\0';
next->size = history_size;
next->required = 1;
next->shortlen = strlen(next->line);
return(0);
} /* history_line_new */
/*---------------------------------------------------------------------------
NAME
history_line_add
SYNOPSIS
int history_line_add ( HSymb ** proot, const char * history_line_key,
const char * substring )
DESCRIPTION
Appends a space and a new item to the end of the history line.
If the history line becomes longer than size bytes (including trailing zero)
the rest is skipped.
RETURN VALUES
Returns 0 in case of success and -1 if no success.
---------------------------------------------------------------------------*/
int history_line_add ( HSymb ** proot, const char * history_line_key,
const char * substring )
{ HSymb * next = *proot;
int notfound = 1;
size_t n, linelen;
/* search history line (next) */
while( ( next!=(HSymb *) NULL ) && (notfound>0) ) {
notfound = compare_keys(next->key,history_line_key,UpperCaseSort);
if (notfound>0) {next = next->Next;}
}
/* add arguments */
if ( next!=(HSymb *) NULL ) {
/* append space if string not empty */
linelen = STRLEN(next->line);
if ((linelen>0) && (linelen<next->size-1)) strcat(next->line, " ");
linelen = STRLEN(next->line);
n = (size_t) MAX(0l,MIN((long) next->size - (long) linelen - 1l,
(long) STRLEN(substring)));
if (n>0) {
// strncat(next->line, substring, n ); // not ansic ++++++++++++++
// strcat(next->line, "\0"); // ++++++++++++++
strncpy(next->line+linelen, substring, n); // start at terminating 0
next->line[linelen+n]='\0'; // write terminating 0
}
/* update shortlen if argument is required */
if (next->required) next->shortlen = strlen(next->line);
next->required = 1;
}
return(0);
} /* history_line_add */
/*+++------------------------------------------------------------------------
NAME
edf_history_new
SYNOPSIS
int edf_history_new ( const char * history_key )
DESCRIPTION
This routines must be called first. If not already initialized, it
initializes all history lists. Existing history lines are
removed and a new empty history line with size MaxHistoryLineSize is
created. edf_history_argv adds parameters to this line.
edf_write_header_history appends it with a new key to the
history lines that were read with edf_read_header_history.
RETURN VALUES
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_history_new ( const char * history_key ) /*---*/
{ HBlock * hblock;
if (HIST_debug) printf("\n edf_history_new BEGIN\n");
/* init history module */
if (!InitHistory) init_history();
/* create an empty history block */
if (insert_history_block( history_key, &hblock )) return(0);
/* create empty history line */
if (history_line_new ( &hblock->history_argv_root, argv_key,
MaxHistoryLineSize, (HSymb **) NULL ) ) return(0);
/* default history key */
if (hblock->current_history_line_key)
free(hblock->current_history_line_key);
hblock->current_history_line_key = newstr(default_history_line_key);
if (HIST_debug) printf("\n edf_history_new END\n");
return(1);
} /* edf_history_new */
/*---------------------------------------------------------------------------
NAME
history_line_required
SYNOPSIS
int history_line_required ( HSymb ** proot, const char * history_line_key,
int required )
DESCRIPTION
Sets the parameter 'required' of 'history_line_key' to required.
If 'required' is 1,
the next call to history_line_add will update the parameter 'shortlen',
if 'required' is 0,
the next call to history_line_add will not update the parameter 'shortlen'
RETURN VALUES
Returns 0 in case of success and -1 if no success.
---------------------------------------------------------------------------*/
int history_line_required ( HSymb ** proot, const char * history_line_key,
int required )
{ HSymb * next = *proot;
int notfound = 1;
/* search history line (next) */
while( ( next!=(HSymb *) NULL ) && (notfound>0) ) {
notfound = compare_keys(next->key,history_line_key,UpperCaseSort);
if (notfound>0) {next = next->Next;}
}
if ( next!=(HSymb *) NULL ) {
next->required = required;
}
return(0);
} /* history_line_required */
/*+++------------------------------------------------------------------------
NAME
edf_history_skip
SYNOPSIS
int edf_history_skip ( const char * history_key )
DESCRIPTION
This routines marks the next parameter that is passed to edf_history_argv as
not required.
RETURN VALUES
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_history_skip ( const char * history_key ) /*---*/
{ HBlock * hblock;
if (HIST_debug) printf("\n edf_history_skip BEGIN\n");
if (!InitHistory) init_history();
/* search block history_key */
if (search_history_block( history_key, &hblock )) return(0);
if (history_line_required ( &hblock->history_argv_root, argv_key, 0 ))
return(0);
if (HIST_debug) {
print_history_list( stdout, 1, 1, hblock->history_argv_root );
}
if (HIST_debug) printf("\n edf_history_skip END\n");
return(1);
} /* edf_history_skip */
/*+++------------------------------------------------------------------------
NAME
edf_history_take
SYNOPSIS
int edf_history_take ( const char * history_key )
DESCRIPTION
This routines marks the next parameter that is passed to edf_history_argv as
required (opposite of edf_history_skip)
RETURN VALUES
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_history_take ( const char * history_key ) /*---*/
{ HBlock *hblock;
if (HIST_debug) printf("\n edf_history_take BEGIN\n");
if (!InitHistory) init_history();
/* search block history_key */
if (search_history_block( history_key, &hblock )) return(0);
if (history_line_required ( &hblock->history_argv_root, argv_key, 1 ))
return(0);
if (HIST_debug) {
print_history_list( stdout, 1, 1, hblock->history_argv_root );
}
if (HIST_debug) printf("\n edf_history_take END\n");
return(1);
} /* edf_history_take */
/*+++------------------------------------------------------------------------
NAME
edf_history_free
SYNOPSIS
int edf_history_free ( const char * history_key )
DESCRIPTION
Removes all history lines from history_key.
If called with history_key == (char *) NULL, all history blocks are removed
RETURN VALUES
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_history_free ( const char * history_key ) /*---*/
{ HBlock * next, * hblock;
if (HIST_debug) printf("\n edf_history_free BEGIN\n");
if (!InitHistory) init_history();
if ( history_key != (char *) NULL ) {
/* search block history_key */
if (search_history_block( history_key, &hblock )) return(0);
/* clear and remove history block */
if (remove_history_block( hblock )) return(0);
} else {
next = history_root;
while ( next != (HBlock *) NULL ) {
hblock = next;
next = hblock->Next;
/* clear and remove history block */
if (remove_history_block( hblock )) return(0);
}
}
if (HIST_debug) printf("\n edf_history_free END\n");
return( 1 );
} /* edf_history_free */
/*+++------------------------------------------------------------------------
NAME
edf_read_header_history
SYNOPSIS
int edf_read_header_history (int stream, long int DataNumber,
int DataChain, const char * history_key,
int * pErrorValue, int * pstatus )
DESCRIPTION
Reads all history lines from the date file header and copies them to
'hline->key's. History lines have the keyword HISTORY_KEY_PREFIX'u',
where 'u' is an unsigned positive integer. A new history line with the
key HISTORY_KEY_PREFIX'last+1' and MaxHistoryLineSize bytes is created.
RETURN VALUES
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_read_header_history (int stream, long int DataNumber,
int DataChain, const char * history_key,
int * pErrorValue, int * pstatus ) /*---*/
{ HBlock *hblock;
char history_line[MaxHistoryLineSize];
char history_line_key_buffer[HistoryKeyBufferSize];
long depth=1;
const char *String;
int ErrorValue = RoutineSucceeded, status = status_error;
if (HIST_debug) printf("\n edf_read_header_history BEGIN\n");
if (!InitHistory) init_history();
/* search block history_key */
if (search_history_block( history_key, &hblock ))
goto edf_read_header_history_error;
if (clear_header_history ( hblock ) )
goto edf_read_header_history_error;
sprintf(history_line_key_buffer,"%s%lu",HISTORY_KEY_PREFIX,depth++);
while ( edf_read_header_string ( stream, DataNumber, DataChain,
history_line_key_buffer, &String,
&ErrorValue, &status )) {
if (status != status_success)
goto edf_read_header_history_error;
/* Copy string to history line */
if (String) {
strncpy(history_line,String,MaxHistoryLineSize-1);
history_line[MaxHistoryLineSize-1]='\0';
} else history_line[0]='\0';
if (history_line_new( &hblock->history_line_root, history_line_key_buffer,
STRLEN(history_line)+1, (HSymb **) NULL ))
goto edf_read_header_history_error;
if (history_line_add( &hblock->history_line_root, history_line_key_buffer,
history_line))
goto edf_read_header_history_error;
sprintf(history_line_key_buffer,"%s%lu",HISTORY_KEY_PREFIX,depth++);
}
/* save current history key */
if (hblock->current_history_line_key) free(hblock->current_history_line_key);
hblock->current_history_line_key = newstr(history_line_key_buffer);
if (HIST_debug) {
printf(" history block key = %s\n",hblock->key);
printf(" current_history_line_key = %s\n",
hblock->current_history_line_key);
print_history_list( stdout, 1, 1, hblock->history_argv_root );
print_history_list( stdout, 1, 1, hblock->history_line_root );
}
ErrorValue = RoutineSucceeded;
status = status_success;
if (pErrorValue) *pErrorValue = ErrorValue;
if (pstatus) *pstatus = status;
if (HIST_debug) printf("\n edf_read_header_history END\n");
return(1);
edf_read_header_history_error:
if (pErrorValue) *pErrorValue = ErrorValue;
if (pstatus) *pstatus = status;
if (HIST_debug) printf("\n edf_read_header_history END (status=%d)\n",status);
return(0);
} /* edf_read_header_history */
/*+++------------------------------------------------------------------------
NAME
edf_write_header_history
SYNOPSIS
int edf_write_header_history ( int stream, long int DataNumber,
int DataChain, const char * history_key,
int * pErrorValue, int * pstatus )
DESCRIPTION
Writes the history strings in 'history_line_root' into the date file header
using the 'hline->key's as keywords. Writes the history string in
'history_argv_root' into the date file header using 'current_history_line_key'
as keyword.
RETURN VALUES
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_write_header_history ( int stream, long int DataNumber,
int DataChain, const char * history_key,
int * pErrorValue, int * pstatus ) /*---*/
{ HBlock * hblock;
HSymb * next;
int retval = 1;
int ErrorValue = RoutineSucceeded, status = status_error;
if (HIST_debug) printf("\n edf_write_header_history BEGIN\n");
if (!InitHistory) init_history();
/* search block history_key */
if (search_history_block( history_key, &hblock ))
goto edf_write_header_history_error;
if (HIST_debug) {
printf(" history block key = %s\n",hblock->key);
printf(" current_history_line_key = %s\n",
hblock->current_history_line_key);
print_history_list( stdout, 1, 1, hblock->history_argv_root );
print_history_list( stdout, 1, 1, hblock->history_line_root );
}
/* history_argv_root */
if (( hblock->history_argv_root != (HSymb *) NULL ) &&
( hblock->current_history_line_key != (char *) NULL ) &&
( hblock->history_argv_root->line != (char *) NULL ) ) {
/* write only non-empty history lines */
if (strlen(hblock->history_argv_root->line)>0) {
/* remove not required arguments */
hblock->history_argv_root->line[hblock->history_argv_root->shortlen]='\0';
if (!(edf_write_header_string ( stream, DataNumber, DataChain,
hblock->current_history_line_key,
hblock->history_argv_root->line,
&ErrorValue, &status ) ) )
goto edf_write_header_history_return;
}
}
/* history_line_root */
next = hblock->history_line_root;
while ( next!=(HSymb *) NULL ) {
if (!(edf_write_header_string ( stream, DataNumber, DataChain,
next->key, next->line,
&ErrorValue, &status ) ) )
goto edf_write_header_history_return;
next = next->Next;
}
ErrorValue = RoutineSucceeded;
status = status_success;
edf_write_header_history_return:
if (pErrorValue) *pErrorValue = ErrorValue;
if (pstatus) *pstatus = status;
if (HIST_debug) printf("\n edf_write_header_history END\n");
return( retval );
edf_write_header_history_error:
if (pErrorValue) *pErrorValue = ErrorValue;
if (pstatus) *pstatus = status;
if (HIST_debug) printf("\n edf_write_header_history (status=%d)\n",status);
return(0);
} /* edf_write_header_history */
/*+++------------------------------------------------------------------------
NAME
edf_history_read_header
SYNOPSIS
int edf_history_read_header ( const char * header_key,
const char * history_key,
int * pErrorValue, int * pstatus);
DESCRIPTION
Reads all history lines from the header header_key and copies them to
'hline->key's. History lines have the keyword HISTORY_KEY_PREFIX'u',
where 'u' is an unsigned positive integer. A new history line with the
key HISTORY_KEY_PREFIX'last+1' and MaxHistoryLineSize bytes is created.
RETURN VALUES
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_history_read_header ( const char * header_key,
const char * history_key,
int * pErrorValue, int * pstatus) /*---*/
{ HBlock *hblock;
const char * history_line;
char history_line_key_buffer[HistoryKeyBufferSize];
long depth=1;
if (HIST_debug) printf("\n edf_history_read_header BEGIN\n");
int ErrorValue = RoutineSucceeded, status = status_error;
if (!InitHistory) init_history();
/* search block history_key */
if (search_history_block( history_key, &hblock ))
goto edf_history_read_header_error;
if (clear_header_history ( hblock ) )
goto edf_history_read_header_error;
sprintf(history_line_key_buffer,"%s%lu",HISTORY_KEY_PREFIX,depth++);
while ( edf_search_header_element( header_key,
history_line_key_buffer, &history_line,
&ErrorValue, &status )) {
if (status != status_success)
goto edf_history_read_header_error;
if (history_line_new( &hblock->history_line_root, history_line_key_buffer,
STRLEN(history_line)+1, (HSymb **) NULL ))
goto edf_history_read_header_error;
if (history_line_add( &hblock->history_line_root, history_line_key_buffer,
history_line))
goto edf_history_read_header_error;
sprintf(history_line_key_buffer,"%s%lu",HISTORY_KEY_PREFIX,depth++);
}
/* save current history key */
if (hblock->current_history_line_key) free(hblock->current_history_line_key);
hblock->current_history_line_key = newstr(history_line_key_buffer);
if (HIST_debug) {
printf(" history block key = %s\n",hblock->key);
printf(" current_history_line_key = %s\n",
hblock->current_history_line_key);
print_history_list( stdout, 1, 1, hblock->history_argv_root );
print_history_list( stdout, 1, 1, hblock->history_line_root );
}
ErrorValue = RoutineSucceeded;
status = status_success;
if (pErrorValue) *pErrorValue = ErrorValue;
if (pstatus) *pstatus = status;
if (HIST_debug) printf("\n edf_history_read_header END\n");
return(1);
edf_history_read_header_error:
if (pErrorValue) *pErrorValue = ErrorValue;
if (pstatus) *pstatus = status;
if (HIST_debug) printf("\n edf_history_read_header END (status=%d)\n",status);
return(0);
} /* edf_history_read_header */
/*+++------------------------------------------------------------------------
NAME
edf_history_write_header
SYNOPSIS
int edf_history_write_header ( const char * header_key,
const char * history_key,
int * pErrorValue, int * pstatus );
DESCRIPTION
Writes the history strings in 'history_line_root' into the date file header
using the 'hline->key's as keywords. Writes the history string in
'history_argv_root' into the date file header using 'current_history_line_key'
as keyword.
RETURN VALUES
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_history_write_header ( const char * header_key,
const char * history_key,
int * pErrorValue, int * pstatus) /*---*/
{ HBlock * hblock;
HSymb * next;
int retval = 1;
int ErrorValue = RoutineSucceeded, status = status_error;
if (HIST_debug) printf("\n edf_history_write_header BEGIN\n");
if (!InitHistory) init_history();
/* search block history_key */
if (search_history_block( history_key, &hblock ))
goto edf_history_write_header_error;
if (HIST_debug) {
printf(" history block key = %s\n",hblock->key);
printf(" current_history_line_key = %s\n",
hblock->current_history_line_key);
print_history_list( stdout, 1, 1, hblock->history_argv_root );
print_history_list( stdout, 1, 1, hblock->history_line_root );
}
/* history_argv_root */
if (( hblock->history_argv_root != (HSymb *) NULL ) &&
( hblock->current_history_line_key != (char *) NULL ) &&
( hblock->history_argv_root->line != (char *) NULL ) ) {
/* write only non-empty history lines */
if (strlen(hblock->history_argv_root->line)>0) {
/* remove not required arguments */
hblock->history_argv_root->line[hblock->history_argv_root->shortlen]='\0';
if (!( edf_add_header_element ( header_key,
hblock->current_history_line_key,
hblock->history_argv_root->line,
&ErrorValue, &status ) ) )
goto edf_history_write_header_return;
}
}
/* history_line_root */
next = hblock->history_line_root;
while ( next!=(HSymb *) NULL ) {
if (!( edf_add_header_element ( header_key, next->key, next->line,
&ErrorValue, &status ) ) )
goto edf_history_write_header_return;
next = next->Next;
}
ErrorValue = RoutineSucceeded;
status = status_success;
edf_history_write_header_return:
if (pErrorValue) *pErrorValue = ErrorValue;
if (pstatus) *pstatus = status;
if (HIST_debug) printf("\n edf_history_write_header END\n");
return( retval );
edf_history_write_header_error:
if (pErrorValue) *pErrorValue = ErrorValue;
if (pstatus) *pstatus = status;
if (HIST_debug) printf("\n edf_history_write_header END (status=%d)\n",status);
return(0);
} /* edf_history_write_header */
/*+++------------------------------------------------------------------------
NAME
edf_history_copy --- copies a history block
SYNOPSIS
int edf_history_copy ( const char * history_key_copy,
const char * history_key );
DESCRIPTION
Copies the history block history_key to a new or existing history block
with the name history_key_copy. The existing contents of history_key_copy
will be lost.
RETURN VALUES
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_history_copy ( const char * history_key_copy,
const char * history_key ) /*---*/
{ HBlock *hcopy, *hblock;
if (HIST_debug) printf("\n edf_history_copy BEGIN\n");
if (!InitHistory) init_history();
/* search block history_key */
if (search_history_block( history_key, &hblock )) return(0);
/* copy hblock to history_key_copy */
if (copy_history_block( history_key_copy, &hcopy, hblock )) return(0);
if (HIST_debug) {
printf(" copied history block\n");
printf(" history block key = %s\n",hcopy->key);
printf(" current_history_line_key = %s\n",
hcopy->current_history_line_key);
print_history_list( stdout, 1, 1, hcopy->history_argv_root );
print_history_list( stdout, 1, 1, hcopy->history_line_root );
}
if (HIST_debug) printf("\n edf_history_copy END\n");
return(1);
} /* edf_history_copy */
/*+++------------------------------------------------------------------------
NAME
edf_history_argv --- appends an argument to history line
SYNOPSIS
int edf_history_argv ( const char * history_key, const char * argument )
DESCRIPTION
Appends argument to history line
RETURN VALUES
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_history_argv ( const char * history_key,
const char * argument ) /*---*/
{ HBlock *hblock;
char * buffer = (char *) NULL;
if (HIST_debug) printf("\n edf_history_argv BEGIN\n");
if (!InitHistory) init_history();
/* search block history_key */
if (search_history_block( history_key, &hblock )) return(0);
if (needquotes(argument)) {
/* add double quotes */
if (!(buffer = (char *) malloc ( strlen(argument)+3 ))) return(0);
sprintf(buffer,"\"%s\"",argument);
if (history_line_add ( &hblock->history_argv_root, argv_key,
buffer )) return(0);
free(buffer);
} else {
/* do not add quotes */
if (history_line_add ( &hblock->history_argv_root, argv_key,
argument )) return(0);
}
if (HIST_debug) {
print_history_list( stdout, 1, 1, hblock->history_argv_root );
}
if (HIST_debug) printf("\n edf_history_argv END\n");
return(1);
} /* edf_history_argv */
/*+++------------------------------------------------------------------------
NAME
edf_history_print
SYNOPSIS
int edf_history_print ( FILE * out, const char * history_key,
int level, int verbose )
DESCRIPTION
Prints contents of history history_key to out, or contents of
all histories, if history_key is NULL.
RETURN VALUE
1: success
0: failed (specified history not found)
---------------------------------------------------------------------------*/
int edf_history_print ( FILE * out, const char * history_key,
int level, int verbose )
{ const char * SeparationLine =
"- - - - - - - - - - - - - - -";
HBlock * hblock, * stop = (HBlock*) NULL;
if (HIST_debug) printf("edf_history_print\n");
if (level<1) return(0);
if (!InitHistory) init_history();
if ( history_key != (const char *) NULL ) {
// list a single history block
if (search_history_block( history_key, &hblock )) return(0);
if ( hblock == (HBlock *) NULL ) return(0);
stop = hblock->Next;
} else hblock = history_root; // list all history blocks
while ( hblock != stop ) {
if (verbose) {
fprintf(out," %s\n",SeparationLine);
fprintf(out," History block key = %s\n",hblock->key);
fprintf(out," Previous Key = ");
if ((hblock->Previous)!=(HBlock*) NULL)
fprintf(out,"%s\n", hblock->Previous->key);
else fprintf(out,"(no previous history block)\n");
fprintf(out," Next Key = ");
if ((hblock->Next)!=(HBlock*) NULL)
fprintf(out,"%s\n", hblock->Next->key);
else fprintf(out,"(no next history block)\n");
print_history_list( out, level-1, verbose, hblock->history_line_root );
print_history_list( out, level-1, verbose, hblock->history_argv_root );
printf(" current_history_line_key = %s\n",
hblock->current_history_line_key);
} else {
fprintf(out," History block key = %s\n",hblock->key);
print_history_list( out, level-1, verbose, hblock->history_line_root );
print_history_list( out, level-1, verbose, hblock->history_argv_root );
printf(" current_history_line_key = %s\n",
hblock->current_history_line_key);
}
hblock=hblock->Next;
}
if (verbose) fprintf(out," %s\n",SeparationLine);
if (HIST_debug) printf("\n edf_history_print END\n");
return(1);
} /* edf_history_print */
/*===history END=============================================================*/
/****************************************************************************/
/*---------------------------------------------------------------------------
NAME
renorm_data_array --- Convert data into a machine readable form
SYNOPSIS
MType mtype;
int renorm_data_array ( DBlock * block, void * buffer, size_t buflen,
int mtype, int * pErrorValue, int * pstatus );
DESCRIPTION
Convert the data in block into a machine readable form of type mtype.
- endian correction
- binary decompression (not implemented)
- raster order normalization
- conversion of data to mtype
If buffer is not the NULL-pointer the converted data are always written to
buffer and block->Flags.ExternalDataAlloc is set. buflen is the available
memory in bytes. If the input data buffer was internally allocated it is
released.
If block->Flags.ExternalDataAlloc is set and buffer is NULL the converted
data are written back to the input data buffer. No additional memory is
allocated.
The routine exits with an error if the buffer length is too small
(DataBufferTooSmall).
An endian correction is applied to the data if ByteOrder is different from
the InternalByteOrder of the machine. The data is decompressed, raster
order is normalized and the data are converted into a machine readable
form (mtype).
ERROR VALUES
int * pErrorValue returned ErrorValue,
int * pstatus return status
HISTORY
01-Jan-2001 PB extracted from read_data_array
--------------------------------------------------------------------------+*/
int renorm_data_array ( DBlock * block, void * buffer, size_t buflen,
int mtype, int * pErrorValue, int * pstatus )
{ static const char * RDA_Error = "ERROR: renorm_data_array:";
int internal_byte_order;
void *als[4] = { (void *) NULL };
int i, alc = 0;
long *data_dim;
long data_value_offset;
long raster_configuration;
size_t data_size, data_len;
unsigned long data_number;
size_t data_buffer_len, data_out_len;
void *current = (void*) NULL, *dest = (void*) NULL, *tmp;
size_t current_len = (size_t) 0, dest_len = (size_t) 0, tmp_len;
*pstatus = status_error;
*pErrorValue = RoutineSucceeded;
internal_byte_order = byteorder();
/* check whether block exists */
if (!block) return(-1);
/* check, if data available */
if ( block->Flags.DataExternal ) { // data must be read first
*pErrorValue = ExternalData; return(-1); }
/* do not use buffer if it is identical to block->Data */
if (block->Data == buffer) { // do not use buffer
buffer = (void *) NULL; buflen = (size_t) NULL;
}
/* get binary data description */
data_value_offset = block->DataValueOffset;
raster_configuration = block->DataRasterConfiguration;
if (!block->DataDim) {
*pErrorValue = MissingArrayDimensions; return(-1); }
data_dim = block->DataDim;
data_size = edf_data_sizeof ( block->DataType );
data_number = edf_dim_product ( data_dim );
data_len = data_size * data_number ;
data_buffer_len = block->DataBufferLen;
data_out_len = edf_machine_sizeof(mtype)*data_number;
/* test output buffer size */
if ( buffer == (void *) NULL ) {
if (block->Flags.ExternalDataAlloc) { // use input data buffer for output
if (data_buffer_len<data_out_len) {
// fprintf(stderr,"%s allocated buffer < %zu bytes\n",
fprintf(stderr,"%s allocated buffer < %zu | %lu bytes\n",
RDA_Error,data_out_len,data_out_len);return(-1);
}
}
} else { // use supplied buffer for output
if (buflen<data_out_len) {
// fprintf(stderr,"%s allocated buffer < %zu bytes\n",
fprintf(stderr,"%s allocated buffer < %zu | %lu bytes\n",
RDA_Error,data_out_len,data_out_len);return(-1);
}
}
/* toggle data between current and dest */
current = block->Data;
current_len = data_buffer_len;
/* --- endian correction */
if ( block->DataByteOrder != internal_byte_order )
edf_bswap ( current, current, data_size, data_number );
block->DataByteOrder = internal_byte_order;
/* --- raster order normalization */
if (block->DataRasterConfiguration!=1l) {
/* input and output memory must be different, allocate new memory */
dest_len = data_len;
if (!(dest = malloc( dest_len ))) {
*pErrorValue = CouldNotMallocMemory;
// fprintf(stderr,"%s malloc of %zu bytes failed\n",RDA_Error,dest_len);return(-1);
fprintf(stderr,"%s malloc of %zu | %lu bytes failed\n",
RDA_Error,dest_len,dest_len);return(-1);
}
als[alc++] = dest; // add allocated memory
if (raster_normalization ( dest, current, data_dim,
raster_configuration, data_size, NULL)) {
for ( i=alc; i>0; --i ) if (als[i]) free(als[i]); return(-1); }
tmp = current; current = dest; dest = tmp;
tmp_len = current_len; current_len = dest_len; dest_len = tmp_len;
} /* if (raster_configuration!=1) */
block->DataRasterConfiguration = 1l;
/* last step, if buffer is set destination should be buffer, otherwise
destination should be block->Data, source is current */
if ( buffer==(void *) NULL ) {
dest = block->Data;
dest_len = data_buffer_len;
} else {
dest = buffer;
dest_len = buflen;
if (dest_len<data_out_len) {
// fprintf(stderr,"%s supplied buffer < %zu bytes\n",RDA_Error,data_out_len);
fprintf(stderr,"%s supplied buffer < %zu | %lu bytes\n",
RDA_Error,data_out_len,data_out_len);
return(-1); }
}
/* --- data conversion to mtype*/
if (dest_len<data_out_len) { /* allocate new memory for output */
dest_len = data_out_len;
if (!(dest = malloc ( dest_len ))) {
for ( i=alc; i>0; --i ) if (als[i]) free(als[i]);
*pErrorValue = CouldNotMallocMemory;
// fprintf(stderr,"%s malloc of %zu bytes failed\n",RDA_Error,dest_len);return(-1);
fprintf(stderr,"%s malloc of %zu | %lu bytes failed\n",
RDA_Error,dest_len,dest_len);
return(-1);
}
als[alc++] = dest; // add allocated memory
} /* if (dest_len ... */
if ( edf_machine2machine ( dest, mtype,
current, data_value_offset,
edf_datatype2machinetype(block->DataType),
data_number ) ) {
for ( i=alc; i>0; --i ) if (als[i]) free(als[i]);
*pErrorValue = DataConversionFailed; return(-1); }
if ( dest!=block->Data ) { // relink new memory
// release only internally allocated data buffer
if (!block->Flags.ExternalDataAlloc) free(block->Data);
block->Data = dest;
block->DataBufferLen = dest_len;
if (dest==buffer) block->Flags.ExternalDataAlloc = True;
else block->Flags.ExternalDataAlloc = False;
/* remove from allocated memory list */
for ( i=alc; i>0; --i ) if (als[i]==dest) als[i]=(void *) NULL;
}
/* update data block description */
block->DataLen = data_out_len;
block->DataValueOffset = 0l;
block->DataType = InValidDType;
block->Flags.DataExternal = True;
/* release temporary memory */
for ( i=alc; i>0; --i ) if (als[i]) free(als[i]);
*pErrorValue = RoutineSucceeded;
*pstatus = status_success;
return(0);
} /* renorm_data_array */
/*---------------------------------------------------------------------------
NAME
read_data_array --- read data array (raw, without conversion)
SYNOPSIS
int read_data_array ( DBlock * block, void *buffer, size_t buflen,
int must_use_buffer, long dim[],
int * pErrorValue, int * pstatus )
DESCRIPTION
Reads a data array from the block DataNumber in DataChain.
If ( block->DataExternal ) the data is read from the file, if not, it is
taken directy from block.
buffer is an optional data buffer. If buffer!=NULL buflen describes the
available memory in bytes and must_use_buffer is a flag that indicates
whether this buffer must be used or whether it is optional. The data are
written to buffer. If its size is too short and the flag must_use_buffer
is set the routine stops with an error, otherwise an internal buffer with
correct length is allocated. If buffer is NULL internal memory is always
allocated. Internally allocated memory is released automatically after
the next write, when a different data block is accessed. or when the
stream is closed.
If dim!=NULL the dimension array is copied to dim. The first element
dim[0] must contain the maximum image dimension, e.g. 2 for a 2d array.
If dim is too short the routine exits with an error. In all other cases
a correct dimension array is allocated and available in block->DataDim.
PARAMETERS
DBlock * block Current data block
void *buffer Data buffer
input: buffer == NULL
-> memory allocated and pointer returned
buffer != NULL
-> up to buflen bytes are written to *buffer
(buflen is data buffer size in bytes)
If must_use_buffer is False memory is
allocated if external buffer is too short.
size_t buflen Size of input data buffer in bytes.
int must_use_buffer True: use always the supplied buffer
Fallse: use supplied buffer only if it is big enough
long dim[] Optional dimension array for output
dim[0] length of the dimension array
dim[1] length of dimension 1
...
dim[dim[0]] length of last dimension
input: dim == NULL
-> not used
dim != NULL
-> data array dimension is copied to dim.
dim[0] must contain the dimensions. dim[0]
dimensions. Unused dimensions are set to 1, error
if too short.
ERROR VALUES
int * pErrorValue returned ErrorValue,
only used when *pstatus!=status_success.
CouldNotGetBinaryArray: routine get_binary_array failed.
int * pstatus return status
AUTHOR
05-Mar-1998 Peter Boesecke
30-Apr-1998 PB no conversion for ConversionType==0,
parameter pDataType added
23-Jul-1999 PB data_value_offset_in added
30-Apr-2000 PB Parameter ConversionType renamed to mtype
12-Nov-2000 PB DataDim is not unlinked any more
12-Nov-2000 PB DBlock * block instead of DataChain etc.
01-Jan-2001 PB totally redesigned, no conversion any more
--------------------------------------------------------------------------+*/
int read_data_array ( DBlock * block, void *buffer, size_t buflen,
int must_use_buffer, long dim[],
int * pErrorValue, int * pstatus )
{
*pstatus = status_error;
*pErrorValue = RoutineSucceeded;
/* check whether block exists */
if (!block) return(-1);
/* get data array */
if ( block->Flags.DataExternal ) {
if ( get_binary_array ( block, buffer, buflen, must_use_buffer ) ) {
*pErrorValue = CouldNotGetBinaryArray; return(-1); }
}
/* copy dimensions to dim */
if (dim) { // copy dimensions to dim
if ( !(copydim( dim, dim[0], block->DataDim ) ) ) {
*pErrorValue = NotNdData; return(-1);
}
}
*pstatus = status_success;
*pErrorValue = RoutineSucceeded;
return(0);
} /* read_data_array */
/****************************************************************************/
/*---------------------------------------------------------------------------
NAME
free_data_file --- deallocates and reinitializes an edf file.
SYNOPSIS
int free_data_file ( DFile * file );
DESCRIPTION
Deallocates all memory of a DFile. If it is already done nothing happens.
RETURN VALUE
success: int 0
error: int -1
---------------------------------------------------------------------------*/
int free_data_file ( DFile * file )
{
/* remove chainlist */
if (free_data_chain_list( file )) return(-1);
/* close file */
if (file->Channel!=NULL)
if (fclose(file->Channel)) return(-1);
file->Channel = (FILE *) NULL;
/* release IO-buffer */
if (file->Buffer!=NULL)
free(file->Buffer);
file->Buffer = (char *) NULL;
/* release file name */
if (file->Name!=NULL)
free(file->Name);
file->Name = (char *) NULL;
init_file ( file );
return(0);
} /* free_data_file */
/*---------------------------------------------------------------------------
NAME
open_as_bsl_file --- reads the file as a bsl file
SYNOPSIS
int open_as_bsl_file ( const char *fname, const char * mode,
int *pErrorValue, int *pstatus );
DESCRIPTION
Opens fname as a BSL file and, if successful, creates an edf file structure
with chains corresponding to bsl memories and data blocks corresponding to
bsl frames. The translation is done in the following way:
memnum franum chain key block key block id
1 n image.psd n n.image.psd
m n image.m n n.image.m
The data block headers exist only in memory, they are not read a second time
from the file. The only allowed opening mode is Old.
ERROR VALUES
*pErrorValue
*pstatus
RETURN VALUE
success: int stream (Channel not opened)
error: int -1
---------------------------------------------------------------------------*/
int open_as_bsl_file ( const char *fname, const char * mode,
int *pErrorValue, int *pstatus )
{ int stream=-1, bsl_stream;
long memnum, minmem, maxmem;
long franum, minfra, maxfra;
BslDataSpec *data_spec;
char *first_header, *second_header;
char chain_key[MaxKeyLen+1];
char block_key[MaxKeyLen+1];
char symbol_key[MaxKeyLen+1];
char symbol_value[MaxValLen+1];
DFile * file;
DChain * chain;
DBlock * block;
SElement * symbol;
int i;
*pstatus = status_error;
*pErrorValue = RoutineSucceeded;
if (EDFIO_debug) printf("open_as_bsl_file\n");
if ( (STRCMP(mode,Old)!=0) && (STRCMP(mode,Read)!=0) ) {
*pErrorValue = CannotOpenAsBslFile; return ( stream );
}
if (!InitTable) init_file_table( FileTable );
if ( ( stream=search_free_stream( FileTable ) ) < 0 ) {
*pErrorValue = NoMoreStreamsAvailable; return(-1);
}
if (EDFIO_debug) printf("\"%s\" : stream = %d (%s)\n",fname,stream,mode);
file = &FileTable[stream];
init_file ( file );
file->Used = True;
if ( !(file->Name = newstr( fname ) ) ) return(-1);
/* set general flags */
file->Flags.NoGeneralHeader = True;
/* create general header */
if ( new_general_block( file ) ) {
*pErrorValue = ErrorCreatingGeneralBlock; return(-1);
}
bsl_stream = open_bsl_file ( fname , "read" );
if (bsl_stream<0) {
*pErrorValue = CannotOpenAsBslFile; return( stream );
}
/* create edf file structure */
read_bsl_file_headers( bsl_stream, &first_header, &second_header );
if (EDFIO_debug) print_bsl_filetable ( stdout, 4, True );
insert_string ( file->GeneralBlock, "Title", first_header, &symbol );
insert_string ( file->GeneralBlock, "SubTitle", second_header, &symbol );
if (bsl_memory_range( bsl_stream, &minmem, &maxmem )) return(-1);
for (memnum = minmem; memnum<=maxmem; memnum++) {
if (bsl_frame_range( bsl_stream, memnum, &minfra, &maxfra )) return(-1);
if (!(default_chain_key(chain_key, memnum))) return(-1);
if ( insert_data_chain( file, chain_key, &chain ) ) return(-1);
for (franum = minfra; franum<=maxfra; franum++) {
data_spec = read_bsl_data_spec ( bsl_stream, memnum, franum );
if (!data_spec) return(-1);
sprintf( block_key, "%ld", franum);
if ( insert_data_block( chain, block_key, &block ) ) return(-1);
block->Flags.InternalHeader = True;
block->Flags.DataExternal = True;
block->BinaryFileName = newstr(data_spec->BinaryFileName);
block->BinaryFilePos = data_spec->BinaryFilePos;
block->BinaryFileLen = data_spec->BinaryFileLen;
for (i=1;i<=data_spec->Dim[0];i++) {
sprintf(symbol_key,"%s%1u",DIMENSION_KEY_PREFIX,i);
long2s(symbol_value,data_spec->Dim[i]);
if (insert_string ( block, symbol_key, symbol_value, &symbol ))
return(-1);
}
if (insert_string ( block, DATA_TYPE_KEY,
edf_datatype2string( data_spec->DataType ), &symbol )) return(-1);
if ( bsl_input_byteorder == InValidBOrder ) {
if (insert_string ( block, BYTE_ORDER_KEY,
ByteOrder2String( data_spec->ByteOrder ), &symbol )) return(-1);
} else {
if (insert_string ( block, BYTE_ORDER_KEY,
ByteOrder2String( bsl_input_byteorder ), &symbol )) return(-1);
}
if (data_spec->RasterConfiguration!=1l) {
sprintf(symbol_value,"%ld",data_spec->RasterConfiguration);
if (insert_string ( block, RASTER_CONFIGURATION_KEY,
symbol_value, &symbol ) ) return(-1);
}
if (insert_string ( block, COMPRESSION_KEY,
edf_compression2string( data_spec->Compression ), &symbol )) return(-1);
} /* for franum */
} /* for memnum */
if (close_bsl_file ( bsl_stream )) return(-1);
/* open existing file read only */
file->Channel = fopen( fname,"rb");
file->Flags.ExistingFile = True;
file->Flags.ReadOnlyFile = True;
*pstatus = status_success;
*pErrorValue = RoutineSucceeded;
return (stream);
} /* open_as_bsl_file */
/*---------------------------------------------------------------------------
open_as_edf_file
Open the file 'fname' with mode "new", "old", "any", "read" and "temp"
return a stream (success: 0 .. MaxFiles-1, error: -1);
--------------------------------------------------------------------------+*/
int open_as_edf_file ( const char *fname, const char * mode,
int *pErrorValue, int *pstatus ) /*---*/
{ int stream;
int locate_status;
DFile * file;
DBlock * block;
*pstatus = status_error;
*pErrorValue = RoutineSucceeded;
if (EDFIO_debug) printf("open_as_edf_file\n");
if (!InitTable) init_file_table( FileTable );
if ( ( stream=search_free_stream( FileTable ) ) < 0 ) {
*pErrorValue = NoMoreStreamsAvailable; return(-1);
}
if (EDFIO_debug) printf("\"%s\" : stream = %d (%s)\n",fname,stream,mode);
file = &FileTable[stream];
init_file ( file );
file->Used = True;
if ( !(file->Name = newstr( fname ) ) ) return(-1);
if (STRCMP(mode,Old)==0) { /* open old file */
file->Channel = fopen( fname,"rb+");
file->Flags.ExistingFile = True;
file->Flags.ReadOnlyFile = False; } else
if (STRCMP(mode,New)==0) { /* open new file */
file->Channel = fopen( fname,"wb+");
file->Flags.ExistingFile = False;
file->Flags.ReadOnlyFile = False; } else
if (STRCMP(mode,Any)==0) { /* open old file or create new file */
if ( (file->Channel = fopen( fname,"rb+")) ) {
file->Flags.ExistingFile = True;
file->Flags.ReadOnlyFile = False;
} else {
file->Channel = fopen( fname,"wb+");
file->Flags.ExistingFile = False;
file->Flags.ReadOnlyFile = False; } } else
if (STRCMP(mode,Read)==0) { /* open old file */
file->Channel = fopen( fname,"rb");
file->Flags.ExistingFile = True;
file->Flags.ReadOnlyFile = True; }
if (STRCMP(mode,Temp)==0) { /* open internal temporary file */
file->Flags.TemporaryFile = True;
file->Channel = (FILE *) NULL;
} else {
// open i/o-channel of non-temporary files
if (file->Channel == (FILE *) NULL) {
*pErrorValue = CouldNotOpenFile; return(-1);
}
/* allocate IO-buffer */
file->Buffer = (char *) malloc(BufferSize*sizeof(char));
if ( file->Buffer == (char *) NULL ) {
*pErrorValue = CouldNotMallocMemory; return(-1);
}
if ( setvbuf(file->Channel, file->Buffer, _IOFBF, BufferSize) ) {
*pErrorValue = CouldNotSetBuffer; return(-1); }
}
/* read general header */
if ( new_general_block( file ) ) {
*pErrorValue = ErrorCreatingGeneralBlock; return(-1);
}
if ( file->Flags.ExistingFile ) {
if ( !read_general_block( file ) ) {
/* This must be an EDF file */
if ( !file->Flags.NoGeneralHeader )
file->LastBlockInFile = file->GeneralBlock;
/* Update sequence number of general block */
if (!file->Flags.NoGeneralHeader)
file->GeneralBlock->SequenceNumber = file->NextSequenceNumber++;
/* locate data blocks */
locate_status = locate_block( file , &block );
while ( !locate_status ) {
file->LastBlockInFile = block;
block->SequenceNumber = file->NextSequenceNumber++;
locate_status = locate_block( file , &block );
}
/* verify that end of file is reached */
if ( locate_status<0 ) {
/* fatal error */
*pErrorValue = ErrorLocatingBlocks; return(-1);
}
} else {
if (free_data_file ( file )) {
*pErrorValue = CouldNotCloseFile; return(-1);
};
*pErrorValue = ErrorReadingGeneralBlock;
return(-1);
} /* if read_general_block */
} else file->GeneralBlock->Flags.HeaderChanged = True;
/* check, if something is in the file */
if (STRCMP(mode,Old)==0) /* open old file */
if (!file->LastBlockInFile) {
*pstatus = status_error;
*pErrorValue = CouldNotFindHeader;
return(-1); }
*pstatus = status_success;
return(stream);
} /* open_as_edf_file */
/*---------------------------------------------------------------------------
NAME
data_file_type --- returns the data file type
SYNOPSIS
int data_file_type ( const char *fname );
DESCRIPTION
Checks file 'fname' and checks its start bytes with check_header
for a header start of an edf file. If it fails, the file name
is checked for a bsl type file.
If the file starts with the following sequence, it is opened as an edf
type file.
'\r' '\n' 'StartHeader
'\n' 'StartHeader
'StartHeader
REMARK
All V2.0 Edf files must start with the following sequence
'\n', StartHeader, '\r', '\n', "DATA_FORMAT_PREFIX". The
first 8 bytes for a version 2.0 edf data file look today
explicitely (22-Mar-1998):
1 2 3 4 5 6 7 8
'\n' '{' '\r' '\n' 'E' 'D' 'F' '_'
ARGUMENT
const char * fname filename
int * pErrorValue error value on exit
int * pstatus status on exit
RETURN VALUE
success: int stream
error: int -1
HISTORY
22-Mar-1998 Peter Boesecke
11-Jul-2001 PB accepts empty files as edf files
--------------------------------------------------------------------------+*/
int data_file_type ( const char * fname, int *pErrorValue, int *pstatus )
{ int dftype = InValidDFType;
FILE * channel;
*pstatus = status_error;
if (!(channel = fopen( fname, "rb" ))) {
*pErrorValue = CouldNotOpenFile; return(dftype); }
/* check for edf file */
switch ( check_start( channel ) ) {
case 0: dftype = EdfType; break;
case -1: dftype = EdfType; break; // empty edf file
default: dftype = BslType; // check for bsl file name
}
fclose ( channel );
*pstatus = status_success;
*pErrorValue = RoutineSucceeded;
return( dftype );
} /* data_file_type */
/*+++------------------------------------------------------------------------
NAME
edf_open_data_file --- open file 'fname' with new, old, any, read or temp
SYNOPSIS
int edf_open_data_file ( const char *fname, const char * mode,
int *pErrorValue, int *pstatus );
DESCRIPTION
Opens the file 'fname' with mode "new", "old", "any" or "read" and
return a stream (success: 0 .. MaxFiles-1, error: -1).
"new": open a new file for read/write, an existing file with the same
name is overwritten
"old": open an existing file for read/write and check file format
"any": open either an existing file and check its file format or
open a new file for read/write
"read": open an existing file for read and check its file format
"temp": open a new temporary file
If an existing file is opened with "old", "any" or "read" its file
start marker is checked and, according to it, it is opened as an edf file
or a bsl file.
A temporary file is newer written to disk or read from disk. It can
only be accessed internally and it disappears after edf_close.
Attention, a temporary file is entirely kept in memory until it is closed.
RETURN VALUE
success: int stream
error: int -1
HISTORY
22-Mar-1998 Peter Boesecke
05-Aug-2001 PB temporary file
--------------------------------------------------------------------------+*/
int edf_open_data_file ( const char *fname, const char * mode,
int *pErrorValue, int *pstatus ) /*---*/
{ int stream;
int ErrorValue = RoutineSucceeded, status = status_error;
if (EDFIO_debug) printf("edf_open_data_file BEGIN\n");
if ( (STRCMP(mode,Old)==0) || (STRCMP(mode,Read)==0) ) { /* open old file */
switch (data_file_type ( fname, &ErrorValue, &status )) {
case EdfType:
stream = open_as_edf_file ( fname, mode, &ErrorValue, &status );
break;
case BslType:
stream = open_as_bsl_file ( fname, mode, &ErrorValue, &status );
break;
default:
/* unknown data file type */
stream = -1;
status = status_error;
};
} else stream = open_as_edf_file ( fname, mode, &ErrorValue, &status );
if (pErrorValue) *pErrorValue = ErrorValue;
if (pstatus) *pstatus = status;
if (EDFIO_debug) printf("edf_open_data_file END (status=%d)\n",status);
if (EDFIO_debug) edf_print_filetable( stdout, 4, True );
return( stream );
} /* edf_open_data_file */
/*+++------------------------------------------------------------------------
NAME
check_mode --- check, whether opening mode mode is compatible with stream
SYNOPSIS
int check_mode( int stream, int mode );
DESCRIPTION
RETURN VALUE
compatible : 0
incompatible: -1
HISTORY
06-Jul-2001 Peter Boesecke
--------------------------------------------------------------------------+*/
int check_mode( int stream, const char * mode )
{ int value=-1;
unsigned short ef, ro;
if ( (stream<0)||(stream>=MaxFiles) ) return(value);
ef = FileTable[stream].Flags.ExistingFile;
ro = FileTable[stream].Flags.ReadOnlyFile;
if (!STRCMP(mode,Read)) {
value = 0; // any file is readable
} else if (!STRCMP(mode,Old)) {
if ( ef && (!ro) ) value=0; // file must exist and not be write protected
} else if (!STRCMP(mode,New)) {
if ((!ef) && (!ro)) value = 0; // must have been opened with new
} else if (!STRCMP(mode,Any)) {
if (!ro) value = 0; // must not be write protected
}
return(value);
} // check_mode
/*+++------------------------------------------------------------------------
NAME
edf_search_stream --- check, whether data file is already opened
SYNOPSIS
int edf_search_stream ( const char *fname, const char * mode,
int *pErrorValue, int *pstatus );
DESCRIPTION
If a file called fname is already opened the function returns its stream,
otherwise -1. If a file is already opened with an incompatible opening
mode the error IncompatibleOpeningMode is returned together with the
stream.
RETURN VALUE
success: int stream
error: int -1
HISTORY
05-Jul-2001 Peter Boesecke
--------------------------------------------------------------------------+*/
int edf_search_stream ( const char *fname, const char * mode,
int *pErrorValue, int *pstatus )
{ int stream;
int ErrorValue=RoutineSucceeded, status=status_success;
if (EDFIO_debug) printf("edf_search_stream BEGIN\n");
if (!InitTable) init_file_table( FileTable );
stream=search_stream( FileTable, fname );
if ( (stream>=0)&&(stream<MaxFiles) )
if (check_mode( stream, mode )) {
status = status_error;
ErrorValue = IncompatibleOpeningModes;
}
if (EDFIO_debug) printf("edf_search_stream END (status=%d)\n",status);
if (EDFIO_debug) edf_print_filetable( stdout, 4, True );
if (pstatus) *pstatus = status;
if (pErrorValue) *pErrorValue = ErrorValue;
return( stream );
} /* edf_search_stream */
/*+++------------------------------------------------------------------------
NAME
edf_close_data_file --- close an edf data file
SYNOPSIS
void edf_close_data_file ( int stream, int *pErrorValue, int *pstatus );
DESCRIPTION
Closes the edf data file stream
--------------------------------------------------------------------------+*/
void edf_close_data_file ( int stream, int *pErrorValue, int *pstatus ) /*---*/
{
int ErrorValue=RoutineSucceeded, status=status_error;
DFile *file = NULL;
if (EDFIO_debug) printf("edf_close_data_file BEGIN\n");
if ( (stream>=0)&&(stream<MaxFiles) ) { // no need to close
file = &FileTable[stream];
/* flush unsaved data block */
if ( disk_write_block( file->ActiveBlock, &ErrorValue ) )
goto edf_close_data_file_error;
/* update active block */
file->ActiveBlock = (DBlock *) NULL;
if (free_data_file ( file )) {
status=status_error;
ErrorValue = CouldNotCloseFile;
goto edf_close_data_file_error;
}
} // if stream
ErrorValue = RoutineSucceeded;
status = status_success;
if (pErrorValue) *pErrorValue = ErrorValue;
if (pstatus) *pstatus = status;
if (EDFIO_debug) printf("edf_close_data_file END\n");
return;
edf_close_data_file_error:
if (pErrorValue) *pErrorValue = ErrorValue;
if (pstatus) *pstatus = status;
if (EDFIO_debug) printf("edf_close_data_file END (status=%d)\n",status);
return;
} /* edf_close_data_file */
/*+++------------------------------------------------------------------------
NAME
edf_free_data_file --- close all edf data files
SYNOPSIS
int edf_free_data_file ( void );
DESCRIPTION
Closes all edf data files and releases all allocated memory buffers.
--------------------------------------------------------------------------+*/
int edf_free_data_file ( void ) /*---*/
{ int i;
for (i=0;i<MaxFiles;i++) free_data_file ( &FileTable[i] );
return(1);
} /* edf_free_data_file */
/*+++------------------------------------------------------------------------
NAME
edf_write_header_line
SYNOPSIS
int edf_write_header_line ( int stream, long int DataNumber, int DataChain,
const char * keyword, const char * Value,
int * pErrorValue, int * pstatus );
DESCRIPTION
Searches for header 'DataNumber' in 'DataChain'.
If it does not exists, it is created. It writes keyword and value
into the header. The value is a character string. This function should
be used when the value should be written to a single line. But the result
can be clipped at MaxLinLen.
Currently, it is identical to edf_write_header_string.
RETURN VALUE
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_write_header_line ( int stream, long int DataNumber, int DataChain,
const char * keyword, const char * Value,
int * pErrorValue, int * pstatus ) /*---*/
{
return ( write_header_string ( stream, DataNumber, DataChain,
keyword, Value, pErrorValue, pstatus ) );
} /* edf_write_header_line */
/*+++------------------------------------------------------------------------
NAME
edf_write_header_string
SYNOPSIS
int edf_write_header_string ( int stream, long int DataNumber, int DataChain,
const char * keyword, const char * Value,
int * pErrorValue, int * pstatus );
DESCRIPTION
Searches for header 'DataNumber' in 'DataChain'.
If it does not exists, it is created. It writes keyword and value
into the header. The value is a character string of any length.
This function should be used if the value should be written to continuation
lines, if necessary.
RETURN VALUE
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_write_header_string ( int stream, long int DataNumber, int DataChain,
const char * keyword, const char * Value,
int * pErrorValue, int * pstatus ) /*---*/
{
return ( write_header_string ( stream, DataNumber, DataChain,
keyword, Value, pErrorValue, pstatus ) );
} /* edf_write_header_string */
/*+++------------------------------------------------------------------------
NAME
edf_delete_key
SYNOPSIS
int edf_delete_key ( int stream, long int DataNumber, int DataChain,
const char * keyword,
int * pErrorValue, int * pstatus );
DESCRIPTION
Searches for header 'DataNumber' in 'DataChain'.
It deletes keyword, associated continuation keys and values from the header.
RETURN VALUE
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_delete_key ( int stream, long int DataNumber, int DataChain,
const char * keyword,
int * pErrorValue, int * pstatus ) /*---*/
{
return ( delete_key ( stream, DataNumber, DataChain,
keyword, pErrorValue, pstatus ) );
} /* edf_delete_key */
/*+++------------------------------------------------------------------------
NAME
edf_write_header_float
SYNOPSIS
int edf_write_header_float ( int stream, long int DataNumber, int DataChain,
const char * keyword, float Value,
int * pErrorValue, int * pstatus );
DESCRIPTION
Searches for header 'DataNumber' in 'DataChain'.
If it does not exists, it is created. It writes keyword and value as
text into the header. The value is a float value.
RETURN VALUE
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_write_header_float ( int stream, long int DataNumber, int DataChain,
const char * keyword, float Value,
int * pErrorValue, int * pstatus ) /*---*/
{ char KeyBuf[MaxKeyLen+1];
int errval;
if (!num_double2str( KeyBuf, MaxKeyLen+1, (double) Value, "",
EdfNDigitsFloat, &errval )) {
*pstatus = status_error;
*pErrorValue = NumberConversionFailed; return(0); }
return( write_header_string ( stream, DataNumber, DataChain,
keyword, KeyBuf, pErrorValue, pstatus ) );
} /* edf_write_header_float */
/*+++------------------------------------------------------------------------
NAME
edf_write_header_unit
SYNOPSIS
int edf_write_header_unit ( int stream, long DataNumber,
int DataChain, const char * keyword,
float Value, const char * unit,
int * pErrorValue, int * pstatus );
DESCRIPTION
Searches for header 'DataNumber' in 'DataChain'.
If it does not exists, it is created. It writes keyword and value as
text into the header. The value is a float value.
RETURN VALUE
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_write_header_unit ( int stream, long DataNumber,
int DataChain, const char * keyword,
float Value, const char * unit,
int * pErrorValue, int * pstatus ) /*---*/
{ char KeyBuf[MaxKeyLen+1];
int errval;
if (!num_double2str( KeyBuf, MaxKeyLen+1, (double) Value, unit,
EdfNDigitsFloat, &errval )) {
*pstatus = status_error;
*pErrorValue = NumberConversionFailed; return(0); }
return( write_header_string ( stream, DataNumber, DataChain,
keyword, KeyBuf, pErrorValue, pstatus ) );
} /* edf_write_header_unit */
/*+++------------------------------------------------------------------------
NAME
edf_write_header_long
SYNOPSIS
int edf_write_header_long ( int stream, long int DataNumber, int DataChain,
const char * keyword, long int Value,
int * pErrorValue, int * pstatus );
DESCRIPTION
Searches for header 'DataNumber' in 'DataChain'.
If it does not exists, it is created. It writes keyword and value as
text into the header. The value is a long integer value.
RETURN VALUE
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_write_header_long ( int stream, long int DataNumber, int DataChain,
const char * keyword, long int Value,
int * pErrorValue, int * pstatus ) /*---*/
{ char KeyBuf[MaxKeyLen+1];
if (!long2s(KeyBuf,Value)) {
*pErrorValue = NumberConversionFailed; return(0); }
return( write_header_string ( stream, DataNumber, DataChain,
keyword, KeyBuf, pErrorValue, pstatus ) );
} /* edf_write_header_long */
/*+++------------------------------------------------------------------------
NAME
edf_write_data_raw --- Write n-dimensional raw data array without conversion
SYNOPSIS
void edf_write_data_raw ( int stream, long int DataNumber,
int DataChain, const long Dim[],
void *pData, int DataType,
long DataValueOffset, int ByteOrder,
long RasterConfiguration,
int * pErrorValue, int *pstatus );
DESCRIPTION
Searches for header 'DataNumber' in 'DataChain'. If it does not exists,
it is created.
Writes an n-dimensional DataType data array without any conversion as
binary data after the end of the header. The data array is specified by Dim,
DataValueOffset, ByteOrder, RasterConfiguration and DataType. All
informations are written into the header.
To write internal data the function edf_write_data should be used.
ARGUMENTS
void * pData (i) pointer to the start of the data array
int DataType (i) data type
long DataValueOffset (i)
int ByteOrder (i)
long RasterConfiguration (i)
const long Dim[0] (i) N, number of dimensions
Dim[1] (i) dimension 1
Dim[2] (i) dimension 2
...
Dim[N] (i) dimension N
--------------------------------------------------------------------------+*/
void edf_write_data_raw ( int stream, long DataNumber,
int DataChain, const long Dim[],
void *pData, int DataType,
long DataValueOffset, int ByteOrder,
long RasterConfiguration,
int * pErrorValue, int *pstatus ) /*---*/
{
char KeyBuf[MaxKeyLen+1];
char ValBuf[MaxValLen+1];
DBlock * block;
SElement * symbol;
int DataCompression=UnCompressed;
long idim;
int errval, status;
if (EDFIO_debug) printf("edf_write_data_raw BEGIN\n");
/* open output to block */
if ( open_write_block (stream, DataNumber, DataChain,
&block, &errval ) )
goto edf_write_data_raw_error;
if (data_compression_out) DataCompression = data_compression_out;
/* link raw data and Dim with block and write specification */
block->Data = pData;
block->Flags.ExternalDataAlloc = True;
block->DataLen = edf_data_sizeof(DataType) * edf_dim_product(Dim);
block->DataBufferLen = block->DataLen;
block->DataType = DataType;
block->DataValueOffset = DataValueOffset;
block->DataByteOrder = ByteOrder;
block->DataRasterConfiguration = RasterConfiguration;
block->DataCompression = DataCompression;
block->DataDim = newcopydim(Dim);
/* write compulsary keywords */
/* --- Array Dimensions */
for (idim = 1l; idim <= Dim[0]; idim++) {
/* write DIM_idim */
sprintf(KeyBuf,"%s%lu",DIMENSION_KEY_PREFIX,idim);
long2s(ValBuf,Dim[idim]);
if (insert_string( block, KeyBuf, ValBuf, &symbol) ) {
errval=CouldNotWriteDimension;
goto edf_write_data_raw_error;
}
}
/* --- DataType */
if (insert_string( block, DATA_TYPE_KEY, edf_datatype2string( DataType ),
&symbol) ) {
errval=CouldNotWriteBinary;
goto edf_write_data_raw_error;
}
/* --- DataValueOffset */
if (DataValueOffset!=0l) { /* write only if not zero, otherwise remove */
if (insert_string( block, DATA_VALUE_OFFSET_KEY,
long2s(ValBuf,DataValueOffset), &symbol) ) {
errval=CouldNotWriteBinary;
goto edf_write_data_raw_error;
}
} else { /* remove if zero */
if (remove_symbol( block, DATA_VALUE_OFFSET_KEY , NULL )) {
errval=CouldNotWriteBinary;
goto edf_write_data_raw_error;
}
}
/* --- ByteOrder */
if (insert_string( block, BYTE_ORDER_KEY, ByteOrder2String( ByteOrder ),
&symbol) ) {
errval=CouldNotWriteBinary;
goto edf_write_data_raw_error;
}
/* --- RasterConfiguration */
if (RasterConfiguration!=1l) { // only compulsary for RasterConfiguration!=1
if (insert_string( block, RASTER_CONFIGURATION_KEY,
long2s(ValBuf,RasterConfiguration), &symbol) ) {
errval=CouldNotWriteBinary;
goto edf_write_data_raw_error;
}
} else { /* remove if 1 */
if (remove_symbol( block, RASTER_CONFIGURATION_KEY, NULL )) {
errval=CouldNotWriteBinary;
goto edf_write_data_raw_error;
}
}
/* --- Compression */
if (insert_string( block, COMPRESSION_KEY,
edf_compression2string( DataCompression ), &symbol) ) {
errval=CouldNotWriteBinary;
goto edf_write_data_raw_error;
}
/* end of compulsary keywords */
/* close output to block */
if ( close_write_block( block, &errval ) )
goto edf_write_data_raw_error;
block->Flags.HeaderChanged = True;
block->Flags.DataChanged = True;
/* write active data block to disk (this block) immediately */
if ( disk_write_block ( block->Chain->File->ActiveBlock, &errval ) )
goto edf_write_data_raw_error;
/* update ActiveBlock */
block->Chain->File->ActiveBlock = (DBlock *) NULL;
errval = RoutineSucceeded;
status = status_success;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
if (EDFIO_debug) printf("edf_write_data_raw END\n");
return;
edf_write_data_raw_error:
status=status_error;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
if (EDFIO_debug) {
printf("edf_write_data_raw: %s",edf_report_data_error ( errval ));
printf("edf_write_data_raw END (status=%d)\n",status);
}
return;
} /* edf_write_data_raw */
/*+++------------------------------------------------------------------------
NAME
edf_write_data --- Write n-dimensional machine data array
SYNOPSIS
void edf_write_data ( int stream, long DataNumber,
int DataChain, const long Dim[],
void *pData, int MachineType,
int * pErrorValue, int *pstatus );
DESCRIPTION
Searches for header 'DataNumber' in 'DataChain'. If it does not exists,
it is created.
Writes an n-dimensional MachineType data array as binary data after the
end of the header. MachineType is translated to the corresponding data type.
If this is not possible, the data is converted into another data type. The
data array is specified by Dim and MachineType. Default values are used for
DataValueOffset (0), ByteOrder (internal order) and RasterConfiguration (1).
All (non-default) informations are written into the header.
Parameters:
void *pData (i) pointer to the start of the data array
const long Dim[0] (i) N, number of dimensions
Dim[1] (i) dimension 1
Dim[2] (i) dimension 2
...
Dim[N] (i) dimension N
--------------------------------------------------------------------------+*/
void edf_write_data ( int stream, long DataNumber,
int DataChain, const long Dim[],
void *pData, int MachineType,
int * pErrorValue, int *pstatus ) /*---*/
{
int DataTypeOut;
int MachineTypeOut;
long DataValueOffsetOut = data_value_offset_out;
int ByteOrder = 0;
long RasterConfiguration = 1l;
void *DataOut = pData; // default
long DataCount;
void *tmp = (void *) NULL;
int errval, status;
if (EDFIO_debug) printf("edf_write_data BEGIN\n");
ByteOrder = byteorder();
/* get output data type */
if (data_type_out==InValidDType) {
/* do not convert */
DataTypeOut = edf_machinetype2datatype( MachineType );
MachineTypeOut = MachineType;
} else {
/* convert */
DataTypeOut = data_type_out;
/* get machine type of output data type */
MachineTypeOut = edf_datatype2machinetype( DataTypeOut );
}
/* get number of array elements */
DataCount = edf_dim_product ( Dim );
if (EDFIO_debug) {
edf_showmachinetypes( True );
printf("Save %s as %s (%s)\n",
MachineType2String( MachineType ),
edf_datatype2string( DataTypeOut ),
MachineType2String( MachineTypeOut) );
} // EDFIO_debug
if ( (MachineTypeOut!=MachineType) || (DataValueOffsetOut!=0l) ) {
/* allocate new memory */
if (!(tmp = malloc( edf_machine_sizeof(MachineTypeOut) * DataCount ) )) {
errval=CouldNotMallocMemory;
goto edf_write_data_error;
}
DataOut = tmp;
/* convert to MachineTypeOut */
if ( edf_machine2machine ( DataOut, MachineTypeOut,
pData, -DataValueOffsetOut,
MachineType, DataCount ) ) {
errval=DataConversionFailed;
goto edf_write_data_error;
}
} // if MachineTypeOut!=MachineType
edf_write_data_raw ( stream, DataNumber,
DataChain, Dim, DataOut, DataTypeOut,
DataValueOffsetOut, ByteOrder, RasterConfiguration,
&errval, &status );
if ( status != status_success )
goto edf_write_data_error;
/* free tmp array */
if (tmp) { free(tmp); tmp=(void *) NULL; }
errval=RoutineSucceeded;
status=status_success;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
if (EDFIO_debug) printf("edf_write_data END\n");
return;
edf_write_data_error:
if (tmp) { free(tmp); tmp=(void *) NULL; }
status = status_error;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
if (EDFIO_debug) {
printf("edf_write_data: %s",edf_report_data_error ( errval ));
printf("edf_write_data END (status=%d)\n",status);
}
return;
} /* edf_write_data */
/*+++------------------------------------------------------------------------
NAME
edf_read_header_line --- reads a line
SYNOPSIS
int edf_read_header_line ( int stream, long int DataNumber, int DataChain,
const char * keyword, char * Value,
int * pErrorValue, int * pstatus );
DESCRIPTION
Searches for 'keyword' in the header 'DataNumber' in 'DataChain'.
If the header or the keyword does not exists, the return value is 0 and a
specific error value is returned. This error is not fatal and can be used
as a test for the existence of the keyword or the header. The Value
string specified by keyword is copied after the location pointed to by
Value. The minimum allocated size for Value must be MaxValLen+1.
The function has not changed Value when the return value is 0.
RETURN VALUE
return value FALSE if not found and no other error
return( int ) FALSE : data header not found,
*pstatus = status_error;
*pErrorValue=(CouldNotFindHeader, RoutineSucceeded);
TRUE : data header found or error,
*pstatus = Success or status_error;
*pErrorValue = <any>
--------------------------------------------------------------------------+*/
int edf_read_header_line ( int stream, long int DataNumber, int DataChain,
const char * keyword, char * Value,
int * pErrorValue, int * pstatus ) /*---*/
{ const char *hstring;
*pErrorValue = RoutineSucceeded;
*pstatus = status_error;
if (!(read_header_string ( stream, DataNumber, DataChain,
keyword, &hstring, pErrorValue, pstatus ))) return(0);
if (*pstatus != status_success) return(1);
/* copy header value to output line value */
strncpy( Value, hstring, MaxLinLen );
Value[MaxLinLen] = '\0';
*pErrorValue = RoutineSucceeded;
*pstatus = status_success;
return(1);
} /* edf_read_header_line */
/*+++------------------------------------------------------------------------
NAME
edf_read_header_string --- reads a string from the header
SYNOPSIS
int edf_read_header_string ( int stream, long int DataNumber, int DataChain,
const char * keyword, const char ** pValue,
int * pErrorValue, int * pstatus );
DESCRIPTION
Searches for 'keyword' in the header 'DataNumber' in 'DataChain'.
If the header or the keyword does not exists, the return value is 0 and a
specific error value is returned. The returned String pointer is NULL.
This error is not fatal and can be used as a test for the existence of
the keyword or the header. In case of success *pValue points to an
internal character string that contains the concatenated string of all
continuation lines. Because the length of *pValue depends on the sum of
the lengths of all continuation lines its size is theoretically unlimited.
RETURN VALUE
In case of a failure the returned *pValue pointer can be NULL.
return value FALSE if not found and no other error,
return( int ) FALSE : data header not found,
*pstatus = status_error;
*pErrorValue=(CouldNotFindHeader, RoutineSucceeded);
TRUE : data header found or error,
*pstatus = Success or status_error;
*pErrorValue = <any>
--------------------------------------------------------------------------+*/
int edf_read_header_string ( int stream, long int DataNumber, int DataChain,
const char * keyword, const char ** String,
int * pErrorValue, int * pstatus ) /*---*/
{
*pErrorValue = RoutineSucceeded;
*pstatus = status_error;
if (!(read_header_string ( stream, DataNumber, DataChain,
keyword, String, pErrorValue, pstatus ))) return(0);
if (*pstatus != status_success) return(1);
*pErrorValue = RoutineSucceeded;
*pstatus = status_success;
return(1);
} /* edf_read_header_string */
/*+++------------------------------------------------------------------------
NAME
edf_read_header_float --- reads a float value
SYNOPSIS
int edf_read_header_float ( int stream, long int DataNumber, int DataChain,
const char * keyword, float * Value,
int * pErrorValue, int * pstatus );
DESCRIPTION
Searches for header 'DataNumber' in 'DataChain'.
In this headers it searches for 'keyword'. If the header or the keyword
do not exists, the return value is 0 and a specific error value
is returned. This error is not fatal and can be used as a test for the
existence of the keyword or the header.
A pointer to the float value specified by 'keyword' is returned
in 'Value'.
The function has not changed Value when the return value is 0.
RETURN VALUE
return value FALSE if not found and no other error
return( int ) FALSE : data header not found,
*pstatus = status_error;
*pErrorValue=(CouldNotFindHeader, RoutineSucceeded);
TRUE : data header found or error,
*pstatus = Success or status_error;
*pErrorValue = <any>
--------------------------------------------------------------------------+*/
int edf_read_header_float ( int stream, long int DataNumber, int DataChain,
const char * keyword, float * Value,
int * pErrorValue, int * pstatus ) /*---*/
{ const char *hstring;
int errval;
*pErrorValue = RoutineSucceeded;
*pstatus = status_error;
if (!(read_header_string ( stream, DataNumber, DataChain,
keyword, &hstring, pErrorValue, pstatus ))) return(0);
if (*pstatus != status_success) return(1);
/* copy header value to output float value */
*Value = ( float ) num_str2double( hstring, NULL, &errval );
if (errval) {
// num_errval2str( errbuf, errbuflen, errval ); ++++++++++ get details
*pErrorValue = NumberConversionFailed; *pstatus = status_error;
} else {
*pErrorValue = RoutineSucceeded; *pstatus = status_success;
}
return(1);
} /* edf_read_header_float */
/*+++------------------------------------------------------------------------
NAME
edf_read_header_long --- reads a long integer value
SYNOPSIS
int edf_read_header_long ( int stream, long int DataNumber, int DataChain,
const char * keyword, long int * Value,
int * pErrorValue, int * pstatus );
DESCRIPTION
Searches for header 'DataNumber' in 'DataChain'.
In this headers it searches for 'keyword'. If the header or the keyword
do not exists, the return value is 0 and a specific error value
is returned. This error is not fatal and can be used as a test for the
existence of the keyword or the header.
A pointer to the long int value specified by 'keyword' is returned
in 'Value'.
The function has not changed Value when the return value is 0.
RETURN VALUE
return value FALSE if not found and no other error
return( int ) FALSE : data header not found,
*pstatus = status_error;
*pErrorValue=(CouldNotFindHeader, RoutineSucceeded);
TRUE : data header found or error,
*pstatus = Success or status_error;
*pErrorValue = <any>
--------------------------------------------------------------------------+*/
int edf_read_header_long ( int stream, long int DataNumber, int DataChain,
const char * keyword, long int * Value,
int * pErrorValue, int * pstatus ) /*---*/
{ const char *hstring;
int errval;
*pErrorValue = RoutineSucceeded;
*pstatus = status_error;
if (!(read_header_string ( stream, DataNumber, DataChain,
keyword, &hstring, pErrorValue, pstatus ))) return(0);
if (*pstatus != status_success) return(1);
/* copy header value to long value */
*Value = num_str2long( hstring, NULL, &errval );
if (errval) {
// num_errval2str( errbuf, errbuflen, errval ); ++++++++++ get details
*pErrorValue = NumberConversionFailed; *pstatus = status_error;
} else {
*pErrorValue = RoutineSucceeded; *pstatus = status_success;
}
return(1);
} /* edf_read_header_long */
/*+++------------------------------------------------------------------------
NAME
edf_read_data_raw --- reads 2d data without type conversion
SYNOPSIS
void edf_read_data_raw ( int stream, long int DataNumber,
int DataChain, long **pDim,
size_t * pDataArraySize, void **ppData,
int * pDataType, long * pDataValueOffset,
int * pByteOrder, long * pRasterConfiguration,
int * pErrorValue, int * pstatus );
DESCRIPTION
Searches for header 'DataNumber' in 'DataChain'.
If it does not exist the routine stops with an error. A data array
with the dimension Data[(*pDim)[1],(*pDim)[2],...] is read from the
file. The pointer &&Data[0,0] is returned in ppData. The data type,
the data value offset, the byte order and the raster configuration
of the array are returned.
The returned array has a length of *pDataArraySize bytes.
The data buffer is allocated and must be released explicitly.
ARGUMENTS
(If memory allocated for the dimension array otherwise *pDim=0)
long (*pDim)[0] (i) number of dimensions N
(*pDim)[1] (o) dimension 1
(*pDim)[2] (o) dimension 2
...
(*pDim)[N] (o) dimension N
If the supplied *pDim is the NULL pointer a pointer to an allocated
dimension array is returned, otherwise the dimensions are copied
to the array (*pDim)[]. (*pDim)[0] must contain the dimension, e.g. 2
for a 2d data array. The dimension array must have N+1 elements, e.g.
3 elements for a 2d-array. The first element of the dimension array
defines always the number of dimensions and is not changed. Remaining
dimensions are set to 1. If the supplied dimension array is too
short an error is returned (NotNdData).
The internally allocated memory for (*pDim) is released automatically
during the next data-i/o or when the file is closed.
size_t * pDataArraySize (o) size of the data array in bytes
void ** pData (o) pointer to the pointer of the data array
long * pDataValueOffset (o) data value offset of the array elements
int * pDataType (o) data type of the array elements (DType)
HISTORY
23-Jul-1999 PB pDataValueOffset, pByteOrder and pRasterConfiguration added
29-Dec-2000 PB total redesign
--------------------------------------------------------------------------+*/
void edf_read_data_raw ( int stream, long int DataNumber,
int DataChain, long **pDim,
size_t * pDataArraySize, void **ppData,
int * pDataType, long * pDataValueOffset,
int * pByteOrder, long * pRasterConfiguration,
int * pErrorValue, int * pstatus ) /*---*/
{
DBlock * block;
int errval, status;
if (EDFIO_debug) printf("edf_read_data_raw BEGIN\n");
if ( open_read_block(stream, DataNumber, DataChain, &block, &errval ) )
goto edf_read_data_raw_error;
// read without conversion
read_data_array ( block, *ppData, *pDataArraySize, True, *pDim,
&errval, &status );
if ( status != status_success ) goto edf_read_data_raw_error;
if ( close_read_block( block, &errval ) )
goto edf_read_data_raw_error;
*pDataType = block->DataType;
*pDataValueOffset = block->DataValueOffset;
*pByteOrder = block->DataByteOrder;
*pRasterConfiguration = block->DataRasterConfiguration;
*ppData = block->Data;
if (!(*pDim)) *pDim = block->DataDim;
*pDataArraySize = block->DataBufferLen;
status = status_success;
errval = RoutineSucceeded;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
if (EDFIO_debug) printf("edf_read_data_raw END\n");
return;
edf_read_data_raw_error:
status = status_error;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
if (EDFIO_debug) printf("edf_read_data_raw END (status=%d)\n",status);
return;
} /* edf_read_data_raw */
/*+++------------------------------------------------------------------------
NAME
edf_read_data --- read data array and convert to MachineType
SYNOPSIS
void edf_read_data ( int stream, long DataNumber, int DataChain,
long **pDim, size_t * pDataArraySize,
void **ppData, int MachineType,
int * pErrorValue, int * pstatus );
DESCRIPTION
Searches for header 'DataNumber' in 'DataChain'.
If it does not exist the routine stops with an error.
A data array is read from the file and converted into a float array of
the type float Data[Dim[1],Dim[2]]. The data array is allocated.
The pointer &&Data[0,0] is returned in ppData.
If the stored array is only 1 dimensional, the data is read with
Dim[2] set to 1.
The data are read with the specification given in the header.
All read data values are converted into float and the returned data
array has a length of *pDataArraySize bytes.
The data buffer is allocated and must be released explicitly.
ARGUMENTS
(If memory allocated for the dimension array otherwise *pDim=0)
long (*pDim)[0] (i) number of dimensions N
(*pDim)[1] (o) dimension 1
(*pDim)[2] (o) dimension 2
...
(*pDim)[N] (o) dimension N
If the supplied *pDim is the NULL pointer a pointer to an allocated
dimension array is returned, otherwise the dimensions are copied
to the array (*pDim)[]. (*pDim)[0] must contain the dimension, e.g. 2
for a 2d data array. The dimension array must have N+2 elements, e.g.
4 elements for a 2d-array. The first element of the dimension array
defines always the number of dimensions and is not changed. Remaining
dimensions are set to 1. If the the supplied dimension array is too
short an error is returned (NotNdData).
The internally allocated memory for (*pDim) is released automatically
during the next data-i/o or when the file is closed.
size_t * pDataArraySize (o) size of the data array in bytes
float ** pData (o) pointer to the pointer of the data array
HISTORY
29-Dec-2000 PB total redesign
--------------------------------------------------------------------------+*/
void edf_read_data ( int stream, long DataNumber, int DataChain,
long **pDim, size_t * pDataArraySize,
void **ppData, int MachineType,
int * pErrorValue, int * pstatus ) /*---*/
{
DBlock * block;
int errval, status;
if (EDFIO_debug) printf("edf_read_data BEGIN\n");
if ( open_read_block(stream, DataNumber, DataChain, &block, &errval ) )
goto edf_read_data_error;
// read without conversion
read_data_array ( block, *ppData, *pDataArraySize, False, *pDim,
&errval, &status );
if ( status != status_success ) goto edf_read_data_error;
// conversion to MachineType
renorm_data_array ( block, *ppData, *pDataArraySize, MachineType,
&errval, &status );
if ( status != status_success ) goto edf_read_data_error;
*ppData = block->Data;
if (!(*pDim)) *pDim = block->DataDim;
*pDataArraySize = block->DataBufferLen;
if ( close_read_block( block, &errval ) )
goto edf_read_data_error;
status = status_success;
errval = RoutineSucceeded;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
if (EDFIO_debug) printf("edf_read_data END\n");
return;
edf_read_data_error:
status = status_error;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
if (EDFIO_debug) printf("edf_read_data END (status=%d)\n",status);
return;
} /* edf_read_data */
/*+++------------------------------------------------------------------------
NAME
edf_search_minmax_number
SYNOPSIS
int edf_search_minmax_number( int stream, int DataChain,
long int *pMinNumber, long int * pMaxNumber,
int *pErrorValue, int *pstatus)
DESCRIPTION
Reads the headers in 'DataChain'
and searches for the minimum and maximum data number.
int DataChain (i) : data chain (0: general, 1: key_1, 2: key_2)
long int * pMinNumber (o) : minimum data number
long int * pMaxNumber (o) : maximum data number
int *pErrorValue (o) : error value
int *pstatus (o) : SAXS status
RETURN VALUE
TRUE : successful
FALSE : failed
--------------------------------------------------------------------------+*/
int edf_search_minmax_number( int stream, int DataChain,
long int *pMinNumber, long int * pMaxNumber,
int *pErrorValue, int *pstatus) /*---*/
{ DBlock * block;
DChain * chain;
DFile * file;
int ErrorValue = RoutineSucceeded, status = status_error;
char *min = (char *) NULL, *max = (char *) NULL;
char ChainKey[MaxKeyLen+1];
if (EDFIO_debug) printf("edf_search_minmax_number BEGIN\n");
*pMinNumber = -1l; *pMaxNumber = -2l;
/* check stream */
if ((stream<0)||(stream>=MaxFiles)) {
*pErrorValue = InvalidStream;
goto edf_search_minmax_number_error;
}
/* get file */
file = &FileTable[stream];
if ( !file->Used ) {
ErrorValue = NoFileOpen;
goto edf_search_minmax_number_error;
}
/* find 'ChainKey' */
if ( find_chainkey ( stream, DataChain, ChainKey ) ) {
ErrorValue = MissingKeyDefinition;
goto edf_search_minmax_number_error;
}
/* search chain */
if (search_data_chain( file, ChainKey, &chain) ) {
ErrorValue = CouldNotFindHeader;
goto edf_search_minmax_number_error;
}
/* loop over all blocks */
block = chain->BlockList;
if ( block ) {
min = max = block->BlockKey;
block = block->Next;
while ( block ) {
if ( compare_keys( block->BlockKey, min , NumberSort ) < 0 ) {
min = block->BlockKey; }
else if ( compare_keys( block->BlockKey, max , NumberSort ) > 0 ) {
max = block->BlockKey; }
block = block->Next;
} /* while */
*pMinNumber = (long int) s2u_long( min );
*pMaxNumber = (long int) s2u_long( max );
} else {
ErrorValue = NoDataBlocksFound;
goto edf_search_minmax_number_error;
}
ErrorValue = RoutineSucceeded;
status = status_success;
if (pErrorValue) *pErrorValue = ErrorValue;
if (pstatus) *pstatus = status;
if (EDFIO_debug) printf("edf_search_minmax_number END (status=%d)\n",status);
return(1);
edf_search_minmax_number_error:
if (pErrorValue) *pErrorValue = ErrorValue;
if (pstatus) *pstatus = status;
if (EDFIO_debug) printf("edf_search_minmax_number END (status=%d)\n",status);
return(0);
} /* edf_search_minmax_number */
/*+++------------------------------------------------------------------------
NAME
edf_read_data_dimension
SYNOPSIS
int edf_read_data_dimension ( int stream, long int DataNumber,
int DataChain, long ** pDim,
size_t * pDataArraySize,
int * pErrorValue, int * pstatus )
DESCRIPTION
Searches for header 'DataNumber' in 'DataChain'
and inquires for the dimension of the two dimensional data array.
If the header or the dimension of the data array does not exist,
the return value is FALSE and a specific error value is returned.
This error is not fatal and can be used as a test for the
existence of a header.
ARGUMENTS
long int DataNumber (i) : data number
int DataChain (i) : data chain (0: general, 1: key_1, 2: key_2)
If memory is allocated for the dimension array otherwise *pDim=0
long (*pDim)[0] (i) : number of dimensions N
(*pDim)[1] (o) : dimension 1
(*pDim)[2] (o) : dimension 2
...
(*pDim)[N] (o) : dimension N
If the supplied *pDim is the NULL pointer a pointer to an allocated
dimension array is returned, otherwise the dimensions are copied
to the array (*pDim)[]. (*pDim)[0] must contain the dimension, e.g. 2
for a 2d data array. The dimension array must have N+2 elements, e.g.
4 elements for a 2d-array. The first element of the dimension array
defines always the number of dimensions and is not changed. Remaining
dimensions are set to 1. If the supplied dimension array is too
short an error is returned (NotNdData).
The internally allocated memory for (*pDim) is released automatically
during the next data-i/o or when the file is closed. Attention, it is
also released when the actual data is read.
size_t * pDataArraySize (o) : size of the raw data array in bytes
int *pErrorValue (o) : error value
int *pstatus (o) : SAXS status
RETURN VALUE
TRUE : data header found, if *pstatus == Success
FALSE : data header not found,
*pstatus == status_error;
*pErrorValue == CouldNotFindHeader;
HISTORY
--------------------------------------------------------------------------+*/
int edf_read_data_dimension ( int stream, long int DataNumber,
int DataChain, long ** pDim,
size_t * pDataArraySize,
int * pErrorValue, int * pstatus ) /*---*/
{
DBlock * block;
long * data_dim;
size_t data_len;
int errval, status;
if (EDFIO_debug) printf("edf_read_data_dimension BEGIN\n");
switch ( open_read_block (stream, DataNumber, DataChain,
&block, &errval) ) {
case 1: goto edf_read_data_dimension_notfound;
case -1: goto edf_read_data_dimension_error;
}
/* get dimension */
if ( ! (data_dim = get_data_dim ( block )) ) {
errval = CouldNotReadDimension;
goto edf_read_data_dimension_error;
}
data_len = edf_dim_product(data_dim)*edf_data_sizeof(get_data_type(block));
*pDataArraySize = data_len;
/* copy data_dim to *pDim */
if (*pDim) { // use supplied buffer
if ( !(copydim( *pDim, (*pDim)[0], data_dim ) ) ) {
errval = NotNdData;
goto edf_read_data_dimension_error;
}
} else { // use allocated buffer
*pDim = data_dim;
}
/* update DataDim array */
if (block->DataDim) { // copy dimensions into existing array
if ( !(copydim( block->DataDim, block->DataDim[0], data_dim ) ) ) {
errval = NotNdData;
goto edf_read_data_dimension_error;
}
} else { // use allocated buffer
block->DataDim = data_dim;
}
if ( close_read_block( block, &errval ) )
goto edf_read_data_dimension_error;
errval = RoutineSucceeded;
status = status_success;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
if (EDFIO_debug) printf("edf_read_data_dimension END\n");
return(1);
edf_read_data_dimension_notfound:
status = status_error;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
if (EDFIO_debug) {
printf("edf_read_data_dimension: %s",edf_report_data_error ( errval ));
printf("edf_read_data_dimension END (status=%d)\n",status);
}
return(0);
edf_read_data_dimension_error:
status = status_error;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
if (EDFIO_debug) {
printf("edf_read_data_dimension: %s",edf_report_data_error ( errval ));
printf("edf_read_data_dimension END (status=%d)\n",status);
}
return(1);
} /* edf_read_data_dimension */
/*+++------------------------------------------------------------------------
NAME
edf_test_header --- test, whether a header exists
SYNOPSIS
int edf_test_header ( int stream, long DataNumber,
int DataChain,
int *pErrorValue, int *pstatus );
DESCRIPTION
Searches for header 'DataNumber' in 'DataChain'. Returns only 1
if it was found, otherwise it returns 0.
--------------------------------------------------------------------------+*/
int edf_test_header ( int stream, long DataNumber,
int DataChain,
int *pErrorValue, int *pstatus ) /*---*/
{
DFile * file;
DChain * chain;
DBlock * block;
int ErrorValue = RoutineSucceeded, status = status_error;
int found = 0;
char BlockKey[MaxKeyLen+1];
char ChainKey[MaxKeyLen+1];
if (EDFIO_debug) printf("edf_test_header BEGIN\n");
/* check stream */
if ((stream<0)||(stream>=MaxFiles)) {
*pErrorValue = InvalidStream;
goto edf_test_header_error;
}
/* get file */
file = &FileTable[stream];
if ( !file->Used ) {
ErrorValue = NoFileOpen;
goto edf_test_header_error;
}
/* find 'ChainKey' */
if ( find_chainkey ( stream, DataChain, ChainKey ) ) {
ErrorValue = MissingKeyDefinition;
goto edf_test_header_error;
}
/* find 'BlockKey' */
if ( find_blockkey ( DataChain, DataNumber, BlockKey ) ) {
ErrorValue = MissingKeyDefinition;
goto edf_test_header_error;
}
status = status_success;
/* search header */
if ( (!search_data_chain( file, ChainKey, &chain) )
&& (!search_data_block( chain, BlockKey, &block) ) ) found = 1;
if (pErrorValue) *pErrorValue = ErrorValue;
if (pstatus) *pstatus = status;
if (EDFIO_debug) printf("edf_test_header END %d\n",found);
return(found);
edf_test_header_error:
if (pErrorValue) *pErrorValue = ErrorValue;
if (pstatus) *pstatus = status;
if (EDFIO_debug) printf("edf_test_header END (status=%d)\n",status);
return(found);
} /* edf_test_header */
/*===keyorder BEGIN=======================================================*/
/*+++ public interface of keyorder -----------------------------------------
HISTORY
2001-11-25 V1.0 Peter Boesecke
PUBLIC extern void
edf_keyorder_set_table ( const char * table[] ),
edf_keyorder_print_table ( FILE * out );
The following routines are only used in edfio.c
PRIVATE SElement **
keyorder_ordersymbols ( DBlock * block );
PRIVATE int
keyorder_first_header_element ( HList * header, HElement ** element ),
keyorder_next_header_element ( HList * header, HElement ** element );
---------------------------------- end of public interface of keyorder ---*/
/****************************************************************************
* Static Variables *
****************************************************************************/
static int keyorder_Debug = 0;
//static const char * keyorder_DefaultTable[] = { (const char *) NULL };
static const char * keyorder_DefaultTable[] = { "ByteOrder",
"DataType", "DataRasterConfiguration", "Dim_*", "Title", "Time",
"Intensity*", "ExposureTime", "Dummy", "DDummy", "Offset_*",
"Center_*", "BSize_*", "PSize_*", "Sample*", "WaveLength",
"DetectorRotation_*", "Projection*", "Raster*", "AxisType_*",
"Norm*", "Attenuator*", "Detector*", "Experiment*", "Gestion*",
"Machine*", "Monitor*", "Msensi*", "Optics*", "Proposal*", "Psic*",
"Session*", "Pslit*", "Slit*", "Station*", "History-*",
"HS32*", "H*",
(const char *) NULL };
static const char ** keyorder_KeyOrderTable = keyorder_DefaultTable;
/*--------------------------------------------------------------------------
NAME
keyorder_setkeyordertable --- defines a key order table
SYNOPSIS
void keyorder_setkeyordertable( const char * keyordertable[] )
DESCRPTION
Redefines the internal order table by keyordertable. The table must be a list
of key words and the last element of the table must be a (char *) NULL. The
key words can be terminated by the wild card character '*'. In this case,
all keywords starting with the characters before the wild card will be
ordered in alphabetical order.
-----------------------------------------------------------------------------*/
void keyorder_setkeyordertable( const char * keyordertable[] )
{ keyorder_KeyOrderTable = keyordertable;
} // keyorder_setkeyordertable
/*--------------------------------------------------------------------------
NAME
keyorder_debug --- set / reset module keyorder into debug mode
SYNOPSIS
void keyorder_debug ( int debug );
DESCRPTION
Writes debug into keyorder_debug.
-----------------------------------------------------------------------------*/
void keyorder_debug ( int debug )
{ keyorder_Debug = debug;
} // keyorder_debug
/*--------------------------------------------------------------------------
NAME
void keyorder_print_keyordertable ( FILE * out ) --- print order key table
SYNOPSIS
void keyorder_print_keyordertable ( FILE * out );
DESCRPTION
Prints the internal order key table.
-----------------------------------------------------------------------------*/
void keyorder_print_keyordertable ( FILE * out )
{ const char **pkeyorder=keyorder_KeyOrderTable;
int i;
if (!pkeyorder) pkeyorder = keyorder_DefaultTable;
i=0;
while (*pkeyorder) {
printf("keyorder_DefaultTable[%u] = %s\n", i++,*pkeyorder);
pkeyorder++;
}
return;
} // keyorder_print_keyordertable
/*---------------------------------------------------------------------------
NAME
keyorder_next_header_element_wild -- searches for next keyorder in header
SYNOPSIS
int keyorder_next_header_element_wild( HList * header,
const char * keyorder,
HElement ** element )
DESCRIPTION
Searches the first header element matching keyorder. keyorder can
terminate with '*' as a wild card.
RETURN VALUE
keyorder found, element pointer returned in **element
keyorder pointer (HElement *) NULL returned in **element
return value 0: OK, -1 : ERROR
---------------------------------------------------------------------------*/
int keyorder_next_header_element_wild( HList * header,
const char * keyorder,
HElement ** element )
{ HElement * current;
/* return NULL in case that header was not found */
*element = (HElement *) NULL;
/* stop, if header not defined */
if ( !header ) return(-1);
/* search element */
current = header->ElementRoot;
while ( current!=(HElement *) NULL ) {
if ( !(current->Flags.Read) ) {
if (!keyorder) {
current->Flags.Read = True; break;
}
if ( ( keyorder_compare( current->Key, keyorder ) ) == 0 ) {
current->Flags.Read = True; break;
}
}
current = current->Next;
}
*element = current;
return( 0 );
} // keyorder_next_header_element_wild
/*---------------------------------------------------------------------------
NAME
keyorder_clear_header_element_readflag -- clears all read flags
SYNOPSIS
int keyorder_clear_header_element_readflag( HList * header );
DESCRIPTION
Clears the read flags of all header elements of header
RETURN VALUE
0, if OK
-1 if not OK
---------------------------------------------------------------------------*/
int keyorder_clear_header_element_readflags( HList * header )
{
HElement * current;
/* stop, if header not defined */
if ( !header ) return(-1);
current = header->ElementRoot;
while ( current!=(HElement *) NULL ) {
current->Flags.Read = False;
current = current->Next;
}
return(0);
} // keyorder_clear_header_element_readflag
/*---------------------------------------------------------------------------
NAME
keyorder_first_header_element -- searches first element in header list
SYNOPSIS
int keyorder_first_header_element( HList * header, HElement ** element )
DESCRIPTION
Returns the first header element according to KeyOrderTable. The following
header elements must be read with keyorder_next_header_element
The function clears the Read flags of all header elements and resets
the KeyOrderNo of header.
RETURN VALUE
first element found, element pointer returned in **element
no element found, (HElement *) NULL returned in **element
--------------------------------------------------------------------------*/
int keyorder_first_header_element( HList * header, HElement ** element )
{
/* return NULL in case that header was not found */
*element = (HElement *) NULL;
/* stop, if header not defined */
if ( !header ) return(-1);
keyorder_clear_header_element_readflags( header );
/* return NULL in case that header was not found */
*element = (HElement *) NULL;
header->KeyOrderNo = 0;
do {
keyorder_next_header_element_wild( header,
keyorder_KeyOrderTable[header->KeyOrderNo], element );
if ( (*element!=(HElement *) NULL) ) break;
} while ( (keyorder_KeyOrderTable[header->KeyOrderNo++]) );
return(0);
} // keyorder_first_header_element
/*---------------------------------------------------------------------------
NAME
keyorder_next_header_element -- returns next element in header list
SYNOPSIS
int keyorder_next_header_element( HList * header, HElement ** element )
DESCRIPTION
Returns the next header element according to KeyOrderTable.
The first element must be read with keyorder_first_header_element.
RETURN VALUE
first element found, element pointer returned in **element
no element found, (HElement *) NULL returned in **element
---------------------------------------------------------------------------*/
int keyorder_next_header_element( HList * header, HElement ** element )
{
/* return NULL in case that header was not found */
*element = (HElement *) NULL;
/* stop, if header not defined */
if ( !header ) return(-1);
do {
keyorder_next_header_element_wild( header,
keyorder_KeyOrderTable[header->KeyOrderNo], element );
if ( (*element!=(HElement *) NULL) ) break;
} while ( (keyorder_KeyOrderTable[header->KeyOrderNo++]) );
return(0);
} // keyorder_next_header_element
/*---------------------------------------------------------------------------
NAME
keyorder_strcolup --- converts a string to upper case and removes spaces
SYNOPSIS
char * keyorder_strcolup( char buffer[], unsigned long buflen,
const char * string )
DESCRIPTION
Copies all printable characters except space to buffer and converts them
to upper case.
RETURN VALUES
Pointer to buffer
HISTORY
Peter Boesecke
---------------------------------------------------------------------------*/
char * keyorder_strcolup( char buffer[], unsigned long buflen,
const char * string )
{ register unsigned int i;
char *pc;
pc = &buffer[0];
if (string)
for (i=0;(i<(buflen-1))&&(*string);i++) {
if (isgraph(*string)) { *pc=toupper(*string); pc++; }
string++;
}
*pc=(char) 0;
return( buffer );
} // keyorder_strcolup
/*---------------------------------------------------------------------------
NAME
keyorder_wildcmp --- compares a key with a wild card key
SYNOPSIS
int keyorder_wildcmp( const char *key, const char *wild );
DESCRIPTION
The routines compares the characters of wild with the characters of key.
If '*' is found in wild the comparison of the remaining characters in
key is skipped until the first character after '*' is found in key. There,
the comparison is continued. However, the function may not return the
expected result if '*' is not the last character in wild and if key
contains several times the character after '*', e.g.
key="abcabc", wild = "abcabc" -> 0
key="abcabc", wild = "abc*" -> 0
key="abcabc", wild = "*abc" -> 1 comparison is stopped after the first
occurrence of abc
key="abcabc", wild = "*abc*" -> 0
key="abcabc", wild = "*cabc" -> 0
RETURN VALUES
The routine returnes as result:
input output
key < wild -1
key = wild 0
key > wild +1
HISTORY
Peter Boesecke
---------------------------------------------------------------------------*/
int keyorder_wildcmp( const char *key1, const char *key2 )
{ const char *pc1, *pc2;
int value=0;
if ((!key1) || (!key2) ) {
if (key2) return(-1); else { if (key1) return(1); else return(0); }
}
pc1 = key1; pc2 = key2;
value=0;
do {
if ((*pc2)=='*') { // wild card
do pc2++; while ((*pc2)=='*'); // get first character after wild cards
while ((*pc1)!=(*pc2)) {
if (*pc1) pc1++;
else break;
}
}
if (*pc2) {
if ( (*pc1)!=(*pc2) ) {
if ( (*pc1)<(*pc2) ) value=-1; else value=1;
}
} else {
if (*pc1) value=1;
}
} while ( (*pc1++) && (*pc2++) );
return( value );
} // keyorder_wildcmp
/*---------------------------------------------------------------------------
NAME
keyorder_compare --- compares a key with a criterion card key
SYNOPSIS
int keyorder_compare( const char *key, const char *criterion );
DESCRIPTION
The comparison is done for printable characters only, except spaces. Other
characters are suppressed. The comparison is done for a maximum of MaxKeyLen
characters (including all characters, printable and non-printable). The
comparison is not case sensitive and is done after conversion of all
characters to upper-case. If the criterion key contains a '*' the
comparison is stopped a this position
RETURN VALUES
The routine returnes as result:
input output
key < criterion -1
key = criterion 0
key > criterion +1
HISTORY
Peter Boesecke
---------------------------------------------------------------------------*/
PRIVATE int keyorder_compare( const char *key, const char *criterion )
{ char buf1[MaxKeyLen+1], buf2[MaxKeyLen+1];
/* convert to upper case */
keyorder_strcolup( buf1, MaxKeyLen+1, key );
keyorder_strcolup( buf2, MaxKeyLen+1, criterion );
/* compare */
return(keyorder_wildcmp( buf1, buf2 ));
} /* keyorder_compare */
//==============================================================================
/*---------------------------------------------------------------------------
NAME
keyorder_clear_symbol_readflag -- clears all symbol read flags
SYNOPSIS
int keyorder_clear_symbol_readflag( DBlock * block,
unsigned long * ptablelen );
DESCRIPTION
Clears the read flags of all symbols in block and returns the
total number of keys in *ptablelen.
Must be called before using keyorder_copy_formatsymbols,
keyorder_next_symbol_wild and keyorder_next_symbol
RETURN VALUE
0, if OK
-1 if not OK
---------------------------------------------------------------------------*/
int keyorder_clear_symbol_readflags( DBlock * block,
unsigned long * ptablelen )
{
SElement * current;
*ptablelen = 0l;
if ( !block ) return(-1);
current = block->SymbolList;
while ( current!=(SElement *) NULL ) {
current->Flags.Read = False;
current = current->Next;
(*ptablelen)++;
}
block->KeyOrderNextSymbol = block->SymbolList;
block->KeyOrderNo = 0;
return(0);
} // keyorder_clear_symbol_readflags
/*---------------------------------------------------------------------------
NAME
keyorder_copy_formatsymbols -- copies all data format symbols
SYNOPSIS
int keyorder_copy_formatsymbols( DBlock * block,
SElement *** ptable );
DESCRIPTION
Copies all data format specific symbol pointers of block to *ptable[i].
After return *ptable points after the copied format symbols.
RETURN VALUE
0, if OK
-1 if not OK
---------------------------------------------------------------------------*/
int keyorder_copy_formatsymbols( DBlock * block, SElement *** ptable )
{
SElement * current;
if ( !block ) return(-1);
current = block->KeyOrderNextSymbol;
while ( ( current!=(SElement *) NULL ) &&
(is_prefix(current->Key,DATA_FORMAT_PREFIX,UpperCaseSort)) ) {
*(*ptable) = current; (*ptable)++;
current->Flags.Read = True;
current = current->Next;
}
block->KeyOrderNextSymbol = current;
return(0);
} // keyorder_copy_formatsymbols
/*---------------------------------------------------------------------------
NAME
keyorder_next_symbol_wild -- searches for next keyorder in block
SYNOPSIS
int keyorder_next_symbol_wild( DBlock * block,
const char * keyorder,
SElement ** symbol )
DESCRIPTION
Searches the first symbol matching keyorder. keyorder can terminate
with '*' as a wild card.
To increase the speed in long lists the search starts at
block->KeyOrderNextSymbol which is the first symbol that has not already
been read. First, block->KeyOrderNextSymbol is updated. Then the search
is started. The first symbol that matches keyorder and that has not
already been read.
RETURN VALUE
keyorder found, symbol pointer returned in **symbol
keyorder pointer (HElement *) NULL returned in **symbol
return value 0: OK, -1 : ERROR
---------------------------------------------------------------------------*/
int keyorder_next_symbol_wild( DBlock * block,
const char * keyorder,
SElement ** symbol )
{ SElement * current;
/* reset symbol */
*symbol = (SElement *) NULL;
/* stop, if block not defined */
if ( !block ) return(-1);
/* get start point */
current = block->KeyOrderNextSymbol;
/* skip already read symbols */
while ( ( current!=(SElement *) NULL ) && (current->Flags.Read) ) {
current = current->Next;
}
/* set new start point */
block->KeyOrderNextSymbol = current;
/* search symbol */
while ( current!=(SElement *) NULL ) {
if ( !(current->Flags.Read) ) {
if (!keyorder) {
current->Flags.Read = True; break;
}
if ( ( keyorder_compare( current->Key, keyorder ) ) == 0 ) {
current->Flags.Read = True; break;
}
}
current = current->Next;
}
*symbol = current;
return( 0 );
} // keyorder_next_symbol_wild
/*---------------------------------------------------------------------------
NAME
keyorder_next_symbol -- returns next symbol
SYNOPSIS
int keyorder_next_symbol( DBlock * block, SElement ** symbol )
DESCRIPTION
Returns the next symbol according to KeyOrderTable.
The first symbol must be read with keyorder_first_symbol.
RETURN VALUE
next symbol found, symbol pointer returned in **symbol
no symbol found, (SElement *) NULL returned in **symbol
---------------------------------------------------------------------------*/
int keyorder_next_symbol( DBlock * block, SElement ** symbol )
{
/* reset symbol */
*symbol = (SElement *) NULL;
/* stop, if block not defined */
if ( !block ) return(-1);
do {
keyorder_next_symbol_wild( block,
keyorder_KeyOrderTable[block->KeyOrderNo], symbol );
if ( (*symbol!=(SElement *) NULL) ) break;
} while ( (keyorder_KeyOrderTable[block->KeyOrderNo++]) );
return(0);
} // keyorder_next_symbol
/*---------------------------------------------------------------------------
NAME
keyorder_ordersymbols --- return a table with symbols in order
SYNOPSIS
SElement ** keyorder_ordersymbols( DBlock * block )
DESCRIPTION
Returns a table that lists pointers to the user symbols of block according to
keyorder_KeyOrderTable. The table is terminated with an empty element
(SElement*) NULL. The table must be released after use.
RETURN VALUES
The routine returnes as result:
(SElement **) NULL: error otherwise, pointer to allocated ordered symbol table
HISTORY
Peter Boesecke
---------------------------------------------------------------------------*/
PRIVATE SElement ** keyorder_ordersymbols( DBlock * block )
{ SElement * symbol, ** table = (SElement **) NULL, ** ptable;
unsigned long tablelen;
if ( keyorder_clear_symbol_readflags( block, &tablelen ) )
return( table );
table = (SElement **) malloc ( (tablelen+1) * sizeof(SElement **) );
if (!table) return( table );
ptable = table;
// copy all format symbols into table
keyorder_copy_formatsymbols( block, &ptable );
// search first user symbol
keyorder_next_symbol( block, &symbol );
while ( symbol ) {
// save symbol pointer in table
*ptable = symbol; ptable++;
// search next symbol
keyorder_next_symbol( block, &symbol );
}
*ptable = (SElement *) NULL;
return( table );
} /* keyorder_ordersymbols */
/*+++------------------------------------------------------------------------
NAME
edf_keyorder_set_table --- sets a new order key table
SYNOPSIS
void edf_keyorder_set_table( const char * table[] )
DESCRIPTION
This function defines a new order key table. The table contains
all keys in the order in what they should be written. The table must be
terminated with (char *) NULL. Keys that are not found in the table are
listed after the keys that have been found. An asterisk at the end of a
key in the table is a wild card.
HISTORY
2001-11-24 Peter Boesecke
--------------------------------------------------------------------------+*/
void edf_keyorder_set_table( const char * table[] )
{ keyorder_setkeyordertable( table );
} /* edf_keyorder_set_table */
/*+++------------------------------------------------------------------------
NAME
edf_keyorder_print_table --- prints the order key table
SYNOPSIS
void edf_keyorder_print_table( FILE * out )
DESCRIPTION
The order key table is printed to out.
HISTORY
2001-11-24 Peter Boesecke
--------------------------------------------------------------------------+*/
void edf_keyorder_print_table( FILE * out )
{ keyorder_print_keyordertable ( out );
} /* edf_keyorder_print_table */
/*===keyorder END=======================================================---*/
/*===header_list BEGIN=====================================================*/
/*+++ public interface of header_list ---------------------------------------
DESCRIPTION
The routines of this module are used to read and write header lines.
'edf_new_header' must be called first. Opens a header with header_key.
'edf_read_header' reads the header from the input image
'edf_write_header' writes the header to the output image
'edf_first_header_element' returns key and value of the first header element
'edf_next_header_element' returns key and value of the next header element
'edf_search_header_element' returns value of header element
'edf_add_header_element' adds or replaces a header element
'edf_delete_header_element' deletes a header element
'edf_free_header' releases a specific or all header keys.
'header_debug' sets the module into debug mode.
The values of header_list do not contain escape sequences.
HISTORY
2000-12-31 PB
2001-11-25 PB edf_first_header_element, edf_next_header_element
PUBLIC extern int
edf_new_header ( const char * header_key ),
edf_read_header ( int stream, long int DataNumber,
int DataChain, const char * header_key,
int * pErrorValue, int * pstatus ),
edf_write_header ( int stream, long int DataNumber,
int DataChain, const char * header_key,
int * pErrorValue, int * pstatus ),
edf_first_header_element ( const char * header_key,
const char ** pkey, const char ** pvalue,
int * pErrorValue, int * pstatus ),
edf_next_header_element ( const char * header_key,
const char ** pkey, const char ** pvalue,
int * pErrorValue, int * pstatus ),
edf_search_header_element( const char * header_key,
const char * key, const char ** pvalue,
int * pErrorValue, int * pstatus ),
edf_add_header_element ( const char * header_key,
const char * key, const char * value,
int * pErrorValue, int * pstatus ),
edf_delete_header_element( const char * header_key,
const char * key,
int * pErrorValue, int * pstatus ),
edf_free_header ( const char * header_key ),
edf_print_header ( FILE * out, const char * header_key,
int level, int verbose );
PUBLIC extern void
header_debug ( int debug );
------------------------------ end of public interface of header_list ---*/
/****************************************************************************
* Static Variables *
****************************************************************************/
static int InitHeader = 0;
static HList * header_root = (HList *) NULL;
static int HEADER_debug = 0;
/*---------------------------------------------------------------------------
NAME
init_header()
SYNOPSIS
DESCRIPTION
RETURN VALUES
Returns 0 in case of success and -1 if no success.
---------------------------------------------------------------------------*/
int init_header( void )
{ header_root = (HList *) NULL;
InitHeader = 1;
return(0);
} /* init_header */
/*+++------------------------------------------------------------------------
NAME
free_header_list (success:0, error:-1)
SYNOPSIS
int free_header_list( HList * header )
DESCRIPTION
Frees the element list of header.
RETURN VALUE
0: success
-1: failed
---------------------------------------------------------------------------*/
int free_header_list( HList * header )
{
HElement * element, * next;
if (header==(HList *)NULL) return(-1);
next = header->ElementRoot;
while(next!=(HElement*) NULL) {
element = next;
next=next->Next;
free(element->Value);
free(element->Key);
free(element);
}
header->ElementRoot = (HElement *) NULL;
return(0);
} /* free_header_list */
/*---------------------------------------------------------------------------
NAME
search_header_list
SYNOPSIS
int search_header_list ( HList * root, const char * header_key,
HList ** pheader )
DESCRIPTION
Searches the key 'header_key' in the header list and returns the pointer
to the header (*pheader) or NULL if not found.
RETURN VALUES
Returns 0 if found and -1 if no success.
---------------------------------------------------------------------------*/
int search_header_list ( HList * root, const char * header_key,
HList ** pheader )
{
HList * previous, * next;
int notfound = 1;
*pheader = (HList *) NULL;
/* search for header_key */
previous = (HList *) NULL;
next = root;
if (root == (HList*) NULL) return(-1);
/* search insertion point (insertion before next) */
while( ( next!=(HList *) NULL ) && (notfound>0) ) {
notfound = compare_keys(next->Key,header_key,UpperCaseSort);
if (notfound>0) {previous = next; next = next->Next;}
}
if (!notfound) *pheader = next;
return(0);
} /* search_header_list */
/*---------------------------------------------------------------------------
NAME
header_list_new
SYNOPSIS
int header_list_new ( HList ** proot, const char * header_key,
HList ** pheader );
DESCRIPTION
Adds a new header list with the key 'header_key' to the header list
If the key already exists, the existing elements are removed.
The key list is ordered in reverse alphabetical order.
RETURN VALUES
Returns 0 in case of success and -1 if no success.
---------------------------------------------------------------------------*/
int header_list_new ( HList ** proot, const char * header_key,
HList ** pheader )
{
HList * newhlist, * previous, * next;
int notfound = 1;
/* search for header_key */
previous = (HList *) NULL;
next = *proot;
*pheader = (HList *) NULL;
/* search insertion point (insertion before next) */
while( ( next!=(HList *) NULL ) && (notfound>0) ) {
notfound = compare_keys(next->Key,header_key,UpperCaseSort);
if (notfound>0) {previous = next; next = next->Next;}
}
if (notfound) {
/* create new hlist */
if (!(newhlist = (HList *) malloc(sizeof(HList)))) return(-1);
newhlist->Key = newstr(header_key); if (!newhlist->Key) return(-1);
newhlist->ElementRoot = (HElement *) NULL;
newhlist->KeyOrderNo = 0;
/* insert newhlist before next */
if (next) next->Previous = newhlist;
newhlist->Next=next;
newhlist->Previous=previous;
if (previous) previous->Next=newhlist;
else *proot = newhlist;
next = newhlist;
}
/* free next->ElementRoot */
if ( next->ElementRoot ) {
free_header_list( next );
}
*pheader = next;
return(0);
} /* header_list_new */
/*---------------------------------------------------------------------------
NAME
header_list_free
SYNOPSIS
int header_list_free ( HList ** proot );
DESCRIPTION
Removes all header lists from proot.
RETURN VALUES
Returns 0 in case of success and -1 if no success.
---------------------------------------------------------------------------*/
int header_list_free ( HList ** proot )
{
HList *current, * next;
/* search for header_key */
next = *proot;
while( next!=(HList *) NULL ) {
current = next;
next = next->Next;
free_header_list( current );
free( current );
}
*proot = next;
return(0);
} /* header_list_free */
/*---------------------------------------------------------------------------
NAME
header_list_remove
SYNOPSIS
int header_list_remove ( HList ** proot, const char * header_key );
DESCRIPTION
Removes header_key from proot.
RETURN VALUES
Returns 0 in case of success and -1 if no success.
---------------------------------------------------------------------------*/
int header_list_remove ( HList ** proot, const char * header_key )
{
HList *current, *previous, *next;
/* search for header_key */
if (search_header_list ( *proot, header_key, &next )) return(-1);
if ( next!=(HList *) NULL ) { // remove current
current = next;
previous = current->Previous;
next = current->Next;
if (next) next->Previous = previous;
if (previous) previous->Next = next;
else *proot = next;
free_header_list( current );
free ( current );
}
return(0);
} /* header_list_remove */
/*---------------------------------------------------------------------------
NAME
init_header_element_flags --- initialize header element flags
SYNOPSIS
init init_header_element_flags( HEFlags * Flags )
RETURN VALUE
success: 0
error: not 0
---------------------------------------------------------------------------*/
int init_header_element_flags( HEFlags * Flags )
{
Flags->Read = (unsigned short) 0;
return(0);
} /* init_header_element_flags */
/*---------------------------------------------------------------------------
print_header_element_flags (success:0, error:-1)
---------------------------------------------------------------------------*/
int print_header_element_flags ( FILE * out, const HEFlags * Flags )
{
fprintf(out," Flags\n");
fprintf(out," Read = %hu\n",Flags->Read);
return(0);
} /* print_header_element_flags */
/*---------------------------------------------------------------------------
insert_header_element (success:0, error:-1)
If 'Key' already exists, its 'Value' is updated, otherwise it is created.
In case of success the pointer to the new element is returned.
---------------------------------------------------------------------------*/
int insert_header_element( HList * header, const char * Key,
const char * Value , HElement ** element )
{
HElement * newelement, * next, * previous;
char * tmp;
int notfound = -1;
if ( header == (HList *) NULL) return(-1);
if ( Value == (const char *) NULL ) return(-1);
*element = (HElement *) NULL;
previous = (HElement *) NULL;
next = header->ElementRoot;
/* search insertion point (insertion before next) */
while( ( next!=(HElement *) NULL ) && (notfound<0) ) {
notfound = compare_keys(next->Key,Key,UpperCaseSort);
if (notfound<0) {previous = next; next = next->Next;}
}
/* create new element, if (notfound) */
if ( notfound ) {
/* create new element */
if (!(newelement = (HElement *) malloc( sizeof(HElement) ) )) return(-1);
newelement->Key = newstr( Key ); if (!newelement->Key) return(-1);
newelement->Value = (char *) NULL;
init_header_element_flags( &(newelement->Flags) );
/* insert newelement before next */
if (next) next->Previous = newelement;
newelement->Next=next;
newelement->Previous=previous;
if (previous) previous->Next=newelement;
else header->ElementRoot = newelement;
next = newelement;
}
/* update Value */
tmp = newstr( Value ); if (!tmp) return(-1);
if ( next->Value ) free ( next->Value );
next->Value = tmp;
*element = next;
return(0);
} /* insert_header_element */
/*---------------------------------------------------------------------------
search_header_element (success:0, error:-1)
In case of success the pointer to the element is returned.
---------------------------------------------------------------------------*/
int search_header_element( HList * header, const char * Key,
HElement ** element )
{
HElement * current;
/* return NULL in case that element was not found */
*element = (HElement *) NULL;
/* stop, if header not defined */
if ( !header ) return(-1);
/* search element */
current = header->ElementRoot;
if ( current!=(HElement *) NULL )
while( ( current!=(HElement *) NULL ) &&
( compare_keys(current->Key,Key,UpperCaseSort)!=0 ) ) {
current = current->Next;
}
*element = current;
if (current==(HElement *) NULL) return(-1);
return(0);
} /* search_header_element */
/*---------------------------------------------------------------------------
remove_header_element (success:0, error:-1)
The routine ends with success if the element is not any more present, even
if it does not exist before the call of this function.
---------------------------------------------------------------------------*/
int remove_header_element( HList * header, const char * Key )
{
HElement * current, * previous, *next;
/* search element */
current = header->ElementRoot;
if ( current!=(HElement *) NULL )
while( ( current!=(HElement *) NULL ) &&
( compare_keys(current->Key,Key,UpperCaseSort)!=0 ) ) {
current = current->Next;
}
/* stop, if no element found */
if (current==(HElement *) NULL) return(0);
/* change links */
previous = current->Previous;
next = current->Next;
if ( next != (HElement *) NULL ) next->Previous = previous;
if ( previous != (HElement *) NULL ) previous->Next = next;
else header->ElementRoot = next;
/* remove element */
free(current->Key);
free(current->Value);
free(current);
return(0);
} /* remove_header_element */
/*---------------------------------------------------------------------------
read_header_list (success:0, error:-1)
Add all header user values of block to a list and convert them to string.
DBlock * block : input block
HList * header : output header
---------------------------------------------------------------------------*/
int read_header_list( DBlock * block, HList * header )
{ SElement * symbol, * next;
HElement * element;
if ( (block == (DBlock *) NULL) || (header==(HList*) NULL) ) return(-1);
symbol = block->SymbolList;
while (symbol!=(SElement*) NULL) {
// update symbol string with values of continuation keys
if ( update_string( symbol, &next ) ) {
free_header_list(header); return(-1);
}
if (HEADER_debug) printf(" '%s' = '%s'\n",symbol->Key,symbol->String);
if (!is_prefix(symbol->Key,DATA_FORMAT_PREFIX,UpperCaseSort)) {
if (insert_header_element(header,symbol->Key,symbol->String,&element)) {
free_header_list(header); return(-1);
}
}
symbol=next; // skip continuation keys
}
return(0);
} /* read_header_list */
/*---------------------------------------------------------------------------
write_header_list (success:0, error:-1)
Write list into header of block
DBlock * block : output block
HList * header : input header
---------------------------------------------------------------------------*/
int write_header_list( DBlock * block, HList * header )
{
HElement * element;
if ( (block == (DBlock *) NULL) || (header==(HList*) NULL) ) return(-1);
element = header->ElementRoot;
while (element!=(HElement*) NULL) {
if (HEADER_debug) printf(" '%s' = '%s'\n",element->Key,element->Value);
/* create/replace keyword and value in header */
if (insert_string(block,element->Key,element->Value,NULL)) return(-1);
/* The header was changed and must be written to disk */
block->Flags.HeaderChanged = True;
element=element->Next;
}
return(0);
} /* write_header_list */
/*+++------------------------------------------------------------------------
NAME
print_header_list (success:0, error:-1)
SYNOPSIS
int print_header_list( FILE * out, HList * header,
int level, int verbose );
DESCRIPTION
Prints the header list to the file out
RETURN VALUE
0: success
-1: failed
---------------------------------------------------------------------------*/
int print_header_list( FILE * out, HList * header, int level, int verbose )
{ const char * SeparationLine =
"- - - - - - - -";
HElement * element;
if (!header) return(-1);
if (level<1) return(0);
element = header->ElementRoot;
while (element!=(HElement*) NULL) {
if (verbose) {
fprintf(out," %s\n",SeparationLine);
fprintf(out," Key = %s\n",element->Key);
fprintf(out," Value = %s\n",element->Value);
print_header_element_flags ( out, &(element->Flags) );
fprintf(out," Previous Key = ");
if ((element->Previous)!=(HElement*) NULL)
fprintf(out,"%s\n", element->Previous->Key);
else fprintf(out,"(no previous element)\n");
fprintf(out," Next Key = ");
if ((element->Next)!=(HElement*) NULL)
fprintf(out,"%s\n", element->Next->Key);
else fprintf(out,"(no next element)\n");
} else {
fprintf(out," '%s' = '%s'\n",element->Key,element->Value);
}
element=element->Next;
}
if (verbose) fprintf(out," %s\n",SeparationLine);
return(0);
} /* print_header_list */
/* print info about a single data block to out
format 6: write lf, not crlf*/
int edf_dump_format ( FILE * out, DBlock * block, int format, int newchain,
char * keyword[] )
{
SElement * symbol;
char **pkey;
char *crlf="\r\n", *lf="\n";
char *ps;
if (format==6) ps=lf;
else ps=crlf;
switch (format) {
case 0: // standard format
case 10000:
case 10001:
fprintf(out,"chain = %s%s", block->Chain->ChainKey,ps);
fprintf(out," block = %s%s", block->BlockKey,ps);
if (format>=10000) {
fprintf(out,
" HeaderBlockPos = %lu (%#lx), Length = %lu (%#lx)%s",
block->TextPos, block->TextPos,
block->TextLen, block->TextLen,
ps);
fprintf(out,
" BinaryBlockPos = %lu (%#lx), Length = %lu (%#lx)%s",
block->BinaryPos, block->BinaryPos,
block->BinaryLen, block->BinaryLen,
ps);
}
if ( (keyword) && (keyword[0]!=(char*) NULL) )
// load data header
if (!get_data_header( block )) {
for (pkey=keyword;*pkey!=(char*) NULL;pkey++) {
if (!search_general( block, *pkey, &symbol )) {
fprintf(out," %s = %s%s",*pkey, symbol->String,ps);
if (format==10001) {
fprintf(out,
" KeyPos = %lu (%#lx), Length = %u (%#x)%s",
symbol->KeyPos, symbol->KeyPos,
symbol->KeyLen, symbol->KeyLen,
ps);
fprintf(out,
" ValPos = %lu (%#lx), Length = %u (%#x)%s",
symbol->ValPos, symbol->ValPos,
symbol->ValLen, symbol->ValLen,
ps);
}
}
}
} // get_data_header
break; // case 0
case 1: // short format
fprintf(out,"%s",block->Chain->File->Name);
fprintf(out,"\t%s",block->Chain->ChainKey);
fprintf(out,"\t%s",block->BlockKey);
if ( (keyword) && (keyword[0]!=(char*) NULL) ) {
// load data header
if (!get_data_header( block )) {
for (pkey=keyword;*pkey!=(char*) NULL;pkey++) {
if (!search_general( block, *pkey, &symbol )) {
fprintf(out,"\t%s", symbol->String );
}
}
} // get_data_header
fprintf(out,"%s",ps);
} // keyword
break; // case 1
case 2: // very short format
case 6:
if ( (keyword) && (keyword[0]!=(char*) NULL) ) {
// load data header
if (!get_data_header( block )) {
pkey=keyword;
if (!search_general( block, *pkey, &symbol ))
fprintf(out,"%s", symbol->String );
pkey++;
for (;*pkey!=(char*) NULL;pkey++) {
if (!search_general( block, *pkey, &symbol )) {
fprintf(out,"\t%s", symbol->String );
}
}
} // get_data_header
fprintf(out,"%s",ps);
} // keyword
break; // case 2
case 101: // short format, no keywords, one line per chain key
if (newchain) {
fprintf(out,"%s",block->Chain->File->Name);
fprintf(out,"\t%s",block->Chain->ChainKey);
}
fprintf(out,"\t%s",block->BlockKey);
break; // case 101
default : break;
} // switch
return(0);
} // edf_dump_format
/*+++------------------------------------------------------------------------
NAME
SYNOPSIS
int edf_dump( FILE * out, int stream, int format,
char * chainkey[], char * blockkey[], char * keyword[] );
DESCRIPTION
Prints the current structure of the file. When the keyword table is not
empty the contents of all headers are read.
format 0 : simple, all on separate lines
10000 : like 0 + write block positions
10001 : like 10000 + write keyword positions
1 : short, one line per block key with keywords:
<filename> <chainkey> <blockkey> <keywords...>
101 : or one line per chain key without keywords:
<filename> <chainkey> <blockkeys...>
2 : very short, one line per block key, keywords only
<keywords...>
6 : very short, one line per block key, keywords only,
last line without crlf
<keywords...>
PARAMETERS
FILE * out : output file
int stream : stream of opened edf file
int format : output format
char *chainkey[] : chainkey table (use all chainkeys, if empty)
char *blockkey[] : blockkey table (use all blockkeys, if empty)
char *keyword[] : keyword table (no keyword, if empty)
The tables chainkey, blockkey and keyword must be terminated with
(char *) NULL.
RETURN VALUE
1: success
0: failed
---------------------------------------------------------------------------*/
int edf_dump( FILE * out, int stream, int format,
char * chainkey[], char * blockkey[], char * keyword[] )
{
DFile * file;
DChain * chain;
DBlock * block;
char **pckey, **pbkey;
int newchain, newline=0;
/* check stream */
if ((stream<0)||(stream>=MaxFiles)) return(0);
/* get file */
file = &FileTable[stream];
if ( !file->Used ) return(0);
if ( (format==1) && ((!keyword)||(!keyword[0])) ) format=101;
if ((format==0)||(format==10000)||(format==10001))
fprintf(out,"file = %s\r\n",file->Name);
if ( chainkey && chainkey[0] ) { // specific chains only
for (pckey=chainkey;*pckey!=(char*) NULL;pckey++) {
newchain = True;
if (!search_data_chain( file, * pckey, &chain )) {
if ( blockkey && blockkey[0] ) { // specific blocks only
for (pbkey=blockkey;*pbkey!=(char*) NULL;pbkey++) {
if (!search_data_block( chain, * pbkey, &block )) {
if ( !(is_general_block( block )) ) {
edf_dump_format ( out, block, format, newchain, keyword );
newline=1;
}
newchain = False;
}
} // for block
} else { // loop over all blocks
block = chain->BlockList;
while (block!=(DBlock*) NULL) {
if ( !(is_general_block( block )) ) {
edf_dump_format ( out, block, format, newchain, keyword );
newline=1;
}
block = block->Next;
newchain = False;
} // while block
} // if (blockkey ..
if ( (10<=format) && (newline) ) fprintf(out,"\r\n");
}
} // for chain
} else { // loop over all chains
chain = file->ChainList;
while(chain!=(DChain*) NULL) {
newchain = True;
if ( blockkey && blockkey[0] ) { // specific blocks only
for (pbkey=blockkey;*pbkey!=(char*) NULL;pbkey++) {
if (!search_data_block( chain, * pbkey, &block )) {
if ( !(is_general_block( block )) ) {
edf_dump_format ( out, block, format, newchain, keyword );
newline=1;
}
newchain = False;
}
} // for block
} else { // loop over all blocks
block = chain->BlockList;
while (block!=(DBlock*) NULL) {
if ( !(is_general_block( block )) ) {
edf_dump_format ( out, block, format, newchain, keyword );
newline=1;
}
block = block->Next;
newchain = False;
} // while block
} // if (blockkey ..
if ( (10<=format) && (newline) ) fprintf(out,"\r\n");
chain = chain->Next;
} // while chain
} // if ( chainkey ..
return(1);
} // edf_dump
/*+++------------------------------------------------------------------------
NAME
edf_print_header
SYNOPSIS
int edf_print_header( FILE * out, const char * header_key,
int level, int verbose );
DESCRIPTION
Prints contents of header header_key to out, or contents of
all headers, if header_key is NULL.
RETURN VALUE
1: success
0: failed (specified header not found)
---------------------------------------------------------------------------*/
int edf_print_header( FILE * out, const char * header_key,
int level, int verbose )
{ const char * SeparationLine =
"- - - - - - - - - - - - - - -";
HList * header, * stop = (HList*) NULL;
if (HEADER_debug) printf("edf_print_header\n");
if (level<1) return(0);
if (!InitHeader) init_header();
if ( header_key != (const char *) NULL ) {
// list a single header
search_header_list ( header_root, header_key, &header );
if ( header == (HList *) NULL ) return(0);
stop = header->Next;
} else header = header_root; // list all headers
while ( header != stop ) {
if (verbose) {
fprintf(out," %s\n",SeparationLine);
fprintf(out," Header key = %s\n",header->Key);
fprintf(out," Previous Key = ");
if ((header->Previous)!=(HList*) NULL)
fprintf(out,"%s\n", header->Previous->Key);
else fprintf(out,"(no previous header)\n");
fprintf(out," Next Key = ");
if ((header->Next)!=(HList*) NULL)
fprintf(out,"%s\n", header->Next->Key);
else fprintf(out,"(no next header)\n");
print_header_list( out, header, level-1, verbose );
fprintf(out," KeyOrderNo = %d\n",header->KeyOrderNo);
} else {
fprintf(out," Header key = %s\n",header->Key);
print_header_list( out, header, level-1, verbose );
}
header=header->Next;
}
if (verbose) fprintf(out," %s\n",SeparationLine);
return(1);
} /* edf_print_header */
/*+++------------------------------------------------------------------------
NAME
edf_read_header --- reads all user keys and values from a header
SYNOPSIS
int edf_read_header ( int stream, long DataNumber,
int DataChain, const char * header_key,
int * pErrorValue, int * pstatus);
DESCRIPTION
Reads all user keys and values from the data header and the general header.
It writes them to the element list with the name header_key.
The header can be released with edf_free_header( header_key );
RETURN VALUE
return value FALSE if not found and no other error
return( int ) FALSE : data header not found,
*pstatus = status_error;
*pErrorValue=(CouldNotFindHeader, RoutineSucceeded);
TRUE : data header found or error,
*pstatus = Success or status_error;
*pErrorValue = <any>
HISTORY
2000-12-31 Peter Boesecke
--------------------------------------------------------------------------+*/
int edf_read_header ( int stream, long DataNumber,
int DataChain, const char * header_key,
int * pErrorValue, int * pstatus)
{
DBlock * block;
HList * header;
int errval, status;
if (HEADER_debug) printf("edf_read_header BEGIN\n");
if (!InitHeader) init_header();
search_header_list ( header_root, header_key, &header );
if ( header == (HList*)NULL ) // try to create it
header_list_new ( &header_root, header_key, &header );
if ( header == (HList*)NULL ) {
errval = CouldNotCreateHeader; // cannot create header
goto edf_read_header_error;
}
switch ( open_read_block (stream, DataNumber, DataChain,
&block, &errval ) ) {
case 1: goto edf_read_header_notfound;
case -1: goto edf_read_header_error;
}
/* read keyword list from general block and copy it to element list */
if ( read_header_list( block->Chain->File->GeneralBlock, header ) ) {
errval = CouldNotReadGeneralHeader;
goto edf_read_header_error;
}
/* read keyword list from block and copy it to element list */
if ( read_header_list( block, header ) ) {
errval = CouldNotReadHeader;
goto edf_read_header_error;
}
if ( close_read_block( block, &errval ) )
goto edf_read_header_error;
errval = RoutineSucceeded;
status = status_success;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
if (HEADER_debug) printf("edf_read_header END\n");
return(1);
edf_read_header_notfound:
status = status_error;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
if (HEADER_debug) {
printf("edf_read_header: %s",edf_report_data_error ( errval ));
printf("edf_read_header END (status=%d)\n",status);
}
return(0);
edf_read_header_error:
status = status_error;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
if (HEADER_debug) {
printf("edf_read_header: %s",edf_report_data_error ( errval ));
printf("edf_read_header END (status=%d)\n",status);
}
return(1);
} /* edf_read_header */
/*+++------------------------------------------------------------------------
NAME
edf_write_header --- writes a header symbol list into the header
SYNOPSIS
int edf_write_header ( int stream, long DataNumber,
int DataChain, const char * header_key,
int * pErrorValue, int * pstatus )
DESCRIPTION
Writes the elementlist with the name header_key into the header
of the specified image.
RETURN VALUE
In case of success the return value is 1, otherwise 0.
HISTORY
2000-12-31 Peter Boesecke
--------------------------------------------------------------------------+*/
int edf_write_header ( int stream, long DataNumber,
int DataChain, const char * header_key,
int * pErrorValue, int * pstatus )
{
DBlock * block;
HList * header;
int errval, status;
if (HEADER_debug) printf("edf_write_header\n");
if (!InitHeader) init_header();
search_header_list ( header_root, header_key, &header );
if ( header == (HList*) NULL ) {
errval=CouldNotFindHeaderKey;
goto edf_write_header_error;
}
if ( open_write_block (stream, DataNumber, DataChain,
&block, &errval ) )
goto edf_write_header_error;
/* create/replace keyword and value in header */
if ( write_header_list( block, header )) {
errval = CouldNotInsertSymbol;
goto edf_write_header_error;
}
if ( close_write_block( block, &errval ) )
goto edf_write_header_error;
/* The header was changed and must be written to disk */
block->Flags.HeaderChanged = True;
errval = RoutineSucceeded;
status = status_success;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
if (HEADER_debug) printf("edf_write_header END\n");
return(1);
edf_write_header_error:
status=status_error;
if (pErrorValue) *pErrorValue = errval;
if (pstatus) *pstatus = status;
if (HEADER_debug) {
printf("edf_write_header: %s",edf_report_data_error ( errval ));
printf("edf_write_header END (status=%d)\n",status);
}
return(0);
} /* edf_write_header */
/*+++------------------------------------------------------------------------
NAME
edf_first_header_element --- return first element of header header_key
SYNOPSIS
int edf_first_header_element( const char * header_key,
const char ** pkey, const char ** pvalue,
int * pErrorValue, int * pstatus )
DESCRIPTION
The first element is read from the header list with the name header_key.
A pointer to the key of this element is returned in *pkey and a pointer
to the value of this key is returned in *pvalue.
If the end of the header list is reached or in case of an error
NULL-pointers are returned.
RETURN VALUE
In case of success the return value is 1, otherwise 0.
HISTORY
2001-11-24 Peter Boesecke
--------------------------------------------------------------------------+*/
int edf_first_header_element( const char * header_key,
const char ** pkey, const char ** pvalue,
int * pErrorValue, int * pstatus )
{ HList * header;
HElement * element;
*pstatus = status_error;
*pErrorValue = RoutineSucceeded;
*pkey = (const char *) NULL;
*pvalue = (const char *) NULL;
if (HEADER_debug) printf("edf_first_header_element\n");
if (!InitHeader) init_header();
search_header_list ( header_root, header_key, &header );
if ( header == (HList*) NULL ) {
*pErrorValue=CouldNotFindHeaderKey; return(0); } // header key not found
keyorder_first_header_element( header, &element );
if ( element != (HElement *) NULL ) {
*pkey = element->Key;
*pvalue = element->Value;
}
*pErrorValue = RoutineSucceeded;
*pstatus = status_success;
return(1);
} /* edf_first_header_element */
/*+++------------------------------------------------------------------------
NAME
edf_next_header_element --- return next element from header header_key
SYNOPSIS
int edf_next_header_element( const char * header_key,
const char ** pkey, const char ** pvalue,
int * pErrorValue, int * pstatus )
DESCRIPTION
The next element is read from the header list with the name header_key.
A pointer to the key of this element is returned in *pkey and a pointer
to the value of this key is returned in *pvalue.
If the end of the header list is reached or in case of an error
NULL-pointers are returned.
Before using this function edf_first_header_element must have been called.
RETURN VALUE
In case of success the return value is 1, otherwise 0.
HISTORY
2001-11-24 Peter Boesecke
--------------------------------------------------------------------------+*/
int edf_next_header_element( const char * header_key,
const char ** pkey, const char ** pvalue,
int * pErrorValue, int * pstatus )
{ HList * header;
HElement * element;
*pstatus = status_error;
*pErrorValue = RoutineSucceeded;
*pkey = (const char *) NULL;
*pvalue = (const char *) NULL;
if (HEADER_debug) printf("edf_next_header_element\n");
if (!InitHeader) init_header();
search_header_list ( header_root, header_key, &header );
if ( header == (HList*) NULL ) {
*pErrorValue=CouldNotFindHeaderKey; return(0); } // header key not found
keyorder_next_header_element( header, &element );
if ( element != (HElement *) NULL ) {
*pkey = element->Key;
*pvalue = element->Value;
}
*pErrorValue = RoutineSucceeded;
*pstatus = status_success;
return(1);
} /* edf_next_header_element */
/*+++------------------------------------------------------------------------
NAME
edf_search_header_element --- return value of header element
SYNOPSIS
int edf_search_header_element( const char * header_key,
const char * key, const char ** pvalue,
int * pErrorValue, int * pstatus )
DESCRIPTION
The value of the element with name 'key' is read from the header list
with the name header_key. A pointer to the value of this key is
returned in *pvalue. If the key was not found or in case of an error
NULL-pointers are returned.
RETURN VALUE
In case of success (found) the return value is 1, otherwise 0.
HISTORY
2002-01-08 Peter Boesecke
--------------------------------------------------------------------------+*/
int edf_search_header_element( const char * header_key,
const char * key, const char ** pvalue,
int * pErrorValue, int * pstatus )
{ HList * header;
HElement * element;
int retval=0;
*pstatus = status_error;
*pErrorValue = RoutineSucceeded;
*pvalue = (const char *) NULL;
if (HEADER_debug) printf("edf_search_header_element\n");
if (!InitHeader) init_header();
search_header_list ( header_root, header_key, &header );
if ( header == (HList*) NULL ) {
*pErrorValue=CouldNotFindHeaderKey; return(retval);} //header key not found
search_header_element( header, key, &element );
if (element) {
*pvalue = element->Value;
retval = 1;
}
*pErrorValue = RoutineSucceeded;
*pstatus = status_success;
return(retval);
} /* edf_search_header_element */
/*+++------------------------------------------------------------------------
NAME
edf_add_header_element --- add an element to header header_key
SYNOPSIS
int edf_add_header_element ( const char * header_key,
const char * key, const char * value,
int * pErrorValue, int * pstatus )
DESCRIPTION
An element with key and value is inserted into the header list with the
name header_key. If a key with the same name already exists its value
is replaced by the new value.
Before using this function a header must have been created with
edf_new_header.
RETURN VALUE
In case of success the return value is 1, otherwise 0.
HISTORY
2001-12-08 Peter Boesecke
--------------------------------------------------------------------------+*/
int edf_add_header_element ( const char * header_key,
const char * key, const char * value,
int * pErrorValue, int * pstatus )
{ HList * header;
HElement * element;
*pstatus = status_error;
*pErrorValue = RoutineSucceeded;
if (HEADER_debug) printf("edf_add_header_element\n");
if (!InitHeader) init_header();
search_header_list ( header_root, header_key, &header );
if ( header == (HList*) NULL ) {
*pErrorValue=CouldNotFindHeaderKey; return(0); } // header key not found
insert_header_element( header, key, value, &element );
if ( element == (HElement*) NULL) {
*pErrorValue=CouldNotInsertElement; return(0);} // header not updated
*pErrorValue = RoutineSucceeded;
*pstatus = status_success;
return(1);
} /* edf_add_header_element */
/*+++------------------------------------------------------------------------
NAME
edf_delete_header_element --- remove an element from header header_key
SYNOPSIS
int edf_delete_header_element( const char * header_key,
const char * key,
int * pErrorValue, int * pstatus );
DESCRIPTION
If an element with the name 'key' is found in the header with the name
header_key it is removed otherwise nothing is done. In both cases the
function returns with success.
Before using this function a header must have been created with
edf_new_header.
RETURN VALUE
In case of success the return value is 1, otherwise 0.
HISTORY
2001-12-08 Peter Boesecke
--------------------------------------------------------------------------+*/
int edf_delete_header_element( const char * header_key,
const char * key,
int * pErrorValue, int * pstatus )
{ HList * header;
*pstatus = status_error;
*pErrorValue = RoutineSucceeded;
if (HEADER_debug) printf("edf_add_header_element\n");
if (!InitHeader) init_header();
search_header_list ( header_root, header_key, &header );
if ( header == (HList*) NULL ) {
*pErrorValue=CouldNotFindHeaderKey; return(0); } // header key not found
remove_header_element( header, key );
*pErrorValue = RoutineSucceeded;
*pstatus = status_success;
return(1);
} /* edf_add_header_element */
/*+++------------------------------------------------------------------------
NAME
edf_new_header
SYNOPSIS
int edf_new_header ( const char * name );
DESCRIPTION
This routines must be called first. If not already initialized, it
initializes the header module and creates a header that can be accessed
with name.
RETURN VALUES
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_new_header ( const char * header_key )
{ HList * header;
if (HEADER_debug) printf("\n edf_new_header BEGIN\n");
if (!InitHeader) init_header();
if (header_list_new ( &header_root, header_key, &header ) ) return(0);
if (HEADER_debug) printf("\n edf_new_header END\n");
return(1);
} /* edf_new_header */
/*+++------------------------------------------------------------------------
NAME
edf_free_header
SYNOPSIS
int edf_free_header ( const char * header_key );
DESCRIPTION
This routine removes all header lists with its contents.
If not already initialized, it initializes the header module.
RETURN VALUES
In case of success the return value is 1, otherwise 0.
--------------------------------------------------------------------------+*/
int edf_free_header ( const char * header_key )
{ int retval;
if (HEADER_debug) printf("\n edf_free_header BEGIN\n");
retval = 1;
if (!InitHeader) init_header();
if ( header_key == (const char *) NULL ) { // remove all keys
if (header_list_free ( &header_root ) ) retval = 0;
} else { // remove header_key
if (header_list_remove ( &header_root, header_key ) ) retval = 0;
}
if (HEADER_debug) printf("\n edf_free_header END\n");
return(retval);
} /* edf_free_header */
/*--------------------------------------------------------------------------
NAME
header_debug --- set / reset module history into debug mode
SYNOPSIS
void header_debug ( int debug );
DESCRPTION
Writes debug into HEADER_debug.
-----------------------------------------------------------------------------*/
void header_debug ( int debug )
{ HEADER_debug = debug;
} /* header_debug */
/*===header_list END====================================================---*/
/*+++------------------------------------------------------------------------
NAME
edf_free_all --- remove all allocated memory
SYNOPSIS
int edf_free_all ( void );
DESCRIPTION
Closes everything and releases all allocated memory buffers.
--------------------------------------------------------------------------+*/
int edf_free_all ( void ) /*---*/
{
edf_history_free( (const char *) NULL );
edf_free_header( (const char *) NULL );
edf_free_data_file();
return(1);
} /* edf_free_all */
/*+++------------------------------------------------------------------------
NAME
edf_report_data_error --- returns the error message of ErrorValue
SYNOPSIS
char * edf_report_data_error ( int ErrorValue );
DESCRIPTION
Allocates a buffer and copies the error message corresponding to
ErrorValue. It returns a pointer to the allocated buffer.
HISTORY
--------------------------------------------------------------------------+*/
// PRIVATE const char *NDFE = "NoDataFormatError"; //unused
PRIVATE const char *UEV = "UnknownErrorValue";
PRIVATE const char *RF = "RoutineFailed";
PRIVATE const char *RS = "RoutineSucceeded";
PRIVATE const char *CNMM = "CouldNotMallocMemory";
PRIVATE const char *CNFH = "CouldNotFreeHeaders";
PRIVATE const char *CNGA = "CouldNotGetBinaryArray";
PRIVATE const char *NMSA = "NoMoreStreamsAvailable";
PRIVATE const char *INVS = "InvalidStream";
PRIVATE const char *CNOF = "CouldNotOpenFile";
PRIVATE const char *EOFD = "EndOfFileDetected";
PRIVATE const char *CNFI = "CouldNotFindHeader";
PRIVATE const char *CNFS = "CouldNotFindSymbol";
// PRIVATE const char *BSD = "BadSizeDefinition"; // unused
PRIVATE const char *BDB = "BadDataBlock";
PRIVATE const char *CNFK = "CouldNotFindKeyword";
PRIVATE const char *WDE = "WriteDataError";
PRIVATE const char *RDE = "ReadDataError";
PRIVATE const char *NFO = "NoFileOpen";
PRIVATE const char *NEDF = "NotESRFDataFile";
PRIVATE const char *NDBF = "NoDataBlocksFound";
PRIVATE const char *ED = "ExternalData";
PRIVATE const char *FINW = "FileIsNotWritable";
PRIVATE const char *FINO = "FileIsNotOpened";
PRIVATE const char *IOM = "IncompatibleOpeningModes";
PRIVATE const char *CNCF = "CouldNotCloseFile";
PRIVATE const char *CNCB = "CouldNotCloseBlock";
PRIVATE const char *CNIC = "CouldNotInsertChain";
PRIVATE const char *CNIB = "CouldNotInsertBlock";
PRIVATE const char *CNIS = "CouldNotInsertSymbol";
PRIVATE const char *MKD = "MissingKeyDefinition";
PRIVATE const char *GBNF = "GeneralBlockNotFirst";
PRIVATE const char *ECGB = "ErrorCreatingGeneralBlock";
PRIVATE const char *ERGB = "ErrorReadingGeneralBlock";
PRIVATE const char *ELB = "ErrorLocatingBlocks";
PRIVATE const char *CNSB = "CouldNotSetBuffer";
PRIVATE const char *NCVF = "NumberConversionFailed";
PRIVATE const char *DCVF = "DataConversionFailed";
PRIVATE const char *DBTS = "DataBufferTooSmall";
PRIVATE const char *MAD = "MissingArrayDimensions";
PRIVATE const char *NND = "NotNdData";
PRIVATE const char *N2D = "Not2dData";
PRIVATE const char *CNWD = "CouldNotWriteDimension";
PRIVATE const char *CNRD = "CouldNotReadDimension";
PRIVATE const char *CNWB = "CouldNotWriteBinary";
PRIVATE const char *CROG = "CannotReOpenGeneralBlock";
PRIVATE const char *COAB = "CannotOpenAsBslFile";
PRIVATE const char *CNIE = "CouldNotInsertElement";
PRIVATE const char *CNDS = "CouldNotDeleteString";
PRIVATE const char *CNFY = "CouldNotFindHeaderKey";
PRIVATE const char *CNCH = "CouldNotCreateHeader";
PRIVATE const char *CNRG = "CouldNotReadGeneralHeader";
PRIVATE const char *CNRH = "CouldNotReadHeader";
char * edf_report_data_error ( int ErrorValue ) /*---*/
{ char * errmsg;
errmsg = (char *) malloc(BufferSize);
switch (ErrorValue) {
case RoutineFailed : sprintf(errmsg,"\n%s\n",RF); break;
case RoutineSucceeded : sprintf(errmsg,"\n%s\n",RS); break;
case CouldNotMallocMemory : sprintf(errmsg,"\n%s\n",CNMM); break;
case CouldNotFreeHeaders : sprintf(errmsg,"\n%s\n",CNFH); break;
case NoMoreStreamsAvailable : sprintf(errmsg,"\n%s\n",NMSA); break;
case InvalidStream : sprintf(errmsg,"\n%s\n",INVS); break;
case CouldNotOpenFile : sprintf(errmsg,"\n%s\n",CNOF); break;
case EndOfFileDetected : sprintf(errmsg,"\n%s\n",EOFD); break;
case CouldNotFindHeader : sprintf(errmsg,"\n%s\n",CNFI); break;
case CouldNotFindSymbol : sprintf(errmsg,"\n%s\n",CNFS); break;
case CouldNotGetBinaryArray : sprintf(errmsg,"\n%s\n",CNGA); break;
case BadDataBlock : sprintf(errmsg,"\n%s\n",BDB); break;
case CouldNotFindKeyword : sprintf(errmsg,"\n%s\n",CNFK); break;
case WriteDataError : sprintf(errmsg,"\n%s\n",WDE); break;
case ReadDataError : sprintf(errmsg,"\n%s\n",RDE); break;
case NoFileOpen : sprintf(errmsg,"\n%s\n",NFO); break;
case NotESRFDataFile : sprintf(errmsg,"\n%s\n",NEDF); break;
case NoDataBlocksFound : sprintf(errmsg,"\n%s\n",NDBF); break;
case ExternalData : sprintf(errmsg,"\n%s\n",ED); break;
case FileIsNotWritable : sprintf(errmsg,"\n%s\n",FINW); break;
case FileIsNotOpened : sprintf(errmsg,"\n%s\n",FINO); break;
case IncompatibleOpeningModes : sprintf(errmsg,"\n%s\n",IOM); break;
case CouldNotCloseFile : sprintf(errmsg,"\n%s\n",CNCF); break;
case CouldNotCloseBlock : sprintf(errmsg,"\n%s\n",CNCB); break;
case CouldNotInsertChain : sprintf(errmsg,"\n%s\n",CNIC); break;
case CouldNotInsertBlock : sprintf(errmsg,"\n%s\n",CNIB); break;
case CouldNotInsertSymbol : sprintf(errmsg,"\n%s\n",CNIS); break;
case MissingKeyDefinition : sprintf(errmsg,"\n%s\n",MKD); break;
case GeneralBlockNotFirst : sprintf(errmsg,"\n%s\n",GBNF); break;
case ErrorCreatingGeneralBlock: sprintf(errmsg,"\n%s\n",ECGB); break;
case ErrorReadingGeneralBlock : sprintf(errmsg,"\n%s\n",ERGB); break;
case ErrorLocatingBlocks : sprintf(errmsg,"\n%s\n",ELB); break;
case CouldNotSetBuffer : sprintf(errmsg,"\n%s\n",CNSB); break;
case NumberConversionFailed : sprintf(errmsg,"\n%s\n",NCVF); break;
case DataConversionFailed : sprintf(errmsg,"\n%s\n",DCVF); break;
case DataBufferTooSmall : sprintf(errmsg,"\n%s\n",DBTS); break;
case MissingArrayDimensions : sprintf(errmsg,"\n%s\n",MAD); break;
case NotNdData : sprintf(errmsg,"\n%s\n",NND); break;
case Not2dData : sprintf(errmsg,"\n%s\n",N2D); break;
case CouldNotWriteDimension : sprintf(errmsg,"\n%s\n",CNWD); break;
case CouldNotReadDimension : sprintf(errmsg,"\n%s\n",CNRD); break;
case CouldNotWriteBinary : sprintf(errmsg,"\n%s\n",CNWB); break;
case CannotReOpenGeneralBlock : sprintf(errmsg,"\n%s\n",CROG); break;
case CannotOpenAsBslFile : sprintf(errmsg,"\n%s\n",COAB); break;
case CouldNotInsertElement : sprintf(errmsg,"\n%s\n",CNIE); break;
case CouldNotDeleteString : sprintf(errmsg,"\n%s\n",CNDS); break;
case CouldNotFindHeaderKey : sprintf(errmsg,"\n%s\n",CNFY); break;
case CouldNotCreateHeader : sprintf(errmsg,"\n%s\n",CNCH); break;
case CouldNotReadGeneralHeader: sprintf(errmsg,"\n%s\n",CNRG); break;
case CouldNotReadHeader : sprintf(errmsg,"\n%s\n",CNRH); break;
default : sprintf(errmsg,"\n%s : %d\n",UEV,ErrorValue);
}
return(errmsg);
} /* edf_report_data_error */
/*****************************************************************************/
/*+++--------------------------------------------------------------------------
NAME
edfio_debug --- set / reset module into debug mode
SYNOPSIS
void edfio_debug ( int debug );
DESCRPTION
Sets/resets all sub-modules into debug mode
----------------------------------------------------------------------------+*/
void edfio_debug ( int debug ) /*---*/
{ EDFIO_debug = debug;
cmpr_debug ( EDFIO_debug );
raster_debug ( EDFIO_debug );
hist_debug ( EDFIO_debug );
header_debug ( EDFIO_debug );
keyorder_debug ( EDFIO_debug );
numio_debug ( EDFIO_debug );
} /* edfio_debug */
/*****************************************************************************/
|