common_rules.py 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. #!/usr/bin/env python3
  2. """
  3. Build common block mechanism for f2py2e.
  4. Copyright 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: 2005/05/06 10:57:33 $
  10. Pearu Peterson
  11. """
  12. __version__ = "$Revision: 1.19 $"[10:-1]
  13. from . import __version__
  14. f2py_version = __version__.version
  15. from .auxfuncs import (
  16. hasbody, hascommon, hasnote, isintent_hide, outmess
  17. )
  18. from . import capi_maps
  19. from . import func2subr
  20. from .crackfortran import rmbadname
  21. def findcommonblocks(block, top=1):
  22. ret = []
  23. if hascommon(block):
  24. for key, value in block['common'].items():
  25. vars_ = {v: block['vars'][v] for v in value}
  26. ret.append((key, value, vars_))
  27. elif hasbody(block):
  28. for b in block['body']:
  29. ret = ret + findcommonblocks(b, 0)
  30. if top:
  31. tret = []
  32. names = []
  33. for t in ret:
  34. if t[0] not in names:
  35. names.append(t[0])
  36. tret.append(t)
  37. return tret
  38. return ret
  39. def buildhooks(m):
  40. ret = {'commonhooks': [], 'initcommonhooks': [],
  41. 'docs': ['"COMMON blocks:\\n"']}
  42. fwrap = ['']
  43. def fadd(line, s=fwrap):
  44. s[0] = '%s\n %s' % (s[0], line)
  45. chooks = ['']
  46. def cadd(line, s=chooks):
  47. s[0] = '%s\n%s' % (s[0], line)
  48. ihooks = ['']
  49. def iadd(line, s=ihooks):
  50. s[0] = '%s\n%s' % (s[0], line)
  51. doc = ['']
  52. def dadd(line, s=doc):
  53. s[0] = '%s\n%s' % (s[0], line)
  54. for (name, vnames, vars) in findcommonblocks(m):
  55. lower_name = name.lower()
  56. hnames, inames = [], []
  57. for n in vnames:
  58. if isintent_hide(vars[n]):
  59. hnames.append(n)
  60. else:
  61. inames.append(n)
  62. if hnames:
  63. outmess('\t\tConstructing COMMON block support for "%s"...\n\t\t %s\n\t\t Hidden: %s\n' % (
  64. name, ','.join(inames), ','.join(hnames)))
  65. else:
  66. outmess('\t\tConstructing COMMON block support for "%s"...\n\t\t %s\n' % (
  67. name, ','.join(inames)))
  68. fadd('subroutine f2pyinit%s(setupfunc)' % name)
  69. fadd('external setupfunc')
  70. for n in vnames:
  71. fadd(func2subr.var2fixfortran(vars, n))
  72. if name == '_BLNK_':
  73. fadd('common %s' % (','.join(vnames)))
  74. else:
  75. fadd('common /%s/ %s' % (name, ','.join(vnames)))
  76. fadd('call setupfunc(%s)' % (','.join(inames)))
  77. fadd('end\n')
  78. cadd('static FortranDataDef f2py_%s_def[] = {' % (name))
  79. idims = []
  80. for n in inames:
  81. ct = capi_maps.getctype(vars[n])
  82. at = capi_maps.c2capi_map[ct]
  83. dm = capi_maps.getarrdims(n, vars[n])
  84. if dm['dims']:
  85. idims.append('(%s)' % (dm['dims']))
  86. else:
  87. idims.append('')
  88. dms = dm['dims'].strip()
  89. if not dms:
  90. dms = '-1'
  91. cadd('\t{\"%s\",%s,{{%s}},%s},' % (n, dm['rank'], dms, at))
  92. cadd('\t{NULL}\n};')
  93. inames1 = rmbadname(inames)
  94. inames1_tps = ','.join(['char *' + s for s in inames1])
  95. cadd('static void f2py_setup_%s(%s) {' % (name, inames1_tps))
  96. cadd('\tint i_f2py=0;')
  97. for n in inames1:
  98. cadd('\tf2py_%s_def[i_f2py++].data = %s;' % (name, n))
  99. cadd('}')
  100. if '_' in lower_name:
  101. F_FUNC = 'F_FUNC_US'
  102. else:
  103. F_FUNC = 'F_FUNC'
  104. cadd('extern void %s(f2pyinit%s,F2PYINIT%s)(void(*)(%s));'
  105. % (F_FUNC, lower_name, name.upper(),
  106. ','.join(['char*'] * len(inames1))))
  107. cadd('static void f2py_init_%s(void) {' % name)
  108. cadd('\t%s(f2pyinit%s,F2PYINIT%s)(f2py_setup_%s);'
  109. % (F_FUNC, lower_name, name.upper(), name))
  110. cadd('}\n')
  111. iadd('\ttmp = PyFortranObject_New(f2py_%s_def,f2py_init_%s);' % (name, name))
  112. iadd('\tF2PyDict_SetItemString(d, \"%s\", tmp);' % name)
  113. iadd('\tPy_DECREF(tmp);')
  114. tname = name.replace('_', '\\_')
  115. dadd('\\subsection{Common block \\texttt{%s}}\n' % (tname))
  116. dadd('\\begin{description}')
  117. for n in inames:
  118. dadd('\\item[]{{}\\verb@%s@{}}' %
  119. (capi_maps.getarrdocsign(n, vars[n])))
  120. if hasnote(vars[n]):
  121. note = vars[n]['note']
  122. if isinstance(note, list):
  123. note = '\n'.join(note)
  124. dadd('--- %s' % (note))
  125. dadd('\\end{description}')
  126. ret['docs'].append(
  127. '"\t/%s/ %s\\n"' % (name, ','.join(map(lambda v, d: v + d, inames, idims))))
  128. ret['commonhooks'] = chooks
  129. ret['initcommonhooks'] = ihooks
  130. ret['latexdoc'] = doc[0]
  131. if len(ret['docs']) <= 1:
  132. ret['docs'] = ''
  133. return ret, fwrap[0]