As the name suggests, the qapi2texi script converts JSON QAPI
description into a standalone texi file suitable for different target
formats.
It parses the following kind of blocks with some little variations:
##
# = Section
# == Subsection
#
# Some text foo with *emphasis*
# 1. with a list
# 2. like that
#
# And some code:
# | $ echo foo
# | <- do this
# | -> get that
#
##
##
# @symbol
#
# Symbol body ditto ergo sum. Foo bar
# baz ding.
#
# @arg: foo
# @arg: #optional foo
#
# Returns: returns bla bla
#
# Or bla blah
#
# Since: version
# Notes: notes, comments can have
# - itemized list
# - like this
#
# and continue...
#
# Example:
#
# <- { "execute": "quit" }
# -> { "return": {} }
#
##
Thanks to the json declaration, it's able to give extra information
about the type of arguments and return value expected.
Signed-off-by: Marc-André Lureau <marcandre.lur...@redhat.com>
---
scripts/qapi.py | 100 +++++++++++++++-
scripts/qapi2texi.py | 314 +++++++++++++++++++++++++++++++++++++++++++++++++
docs/qapi-code-gen.txt | 44 +++++--
3 files changed, 446 insertions(+), 12 deletions(-)
create mode 100755 scripts/qapi2texi.py
diff --git a/scripts/qapi.py b/scripts/qapi.py
index 21bc32f..4efc7e7 100644
--- a/scripts/qapi.py
+++ b/scripts/qapi.py
@@ -122,6 +122,79 @@ class QAPIExprError(Exception):
"%s:%d: %s" % (self.info['file'], self.info['line'], self.msg)
+class QAPIDoc:
+ def __init__(self, comment):
+ self.symbol = None
+ self.comment = "" # the main symbol comment
+ self.args = OrderedDict()
+ # meta is for Since:, Notes:, Examples:, Returns:...
+ self.meta = OrderedDict()
+ # the current section to populate, array of [dict, key, comment...]
+ self.section = None
+
+ for line in comment.split('\n'):
+ # remove multiple spaces
+ sline = ' '.join(line.split())
+ # take the first word out
+ split = sline.split(' ', 1)
+ key = split[0]
+
+ if key.startswith("@"):
+ key = key[1:].rstrip(':')
+ sline = split[1] if len(split) > 1 else ""
+ if self.symbol is None:
+ # the first is the section symbol
+ self.symbol = key
+ else:
+ # else an arg
+ self.start_section(self.args, key)
+ elif self.symbol and \
+ key in ("Returns:",
+ # special case for Since often used without:
+ "Since:", "Since",
+ # those are often singular or plural
+ "Note:", "Notes:",
+ "Example:", "Examples:"):
+ sline = split[1] if len(split) > 1 else ""
+ line = None
+ # new "meta" section
+ self.start_section(self.meta, key.rstrip(':'))
+
+ if self.section and self.section[1].startswith("Example"):
+ # example is verbatim
+ self.append_comment(line)
+ else:
+ self.append_comment(sline)
+
+ self.end_section()
+
+ def append_comment(self, line):
+ """Adds a comment to the current section, or the symbol comment"""
+ if line is None:
+ return
+ if self.section is not None:
+ if self.section[-1] == "" and line == "":
+ self.end_section()
+ else:
+ self.section.append(line)
+ elif self.comment == "":
+ self.comment = line
+ else:
+ self.comment += "\n" + line
+
+ def end_section(self):
+ if self.section is not None:
+ dic = self.section[0]
+ key = self.section[1]
+ doc = "\n".join(self.section[2:])
+ dic[key] = doc
+ self.section = None
+
+ def start_section(self, dic, key):
+ self.end_section()
+ self.section = [dic, key] # .. remaining elems will be the doc
+
+
class QAPISchemaParser(object):
def __init__(self, fp, previously_included=[], incl_info=None):
@@ -137,11 +210,14 @@ class QAPISchemaParser(object):
self.line = 1
self.line_pos = 0
self.exprs = []
+ self.comment = None
+ self.apidoc = incl_info['doc'] if incl_info else []
self.accept()
while self.tok is not None:
expr_info = {'file': fname, 'line': self.line,
- 'parent': self.incl_info}
+ 'parent': self.incl_info, 'doc': self.apidoc}
+ self.apidoc = []
expr = self.get_expr(False)
if isinstance(expr, dict) and "include" in expr:
if len(expr) != 1:
@@ -162,6 +238,8 @@ class QAPISchemaParser(object):
inf = inf['parent']
# skip multiple include of the same file
if incl_abs_fname in previously_included:
+ expr_info['doc'].extend(self.apidoc)
+ self.apidoc = expr_info['doc']
continue
try:
fobj = open(incl_abs_fname, 'r')
@@ -176,6 +254,12 @@ class QAPISchemaParser(object):
'info': expr_info}
self.exprs.append(expr_elem)
+ def append_doc(self):
+ if self.comment:
+ apidoc = QAPIDoc(self.comment)
+ self.apidoc.append(apidoc)
+ self.comment = None
+
def accept(self):
while True:
self.tok = self.src[self.cursor]
@@ -184,8 +268,20 @@ class QAPISchemaParser(object):
self.val = None
if self.tok == '#':
- self.cursor = self.src.find('\n', self.cursor)
+ end = self.src.find('\n', self.cursor)
+ line = self.src[self.cursor:end+1]
+ # start a comment section after ##
+ if line[0] == "#":
+ if self.comment is None:
+ self.comment = ""
+ # skip modeline
+ elif line.find("-*") == -1 and self.comment is not None:
+ self.comment += line
+ if self.src[end] == "\n" and self.src[end+1] == "\n":
+ self.append_doc()
+ self.cursor = end
elif self.tok in "{}:,[]":
+ self.append_doc()
return
elif self.tok == "'":
string = ''
diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py
new file mode 100755
index 0000000..2706b16
--- /dev/null
+++ b/scripts/qapi2texi.py
@@ -0,0 +1,314 @@
+#!/usr/bin/env python
+# QAPI texi generator
+#
+# This work is licensed under the terms of the GNU LGPL, version 2+.
+# See the COPYING file in the top-level directory.
+"""This script produces the documentation of a qapi schema in texinfo format"""
+import re
+import sys
+
+from qapi import QAPISchemaParser, QAPISchemaError, check_exprs, QAPIExprError
+
+COMMAND_FMT = """
+@deftypefn {type} {{{ret}}} {name} @
+{{{args}}}
+
+{body}
+
+@end deftypefn
+
+""".format
+
+ENUM_FMT = """
+@deftp Enum {name}
+
+{body}
+
+@end deftp
+
+""".format
+
+STRUCT_FMT = """
+@deftp {type} {name} @
+{{{attrs}}}
+
+{body}
+
+@end deftp
+
+""".format
+
+EXAMPLE_FMT = """@example
+{code}
+@end example
+""".format
+
+
+def subst_strong(doc):
+ """Replaces *foo* by @strong{foo}"""
+ return re.sub(r'\*(\w+)\*', r'@emph{\1}', doc)
+
+
+def subst_emph(doc):
+ """Replaces _foo_ by @emph{foo}"""
+ return re.sub(r'\s_(\w+)_\s', r' @emph{\1} ', doc)
+
+
+def subst_vars(doc):
+ """Replaces @var by @var{var}"""
+ return re.sub(r'@(\w+)', r'@var{\1}', doc)
+
+
+def subst_braces(doc):
+ """Replaces {} with @{ @}"""
+ return doc.replace("{", "@{").replace("}", "@}")
+
+
+def texi_example(doc):
+ """Format @example"""
+ doc = subst_braces(doc).strip('\n')
+ return EXAMPLE_FMT(code=doc)
+
+
+def texi_comment(doc):
+ """
+ Format a comment
+
+ Lines starting with:
+ - |: generates an @example
+ - =: generates @section
+ - ==: generates @subsection
+ - 1. or 1): generates an @enumerate @item
+ - o/*/-: generates an @itemize list
+ """
+ lines = []
+ doc = subst_braces(doc)
+ doc = subst_vars(doc)
+ doc = subst_emph(doc)
+ doc = subst_strong(doc)
+ inlist = ""
+ lastempty = False
+ for line in doc.split('\n'):
+ empty = line == ""
+
+ if line.startswith("| "):
+ line = EXAMPLE_FMT(code=line[1:])
+ elif line.startswith("= "):
+ line = "@section " + line[1:]
+ elif line.startswith("== "):
+ line = "@subsection " + line[2:]
+ elif re.match("^([0-9]*[.)]) ", line):
+ if not inlist:
+ lines.append("@enumerate")
+ inlist = "enumerate"
+ line = line[line.find(" ")+1:]
+ lines.append("@item")
+ elif re.match("^[o*-] ", line):
+ if not inlist:
+ lines.append("@itemize %s" % {'o': "@bullet",
+ '*': "@minus",
+ '-': ""}[line[0]])
+ inlist = "itemize"
+ lines.append("@item")
+ line = line[2:]
+ elif lastempty and inlist:
+ lines.append("@end %s\n" % inlist)
+ inlist = ""
+
+ lastempty = empty
+ lines.append(line)
+
+ if inlist:
+ lines.append("@end %s\n" % inlist)
+ return "\n".join(lines)
+
+
+def texi_args(expr):
+ """
+ Format the functions/structure/events.. arguments/members
+ """
+ data = expr["data"] if "data" in expr else {}
+ if isinstance(data, str):
+ args = data
+ else:
+ arg_list = []
+ for name, typ in data.iteritems():
+ # optional arg
+ if name.startswith("*"):
+ name = name[1:]
+ arg_list.append("['%s': @var{%s}]" % (name, typ))
+ # regular arg
+ else:
+ arg_list.append("'%s': @var{%s}" % (name, typ))
+ args = ", ".join(arg_list)
+ return args
+
+
+def texi_body(doc, arg="@var"):
+ """
+ Format the body of a symbol documentation:
+ - a table of arguments
+ - followed by "Returns/Notes/Since/Example" sections
+ """
+ body = "@table %s\n" % arg
+ for arg, desc in doc.args.iteritems():
+ if desc.startswith("#optional"):
+ desc = desc[10:]
+ arg += "*"
+ elif desc.endswith("#optional"):
+ desc = desc[:-10]
+ arg += "*"
+ body += "@item %s\n%s\n" % (arg, texi_comment(desc))
+ body += "@end table\n"
+ body += texi_comment(doc.comment)
+
+ for k in ("Returns", "Note", "Notes", "Since", "Example", "Examples"):
+ if k not in doc.meta:
+ continue
+ func = texi_comment
+ if k.startswith("Example"):
+ func = texi_example
+
+ body += "\n@quotation %s\n%s\n@end quotation" % \
+ (k, func(doc.meta[k]))
+ return body
+
+
+def texi_alternate(expr, doc):
+ """
+ Format an alternate to texi
+ """
+ args = texi_args(expr)
+ body = texi_body(doc)
+ return STRUCT_FMT(type="Alternate",
+ name=doc.symbol,
+ attrs="[ " + args + " ]",
+ body=body)
+
+
+def texi_union(expr, doc):
+ """
+ Format an union to texi
+ """
+ args = texi_args(expr)
+ body = texi_body(doc)
+ return STRUCT_FMT(type="Union",
+ name=doc.symbol,
+ attrs="[ " + args + " ]",
+ body=body)
+
+
+def texi_enum(_, doc):
+ """
+ Format an enum to texi
+ """
+ body = texi_body(doc, "@samp")
+ return ENUM_FMT(name=doc.symbol,
+ body=body)
+
+
+def texi_struct(expr, doc):
+ """
+ Format a struct to texi
+ """
+ args = texi_args(expr)
+ body = texi_body(doc)
+ return STRUCT_FMT(type="Struct",
+ name=doc.symbol,
+ attrs="@{ " + args + " @}",
+ body=body)
+
+
+def texi_command(expr, doc):
+ """
+ Format a command to texi
+ """
+ args = texi_args(expr)
+ ret = expr["returns"] if "returns" in expr else ""
+ body = texi_body(doc)
+ return COMMAND_FMT(type="Command",
+ name=doc.symbol,
+ ret=ret,
+ args="(" + args + ")",
+ body=body)
+
+
+def texi_event(expr, doc):
+ """
+ Format an event to texi
+ """
+ args = texi_args(expr)
+ body = texi_body(doc)
+ return COMMAND_FMT(type="Event",
+ name=doc.symbol,
+ ret="",
+ args="(" + args + ")",
+ body=body)
+
+
+def texi(exprs):
+ """
+ Convert QAPI schema expressions to texi documentation
+ """
+ res = []
+ for qapi in exprs:
+ try:
+ docs = qapi['info']['doc']
+ expr = qapi['expr']
+ expr_doc = docs[-1]
+ body = docs[0:-1]
+
+ (kind, _) = expr.items()[0]
+
+ for doc in body:
+ res.append(texi_body(doc))
+
+ fmt = {"command": texi_command,
+ "struct": texi_struct,
+ "enum": texi_enum,
+ "union": texi_union,
+ "alternate": texi_alternate,
+ "event": texi_event}
+ try:
+ fmt = fmt[kind]
+ except KeyError:
+ raise ValueError("Unknown expression kind '%s'" % kind)
+ res.append(fmt(expr, expr_doc))
+ except:
+ print >>sys.stderr, "error at @%s" % qapi
+ raise
+
+ return '\n'.join(res)
+
+
+def parse_schema(fname):
+ """
+ Parse the given schema file and return the exprs
+ """
+ try:
+ schema = QAPISchemaParser(open(fname, "r"))
+ check_exprs(schema.exprs)
+ return schema.exprs
+ except (QAPISchemaError, QAPIExprError), err:
+ print >>sys.stderr, err
+ exit(1)
+
+
+def main(argv):
+ """
+ Takes argv arguments, prints result to stdout
+ """
+ if len(argv) != 4:
+ print >>sys.stderr, "%s: need exactly 3 arguments: " \
+ "TEMPLATE VERSION SCHEMA" % argv[0]
+ sys.exit(1)
+
+ exprs = parse_schema(argv[3])
+
+ templ = open(argv[1])
+ qapi = texi(exprs)
+ print templ.read().format(version=argv[2], qapi=qapi)
+
+
+if __name__ == "__main__":
+ main(sys.argv)
diff --git a/docs/qapi-code-gen.txt b/docs/qapi-code-gen.txt
index 5d4c2cd..e51ae4c 100644
--- a/docs/qapi-code-gen.txt
+++ b/docs/qapi-code-gen.txt
@@ -45,16 +45,13 @@ QAPI parser does not). At present, there is no place where
a QAPI
schema requires the use of JSON numbers or null.
Comments are allowed; anything between an unquoted # and the following
-newline is ignored. Although there is not yet a documentation
-generator, a form of stylized comments has developed for consistently
-documenting details about an expression and when it was added to the
-schema. The documentation is delimited between two lines of ##, then
-the first line names the expression, an optional overview is provided,
-then individual documentation about each member of 'data' is provided,
-and finally, a 'Since: x.y.z' tag lists the release that introduced
-the expression. Optional members are tagged with the phrase
-'#optional', often with their default value; and extensions added
-after the expression was first released are also given a '(since
+newline is ignored. The documentation is delimited between two lines
+of ##, then the first line names the expression, an optional overview
+is provided, then individual documentation about each member of 'data'
+is provided, and finally, a 'Since: x.y.z' tag lists the release that
+introduced the expression. Optional members are tagged with the
+phrase '#optional', often with their default value; and extensions
+added after the expression was first released are also given a '(since
x.y.z)' comment. For example:
##
@@ -73,12 +70,39 @@ x.y.z)' comment. For example:
# (Since 2.0)
#
# Since: 0.14.0
+ #
+ # Notes: You can also make a list:
+ # - with items
+ # - like this
+ #
+ # Example:
+ #
+ # <- { "execute": ... }
+ # -> { "return": ... }
+ #
##
{ 'struct': 'BlockStats',
'data': {'*device': 'str', 'stats': 'BlockDeviceStats',
'*parent': 'BlockStats',
'*backing': 'BlockStats'} }
+It's also possible to create documentation sections, such as:
+
+ ##
+ # = Section
+ # == Subsection
+ #
+ # Some text foo with *emphasis*
+ # 1. with a list
+ # 2. like that
+ #
+ # And some code:
+ # | $ echo foo
+ # | <- do this
+ # | -> get that
+ #
+ ##
+
The schema sets up a series of types, as well as commands and events
that will use those types. Forward references are allowed: the parser
scans in two passes, where the first pass learns all type names, and
--
2.10.0
