def format_docstring(el, refs, indent=' * ', brackets=None, maxwidth=80):
docstring_el = None
for x in el.childNodes:
if x.namespaceURI == NS_TP and x.localName == 'docstring':
docstring_el = x
if not docstring_el:
return ''
lines = []
# escape backslashes, so they won't be interpreted starting doxygen commands and we can later
# insert doxygen commands we actually want
def escape_slashes(x):
if x.nodeType == x.TEXT_NODE:
x.data = x.data.replace('\\', '\\\\')
elif x.nodeType == x.ELEMENT_NODE:
for y in x.childNodes:
escape_slashes(y)
else:
return
escape_slashes(docstring_el)
doc = docstring_el.ownerDocument
for n in docstring_el.getElementsByTagNameNS(NS_TP, 'rationale'):
nested = n.getElementsByTagNameNS(NS_TP, 'rationale')
if nested:
raise Xzibit(n, nested[0])
div = doc.createElement('div')
div.setAttribute('class', 'rationale')
for rationale_body in n.childNodes:
div.appendChild(rationale_body.cloneNode(True))
n.parentNode.replaceChild(div, n)
if docstring_el.getAttribute('xmlns') == 'http://www.w3.org/1999/xhtml':
for ref in docstring_el.getElementsByTagNameNS(NS_TP, 'member-ref') + docstring_el.getElementsByTagNameNS(NS_TP, 'dbus-ref'):
nested = ref.getElementsByTagNameNS(NS_TP, 'member-ref') + ref.getElementsByTagNameNS(NS_TP, 'dbus-ref')
if nested:
raise Xzibit(n, nested[0])
text = doc.createTextNode(' \\endhtmlonly ')
text.data += refs.process(ref)
text.data += ' \\htmlonly '
ref.parentNode.replaceChild(text, ref)
splitted = ''.join([el.toxml() for el in docstring_el.childNodes]).strip(' ').strip('\n').split('\n')
level = min([not match and maxint or match.end() - 1 for match in [re.match('^ *[^ ]', line) for line in splitted]])
assert level != maxint
lines = ['\\htmlonly'] + [line[level:] for line in splitted] + ['\\endhtmlonly']
else:
content = xml_escape(get_descendant_text(docstring_el).replace('\n', ' ').strip())
while content.find(' ') != -1:
content = content.replace(' ', ' ')
left = maxwidth - len(indent) - 1
line = ''
while content:
step = (content.find(' ') + 1) or len(content)
if step > left:
lines.append(line)
line = ''
left = maxwidth - len(indent) - 1
left = left - step
line = line + content[:step]
content = content[step:]
if line:
lines.append(line)
output = []
if lines:
if brackets:
output.append(brackets[0])
else:
output.append(indent)
output.append('\n')
for line in lines:
output.append(indent)
output.append(line)
output.append('\n')
if lines and brackets:
output.append(brackets[1])
output.append('\n')
return ''.join(output)
def format_docstring(el, indent=' * ', brackets=None, maxwidth=80):
docstring_el = None
for x in el.childNodes:
if x.namespaceURI == NS_TP and x.localName == 'docstring':
docstring_el = x
if not docstring_el:
return ''
lines = []
if docstring_el.getAttribute('xmlns') == 'http://www.w3.org/1999/xhtml':
splitted = ''.join([el.toxml() for el in docstring_el.childNodes
]).strip(' ').strip('\n').split('\n')
level = min([
not match and maxsize or match.end() - 1
for match in [re.match('^ *[^ ]', line) for line in splitted]
])
assert level != maxsize
lines = [line[level:].replace('\\', '\\\\') for line in splitted]
else:
content = xml_escape(
get_descendant_text(docstring_el).replace('\n', ' ').strip())
while content.find(' ') != -1:
content = content.replace(' ', ' ')
left = maxwidth - len(indent) - 1
line = ''
while content:
step = (content.find(' ') + 1) or len(content)
if step > left:
lines.append(line)
line = ''
left = maxwidth - len(indent) - 1
left = left - step
line = line + content[:step]
content = content[step:]
if line:
lines.append(line.replace('\\', '\\\\'))
output = []
if lines:
if brackets:
output.append(brackets[0])
else:
output.append(indent)
output.append('\n')
for line in lines:
output.append(indent)
output.append(line)
output.append('\n')
if lines and brackets:
output.append(brackets[1])
output.append('\n')
return ''.join(output)
def format_docstring(el, indent=' * ', brackets=None, maxwidth=80):
docstring_el = None
for x in el.childNodes:
if x.namespaceURI == NS_TP and x.localName == 'docstring':
docstring_el = x
if not docstring_el:
return ''
lines = []
if docstring_el.getAttribute('xmlns') == 'http://www.w3.org/1999/xhtml':
splitted = ''.join([el.toxml() for el in docstring_el.childNodes]).strip(' ').strip('\n').split('\n')
level = min([not match and maxint or match.end() - 1 for match in [re.match('^ *[^ ]', line) for line in splitted]])
assert level != maxint
lines = [line[level:].replace('\\', '\\\\') for line in splitted]
else:
content = xml_escape(get_descendant_text(docstring_el).replace('\n', ' ').strip())
while content.find(' ') != -1:
content = content.replace(' ', ' ')
left = maxwidth - len(indent) - 1
line = ''
while content:
step = (content.find(' ') + 1) or len(content)
if step > left:
lines.append(line)
line = ''
left = maxwidth - len(indent) - 1
left = left - step
line = line + content[:step]
content = content[step:]
if line:
lines.append(line.replace('\\', '\\\\'))
output = []
if lines:
if brackets:
output.append(brackets[0])
else:
output.append(indent)
output.append('\n')
for line in lines:
output.append(indent)
output.append(line)
output.append('\n')
if lines and brackets:
output.append(brackets[1])
output.append('\n')
return ''.join(output)
