You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
125 lines
5.9 KiB
125 lines
5.9 KiB
#!/usr/bin/env python3 |
|
"""Generate SDRangel Qt SWG model classes from a Swagger include YAML. |
|
|
|
SDRangel's own generator is a fork of swagger-codegen; regenerating the whole |
|
client touches hundreds of files. This writes only the classes for one YAML, |
|
in the compact style of the hand-maintained SWGSELCALDemod* models. |
|
|
|
./gen_swg_models.py ~/sdrangel/swagger/sdrangel/api/swagger/include/ChirpModemDemod.yaml \ |
|
~/sdrangel/swagger/sdrangel/code/qt5/client |
|
""" |
|
|
|
import sys |
|
from pathlib import Path |
|
|
|
import yaml |
|
|
|
PRIMITIVES = { |
|
("integer", "int32"): "qint32", |
|
("integer", "int64"): "qint64", |
|
("integer", None): "qint32", |
|
("number", "float"): "float", |
|
("number", "double"): "double", |
|
("number", None): "float", |
|
} |
|
|
|
|
|
def accessor(name): |
|
"""Method suffix: the codegen capitalises the key and writes API as Api.""" |
|
return (name[0].upper() + name[1:]).replace("API", "Api") |
|
|
|
|
|
def field_type(prop): |
|
if "$ref" in prop: |
|
return "ref", "SWG" + prop["$ref"].rsplit("/", 1)[-1] |
|
if prop["type"] == "string": |
|
return "string", "QString" |
|
return "prim", PRIMITIVES[(prop["type"], prop.get("format"))] |
|
|
|
|
|
def generate(cls, definition, yaml_name): |
|
name = "SWG" + cls |
|
fields = [(key, *field_type(prop)) for key, prop in definition["properties"].items()] |
|
refs = sorted({t for _, kind, t in fields if kind == "ref"}) |
|
|
|
h = ["// SPDX-License-Identifier: GPL-3.0-or-later", |
|
f"// Qt model for {yaml_name}, following the Swagger client model interface.", |
|
f"// Generated by gen_swg_models.py: edit the YAML, not this file.", |
|
f"#ifndef {name}_H_", f"#define {name}_H_", "", |
|
"#include <QJsonObject>", "#include <QString>", "", |
|
'#include "SWGObject.h"', '#include "export.h"'] |
|
h += [f'#include "{r}.h"' for r in refs] |
|
h += ["", "namespace SWGSDRangel {", "", |
|
f"class SWG_API {name} : public SWGObject {{", "public:", |
|
f" {name}();", f" explicit {name}(QString* json);", f" ~{name}() override;", |
|
" void init();", " void cleanup();", " QString asJson() override;", |
|
" QJsonObject* asJsonObject() override;", " void fromJsonObject(QJsonObject& json) override;", |
|
f" {name}* fromJson(QString& json) override;", " bool isSet() override;", ""] |
|
for key, kind, t in fields: |
|
ctype = t if kind == "prim" else t + "*" |
|
h += [f" {ctype} get{accessor(key)}();", f" void set{accessor(key)}({ctype} value);"] |
|
h += ["", "private:"] |
|
for key, kind, t in fields: |
|
if kind == "prim": |
|
h.append(f" {t} m_{key} = 0;") |
|
else: |
|
h.append(f" {t}* m_{key} = nullptr;") |
|
h.append(f" bool m_{key}IsSet = false;") |
|
h += ["};", "", "}", "", "#endif", ""] |
|
|
|
c = ["// SPDX-License-Identifier: GPL-3.0-or-later", |
|
f"// Generated by gen_swg_models.py from {yaml_name}: edit the YAML, not this file.", |
|
f'#include "{name}.h"', '#include "SWGHelpers.h"', "", "#include <QJsonDocument>", "", |
|
"namespace SWGSDRangel {", "", |
|
f"{name}::{name}() = default;", |
|
f"{name}::{name}(QString* json) {{ init(); if (json) {{ fromJson(*json); }} }}", |
|
f"{name}::~{name}() {{ cleanup(); }}", "", |
|
f"void {name}::cleanup()", "{"] |
|
c += [f" delete m_{k}; m_{k} = nullptr;" for k, kind, _ in fields if kind != "prim"] |
|
c += ["}", "", f"void {name}::init()", "{", " cleanup();"] |
|
for key, kind, t in fields: |
|
init = "0" if kind == "prim" else f"new {t}()" |
|
c.append(f" m_{key} = {init}; m_{key}IsSet = false;") |
|
c += ["}", "", f"{name}* {name}::fromJson(QString& json)", "{", |
|
" auto object = QJsonDocument::fromJson(json.toUtf8()).object(); fromJsonObject(object); return this;", |
|
"}", "", f"void {name}::fromJsonObject(QJsonObject& json)", "{"] |
|
for key, kind, t in fields: |
|
inner = "" if kind == "prim" else t |
|
c.append(f' if (json.contains("{key}")) {{ ::SWGSDRangel::setValue(&m_{key},json["{key}"],"{t}","{inner}"); m_{key}IsSet = true; }}') |
|
c += ["}", "", f"QString {name}::asJson()", "{", |
|
" auto* object = asJsonObject(); QString result = QJsonDocument(*object).toJson(); delete object; return result;", |
|
"}", "", f"QJsonObject* {name}::asJsonObject()", "{", " auto* object = new QJsonObject();"] |
|
for key, kind, t in fields: |
|
if kind == "prim": |
|
c.append(f' if (m_{key}IsSet) {{ object->insert("{key}",QJsonValue(m_{key})); }}') |
|
elif kind == "string": |
|
c.append(f' if (m_{key} && (m_{key}IsSet || !m_{key}->isEmpty())) {{ toJsonValue(QString("{key}"),m_{key},object,QString("QString")); }}') |
|
else: |
|
c.append(f' if (m_{key} && (m_{key}IsSet || m_{key}->isSet())) {{ toJsonValue(QString("{key}"),m_{key},object,QString("{t}")); }}') |
|
c += [" return object;", "}", "", f"bool {name}::isSet()", "{", |
|
" return " + " || ".join(f"m_{k}IsSet" for k, _, _ in fields) + ";", "}", ""] |
|
for key, kind, t in fields: |
|
a = accessor(key) |
|
if kind == "prim": |
|
c += [f"{t} {name}::get{a}() {{ return m_{key}; }}", |
|
f"void {name}::set{a}({t} value) {{ m_{key} = value; m_{key}IsSet = true; }}"] |
|
else: |
|
c += [f"{t}* {name}::get{a}() {{ return m_{key}; }}", |
|
f"void {name}::set{a}({t}* value) {{ if (m_{key} != value) {{ delete m_{key}; m_{key} = value; }} m_{key}IsSet = true; }}"] |
|
c += ["", "}", ""] |
|
return name, "\n".join(h), "\n".join(c) |
|
|
|
|
|
def main(): |
|
if len(sys.argv) != 3: |
|
sys.exit(__doc__) |
|
src, out = Path(sys.argv[1]).expanduser(), Path(sys.argv[2]).expanduser() |
|
for cls, definition in yaml.safe_load(src.read_text()).items(): |
|
name, header, source = generate(cls, definition, src.name) |
|
(out / f"{name}.h").write_text(header) |
|
(out / f"{name}.cpp").write_text(source) |
|
print(f"wrote {out / name}.h/.cpp ({len(definition['properties'])} fields)") |
|
|
|
|
|
if __name__ == "__main__": |
|
main()
|
|
|