@@ -31,10 +31,11 @@ class QAPISchemaGenGolangVisitor(QAPISchemaVisitor):
def __init__(self, prefix: str):
super().__init__()
- self.target = {name: "" for name in ["alternate", "enum", "event", "helper", "struct", "union"]}
+ self.target = {name: "" for name in ["alternate", "command", "enum", "event", "helper", "struct", "union"]}
self.objects_seen = {}
self.schema = None
self.events = {}
+ self.commands = {}
self._docmap = {}
self.golang_package_name = "qapi"
@@ -76,6 +77,19 @@ def visit_end(self):
'''
self.target["event"] += generate_marshal_methods('Event', self.events)
+ self.target["command"] += '''
+type CommandBase struct {
+ Id string `json:"id,omitempty"`
+ Name string `json:"execute"`
+}
+
+type Command struct {
+ CommandBase
+ Arg Any `json:"arguments,omitempty"`
+}
+'''
+ self.target["command"] += generate_marshal_methods('Command', self.commands)
+
self.target["helper"] += '''
// Creates a decoder that errors on unknown Fields
// Returns true if successfully decoded @from string @into type
@@ -295,7 +309,29 @@ def visit_command(self,
allow_oob: bool,
allow_preconfig: bool,
coroutine: bool) -> None:
- pass
+ assert name == info.defn_name
+ type_name = qapi_to_go_type_name(name, info.defn_meta)
+ self.commands[name] = type_name
+
+ doc = self._docmap.get(name, None)
+ self_contained = True if not arg_type or not arg_type.name.startswith("q_obj") else False
+ content = ""
+ if boxed or self_contained:
+ args = "" if not arg_type else "\n" + arg_type.name
+ doc_struct, _ = qapi_to_golang_struct_docs(doc)
+ content = generate_struct_type(type_name, args, doc_struct)
+ else:
+ assert isinstance(arg_type, QAPISchemaObjectType)
+ content = qapi_to_golang_struct(name,
+ doc,
+ arg_type.info,
+ arg_type.ifcond,
+ arg_type.features,
+ arg_type.base,
+ arg_type.members,
+ arg_type.variants)
+
+ self.target["command"] += content
def visit_event(self, name, info, ifcond, features, arg_type, boxed):
assert name == info.defn_name
@@ -391,7 +427,7 @@ def generate_marshal_methods_enum(members: List[QAPISchemaEnumMember]) -> str:
}}
'''
-# Marshal methods for Event and Union types
+# Marshal methods for Event, Commad and Union types
def generate_marshal_methods(type: str,
type_dict: Dict[str, str],
discriminator: str = "",
@@ -404,6 +440,11 @@ def generate_marshal_methods(type: str,
discriminator = "base.Name"
struct_field = "Arg"
json_field = "data"
+ elif type == "Command":
+ base = type + "Base"
+ discriminator = "base.Name"
+ struct_field = "Arg"
+ json_field = "arguments"
else:
assert base != ""
discriminator = "base." + discriminator
@@ -636,7 +677,7 @@ def qapi_to_go_type_name(name: str, meta: str) -> str:
name = words[0].title() if words[0].islower() or words[0].isupper() else words[0]
name += ''.join(word.title() for word in words[1:])
- if meta == "event":
+ if meta == "event" or meta == "command":
name = name[:-3] if name.endswith("Arg") else name
name += meta.title()
This patch handles QAPI command types and generates data structures in Go that decodes from QMP JSON Object to Go data structure and vice versa. At the time of this writing, it generates 210 structures (208 commands) This is very similar to previous commit, that handles QAPI union types in Go. Each QAPI command will generate a Go struct with the suffix 'Command'. Its fields, if any, are the mandatory or optional arguments defined in the QAPI command. Simlar to Event, this patch adds two structures to handle QAPI specification for command types: 'Command' and 'CommandBase'. 'CommandBase' contains @Id and @Name. 'Command' extends 'CommandBase' with an @Arg field of type 'Any'. The 'Command' type implements the Unmarshaler to decode QMP JSON Object into the correct Golang (command) struct. Marshal example: ```go cmdArg := SetPasswordCommand{} cmdArg.Protocol = DisplayProtocolVnc cmdArg.Password = "secret" cmd := Command{} cmd.Name = "set_password" cmd.Arg = cmdArg b, _ := json.Marshal(&cmd) // string(b) == `{"execute":"set_password","arguments":{"protocol":"vnc","password":"secret"}}` ``` Unmarshal example: ```go qmpCommand := ` { "execute": "set_password", "arguments":{ "protocol": "vnc", "password": "secret" } }` cmd := Command{} _ = json.Unmarshal([]byte(qmpCommand), &cmd) // cmd.Name == "set_password" // cmd1.Arg.(SetPasswordCommand).Protocol == DisplayProtocolVnc ``` Signed-off-by: Victor Toso <victortoso@redhat.com> --- scripts/qapi/golang.py | 49 ++++++++++++++++++++++++++++++++++++++---- 1 file changed, 45 insertions(+), 4 deletions(-)