common_rules.py 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. """
  2. Build common block mechanism for f2py2e.
  3. Copyright 1999 -- 2011 Pearu Peterson all rights reserved.
  4. Copyright 2011 -- present NumPy Developers.
  5. Permission to use, modify, and distribute this software is given under the
  6. terms of the NumPy License
  7. NO WARRANTY IS EXPRESSED OR IMPLIED. USE AT YOUR OWN RISK.
  8. """
  9. from . import __version__
  10. f2py_version = __version__.version
  11. from .auxfuncs import (
  12. hasbody, hascommon, hasnote, isintent_hide, outmess, getuseblocks
  13. )
  14. from . import capi_maps
  15. from . import func2subr
  16. from .crackfortran import rmbadname
  17. def findcommonblocks(block, top=1):
  18. ret = []
  19. if hascommon(block):
  20. for key, value in block['common'].items():
  21. vars_ = {v: block['vars'][v] for v in value}
  22. ret.append((key, value, vars_))
  23. elif hasbody(block):
  24. for b in block['body']:
  25. ret = ret + findcommonblocks(b, 0)
  26. if top:
  27. tret = []
  28. names = []
  29. for t in ret:
  30. if t[0] not in names:
  31. names.append(t[0])
  32. tret.append(t)
  33. return tret
  34. return ret
  35. def buildhooks(m):
  36. ret = {'commonhooks': [], 'initcommonhooks': [],
  37. 'docs': ['"COMMON blocks:\\n"']}
  38. fwrap = ['']
  39. def fadd(line, s=fwrap):
  40. s[0] = '%s\n %s' % (s[0], line)
  41. chooks = ['']
  42. def cadd(line, s=chooks):
  43. s[0] = '%s\n%s' % (s[0], line)
  44. ihooks = ['']
  45. def iadd(line, s=ihooks):
  46. s[0] = '%s\n%s' % (s[0], line)
  47. doc = ['']
  48. def dadd(line, s=doc):
  49. s[0] = '%s\n%s' % (s[0], line)
  50. for (name, vnames, vars) in findcommonblocks(m):
  51. lower_name = name.lower()
  52. hnames, inames = [], []
  53. for n in vnames:
  54. if isintent_hide(vars[n]):
  55. hnames.append(n)
  56. else:
  57. inames.append(n)
  58. if hnames:
  59. outmess('\t\tConstructing COMMON block support for "%s"...\n\t\t %s\n\t\t Hidden: %s\n' % (
  60. name, ','.join(inames), ','.join(hnames)))
  61. else:
  62. outmess('\t\tConstructing COMMON block support for "%s"...\n\t\t %s\n' % (
  63. name, ','.join(inames)))
  64. fadd('subroutine f2pyinit%s(setupfunc)' % name)
  65. for usename in getuseblocks(m):
  66. fadd(f'use {usename}')
  67. fadd('external setupfunc')
  68. for n in vnames:
  69. fadd(func2subr.var2fixfortran(vars, n))
  70. if name == '_BLNK_':
  71. fadd('common %s' % (','.join(vnames)))
  72. else:
  73. fadd('common /%s/ %s' % (name, ','.join(vnames)))
  74. fadd('call setupfunc(%s)' % (','.join(inames)))
  75. fadd('end\n')
  76. cadd('static FortranDataDef f2py_%s_def[] = {' % (name))
  77. idims = []
  78. for n in inames:
  79. ct = capi_maps.getctype(vars[n])
  80. elsize = capi_maps.get_elsize(vars[n])
  81. at = capi_maps.c2capi_map[ct]
  82. dm = capi_maps.getarrdims(n, vars[n])
  83. if dm['dims']:
  84. idims.append('(%s)' % (dm['dims']))
  85. else:
  86. idims.append('')
  87. dms = dm['dims'].strip()
  88. if not dms:
  89. dms = '-1'
  90. cadd('\t{\"%s\",%s,{{%s}},%s, %s},'
  91. % (n, dm['rank'], dms, at, elsize))
  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('\tif (tmp == NULL) return NULL;')
  113. iadd('\tif (F2PyDict_SetItemString(d, \"%s\", tmp) == -1) return NULL;'
  114. % name)
  115. iadd('\tPy_DECREF(tmp);')
  116. tname = name.replace('_', '\\_')
  117. dadd('\\subsection{Common block \\texttt{%s}}\n' % (tname))
  118. dadd('\\begin{description}')
  119. for n in inames:
  120. dadd('\\item[]{{}\\verb@%s@{}}' %
  121. (capi_maps.getarrdocsign(n, vars[n])))
  122. if hasnote(vars[n]):
  123. note = vars[n]['note']
  124. if isinstance(note, list):
  125. note = '\n'.join(note)
  126. dadd('--- %s' % (note))
  127. dadd('\\end{description}')
  128. ret['docs'].append(
  129. '"\t/%s/ %s\\n"' % (name, ','.join(map(lambda v, d: v + d, inames, idims))))
  130. ret['commonhooks'] = chooks
  131. ret['initcommonhooks'] = ihooks
  132. ret['latexdoc'] = doc[0]
  133. if len(ret['docs']) <= 1:
  134. ret['docs'] = ''
  135. return ret, fwrap[0]