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"""
8 from __future__
import print_function
13 @deftypefn {type} {{}} {name}
21 @deftp {{{type}}} {name}
28 EXAMPLE_FMT
= """@example
34 def subst_strong(doc
):
35 """Replaces *foo* by @strong{foo}"""
36 return re
.sub(r
'\*([^*\n]+)\*', r
'@strong{\1}', doc
)
40 """Replaces _foo_ by @emph{foo}"""
41 return re
.sub(r
'\b_([^_\n]+)_\b', r
'@emph{\1}', doc
)
45 """Replaces @var by @code{var}"""
46 return re
.sub(r
'@([\w-]+)', r
'@code{\1}', doc
)
49 def subst_braces(doc
):
50 """Replaces {} with @{ @}"""
51 return doc
.replace('{', '@{').replace('}', '@}')
54 def texi_example(doc
):
56 # TODO: Neglects to escape @ characters.
57 # We should probably escape them in subst_braces(), and rename the
58 # function to subst_special() or subs_texi_special(). If we do that, we
59 # need to delay it until after subst_vars() in texi_format().
60 doc
= subst_braces(doc
).strip('\n')
61 return EXAMPLE_FMT(code
=doc
)
69 - |: generates an @example
70 - =: generates @section
71 - ==: generates @subsection
72 - 1. or 1): generates an @enumerate @item
73 - */-: generates an @itemize list
76 doc
= subst_braces(doc
)
79 doc
= subst_strong(doc
)
82 for line
in doc
.split('\n'):
85 # FIXME: Doing this in a single if / elif chain is
86 # problematic. For instance, a line without markup terminates
87 # a list if it follows a blank line (reaches the final elif),
88 # but a line with some *other* markup, such as a = title
91 # Make sure to update section "Documentation markup" in
92 # docs/devel/qapi-code-gen.txt when fixing this.
93 if line
.startswith('| '):
94 line
= EXAMPLE_FMT(code
=line
[2:])
95 elif line
.startswith('= '):
96 line
= '@section ' + line
[2:]
97 elif line
.startswith('== '):
98 line
= '@subsection ' + line
[3:]
99 elif re
.match(r
'^([0-9]*\.) ', line
):
101 ret
+= '@enumerate\n'
104 line
= line
[line
.find(' ')+1:]
105 elif re
.match(r
'^[*-] ', line
):
107 ret
+= '@itemize %s\n' % {'*': '@bullet',
108 '-': '@minus'}[line
[0]]
112 elif lastempty
and inlist
:
113 ret
+= '@end %s\n\n' % inlist
120 ret
+= '@end %s\n\n' % inlist
125 """Format the main documentation body"""
126 return texi_format(doc
.body
.text
)
129 def texi_enum_value(value
):
130 """Format a table of members item for an enumeration value"""
131 return '@item @code{%s}\n' % value
.name
134 def texi_member(member
, suffix
=''):
135 """Format a table of members item for an object type member"""
136 typ
= member
.type.doc_type()
137 membertype
= ': ' + typ
if typ
else ''
138 return '@item @code{%s%s}%s%s\n' % (
139 member
.name
, membertype
,
140 ' (optional)' if member
.optional
else '',
144 def texi_members(doc
, what
, base
, variants
, member_func
):
145 """Format the table of members"""
147 for section
in doc
.args
.values():
148 # TODO Drop fallbacks when undocumented members are outlawed
150 desc
= texi_format(section
.text
)
151 elif (variants
and variants
.tag_member
== section
.member
152 and not section
.member
.type.doc_type()):
153 values
= section
.member
.type.member_names()
154 members_text
= ', '.join(['@t{"%s"}' % v
for v
in values
])
155 desc
= 'One of ' + members_text
+ '\n'
157 desc
= 'Not documented\n'
158 items
+= member_func(section
.member
) + desc
160 items
+= '@item The members of @code{%s}\n' % base
.doc_type()
162 for v
in variants
.variants
:
163 when
= ' when @code{%s} is @t{"%s"}' % (
164 variants
.tag_member
.name
, v
.name
)
165 if v
.type.is_implicit():
166 assert not v
.type.base
and not v
.type.variants
167 for m
in v
.type.local_members
:
168 items
+= member_func(m
, when
)
170 items
+= '@item The members of @code{%s}%s\n' % (
171 v
.type.doc_type(), when
)
174 return '\n@b{%s:}\n@table @asis\n%s@end table\n' % (what
, items
)
177 def texi_sections(doc
):
178 """Format additional sections following arguments"""
180 for section
in doc
.sections
:
182 # prefer @b over @strong, so txt doesn't translate it to *Foo:*
183 body
+= '\n@b{%s:}\n' % section
.name
184 if section
.name
and section
.name
.startswith('Example'):
185 body
+= texi_example(section
.text
)
187 body
+= texi_format(section
.text
)
191 def texi_entity(doc
, what
, base
=None, variants
=None,
192 member_func
=texi_member
):
193 return (texi_body(doc
)
194 + texi_members(doc
, what
, base
, variants
, member_func
)
195 + texi_sections(doc
))
198 class QAPISchemaGenDocVisitor(qapi
.common
.QAPISchemaVisitor
):
199 def __init__(self
, prefix
):
200 self
._prefix
= prefix
201 self
._gen
= qapi
.common
.QAPIGenDoc()
204 def write(self
, output_dir
):
205 self
._gen
.write(output_dir
, self
._prefix
+ 'qapi-doc.texi')
207 def visit_enum_type(self
, name
, info
, values
, prefix
):
209 self
._gen
.add(TYPE_FMT(type='Enum',
211 body
=texi_entity(doc
, 'Values',
212 member_func
=texi_enum_value
)))
214 def visit_object_type(self
, name
, info
, base
, members
, variants
):
216 if base
and base
.is_implicit():
218 self
._gen
.add(TYPE_FMT(type='Object',
220 body
=texi_entity(doc
, 'Members',
223 def visit_alternate_type(self
, name
, info
, variants
):
225 self
._gen
.add(TYPE_FMT(type='Alternate',
227 body
=texi_entity(doc
, 'Members')))
229 def visit_command(self
, name
, info
, arg_type
, ret_type
,
230 gen
, success_response
, boxed
, allow_oob
):
233 body
= texi_body(doc
)
234 body
+= ('\n@b{Arguments:} the members of @code{%s}\n'
236 body
+= texi_sections(doc
)
238 body
= texi_entity(doc
, 'Arguments')
239 self
._gen
.add(MSG_FMT(type='Command',
243 def visit_event(self
, name
, info
, arg_type
, boxed
):
245 self
._gen
.add(MSG_FMT(type='Event',
247 body
=texi_entity(doc
, 'Arguments')))
249 def symbol(self
, doc
, entity
):
256 def freeform(self
, doc
):
260 self
._gen
.add(texi_body(doc
) + texi_sections(doc
))
263 def gen_doc(schema
, output_dir
, prefix
):
264 if not qapi
.common
.doc_required
:
266 vis
= QAPISchemaGenDocVisitor(prefix
)
267 vis
.visit_begin(schema
)
268 for doc
in schema
.docs
:
270 vis
.symbol(doc
, schema
.lookup_entity(doc
.symbol
))
273 vis
.write(output_dir
)