[PULL,13/27] qapi: Move check for reserved names out of add_name()

Commit Message

Markus Armbruster Sept. 28, 2019, 6:39 p.m. UTC

The checks for reserved names are spread far and wide.  Move one from
add_name() to new check_defn_name_str().  This is a first step towards
collecting them all in dedicated name checking functions next to
check_name().

While there, drop the quotes around the meta-type in
check_name_str()'s error messages: "'command' uses ... name 'NAME'"
becomes "command uses ... name 'NAME'".

Signed-off-by: Markus Armbruster <[e-mail]>
Reviewed-by: Eric Blake <[e-mail]>
Message-Id: <[e-mail]>
---
 scripts/qapi/common.py                   | 16 ++++++++++------
 tests/qapi-schema/bad-ident.err          |  2 +-
 tests/qapi-schema/reserved-command-q.err |  2 +-
 3 files changed, 12 insertions(+), 8 deletions(-)

Patch

diff --git a/scripts/qapi/common.py b/scripts/qapi/common.py
index a4cf41f13e..111a4bbe55 100644
--- a/scripts/qapi/common.py
+++ b/scripts/qapi/common.py
@@ -741,6 +741,13 @@  def check_name_str(name, info, source,
     assert not membername.startswith('*')
 
 
+def check_defn_name_str(name, info, meta):
+    check_name_str(name, info, meta, permit_upper=True)
+    if name.endswith('Kind') or name.endswith('List'):
+        raise QAPISemError(
+            info, "%s '%s' should not end in '%s'" % (meta, name, name[-4:]))
+
+
 def add_name(name, info, meta):
     global all_names
     # FIXME should reject names that differ only in '_' vs. '.'
@@ -748,9 +755,6 @@  def add_name(name, info, meta):
     if name in all_names:
         raise QAPISemError(info, "%s '%s' is already defined"
                            % (all_names[name], name))
-    if name.endswith('Kind') or name.endswith('List'):
-        raise QAPISemError(info, "%s '%s' should not end in '%s'"
-                           % (meta, name, name[-4:]))
     all_names[name] = meta
 
 
@@ -1162,7 +1166,7 @@  def check_exprs(exprs):
         name = expr[meta]
         check_name_is_str(name, info, "'%s'" % meta)
         info.set_defn(meta, name)
-        check_name_str(name, info, "'%s'" % meta, permit_upper=True)
+        check_defn_name_str(name, info, meta)
         add_name(name, info, meta)
         if doc and doc.symbol != name:
             raise QAPISemError(
@@ -1889,13 +1893,13 @@  class QAPISchema(object):
 
     def _make_implicit_enum_type(self, name, info, ifcond, values):
         # See also QAPISchemaObjectTypeMember.describe()
-        name = name + 'Kind'   # Use namespace reserved by add_name()
+        name = name + 'Kind'    # reserved by check_defn_name_str()
         self._def_entity(QAPISchemaEnumType(
             name, info, None, ifcond, self._make_enum_members(values), None))
         return name
 
     def _make_array_type(self, element_type, info):
-        name = element_type + 'List'   # Use namespace reserved by add_name()
+        name = element_type + 'List'    # reserved by check_defn_name_str()
         if not self.lookup_type(name):
             self._def_entity(QAPISchemaArrayType(name, info, element_type))
         return name
diff --git a/tests/qapi-schema/bad-ident.err b/tests/qapi-schema/bad-ident.err
index ddc96bd3a9..79d14758ce 100644
--- a/tests/qapi-schema/bad-ident.err
+++ b/tests/qapi-schema/bad-ident.err
@@ -1,2 +1,2 @@ 
 tests/qapi-schema/bad-ident.json: In struct '*oops':
-tests/qapi-schema/bad-ident.json:2: 'struct' uses invalid name '*oops'
+tests/qapi-schema/bad-ident.json:2: struct uses invalid name '*oops'
diff --git a/tests/qapi-schema/reserved-command-q.err b/tests/qapi-schema/reserved-command-q.err
index 0844e14b26..631cb5cdcc 100644
--- a/tests/qapi-schema/reserved-command-q.err
+++ b/tests/qapi-schema/reserved-command-q.err
@@ -1,2 +1,2 @@ 
 tests/qapi-schema/reserved-command-q.json: In command 'q-unix':
-tests/qapi-schema/reserved-command-q.json:5: 'command' uses invalid name 'q-unix'
+tests/qapi-schema/reserved-command-q.json:5: command uses invalid name 'q-unix'