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
|
/*
* This software was developed by the Thermal Modeling and Analysis
* Project(TMAP) of the National Oceanographic and Atmospheric
* Administration's (NOAA) Pacific Marine Environmental Lab(PMEL),
* hereafter referred to as NOAA/PMEL/TMAP.
*
* Access and use of this software shall impose the following
* obligations and understandings on the user. The user is granted the
* right, without any fee or cost, to use, copy, modify, alter, enhance
* and distribute this software, and any derivative works thereof, and
* its supporting documentation for any purpose whatsoever, provided
* that this entire notice appears in all copies of the software,
* derivative works and supporting documentation. Further, the user
* agrees to credit NOAA/PMEL/TMAP in any publications that result from
* the use of this software or in any product that includes this
* software. The names TMAP, NOAA and/or PMEL, however, may not be used
* in any advertising or publicity to endorse or promote any products
* or commercial entity unless specific written permission is obtained
* from NOAA/PMEL/TMAP. The user also understands that NOAA/PMEL/TMAP
* is not obligated to provide the user with any support, consulting,
* training or assistance of any kind with regard to the use, operation
* and performance of this software nor to provide the user with any
* updates, revisions, new versions or "bug fixes".
*
* THIS SOFTWARE IS PROVIDED BY NOAA/PMEL/TMAP "AS IS" AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL NOAA/PMEL/TMAP BE LIABLE FOR ANY
* SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
* RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
* CONTRACT, NEGLIGENCE OR OTHER TORTUOUS ACTION, ARISING OUT OF OR IN
* CONNECTION WITH THE ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#include <Python.h>
#define PY_ARRAY_UNIQUE_SYMBOL pyferret_ARRAY_API
#include <numpy/arrayobject.h>
#include <ctype.h>
#include <signal.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#if PY_MAJOR_VERSION >= 3
#define PyInt_AsLong(x) PyLong_AsLong(x)
#define PyString_AsString(x) PyUnicode_AsUTF8(x)
#define PyString_FromString(x) PyUnicode_FromString(x)
#define PyString_FromStringAndSize(x,y) PyUnicode_FromStringAndSize(x,y)
#endif
#include "ferret.h"
#include "ferret_shared_buffer.h"
#include "EF_Util.h"
#include "grdel.h"
#include "pyferret.h"
#include "pplmem.h"
struct pyferret_module {
/* Flag of this Ferret's start/stop state */
int initialized;
/*
* for memory management in this module
* double *, instead of DFTYPE *, is used for ferMemory
* to create a warning if DFTYPE is not double.
*/
size_t ferMemSize;
double *ferMemory;
float *pplMemory;
/* TODO: Merge errors to use this */
PyObject *error;
};
/* In Python3, we shouldn't have a global variable for module state; all the state should be via
* a struct (pyferret_module)
* In practice we still have a hacky need due to reallo_ppl_memory() so we have pyf_module below
*/
#if PY_MAJOR_VERSION >= 3
#define MODULE_STATE(m) ((struct pyferret_module*)PyModule_GetState(m))
#else
#define MODULE_STATE(m) (&_state)
static struct pyferret_module _state;
#endif
/* Hack. See if we can remove this static later */
static struct pyferret_module *pyf_module = NULL;
/* global pyferret Python module object used for readline */
PyObject *pyferret_module_pyobject = NULL;
/* global pyferret.graphbind Python module object used for createWindow */
PyObject *pyferret_graphbind_module_pyobject = NULL;
/* Ferret's OK return status value */
#define FERR_OK 3
/* Special return value from libpyferret._run indicating the program should shut down */
#define FERR_EXIT_PROGRAM -3
/* Ferret's unspecified integer value */
#define UNSPECIFIED_INT4 -999
/* Length given to the abstract axis */
#define ABSTRACT_AXIS_LEN 9999999
/* for recovering from seg faults */
static void (*segv_handler)(int);
static jmp_buf jumpbuffer;
static void pyefcn_signal_handler(int signum)
{
longjmp(jumpbuffer, 1);
}
/*
* Ctrl-C handler that just calls the CTRLC_AST Fortran subroutine
* defined in fer/gnl/ctrl_c.F (which has no arguments).
*/
static void pyferret_sigint_handler(int signum) {
/* ignore any further Ctrl-C entries until done */
signal(SIGINT, SIG_IGN);
/* Now call the Fortran routine */
ctrlc_ast_();
/* Go back to catching Ctrl-C */
signal(SIGINT, pyferret_sigint_handler);
}
static char pyferretStartDocstring[] =
"Initializes Ferret. This allocates the initial amount of memory for \n"
"Ferret (from Python-managed memory), opens the journal file, if requested, \n"
"and sets Ferret's verify mode. If restrict is True, some Ferret commands \n"
"will not be available (to provide a secured session). Once restrict is set, \n"
"it cannot be unset. If server is True, Ferret will be run in server mode. \n"
"If metaname is empty (and not in server mode), Ferret's graphics will be \n"
"displayed by default; otherwise, this value is used as the initial filename \n"
"for output graphics. This routine does NOT run any user initialization scripts. \n"
"\n"
"Required arguments: \n"
" (none) \n"
"\n"
"Optional arguments: \n"
" memsize = <float>: the size, in megadoubles (where a double is 8 bytes), \n"
" to allocate for Ferret's memory cache (default 25.6) \n"
" journal = <bool>: journal Ferret commands? (default True) \n"
" verify = <bool>: echo Ferret commands? (default True) \n"
" restrict = <bool>: restrict Ferret's capabilities? (default False) \n"
" server = <bool>: run Ferret in server mode? (default False) \n"
" metaname = <string>: filename for Ferret graphics (default empty) \n"
" unmapped = <bool>: hide the graphics viewer? (default False) \n"
" quiet = <bool>: do not print the ferret header? (default False) \n"
" linebuffer = <bool>: use line buffering for stdout and stderr? (default False) \n"
" Note: \n"
" the enviroment variable GFORTRAN_UNBUFFERED_PRECONNECTED \n"
" needs to be set to 1 in order to unbuffer the Fortran \n"
" units for output and error messages\n"
"\n"
"Returns: \n"
" True is successful \n"
" False if Ferret has already been started \n"
"\n"
"Raises: \n"
" MemoryError if unable to allocate the needed memory \n"
" IOError if unable to open the journal file \n";
static PyObject *pyferretStart(PyObject *self, PyObject *args, PyObject *kwds)
{
static char *argNames[] = {"memsize", "journal", "verify", "restrict", "server",
"metaname", "transparent", "unmapped", "quiet",
"linebuffer", NULL};
double mwMemSize = 25.6;
PyObject *pyoJournal = NULL;
PyObject *pyoVerify = NULL;
PyObject *pyoRestrict = NULL;
PyObject *pyoServer = NULL;
PyObject *pyoTransparent = NULL;
PyObject *pyoUnmapped = NULL;
PyObject *pyoQuiet = NULL;
PyObject *pyoLineBuffer = NULL;
char *metaname = NULL;
int journalFlag = 1;
int verifyFlag = 1;
int restrictFlag = 0;
int serverFlag = 0;
int transparentFlag = 0;
int unmappedFlag = 0;
int quietFlag = 0;
int lineBufferFlag = 0;
int pplMemSize;
size_t blksiz;
int status;
int ttoutLun = TTOUT_LUN;
int one_cmnd_mode_int;
PyObject *modulename;
struct pyferret_module *module;
module = MODULE_STATE(self);
/* If already initialized, return False */
if ( module->initialized ) {
Py_INCREF(Py_False);
return Py_False;
}
/* Import the function-pointer table for the PyArray_* functions */
import_array1(NULL);
/* Parse the arguments, checking if an Exception was raised */
if ( ! PyArg_ParseTupleAndKeywords(args, kwds, "|dO!O!O!O!sO!O!O!O!",
argNames, &mwMemSize, &PyBool_Type, &pyoJournal,
&PyBool_Type, &pyoVerify, &PyBool_Type, &pyoRestrict,
&PyBool_Type, &pyoServer, &metaname,
&PyBool_Type, &pyoTransparent, &PyBool_Type, &pyoUnmapped,
&PyBool_Type, &pyoQuiet, &PyBool_Type, &pyoLineBuffer) )
return NULL;
/* Interpret the booleans - Py_False and Py_True are singleton non-NULL objects, so just use == */
if ( pyoJournal == Py_False )
journalFlag = 0;
if ( pyoVerify == Py_False )
verifyFlag = 0;
if ( pyoRestrict == Py_True )
restrictFlag = 1;
if ( pyoServer == Py_True )
serverFlag = 1;
if ( pyoTransparent == Py_True )
transparentFlag = 1;
if ( pyoUnmapped == Py_True )
unmappedFlag = 1;
if ( pyoQuiet == Py_True )
quietFlag = 1;
if ( pyoLineBuffer == Py_True )
lineBufferFlag = 1;
if ( metaname[0] == '\0' )
metaname = NULL;
/* Deal with line buffering */
if ( lineBufferFlag != 0 ) {
/* Set line buffering on stdout and stderr; ignore failures */
setvbuf(stdout, NULL, _IOLBF, BUFSIZ);
setvbuf(stderr, NULL, _IOLBF, BUFSIZ);
}
/* Deal with the restrict and server flags right away */
if ( restrictFlag != 0 )
set_secure();
if ( serverFlag != 0 )
set_server();
/* Initialize the shared buffer sBuffer */
set_shared_buffer();
/* Initial allocation of PPLUS memory */
pplMemSize = 0.5 * 1.0E6;
module->pplMemory = (float *) PyMem_Malloc((size_t)pplMemSize * (size_t)sizeof(float));
if ( module->pplMemory == NULL )
return PyErr_NoMemory();
set_ppl_memory(module->pplMemory, pplMemSize);
/* Initial allocation of Ferret memory - multiples of 100 PMAX_MEM_BLKS */
blksiz = (size_t) ((mwMemSize * 1.0E6 + (double)PMAX_MEM_BLKS - 1.0) / (double)PMAX_MEM_BLKS);
blksiz = (blksiz + 99) / 100;
blksiz *= 100;
module->ferMemSize = blksiz * (size_t)PMAX_MEM_BLKS;
/* Check for overflow */
if ( blksiz != module->ferMemSize / (size_t)PMAX_MEM_BLKS )
return PyErr_NoMemory();
module->ferMemory = (double *) PyMem_Malloc( module->ferMemSize * (size_t)sizeof(double));
if ( module->ferMemory == NULL )
return PyErr_NoMemory();
set_fer_memory(module->ferMemory, module->ferMemSize);
if ( (metaname != NULL) || (unmappedFlag != 0) ) {
/*
* Set the default graphics filename for saving before ending.
* Make a copy of the name just in case set_batch_graphics_ changes
* something. This also hides the graphics viewer.
*/
char my_meta_name[2048];
if ( metaname != NULL ) {
strncpy(my_meta_name, metaname, 2048);
my_meta_name[2047] = '\0';
}
else {
my_meta_name[0] = '\0';
}
set_batch_graphics_(my_meta_name);
}
/* Set the default autosave transparency */
fgd_set_transparency_(&transparentFlag);
/* Initialize stuff: keyboard, todays date, grids, GFDL terms, PPL brain */
initialize_();
/* Open the output journal file, if appropriate */
if ( journalFlag != 0 ) {
init_journal_(&status);
if ( status != FERR_OK ) {
PyErr_SetString(PyExc_IOError, "Unable to open the journal file ferret.jnl");
return NULL;
}
}
else
no_journal_();
/* Set the verify flag */
if ( verifyFlag == 0 )
turnoff_verify_(&status);
/* Get the PyObject representing the pyferret module */
modulename = PyString_FromString("pyferret");
if ( modulename == NULL ) {
return NULL;
}
pyferret_module_pyobject = PyImport_Import(modulename);
Py_DECREF(modulename);
if ( pyferret_module_pyobject == NULL ) {
return NULL;
}
/* Get the PyObject representing the pyferret.graphbind module */
modulename = PyString_FromString("pyferret.graphbind");
if ( modulename == NULL ) {
Py_DECREF(pyferret_module_pyobject);
return NULL;
}
pyferret_graphbind_module_pyobject = PyImport_Import(modulename);
Py_DECREF(modulename);
if ( pyferret_graphbind_module_pyobject == NULL ) {
return NULL;
}
/* Set and possibly output program name and revision number */
proclaim_c_(&ttoutLun, "\t", &quietFlag);
/* Set so that ferret_dispatch returns after every command */
one_cmnd_mode_int = 1;
set_one_cmnd_mode_(&one_cmnd_mode_int);
/* Success - return True */
module->initialized = 1;
pyf_module = module;
Py_INCREF(Py_True);
return Py_True;
}
/*
* Helper function to reallocate Ferret's memory from Python.
* Argument: the new number of floats of Ferret's memory cache is given by
* blksiz * PMAX_MEM_BLKS (defined in ferret.h as 2000)
* Returns: zero if fails, non-zero if successful
*/
static int resizeFerretMemory(struct pyferret_module *module, int blksiz)
{
size_t actual_blksiz;
size_t newFerMemSize;
/* Get the new size for the memory and check for overflow */
if ( blksiz <= 0 )
return 0;
actual_blksiz = (blksiz + 99)/ 100;
actual_blksiz *= 100;
newFerMemSize = actual_blksiz * (size_t)PMAX_MEM_BLKS;
if ( actual_blksiz != newFerMemSize / (size_t)PMAX_MEM_BLKS )
return 0;
/*
* Free the old memory and allocate new memory rather than use
* realloc since the contents of the old memory isn't needed.
* This could also result in a better garbage collection.
*/
PyMem_Free(module->ferMemory);
module->ferMemory = (double *) PyMem_Malloc(newFerMemSize * (size_t)sizeof(double));
if ( module->ferMemory == NULL ) {
module->ferMemory = (double *) PyMem_Malloc(module->ferMemSize * (size_t)sizeof(double));
if ( module->ferMemory == NULL ) {
fprintf(stderr, "**ERROR: Unable to restore Ferret's memory cache of %f Mdoubles\n", (double)module->ferMemSize / 1.0E6);
exit(1);
}
return 0;
}
/* Reallocation successful; assign the new memory */
module->ferMemSize = newFerMemSize;
set_fer_memory(module->ferMemory, module->ferMemSize);
return 1;
}
/*
* Called by the Ferret core to reallocate for more PPL memory
*/
void reallo_ppl_memory(int new_size)
{
/* Horrible hack. Need to keep a global state var in libpyferret for reallo_ppl_memory
* to be free of tracking PyFerret module state
*/
struct pyferret_module *module = pyf_module;
if ( module->pplMemory != NULL )
PyMem_Free(module->pplMemory);
module->pplMemory = (float *) PyMem_Malloc((size_t)new_size * sizeof(float));
if ( module->pplMemory == NULL ) {
printf("Unable to allocate the requested %d words of PLOT memory.\n", new_size);
exit(1);
}
set_ppl_memory(module->pplMemory, new_size);
}
static char pyferretResizeMemoryDocstring[] =
"Reset the the amount of memory allocated for Ferret from Python-managed memory. \n"
"\n"
"Required arguments: \n"
" memsize = <float>: the new size, in megadouble (where a double is 8 bytes), \n"
" for Ferret's memory cache \n"
"\n"
"Optional arguments: \n"
" (none) \n"
"\n"
"Returns: \n"
" True if successful - Ferret has the new amount of memory \n"
" False if unsuccessful - Ferret has the previous amount of memory \n"
"\n"
"Raises: \n"
" MemoryError if Ferret has not been started or has been stopped \n";
static PyObject *pyferretResizeMemory(PyObject *self, PyObject *args, PyObject *kwds)
{
static char *argNames[] = {"memsize", NULL};
double mwMemSize;
struct pyferret_module *module = MODULE_STATE(self);
/* If not initialized, raise a MemoryError */
if ( ! module->initialized ) {
PyErr_SetString(PyExc_MemoryError, "Ferret not started");
return NULL;
}
/* Parse the arguments, checking if an Exception was raised */
if ( ! PyArg_ParseTupleAndKeywords(args, kwds, "d", argNames, &mwMemSize) )
return NULL;
/* Reallocate the new amount of memory for Ferret */
if ( resizeFerretMemory(module, (int) ((mwMemSize * 1.0E6 + (double)PMAX_MEM_BLKS - 1.0) / (double)PMAX_MEM_BLKS)) == 0 ) {
Py_INCREF(Py_False);
return Py_False;
}
/* Success - return True */
Py_INCREF(Py_True);
return Py_True;
}
static char pyferretRunCommandDocstring[] =
"Runs a Ferret command just as if entering a command at the Ferret prompt. \n"
"\n"
"If an empty string is given, Ferret will prompt you for commands \n"
"until either the \"EXIT\" or the \"EXIT /TOPYTHON\" command is given. \n"
"If \"EXIT /TOPYTHON\" is given, the return tuple will be for the last \n"
"error, if any, that occurred in the sequence of commands submitted. \n"
"\n"
"Required arguments: \n"
" command = <string>: the Ferret command to be run \n"
"\n"
"Optional arguments: \n"
" (none) \n"
"\n"
"Returns: \n"
" (err_int, err_string) \n"
" err_int: one of the FERR_* data values (FERR_OK if there are no errors) \n"
" err_string: error or warning message (can be empty) \n"
" Error messages normally start with \"**ERROR\" \n"
" Warning messages normally start with \"*** NOTE:\" \n"
"\n"
"Raises: \n"
" MemoryError if Ferret has not been started or has been stopped \n";
static PyObject *pyferretRunCommand(PyObject *self, PyObject *args, PyObject *kwds)
{
static char *argNames[] = {"command", NULL};
const char *command;
const char *iter_command;
int one_cmnd_mode_int;
void (*oldsighand)(int);
int cmnd_stack_level;
char errmsg[2112];
int errval;
struct pyferret_module *module;
module = MODULE_STATE(self);
/* If not initialized, raise a MemoryError */
if ( ! module->initialized ) {
PyErr_SetString(PyExc_MemoryError, "Ferret not started");
return NULL;
}
/* Parse the arguments, checking if an Exception was raised */
if ( ! PyArg_ParseTupleAndKeywords(args, kwds, "s", argNames, &command) )
return NULL;
/* Clear the last error message and value */
clear_fer_last_error_info_();
/* If an empty string, temporarily turn off the one-command mode */
if ( command[0] == '\0' ) {
one_cmnd_mode_int = 0;
set_one_cmnd_mode_(&one_cmnd_mode_int);
}
else
one_cmnd_mode_int = 1;
/* Let ferret deal with ctrl-C while in ferret mode */
oldsighand = signal(SIGINT, pyferret_sigint_handler);
if ( oldsighand == SIG_ERR ) {
PyErr_SetString(PyExc_SystemError, "Unable to catch SIGTERM while in Ferret");
return NULL;
}
/* do-loop only for dealing with Ferret "SET MEMORY /SIZE=..." resize command */
iter_command = command;
do {
cmnd_stack_level = 0;
/* Run the Ferret command */
ferret_dispatch_c(module->ferMemory, iter_command, sBuffer);
if ( sBuffer->flags[FRTN_ACTION] == FACTN_MEM_RECONFIGURE ) {
/* resize, then re-enter if not single-command mode */
if ( resizeFerretMemory(module, sBuffer->flags[FRTN_IDATA1]) == 0 ) {
printf("Unable to resize Ferret's memory cache to %f Mdoubles\n",
(double)(sBuffer->flags[FRTN_IDATA1]) * (double)PMAX_MEM_BLKS / 1.0E6);
printf("Ferret's memory cache remains at %f Mdoubles\n",
(double)(module->ferMemSize) / 1.0E6);
}
cmnd_stack_level = sBuffer->flags[FRTN_IDATA2];
}
else {
/*
* Not a memory resize command; probably an exit command.
* Do not allow return to the Python prompt if in restricted mode
* (is_secure_() returns non-zero).
*/
if ( is_secure_() == 0 )
break;
if ( sBuffer->flags[FRTN_ACTION] == FACTN_EXIT ) {
signal(SIGTERM, oldsighand);
exit(0);
}
}
/* submit an empty command to continue on with whaterever was going on */
iter_command = "";
} while ( (one_cmnd_mode_int == 0) || (cmnd_stack_level > 0) );
signal(SIGINT, oldsighand);
/* Set back to single command mode */
if ( one_cmnd_mode_int == 0 ) {
one_cmnd_mode_int = 1;
set_one_cmnd_mode_(&one_cmnd_mode_int);
}
if ( sBuffer->flags[FRTN_ACTION] == FACTN_EXIT ) {
/* plain "EXIT" Ferret command - instigate an orderly shutdown */
/* return Py_BuildValue("is", FERR_EXIT_PROGRAM, "EXIT"); */
/*
* python -i -c ... intercepts the Python sys.exit() call and stays in python,
* so just do a C exit() from python
*/
exit(0);
}
/* Get the last error message (null terminated) and value */
get_fer_last_error_info_(&errval, errmsg, 2112);
/* Return the tuple of the last error value and message */
return Py_BuildValue("is", errval, errmsg);
}
static char pyferretGetDataDocstring[] =
"Returns the numeric data array described in the argument. \n"
"\n"
"Required arguments: \n"
" name = <string>: the name of the numeric data array to return \n"
"\n"
"Optional arguments: \n"
" (none) \n"
"\n"
"Returns: \n"
" A tuple containing: \n"
" a NumPy float64 ndarray containing a copy of the numeric data requested, \n"
" a NumPy float64 ndarray containing the bad-data-flag value for the data, \n"
" a string giving the units for the data \n"
" a tuple of six integers giving the AXISTYPE codes of the axes, \n"
" a tuple of six strings giving the names of the axes, \n"
" a tuple of six strings giving the units of a non-calendar-time data axis, or \n"
" the CALTYPE_ calendar name of a calendar-time axis, \n"
" a tuple of six ndarrays giving the coordinates for the data axes \n"
" (ndarray of N doubles for non-calendar-time, non-normal axes, \n"
" ndarray of (N,6) integers for calendar-time axes, or \n"
" None for normal axes) \n"
"\n"
"Raises: \n"
" ValueError if the data name is invalid \n"
" MemoryError if Ferret has not been started or has been stopped \n";
static PyObject *pyferretGetData(PyObject *self, PyObject *args, PyObject *kwds)
{
static char *argNames[] = {"name", NULL};
char *name;
int lendataname;
char dataname[1024];
int arraystart;
int memlo[MAX_FERRET_NDIM], memhi[MAX_FERRET_NDIM];
int steplo[MAX_FERRET_NDIM], stephi[MAX_FERRET_NDIM], incr[MAX_FERRET_NDIM];
char dataunit[64];
int lendataunit;
AXISTYPE axis_types[MAX_FERRET_NDIM];
char errmsg[2112];
int lenerrmsg;
double badval;
int i, j, k, l, m, n, q;
npy_intp shape[MAX_FERRET_NDIM];
npy_intp new_shape[2];
int strides[MAX_FERRET_NDIM];
PyObject *data_ndarray;
double *ferdata;
double *npydata;
PyObject *badval_ndarray;
PyObject *axis_coords[MAX_FERRET_NDIM];
char axis_units[MAX_FERRET_NDIM][64];
char axis_names[MAX_FERRET_NDIM][64];
CALTYPE calendar_type;
struct pyferret_module *module;
module = MODULE_STATE(self);
/* If not initialized, raise a MemoryError */
if ( ! module->initialized ) {
PyErr_SetString(PyExc_MemoryError, "Ferret not started");
return NULL;
}
/* Parse the arguments, checking if an Exception was raised */
if ( ! PyArg_ParseTupleAndKeywords(args, kwds, "s", argNames, &name) )
return NULL;
/* Make a copy of dataname just to be sure it isn't altered */
lendataname = strlen(name);
if ( lendataname > 1020 ) {
PyErr_SetString(PyExc_ValueError, "name too long");
return NULL;
}
strcpy(dataname, name);
/*
* Retrieve the memory parameters describing the data array requested.
* Assumes Unix standard for passing strings to Fortran (appended array lengths).
*/
get_data_array_params_(dataname, &lendataname, module->ferMemory, &arraystart, memlo, memhi,
steplo, stephi, incr, dataunit, &lendataunit, axis_types,
&badval, errmsg, &lenerrmsg, 1024, 64, 2112);
if ( lenerrmsg > 0 ) {
errmsg[lenerrmsg] = '\0';
PyErr_SetString(PyExc_ValueError, errmsg);
return NULL;
}
/* null terminate the data unit name */
dataunit[lendataunit] = '\0';
/* Get the shape of the array */
for (k = 0; k < MAX_FERRET_NDIM; k++)
shape[k] = (npy_intp) ((stephi[k] - steplo[k] + incr[k]) / (incr[k]));
/* Get the strides through the memory (as a double *) */
strides[0] = 1;
for (k = 1; k < MAX_FERRET_NDIM; k++)
strides[k] = strides[k-1] * (memhi[k-1] - memlo[k-1] + 1);
/* Get the actual starting point in the array */
for (k = 0; k < MAX_FERRET_NDIM; k++)
arraystart += (strides[k]) * (steplo[k] - memlo[k]);
/* Convert to strides through places in memory to be read */
for (k = 0; k < MAX_FERRET_NDIM; k++)
strides[k] *= incr[k];
/* Create a new NumPy double ndarray (Fortran ordering) with the same shape */
data_ndarray = PyArray_EMPTY(MAX_FERRET_NDIM, shape, NPY_DOUBLE, 1);
if ( data_ndarray == NULL ) {
return NULL;
}
/*
* Assign the data in the new ndarray.
* Note: if MAX_FERRET_NDIM changes, this needs editing.
*/
ferdata = module->ferMemory + arraystart;
npydata = (double *)PyArray_DATA(data_ndarray);
q = 0;
for (n = 0; n < (int)(shape[5]); n++) {
for (m = 0; m < (int)(shape[4]); m++) {
for (l = 0; l < (int)(shape[3]); l++) {
for (k = 0; k < (int)(shape[2]); k++) {
for (j = 0; j < (int)(shape[1]); j++) {
for (i = 0; i < (int)(shape[0]); i++) {
npydata[q] = ferdata[ i * strides[0] +
j * strides[1] +
k * strides[2] +
l * strides[3] +
m * strides[4] +
n * strides[5] ];
q++;
}
}
}
}
}
}
/* Create a new NumPy float ndarray with the bad-data-flag value(s) */
new_shape[0] = 1;
badval_ndarray = PyArray_SimpleNew(1, new_shape, NPY_DOUBLE);
if ( badval_ndarray == NULL ) {
Py_DECREF(data_ndarray);
return NULL;
}
npydata = (double *)PyArray_DATA(badval_ndarray);
npydata[0] = badval;
/* Create the axis coordinates array objects */
for (k = 0; k < MAX_FERRET_NDIM; k++) {
switch( axis_types[k] ) {
case AXISTYPE_LONGITUDE:
case AXISTYPE_LATITUDE:
case AXISTYPE_LEVEL:
case AXISTYPE_CUSTOM:
case AXISTYPE_ABSTRACT:
/* array of doubles, possibly with a units string */
axis_coords[k] = PyArray_SimpleNew(1, &(shape[k]), NPY_DOUBLE);
if ( axis_coords[k] == NULL ) {
while ( k > 0 ) {
k--;
Py_DECREF(axis_coords[k]);
}
Py_DECREF(badval_ndarray);
Py_DECREF(data_ndarray);
return NULL;
}
/* get the coordinates and the units string */
q = k+1;
j = (int) shape[k];
get_data_array_coords_((double *)PyArray_DATA(axis_coords[k]), axis_units[k],
axis_names[k], &q, &j, errmsg, &lenerrmsg, 64, 64, 2112);
if ( lenerrmsg > 0 ) {
errmsg[lenerrmsg] = '\0';
PyErr_SetString(PyExc_ValueError, errmsg);
Py_DECREF(axis_coords[k]);
while ( k > 0 ) {
k--;
Py_DECREF(axis_coords[k]);
}
Py_DECREF(badval_ndarray);
Py_DECREF(data_ndarray);
return NULL;
}
break;
case AXISTYPE_TIME:
/* array of 6-tuples of integers in C order, so: [N][6] in C or (6,N) in Fortran */
new_shape[0] = shape[k];
new_shape[1] = 6;
axis_coords[k] = PyArray_SimpleNew(2, new_shape, NPY_INT);
if ( axis_coords[k] == NULL ) {
while ( k > 0 ) {
k--;
Py_DECREF(axis_coords[k]);
}
Py_DECREF(badval_ndarray);
Py_DECREF(data_ndarray);
return NULL;
}
/* get the time coordinate integers */
q = k+1;
j = (int) shape[k];
get_data_array_time_coords_((int (*)[6])PyArray_DATA(axis_coords[k]), &calendar_type, axis_names[k],
&q, &j, errmsg, &lenerrmsg, 64, 2112);
if ( lenerrmsg > 0 ) {
errmsg[lenerrmsg] = '\0';
PyErr_SetString(PyExc_ValueError, errmsg);
Py_DECREF(axis_coords[k]);
while ( k > 0 ) {
k--;
Py_DECREF(axis_coords[k]);
}
Py_DECREF(badval_ndarray);
Py_DECREF(data_ndarray);
return NULL;
}
/* set the axis units to the name of the calendar */
switch( calendar_type ) {
case CALTYPE_NONE:
strcpy(axis_units[k], CALTYPE_NONE_STR);
break;
case CALTYPE_360DAY:
strcpy(axis_units[k], CALTYPE_360DAY_STR);
break;
case CALTYPE_NOLEAP:
strcpy(axis_units[k], CALTYPE_NOLEAP_STR);
break;
case CALTYPE_GREGORIAN:
strcpy(axis_units[k], CALTYPE_GREGORIAN_STR);
break;
case CALTYPE_JULIAN:
strcpy(axis_units[k], CALTYPE_JULIAN_STR);
break;
case CALTYPE_ALLLEAP:
strcpy(axis_units[k], CALTYPE_ALLLEAP_STR);
break;
default:
sprintf(errmsg, "Unexpected calendar type of %d", calendar_type);
PyErr_SetString(PyExc_ValueError, errmsg);
Py_DECREF(axis_coords[k]);
while ( k > 0 ) {
k--;
Py_DECREF(axis_coords[k]);
}
Py_DECREF(badval_ndarray);
Py_DECREF(data_ndarray);
return NULL;
}
break;
case AXISTYPE_NORMAL:
/* axis normal to the results - no coordinates */
Py_INCREF(Py_None);
axis_coords[k] = Py_None;
axis_units[k][0] = '\0';
axis_names[k][0] = '\0';
break;
default:
sprintf(errmsg, "Unexpected axis type of %d", axis_types[k]);
PyErr_SetString(PyExc_RuntimeError, errmsg);
while ( k > 0 ) {
k--;
Py_DECREF(axis_coords[k]);
}
Py_DECREF(badval_ndarray);
Py_DECREF(data_ndarray);
return NULL;
}
}
/*
* Return a tuple (stealing references for PyObjects) of data_ndarray,
* badval_ndarray, dataunit, axis_types, axis_names, axis_units, and axis_coords.
* Note: if MAX_FERRET_NDIM changes, this needs editing.
*/
return Py_BuildValue("NNs(iiiiii)(ssssss)(ssssss)(NNNNNN)", data_ndarray, badval_ndarray, dataunit,
axis_types[0], axis_types[1], axis_types[2], axis_types[3], axis_types[4], axis_types[5],
axis_names[0], axis_names[1], axis_names[2], axis_names[3], axis_names[4], axis_names[5],
axis_units[0], axis_units[1], axis_units[2], axis_units[3], axis_units[4], axis_units[5],
axis_coords[0], axis_coords[1], axis_coords[2], axis_coords[3], axis_coords[4], axis_coords[5]);
}
static char pyferretPutDataDocstring[] =
"Creates a Ferret data variable with the numeric data array described in the arguments. \n"
"\n"
"Required arguments: \n"
" codename = <string>: the code name of the Ferret data variable to create (eg, \"SST\") \n"
" title = <string>: the title of the Ferret data variable to create (eg, \"Sea Surface Temperature\") \n"
" data = <ndarray>: the array containing the numeric data \n"
" bdfval = <ndarray>: the bad-data-flag value for the data \n"
" units = <string>: the units for the data \n"
" dset = <string>: the dataset name or number to be associates with this variable; \n"
" give an empty strip associated with the current dataset \n"
" or 'None' to not associate with any dataset \n"
" axis_types = <6-tuple of int>: the AXISTYPE codes for the axes \n"
" axis_names = <6-tuple of string>: the names of the axes \n"
" axis_units = <6-tuple of string>: the units of a non-calendar-time axis, or \n"
" the CALTYPE_ calendar name of a calendar-time axis \n"
" axis_coords = <6-tuple of ndarray>: the axis coordinates \n"
" (ndarray of N doubles for a non-calendar-time, non-normal axis, or \n"
" ndarray of (N,6) integers for a calendar-time axis; \n"
" None - or any object - for a normal axis) \n"
"\n"
"Optional arguments: \n"
" (none) \n"
"\n"
"Returns: \n"
" None \n"
"\n"
"Raises: \n"
" ValueError if there is a problem with the argument data passed \n"
" MemoryError if Ferret has not been started or has been stopped \n";
static PyObject *pyferretPutData(PyObject *self, PyObject *args, PyObject *kwds)
{
static char *argNames[] = {"codename", "title", "data", "bdfval", "units", "dset",
"axis_types", "axis_names", "axis_units", "axis_coords", NULL};
char *codename;
char *title;
PyObject *data_ndarray;
PyObject *bdfval_ndarray;
char *units;
char *dset;
PyObject *axis_types_tuple;
PyObject *axis_names_tuple;
PyObject *axis_units_tuple;
PyObject *axis_coords_tuple;
double bdfval;
int k;
PyObject *seqitem;
AXISTYPE axis_types[MAX_FERRET_NDIM];
char *strptr;
char axis_names[MAX_FERRET_NDIM][64];
char axis_units[MAX_FERRET_NDIM][64];
int num_coords[MAX_FERRET_NDIM];
void *axis_coords[MAX_FERRET_NDIM];
CALTYPE calendar_type;
int axis_nums[MAX_FERRET_NDIM];
int axis_starts[MAX_FERRET_NDIM];
int axis_ends[MAX_FERRET_NDIM];
int len_codename;
int len_title;
int len_units;
int len_dset;
char errmsg[2048];
int len_errmsg;
/* If not initialized, raise a MemoryError */
if ( ! MODULE_STATE(self)->initialized ) {
PyErr_SetString(PyExc_MemoryError, "Ferret not started");
return NULL;
}
/* Parse the arguments, checking if an Exception was raised - borrowed references to the PyObjects */
if ( ! PyArg_ParseTupleAndKeywords(args, kwds, "ssOOssOOOO", argNames, &codename, &title,
&data_ndarray, &bdfval_ndarray, &units, &dset, &axis_types_tuple,
&axis_names_tuple, &axis_units_tuple, &axis_coords_tuple) )
return NULL;
/* PyArray_Size returns 0 if the object is not an appropriate type */
/* ISFARRAY_RO checks if it is F-contiguous, aligned, and in machine byte-order */
if ( (PyArray_Size(data_ndarray) < 1) || (PyArray_TYPE(data_ndarray) != NPY_DOUBLE) ||
(! PyArray_ISFARRAY_RO(data_ndarray)) || (! PyArray_CHKFLAGS(data_ndarray, NPY_OWNDATA)) ) {
PyErr_SetString(PyExc_ValueError, "data is not an appropriate ndarray of type float64");
return NULL;
}
/* PyArray_Size returns 0 if the object is not an appropriate type */
/* ISBEHAVED_RO checks if it is aligned and in machine byte-order */
if ( (PyArray_Size(bdfval_ndarray) < 1) || (PyArray_TYPE(bdfval_ndarray) != NPY_DOUBLE) ||
(! PyArray_ISBEHAVED_RO(bdfval_ndarray)) ) {
PyErr_SetString(PyExc_ValueError, "bdfval is not an appropriate ndarray of type float64");
return NULL;
}
/* Just get bdfval from the data in bdfval_ndarray */
bdfval = ((double *)PyArray_DATA(bdfval_ndarray))[0];
/* Get the axis types out of the tuple */
axis_types_tuple = PySequence_Fast(axis_types_tuple, "axis_types is not a tuple or list");
if ( axis_types_tuple == NULL ) {
return NULL;
}
if ( PySequence_Fast_GET_SIZE(axis_types_tuple) != MAX_FERRET_NDIM ) {
PyErr_SetString(PyExc_ValueError, "axis_types does not have the expected number of items");
Py_DECREF(axis_types_tuple);
return NULL;
}
for (k = 0; k < MAX_FERRET_NDIM; k++) {
seqitem = PySequence_Fast_GET_ITEM(axis_types_tuple, k); /* borrowed reference */
axis_types[k] = (int) PyInt_AsLong(seqitem);
if ( (axis_types[k] != AXISTYPE_LONGITUDE) &&
(axis_types[k] != AXISTYPE_LATITUDE) &&
(axis_types[k] != AXISTYPE_LEVEL) &&
(axis_types[k] != AXISTYPE_TIME) &&
(axis_types[k] != AXISTYPE_CUSTOM) &&
(axis_types[k] != AXISTYPE_ABSTRACT) &&
(axis_types[k] != AXISTYPE_NORMAL) ) {
PyErr_SetString(PyExc_ValueError, "Invalid axis_types item");
Py_DECREF(axis_types_tuple);
return NULL;
}
}
Py_DECREF(axis_types_tuple);
/* Get the axis names out of the tuple */
axis_names_tuple = PySequence_Fast(axis_names_tuple, "axis_names is not a tuple or list");
if ( axis_names_tuple == NULL ) {
return NULL;
}
if ( PySequence_Fast_GET_SIZE(axis_names_tuple) != MAX_FERRET_NDIM ) {
PyErr_SetString(PyExc_ValueError, "axis_names does not have the expected number of items");
Py_DECREF(axis_names_tuple);
return NULL;
}
for (k = 0; k < MAX_FERRET_NDIM; k++) {
seqitem = PySequence_Fast_GET_ITEM(axis_names_tuple, k); /* borrowed reference */
strptr = PyString_AsString(seqitem);
if ( strptr == NULL ) {
PyErr_Clear();
PyErr_SetString(PyExc_ValueError, "Invalid axis_names item");
Py_DECREF(axis_names_tuple);
return NULL;
}
strncpy(axis_names[k], strptr, 64);
axis_names[k][63] = '\0';
}
Py_DECREF(axis_names_tuple);
/* Get the axis units out of the tuple */
axis_units_tuple = PySequence_Fast(axis_units_tuple, "axis_units is not a tuple or list");
if ( axis_units_tuple == NULL ) {
return NULL;
}
if ( PySequence_Fast_GET_SIZE(axis_units_tuple) != MAX_FERRET_NDIM ) {
PyErr_SetString(PyExc_ValueError, "axis_units does not have the expected number of items");
Py_DECREF(axis_units_tuple);
return NULL;
}
for (k = 0; k < MAX_FERRET_NDIM; k++) {
seqitem = PySequence_Fast_GET_ITEM(axis_units_tuple, k); /* borrowed reference */
strptr = PyString_AsString(seqitem);
if ( strptr == NULL ) {
PyErr_Clear();
PyErr_SetString(PyExc_ValueError, "Invalid axis_units item");
Py_DECREF(axis_units_tuple);
return NULL;
}
strncpy(axis_units[k], strptr, 64);
axis_units[k][63] = '\0';
}
Py_DECREF(axis_units_tuple);
/* Get the axis coordinates ndarray out of the tuple */
axis_coords_tuple = PySequence_Fast(axis_coords_tuple, "axis_coords is not a tuple or list");
if ( axis_coords_tuple == NULL ) {
return NULL;
}
if ( PySequence_Fast_GET_SIZE(axis_coords_tuple) != MAX_FERRET_NDIM ) {
PyErr_SetString(PyExc_ValueError, "axis_coords does not have the expected number of items");
Py_DECREF(axis_coords_tuple);
return NULL;
}
for (k = 0; k < MAX_FERRET_NDIM; k++) {
seqitem = PySequence_Fast_GET_ITEM(axis_coords_tuple, k); /* borrowed reference */
switch( axis_types[k] ) {
case AXISTYPE_LONGITUDE:
case AXISTYPE_LATITUDE:
case AXISTYPE_LEVEL:
case AXISTYPE_CUSTOM:
case AXISTYPE_ABSTRACT:
/* float64 N-ndarray containing the axis coordinates */
/* PyArray_Size returns 0 if the object is not an appropriate type */
/* ISCARRAY_RO checks if it is C-contiguous, aligned and in machine byte-order */
num_coords[k] = PyArray_Size(seqitem);
if ( num_coords[k] < 1 ) {
PyErr_SetString(PyExc_ValueError, "a standard axis of axis_coords has an invalid number of coordinates");
Py_DECREF(axis_coords_tuple);
return NULL;
}
if ( PyArray_TYPE(seqitem) != NPY_DOUBLE ) {
PyErr_SetString(PyExc_ValueError, "a standard axis of axis_coords has an invalid type");
Py_DECREF(axis_coords_tuple);
return NULL;
}
if ( ! PyArray_ISCARRAY_RO(seqitem) ) {
PyErr_SetString(PyExc_ValueError, "a standard axis of axis_coords is not an appropriate ndarray");
Py_DECREF(axis_coords_tuple);
return NULL;
}
axis_coords[k] = (int *)PyArray_DATA(seqitem);
get_axis_num_(&(axis_nums[k]), &(axis_starts[k]), &(axis_ends[k]), axis_names[k],
axis_units[k], axis_coords[k], &(num_coords[k]), &(axis_types[k]),
errmsg, &len_errmsg, strlen(axis_names[k]), strlen(axis_units[k]), 2048);
if ( len_errmsg > 0 ) {
errmsg[len_errmsg] = '\0';
PyErr_SetString(PyExc_ValueError, errmsg);
Py_DECREF(axis_coords_tuple);
return NULL;
}
break;
case AXISTYPE_TIME:
/* int32 (N,6)-ndarray containing component time values; the calendar given in axis_units */
/* PyArray_Size returns 0 if the object is not an appropriate type */
/* ISCARRAY_RO checks if it is C-contiguous, aligned and in machine byte-order */
num_coords[k] = PyArray_Size(seqitem);
if ( (num_coords[k] < 1) || ((num_coords[k] % 6) != 0) ) {
PyErr_SetString(PyExc_ValueError, "an absolute-time axis of axis_coords has an invalid number of coordinates");
Py_DECREF(axis_coords_tuple);
return NULL;
}
if ( (PyArray_TYPE(seqitem) != NPY_INT) &&
((PyArray_TYPE(seqitem) != NPY_LONG) || (NPY_SIZEOF_LONG != 4)) ) {
PyErr_SetString(PyExc_ValueError, "an absolute-time axis of axis_coords has an invalid type");
Py_DECREF(axis_coords_tuple);
return NULL;
}
if ( ! PyArray_ISCARRAY_RO(seqitem) ) {
PyErr_SetString(PyExc_ValueError, "an absolute-time axis of axis_coords is not an appropriate ndarray");
Py_DECREF(axis_coords_tuple);
return NULL;
}
num_coords[k] /= 6;
if ( strcmp(axis_units[k], CALTYPE_NONE_STR) == 0 ) {
calendar_type = CALTYPE_NONE;
}
else if ( strcmp(axis_units[k], CALTYPE_360DAY_STR) == 0 ) {
calendar_type = CALTYPE_360DAY;
}
else if ( strcmp(axis_units[k], CALTYPE_NOLEAP_STR) == 0 ) {
calendar_type = CALTYPE_NOLEAP;
}
else if ( strcmp(axis_units[k], CALTYPE_GREGORIAN_STR) == 0 ) {
calendar_type = CALTYPE_GREGORIAN;
}
else if ( strcmp(axis_units[k], CALTYPE_JULIAN_STR) == 0 ) {
calendar_type = CALTYPE_JULIAN;
}
else if ( strcmp(axis_units[k], CALTYPE_ALLLEAP_STR) == 0 ) {
calendar_type = CALTYPE_ALLLEAP;
}
else {
PyErr_SetString(PyExc_ValueError, "unknown calendar");
Py_DECREF(axis_coords_tuple);
return NULL;
}
axis_coords[k] = (int *)PyArray_DATA(seqitem);
get_time_axis_num_(&(axis_nums[k]), &(axis_starts[k]), &(axis_ends[k]),
axis_names[k], &calendar_type, axis_coords[k], &(num_coords[k]),
errmsg, &len_errmsg, strlen(axis_names[k]), 2048);
if ( len_errmsg > 0 ) {
errmsg[len_errmsg] = '\0';
PyErr_SetString(PyExc_ValueError, errmsg);
Py_DECREF(axis_coords_tuple);
return NULL;
}
break;
case AXISTYPE_NORMAL:
/* axis normal to the results - ignore sequence item (probably None) */
axis_nums[k] = 0; /* ferret.parm value for a normal line (mnormal) */
axis_starts[k] = 0;
axis_ends[k] = 0;
break;
default:
PyErr_SetString(PyExc_ValueError, "Unexpected axis_type when processing axis coordinates");
Py_DECREF(axis_coords_tuple);
return NULL;
}
}
/* The information in axis_coords_tuple no longer needed */
Py_DECREF(axis_coords_tuple);
/* Assign the data in the XPYVAR_INFO common block */
len_codename = strlen(codename);
len_title = strlen(title);
len_units = strlen(units);
len_dset = strlen(dset);
add_pystat_var_(&data_ndarray, codename, title, units, &bdfval, dset,
axis_nums, axis_starts, axis_ends, errmsg, &len_errmsg,
len_codename, len_title, len_units, len_dset, 2048);
if ( len_errmsg > 0 ) {
errmsg[len_errmsg] = '\0';
PyErr_SetString(PyExc_ValueError, errmsg);
return NULL;
}
/*
* Increase the reference count to data_ndarray to keep it around.
* A pointer to it is stored in the XPYVAR_INFO common block.
* The reference count will be decremented by Ferret when no longer needed.
*/
Py_INCREF(data_ndarray);
Py_INCREF(Py_None);
return Py_None;
}
static char pyferretGetStrDataDocstring[] =
"Returns the String data array described in the argument. \n"
"\n"
"Required arguments: \n"
" name = <string>: the name of the String data array to return \n"
"\n"
"Optional arguments: \n"
" (none) \n"
"\n"
"Returns: \n"
" A tuple containing: \n"
" a NumPy String ndarray containing a copy of the numeric data requested, \n"
" a NumPy String ndarray containing the bad-data-flag value for the data, \n"
" a tuple of six integers giving the AXISTYPE codes of the axes, \n"
" a tuple of six strings giving the names of the axes, \n"
" a tuple of six strings giving the units of a non-calendar-time data axis, or \n"
" the CALTYPE_ calendar name of a calendar-time axis, \n"
" a tuple of six ndarrays giving the coordinates for the data axes \n"
" (ndarray of N doubles for non-calendar-time, non-normal axes, \n"
" ndarray of (N,6) integers for calendar-time axes, or \n"
" None for normal axes) \n"
"\n"
"Raises: \n"
" ValueError if the data name is invalid \n"
" MemoryError if Ferret has not been started or has been stopped \n";
static PyObject *pyferretGetStrData(PyObject *self, PyObject *args, PyObject *kwds)
{
static char *argNames[] = {"name", NULL};
char *name;
int lendataname;
char dataname[1024];
int arraystart;
int memlo[MAX_FERRET_NDIM], memhi[MAX_FERRET_NDIM];
int steplo[MAX_FERRET_NDIM], stephi[MAX_FERRET_NDIM], incr[MAX_FERRET_NDIM];
AXISTYPE axis_types[MAX_FERRET_NDIM];
char errmsg[2112];
int lenerrmsg;
int i, j, k, l, m, n, q;
npy_intp shape[MAX_FERRET_NDIM];
npy_intp new_shape[2];
int strides[MAX_FERRET_NDIM];
PyObject *data_ndarray;
void **ferdata;
char *strptr;
int maxstrlen;
int thisstrlen;
PyArray_Descr *strarraydescript;
char *npydata;
PyObject *badval_ndarray;
PyObject *axis_coords[MAX_FERRET_NDIM];
char axis_units[MAX_FERRET_NDIM][64];
char axis_names[MAX_FERRET_NDIM][64];
CALTYPE calendar_type;
struct pyferret_module *module = MODULE_STATE(self);
/* If not initialized, raise a MemoryError */
if ( ! module->initialized ) {
PyErr_SetString(PyExc_MemoryError, "Ferret not started");
return NULL;
}
/* Parse the arguments, checking if an Exception was raised */
if ( ! PyArg_ParseTupleAndKeywords(args, kwds, "s", argNames, &name) )
return NULL;
/* Make a copy of dataname just to be sure it isn't altered */
lendataname = strlen(name);
if ( lendataname > 1020 ) {
PyErr_SetString(PyExc_ValueError, "name too long");
return NULL;
}
strcpy(dataname, name);
/*
* Retrieve the memory parameters describing the data array requested.
* Assumes Unix standard for passing strings to Fortran (appended array lengths).
*/
get_str_data_array_params_(dataname, &lendataname, module->ferMemory, &arraystart,
memlo, memhi, steplo, stephi, incr, axis_types,
errmsg, &lenerrmsg, 1024, 64, 2112);
if ( lenerrmsg > 0 ) {
errmsg[lenerrmsg] = '\0';
PyErr_SetString(PyExc_ValueError, errmsg);
return NULL;
}
/* Get the shape of the array */
for (k = 0; k < MAX_FERRET_NDIM; k++)
shape[k] = (npy_intp) ((stephi[k] - steplo[k] + incr[k]) / (incr[k]));
/* Get the strides through the memory (as a double *) */
strides[0] = 1;
for (k = 1; k < MAX_FERRET_NDIM; k++)
strides[k] = strides[k-1] * (memhi[k-1] - memlo[k-1] + 1);
/* Get the actual starting point in the array */
for (k = 0; k < MAX_FERRET_NDIM; k++)
arraystart += (strides[k]) * (steplo[k] - memlo[k]);
/* Convert to strides through places in memory to be read */
for (k = 0; k < MAX_FERRET_NDIM; k++)
strides[k] *= incr[k];
/*
* Note: for string arrays, each "double" is a pointer
* to allocated memory containing a null-terminated string;
* or null for missing strings.
*/
/* Get the maximum string length of all the strings in this array */
ferdata = (void **) (module->ferMemory + arraystart);
/* Use STRING_MISSING_VALUE for missing strings */
maxstrlen = (int)(strlen(STRING_MISSING_VALUE) + 1);
for (n = 0; n < (int)(shape[5]); n++) {
for (m = 0; m < (int)(shape[4]); m++) {
for (l = 0; l < (int)(shape[3]); l++) {
for (k = 0; k < (int)(shape[2]); k++) {
for (j = 0; j < (int)(shape[1]); j++) {
for (i = 0; i < (int)(shape[0]); i++) {
strptr = (char *) ferdata[ i * strides[0] +
j * strides[1] +
k * strides[2] +
l * strides[3] +
m * strides[4] +
n * strides[5] ];
if ( strptr != NULL ) {
/* add one so always null-terminated */
thisstrlen = (int)(strlen(strptr) + 1);
if ( maxstrlen < thisstrlen ) {
maxstrlen = thisstrlen;
}
}
}
}
}
}
}
}
/* Create a new NumPy String ndarray (Fortran ordering) with the same shape */
strarraydescript = PyArray_DescrNewFromType(NPY_STRING);
strarraydescript->elsize = maxstrlen;
data_ndarray = PyArray_Empty(MAX_FERRET_NDIM, shape, strarraydescript, 1);
if ( data_ndarray == NULL ) {
return NULL;
}
/* PyArray_Empty steals the reference to strarraydescript so do not free or reuse */
/*
* Assign the data in the new ndarray.
* Note: if MAX_FERRET_NDIM changes, this needs editing.
*/
npydata = (char *)PyArray_DATA(data_ndarray);
q = 0;
for (n = 0; n < (int)(shape[5]); n++) {
for (m = 0; m < (int)(shape[4]); m++) {
for (l = 0; l < (int)(shape[3]); l++) {
for (k = 0; k < (int)(shape[2]); k++) {
for (j = 0; j < (int)(shape[1]); j++) {
for (i = 0; i < (int)(shape[0]); i++) {
strptr = (char *) ferdata[ i * strides[0] +
j * strides[1] +
k * strides[2] +
l * strides[3] +
m * strides[4] +
n * strides[5] ];
if ( strptr == NULL ) {
strptr = STRING_MISSING_VALUE;
}
/* because of +1 to strlen, these will always be null-terminated */
strncpy(&(npydata[q]), strptr, maxstrlen);
q += maxstrlen;
}
}
}
}
}
}
/* Create a new NumPy String ndarray with the bad-data-flag value */
new_shape[0] = 1;
strarraydescript = PyArray_DescrNewFromType(NPY_STRING);
strarraydescript->elsize = maxstrlen;
badval_ndarray = PyArray_Empty(1, new_shape, strarraydescript, 0);
if ( badval_ndarray == NULL ) {
Py_DECREF(data_ndarray);
return NULL;
}
/* PyArray_Empty steals the reference to strarraydescript so do not free or reuse */
npydata = (char *)PyArray_DATA(badval_ndarray);
strncpy(npydata, STRING_MISSING_VALUE, maxstrlen);
/* Create the axis coordinates array objects */
for (k = 0; k < MAX_FERRET_NDIM; k++) {
switch( axis_types[k] ) {
case AXISTYPE_LONGITUDE:
case AXISTYPE_LATITUDE:
case AXISTYPE_LEVEL:
case AXISTYPE_CUSTOM:
case AXISTYPE_ABSTRACT:
/* array of doubles, possibly with a units string */
axis_coords[k] = PyArray_SimpleNew(1, &(shape[k]), NPY_DOUBLE);
if ( axis_coords[k] == NULL ) {
while ( k > 0 ) {
k--;
Py_DECREF(axis_coords[k]);
}
Py_DECREF(badval_ndarray);
Py_DECREF(data_ndarray);
return NULL;
}
/* get the coordinates and the units string */
q = k+1;
j = (int) shape[k];
get_data_array_coords_((double *)PyArray_DATA(axis_coords[k]), axis_units[k],
axis_names[k], &q, &j, errmsg, &lenerrmsg, 64, 64, 2112);
if ( lenerrmsg > 0 ) {
errmsg[lenerrmsg] = '\0';
PyErr_SetString(PyExc_ValueError, errmsg);
Py_DECREF(axis_coords[k]);
while ( k > 0 ) {
k--;
Py_DECREF(axis_coords[k]);
}
Py_DECREF(badval_ndarray);
Py_DECREF(data_ndarray);
return NULL;
}
break;
case AXISTYPE_TIME:
/* array of 6-tuples of integers in C order, so: [N][6] in C or (6,N) in Fortran */
new_shape[0] = shape[k];
new_shape[1] = 6;
axis_coords[k] = PyArray_SimpleNew(2, new_shape, NPY_INT);
if ( axis_coords[k] == NULL ) {
while ( k > 0 ) {
k--;
Py_DECREF(axis_coords[k]);
}
Py_DECREF(badval_ndarray);
Py_DECREF(data_ndarray);
return NULL;
}
/* get the time coordinate integers */
q = k+1;
j = (int) shape[k];
get_data_array_time_coords_((int (*)[6])PyArray_DATA(axis_coords[k]), &calendar_type, axis_names[k],
&q, &j, errmsg, &lenerrmsg, 64, 2112);
if ( lenerrmsg > 0 ) {
errmsg[lenerrmsg] = '\0';
PyErr_SetString(PyExc_ValueError, errmsg);
Py_DECREF(axis_coords[k]);
while ( k > 0 ) {
k--;
Py_DECREF(axis_coords[k]);
}
Py_DECREF(badval_ndarray);
Py_DECREF(data_ndarray);
return NULL;
}
/* set the axis units to the name of the calendar */
switch( calendar_type ) {
case CALTYPE_NONE:
strcpy(axis_units[k], CALTYPE_NONE_STR);
break;
case CALTYPE_360DAY:
strcpy(axis_units[k], CALTYPE_360DAY_STR);
break;
case CALTYPE_NOLEAP:
strcpy(axis_units[k], CALTYPE_NOLEAP_STR);
break;
case CALTYPE_GREGORIAN:
strcpy(axis_units[k], CALTYPE_GREGORIAN_STR);
break;
case CALTYPE_JULIAN:
strcpy(axis_units[k], CALTYPE_JULIAN_STR);
break;
case CALTYPE_ALLLEAP:
strcpy(axis_units[k], CALTYPE_ALLLEAP_STR);
break;
default:
sprintf(errmsg, "Unexpected calendar type of %d", calendar_type);
PyErr_SetString(PyExc_ValueError, errmsg);
Py_DECREF(axis_coords[k]);
while ( k > 0 ) {
k--;
Py_DECREF(axis_coords[k]);
}
Py_DECREF(badval_ndarray);
Py_DECREF(data_ndarray);
return NULL;
}
break;
case AXISTYPE_NORMAL:
/* axis normal to the results - no coordinates */
Py_INCREF(Py_None);
axis_coords[k] = Py_None;
axis_units[k][0] = '\0';
axis_names[k][0] = '\0';
break;
default:
sprintf(errmsg, "Unexpected axis type of %d", axis_types[k]);
PyErr_SetString(PyExc_RuntimeError, errmsg);
while ( k > 0 ) {
k--;
Py_DECREF(axis_coords[k]);
}
Py_DECREF(badval_ndarray);
Py_DECREF(data_ndarray);
return NULL;
}
}
/*
* Return a tuple (stealing references for PyObjects) of data_ndarray,
* axis_types, axis_names, axis_units, and axis_coords.
* Note: if MAX_FERRET_NDIM changes, this needs editing.
*/
return Py_BuildValue("NN(iiiiii)(ssssss)(ssssss)(NNNNNN)", data_ndarray, badval_ndarray,
axis_types[0], axis_types[1], axis_types[2], axis_types[3], axis_types[4], axis_types[5],
axis_names[0], axis_names[1], axis_names[2], axis_names[3], axis_names[4], axis_names[5],
axis_units[0], axis_units[1], axis_units[2], axis_units[3], axis_units[4], axis_units[5],
axis_coords[0], axis_coords[1], axis_coords[2], axis_coords[3], axis_coords[4], axis_coords[5]);
}
static char pyferretStopDocstring[] =
"Runs a series of Ferret commands to return Ferret to \n"
"its default state, then shuts down and releases all \n"
"memory used by Ferret. After calling this function do \n"
"not call any Ferret functions except start, which will \n"
"restart Ferret and re-enable the other functions. \n"
"\n"
"Required arguments: \n"
" (none) \n"
"\n"
"Optional arguments: \n"
" (none) \n"
"\n"
"Returns: \n"
" False if Ferret has not been started or has already been stopped \n"
" True otherwise \n";
static PyObject *pyferretStop(PyObject *self)
{
struct pyferret_module *module = MODULE_STATE(self);
/* If not initialized, return False */
if ( ! module->initialized ) {
Py_INCREF(Py_False);
return Py_False;
}
/* Set to uninitialized */
module->initialized = 0;
pyf_module = NULL;
/* Release the references to the pyferret and pyferret.graphbind modules */
Py_DECREF(pyferret_graphbind_module_pyobject);
pyferret_graphbind_module_pyobject = NULL;
Py_DECREF(pyferret_module_pyobject);
pyferret_module_pyobject = NULL;
/* Run commands to clear/reset Ferret's state */
ferret_dispatch_c(module->ferMemory, "SET GRID ABSTRACT", sBuffer);
ferret_dispatch_c(module->ferMemory, "CANCEL WINDOW /ALL", sBuffer);
ferret_dispatch_c(module->ferMemory, "CANCEL VARIABLE /ALL", sBuffer);
ferret_dispatch_c(module->ferMemory, "CANCEL SYMBOL /ALL", sBuffer);
ferret_dispatch_c(module->ferMemory, "CANCEL DATA /ALL", sBuffer);
ferret_dispatch_c(module->ferMemory, "CANCEL REGION /ALL", sBuffer);
ferret_dispatch_c(module->ferMemory, "CANCEL MEMORY /ALL", sBuffer);
ferret_dispatch_c(module->ferMemory, "EXIT /PROGRAM", sBuffer);
/* Free memory allocated inside Ferret */
finalize_();
/* Free memory allocated for Ferret */
PyMem_Free(module->ferMemory);
module->ferMemory = NULL;
module->ferMemSize = 0;
PyMem_Free(module->pplMemory);
module->pplMemory = NULL;
/* Return True */
Py_INCREF(Py_True);
return Py_True;
}
static char pyferretQuitDocstring[] =
"Shuts down and release all memory used by Ferret. \n"
"This function is intended to be used with the atexit module \n"
"to ensure an open viewer window does not hang Python shutdown. \n"
"\n"
"Required arguments: \n"
" (none) \n"
"\n"
"Optional arguments: \n"
" (none) \n"
"\n"
"Returns: \n"
" None \n";
static PyObject *pyferretQuit(PyObject *self)
{
struct pyferret_module *module = MODULE_STATE(self);
/* If not initialized, nothing to do; just return None */
if ( ! module->initialized ) {
Py_INCREF(Py_None);
return Py_None;
}
/* Set to uninitialized */
module->initialized = 0;
/* Release the references to the pyferret and pyferret.graphbind modules */
Py_DECREF(pyferret_graphbind_module_pyobject);
pyferret_graphbind_module_pyobject = NULL;
Py_DECREF(pyferret_module_pyobject);
pyferret_module_pyobject = NULL;
/* Let Ferret do its orderly shutdown - including closing viewers */
ferret_dispatch_c(module->ferMemory, "EXIT /PROGRAM", sBuffer);
/* Free memory allocated inside Ferret */
finalize_();
/* Free memory allocated for Ferret */
PyMem_Free(module->ferMemory);
module->ferMemory = NULL;
module->ferMemSize = 0;
PyMem_Free(module->pplMemory);
module->pplMemory = NULL;
/* Return None */
Py_INCREF(Py_None);
return Py_None;
}
static char pyefcnGetAxisCoordinatesDocstring[] =
"Returns the \"world\" coordinates for an axis of an argument to an external function\n"
"\n"
"Required arguments: \n"
" id = <int>: the ferret id of the external function \n"
" arg = <int>: the index (zero based) of the argument (can use ARG1, ARG2, ..., ARG9) \n"
" axis = <int>: the index (zero based) of the axis (can use X_AXIS, Y_AXIS, Z_AXIS, \n"
" T_AXIS, E_AXIS, F_AXIS) \n"
"\n"
"Optional arguments: \n"
" (none) \n"
"\n"
"Returns: \n"
" a NumPy float64 ndarray containing the \"world\" coordinates, \n"
" or None if the values cannot be determined at the time this was called \n"
"\n"
"Raises: \n"
" ValueError if id, arg, or axis is invalid \n";
static PyObject *pyefcnGetAxisCoordinates(PyObject *self, PyObject *args, PyObject *kwds)
{
static char *argNames[] = {"id", "arg", "axis", NULL};
int id, arg, axis;
ExternalFunction *ef_ptr;
int steplo[EF_MAX_COMPUTE_ARGS][MAX_FERRET_NDIM];
int stephi[EF_MAX_COMPUTE_ARGS][MAX_FERRET_NDIM];
int incr[EF_MAX_COMPUTE_ARGS][MAX_FERRET_NDIM];
int lo, hi;
npy_intp shape[1];
PyObject *coords_ndarray;
/* Parse the arguments, checking if an Exception was raised */
if ( ! PyArg_ParseTupleAndKeywords(args, kwds, "iii", argNames, &id, &arg, &axis) )
return NULL;
/* Check for obvious errors in the arguments passed */
ef_ptr = ef_ptr_from_id_ptr(&id);
if ( (ef_ptr == NULL) || ! ef_ptr->already_have_internals ) {
PyErr_SetString(PyExc_ValueError, "Invalid ferret external function id");
return NULL;
}
if ( (arg < 0) || (arg >= EF_MAX_ARGS) ||
((arg >= ef_ptr->internals_ptr->num_reqd_args) && ! ef_ptr->internals_ptr->has_vari_args) ) {
PyErr_SetString(PyExc_ValueError, "Invalid argument index");
return NULL;
}
if ( (axis < 0) || (axis >= MAX_FERRET_NDIM) ) {
PyErr_SetString(PyExc_ValueError, "Invalid axis index");
return NULL;
}
/* Catch seg faults from indiscriminately calling this function */
if ( setjmp(jumpbuffer) == 1 ) {
signal(SIGSEGV, segv_handler);
PyErr_SetString(PyExc_ValueError, "Invalid function call - probably not from a ferret external function call");
return NULL;
}
segv_handler = signal(SIGSEGV, pyefcn_signal_handler);
if ( segv_handler == SIG_ERR ) {
PyErr_SetString(PyExc_ValueError, "Unable to catch SIGSEGV");
return NULL;
}
/* Get the subscripts for all of the arguments */
ef_get_arg_subscripts_6d_(&id, steplo, stephi, incr);
/* Restore the original segv handler */
signal(SIGSEGV, segv_handler);
/* Check the indices for the coordinates of the desired axis of the argument */
if ( (steplo[arg][axis] == UNSPECIFIED_INT4) || (stephi[arg][axis] == UNSPECIFIED_INT4) ||
((steplo[arg][axis] == 1) && (stephi[arg][axis] == ABSTRACT_AXIS_LEN)) ) {
Py_INCREF(Py_None);
return Py_None;
}
/* Create a NumPy float64 ndarray to get the memory for the coordinates */
if ( incr[arg][axis] == 0 ) {
if ( steplo[arg][axis] <= stephi[arg][axis] )
incr[arg][axis] = 1;
else
incr[arg][axis] = -1;
}
shape[0] = (Py_ssize_t) ((stephi[arg][axis] - steplo[arg][axis] + incr[arg][axis]) / incr[arg][axis]);
coords_ndarray = PyArray_SimpleNew(1, shape, NPY_DOUBLE);
if ( coords_ndarray == NULL ) {
return NULL;
}
/* Get the full range of world coordinates for the requested axis */
lo = steplo[arg][axis];
hi = stephi[arg][axis];
arg++;
axis++;
ef_get_coordinates_(&id, &arg, &axis, &lo, &hi, (double *)PyArray_DATA(coords_ndarray));
return coords_ndarray;
}
static char pyefcnGetAxisBoxSizesDocstring[] =
"Returns the \"box sizes\", in \"world\" coordinate units, \n"
"for an axis of an argument to an external function \n"
"\n"
"Required arguments: \n"
" id = <int>: the ferret id of the external function \n"
" arg = <int>: the index (zero based) of the argument (can use ARG1, ARG2, ..., ARG9) \n"
" axis = <int>: the index (zero based) of the axis (can use X_AXIS, Y_AXIS, Z_AXIS, \n"
" T_AXIS, E_AXIS, F_AXIS) \n"
"\n"
"Optional arguments: \n"
" (none) \n"
"\n"
"Returns: \n"
" a NumPy float64 ndarray containing the \"box sizes\", \n"
" or None if the values cannot be determined at the time this was called \n"
"\n"
"Raises: \n"
" ValueError if id, arg, or axis is invalid \n";
static PyObject *pyefcnGetAxisBoxSizes(PyObject *self, PyObject *args, PyObject *kwds)
{
static char *argNames[] = {"id", "arg", "axis", NULL};
int id, arg, axis;
ExternalFunction *ef_ptr;
int steplo[EF_MAX_COMPUTE_ARGS][MAX_FERRET_NDIM];
int stephi[EF_MAX_COMPUTE_ARGS][MAX_FERRET_NDIM];
int incr[EF_MAX_COMPUTE_ARGS][MAX_FERRET_NDIM];
int lo, hi;
npy_intp shape[1];
PyObject *sizes_ndarray;
/* Parse the arguments, checking if an Exception was raised */
if ( ! PyArg_ParseTupleAndKeywords(args, kwds, "iii", argNames, &id, &arg, &axis) )
return NULL;
/* Check for obvious errors in the arguments passed */
ef_ptr = ef_ptr_from_id_ptr(&id);
if ( (ef_ptr == NULL) || ! ef_ptr->already_have_internals ) {
PyErr_SetString(PyExc_ValueError, "Invalid ferret external function id");
return NULL;
}
if ( (arg < 0) || (arg >= EF_MAX_ARGS) ||
((arg >= ef_ptr->internals_ptr->num_reqd_args) && ! ef_ptr->internals_ptr->has_vari_args) ) {
PyErr_SetString(PyExc_ValueError, "Invalid argument index");
return NULL;
}
if ( (axis < 0) || (axis >= MAX_FERRET_NDIM) ) {
PyErr_SetString(PyExc_ValueError, "Invalid axis index");
return NULL;
}
/* Catch seg faults from indiscriminately calling this function */
if ( setjmp(jumpbuffer) == 1 ) {
signal(SIGSEGV, segv_handler);
PyErr_SetString(PyExc_ValueError, "Invalid function call - probably not from a ferret external function call");
return NULL;
}
segv_handler = signal(SIGSEGV, pyefcn_signal_handler);
if ( segv_handler == SIG_ERR ) {
PyErr_SetString(PyExc_ValueError, "Unable to catch SIGSEGV");
return NULL;
}
/* Get the subscripts for all of the arguments */
ef_get_arg_subscripts_6d_(&id, steplo, stephi, incr);
/* Restore the original segv handler */
signal(SIGSEGV, segv_handler);
/* Check the indices for the coordinates of the desired axis of the argument */
if ( (steplo[arg][axis] == UNSPECIFIED_INT4) || (stephi[arg][axis] == UNSPECIFIED_INT4) ||
((steplo[arg][axis] == 1) && (stephi[arg][axis] == ABSTRACT_AXIS_LEN)) ) {
Py_INCREF(Py_None);
return Py_None;
}
/* Create a NumPy float64 ndarray to get the memory for the box sizes */
if ( incr[arg][axis] == 0 ) {
if ( steplo[arg][axis] <= stephi[arg][axis] )
incr[arg][axis] = 1;
else
incr[arg][axis] = -1;
}
shape[0] = (Py_ssize_t) ((stephi[arg][axis] - steplo[arg][axis] + incr[arg][axis]) / incr[arg][axis]);
sizes_ndarray = PyArray_SimpleNew(1, shape, NPY_DOUBLE);
if ( sizes_ndarray == NULL ) {
return NULL;
}
/* Get the full range of box sizes for the requested axis */
lo = steplo[arg][axis];
hi = stephi[arg][axis];
arg++;
axis++;
ef_get_box_size_(&id, &arg, &axis, &lo, &hi, (double *)PyArray_DATA(sizes_ndarray));
return sizes_ndarray;
}
static char pyefcnGetAxisBoxLimitsDocstring[] =
"Returns the \"box limits\", in \"world\" coordinate units, \n"
"for an axis of an argument to an external function \n"
"\n"
"Required arguments: \n"
" id = <int>: the ferret id of the external function \n"
" arg = <int>: the index (zero based) of the argument (can use ARG1, ARG2, ..., ARG9) \n"
" axis = <int>: the index (zero based) of the axis (can use X_AXIS, Y_AXIS, Z_AXIS, \n"
" T_AXIS, E_AXIS, F_AXIS) \n"
"\n"
"Optional arguments: \n"
" (none) \n"
"\n"
"Returns: \n"
" a tuple of two NumPy float64 ndarrays containing the low and high \"box limits\", \n"
" or None if the values cannot be determined at the time this was called \n"
"\n"
"Raises: \n"
" ValueError if id, arg, or axis is invalid \n";
static PyObject *pyefcnGetAxisBoxLimits(PyObject *self, PyObject *args, PyObject *kwds)
{
static char *argNames[] = {"id", "arg", "axis", NULL};
int id, arg, axis;
ExternalFunction *ef_ptr;
int steplo[EF_MAX_COMPUTE_ARGS][MAX_FERRET_NDIM];
int stephi[EF_MAX_COMPUTE_ARGS][MAX_FERRET_NDIM];
int incr[EF_MAX_COMPUTE_ARGS][MAX_FERRET_NDIM];
int lo, hi;
npy_intp shape[1];
PyObject *low_limits_ndarray, *high_limits_ndarray;
/* Parse the arguments, checking if an Exception was raised */
if ( ! PyArg_ParseTupleAndKeywords(args, kwds, "iii", argNames, &id, &arg, &axis) )
return NULL;
/* Check for obvious errors in the arguments passed */
ef_ptr = ef_ptr_from_id_ptr(&id);
if ( (ef_ptr == NULL) || ! ef_ptr->already_have_internals ) {
PyErr_SetString(PyExc_ValueError, "Invalid ferret external function id");
return NULL;
}
if ( (arg < 0) || (arg >= EF_MAX_ARGS) ||
((arg >= ef_ptr->internals_ptr->num_reqd_args) && ! ef_ptr->internals_ptr->has_vari_args) ) {
PyErr_SetString(PyExc_ValueError, "Invalid argument index");
return NULL;
}
if ( (axis < 0) || (axis >= MAX_FERRET_NDIM) ) {
PyErr_SetString(PyExc_ValueError, "Invalid axis index");
return NULL;
}
/* Catch seg faults from indiscriminately calling this function */
if ( setjmp(jumpbuffer) == 1 ) {
signal(SIGSEGV, segv_handler);
PyErr_SetString(PyExc_ValueError, "Invalid function call - probably not from a ferret external function call");
return NULL;
}
segv_handler = signal(SIGSEGV, pyefcn_signal_handler);
if ( segv_handler == SIG_ERR ) {
PyErr_SetString(PyExc_ValueError, "Unable to catch SIGSEGV");
return NULL;
}
/* Get the subscripts for all of the arguments */
ef_get_arg_subscripts_6d_(&id, steplo, stephi, incr);
/* Restore the original segv handler */
signal(SIGSEGV, segv_handler);
/* Check the indices for the coordinates of the desired axis of the argument */
if ( (steplo[arg][axis] == UNSPECIFIED_INT4) || (stephi[arg][axis] == UNSPECIFIED_INT4) ||
((steplo[arg][axis] == 1) && (stephi[arg][axis] == ABSTRACT_AXIS_LEN)) ) {
Py_INCREF(Py_None);
return Py_None;
}
/* Create two NumPy float64 ndarrays to get the memory for the box limits */
if ( incr[arg][axis] == 0 ) {
if ( steplo[arg][axis] <= stephi[arg][axis] )
incr[arg][axis] = 1;
else
incr[arg][axis] = -1;
}
shape[0] = (Py_ssize_t) ((stephi[arg][axis] - steplo[arg][axis] + incr[arg][axis]) / incr[arg][axis]);
low_limits_ndarray = PyArray_SimpleNew(1, shape, NPY_DOUBLE);
if ( low_limits_ndarray == NULL ) {
return NULL;
}
high_limits_ndarray = PyArray_SimpleNew(1, shape, NPY_DOUBLE);
if ( high_limits_ndarray == NULL ) {
Py_DECREF(low_limits_ndarray);
return NULL;
}
/* Get the full range of box limits for the requested axis */
lo = steplo[arg][axis];
hi = stephi[arg][axis];
arg++;
axis++;
ef_get_box_limits_(&id, &arg, &axis, &lo, &hi, (double *)PyArray_DATA(low_limits_ndarray),
(double *)PyArray_DATA(high_limits_ndarray));
return Py_BuildValue("NN", low_limits_ndarray, high_limits_ndarray); /* Steals the references to the two ndarrays */
}
static char pyefcnGetAxisInfoDocstring[] =
"Returns information about the axis of an argument to an external function \n"
"\n"
"Required arguments: \n"
" id = <int>: the ferret id of the external function \n"
" arg = <int>: the index (zero based) of the argument (can use ARG1, ARG2, ..., ARG9) \n"
" axis = <int>: the index (zero based) of the axis (can use X_AXIS, Y_AXIS, Z_AXIS, \n"
" T_AXIS, E_AXIS, F_AXIS) \n"
"\n"
"Optional arguments: \n"
" (none) \n"
"\n"
"Returns: \n"
" a dictionary defining the following keys: \n"
" \"name\": name string for the axis coordinate \n"
" \"unit\": name string for the axis unit \n"
" \"backwards\": boolean - reversed axis? \n"
" \"modulo\": float - length of a modulo (periodic,wrapping) axis, \n"
" or 0.0 if not a modulo axis\n"
" \"regular\": boolean - evenly spaced axis? \n"
" \"size\": number of coordinates on this axis, or -1 if the value \n"
" cannot be determined at the time this was called \n"
"\n"
"Raises: \n"
" ValueError if id, arg, or axis is invalid \n";
static PyObject *pyefcnGetAxisInfo(PyObject *self, PyObject *args, PyObject *kwds)
{
static char *argNames[] = {"id", "arg", "axis", NULL};
int id, arg, axis;
ExternalFunction *ef_ptr;
int steplo[EF_MAX_COMPUTE_ARGS][MAX_FERRET_NDIM];
int stephi[EF_MAX_COMPUTE_ARGS][MAX_FERRET_NDIM];
int incr[EF_MAX_COMPUTE_ARGS][MAX_FERRET_NDIM];
int num_coords;
char name[80];
char unit[80];
int backwards;
int modulo;
int regular;
double modulolen;
PyObject *backwards_bool;
PyObject *regular_bool;
/* Parse the arguments, checking if an Exception was raised */
if ( ! PyArg_ParseTupleAndKeywords(args, kwds, "iii", argNames, &id, &arg, &axis) )
return NULL;
/* Check for obvious errors in the arguments passed */
ef_ptr = ef_ptr_from_id_ptr(&id);
if ( (ef_ptr == NULL) || ! ef_ptr->already_have_internals ) {
PyErr_SetString(PyExc_ValueError, "Invalid ferret external function id");
return NULL;
}
if ( (arg < 0) || (arg >= EF_MAX_ARGS) ||
((arg >= ef_ptr->internals_ptr->num_reqd_args) && ! ef_ptr->internals_ptr->has_vari_args) ) {
PyErr_SetString(PyExc_ValueError, "Invalid argument index");
return NULL;
}
if ( (axis < 0) || (axis >= MAX_FERRET_NDIM) ) {
PyErr_SetString(PyExc_ValueError, "Invalid axis index");
return NULL;
}
/* Catch seg faults from indiscriminately calling this function */
if ( setjmp(jumpbuffer) == 1 ) {
signal(SIGSEGV, segv_handler);
PyErr_SetString(PyExc_ValueError, "Invalid function call - probably not from a ferret external function call");
return NULL;
}
segv_handler = signal(SIGSEGV, pyefcn_signal_handler);
if ( segv_handler == SIG_ERR ) {
PyErr_SetString(PyExc_ValueError, "Unable to catch SIGSEGV");
return NULL;
}
/* Get the subscripts for all of the arguments */
ef_get_arg_subscripts_6d_(&id, steplo, stephi, incr);
/* Restore the original segv handler */
signal(SIGSEGV, segv_handler);
/* Check the indices for the coordinates of the desired axis of the argument */
if ( (steplo[arg][axis] == UNSPECIFIED_INT4) || (stephi[arg][axis] == UNSPECIFIED_INT4) ||
((steplo[arg][axis] == 1) && (stephi[arg][axis] == ABSTRACT_AXIS_LEN)) ) {
num_coords = -1;
}
else {
if ( incr[arg][axis] == 0 ) {
if ( steplo[arg][axis] <= stephi[arg][axis] )
incr[arg][axis] = 1;
else
incr[arg][axis] = -1;
}
num_coords = (stephi[arg][axis] - steplo[arg][axis] + incr[arg][axis]) / incr[arg][axis];
}
/* Get the rest of the info */
arg++;
axis++;
ef_get_single_axis_info_(&id, &arg, &axis, name, unit, &backwards, &modulo, ®ular, 80, 80);
if ( modulo != 0 )
ef_get_axis_modulo_len_(&id, &arg, &axis, &modulolen);
else
modulolen = 0.0;
/* Assign the Python bool objects */
if ( backwards != 0 )
backwards_bool = Py_True;
else
backwards_bool = Py_False;
if ( regular != 0 )
regular_bool = Py_True;
else
regular_bool = Py_False;
/* Using O for the booleans to increment the references to these objects */
return Py_BuildValue("{sssssOsdsOsi}", "name", name, "unit", unit,
"backwards", backwards_bool, "modulo", modulolen,
"regular", regular_bool, "size", num_coords);
}
static char pyefcnGetArgOneValDocstring[] =
"Returns the value of the indicated FLOAT_ONEVAL or STRING_ONEVAL argument. \n"
"\n"
"Required arguments: \n"
" id = <int>: the ferret id of the external function \n"
" arg = <int>: the index (zero based) of the argument (can use ARG1, ARG2, ..., ARG9) \n"
"\n"
"Optional arguments: \n"
" (none) \n"
"\n"
"Returns: \n"
" the value of the argument, either as a float (if a FLOAT_ONEVAL) \n"
" or a string (if STRING_ONEVAL) \n"
"\n"
"Raises: \n"
" ValueError if id or arg is invalid, or if the argument type is not \n"
" FLOAT_ONEVAL or STRING_ONEVAL \n";
static PyObject *pyefcnGetArgOneVal(PyObject *self, PyObject *args, PyObject *kwds)
{
static char *argNames[] = {"id", "arg", NULL};
int id, arg;
ExternalFunction *ef_ptr;
PyObject *modname;
PyObject *usermod;
PyObject *initdict;
PyObject *typetuple;
PyObject *typeobj;
double float_val;
PyObject *valobj;
char str_val[2048];
int k;
/* Parse the arguments, checking if an Exception was raised */
if ( ! PyArg_ParseTupleAndKeywords(args, kwds, "ii", argNames, &id, &arg) )
return NULL;
/* Check for obvious errors in the arguments passed */
ef_ptr = ef_ptr_from_id_ptr(&id);
if ( (ef_ptr == NULL) || ! ef_ptr->already_have_internals ) {
PyErr_SetString(PyExc_ValueError, "Invalid ferret external function id");
return NULL;
}
if ( (arg < 0) || (arg >= EF_MAX_ARGS) ||
((arg >= ef_ptr->internals_ptr->num_reqd_args) && ! ef_ptr->internals_ptr->has_vari_args) ) {
PyErr_SetString(PyExc_ValueError, "Invalid argument index");
return NULL;
}
/* Get the Python module (should already be imported) */
modname = PyString_FromString(ef_ptr->path);
if ( modname == NULL )
return NULL;
usermod = PyImport_Import(modname);
Py_DECREF(modname);
if ( usermod == NULL )
return NULL;
/* Call the initialization method to get the argument types */
initdict = PyObject_CallMethod(usermod, INIT_METHOD_NAME, "i", id);
Py_DECREF(usermod);
if ( initdict == NULL )
return NULL;
typetuple = PyDict_GetItemString(initdict, "argtypes"); /* borrowed reference */
if ( typetuple == NULL ) {
/* Key not present; no exception raised */
Py_DECREF(initdict);
PyErr_SetString(PyExc_ValueError, "argtype is neither FLOAT_ONEVAL nor STRING_ONEVAL");
return NULL;
}
/* Get the type of this argument */
typeobj = PySequence_GetItem(typetuple, (Py_ssize_t) arg);
if ( typeobj == NULL ) {
PyErr_Clear();
Py_DECREF(initdict);
PyErr_SetString(PyExc_ValueError, "argtype is neither FLOAT_ONEVAL nor STRING_ONEVAL");
return NULL;
}
switch( (int) PyInt_AsLong(typeobj) ) {
case FLOAT_ONEVAL:
k = arg + 1;
ef_get_one_val_(&id, &k, &float_val);
valobj = PyFloat_FromDouble(float_val);
break;
case STRING_ONEVAL:
case STRING_ARG:
k = arg + 1;
/* Assumes gcc standard for passing Hollerith strings */
ef_get_arg_string_(&id, &k, str_val, 2048);
for (k = 2048; k > 0; k--)
if ( ! isspace(str_val[k-1]) )
break;
valobj = PyString_FromStringAndSize(str_val, k);
break;
default:
PyErr_Clear(); /* Just to be safe */
PyErr_SetString(PyExc_ValueError, "argtype is neither FLOAT_ONEVAL nor STRING_ONEVAL");
valobj = NULL;
}
Py_DECREF(typeobj);
Py_DECREF(initdict);
return valobj;
}
/* List of Python functions and their docstrings available in this module */
static struct PyMethodDef pyferretMethods[] = {
{"_start", (PyCFunction) pyferretStart, METH_VARARGS | METH_KEYWORDS, pyferretStartDocstring},
{"_run", (PyCFunction) pyferretRunCommand, METH_VARARGS | METH_KEYWORDS, pyferretRunCommandDocstring},
{"_get", (PyCFunction) pyferretGetData, METH_VARARGS | METH_KEYWORDS, pyferretGetDataDocstring},
{"_getstrdata", (PyCFunction) pyferretGetStrData, METH_VARARGS | METH_KEYWORDS, pyferretGetStrDataDocstring},
{"_put", (PyCFunction) pyferretPutData, METH_VARARGS | METH_KEYWORDS, pyferretPutDataDocstring},
{"_resize", (PyCFunction) pyferretResizeMemory, METH_VARARGS | METH_KEYWORDS, pyferretResizeMemoryDocstring},
{"_stop", (PyCFunction) pyferretStop, METH_NOARGS, pyferretStopDocstring},
{"_quit", (PyCFunction) pyferretQuit, METH_NOARGS, pyferretQuitDocstring},
{"_get_axis_coordinates", (PyCFunction) pyefcnGetAxisCoordinates, METH_VARARGS | METH_KEYWORDS, pyefcnGetAxisCoordinatesDocstring},
{"_get_axis_box_sizes", (PyCFunction) pyefcnGetAxisBoxSizes, METH_VARARGS | METH_KEYWORDS, pyefcnGetAxisBoxSizesDocstring},
{"_get_axis_box_limits", (PyCFunction) pyefcnGetAxisBoxLimits, METH_VARARGS | METH_KEYWORDS, pyefcnGetAxisBoxLimitsDocstring},
{"_get_axis_info", (PyCFunction) pyefcnGetAxisInfo, METH_VARARGS | METH_KEYWORDS, pyefcnGetAxisInfoDocstring},
{"_get_arg_one_val", (PyCFunction) pyefcnGetArgOneVal, METH_VARARGS | METH_KEYWORDS, pyefcnGetArgOneValDocstring},
{NULL, (PyCFunction) NULL, 0, NULL}
};
static char pyferretModuleDocstring[] =
"An extension module enabling the use of Ferret from Python \n";
#if PY_MAJOR_VERSION >= 3
static int pyferretTraverse(PyObject *m, visitproc visit, void *arg) {
Py_VISIT(MODULE_STATE(m)->error);
return 0;
}
static int pyferretClear(PyObject *m) {
Py_CLEAR(MODULE_STATE(m)->error);
return 0;
}
static struct PyModuleDef moduledef = {
PyModuleDef_HEAD_INIT,
"libpyferret",
NULL,
sizeof(struct pyferret_module),
pyferretMethods,
NULL,
pyferretTraverse,
pyferretClear,
NULL
};
PyMODINIT_FUNC PyInit_libpyferret(void)
#else /* !python3 */
/* For the libpyferret module, this function must be named initlibpyferret */
PyMODINIT_FUNC initlibpyferret(void)
#endif
{
char names[64][32];
int values[64];
int numvals;
int k;
/* Create the module with the indicated methods */
#if PY_MAJOR_VERSION >= 3
PyObject *mod = PyModule_Create(&moduledef);
#else
PyObject *mod = Py_InitModule3("libpyferret", pyferretMethods, pyferretModuleDocstring);
#endif
/* Add ferret parameter values */
get_ferret_params_(names, values, &numvals);
for (k = 0; k < numvals; k++) {
PyModule_AddIntConstant(mod, names[k], values[k]);
}
/* Add parameters for the python EF argument types */
PyModule_AddIntConstant(mod, "FLOAT_ARRAY", FLOAT_ARRAY);
PyModule_AddIntConstant(mod, "FLOAT_ONEVAL", FLOAT_ONEVAL);
PyModule_AddIntConstant(mod, "STRING_ARRAY", STRING_ARRAY);
PyModule_AddIntConstant(mod, "STRING_ONEVAL", STRING_ONEVAL);
/* Add parameters for the python axis functions */
PyModule_AddIntConstant(mod, "X_AXIS", 0);
PyModule_AddIntConstant(mod, "Y_AXIS", 1);
PyModule_AddIntConstant(mod, "Z_AXIS", 2);
PyModule_AddIntConstant(mod, "T_AXIS", 3);
PyModule_AddIntConstant(mod, "E_AXIS", 4);
PyModule_AddIntConstant(mod, "F_AXIS", 5);
PyModule_AddIntConstant(mod, "ARG1", 0);
PyModule_AddIntConstant(mod, "ARG2", 1);
PyModule_AddIntConstant(mod, "ARG3", 2);
PyModule_AddIntConstant(mod, "ARG4", 3);
PyModule_AddIntConstant(mod, "ARG5", 4);
PyModule_AddIntConstant(mod, "ARG6", 5);
PyModule_AddIntConstant(mod, "ARG7", 6);
PyModule_AddIntConstant(mod, "ARG8", 7);
PyModule_AddIntConstant(mod, "ARG9", 8);
/* Parameters for interpreting axis data */
PyModule_AddIntConstant(mod, "AXISTYPE_LONGITUDE", AXISTYPE_LONGITUDE);
PyModule_AddIntConstant(mod, "AXISTYPE_LATITUDE", AXISTYPE_LATITUDE);
PyModule_AddIntConstant(mod, "AXISTYPE_LEVEL", AXISTYPE_LEVEL);
PyModule_AddIntConstant(mod, "AXISTYPE_TIME", AXISTYPE_TIME);
PyModule_AddIntConstant(mod, "AXISTYPE_CUSTOM", AXISTYPE_CUSTOM);
PyModule_AddIntConstant(mod, "AXISTYPE_ABSTRACT", AXISTYPE_ABSTRACT);
PyModule_AddIntConstant(mod, "AXISTYPE_NORMAL", AXISTYPE_NORMAL);
PyModule_AddIntConstant(mod, "TIMEARRAY_DAYINDEX", TIMEARRAY_DAYINDEX);
PyModule_AddIntConstant(mod, "TIMEARRAY_MONTHINDEX", TIMEARRAY_MONTHINDEX);
PyModule_AddIntConstant(mod, "TIMEARRAY_YEARINDEX", TIMEARRAY_YEARINDEX);
PyModule_AddIntConstant(mod, "TIMEARRAY_HOURINDEX", TIMEARRAY_HOURINDEX);
PyModule_AddIntConstant(mod, "TIMEARRAY_MINUTEINDEX", TIMEARRAY_MINUTEINDEX);
PyModule_AddIntConstant(mod, "TIMEARRAY_SECONDINDEX", TIMEARRAY_SECONDINDEX);
/* Parameters for the calendar types */
PyModule_AddStringConstant(mod, "CALTYPE_360DAY", CALTYPE_360DAY_STR);
PyModule_AddStringConstant(mod, "CALTYPE_NOLEAP", CALTYPE_NOLEAP_STR);
PyModule_AddStringConstant(mod, "CALTYPE_GREGORIAN", CALTYPE_GREGORIAN_STR);
PyModule_AddStringConstant(mod, "CALTYPE_JULIAN", CALTYPE_JULIAN_STR);
PyModule_AddStringConstant(mod, "CALTYPE_ALLLEAP", CALTYPE_ALLLEAP_STR);
PyModule_AddStringConstant(mod, "CALTYPE_NONE", CALTYPE_NONE_STR);
/* Parameter giving the maximum number of axis allowed in Ferret */
PyModule_AddIntConstant(mod, "MAX_FERRET_NDIM", MAX_FERRET_NDIM);
/* Parameter giving the String used as the missing value for String arrays */
PyModule_AddStringConstant(mod, "STRING_MISSING_VALUE", STRING_MISSING_VALUE);
/* Private parameter return value from libpyferret._run indicating the program should shut down */
PyModule_AddIntConstant(mod, "_FERR_EXIT_PROGRAM", FERR_EXIT_PROGRAM);
#if PY_MAJOR_VERSION >= 3
return mod;
#endif
}
|