lbkit 0.5.20__tar.gz → 0.5.21__tar.gz

{lbkit-0.5.20/lbkit.egg-info → lbkit-0.5.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lbkit
-Version: 0.5.20
+Version: 0.5.21
 Summary: Tools provided by litebmc.com
 Home-page: https://www.litebmc.com
 Author: xuhj@litebmc.com

lbkit-0.5.21/lbkit/__init__.py

@@ -0,0 +1,2 @@
+
+__version__ = '0.5.21'

{lbkit-0.5.20 → lbkit-0.5.21}/lbkit/cli.py

@@ -57,8 +57,12 @@ class Command(object):
 
         支持自动生成服务端和客户端C代码
         """
-        gen = CodeGen(sys.argv[2:])
-        gen.run("./metadata/package.yml")
+        argv = sys.argv[2:]
+        if "-i" not in argv and "-c" not in argv:
+            if os.path.isfile("./metadata/package.yml"):
+                argv.extend(["-c", "./metadata/package.yml"])
+        gen = CodeGen(argv)
+        gen.run()
 
     # new package
     def new(self, *args):

{lbkit-0.5.20 → lbkit-0.5.21}/lbkit/codegen/codegen.py

@@ -17,11 +17,12 @@ from lbkit.misc import SmartFormatter
 lb_cwd = os.path.split(os.path.realpath(__file__))[0]
 log = Logger("codegen")
 
-__version__=2
+__version__=3
 
 class CodeGen(object):
     def __init__(self, args):
         self.args = args
+        self.codegen_version = __version__
         pass
 
     def _gen(self, idf_file, directory="."):
@@ -32,12 +33,12 @@ class CodeGen(object):
         lookup = TemplateLookup(directories=os.path.join(lb_cwd, "template"))
         interface = IdfInterface(lookup, idf_file)
         out_file = os.path.join(directory, "public", interface.name + ".xml")
-        interface.render_dbus_xml("interface.introspect.xml.mako", out_file)
+        interface.render_dbus_xml("interface.introspect.xml.mako", out_file, self.codegen_version)
         for code_type in ["server", "client", "public"]:
             out_file = os.path.join(directory, code_type, interface.name + ".h")
-            interface.render_c_source(code_type + ".h.mako", out_file)
+            interface.render_c_source(code_type + ".h.mako", out_file, self.codegen_version)
             out_file = os.path.join(directory, code_type, interface.name + ".c")
-            interface.render_c_source(code_type + ".c.mako", out_file)
+            interface.render_c_source(code_type + ".c.mako", out_file, self.codegen_version)
         json_file = os.path.join(directory, "package.yml")
         data = {
             "version": interface.version,
@@ -54,37 +55,59 @@ class CodeGen(object):
             json.dump(odf_data, fp, sort_keys=False, indent=4)
 
 
-    def run(self, package_yml=None):
+    def run(self):
         """
         代码自动生成.
 
         支持自动生成服务端和客户端C代码
         """
-        if package_yml is not None and os.path.isfile(package_yml):
-            configs = Helper.read_yaml(package_yml, "codegen", [])
+        parser = argparse.ArgumentParser(description=self.run.__doc__,
+                                         prog="lbkit gen",
+                                         formatter_class=SmartFormatter)
+        # 默认的自动生成工具版本号为2
+        parser.add_argument("-cv", "--codegen_version", help=f'''must less than or equal to {__version__}, default: 2
+                            description of changes:
+                            3: compatible with libgcom/0.7.x
+                            2: compatible with libgcom/0.6.x
+                            ''',
+                            type=int, default=2)
+        parser.add_argument("-d", "--directory", help='generate code directory', default=".")
+        group2 = parser.add_argument_group('cdf file', 'Generate code using the specified CDF file')
+        group2.add_argument("-c", "--cdf_file", help='component description file, default metadata/package.yml', default=None)
+        group1 = parser.add_argument_group('idf file', 'Generate code using the specified IDF file')
+        group1.add_argument("-i", "--idf_file", help='A IDF file to be processed e.g.: com.litebmc.Upgrade.xml', default=None)
+
+        args = parser.parse_args(self.args)
+
+        if args.cdf_file:
+            if not os.path.isfile(args.cdf_file):
+                raise ArgException(f"argument -c/--cdf_file: {args.cdf_file} not exist")
+            configs = Helper.read_yaml(args.cdf_file, "codegen", [])
+            # 为保障兼容，package.yml未指定版本号的，默认使用2，该版本配套libgcom/0.6.0版本，其GclProperty无set/get成员
+            self.codegen_version = Helper.read_yaml(args.cdf_file, "codegen_version", 2)
             for cfg in configs:
                 file = cfg.get("file")
                 if file is None:
-                    log.error("%s的自动代码生成配置不正确, 缺少file元素指定描述文件", package_yml)
+                    log.error("%s的自动代码生成配置不正确, 缺少file元素指定描述文件", args.cdf_file)
                     sys.exit(-1)
                 if not file.endswith(".yaml") :
-                    log.error("%s的自动代码生成配置不正确, %s的文件名不是以.yaml结束", package_yml, file)
+                    log.error("%s的自动代码生成配置不正确, %s的文件名不是以.yaml结束", args.cdf_file, file)
                     sys.exit(-1)
                 if not os.path.isfile(file):
-                    log.error("%s的自动代码生成配置不正确, %s不是一个文件", package_yml, file)
+                    log.error("%s的自动代码生成配置不正确, %s不是一个文件", args.cdf_file, file)
                     sys.exit(-1)
                 outdir = cfg.get("outdir", os.getcwd())
                 self._gen(file, outdir)
             return
 
-        parser = argparse.ArgumentParser(description=self.run.__doc__,
-                                         prog="lbkit gen",
-                                         formatter_class=SmartFormatter)
-        parser.add_argument("-i", "--input", help='A IDF file to be processed e.g.: com.litebmc.Upgrade.xml', required=True)
-        parser.add_argument("-d", "--directory", help='generate code directory', default=".")
-
-        args = parser.parse_args(self.args)
-        intf_file = args.input
+        intf_file = args.idf_file
+        if not intf_file:
+            raise ArgException(f"argument error, arguments -c/--cdf_file and -i/--idf_file are not set")
+        if not os.path.isfile(intf_file):
+            raise ArgException(f"argument -i/--idf_file: {args.idf_file} not exist")
+        if args.codegen_version > __version__ or args.codegen_version <= 0:
+            raise ArgException(f"argument -v/--codegen_version: validate failed, must less than or equal to {__version__} and bigger than 0")
+        self.codegen_version = args.codegen_version
         out_dir = os.path.join(os.getcwd(), args.directory)
         if not intf_file.endswith(".yaml"):
             raise ArgException(f"The IDF file ({intf_file}) not endswith .yaml")
@@ -96,5 +119,5 @@ class CodeGen(object):
         self._gen(intf_file, out_dir)
 
 if __name__ == "__main__":
-    gen = CodeGen(None)
+    gen = CodeGen(sys.argv)
     gen._gen("com.litebmc.test.xml", ".")

{lbkit-0.5.20 → lbkit-0.5.21}/lbkit/codegen/idf_interface.py

@@ -1102,9 +1102,8 @@ class IdfInterface(IdfInterfaceBase):
         intf_stru = IdfStructure(self, idf, propety_key="properties")
         self.structures[self.alias] = intf_stru
 
-    def render_dbus_xml(self, template, out_file):
-
-        out = self.render(self.lookup, template, intf=self)
+    def render_dbus_xml(self, template, out_file, codegen_version):
+        out = self.render(self.lookup, template, intf=self, codegen_version=codegen_version)
         hash = hashlib.sha256()
         hash.update(out.encode('utf-8'))
         self.introspect_xml_sha256 = hash.hexdigest()
@@ -1112,8 +1111,8 @@ class IdfInterface(IdfInterfaceBase):
         with open(out_file, "w") as fd:
             fd.write(out)
 
-    def render_c_source(self, template, out_file):
+    def render_c_source(self, template, out_file, codegen_version):
 
-        out = self.render(self.lookup, template, intf=self)
+        out = self.render(self.lookup, template, intf=self, codegen_version=codegen_version)
         with open(out_file, "w") as fd:
             fd.write(out)

{lbkit-0.5.20 → lbkit-0.5.21}/lbkit/codegen/template/public.c.mako

@@ -785,6 +785,45 @@ static GDBusPropertyInfo ${class_name}_property_${prop.name} =
 
     % endif
 % endfor
+% if len(intf.properties):
+GclBase *_get_real_object(const ${class_name} *object)
+{
+    GclBase *real = (GclBase *)strstr((const char *)object, GCL_MAGIC);
+    if ((gconstpointer)real != (gconstpointer)object) {
+        log_error("Get real object fail, Perhaps the memory has been freed, call abort() now");
+        abort();
+    }
+    return real;
+}
+% endif
+## 只有自动生成工具版本号大于等于3的才会生成get和set方法
+% if codegen_version >= 3:
+% for prop in intf.properties:
+static void ${class_name}_set_${prop.name}_variant(GclObject *object, GVariant *value)
+{
+    g_assert(value && object);
+    ${class_name} *real_obj = (${class_name} *)_get_real_object(object);
+    % for line in prop.free_func():
+    ${line.replace("<arg_name>", "real_obj->" + prop.name)};
+    % endfor
+    % for line in prop.decode_func():
+    ${line.replace("n_<arg_in>", "real_obj->n_" + prop.name).replace("<arg_in>", "real_obj->" + prop.name).replace("<arg_name>", "value")};
+    % endfor
+}
+
+static GVariant *${class_name}_get_${prop.name}_variant(GclObject *object)
+{
+    g_assert(object);
+    GVariant *out = NULL;
+    ${class_name} *real_obj = (${class_name} *)_get_real_object(object);
+    % for line in prop.encode_func():
+    ${line.replace("<arg_out>", "out").replace("n_<arg_name>", "real_obj->n_" + prop.name).replace("<arg_name>", "real_obj->" + prop.name)};
+    % endfor
+    return out;
+}
+
+%endfor
+%endif
 static ${class_name}_Properties _${class_name}_properties =
 {
 <% id = 0 %>\
@@ -798,7 +837,13 @@ static ${class_name}_Properties _${class_name}_properties =
         .info = NULL, /* load from /usr/share/dbus-1/interfaces/${intf.name} by gcl_init */
         % endif
         .offset = offsetof(${class_name}, ${prop.name}),
+% if codegen_version >= 3:
+        .flags = ${prop.desc_flags},
+        .set = ${class_name}_set_${prop.name}_variant,
+        .get = ${class_name}_get_${prop.name}_variant
+% else:
         .flags = ${prop.desc_flags}
+% endif
     },
 <% id = id + 1 %>\
     % endfor

{lbkit-0.5.20 → lbkit-0.5.21}/lbkit/component/build.py

@@ -306,8 +306,8 @@ class BuildComponent():
     def run(self):
         cmd = f"conan remove {self.package} -c"
         tools.exec(cmd)
-        gen = CodeGen([])
-        gen.run("./metadata/package.yml")
+        gen = CodeGen(["-c", "./metadata/package.yml"])
+        gen.run()
         self._build_dependencies()
         log.success(f"start build {self.package}")
         cmd = "conan create . {} -tf=\"\"".format(self.base_cmd)

{lbkit-0.5.20 → lbkit-0.5.21}/lbkit/helper.py

@@ -16,7 +16,7 @@ class Helper():
     def read_yaml(file: str, key, default=None):
         if not os.path.isfile(file):
             return default
-        fd = open(file, "r");
+        fd = open(file, "r")
         try:
             data = yaml.load(fd, Loader=yaml.FullLoader)
             for split in key.split("/", -1):

{lbkit-0.5.20 → lbkit-0.5.21}/lbkit/misc.py

@@ -50,6 +50,13 @@ class SmartFormatter(argparse.HelpFormatter):
         text = textwrap.dedent(text)
         return ''.join(indent + line for line in text.splitlines(True))
 
+    # 优化帮助文本打印：支持换行符
+    def _split_lines(self, text, width):
+        ret = []
+        for line in text.split("\n"):
+            ret.extend(super()._split_lines(line, width))
+        return ret
+
 def get_json_schema_file(yml_file, default_json_schema_file):
     """使用json schema文件校验yml_file配置文件"""
     with open(yml_file, "r") as fp:

{lbkit-0.5.20 → lbkit-0.5.21/lbkit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lbkit
-Version: 0.5.20
+Version: 0.5.21
 Summary: Tools provided by litebmc.com
 Home-page: https://www.litebmc.com
 Author: xuhj@litebmc.com

lbkit-0.5.20/lbkit/__init__.py

@@ -1,2 +0,0 @@
-
-__version__ = '0.5.20'