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_enum_value(value):
 130     """Format a table of members item for an enumeration value"""
 131     return '@item @code{%s}\n' % value.name
 132
 133
 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     return '@item @code{%s%s%s}%s%s\n' % (
 138         member.name,
 139         ': ' if typ else '',
 140         typ if typ else '',
 141         ' (optional)' if member.optional else '',
 142         suffix)
 143
 144
 145 def texi_members(doc, what, base, variants, member_func):
 146     """Format the table of members"""
 147     items = ''
 148     for section in doc.args.values():
 149         # TODO Drop fallbacks when undocumented members are outlawed
 150         if section.text:
 151             desc = texi_format(section.text)
 152         elif (variants and variants.tag_member == section.member
 153               and not section.member.type.doc_type()):
 154             values = section.member.type.member_names()
 155             members_text = ', '.join(['@t{"%s"}' % v for v in values])
 156             desc = 'One of ' + members_text + '\n'
 157         else:
 158             desc = 'Not documented\n'
 159         items += member_func(section.member) + desc
 160     if base:
 161         items += '@item The members of @code{%s}\n' % base.doc_type()
 162     if variants:
 163         for v in variants.variants:
 164             when = ' when @code{%s} is @t{"%s"}' % (
 165                 variants.tag_member.name, v.name)
 166             if v.type.is_implicit():
 167                 assert not v.type.base and not v.type.variants
 168                 for m in v.type.local_members:
 169                     items += member_func(m, when)
 170             else:
 171                 items += '@item The members of @code{%s}%s\n' % (
 172                     v.type.doc_type(), when)
 173     if not items:
 174         return ''
 175     return '\n@b{%s:}\n@table @asis\n%s@end table\n' % (what, items)
 176
 177
 178 def texi_sections(doc):
 179     """Format additional sections following arguments"""
 180     body = ''
 181     for section in doc.sections:
 182         if section.name:
 183             # prefer @b over @strong, so txt doesn't translate it to *Foo:*
 184             body += '\n@b{%s:}\n' % section.name
 185         if section.name and section.name.startswith('Example'):
 186             body += texi_example(section.text)
 187         else:
 188             body += texi_format(section.text)
 189     return body
 190
 191
 192 def texi_entity(doc, what, base=None, variants=None,
 193                 member_func=texi_member):
 194     return (texi_body(doc)
 195             + texi_members(doc, what, base, variants, member_func)
 196             + texi_sections(doc))
 197
 198
 199 class QAPISchemaGenDocVisitor(qapi.common.QAPISchemaVisitor):
 200     def __init__(self):
 201         self.out = None
 202         self.cur_doc = None
 203
 204     def visit_begin(self, schema):
 205         self.out = ''
 206
 207     def visit_enum_type(self, name, info, values, prefix):
 208         doc = self.cur_doc
 209         self.out += TYPE_FMT(type='Enum',
 210                              name=doc.symbol,
 211                              body=texi_entity(doc, 'Values',
 212                                               member_func=texi_enum_value))
 213
 214     def visit_object_type(self, name, info, base, members, variants):
 215         doc = self.cur_doc
 216         if base and base.is_implicit():
 217             base = None
 218         self.out += TYPE_FMT(type='Object',
 219                              name=doc.symbol,
 220                              body=texi_entity(doc, 'Members', base, variants))
 221
 222     def visit_alternate_type(self, name, info, variants):
 223         doc = self.cur_doc
 224         self.out += TYPE_FMT(type='Alternate',
 225                              name=doc.symbol,
 226                              body=texi_entity(doc, 'Members'))
 227
 228     def visit_command(self, name, info, arg_type, ret_type,
 229                       gen, success_response, boxed):
 230         doc = self.cur_doc
 231         if boxed:
 232             body = texi_body(doc)
 233             body += ('\n@b{Arguments:} the members of @code{%s}\n'
 234                      % arg_type.name)
 235             body += texi_sections(doc)
 236         else:
 237             body = texi_entity(doc, 'Arguments')
 238         self.out += MSG_FMT(type='Command',
 239                             name=doc.symbol,
 240                             body=body)
 241
 242     def visit_event(self, name, info, arg_type, boxed):
 243         doc = self.cur_doc
 244         self.out += MSG_FMT(type='Event',
 245                             name=doc.symbol,
 246                             body=texi_entity(doc, 'Arguments'))
 247
 248     def symbol(self, doc, entity):
 249         if self.out:
 250             self.out += '\n'
 251         self.cur_doc = doc
 252         entity.visit(self)
 253         self.cur_doc = None
 254
 255     def freeform(self, doc):
 256         assert not doc.args
 257         if self.out:
 258             self.out += '\n'
 259         self.out += texi_body(doc) + texi_sections(doc)
 260
 261
 262 def texi_schema(schema):
 263     """Convert QAPI schema documentation to Texinfo"""
 264     gen = QAPISchemaGenDocVisitor()
 265     gen.visit_begin(schema)
 266     for doc in schema.docs:
 267         if doc.symbol:
 268             gen.symbol(doc, schema.lookup_entity(doc.symbol))
 269         else:
 270             gen.freeform(doc)
 271     return gen.out
 272
 273
 274 def gen_doc(schema, output_dir, prefix):
 275     if qapi.common.doc_required:
 276         gen = qapi.common.QAPIGenDoc()
 277         gen.add(texi_schema(schema))
 278         gen.write(output_dir, prefix + 'qapi-doc.texi')