Chris@87: #!/usr/bin/env python
Chris@87: """
Chris@87: 
Chris@87: Rules for building C/API module with f2py2e.
Chris@87: 
Chris@87: Here is a skeleton of a new wrapper function (13Dec2001):
Chris@87: 
Chris@87: wrapper_function(args)
Chris@87:   declarations
Chris@87:   get_python_arguments, say, `a' and `b'
Chris@87: 
Chris@87:   get_a_from_python
Chris@87:   if (successful) {
Chris@87: 
Chris@87:     get_b_from_python
Chris@87:     if (successful) {
Chris@87: 
Chris@87:       callfortran
Chris@87:       if (succesful) {
Chris@87: 
Chris@87:         put_a_to_python
Chris@87:         if (succesful) {
Chris@87: 
Chris@87:           put_b_to_python
Chris@87:           if (succesful) {
Chris@87: 
Chris@87:             buildvalue = ...
Chris@87: 
Chris@87:           }
Chris@87: 
Chris@87:         }
Chris@87: 
Chris@87:       }
Chris@87: 
Chris@87:     }
Chris@87:     cleanup_b
Chris@87: 
Chris@87:   }
Chris@87:   cleanup_a
Chris@87: 
Chris@87:   return buildvalue
Chris@87: 
Chris@87: Copyright 1999,2000 Pearu Peterson all rights reserved,
Chris@87: Pearu Peterson <pearu@ioc.ee>
Chris@87: Permission to use, modify, and distribute this software is given under the
Chris@87: terms of the NumPy License.
Chris@87: 
Chris@87: NO WARRANTY IS EXPRESSED OR IMPLIED.  USE AT YOUR OWN RISK.
Chris@87: $Date: 2005/08/30 08:58:42 $
Chris@87: Pearu Peterson
Chris@87: 
Chris@87: """
Chris@87: from __future__ import division, absolute_import, print_function
Chris@87: 
Chris@87: __version__ = "$Revision: 1.129 $"[10:-1]
Chris@87: 
Chris@87: from . import __version__
Chris@87: f2py_version = __version__.version
Chris@87: 
Chris@87: import pprint
Chris@87: import sys
Chris@87: import time
Chris@87: import copy
Chris@87: 
Chris@87: from .auxfuncs import *
Chris@87: from . import capi_maps
Chris@87: from .capi_maps import *
Chris@87: from . import cfuncs
Chris@87: from . import common_rules
Chris@87: from . import use_rules
Chris@87: from . import f90mod_rules
Chris@87: from . import func2subr
Chris@87: 
Chris@87: errmess = sys.stderr.write
Chris@87: outmess = sys.stdout.write
Chris@87: show = pprint.pprint
Chris@87: 
Chris@87: options={}
Chris@87: sepdict={}
Chris@87: #for k in ['need_cfuncs']: sepdict[k]=','
Chris@87: for k in ['decl',
Chris@87:           'frompyobj',
Chris@87:           'cleanupfrompyobj',
Chris@87:           'topyarr', 'method',
Chris@87:           'pyobjfrom', 'closepyobjfrom',
Chris@87:           'freemem',
Chris@87:           'userincludes',
Chris@87:           'includes0', 'includes', 'typedefs', 'typedefs_generated',
Chris@87:           'cppmacros', 'cfuncs', 'callbacks',
Chris@87:           'latexdoc',
Chris@87:           'restdoc',
Chris@87:           'routine_defs', 'externroutines',
Chris@87:           'initf2pywraphooks',
Chris@87:           'commonhooks', 'initcommonhooks',
Chris@87:           'f90modhooks', 'initf90modhooks']:
Chris@87:     sepdict[k]='\n'
Chris@87: 
Chris@87: #################### Rules for C/API module #################
Chris@87: 
Chris@87: module_rules={
Chris@87:     'modulebody':"""\
Chris@87: /* File: #modulename#module.c
Chris@87:  * This file is auto-generated with f2py (version:#f2py_version#).
Chris@87:  * f2py is a Fortran to Python Interface Generator (FPIG), Second Edition,
Chris@87:  * written by Pearu Peterson <pearu@cens.ioc.ee>.
Chris@87:  * See http://cens.ioc.ee/projects/f2py2e/
Chris@87:  * Generation date: """+time.asctime(time.localtime(time.time()))+"""
Chris@87:  * $R"""+"""evision:$
Chris@87:  * $D"""+"""ate:$
Chris@87:  * Do not edit this file directly unless you know what you are doing!!!
Chris@87:  */
Chris@87: #ifdef __cplusplus
Chris@87: extern \"C\" {
Chris@87: #endif
Chris@87: 
Chris@87: """+gentitle("See f2py2e/cfuncs.py: includes")+"""
Chris@87: #includes#
Chris@87: #includes0#
Chris@87: 
Chris@87: """+gentitle("See f2py2e/rules.py: mod_rules['modulebody']")+"""
Chris@87: static PyObject *#modulename#_error;
Chris@87: static PyObject *#modulename#_module;
Chris@87: 
Chris@87: """+gentitle("See f2py2e/cfuncs.py: typedefs")+"""
Chris@87: #typedefs#
Chris@87: 
Chris@87: """+gentitle("See f2py2e/cfuncs.py: typedefs_generated")+"""
Chris@87: #typedefs_generated#
Chris@87: 
Chris@87: """+gentitle("See f2py2e/cfuncs.py: cppmacros")+"""
Chris@87: #cppmacros#
Chris@87: 
Chris@87: """+gentitle("See f2py2e/cfuncs.py: cfuncs")+"""
Chris@87: #cfuncs#
Chris@87: 
Chris@87: """+gentitle("See f2py2e/cfuncs.py: userincludes")+"""
Chris@87: #userincludes#
Chris@87: 
Chris@87: """+gentitle("See f2py2e/capi_rules.py: usercode")+"""
Chris@87: #usercode#
Chris@87: 
Chris@87: /* See f2py2e/rules.py */
Chris@87: #externroutines#
Chris@87: 
Chris@87: """+gentitle("See f2py2e/capi_rules.py: usercode1")+"""
Chris@87: #usercode1#
Chris@87: 
Chris@87: """+gentitle("See f2py2e/cb_rules.py: buildcallback")+"""
Chris@87: #callbacks#
Chris@87: 
Chris@87: """+gentitle("See f2py2e/rules.py: buildapi")+"""
Chris@87: #body#
Chris@87: 
Chris@87: """+gentitle("See f2py2e/f90mod_rules.py: buildhooks")+"""
Chris@87: #f90modhooks#
Chris@87: 
Chris@87: """+gentitle("See f2py2e/rules.py: module_rules['modulebody']")+"""
Chris@87: 
Chris@87: """+gentitle("See f2py2e/common_rules.py: buildhooks")+"""
Chris@87: #commonhooks#
Chris@87: 
Chris@87: """+gentitle("See f2py2e/rules.py")+"""
Chris@87: 
Chris@87: static FortranDataDef f2py_routine_defs[] = {
Chris@87: #routine_defs#
Chris@87: \t{NULL}
Chris@87: };
Chris@87: 
Chris@87: static PyMethodDef f2py_module_methods[] = {
Chris@87: #pymethoddef#
Chris@87: \t{NULL,NULL}
Chris@87: };
Chris@87: 
Chris@87: #if PY_VERSION_HEX >= 0x03000000
Chris@87: static struct PyModuleDef moduledef = {
Chris@87: \tPyModuleDef_HEAD_INIT,
Chris@87: \t"#modulename#",
Chris@87: \tNULL,
Chris@87: \t-1,
Chris@87: \tf2py_module_methods,
Chris@87: \tNULL,
Chris@87: \tNULL,
Chris@87: \tNULL,
Chris@87: \tNULL
Chris@87: };
Chris@87: #endif
Chris@87: 
Chris@87: #if PY_VERSION_HEX >= 0x03000000
Chris@87: #define RETVAL m
Chris@87: PyMODINIT_FUNC PyInit_#modulename#(void) {
Chris@87: #else
Chris@87: #define RETVAL
Chris@87: PyMODINIT_FUNC init#modulename#(void) {
Chris@87: #endif
Chris@87: \tint i;
Chris@87: \tPyObject *m,*d, *s;
Chris@87: #if PY_VERSION_HEX >= 0x03000000
Chris@87: \tm = #modulename#_module = PyModule_Create(&moduledef);
Chris@87: #else
Chris@87: \tm = #modulename#_module = Py_InitModule(\"#modulename#\", f2py_module_methods);
Chris@87: #endif
Chris@87: \tPy_TYPE(&PyFortran_Type) = &PyType_Type;
Chris@87: \timport_array();
Chris@87: \tif (PyErr_Occurred())
Chris@87: \t\t{PyErr_SetString(PyExc_ImportError, \"can't initialize module #modulename# (failed to import numpy)\"); return RETVAL;}
Chris@87: \td = PyModule_GetDict(m);
Chris@87: \ts = PyString_FromString(\"$R"""+"""evision: $\");
Chris@87: \tPyDict_SetItemString(d, \"__version__\", s);
Chris@87: #if PY_VERSION_HEX >= 0x03000000
Chris@87: \ts = PyUnicode_FromString(
Chris@87: #else
Chris@87: \ts = PyString_FromString(
Chris@87: #endif
Chris@87: \t\t\"This module '#modulename#' is auto-generated with f2py (version:#f2py_version#).\\nFunctions:\\n\"\n#docs#\".\");
Chris@87: \tPyDict_SetItemString(d, \"__doc__\", s);
Chris@87: \t#modulename#_error = PyErr_NewException (\"#modulename#.error\", NULL, NULL);
Chris@87: \tPy_DECREF(s);
Chris@87: \tfor(i=0;f2py_routine_defs[i].name!=NULL;i++)
Chris@87: \t\tPyDict_SetItemString(d, f2py_routine_defs[i].name,PyFortranObject_NewAsAttr(&f2py_routine_defs[i]));
Chris@87: #initf2pywraphooks#
Chris@87: #initf90modhooks#
Chris@87: #initcommonhooks#
Chris@87: #interface_usercode#
Chris@87: 
Chris@87: #ifdef F2PY_REPORT_ATEXIT
Chris@87: \tif (! PyErr_Occurred())
Chris@87: \t\ton_exit(f2py_report_on_exit,(void*)\"#modulename#\");
Chris@87: #endif
Chris@87: 
Chris@87: \treturn RETVAL;
Chris@87: }
Chris@87: #ifdef __cplusplus
Chris@87: }
Chris@87: #endif
Chris@87: """,
Chris@87:     'separatorsfor':{'latexdoc':'\n\n',
Chris@87:                      'restdoc':'\n\n'},
Chris@87:     'latexdoc':['\\section{Module \\texttt{#texmodulename#}}\n',
Chris@87:                 '#modnote#\n',
Chris@87:                 '#latexdoc#'],
Chris@87:     'restdoc':['Module #modulename#\n'+'='*80,
Chris@87:                '\n#restdoc#']
Chris@87:     }
Chris@87: 
Chris@87: defmod_rules=[
Chris@87:     {'body': '/*eof body*/',
Chris@87:      'method': '/*eof method*/',
Chris@87:      'externroutines': '/*eof externroutines*/',
Chris@87:      'routine_defs': '/*eof routine_defs*/',
Chris@87:      'initf90modhooks': '/*eof initf90modhooks*/',
Chris@87:      'initf2pywraphooks': '/*eof initf2pywraphooks*/',
Chris@87:      'initcommonhooks': '/*eof initcommonhooks*/',
Chris@87:      'latexdoc': '',
Chris@87:      'restdoc': '',
Chris@87:      'modnote': {hasnote:'#note#',l_not(hasnote):''},
Chris@87:      }
Chris@87:     ]
Chris@87: 
Chris@87: routine_rules={
Chris@87:     'separatorsfor':sepdict,
Chris@87:     'body':"""
Chris@87: #begintitle#
Chris@87: static char doc_#apiname#[] = \"\\\n#docreturn##name#(#docsignatureshort#)\\n\\nWrapper for ``#name#``.\\\n\\n#docstrsigns#\";
Chris@87: /* #declfortranroutine# */
Chris@87: static PyObject *#apiname#(const PyObject *capi_self,
Chris@87:                            PyObject *capi_args,
Chris@87:                            PyObject *capi_keywds,
Chris@87:                            #functype# (*f2py_func)(#callprotoargument#)) {
Chris@87: \tPyObject * volatile capi_buildvalue = NULL;
Chris@87: \tvolatile int f2py_success = 1;
Chris@87: #decl#
Chris@87: \tstatic char *capi_kwlist[] = {#kwlist##kwlistopt##kwlistxa#NULL};
Chris@87: #usercode#
Chris@87: #routdebugenter#
Chris@87: #ifdef F2PY_REPORT_ATEXIT
Chris@87: f2py_start_clock();
Chris@87: #endif
Chris@87: \tif (!PyArg_ParseTupleAndKeywords(capi_args,capi_keywds,\\
Chris@87: \t\t\"#argformat##keyformat##xaformat#:#pyname#\",\\
Chris@87: \t\tcapi_kwlist#args_capi##keys_capi##keys_xa#))\n\t\treturn NULL;
Chris@87: #frompyobj#
Chris@87: /*end of frompyobj*/
Chris@87: #ifdef F2PY_REPORT_ATEXIT
Chris@87: f2py_start_call_clock();
Chris@87: #endif
Chris@87: #callfortranroutine#
Chris@87: if (PyErr_Occurred())
Chris@87:   f2py_success = 0;
Chris@87: #ifdef F2PY_REPORT_ATEXIT
Chris@87: f2py_stop_call_clock();
Chris@87: #endif
Chris@87: /*end of callfortranroutine*/
Chris@87: \t\tif (f2py_success) {
Chris@87: #pyobjfrom#
Chris@87: /*end of pyobjfrom*/
Chris@87: \t\tCFUNCSMESS(\"Building return value.\\n\");
Chris@87: \t\tcapi_buildvalue = Py_BuildValue(\"#returnformat#\"#return#);
Chris@87: /*closepyobjfrom*/
Chris@87: #closepyobjfrom#
Chris@87: \t\t} /*if (f2py_success) after callfortranroutine*/
Chris@87: /*cleanupfrompyobj*/
Chris@87: #cleanupfrompyobj#
Chris@87: \tif (capi_buildvalue == NULL) {
Chris@87: #routdebugfailure#
Chris@87: \t} else {
Chris@87: #routdebugleave#
Chris@87: \t}
Chris@87: \tCFUNCSMESS(\"Freeing memory.\\n\");
Chris@87: #freemem#
Chris@87: #ifdef F2PY_REPORT_ATEXIT
Chris@87: f2py_stop_clock();
Chris@87: #endif
Chris@87: \treturn capi_buildvalue;
Chris@87: }
Chris@87: #endtitle#
Chris@87: """,
Chris@87:     'routine_defs':'#routine_def#',
Chris@87:     'initf2pywraphooks':'#initf2pywraphook#',
Chris@87:     'externroutines':'#declfortranroutine#',
Chris@87:     'doc':'#docreturn##name#(#docsignature#)',
Chris@87:     'docshort':'#docreturn##name#(#docsignatureshort#)',
Chris@87:     'docs':'"\t#docreturn##name#(#docsignature#)\\n"\n',
Chris@87:     'need':['arrayobject.h', 'CFUNCSMESS', 'MINMAX'],
Chris@87:     'cppmacros':{debugcapi:'#define DEBUGCFUNCS'},
Chris@87:     'latexdoc':['\\subsection{Wrapper function \\texttt{#texname#}}\n',
Chris@87:                 """
Chris@87: \\noindent{{}\\verb@#docreturn##name#@{}}\\texttt{(#latexdocsignatureshort#)}
Chris@87: #routnote#
Chris@87: 
Chris@87: #latexdocstrsigns#
Chris@87: """],
Chris@87:     'restdoc':['Wrapped function ``#name#``\n'+'-'*80,
Chris@87: 
Chris@87:                ]
Chris@87:     }
Chris@87: 
Chris@87: ################## Rules for C/API function ##############
Chris@87: 
Chris@87: rout_rules=[
Chris@87:     { # Init
Chris@87:     'separatorsfor': {'callfortranroutine': '\n', 'routdebugenter': '\n', 'decl': '\n',
Chris@87:                       'routdebugleave': '\n', 'routdebugfailure': '\n',
Chris@87:                       'setjmpbuf': ' || ',
Chris@87:                       'docstrreq': '\n', 'docstropt': '\n', 'docstrout': '\n',
Chris@87:                       'docstrcbs': '\n', 'docstrsigns': '\\n"\n"',
Chris@87:                       'latexdocstrsigns': '\n',
Chris@87:                       'latexdocstrreq': '\n', 'latexdocstropt': '\n',
Chris@87:                       'latexdocstrout': '\n', 'latexdocstrcbs': '\n',
Chris@87:                       },
Chris@87:     'kwlist': '', 'kwlistopt': '', 'callfortran': '', 'callfortranappend': '',
Chris@87:     'docsign': '', 'docsignopt': '', 'decl': '/*decl*/',
Chris@87:     'freemem': '/*freemem*/',
Chris@87:     'docsignshort': '', 'docsignoptshort': '',
Chris@87:     'docstrsigns': '', 'latexdocstrsigns': '',
Chris@87:     'docstrreq': '\\nParameters\\n----------',
Chris@87:     'docstropt': '\\nOther Parameters\\n----------------',
Chris@87:     'docstrout': '\\nReturns\\n-------',
Chris@87:     'docstrcbs': '\\nNotes\\n-----\\nCall-back functions::\\n',
Chris@87:     'latexdocstrreq': '\\noindent Required arguments:',
Chris@87:     'latexdocstropt': '\\noindent Optional arguments:',
Chris@87:     'latexdocstrout': '\\noindent Return objects:',
Chris@87:     'latexdocstrcbs': '\\noindent Call-back functions:',
Chris@87:     'args_capi': '', 'keys_capi': '', 'functype': '',
Chris@87:     'frompyobj': '/*frompyobj*/',
Chris@87:     'cleanupfrompyobj': ['/*end of cleanupfrompyobj*/'], #this list will be reversed
Chris@87:     'pyobjfrom': '/*pyobjfrom*/',
Chris@87:     'closepyobjfrom': ['/*end of closepyobjfrom*/'], #this list will be reversed
Chris@87:     'topyarr': '/*topyarr*/', 'routdebugleave': '/*routdebugleave*/',
Chris@87:     'routdebugenter': '/*routdebugenter*/',
Chris@87:     'routdebugfailure': '/*routdebugfailure*/',
Chris@87:     'callfortranroutine': '/*callfortranroutine*/',
Chris@87:     'argformat': '', 'keyformat': '', 'need_cfuncs': '',
Chris@87:     'docreturn': '', 'return': '', 'returnformat': '', 'rformat': '',
Chris@87:     'kwlistxa': '', 'keys_xa': '', 'xaformat': '', 'docsignxa': '', 'docsignxashort': '',
Chris@87:     'initf2pywraphook': '',
Chris@87:     'routnote': {hasnote:'--- #note#',l_not(hasnote):''},
Chris@87:     }, {
Chris@87:         'apiname':'f2py_rout_#modulename#_#name#',
Chris@87:         'pyname':'#modulename#.#name#',
Chris@87:         'decl':'',
Chris@87:         '_check':l_not(ismoduleroutine)
Chris@87:     }, {
Chris@87:         'apiname':'f2py_rout_#modulename#_#f90modulename#_#name#',
Chris@87:         'pyname':'#modulename#.#f90modulename#.#name#',
Chris@87:         'decl':'',
Chris@87:         '_check':ismoduleroutine
Chris@87:     }, { # Subroutine
Chris@87:     'functype': 'void',
Chris@87:     'declfortranroutine': {l_and(l_not(l_or(ismoduleroutine, isintent_c)), l_not(isdummyroutine)):'extern void #F_FUNC#(#fortranname#,#FORTRANNAME#)(#callprotoargument#);',
Chris@87:                           l_and(l_not(ismoduleroutine), isintent_c, l_not(isdummyroutine)):'extern void #fortranname#(#callprotoargument#);',
Chris@87:                           ismoduleroutine:'',
Chris@87:                           isdummyroutine:''
Chris@87:                           },
Chris@87:     'routine_def': {l_not(l_or(ismoduleroutine, isintent_c, isdummyroutine)): '\t{\"#name#\",-1,{{-1}},0,(char *)#F_FUNC#(#fortranname#,#FORTRANNAME#),(f2py_init_func)#apiname#,doc_#apiname#},',
Chris@87:                    l_and(l_not(ismoduleroutine), isintent_c, l_not(isdummyroutine)): '\t{\"#name#\",-1,{{-1}},0,(char *)#fortranname#,(f2py_init_func)#apiname#,doc_#apiname#},',
Chris@87:                    l_and(l_not(ismoduleroutine), isdummyroutine): '\t{\"#name#\",-1,{{-1}},0,NULL,(f2py_init_func)#apiname#,doc_#apiname#},',
Chris@87:                    },
Chris@87:     'need': {l_and(l_not(l_or(ismoduleroutine, isintent_c)), l_not(isdummyroutine)):'F_FUNC'},
Chris@87:     'callfortranroutine': [
Chris@87:         {debugcapi:["""\tfprintf(stderr,\"debug-capi:Fortran subroutine `#fortranname#(#callfortran#)\'\\n\");"""]},
Chris@87:         {hasexternals:"""\
Chris@87: \t\tif (#setjmpbuf#) {
Chris@87: \t\t\tf2py_success = 0;
Chris@87: \t\t} else {"""},
Chris@87:         {isthreadsafe:'\t\t\tPy_BEGIN_ALLOW_THREADS'},
Chris@87:         {hascallstatement:'''\t\t\t\t#callstatement#;
Chris@87: \t\t\t\t/*(*f2py_func)(#callfortran#);*/'''},
Chris@87:         {l_not(l_or(hascallstatement, isdummyroutine)):'\t\t\t\t(*f2py_func)(#callfortran#);'},
Chris@87:         {isthreadsafe:'\t\t\tPy_END_ALLOW_THREADS'},
Chris@87:         {hasexternals:"""\t\t}"""}
Chris@87:          ],
Chris@87:     '_check': l_and(issubroutine, l_not(issubroutine_wrap)),
Chris@87:     }, { # Wrapped function
Chris@87:     'functype': 'void',
Chris@87:     'declfortranroutine': {l_not(l_or(ismoduleroutine, isdummyroutine)): 'extern void #F_WRAPPEDFUNC#(#name_lower#,#NAME#)(#callprotoargument#);',
Chris@87:                           isdummyroutine: '',
Chris@87:                           },
Chris@87: 
Chris@87:     'routine_def': {l_not(l_or(ismoduleroutine, isdummyroutine)): '\t{\"#name#\",-1,{{-1}},0,(char *)#F_WRAPPEDFUNC#(#name_lower#,#NAME#),(f2py_init_func)#apiname#,doc_#apiname#},',
Chris@87:                    isdummyroutine: '\t{\"#name#\",-1,{{-1}},0,NULL,(f2py_init_func)#apiname#,doc_#apiname#},',
Chris@87:                    },
Chris@87:     'initf2pywraphook': {l_not(l_or(ismoduleroutine, isdummyroutine)):'''
Chris@87:     {
Chris@87:       extern #ctype# #F_FUNC#(#name_lower#,#NAME#)(void);
Chris@87:       PyObject* o = PyDict_GetItemString(d,"#name#");
Chris@87:       PyObject_SetAttrString(o,"_cpointer", F2PyCapsule_FromVoidPtr((void*)#F_FUNC#(#name_lower#,#NAME#),NULL));
Chris@87: #if PY_VERSION_HEX >= 0x03000000
Chris@87:       PyObject_SetAttrString(o,"__name__", PyUnicode_FromString("#name#"));
Chris@87: #else
Chris@87:       PyObject_SetAttrString(o,"__name__", PyString_FromString("#name#"));
Chris@87: #endif
Chris@87:     }
Chris@87:     '''},
Chris@87:     'need': {l_not(l_or(ismoduleroutine, isdummyroutine)):['F_WRAPPEDFUNC', 'F_FUNC']},
Chris@87:     'callfortranroutine': [
Chris@87:     {debugcapi:["""\tfprintf(stderr,\"debug-capi:Fortran subroutine `f2pywrap#name_lower#(#callfortran#)\'\\n\");"""]},
Chris@87:     {hasexternals:"""\
Chris@87: \tif (#setjmpbuf#) {
Chris@87: \t\tf2py_success = 0;
Chris@87: \t} else {"""},
Chris@87:     {isthreadsafe:'\tPy_BEGIN_ALLOW_THREADS'},
Chris@87:     {l_not(l_or(hascallstatement, isdummyroutine)):'\t(*f2py_func)(#callfortran#);'},
Chris@87:     {hascallstatement:'\t#callstatement#;\n\t/*(*f2py_func)(#callfortran#);*/'},
Chris@87:     {isthreadsafe:'\tPy_END_ALLOW_THREADS'},
Chris@87:     {hasexternals:'\t}'}
Chris@87:     ],
Chris@87:     '_check': isfunction_wrap,
Chris@87:     }, { # Wrapped subroutine
Chris@87:     'functype': 'void',
Chris@87:     'declfortranroutine': {l_not(l_or(ismoduleroutine, isdummyroutine)): 'extern void #F_WRAPPEDFUNC#(#name_lower#,#NAME#)(#callprotoargument#);',
Chris@87:                           isdummyroutine: '',
Chris@87:                           },
Chris@87: 
Chris@87:     'routine_def': {l_not(l_or(ismoduleroutine, isdummyroutine)): '\t{\"#name#\",-1,{{-1}},0,(char *)#F_WRAPPEDFUNC#(#name_lower#,#NAME#),(f2py_init_func)#apiname#,doc_#apiname#},',
Chris@87:                    isdummyroutine: '\t{\"#name#\",-1,{{-1}},0,NULL,(f2py_init_func)#apiname#,doc_#apiname#},',
Chris@87:                    },
Chris@87:     'initf2pywraphook': {l_not(l_or(ismoduleroutine, isdummyroutine)):'''
Chris@87:     {
Chris@87:       extern void #F_FUNC#(#name_lower#,#NAME#)(void);
Chris@87:       PyObject* o = PyDict_GetItemString(d,"#name#");
Chris@87:       PyObject_SetAttrString(o,"_cpointer", F2PyCapsule_FromVoidPtr((void*)#F_FUNC#(#name_lower#,#NAME#),NULL));
Chris@87: #if PY_VERSION_HEX >= 0x03000000
Chris@87:       PyObject_SetAttrString(o,"__name__", PyUnicode_FromString("#name#"));
Chris@87: #else
Chris@87:       PyObject_SetAttrString(o,"__name__", PyString_FromString("#name#"));
Chris@87: #endif
Chris@87:     }
Chris@87:     '''},
Chris@87:     'need': {l_not(l_or(ismoduleroutine, isdummyroutine)):['F_WRAPPEDFUNC', 'F_FUNC']},
Chris@87:     'callfortranroutine': [
Chris@87:     {debugcapi:["""\tfprintf(stderr,\"debug-capi:Fortran subroutine `f2pywrap#name_lower#(#callfortran#)\'\\n\");"""]},
Chris@87:     {hasexternals:"""\
Chris@87: \tif (#setjmpbuf#) {
Chris@87: \t\tf2py_success = 0;
Chris@87: \t} else {"""},
Chris@87:     {isthreadsafe:'\tPy_BEGIN_ALLOW_THREADS'},
Chris@87:     {l_not(l_or(hascallstatement, isdummyroutine)):'\t(*f2py_func)(#callfortran#);'},
Chris@87:     {hascallstatement:'\t#callstatement#;\n\t/*(*f2py_func)(#callfortran#);*/'},
Chris@87:     {isthreadsafe:'\tPy_END_ALLOW_THREADS'},
Chris@87:     {hasexternals:'\t}'}
Chris@87:     ],
Chris@87:     '_check': issubroutine_wrap,
Chris@87:     }, { # Function
Chris@87:     'functype':'#ctype#',
Chris@87:     'docreturn':{l_not(isintent_hide):'#rname#,'},
Chris@87:     'docstrout':'#pydocsignout#',
Chris@87:     'latexdocstrout':['\\item[]{{}\\verb@#pydocsignout#@{}}',
Chris@87:                       {hasresultnote:'--- #resultnote#'}],
Chris@87:     'callfortranroutine':[{l_and(debugcapi, isstringfunction):"""\
Chris@87: #ifdef USESCOMPAQFORTRAN
Chris@87: \tfprintf(stderr,\"debug-capi:Fortran function #ctype# #fortranname#(#callcompaqfortran#)\\n\");
Chris@87: #else
Chris@87: \tfprintf(stderr,\"debug-capi:Fortran function #ctype# #fortranname#(#callfortran#)\\n\");
Chris@87: #endif
Chris@87: """},
Chris@87:                           {l_and(debugcapi, l_not(isstringfunction)):"""\
Chris@87: \tfprintf(stderr,\"debug-capi:Fortran function #ctype# #fortranname#(#callfortran#)\\n\");
Chris@87: """}
Chris@87:                           ],
Chris@87:     '_check':l_and(isfunction, l_not(isfunction_wrap))
Chris@87:     }, { # Scalar function
Chris@87:     'declfortranroutine':{l_and(l_not(l_or(ismoduleroutine, isintent_c)), l_not(isdummyroutine)):'extern #ctype# #F_FUNC#(#fortranname#,#FORTRANNAME#)(#callprotoargument#);',
Chris@87:                           l_and(l_not(ismoduleroutine), isintent_c, l_not(isdummyroutine)):'extern #ctype# #fortranname#(#callprotoargument#);',
Chris@87:                           isdummyroutine:''
Chris@87:                           },
Chris@87:     'routine_def':{l_and(l_not(l_or(ismoduleroutine, isintent_c)), l_not(isdummyroutine)): '\t{\"#name#\",-1,{{-1}},0,(char *)#F_FUNC#(#fortranname#,#FORTRANNAME#),(f2py_init_func)#apiname#,doc_#apiname#},',
Chris@87:                    l_and(l_not(ismoduleroutine), isintent_c, l_not(isdummyroutine)): '\t{\"#name#\",-1,{{-1}},0,(char *)#fortranname#,(f2py_init_func)#apiname#,doc_#apiname#},',
Chris@87:                    isdummyroutine: '\t{\"#name#\",-1,{{-1}},0,NULL,(f2py_init_func)#apiname#,doc_#apiname#},',
Chris@87:                    },
Chris@87:     'decl':[{iscomplexfunction_warn:'\t#ctype# #name#_return_value={0,0};',
Chris@87:              l_not(iscomplexfunction):'\t#ctype# #name#_return_value=0;'},
Chris@87:             {iscomplexfunction:'\tPyObject *#name#_return_value_capi = Py_None;'}
Chris@87:             ],
Chris@87:     'callfortranroutine':[
Chris@87:         {hasexternals:"""\
Chris@87: \tif (#setjmpbuf#) {
Chris@87: \t\tf2py_success = 0;
Chris@87: \t} else {"""},
Chris@87:         {isthreadsafe:'\tPy_BEGIN_ALLOW_THREADS'},
Chris@87:         {hascallstatement:'''\t#callstatement#;
Chris@87: /*\t#name#_return_value = (*f2py_func)(#callfortran#);*/
Chris@87: '''},
Chris@87:         {l_not(l_or(hascallstatement, isdummyroutine)):'\t#name#_return_value = (*f2py_func)(#callfortran#);'},
Chris@87:         {isthreadsafe:'\tPy_END_ALLOW_THREADS'},
Chris@87:         {hasexternals:'\t}'},
Chris@87:         {l_and(debugcapi, iscomplexfunction):'\tfprintf(stderr,"#routdebugshowvalue#\\n",#name#_return_value.r,#name#_return_value.i);'},
Chris@87:         {l_and(debugcapi, l_not(iscomplexfunction)):'\tfprintf(stderr,"#routdebugshowvalue#\\n",#name#_return_value);'}],
Chris@87:     'pyobjfrom':{iscomplexfunction:'\t#name#_return_value_capi = pyobj_from_#ctype#1(#name#_return_value);'},
Chris@87:     'need':[{l_not(isdummyroutine):'F_FUNC'},
Chris@87:     {iscomplexfunction:'pyobj_from_#ctype#1'},
Chris@87:     {islong_longfunction:'long_long'},
Chris@87:     {islong_doublefunction:'long_double'}],
Chris@87:     'returnformat':{l_not(isintent_hide):'#rformat#'},
Chris@87:     'return':{iscomplexfunction:',#name#_return_value_capi',
Chris@87:     l_not(l_or(iscomplexfunction, isintent_hide)):',#name#_return_value'},
Chris@87:     '_check':l_and(isfunction, l_not(isstringfunction), l_not(isfunction_wrap))
Chris@87:     }, { # String function # in use for --no-wrap
Chris@87:     'declfortranroutine':'extern void #F_FUNC#(#fortranname#,#FORTRANNAME#)(#callprotoargument#);',
Chris@87:     'routine_def':{l_not(l_or(ismoduleroutine, isintent_c)):
Chris@87: #        '\t{\"#name#\",-1,{{-1}},0,(char *)F_FUNC(#fortranname#,#FORTRANNAME#),(void *)#apiname#,doc_#apiname#},',
Chris@87:         '\t{\"#name#\",-1,{{-1}},0,(char *)#F_FUNC#(#fortranname#,#FORTRANNAME#),(f2py_init_func)#apiname#,doc_#apiname#},',
Chris@87:         l_and(l_not(ismoduleroutine), isintent_c):
Chris@87: #            '\t{\"#name#\",-1,{{-1}},0,(char *)#fortranname#,(void *)#apiname#,doc_#apiname#},'
Chris@87:             '\t{\"#name#\",-1,{{-1}},0,(char *)#fortranname#,(f2py_init_func)#apiname#,doc_#apiname#},'
Chris@87:                    },
Chris@87:     'decl':['\t#ctype# #name#_return_value = NULL;',
Chris@87:             '\tint #name#_return_value_len = 0;'],
Chris@87:     'callfortran':'#name#_return_value,#name#_return_value_len,',
Chris@87:     'callfortranroutine':['\t#name#_return_value_len = #rlength#;',
Chris@87:                           '\tif ((#name#_return_value = (string)malloc(sizeof(char)*(#name#_return_value_len+1))) == NULL) {',
Chris@87:                           '\t\tPyErr_SetString(PyExc_MemoryError, \"out of memory\");',
Chris@87:                           '\t\tf2py_success = 0;',
Chris@87:                           '\t} else {',
Chris@87:                           "\t\t(#name#_return_value)[#name#_return_value_len] = '\\0';",
Chris@87:                           '\t}',
Chris@87:                           '\tif (f2py_success) {',
Chris@87:                           {hasexternals:"""\
Chris@87: \t\tif (#setjmpbuf#) {
Chris@87: \t\t\tf2py_success = 0;
Chris@87: \t\t} else {"""},
Chris@87:                           {isthreadsafe:'\t\tPy_BEGIN_ALLOW_THREADS'},
Chris@87:                           """\
Chris@87: #ifdef USESCOMPAQFORTRAN
Chris@87: \t\t(*f2py_func)(#callcompaqfortran#);
Chris@87: #else
Chris@87: \t\t(*f2py_func)(#callfortran#);
Chris@87: #endif
Chris@87: """,
Chris@87:                           {isthreadsafe:'\t\tPy_END_ALLOW_THREADS'},
Chris@87:                           {hasexternals:'\t\t}'},
Chris@87:                           {debugcapi:'\t\tfprintf(stderr,"#routdebugshowvalue#\\n",#name#_return_value_len,#name#_return_value);'},
Chris@87:                           '\t} /* if (f2py_success) after (string)malloc */',
Chris@87:                           ],
Chris@87:     'returnformat':'#rformat#',
Chris@87:     'return':',#name#_return_value',
Chris@87:     'freemem':'\tSTRINGFREE(#name#_return_value);',
Chris@87:     'need':['F_FUNC', '#ctype#', 'STRINGFREE'],
Chris@87:     '_check':l_and(isstringfunction, l_not(isfunction_wrap)) # ???obsolete
Chris@87:     },
Chris@87:     { # Debugging
Chris@87:     'routdebugenter':'\tfprintf(stderr,"debug-capi:Python C/API function #modulename#.#name#(#docsignature#)\\n");',
Chris@87:     'routdebugleave':'\tfprintf(stderr,"debug-capi:Python C/API function #modulename#.#name#: successful.\\n");',
Chris@87:     'routdebugfailure':'\tfprintf(stderr,"debug-capi:Python C/API function #modulename#.#name#: failure.\\n");',
Chris@87:     '_check':debugcapi
Chris@87:     }
Chris@87:     ]
Chris@87: 
Chris@87: ################ Rules for arguments ##################
Chris@87: 
Chris@87: typedef_need_dict = {islong_long: 'long_long',
Chris@87:                      islong_double: 'long_double',
Chris@87:                      islong_complex: 'complex_long_double',
Chris@87:                      isunsigned_char: 'unsigned_char',
Chris@87:                      isunsigned_short: 'unsigned_short',
Chris@87:                      isunsigned: 'unsigned',
Chris@87:                      isunsigned_long_long: 'unsigned_long_long',
Chris@87:                      isunsigned_chararray: 'unsigned_char',
Chris@87:                      isunsigned_shortarray: 'unsigned_short',
Chris@87:                      isunsigned_long_longarray: 'unsigned_long_long',
Chris@87:                      issigned_long_longarray: 'long_long',
Chris@87:                      }
Chris@87: 
Chris@87: aux_rules=[
Chris@87:     {
Chris@87:     'separatorsfor':sepdict
Chris@87:     },
Chris@87:     { # Common
Chris@87:     'frompyobj': ['\t/* Processing auxiliary variable #varname# */',
Chris@87:                  {debugcapi:'\tfprintf(stderr,"#vardebuginfo#\\n");'},],
Chris@87:     'cleanupfrompyobj': '\t/* End of cleaning variable #varname# */',
Chris@87:     'need': typedef_need_dict,
Chris@87:     },
Chris@87: # Scalars (not complex)
Chris@87:     { # Common
Chris@87:     'decl': '\t#ctype# #varname# = 0;',
Chris@87:     'need': {hasinitvalue:'math.h'},
Chris@87:     'frompyobj': {hasinitvalue:'\t#varname# = #init#;'},
Chris@87:     '_check': l_and(isscalar, l_not(iscomplex)),
Chris@87:     },
Chris@87:     {
Chris@87:     'return': ',#varname#',
Chris@87:     'docstrout': '#pydocsignout#',
Chris@87:     'docreturn': '#outvarname#,',
Chris@87:     'returnformat': '#varrformat#',
Chris@87:     '_check': l_and(isscalar, l_not(iscomplex), isintent_out),
Chris@87:     },
Chris@87: # Complex scalars
Chris@87:     { # Common
Chris@87:     'decl':'\t#ctype# #varname#;',
Chris@87:     'frompyobj': {hasinitvalue:'\t#varname#.r = #init.r#, #varname#.i = #init.i#;'},
Chris@87:     '_check':iscomplex
Chris@87:     },
Chris@87: # String
Chris@87:     { # Common
Chris@87:     'decl':['\t#ctype# #varname# = NULL;',
Chris@87:             '\tint slen(#varname#);',
Chris@87:             ],
Chris@87:     'need':['len..'],
Chris@87:     '_check':isstring
Chris@87:     },
Chris@87: # Array
Chris@87:     { # Common
Chris@87:     'decl':['\t#ctype# *#varname# = NULL;',
Chris@87:             '\tnpy_intp #varname#_Dims[#rank#] = {#rank*[-1]#};',
Chris@87:             '\tconst int #varname#_Rank = #rank#;',
Chris@87:             ],
Chris@87:     'need':['len..', {hasinitvalue:'forcomb'}, {hasinitvalue:'CFUNCSMESS'}],
Chris@87:     '_check':isarray
Chris@87:     },
Chris@87: # Scalararray
Chris@87:     { # Common
Chris@87:     '_check':l_and(isarray, l_not(iscomplexarray))
Chris@87:     }, { # Not hidden
Chris@87:     '_check':l_and(isarray, l_not(iscomplexarray), isintent_nothide)
Chris@87:     },
Chris@87: # Integer*1 array
Chris@87:     {'need':'#ctype#',
Chris@87:      '_check':isint1array,
Chris@87:      '_depend':''
Chris@87:      },
Chris@87: # Integer*-1 array
Chris@87:     {'need':'#ctype#',
Chris@87:      '_check':isunsigned_chararray,
Chris@87:      '_depend':''
Chris@87:      },
Chris@87: # Integer*-2 array
Chris@87:     {'need':'#ctype#',
Chris@87:      '_check':isunsigned_shortarray,
Chris@87:      '_depend':''
Chris@87:      },
Chris@87: # Integer*-8 array
Chris@87:     {'need':'#ctype#',
Chris@87:      '_check':isunsigned_long_longarray,
Chris@87:      '_depend':''
Chris@87:      },
Chris@87: # Complexarray
Chris@87:     {'need':'#ctype#',
Chris@87:      '_check':iscomplexarray,
Chris@87:      '_depend':''
Chris@87:      },
Chris@87: # Stringarray
Chris@87:      {
Chris@87:      'callfortranappend':{isarrayofstrings:'flen(#varname#),'},
Chris@87:      'need':'string',
Chris@87:      '_check':isstringarray
Chris@87:      }
Chris@87:     ]
Chris@87: 
Chris@87: arg_rules=[
Chris@87:     {
Chris@87:     'separatorsfor':sepdict
Chris@87:     },
Chris@87:     { # Common
Chris@87:     'frompyobj': ['\t/* Processing variable #varname# */',
Chris@87:                  {debugcapi:'\tfprintf(stderr,"#vardebuginfo#\\n");'},],
Chris@87:     'cleanupfrompyobj': '\t/* End of cleaning variable #varname# */',
Chris@87:     '_depend': '',
Chris@87:     'need': typedef_need_dict,
Chris@87:     },
Chris@87: # Doc signatures
Chris@87:     {
Chris@87:     'docstropt':{l_and(isoptional, isintent_nothide):'#pydocsign#'},
Chris@87:     'docstrreq':{l_and(isrequired, isintent_nothide):'#pydocsign#'},
Chris@87:     'docstrout':{isintent_out:'#pydocsignout#'},
Chris@87:     'latexdocstropt':{l_and(isoptional, isintent_nothide):['\\item[]{{}\\verb@#pydocsign#@{}}',
Chris@87:                                                           {hasnote:'--- #note#'}]},
Chris@87:     'latexdocstrreq':{l_and(isrequired, isintent_nothide):['\\item[]{{}\\verb@#pydocsign#@{}}',
Chris@87:                                                           {hasnote:'--- #note#'}]},
Chris@87:     'latexdocstrout':{isintent_out:['\\item[]{{}\\verb@#pydocsignout#@{}}',
Chris@87:                                     {l_and(hasnote, isintent_hide):'--- #note#',
Chris@87:                                      l_and(hasnote, isintent_nothide):'--- See above.'}]},
Chris@87:     'depend':''
Chris@87:     },
Chris@87: # Required/Optional arguments
Chris@87:     {
Chris@87:     'kwlist':'"#varname#",',
Chris@87:     'docsign':'#varname#,',
Chris@87:     '_check':l_and(isintent_nothide, l_not(isoptional))
Chris@87:     },
Chris@87:     {
Chris@87:     'kwlistopt':'"#varname#",',
Chris@87:     'docsignopt':'#varname#=#showinit#,',
Chris@87:     'docsignoptshort':'#varname#,',
Chris@87:     '_check':l_and(isintent_nothide, isoptional)
Chris@87:     },
Chris@87: # Docstring/BuildValue
Chris@87:     {
Chris@87:     'docreturn':'#outvarname#,',
Chris@87:     'returnformat':'#varrformat#',
Chris@87:     '_check':isintent_out
Chris@87:     },
Chris@87: # Externals (call-back functions)
Chris@87:     { # Common
Chris@87:     'docsignxa':{isintent_nothide:'#varname#_extra_args=(),'},
Chris@87:     'docsignxashort':{isintent_nothide:'#varname#_extra_args,'},
Chris@87:     'docstropt':{isintent_nothide:'#varname#_extra_args : input tuple, optional\\n    Default: ()'},
Chris@87:     'docstrcbs':'#cbdocstr#',
Chris@87:     'latexdocstrcbs':'\\item[] #cblatexdocstr#',
Chris@87:     'latexdocstropt':{isintent_nothide:'\\item[]{{}\\verb@#varname#_extra_args := () input tuple@{}} --- Extra arguments for call-back function {{}\\verb@#varname#@{}}.'},
Chris@87:     'decl':['\tPyObject *#varname#_capi = Py_None;',
Chris@87:             '\tPyTupleObject *#varname#_xa_capi = NULL;',
Chris@87:             '\tPyTupleObject *#varname#_args_capi = NULL;',
Chris@87:             '\tint #varname#_nofargs_capi = 0;',
Chris@87:             {l_not(isintent_callback):'\t#cbname#_typedef #varname#_cptr;'}
Chris@87:             ],
Chris@87:     'kwlistxa':{isintent_nothide:'"#varname#_extra_args",'},
Chris@87:     'argformat':{isrequired:'O'},
Chris@87:     'keyformat':{isoptional:'O'},
Chris@87:     'xaformat':{isintent_nothide:'O!'},
Chris@87:     'args_capi':{isrequired:',&#varname#_capi'},
Chris@87:     'keys_capi':{isoptional:',&#varname#_capi'},
Chris@87:     'keys_xa':',&PyTuple_Type,&#varname#_xa_capi',
Chris@87:     'setjmpbuf':'(setjmp(#cbname#_jmpbuf))',
Chris@87:     'callfortran':{l_not(isintent_callback):'#varname#_cptr,'},
Chris@87:     'need':['#cbname#', 'setjmp.h'],
Chris@87:     '_check':isexternal
Chris@87:     },
Chris@87:     {
Chris@87:     'frompyobj':[{l_not(isintent_callback):"""\
Chris@87: if(F2PyCapsule_Check(#varname#_capi)) {
Chris@87:   #varname#_cptr = F2PyCapsule_AsVoidPtr(#varname#_capi);
Chris@87: } else {
Chris@87:   #varname#_cptr = #cbname#;
Chris@87: }
Chris@87: """}, {isintent_callback:"""\
Chris@87: if (#varname#_capi==Py_None) {
Chris@87:   #varname#_capi = PyObject_GetAttrString(#modulename#_module,\"#varname#\");
Chris@87:   if (#varname#_capi) {
Chris@87:     if (#varname#_xa_capi==NULL) {
Chris@87:       if (PyObject_HasAttrString(#modulename#_module,\"#varname#_extra_args\")) {
Chris@87:         PyObject* capi_tmp = PyObject_GetAttrString(#modulename#_module,\"#varname#_extra_args\");
Chris@87:         if (capi_tmp)
Chris@87:           #varname#_xa_capi = (PyTupleObject *)PySequence_Tuple(capi_tmp);
Chris@87:         else
Chris@87:           #varname#_xa_capi = (PyTupleObject *)Py_BuildValue(\"()\");
Chris@87:         if (#varname#_xa_capi==NULL) {
Chris@87:           PyErr_SetString(#modulename#_error,\"Failed to convert #modulename#.#varname#_extra_args to tuple.\\n\");
Chris@87:           return NULL;
Chris@87:         }
Chris@87:       }
Chris@87:     }
Chris@87:   }
Chris@87:   if (#varname#_capi==NULL) {
Chris@87:     PyErr_SetString(#modulename#_error,\"Callback #varname# not defined (as an argument or module #modulename# attribute).\\n\");
Chris@87:     return NULL;
Chris@87:   }
Chris@87: }
Chris@87: """},
Chris@87: ##    {l_not(isintent_callback):"""\
Chris@87: ## if (#varname#_capi==Py_None) {
Chris@87: ## printf(\"hoi\\n\");
Chris@87: ## }
Chris@87: ## """},
Chris@87: """\
Chris@87: \t#varname#_nofargs_capi = #cbname#_nofargs;
Chris@87: \tif (create_cb_arglist(#varname#_capi,#varname#_xa_capi,#maxnofargs#,#nofoptargs#,&#cbname#_nofargs,&#varname#_args_capi,\"failed in processing argument list for call-back #varname#.\")) {
Chris@87: \t\tjmp_buf #varname#_jmpbuf;""",
Chris@87: {debugcapi:["""\
Chris@87: \t\tfprintf(stderr,\"debug-capi:Assuming %d arguments; at most #maxnofargs#(-#nofoptargs#) is expected.\\n\",#cbname#_nofargs);
Chris@87: \t\tCFUNCSMESSPY(\"for #varname#=\",#cbname#_capi);""",
Chris@87: {l_not(isintent_callback):"""\t\tfprintf(stderr,\"#vardebugshowvalue# (call-back in C).\\n\",#cbname#);"""}]},
Chris@87:           """\
Chris@87: \t\tCFUNCSMESS(\"Saving jmpbuf for `#varname#`.\\n\");
Chris@87: \t\tSWAP(#varname#_capi,#cbname#_capi,PyObject);
Chris@87: \t\tSWAP(#varname#_args_capi,#cbname#_args_capi,PyTupleObject);
Chris@87: \t\tmemcpy(&#varname#_jmpbuf,&#cbname#_jmpbuf,sizeof(jmp_buf));""",
Chris@87:           ],
Chris@87: 'cleanupfrompyobj':
Chris@87: """\
Chris@87: \t\tCFUNCSMESS(\"Restoring jmpbuf for `#varname#`.\\n\");
Chris@87: \t\t#cbname#_capi = #varname#_capi;
Chris@87: \t\tPy_DECREF(#cbname#_args_capi);
Chris@87: \t\t#cbname#_args_capi = #varname#_args_capi;
Chris@87: \t\t#cbname#_nofargs = #varname#_nofargs_capi;
Chris@87: \t\tmemcpy(&#cbname#_jmpbuf,&#varname#_jmpbuf,sizeof(jmp_buf));
Chris@87: \t}""",
Chris@87:     'need':['SWAP', 'create_cb_arglist'],
Chris@87:     '_check':isexternal,
Chris@87:     '_depend':''
Chris@87:     },
Chris@87: # Scalars (not complex)
Chris@87:     { # Common
Chris@87:     'decl':'\t#ctype# #varname# = 0;',
Chris@87:     'pyobjfrom':{debugcapi:'\tfprintf(stderr,"#vardebugshowvalue#\\n",#varname#);'},
Chris@87:     'callfortran':{isintent_c:'#varname#,',l_not(isintent_c):'&#varname#,'},
Chris@87:     'return':{isintent_out:',#varname#'},
Chris@87:     '_check':l_and(isscalar, l_not(iscomplex))
Chris@87:     }, {
Chris@87:     'need': {hasinitvalue:'math.h'},
Chris@87:     '_check': l_and(isscalar, l_not(iscomplex)),
Chris@87:     #'_depend':''
Chris@87:     }, { # Not hidden
Chris@87:     'decl':'\tPyObject *#varname#_capi = Py_None;',
Chris@87:     'argformat':{isrequired:'O'},
Chris@87:     'keyformat':{isoptional:'O'},
Chris@87:     'args_capi':{isrequired:',&#varname#_capi'},
Chris@87:     'keys_capi':{isoptional:',&#varname#_capi'},
Chris@87:     'pyobjfrom':{isintent_inout:"""\
Chris@87: \tf2py_success = try_pyarr_from_#ctype#(#varname#_capi,&#varname#);
Chris@87: \tif (f2py_success) {"""},
Chris@87:     'closepyobjfrom':{isintent_inout:"\t} /*if (f2py_success) of #varname# pyobjfrom*/"},
Chris@87:     'need':{isintent_inout:'try_pyarr_from_#ctype#'},
Chris@87:     '_check':l_and(isscalar, l_not(iscomplex), isintent_nothide)
Chris@87:     }, {
Chris@87:     'frompyobj':[
Chris@87: # hasinitvalue...
Chris@87: #   if pyobj is None:
Chris@87: #     varname = init
Chris@87: #   else
Chris@87: #     from_pyobj(varname)
Chris@87: #
Chris@87: # isoptional and noinitvalue...
Chris@87: #   if pyobj is not None:
Chris@87: #     from_pyobj(varname)
Chris@87: #   else:
Chris@87: #     varname is uninitialized
Chris@87: #
Chris@87: # ...
Chris@87: #   from_pyobj(varname)
Chris@87: #
Chris@87:     {hasinitvalue:'\tif (#varname#_capi == Py_None) #varname# = #init#; else',
Chris@87:      '_depend':''},
Chris@87:     {l_and(isoptional, l_not(hasinitvalue)):'\tif (#varname#_capi != Py_None)',
Chris@87:      '_depend':''},
Chris@87:     {l_not(islogical):'''\
Chris@87: \t\tf2py_success = #ctype#_from_pyobj(&#varname#,#varname#_capi,"#pyname#() #nth# (#varname#) can\'t be converted to #ctype#");
Chris@87: \tif (f2py_success) {'''},
Chris@87:     {islogical:'''\
Chris@87: \t\t#varname# = (#ctype#)PyObject_IsTrue(#varname#_capi);
Chris@87: \t\tf2py_success = 1;
Chris@87: \tif (f2py_success) {'''},
Chris@87:      ],
Chris@87:     'cleanupfrompyobj':'\t} /*if (f2py_success) of #varname#*/',
Chris@87:     'need':{l_not(islogical):'#ctype#_from_pyobj'},
Chris@87:     '_check':l_and(isscalar, l_not(iscomplex), isintent_nothide),
Chris@87:     '_depend':''
Chris@87: #    },{ # Hidden
Chris@87: #    '_check':l_and(isscalar,l_not(iscomplex),isintent_hide)
Chris@87:     }, { # Hidden
Chris@87:     'frompyobj':{hasinitvalue:'\t#varname# = #init#;'},
Chris@87:     'need':typedef_need_dict,
Chris@87:     '_check':l_and(isscalar, l_not(iscomplex), isintent_hide),
Chris@87:     '_depend':''
Chris@87:     }, { # Common
Chris@87:     'frompyobj':{debugcapi:'\tfprintf(stderr,"#vardebugshowvalue#\\n",#varname#);'},
Chris@87:     '_check':l_and(isscalar, l_not(iscomplex)),
Chris@87:     '_depend':''
Chris@87:     },
Chris@87: # Complex scalars
Chris@87:     { # Common
Chris@87:     'decl':'\t#ctype# #varname#;',
Chris@87:     'callfortran':{isintent_c:'#varname#,',l_not(isintent_c):'&#varname#,'},
Chris@87:     'pyobjfrom':{debugcapi:'\tfprintf(stderr,"#vardebugshowvalue#\\n",#varname#.r,#varname#.i);'},
Chris@87:     'return':{isintent_out:',#varname#_capi'},
Chris@87:     '_check':iscomplex
Chris@87:     }, { # Not hidden
Chris@87:     'decl':'\tPyObject *#varname#_capi = Py_None;',
Chris@87:     'argformat':{isrequired:'O'},
Chris@87:     'keyformat':{isoptional:'O'},
Chris@87:     'args_capi':{isrequired:',&#varname#_capi'},
Chris@87:     'keys_capi':{isoptional:',&#varname#_capi'},
Chris@87:     'need':{isintent_inout:'try_pyarr_from_#ctype#'},
Chris@87:     'pyobjfrom':{isintent_inout:"""\
Chris@87: \t\tf2py_success = try_pyarr_from_#ctype#(#varname#_capi,&#varname#);
Chris@87: \t\tif (f2py_success) {"""},
Chris@87:     'closepyobjfrom':{isintent_inout:"\t\t} /*if (f2py_success) of #varname# pyobjfrom*/"},
Chris@87:     '_check':l_and(iscomplex, isintent_nothide)
Chris@87:     }, {
Chris@87:     'frompyobj':[{hasinitvalue:'\tif (#varname#_capi==Py_None) {#varname#.r = #init.r#, #varname#.i = #init.i#;} else'},
Chris@87:                  {l_and(isoptional, l_not(hasinitvalue)):'\tif (#varname#_capi != Py_None)'},
Chris@87: #                 '\t\tf2py_success = #ctype#_from_pyobj(&#varname#,#varname#_capi,"#ctype#_from_pyobj failed in converting #nth# `#varname#\' of #pyname# to C #ctype#\\n");'
Chris@87:                  '\t\tf2py_success = #ctype#_from_pyobj(&#varname#,#varname#_capi,"#pyname#() #nth# (#varname#) can\'t be converted to #ctype#");'
Chris@87:                  '\n\tif (f2py_success) {'],
Chris@87:     'cleanupfrompyobj':'\t}  /*if (f2py_success) of #varname# frompyobj*/',
Chris@87:     'need':['#ctype#_from_pyobj'],
Chris@87:     '_check':l_and(iscomplex, isintent_nothide),
Chris@87:     '_depend':''
Chris@87:     }, { # Hidden
Chris@87:     'decl':{isintent_out:'\tPyObject *#varname#_capi = Py_None;'},
Chris@87:     '_check':l_and(iscomplex, isintent_hide)
Chris@87:     }, {
Chris@87:     'frompyobj': {hasinitvalue:'\t#varname#.r = #init.r#, #varname#.i = #init.i#;'},
Chris@87:     '_check':l_and(iscomplex, isintent_hide),
Chris@87:     '_depend':''
Chris@87:     }, { # Common
Chris@87:     'pyobjfrom':{isintent_out:'\t#varname#_capi = pyobj_from_#ctype#1(#varname#);'},
Chris@87:     'need':['pyobj_from_#ctype#1'],
Chris@87:     '_check':iscomplex
Chris@87:     }, {
Chris@87:     'frompyobj':{debugcapi:'\tfprintf(stderr,"#vardebugshowvalue#\\n",#varname#.r,#varname#.i);'},
Chris@87:     '_check':iscomplex,
Chris@87:     '_depend':''
Chris@87:     },
Chris@87: # String
Chris@87:     { # Common
Chris@87:     'decl':['\t#ctype# #varname# = NULL;',
Chris@87:             '\tint slen(#varname#);',
Chris@87:             '\tPyObject *#varname#_capi = Py_None;'],
Chris@87:     'callfortran':'#varname#,',
Chris@87:     'callfortranappend':'slen(#varname#),',
Chris@87:     'pyobjfrom':{debugcapi:'\tfprintf(stderr,"#vardebugshowvalue#\\n",slen(#varname#),#varname#);'},
Chris@87: #    'freemem':'\tSTRINGFREE(#varname#);',
Chris@87:     'return':{isintent_out:',#varname#'},
Chris@87:     'need':['len..'],#'STRINGFREE'],
Chris@87:     '_check':isstring
Chris@87:     }, { # Common
Chris@87:     'frompyobj':"""\
Chris@87: \tslen(#varname#) = #length#;
Chris@87: \tf2py_success = #ctype#_from_pyobj(&#varname#,&slen(#varname#),#init#,#varname#_capi,\"#ctype#_from_pyobj failed in converting #nth# `#varname#\' of #pyname# to C #ctype#\");
Chris@87: \tif (f2py_success) {""",
Chris@87:     'cleanupfrompyobj':"""\
Chris@87: \t\tSTRINGFREE(#varname#);
Chris@87: \t}  /*if (f2py_success) of #varname#*/""",
Chris@87:     'need':['#ctype#_from_pyobj', 'len..', 'STRINGFREE'],
Chris@87:     '_check':isstring,
Chris@87:     '_depend':''
Chris@87:     }, { # Not hidden
Chris@87:     'argformat':{isrequired:'O'},
Chris@87:     'keyformat':{isoptional:'O'},
Chris@87:     'args_capi':{isrequired:',&#varname#_capi'},
Chris@87:     'keys_capi':{isoptional:',&#varname#_capi'},
Chris@87:     'pyobjfrom':{isintent_inout:'''\
Chris@87: \tf2py_success = try_pyarr_from_#ctype#(#varname#_capi,#varname#);
Chris@87: \tif (f2py_success) {'''},
Chris@87:     'closepyobjfrom':{isintent_inout:'\t} /*if (f2py_success) of #varname# pyobjfrom*/'},
Chris@87:     'need':{isintent_inout:'try_pyarr_from_#ctype#'},
Chris@87:     '_check':l_and(isstring, isintent_nothide)
Chris@87:     }, { # Hidden
Chris@87:     '_check':l_and(isstring, isintent_hide)
Chris@87:     }, {
Chris@87:     'frompyobj':{debugcapi:'\tfprintf(stderr,"#vardebugshowvalue#\\n",slen(#varname#),#varname#);'},
Chris@87:     '_check':isstring,
Chris@87:     '_depend':''
Chris@87:     },
Chris@87: # Array
Chris@87:     { # Common
Chris@87:     'decl':['\t#ctype# *#varname# = NULL;',
Chris@87:             '\tnpy_intp #varname#_Dims[#rank#] = {#rank*[-1]#};',
Chris@87:             '\tconst int #varname#_Rank = #rank#;',
Chris@87:             '\tPyArrayObject *capi_#varname#_tmp = NULL;',
Chris@87:             '\tint capi_#varname#_intent = 0;',
Chris@87:             ],
Chris@87:     'callfortran':'#varname#,',
Chris@87:     'return':{isintent_out:',capi_#varname#_tmp'},
Chris@87:     'need':'len..',
Chris@87:     '_check':isarray
Chris@87:     }, { # intent(overwrite) array
Chris@87:     'decl': '\tint capi_overwrite_#varname# = 1;',
Chris@87:     'kwlistxa': '"overwrite_#varname#",',
Chris@87:     'xaformat': 'i',
Chris@87:     'keys_xa': ',&capi_overwrite_#varname#',
Chris@87:     'docsignxa': 'overwrite_#varname#=1,',
Chris@87:     'docsignxashort': 'overwrite_#varname#,',
Chris@87:     'docstropt': 'overwrite_#varname# : input int, optional\\n    Default: 1',
Chris@87:     '_check': l_and(isarray, isintent_overwrite),
Chris@87:     }, {
Chris@87:     'frompyobj': '\tcapi_#varname#_intent |= (capi_overwrite_#varname#?0:F2PY_INTENT_COPY);',
Chris@87:     '_check': l_and(isarray, isintent_overwrite),
Chris@87:     '_depend': '',
Chris@87:     },
Chris@87:     { # intent(copy) array
Chris@87:     'decl': '\tint capi_overwrite_#varname# = 0;',
Chris@87:      'kwlistxa': '"overwrite_#varname#",',
Chris@87:      'xaformat': 'i',
Chris@87:      'keys_xa': ',&capi_overwrite_#varname#',
Chris@87:      'docsignxa': 'overwrite_#varname#=0,',
Chris@87:      'docsignxashort': 'overwrite_#varname#,',
Chris@87:      'docstropt': 'overwrite_#varname# : input int, optional\\n    Default: 0',
Chris@87:      '_check': l_and(isarray, isintent_copy),
Chris@87:      }, {
Chris@87:      'frompyobj': '\tcapi_#varname#_intent |= (capi_overwrite_#varname#?0:F2PY_INTENT_COPY);',
Chris@87:      '_check': l_and(isarray, isintent_copy),
Chris@87:      '_depend': '',
Chris@87:     }, {
Chris@87:     'need':[{hasinitvalue:'forcomb'}, {hasinitvalue:'CFUNCSMESS'}],
Chris@87:     '_check':isarray,
Chris@87:     '_depend':''
Chris@87:     }, { # Not hidden
Chris@87:     'decl':'\tPyObject *#varname#_capi = Py_None;',
Chris@87:     'argformat':{isrequired:'O'},
Chris@87:     'keyformat':{isoptional:'O'},
Chris@87:     'args_capi':{isrequired:',&#varname#_capi'},
Chris@87:     'keys_capi':{isoptional:',&#varname#_capi'},
Chris@87: #     'pyobjfrom':{isintent_inout:"""\
Chris@87: # /* Partly because of the following hack, intent(inout) is depreciated,
Chris@87: #    Use intent(in,out) instead.
Chris@87: 
Chris@87: # \tif ((#varname#_capi != Py_None) && PyArray_Check(#varname#_capi) \\
Chris@87: # \t\t&& (#varname#_capi != (PyObject *)capi_#varname#_tmp)) {
Chris@87: # \t\tif (((PyArrayObject *)#varname#_capi)->nd != capi_#varname#_tmp->nd) {
Chris@87: # \t\t\tif (#varname#_capi != capi_#varname#_tmp->base)
Chris@87: # \t\t\t\tcopy_ND_array((PyArrayObject *)capi_#varname#_tmp->base,(PyArrayObject *)#varname#_capi);
Chris@87: # \t\t} else
Chris@87: # \t\t\tcopy_ND_array(capi_#varname#_tmp,(PyArrayObject *)#varname#_capi);
Chris@87: # \t}
Chris@87: # */
Chris@87: # """},
Chris@87: #     'need':{isintent_inout:'copy_ND_array'},
Chris@87:     '_check':l_and(isarray, isintent_nothide)
Chris@87:     }, {
Chris@87:     'frompyobj':['\t#setdims#;',
Chris@87:                  '\tcapi_#varname#_intent |= #intent#;',
Chris@87:                  {isintent_hide:'\tcapi_#varname#_tmp = array_from_pyobj(#atype#,#varname#_Dims,#varname#_Rank,capi_#varname#_intent,Py_None);'},
Chris@87:                  {isintent_nothide:'\tcapi_#varname#_tmp = array_from_pyobj(#atype#,#varname#_Dims,#varname#_Rank,capi_#varname#_intent,#varname#_capi);'},
Chris@87:                  """\
Chris@87: \tif (capi_#varname#_tmp == NULL) {
Chris@87: \t\tif (!PyErr_Occurred())
Chris@87: \t\t\tPyErr_SetString(#modulename#_error,\"failed in converting #nth# `#varname#\' of #pyname# to C/Fortran array\" );
Chris@87: \t} else {
Chris@87: \t\t#varname# = (#ctype# *)(capi_#varname#_tmp->data);
Chris@87: """,
Chris@87: {hasinitvalue:[
Chris@87:     {isintent_nothide:'\tif (#varname#_capi == Py_None) {'},
Chris@87:     {isintent_hide:'\t{'},
Chris@87:     {iscomplexarray:'\t\t#ctype# capi_c;'},
Chris@87:     """\
Chris@87: \t\tint *_i,capi_i=0;
Chris@87: \t\tCFUNCSMESS(\"#name#: Initializing #varname#=#init#\\n\");
Chris@87: \t\tif (initforcomb(capi_#varname#_tmp->dimensions,capi_#varname#_tmp->nd,1)) {
Chris@87: \t\t\twhile ((_i = nextforcomb()))
Chris@87: \t\t\t\t#varname#[capi_i++] = #init#; /* fortran way */
Chris@87: \t\t} else {
Chris@87: \t\t\tif (!PyErr_Occurred())
Chris@87: \t\t\t\tPyErr_SetString(#modulename#_error,\"Initialization of #nth# #varname# failed (initforcomb).\");
Chris@87: \t\t\tf2py_success = 0;
Chris@87: \t\t}
Chris@87: \t}
Chris@87: \tif (f2py_success) {"""]},
Chris@87:                  ],
Chris@87:     'cleanupfrompyobj':[ # note that this list will be reversed
Chris@87:     '\t}  /*if (capi_#varname#_tmp == NULL) ... else of #varname#*/',
Chris@87:     {l_not(l_or(isintent_out, isintent_hide)):"""\
Chris@87: \tif((PyObject *)capi_#varname#_tmp!=#varname#_capi) {
Chris@87: \t\tPy_XDECREF(capi_#varname#_tmp); }"""},
Chris@87:     {l_and(isintent_hide, l_not(isintent_out)):"""\t\tPy_XDECREF(capi_#varname#_tmp);"""},
Chris@87:     {hasinitvalue:'\t}  /*if (f2py_success) of #varname# init*/'},
Chris@87:     ],
Chris@87:     '_check':isarray,
Chris@87:     '_depend':''
Chris@87:     },
Chris@87: #    { # Hidden
Chris@87: #    'freemem':{l_not(isintent_out):'\tPy_XDECREF(capi_#varname#_tmp);'},
Chris@87: #    '_check':l_and(isarray,isintent_hide)
Chris@87: #    },
Chris@87: # Scalararray
Chris@87:     { # Common
Chris@87:     '_check':l_and(isarray, l_not(iscomplexarray))
Chris@87:     }, { # Not hidden
Chris@87:     '_check':l_and(isarray, l_not(iscomplexarray), isintent_nothide)
Chris@87:     },
Chris@87: # Integer*1 array
Chris@87:     {'need':'#ctype#',
Chris@87:      '_check':isint1array,
Chris@87:      '_depend':''
Chris@87:      },
Chris@87: # Integer*-1 array
Chris@87:     {'need':'#ctype#',
Chris@87:      '_check':isunsigned_chararray,
Chris@87:      '_depend':''
Chris@87:      },
Chris@87: # Integer*-2 array
Chris@87:     {'need':'#ctype#',
Chris@87:      '_check':isunsigned_shortarray,
Chris@87:      '_depend':''
Chris@87:      },
Chris@87: # Integer*-8 array
Chris@87:     {'need':'#ctype#',
Chris@87:      '_check':isunsigned_long_longarray,
Chris@87:      '_depend':''
Chris@87:      },
Chris@87: # Complexarray
Chris@87:     {'need':'#ctype#',
Chris@87:      '_check':iscomplexarray,
Chris@87:      '_depend':''
Chris@87:      },
Chris@87: # Stringarray
Chris@87:      {
Chris@87:      'callfortranappend':{isarrayofstrings:'flen(#varname#),'},
Chris@87:      'need':'string',
Chris@87:      '_check':isstringarray
Chris@87:      }
Chris@87:     ]
Chris@87: 
Chris@87: ################# Rules for checking ###############
Chris@87: 
Chris@87: check_rules=[
Chris@87:     {
Chris@87:     'frompyobj':{debugcapi:'\tfprintf(stderr,\"debug-capi:Checking `#check#\'\\n\");'},
Chris@87:     'need':'len..'
Chris@87:     }, {
Chris@87:     'frompyobj':'\tCHECKSCALAR(#check#,\"#check#\",\"#nth# #varname#\",\"#varshowvalue#\",#varname#) {',
Chris@87:     'cleanupfrompyobj':'\t} /*CHECKSCALAR(#check#)*/',
Chris@87:     'need':'CHECKSCALAR',
Chris@87:     '_check':l_and(isscalar, l_not(iscomplex)),
Chris@87:     '_break':''
Chris@87:     }, {
Chris@87:     'frompyobj':'\tCHECKSTRING(#check#,\"#check#\",\"#nth# #varname#\",\"#varshowvalue#\",#varname#) {',
Chris@87:     'cleanupfrompyobj':'\t} /*CHECKSTRING(#check#)*/',
Chris@87:     'need':'CHECKSTRING',
Chris@87:     '_check':isstring,
Chris@87:     '_break':''
Chris@87:     }, {
Chris@87:     'need':'CHECKARRAY',
Chris@87:     'frompyobj':'\tCHECKARRAY(#check#,\"#check#\",\"#nth# #varname#\") {',
Chris@87:     'cleanupfrompyobj':'\t} /*CHECKARRAY(#check#)*/',
Chris@87:     '_check':isarray,
Chris@87:     '_break':''
Chris@87:     }, {
Chris@87:     'need': 'CHECKGENERIC',
Chris@87:     'frompyobj': '\tCHECKGENERIC(#check#,\"#check#\",\"#nth# #varname#\") {',
Chris@87:     'cleanupfrompyobj': '\t} /*CHECKGENERIC(#check#)*/',
Chris@87:     }
Chris@87: ]
Chris@87: 
Chris@87: ########## Applying the rules. No need to modify what follows #############
Chris@87: 
Chris@87: #################### Build C/API module #######################
Chris@87: 
Chris@87: def buildmodule(m, um):
Chris@87:     """
Chris@87:     Return
Chris@87:     """
Chris@87:     global f2py_version, options
Chris@87:     outmess('\tBuilding module "%s"...\n'%(m['name']))
Chris@87:     ret = {}
Chris@87:     mod_rules=defmod_rules[:]
Chris@87:     vrd=modsign2map(m)
Chris@87:     rd=dictappend({'f2py_version':f2py_version}, vrd)
Chris@87:     funcwrappers = []
Chris@87:     funcwrappers2 = [] # F90 codes
Chris@87:     for n in m['interfaced']:
Chris@87:         nb=None
Chris@87:         for bi in m['body']:
Chris@87:             if not bi['block']=='interface':
Chris@87:                 errmess('buildmodule: Expected interface block. Skipping.\n')
Chris@87:                 continue
Chris@87:             for b in bi['body']:
Chris@87:                 if b['name']==n: nb=b;break
Chris@87: 
Chris@87:         if not nb:
Chris@87:             errmess('buildmodule: Could not found the body of interfaced routine "%s". Skipping.\n'%(n))
Chris@87:             continue
Chris@87:         nb_list = [nb]
Chris@87:         if 'entry' in nb:
Chris@87:             for k, a in nb['entry'].items():
Chris@87:                 nb1 = copy.deepcopy(nb)
Chris@87:                 del nb1['entry']
Chris@87:                 nb1['name'] = k
Chris@87:                 nb1['args'] = a
Chris@87:                 nb_list.append(nb1)
Chris@87:         for nb in nb_list:
Chris@87:             api, wrap=buildapi(nb)
Chris@87:             if wrap:
Chris@87:                 if ismoduleroutine(nb):
Chris@87:                     funcwrappers2.append(wrap)
Chris@87:                 else:
Chris@87:                     funcwrappers.append(wrap)
Chris@87:             ar=applyrules(api, vrd)
Chris@87:             rd=dictappend(rd, ar)
Chris@87: 
Chris@87:     # Construct COMMON block support
Chris@87:     cr, wrap = common_rules.buildhooks(m)
Chris@87:     if wrap:
Chris@87:         funcwrappers.append(wrap)
Chris@87:     ar=applyrules(cr, vrd)
Chris@87:     rd=dictappend(rd, ar)
Chris@87: 
Chris@87:     # Construct F90 module support
Chris@87:     mr, wrap = f90mod_rules.buildhooks(m)
Chris@87:     if wrap:
Chris@87:         funcwrappers2.append(wrap)
Chris@87:     ar=applyrules(mr, vrd)
Chris@87:     rd=dictappend(rd, ar)
Chris@87: 
Chris@87:     for u in um:
Chris@87:         ar=use_rules.buildusevars(u, m['use'][u['name']])
Chris@87:         rd=dictappend(rd, ar)
Chris@87: 
Chris@87:     needs=cfuncs.get_needs()
Chris@87:     code={}
Chris@87:     for n in needs.keys():
Chris@87:         code[n]=[]
Chris@87:         for k in needs[n]:
Chris@87:             c=''
Chris@87:             if k in cfuncs.includes0:
Chris@87:                 c=cfuncs.includes0[k]
Chris@87:             elif k in cfuncs.includes:
Chris@87:                 c=cfuncs.includes[k]
Chris@87:             elif k in cfuncs.userincludes:
Chris@87:                 c=cfuncs.userincludes[k]
Chris@87:             elif k in cfuncs.typedefs:
Chris@87:                 c=cfuncs.typedefs[k]
Chris@87:             elif k in cfuncs.typedefs_generated:
Chris@87:                 c=cfuncs.typedefs_generated[k]
Chris@87:             elif k in cfuncs.cppmacros:
Chris@87:                 c=cfuncs.cppmacros[k]
Chris@87:             elif k in cfuncs.cfuncs:
Chris@87:                 c=cfuncs.cfuncs[k]
Chris@87:             elif k in cfuncs.callbacks:
Chris@87:                 c=cfuncs.callbacks[k]
Chris@87:             elif k in cfuncs.f90modhooks:
Chris@87:                 c=cfuncs.f90modhooks[k]
Chris@87:             elif k in cfuncs.commonhooks:
Chris@87:                 c=cfuncs.commonhooks[k]
Chris@87:             else:
Chris@87:                 errmess('buildmodule: unknown need %s.\n'%(repr(k)));continue
Chris@87:             code[n].append(c)
Chris@87:     mod_rules.append(code)
Chris@87:     for r in mod_rules:
Chris@87:         if ('_check' in r and r['_check'](m)) or ('_check' not in r):
Chris@87:             ar=applyrules(r, vrd, m)
Chris@87:             rd=dictappend(rd, ar)
Chris@87:     ar=applyrules(module_rules, rd)
Chris@87: 
Chris@87:     fn = os.path.join(options['buildpath'], vrd['coutput'])
Chris@87:     ret['csrc'] = fn
Chris@87:     f=open(fn, 'w')
Chris@87:     f.write(ar['modulebody'].replace('\t', 2*' '))
Chris@87:     f.close()
Chris@87:     outmess('\tWrote C/API module "%s" to file "%s"\n'%(m['name'], fn))
Chris@87: 
Chris@87:     if options['dorestdoc']:
Chris@87:         fn = os.path.join(options['buildpath'], vrd['modulename']+'module.rest')
Chris@87:         f=open(fn, 'w')
Chris@87:         f.write('.. -*- rest -*-\n')
Chris@87:         f.write('\n'.join(ar['restdoc']))
Chris@87:         f.close()
Chris@87:         outmess('\tReST Documentation is saved to file "%s/%smodule.rest"\n'%(options['buildpath'], vrd['modulename']))
Chris@87:     if options['dolatexdoc']:
Chris@87:         fn = os.path.join(options['buildpath'], vrd['modulename']+'module.tex')
Chris@87:         ret['ltx'] = fn
Chris@87:         f=open(fn, 'w')
Chris@87:         f.write('%% This file is auto-generated with f2py (version:%s)\n'%(f2py_version))
Chris@87:         if 'shortlatex' not in options:
Chris@87:             f.write('\\documentclass{article}\n\\usepackage{a4wide}\n\\begin{document}\n\\tableofcontents\n\n')
Chris@87:         f.write('\n'.join(ar['latexdoc']))
Chris@87:         if 'shortlatex' not in options:
Chris@87:             f.write('\\end{document}')
Chris@87:         f.close()
Chris@87:         outmess('\tDocumentation is saved to file "%s/%smodule.tex"\n'%(options['buildpath'], vrd['modulename']))
Chris@87:     if funcwrappers:
Chris@87:         wn = os.path.join(options['buildpath'], vrd['f2py_wrapper_output'])
Chris@87:         ret['fsrc'] = wn
Chris@87:         f=open(wn, 'w')
Chris@87:         f.write('C     -*- fortran -*-\n')
Chris@87:         f.write('C     This file is autogenerated with f2py (version:%s)\n'%(f2py_version))
Chris@87:         f.write('C     It contains Fortran 77 wrappers to fortran functions.\n')
Chris@87:         lines = []
Chris@87:         for l in ('\n\n'.join(funcwrappers)+'\n').split('\n'):
Chris@87:             if l and l[0]==' ':
Chris@87:                 while len(l)>=66:
Chris@87:                     lines.append(l[:66]+'\n     &')
Chris@87:                     l = l[66:]
Chris@87:                 lines.append(l+'\n')
Chris@87:             else: lines.append(l+'\n')
Chris@87:         lines = ''.join(lines).replace('\n     &\n', '\n')
Chris@87:         f.write(lines)
Chris@87:         f.close()
Chris@87:         outmess('\tFortran 77 wrappers are saved to "%s"\n'%(wn))
Chris@87:     if funcwrappers2:
Chris@87:         wn = os.path.join(options['buildpath'], '%s-f2pywrappers2.f90'%(vrd['modulename']))
Chris@87:         ret['fsrc'] = wn
Chris@87:         f=open(wn, 'w')
Chris@87:         f.write('!     -*- f90 -*-\n')
Chris@87:         f.write('!     This file is autogenerated with f2py (version:%s)\n'%(f2py_version))
Chris@87:         f.write('!     It contains Fortran 90 wrappers to fortran functions.\n')
Chris@87:         lines = []
Chris@87:         for l in ('\n\n'.join(funcwrappers2)+'\n').split('\n'):
Chris@87:             if len(l)>72 and l[0]==' ':
Chris@87:                 lines.append(l[:72]+'&\n     &')
Chris@87:                 l = l[72:]
Chris@87:                 while len(l)>66:
Chris@87:                     lines.append(l[:66]+'&\n     &')
Chris@87:                     l = l[66:]
Chris@87:                 lines.append(l+'\n')
Chris@87:             else: lines.append(l+'\n')
Chris@87:         lines = ''.join(lines).replace('\n     &\n', '\n')
Chris@87:         f.write(lines)
Chris@87:         f.close()
Chris@87:         outmess('\tFortran 90 wrappers are saved to "%s"\n'%(wn))
Chris@87:     return ret
Chris@87: 
Chris@87: ################## Build C/API function #############
Chris@87: 
Chris@87: stnd={1:'st',2:'nd',3:'rd',4:'th',5:'th',6:'th',7:'th',8:'th',9:'th',0:'th'}
Chris@87: 
Chris@87: def buildapi(rout):
Chris@87:     rout, wrap = func2subr.assubr(rout)
Chris@87:     args, depargs=getargs2(rout)
Chris@87:     capi_maps.depargs=depargs
Chris@87:     var=rout['vars']
Chris@87:     auxvars = [a for a in var.keys() if isintent_aux(var[a])]
Chris@87: 
Chris@87:     if ismoduleroutine(rout):
Chris@87:         outmess('\t\t\tConstructing wrapper function "%s.%s"...\n'%(rout['modulename'], rout['name']))
Chris@87:     else:
Chris@87:         outmess('\t\tConstructing wrapper function "%s"...\n'%(rout['name']))
Chris@87:     # Routine
Chris@87:     vrd=routsign2map(rout)
Chris@87:     rd=dictappend({}, vrd)
Chris@87:     for r in rout_rules:
Chris@87:         if ('_check' in r and r['_check'](rout)) or ('_check' not in r):
Chris@87:             ar=applyrules(r, vrd, rout)
Chris@87:             rd=dictappend(rd, ar)
Chris@87: 
Chris@87:     # Args
Chris@87:     nth, nthk=0, 0
Chris@87:     savevrd={}
Chris@87:     for a in args:
Chris@87:         vrd=sign2map(a, var[a])
Chris@87:         if isintent_aux(var[a]):
Chris@87:             _rules = aux_rules
Chris@87:         else:
Chris@87:             _rules = arg_rules
Chris@87:             if not isintent_hide(var[a]):
Chris@87:                 if not isoptional(var[a]):
Chris@87:                     nth=nth+1
Chris@87:                     vrd['nth']=repr(nth)+stnd[nth%10]+' argument'
Chris@87:                 else:
Chris@87:                     nthk=nthk+1
Chris@87:                     vrd['nth']=repr(nthk)+stnd[nthk%10]+' keyword'
Chris@87:             else: vrd['nth']='hidden'
Chris@87:         savevrd[a]=vrd
Chris@87:         for r in _rules:
Chris@87:             if '_depend' in r:
Chris@87:                 continue
Chris@87:             if ('_check' in r and r['_check'](var[a])) or ('_check' not in r):
Chris@87:                 ar=applyrules(r, vrd, var[a])
Chris@87:                 rd=dictappend(rd, ar)
Chris@87:                 if '_break' in r:
Chris@87:                     break
Chris@87:     for a in depargs:
Chris@87:         if isintent_aux(var[a]):
Chris@87:             _rules = aux_rules
Chris@87:         else:
Chris@87:             _rules = arg_rules
Chris@87:         vrd=savevrd[a]
Chris@87:         for r in _rules:
Chris@87:             if '_depend' not in r:
Chris@87:                 continue
Chris@87:             if ('_check' in r and r['_check'](var[a])) or ('_check' not in r):
Chris@87:                 ar=applyrules(r, vrd, var[a])
Chris@87:                 rd=dictappend(rd, ar)
Chris@87:                 if '_break' in r:
Chris@87:                     break
Chris@87:         if 'check' in var[a]:
Chris@87:             for c in var[a]['check']:
Chris@87:                 vrd['check']=c
Chris@87:                 ar=applyrules(check_rules, vrd, var[a])
Chris@87:                 rd=dictappend(rd, ar)
Chris@87:     if isinstance(rd['cleanupfrompyobj'], list):
Chris@87:         rd['cleanupfrompyobj'].reverse()
Chris@87:     if isinstance(rd['closepyobjfrom'], list):
Chris@87:         rd['closepyobjfrom'].reverse()
Chris@87:     rd['docsignature']=stripcomma(replace('#docsign##docsignopt##docsignxa#',
Chris@87:                                           {'docsign':rd['docsign'],
Chris@87:                                            'docsignopt':rd['docsignopt'],
Chris@87:                                            'docsignxa':rd['docsignxa']}))
Chris@87:     optargs=stripcomma(replace('#docsignopt##docsignxa#',
Chris@87:                                {'docsignxa':rd['docsignxashort'],
Chris@87:                                 'docsignopt':rd['docsignoptshort']}
Chris@87:                                ))
Chris@87:     if optargs=='':
Chris@87:         rd['docsignatureshort']=stripcomma(replace('#docsign#', {'docsign':rd['docsign']}))
Chris@87:     else:
Chris@87:         rd['docsignatureshort']=replace('#docsign#[#docsignopt#]',
Chris@87:                                         {'docsign': rd['docsign'],
Chris@87:                                          'docsignopt': optargs,
Chris@87:                                          })
Chris@87:     rd['latexdocsignatureshort']=rd['docsignatureshort'].replace('_', '\\_')
Chris@87:     rd['latexdocsignatureshort']=rd['latexdocsignatureshort'].replace(',', ', ')
Chris@87:     cfs=stripcomma(replace('#callfortran##callfortranappend#', {'callfortran':rd['callfortran'],'callfortranappend':rd['callfortranappend']}))
Chris@87:     if len(rd['callfortranappend'])>1:
Chris@87:         rd['callcompaqfortran']=stripcomma(replace('#callfortran# 0,#callfortranappend#', {'callfortran':rd['callfortran'],'callfortranappend':rd['callfortranappend']}))
Chris@87:     else:
Chris@87:         rd['callcompaqfortran']=cfs
Chris@87:     rd['callfortran']=cfs
Chris@87:     if isinstance(rd['docreturn'], list):
Chris@87:         rd['docreturn']=stripcomma(replace('#docreturn#', {'docreturn':rd['docreturn']}))+' = '
Chris@87:     rd['docstrsigns']=[]
Chris@87:     rd['latexdocstrsigns']=[]
Chris@87:     for k in ['docstrreq', 'docstropt', 'docstrout', 'docstrcbs']:
Chris@87:         if k in rd and isinstance(rd[k], list):
Chris@87:             rd['docstrsigns']=rd['docstrsigns']+rd[k]
Chris@87:         k='latex'+k
Chris@87:         if k in rd and isinstance(rd[k], list):
Chris@87:             rd['latexdocstrsigns']=rd['latexdocstrsigns']+rd[k][0:1]+\
Chris@87:                                     ['\\begin{description}']+rd[k][1:]+\
Chris@87:                                     ['\\end{description}']
Chris@87: 
Chris@87:     # Workaround for Python 2.6, 2.6.1 bug: http://bugs.python.org/issue4720
Chris@87:     if rd['keyformat'] or rd['xaformat']:
Chris@87:         argformat = rd['argformat']
Chris@87:         if isinstance(argformat, list):
Chris@87:             argformat.append('|')
Chris@87:         else:
Chris@87:             assert isinstance(argformat, str), repr((argformat, type(argformat)))
Chris@87:             rd['argformat'] += '|'
Chris@87: 
Chris@87:     ar=applyrules(routine_rules, rd)
Chris@87:     if ismoduleroutine(rout):
Chris@87:         outmess('\t\t\t  %s\n'%(ar['docshort']))
Chris@87:     else:
Chris@87:         outmess('\t\t  %s\n'%(ar['docshort']))
Chris@87:     return ar, wrap
Chris@87: 
Chris@87: 
Chris@87: #################### EOF rules.py #######################