aboutsummaryrefslogtreecommitdiff
path: root/scripts/qapi/parser.py
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2021-09-30 16:57:10 -0400
committerMarkus Armbruster <armbru@redhat.com>2021-10-02 07:33:42 +0200
commitf4c05aaf148a44d80855eb45b9342feaeeb4764a (patch)
tree64bd532191e41f1ad2912a02cc2ebf35d747debf /scripts/qapi/parser.py
parent1e20a77576dedf1489ce1cdb6abc4b34663637a4 (diff)
downloadqemu-f4c05aaf148a44d80855eb45b9342feaeeb4764a.zip
qemu-f4c05aaf148a44d80855eb45b9342feaeeb4764a.tar.gz
qemu-f4c05aaf148a44d80855eb45b9342feaeeb4764a.tar.bz2
qapi/parser: Introduce NullSection
Here's the weird bit. QAPIDoc generally expects -- virtually everywhere -- that it will always have a current section. The sole exception to this is in the case that end_comment() is called, which leaves us with *no* section. However, in this case, we also don't expect to actually ever mutate the comment contents ever again. NullSection is just a Null-object that allows us to maintain the invariant that we *always* have a current section, enforced by static typing -- allowing us to type that field as QAPIDoc.Section instead of the more ambiguous Optional[QAPIDoc.Section]. end_section is renamed to switch_section and now accepts as an argument the new section to activate, clarifying that no callers ever just unilaterally end a section; they only do so when starting a new section. Signed-off-by: John Snow <jsnow@redhat.com> Message-Id: <20210930205716.1148693-8-jsnow@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'scripts/qapi/parser.py')
-rw-r--r--scripts/qapi/parser.py27
1 files changed, 16 insertions, 11 deletions
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index 82f1d95..40c5da4 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -478,6 +478,13 @@ class QAPIDoc:
def connect(self, member):
self.member = member
+ class NullSection(Section):
+ """
+ Immutable dummy section for use at the end of a doc block.
+ """
+ def append(self, line):
+ assert False, "Text appended after end_comment() called."
+
def __init__(self, parser, info):
# self._parser is used to report errors with QAPIParseError. The
# resulting error position depends on the state of the parser.
@@ -525,7 +532,7 @@ class QAPIDoc:
self._append_line(line)
def end_comment(self):
- self._end_section()
+ self._switch_section(QAPIDoc.NullSection(self._parser))
@staticmethod
def _is_section_tag(name):
@@ -699,9 +706,9 @@ class QAPIDoc:
raise QAPIParseError(self._parser,
"'%s' parameter name duplicated" % name)
assert not self.sections
- self._end_section()
- self._section = QAPIDoc.ArgSection(self._parser, name, indent)
- symbols_dict[name] = self._section
+ new_section = QAPIDoc.ArgSection(self._parser, name, indent)
+ self._switch_section(new_section)
+ symbols_dict[name] = new_section
def _start_args_section(self, name, indent):
self._start_symbol_section(self.args, name, indent)
@@ -713,13 +720,11 @@ class QAPIDoc:
if name in ('Returns', 'Since') and self.has_section(name):
raise QAPIParseError(self._parser,
"duplicated '%s' section" % name)
- self._end_section()
- self._section = QAPIDoc.Section(self._parser, name, indent)
- self.sections.append(self._section)
-
- def _end_section(self):
- assert self._section is not None
+ new_section = QAPIDoc.Section(self._parser, name, indent)
+ self._switch_section(new_section)
+ self.sections.append(new_section)
+ def _switch_section(self, new_section):
text = self._section.text = self._section.text.strip()
# Only the 'body' section is allowed to have an empty body.
@@ -732,7 +737,7 @@ class QAPIDoc:
self._parser,
"empty doc section '%s'" % self._section.name)
- self._section = None
+ self._section = new_section
def _append_freeform(self, line):
match = re.match(r'(@\S+:)', line)