output will be written (the file will be clobbered).
"""
-######################################################################
+#
#
# This code is implemented using Mark Pilgrim's code as a guideline:
# http://www.faqs.org/docs/diveintopython/kgp_divein.html
# Bill Spotz: bug reports and testing.
# Sebastian Henschel: Misc. enhancements.
#
-######################################################################
+#
from xml.dom import minidom
import re
else:
return open(source)
+
def my_open_write(dest):
if hasattr(dest, "write"):
return dest
return open(dest, 'w')
-class Doxy2SWIG:
+class Doxy2SWIG:
+
"""Converts Doxygen generated XML files into a file containing
docstrings that can be used by SWIG-1.3.x that have support for
feature("docstring"). Once the data is parsed it is stored in
self.pieces.
- """
-
+ """
+
def __init__(self, src, include_function_definition=True, quiet=False):
"""Initialize the instance given a source object. `src` can
be a file or filename. If you do not want to include function
f.close()
self.pieces = []
- self.pieces.append('\n// File: %s\n'%\
+ self.pieces.append('\n// File: %s\n' %
os.path.basename(f.name))
self.space_re = re.compile(r'\s+')
self.ignores.append('argsstring')
self.quiet = quiet
-
-
+
def generate(self):
"""Parses the file set in the initialization. The resulting
data is stored in `self.pieces`.
"""
self.parse(self.xmldoc)
-
+
def parse(self, node):
"""Parse a given node. This function in turn calls the
`parse_<nodeType>` functions which handle the respective
nodes.
"""
- pm = getattr(self, "parse_%s"%node.__class__.__name__)
+ pm = getattr(self, "parse_%s" % node.__class__.__name__)
pm(node)
def parse_Document(self, node):
`do_<tagName>` handers for different elements. If no handler
is available the `generic_parse` method is called. All
tagNames specified in `self.ignores` are simply ignored.
-
+
"""
name = node.tagName
ignores = self.ignores
`ELEMENT_NODEs`, that have a `tagName` equal to the name.
"""
- nodes = [(x.tagName, x) for x in node.childNodes \
- if x.nodeType == x.ELEMENT_NODE and \
+ nodes = [(x.tagName, x) for x in node.childNodes
+ if x.nodeType == x.ELEMENT_NODE and
x.tagName in names]
return dict(nodes)
if pad:
npiece = len(self.pieces)
if pad == 2:
- self.add_text('\n')
+ self.add_text('\n')
for n in node.childNodes:
self.parse(n)
if pad:
def do_compoundname(self, node):
self.add_text('\n\n')
data = node.firstChild.data
- self.add_text('%%feature("docstring") %s "\n'%data)
+ self.add_text('%%feature("docstring") %s "\n' % data)
def do_compounddef(self, node):
kind = node.attributes['kind'].value
for n in names:
if first.has_key(n):
self.parse(first[n])
- self.add_text(['";','\n'])
+ self.add_text(['";', '\n'])
for n in node.childNodes:
if n not in first.values():
self.parse(n)
self.generic_parse(node, pad=1)
def do_parameterlist(self, node):
- text='unknown'
+ text = 'unknown'
for key, val in node.attributes.items():
if key == 'kind':
- if val == 'param': text = 'Parameters'
- elif val == 'exception': text = 'Exceptions'
- elif val == 'retval': text = 'Returns'
- else: text = val
+ if val == 'param':
+ text = 'Parameters'
+ elif val == 'exception':
+ text = 'Exceptions'
+ elif val == 'retval':
+ text = 'Returns'
+ else:
+ text = val
break
self.add_text(['\n', '\n', text, ':', '\n'])
self.generic_parse(node, pad=1)
def do_parametername(self, node):
self.add_text('\n')
try:
- data=node.firstChild.data
- except AttributeError: # perhaps a <ref> tag in it
- data=node.firstChild.firstChild.data
+ data = node.firstChild.data
+ except AttributeError: # perhaps a <ref> tag in it
+ data = node.firstChild.firstChild.data
if data.find('Exception') != -1:
self.add_text(data)
else:
- self.add_text("%s: "%data)
+ self.add_text("%s: " % data)
def do_parameterdefinition(self, node):
self.generic_parse(node, pad=1)
tmp = node.parentNode.parentNode.parentNode
compdef = tmp.getElementsByTagName('compounddef')[0]
cdef_kind = compdef.attributes['kind'].value
-
+
if prot == 'public':
first = self.get_specific_nodes(node, ('definition', 'name'))
name = first['name'].firstChild.data
- if name[:8] == 'operator': # Don't handle operators yet.
+ if name[:8] == 'operator': # Don't handle operators yet.
return
if not 'definition' in first or \
defn = ""
self.add_text('\n')
self.add_text('%feature("docstring") ')
-
+
anc = node.parentNode.parentNode
if cdef_kind in ('file', 'namespace'):
ns_node = anc.getElementsByTagName('innernamespace')
ns_node = anc.getElementsByTagName('compoundname')
if ns_node:
ns = ns_node[0].firstChild.data
- self.add_text(' %s::%s "\n%s'%(ns, name, defn))
+ self.add_text(' %s::%s "\n%s' % (ns, name, defn))
else:
- self.add_text(' %s "\n%s'%(name, defn))
+ self.add_text(' %s "\n%s' % (name, defn))
elif cdef_kind in ('class', 'struct'):
# Get the full function name.
anc_node = anc.getElementsByTagName('compoundname')
cname = anc_node[0].firstChild.data
- self.add_text(' %s::%s "\n%s'%(cname, name, defn))
+ self.add_text(' %s::%s "\n%s' % (cname, name, defn))
for n in node.childNodes:
if n not in first.values():
self.parse(n)
self.add_text(['";', '\n'])
-
+
def do_definition(self, node):
data = node.firstChild.data
- self.add_text('%s "\n%s'%(data, data))
+ self.add_text('%s "\n%s' % (data, data))
def do_sectiondef(self, node):
kind = node.attributes['kind'].value
which should not be printed as such, so we comment it in the
output."""
data = node.firstChild.data
- self.add_text('\n/*\n %s \n*/\n'%data)
+ self.add_text('\n/*\n %s \n*/\n' % data)
# If our immediate sibling is a 'description' node then we
# should comment that out also and remove it from the parent
# node's children.
parent = node.parentNode
idx = parent.childNodes.index(node)
if len(parent.childNodes) >= idx + 2:
- nd = parent.childNodes[idx+2]
+ nd = parent.childNodes[idx + 2]
if nd.nodeName == 'description':
nd = parent.removeChild(nd)
self.add_text('\n/*')
if not os.path.exists(fname):
fname = os.path.join(self.my_dir, fname)
if not self.quiet:
- print( "parsing file: %s"%fname )
+ print("parsing file: %s" % fname)
p = Doxy2SWIG(fname, self.include_function_definition, self.quiet)
p.generate()
self.pieces.extend(self.clean_pieces(p.pieces))
"""Cleans the list of strings given as `pieces`. It replaces
multiple newlines by a maximum of 2 and returns a new list.
It also wraps the paragraphs nicely.
-
+
"""
ret = []
count = 0
elif count > 2:
ret.append('\n\n')
elif count:
- ret.append('\n'*count)
+ ret.append('\n' * count)
count = 0
ret.append(i)
ret = []
for i in _data.split('\n\n'):
if i == 'Parameters:' or i == 'Exceptions:' or i == 'Returns:':
- ret.extend([i, '\n'+'-'*len(i), '\n\n'])
- elif i.find('// File:') > -1: # leave comments alone.
+ ret.extend([i, '\n' + '-' * len(i), '\n\n'])
+ elif i.find('// File:') > -1: # leave comments alone.
ret.extend([i, '\n'])
else:
_tmp = textwrap.fill(i.strip(), break_long_words=False)
p.generate()
p.write(output)
+
def main():
usage = __doc__
parser = optparse.OptionParser(usage)
default=False,
dest='quiet',
help='be quiet and minimize output')
-
+
options, args = parser.parse_args()
if len(args) != 2:
parser.error("error: no input and output specified")
convert(args[0], args[1], not options.func_def, options.quiet)
-
+
if __name__ == '__main__':
main()
git://developer.intra2net.com / libftdi / blobdiff