scripts/qapi/doc.py

   1 #!/usr/bin/env python
   2 # QAPI texi generator
   3 #
   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"""
   7
   8 from __future__ import print_function
   9 import re
  10 import qapi.common
  11
  12 MSG_FMT = """
  13 @deftypefn {type} {{}} {name}
  14
  15 {body}
  16 @end deftypefn
  17
  18 """.format
  19
  20 TYPE_FMT = """
  21 @deftp {{{type}}} {name}
  22
  23 {body}
  24 @end deftp
  25
  26 """.format
  27
  28 EXAMPLE_FMT = """@example
  29 {code}
  30 @end example
  31 """.format
  32
  33
  34 def subst_strong(doc):
  35     """Replaces *foo* by @strong{foo}"""
  36     return re.sub(r'\*([^*\n]+)\*', r'@strong{\1}', doc)
  37
  38
  39 def subst_emph(doc):
  40     """Replaces _foo_ by @emph{foo}"""
  41     return re.sub(r'\b_([^_\n]+)_\b', r'@emph{\1}', doc)
  42
  43
  44 def subst_vars(doc):
  45     """Replaces @var by @code{var}"""
  46     return re.sub(r'@([\w-]+)', r'@code{\1}', doc)
  47
  48
  49 def subst_braces(doc):
  50     """Replaces {} with @{ @}"""
  51     return doc.replace('{', '@{').replace('}', '@}')
  52
  53
  54 def texi_example(doc):
  55     """Format @example"""
  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)
  62
  63
  64 def texi_format(doc):
  65     """
  66     Format documentation
  67
  68     Lines starting with:
  69     - |: generates an @example
  70     - =: generates @section
  71     - ==: generates @subsection
  72     - 1. or 1): generates an @enumerate @item
  73     - */-: generates an @itemize list
  74     """
  75     ret = ''
  76     doc = subst_braces(doc)
  77     doc = subst_vars(doc)
  78     doc = subst_emph(doc)
  79     doc = subst_strong(doc)
  80     inlist = ''
  81     lastempty = False
  82     for line in doc.split('\n'):
  83         empty = line == ''
  84
  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
  89         # doesn't.
  90         #
  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):
 100             if not inlist:
 101                 ret += '@enumerate\n'
 102                 inlist = 'enumerate'
 103             ret += '@item\n'
 104             line = line[line.find(' ')+1:]
 105         elif re.match(r'^[*-] ', line):
 106             if not inlist:
 107                 ret += '@itemize %s\n' % {'*': '@bullet',
 108                                           '-': '@minus'}[line[0]]
 109                 inlist = 'itemize'
 110             ret += '@item\n'
 111             line = line[2:]
 112         elif lastempty and inlist:
 113             ret += '@end %s\n\n' % inlist
 114             inlist = ''
 115
 116         lastempty = empty
 117         ret += line + '\n'
 118
 119     if inlist:
 120         ret += '@end %s\n\n' % inlist
 121     return ret
 122
 123
 124 def texi_body(doc):
 125     """Format the main documentation body"""
 126     return texi_format(doc.body.text)
 127
 128
 129 def texi_if(ifcond, prefix='\n', suffix='\n'):
 130     """Format the #if condition"""
 131     if not ifcond:
 132         return ''
 133     return '%s@b{If:} @code{%s}%s' % (prefix, ', '.join(ifcond), suffix)
 134
 135
 136 def texi_enum_value(value, desc, suffix):
 137     """Format a table of members item for an enumeration value"""
 138     return '@item @code{%s}\n%s%s' % (
 139         value.name, desc, texi_if(value.ifcond, prefix='@*'))
 140
 141
 142 def texi_member(member, desc, suffix):
 143     """Format a table of members item for an object type member"""
 144     typ = member.type.doc_type()
 145     membertype = ': ' + typ if typ else ''
 146     return '@item @code{%s%s}%s%s\n%s%s' % (
 147         member.name, membertype,
 148         ' (optional)' if member.optional else '',
 149         suffix, desc, texi_if(member.ifcond, prefix='@*'))
 150
 151
 152 def texi_members(doc, what, base, variants, member_func):
 153     """Format the table of members"""
 154     items = ''
 155     for section in doc.args.values():
 156         # TODO Drop fallbacks when undocumented members are outlawed
 157         if section.text:
 158             desc = texi_format(section.text)
 159         elif (variants and variants.tag_member == section.member
 160               and not section.member.type.doc_type()):
 161             values = section.member.type.member_names()
 162             members_text = ', '.join(['@t{"%s"}' % v for v in values])
 163             desc = 'One of ' + members_text + '\n'
 164         else:
 165             desc = 'Not documented\n'
 166         items += member_func(section.member, desc, suffix='')
 167     if base:
 168         items += '@item The members of @code{%s}\n' % base.doc_type()
 169     if variants:
 170         for v in variants.variants:
 171             when = ' when @code{%s} is @t{"%s"}%s' % (
 172                 variants.tag_member.name, v.name, texi_if(v.ifcond, " (", ")"))
 173             if v.type.is_implicit():
 174                 assert not v.type.base and not v.type.variants
 175                 for m in v.type.local_members:
 176                     items += member_func(m, desc='', suffix=when)
 177             else:
 178                 items += '@item The members of @code{%s}%s\n' % (
 179                     v.type.doc_type(), when)
 180     if not items:
 181         return ''
 182     return '\n@b{%s:}\n@table @asis\n%s@end table\n' % (what, items)
 183
 184
 185 def texi_features(doc):
 186     """Format the table of features"""
 187     items = ''
 188     for section in doc.features.values():
 189         desc = texi_format(section.text)
 190         items += '@item @code{%s}\n%s' % (section.name, desc)
 191     if not items:
 192         return ''
 193     return '\n@b{Features:}\n@table @asis\n%s@end table\n' % (items)
 194
 195
 196 def texi_sections(doc, ifcond):
 197     """Format additional sections following arguments"""
 198     body = ''
 199     for section in doc.sections:
 200         if section.name:
 201             # prefer @b over @strong, so txt doesn't translate it to *Foo:*
 202             body += '\n@b{%s:}\n' % section.name
 203         if section.name and section.name.startswith('Example'):
 204             body += texi_example(section.text)
 205         else:
 206             body += texi_format(section.text)
 207     body += texi_if(ifcond, suffix='')
 208     return body
 209
 210
 211 def texi_entity(doc, what, ifcond, base=None, variants=None,
 212                 member_func=texi_member):
 213     return (texi_body(doc)
 214             + texi_members(doc, what, base, variants, member_func)
 215             + texi_features(doc)
 216             + texi_sections(doc, ifcond))
 217
 218
 219 class QAPISchemaGenDocVisitor(qapi.common.QAPISchemaVisitor):
 220     def __init__(self, prefix):
 221         self._prefix = prefix
 222         self._gen = qapi.common.QAPIGenDoc(self._prefix + 'qapi-doc.texi')
 223         self.cur_doc = None
 224
 225     def write(self, output_dir):
 226         self._gen.write(output_dir)
 227
 228     def visit_enum_type(self, name, info, ifcond, members, prefix):
 229         doc = self.cur_doc
 230         self._gen.add(TYPE_FMT(type='Enum',
 231                                name=doc.symbol,
 232                                body=texi_entity(doc, 'Values', ifcond,
 233                                                 member_func=texi_enum_value)))
 234
 235     def visit_object_type(self, name, info, ifcond, base, members, variants,
 236                           features):
 237         doc = self.cur_doc
 238         if base and base.is_implicit():
 239             base = None
 240         self._gen.add(TYPE_FMT(type='Object',
 241                                name=doc.symbol,
 242                                body=texi_entity(doc, 'Members', ifcond,
 243                                                 base, variants)))
 244
 245     def visit_alternate_type(self, name, info, ifcond, variants):
 246         doc = self.cur_doc
 247         self._gen.add(TYPE_FMT(type='Alternate',
 248                                name=doc.symbol,
 249                                body=texi_entity(doc, 'Members', ifcond)))
 250
 251     def visit_command(self, name, info, ifcond, arg_type, ret_type, gen,
 252                       success_response, boxed, allow_oob, allow_preconfig):
 253         doc = self.cur_doc
 254         if boxed:
 255             body = texi_body(doc)
 256             body += ('\n@b{Arguments:} the members of @code{%s}\n'
 257                      % arg_type.name)
 258             body += texi_sections(doc, ifcond)
 259         else:
 260             body = texi_entity(doc, 'Arguments', ifcond)
 261         self._gen.add(MSG_FMT(type='Command',
 262                               name=doc.symbol,
 263                               body=body))
 264
 265     def visit_event(self, name, info, ifcond, arg_type, boxed):
 266         doc = self.cur_doc
 267         self._gen.add(MSG_FMT(type='Event',
 268                               name=doc.symbol,
 269                               body=texi_entity(doc, 'Arguments', ifcond)))
 270
 271     def symbol(self, doc, entity):
 272         if self._gen._body:
 273             self._gen.add('\n')
 274         self.cur_doc = doc
 275         entity.visit(self)
 276         self.cur_doc = None
 277
 278     def freeform(self, doc):
 279         assert not doc.args
 280         if self._gen._body:
 281             self._gen.add('\n')
 282         self._gen.add(texi_body(doc) + texi_sections(doc, None))
 283
 284
 285 def gen_doc(schema, output_dir, prefix):
 286     if not qapi.common.doc_required:
 287         return
 288     vis = QAPISchemaGenDocVisitor(prefix)
 289     vis.visit_begin(schema)
 290     for doc in schema.docs:
 291         if doc.symbol:
 292             vis.symbol(doc, schema.lookup_entity(doc.symbol))
 293         else:
 294             vis.freeform(doc)
 295     vis.write(output_dir)