func2subr.py 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300
  1. #!/usr/bin/env python
  2. """
  3. Rules for building C/API module with f2py2e.
  4. Copyright 1999,2000 Pearu Peterson all rights reserved,
  5. Pearu Peterson <pearu@ioc.ee>
  6. Permission to use, modify, and distribute this software is given under the
  7. terms of the NumPy License.
  8. NO WARRANTY IS EXPRESSED OR IMPLIED. USE AT YOUR OWN RISK.
  9. $Date: 2004/11/26 11:13:06 $
  10. Pearu Peterson
  11. """
  12. from __future__ import division, absolute_import, print_function
  13. __version__ = "$Revision: 1.16 $"[10:-1]
  14. f2py_version = 'See `f2py -v`'
  15. import copy
  16. from .auxfuncs import (
  17. getfortranname, isexternal, isfunction, isfunction_wrap, isintent_in,
  18. isintent_out, islogicalfunction, ismoduleroutine, isscalar,
  19. issubroutine, issubroutine_wrap, outmess, show
  20. )
  21. def var2fixfortran(vars, a, fa=None, f90mode=None):
  22. if fa is None:
  23. fa = a
  24. if a not in vars:
  25. show(vars)
  26. outmess('var2fixfortran: No definition for argument "%s".\n' % a)
  27. return ''
  28. if 'typespec' not in vars[a]:
  29. show(vars[a])
  30. outmess('var2fixfortran: No typespec for argument "%s".\n' % a)
  31. return ''
  32. vardef = vars[a]['typespec']
  33. if vardef == 'type' and 'typename' in vars[a]:
  34. vardef = '%s(%s)' % (vardef, vars[a]['typename'])
  35. selector = {}
  36. lk = ''
  37. if 'kindselector' in vars[a]:
  38. selector = vars[a]['kindselector']
  39. lk = 'kind'
  40. elif 'charselector' in vars[a]:
  41. selector = vars[a]['charselector']
  42. lk = 'len'
  43. if '*' in selector:
  44. if f90mode:
  45. if selector['*'] in ['*', ':', '(*)']:
  46. vardef = '%s(len=*)' % (vardef)
  47. else:
  48. vardef = '%s(%s=%s)' % (vardef, lk, selector['*'])
  49. else:
  50. if selector['*'] in ['*', ':']:
  51. vardef = '%s*(%s)' % (vardef, selector['*'])
  52. else:
  53. vardef = '%s*%s' % (vardef, selector['*'])
  54. else:
  55. if 'len' in selector:
  56. vardef = '%s(len=%s' % (vardef, selector['len'])
  57. if 'kind' in selector:
  58. vardef = '%s,kind=%s)' % (vardef, selector['kind'])
  59. else:
  60. vardef = '%s)' % (vardef)
  61. elif 'kind' in selector:
  62. vardef = '%s(kind=%s)' % (vardef, selector['kind'])
  63. vardef = '%s %s' % (vardef, fa)
  64. if 'dimension' in vars[a]:
  65. vardef = '%s(%s)' % (vardef, ','.join(vars[a]['dimension']))
  66. return vardef
  67. def createfuncwrapper(rout, signature=0):
  68. assert isfunction(rout)
  69. extra_args = []
  70. vars = rout['vars']
  71. for a in rout['args']:
  72. v = rout['vars'][a]
  73. for i, d in enumerate(v.get('dimension', [])):
  74. if d == ':':
  75. dn = 'f2py_%s_d%s' % (a, i)
  76. dv = dict(typespec='integer', intent=['hide'])
  77. dv['='] = 'shape(%s, %s)' % (a, i)
  78. extra_args.append(dn)
  79. vars[dn] = dv
  80. v['dimension'][i] = dn
  81. rout['args'].extend(extra_args)
  82. need_interface = bool(extra_args)
  83. ret = ['']
  84. def add(line, ret=ret):
  85. ret[0] = '%s\n %s' % (ret[0], line)
  86. name = rout['name']
  87. fortranname = getfortranname(rout)
  88. f90mode = ismoduleroutine(rout)
  89. newname = '%sf2pywrap' % (name)
  90. if newname not in vars:
  91. vars[newname] = vars[name]
  92. args = [newname] + rout['args'][1:]
  93. else:
  94. args = [newname] + rout['args']
  95. l = var2fixfortran(vars, name, newname, f90mode)
  96. if l[:13] == 'character*(*)':
  97. if f90mode:
  98. l = 'character(len=10)' + l[13:]
  99. else:
  100. l = 'character*10' + l[13:]
  101. charselect = vars[name]['charselector']
  102. if charselect.get('*', '') == '(*)':
  103. charselect['*'] = '10'
  104. sargs = ', '.join(args)
  105. if f90mode:
  106. add('subroutine f2pywrap_%s_%s (%s)' %
  107. (rout['modulename'], name, sargs))
  108. if not signature:
  109. add('use %s, only : %s' % (rout['modulename'], fortranname))
  110. else:
  111. add('subroutine f2pywrap%s (%s)' % (name, sargs))
  112. if not need_interface:
  113. add('external %s' % (fortranname))
  114. l = l + ', ' + fortranname
  115. if need_interface:
  116. for line in rout['saved_interface'].split('\n'):
  117. if line.lstrip().startswith('use '):
  118. add(line)
  119. args = args[1:]
  120. dumped_args = []
  121. for a in args:
  122. if isexternal(vars[a]):
  123. add('external %s' % (a))
  124. dumped_args.append(a)
  125. for a in args:
  126. if a in dumped_args:
  127. continue
  128. if isscalar(vars[a]):
  129. add(var2fixfortran(vars, a, f90mode=f90mode))
  130. dumped_args.append(a)
  131. for a in args:
  132. if a in dumped_args:
  133. continue
  134. if isintent_in(vars[a]):
  135. add(var2fixfortran(vars, a, f90mode=f90mode))
  136. dumped_args.append(a)
  137. for a in args:
  138. if a in dumped_args:
  139. continue
  140. add(var2fixfortran(vars, a, f90mode=f90mode))
  141. add(l)
  142. if need_interface:
  143. if f90mode:
  144. # f90 module already defines needed interface
  145. pass
  146. else:
  147. add('interface')
  148. add(rout['saved_interface'].lstrip())
  149. add('end interface')
  150. sargs = ', '.join([a for a in args if a not in extra_args])
  151. if not signature:
  152. if islogicalfunction(rout):
  153. add('%s = .not.(.not.%s(%s))' % (newname, fortranname, sargs))
  154. else:
  155. add('%s = %s(%s)' % (newname, fortranname, sargs))
  156. if f90mode:
  157. add('end subroutine f2pywrap_%s_%s' % (rout['modulename'], name))
  158. else:
  159. add('end')
  160. return ret[0]
  161. def createsubrwrapper(rout, signature=0):
  162. assert issubroutine(rout)
  163. extra_args = []
  164. vars = rout['vars']
  165. for a in rout['args']:
  166. v = rout['vars'][a]
  167. for i, d in enumerate(v.get('dimension', [])):
  168. if d == ':':
  169. dn = 'f2py_%s_d%s' % (a, i)
  170. dv = dict(typespec='integer', intent=['hide'])
  171. dv['='] = 'shape(%s, %s)' % (a, i)
  172. extra_args.append(dn)
  173. vars[dn] = dv
  174. v['dimension'][i] = dn
  175. rout['args'].extend(extra_args)
  176. need_interface = bool(extra_args)
  177. ret = ['']
  178. def add(line, ret=ret):
  179. ret[0] = '%s\n %s' % (ret[0], line)
  180. name = rout['name']
  181. fortranname = getfortranname(rout)
  182. f90mode = ismoduleroutine(rout)
  183. args = rout['args']
  184. sargs = ', '.join(args)
  185. if f90mode:
  186. add('subroutine f2pywrap_%s_%s (%s)' %
  187. (rout['modulename'], name, sargs))
  188. if not signature:
  189. add('use %s, only : %s' % (rout['modulename'], fortranname))
  190. else:
  191. add('subroutine f2pywrap%s (%s)' % (name, sargs))
  192. if not need_interface:
  193. add('external %s' % (fortranname))
  194. if need_interface:
  195. for line in rout['saved_interface'].split('\n'):
  196. if line.lstrip().startswith('use '):
  197. add(line)
  198. dumped_args = []
  199. for a in args:
  200. if isexternal(vars[a]):
  201. add('external %s' % (a))
  202. dumped_args.append(a)
  203. for a in args:
  204. if a in dumped_args:
  205. continue
  206. if isscalar(vars[a]):
  207. add(var2fixfortran(vars, a, f90mode=f90mode))
  208. dumped_args.append(a)
  209. for a in args:
  210. if a in dumped_args:
  211. continue
  212. add(var2fixfortran(vars, a, f90mode=f90mode))
  213. if need_interface:
  214. if f90mode:
  215. # f90 module already defines needed interface
  216. pass
  217. else:
  218. add('interface')
  219. add(rout['saved_interface'].lstrip())
  220. add('end interface')
  221. sargs = ', '.join([a for a in args if a not in extra_args])
  222. if not signature:
  223. add('call %s(%s)' % (fortranname, sargs))
  224. if f90mode:
  225. add('end subroutine f2pywrap_%s_%s' % (rout['modulename'], name))
  226. else:
  227. add('end')
  228. return ret[0]
  229. def assubr(rout):
  230. if isfunction_wrap(rout):
  231. fortranname = getfortranname(rout)
  232. name = rout['name']
  233. outmess('\t\tCreating wrapper for Fortran function "%s"("%s")...\n' % (
  234. name, fortranname))
  235. rout = copy.copy(rout)
  236. fname = name
  237. rname = fname
  238. if 'result' in rout:
  239. rname = rout['result']
  240. rout['vars'][fname] = rout['vars'][rname]
  241. fvar = rout['vars'][fname]
  242. if not isintent_out(fvar):
  243. if 'intent' not in fvar:
  244. fvar['intent'] = []
  245. fvar['intent'].append('out')
  246. flag = 1
  247. for i in fvar['intent']:
  248. if i.startswith('out='):
  249. flag = 0
  250. break
  251. if flag:
  252. fvar['intent'].append('out=%s' % (rname))
  253. rout['args'][:] = [fname] + rout['args']
  254. return rout, createfuncwrapper(rout)
  255. if issubroutine_wrap(rout):
  256. fortranname = getfortranname(rout)
  257. name = rout['name']
  258. outmess('\t\tCreating wrapper for Fortran subroutine "%s"("%s")...\n' % (
  259. name, fortranname))
  260. rout = copy.copy(rout)
  261. return rout, createsubrwrapper(rout)
  262. return rout, ''