]>
git.proxmox.com Git - mirror_qemu.git/blob - scripts/qapi2texi.py
4 # This work is licensed under the terms of the GNU LGPL, version 2+.
5 # See the COPYING file in the top-level directory.
6 """This script produces the documentation of a qapi schema in texinfo format"""
13 @deftypefn {type} {{}} {name}
22 @deftp {{{type}}} {name}
30 EXAMPLE_FMT
= """@example
36 def subst_strong(doc
):
37 """Replaces *foo* by @strong{foo}"""
38 return re
.sub(r
'\*([^*\n]+)\*', r
'@emph{\1}', doc
)
42 """Replaces _foo_ by @emph{foo}"""
43 return re
.sub(r
'\b_([^_\n]+)_\b', r
' @emph{\1} ', doc
)
47 """Replaces @var by @code{var}"""
48 return re
.sub(r
'@([\w-]+)', r
'@code{\1}', doc
)
51 def subst_braces(doc
):
52 """Replaces {} with @{ @}"""
53 return doc
.replace('{', '@{').replace('}', '@}')
56 def texi_example(doc
):
58 # TODO: Neglects to escape @ characters.
59 # We should probably escape them in subst_braces(), and rename the
60 # function to subst_special() or subs_texi_special(). If we do that, we
61 # need to delay it until after subst_vars() in texi_format().
62 doc
= subst_braces(doc
).strip('\n')
63 return EXAMPLE_FMT(code
=doc
)
71 - |: generates an @example
72 - =: generates @section
73 - ==: generates @subsection
74 - 1. or 1): generates an @enumerate @item
75 - */-: generates an @itemize list
78 doc
= subst_braces(doc
)
81 doc
= subst_strong(doc
)
84 for line
in doc
.split('\n'):
87 # FIXME: Doing this in a single if / elif chain is
88 # problematic. For instance, a line without markup terminates
89 # a list if it follows a blank line (reaches the final elif),
90 # but a line with some *other* markup, such as a = title
93 # Make sure to update section "Documentation markup" in
94 # docs/qapi-code-gen.txt when fixing this.
95 if line
.startswith('| '):
96 line
= EXAMPLE_FMT(code
=line
[2:])
97 elif line
.startswith('= '):
98 line
= '@section ' + line
[2:]
99 elif line
.startswith('== '):
100 line
= '@subsection ' + line
[3:]
101 elif re
.match(r
'^([0-9]*\.) ', line
):
103 lines
.append('@enumerate')
105 line
= line
[line
.find(' ')+1:]
106 lines
.append('@item')
107 elif re
.match(r
'^[*-] ', line
):
109 lines
.append('@itemize %s' % {'*': '@bullet',
110 '-': '@minus'}[line
[0]])
112 lines
.append('@item')
114 elif lastempty
and inlist
:
115 lines
.append('@end %s\n' % inlist
)
122 lines
.append('@end %s\n' % inlist
)
123 return '\n'.join(lines
)
127 """Format the main documentation body"""
128 return texi_format(str(doc
.body
)) + '\n'
131 def texi_enum_value(value
):
132 """Format a table of members item for an enumeration value"""
133 return '@item @code{%s}\n' % value
.name
136 def texi_member(member
):
137 """Format a table of members item for an object type member"""
138 return '@item @code{%s}%s\n' % (
139 member
.name
, ' (optional)' if member
.optional
else '')
142 def texi_members(doc
, what
, member_func
, show_undocumented
):
143 """Format the table of members"""
145 for section
in doc
.args
.itervalues():
146 if not section
.content
and not show_undocumented
:
147 continue # Undocumented TODO require doc and drop
151 desc
= 'Not documented'
152 items
+= member_func(section
.member
) + texi_format(desc
) + '\n'
155 return '\n@b{%s:}\n@table @asis\n%s@end table\n' % (what
, items
)
158 def texi_sections(doc
):
159 """Format additional sections following arguments"""
161 for section
in doc
.sections
:
162 name
, doc
= (section
.name
, str(section
))
164 if name
.startswith('Example'):
168 # prefer @b over @strong, so txt doesn't translate it to *Foo:*
169 body
+= '\n\n@b{%s:}\n' % name
175 def texi_entity(doc
, what
, member_func
=texi_member
,
176 show_undocumented
=False):
177 return (texi_body(doc
)
178 + texi_members(doc
, what
, member_func
, show_undocumented
)
179 + texi_sections(doc
))
182 class QAPISchemaGenDocVisitor(qapi
.QAPISchemaVisitor
):
187 def visit_begin(self
, schema
):
190 def visit_enum_type(self
, name
, info
, values
, prefix
):
194 self
.out
+= TYPE_FMT(type='Enum',
196 body
=texi_entity(doc
, 'Values',
197 member_func
=texi_enum_value
,
198 show_undocumented
=True))
200 def visit_object_type(self
, name
, info
, base
, members
, variants
):
204 elif variants
._tag
_name
: # TODO unclean member access
210 self
.out
+= TYPE_FMT(type=typ
,
212 body
=texi_entity(doc
, 'Members'))
214 def visit_alternate_type(self
, name
, info
, variants
):
218 self
.out
+= TYPE_FMT(type='Alternate',
220 body
=texi_entity(doc
, 'Members'))
222 def visit_command(self
, name
, info
, arg_type
, ret_type
,
223 gen
, success_response
, boxed
):
227 self
.out
+= MSG_FMT(type='Command',
229 body
=texi_entity(doc
, 'Arguments'))
231 def visit_event(self
, name
, info
, arg_type
, boxed
):
235 self
.out
+= MSG_FMT(type='Event',
237 body
=texi_entity(doc
, 'Arguments'))
239 def symbol(self
, doc
, entity
):
244 def freeform(self
, doc
):
248 self
.out
+= texi_body(doc
) + texi_sections(doc
)
251 def texi_schema(schema
):
252 """Convert QAPI schema documentation to Texinfo"""
253 gen
= QAPISchemaGenDocVisitor()
254 gen
.visit_begin(schema
)
255 for doc
in schema
.docs
:
257 gen
.symbol(doc
, schema
.lookup_entity(doc
.symbol
))
264 """Takes schema argument, prints result to stdout"""
266 print >>sys
.stderr
, "%s: need exactly 1 argument: SCHEMA" % argv
[0]
269 schema
= qapi
.QAPISchema(argv
[1])
270 if not qapi
.doc_required
:
271 print >>sys
.stderr
, ("%s: need pragma 'doc-required' "
272 "to generate documentation" % argv
[0])
273 print texi_schema(schema
)
276 if __name__
== '__main__':