Commit e6c42b96 authored by Markus Armbruster's avatar Markus Armbruster
Browse files

qapi: Split up scripts/qapi/common.py 



The QAPI code generator clocks in at some 3100 SLOC in 8 source files.
Almost 60% of the code is in qapi/common.py.  Split it into more
focused modules:

* Move QAPISchemaPragma and QAPISourceInfo to qapi/source.py.

* Move QAPIError and its sub-classes to qapi/error.py.

* Move QAPISchemaParser and QAPIDoc to parser.py.  Use the opportunity
  to put QAPISchemaParser first.

* Move check_expr() & friends to qapi/expr.py.  Use the opportunity to
  put the code into a more sensible order.

* Move QAPISchema & friends to qapi/schema.py

* Move QAPIGen and its sub-classes, ifcontext,
  QAPISchemaModularCVisitor, and QAPISchemaModularCVisitor to qapi/gen.py

* Delete camel_case(), it's unused since commit e98859a9 "qapi:
  Clean up after recent conversions to QAPISchemaVisitor"

A number of helper functions remain in qapi/common.py.  I considered
moving the code generator helpers to qapi/gen.py, but decided not to.
Perhaps we should rewrite them as methods of QAPIGen some day.

Signed-off-by: default avatarMarkus Armbruster <armbru@redhat.com>
Reviewed-by: default avatarEric Blake <eblake@redhat.com>
Message-Id: <20191018074345.24034-7-armbru@redhat.com>
[Add "# -*- coding: utf-8 -*-" lines]
parent 61bfb2e1

Makefile

+10 −3
Original line number Diff line number Diff line
@@ -582,13 +582,20 @@ qemu-ga$(EXESUF): QEMU_CFLAGS += -I qga/qapi-generated 
qemu-keymap$(EXESUF): LIBS += $(XKBCOMMON_LIBS)

qemu-keymap$(EXESUF): QEMU_CFLAGS += $(XKBCOMMON_CFLAGS)



qapi-py = $(SRC_PATH)/scripts/qapi/commands.py \

qapi-py = $(SRC_PATH)/scripts/qapi/__init__.py \

$(SRC_PATH)/scripts/qapi/commands.py \

$(SRC_PATH)/scripts/qapi/common.py \

$(SRC_PATH)/scripts/qapi/doc.py \

$(SRC_PATH)/scripts/qapi/error.py \

$(SRC_PATH)/scripts/qapi/events.py \

$(SRC_PATH)/scripts/qapi/expr.py \

$(SRC_PATH)/scripts/qapi/gen.py \

$(SRC_PATH)/scripts/qapi/introspect.py \

$(SRC_PATH)/scripts/qapi/parser.py \

$(SRC_PATH)/scripts/qapi/schema.py \

$(SRC_PATH)/scripts/qapi/source.py \

$(SRC_PATH)/scripts/qapi/types.py \

$(SRC_PATH)/scripts/qapi/visit.py \

$(SRC_PATH)/scripts/qapi/common.py \

$(SRC_PATH)/scripts/qapi/doc.py \

$(SRC_PATH)/scripts/qapi-gen.py



qga/qapi-generated/qga-qapi-types.c qga/qapi-generated/qga-qapi-types.h \

scripts/qapi-gen.py

+6 −4
Original line number Diff line number Diff line
@@ -5,16 +5,18 @@ 
# See the COPYING file in the top-level directory.



from __future__ import print_function



import argparse

import re

import sys

from qapi.common import QAPIError, QAPISchema

from qapi.types import gen_types

from qapi.visit import gen_visit



from qapi.commands import gen_commands

from qapi.doc import gen_doc

from qapi.events import gen_events

from qapi.introspect import gen_introspect

from qapi.doc import gen_doc

from qapi.schema import QAPIError, QAPISchema

from qapi.types import gen_types

from qapi.visit import gen_visit





def main(argv):

scripts/qapi/commands.py

+1 −0
Original line number Diff line number Diff line
@@ -14,6 +14,7 @@ See the COPYING file in the top-level directory. 
"""



from qapi.common import *

from qapi.gen import QAPIGenCCode, QAPISchemaModularCVisitor, ifcontext





def gen_command_decl(name, arg_type, boxed, ret_type):

scripts/qapi/common.py

+0 −2321

File changed.

Preview size limit exceeded, changes collapsed.

scripts/qapi/doc.py

+4 −3
Original line number Diff line number Diff line
@@ -7,7 +7,8 @@ 


from __future__ import print_function

import re

import qapi.common

from qapi.gen import QAPIGenDoc, QAPISchemaVisitor





MSG_FMT = """

@deftypefn {type} {{}} {name}
@@ -216,10 +217,10 @@ def texi_entity(doc, what, ifcond, base=None, variants=None, 
            + texi_sections(doc, ifcond))





class QAPISchemaGenDocVisitor(qapi.common.QAPISchemaVisitor):

class QAPISchemaGenDocVisitor(QAPISchemaVisitor):

    def __init__(self, prefix):

        self._prefix = prefix

        self._gen = qapi.common.QAPIGenDoc(self._prefix + 'qapi-doc.texi')

        self._gen = QAPIGenDoc(self._prefix + 'qapi-doc.texi')

        self.cur_doc = None



    def write(self, output_dir):