lbkit 0.8.9__tar.gz → 0.9.1__tar.gz

{lbkit-0.8.9/lbkit.egg-info → lbkit-0.9.1}/PKG-INFO

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

lbkit-0.9.1/lbkit/__init__.py

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

{lbkit-0.8.9 → lbkit-0.9.1}/lbkit/codegen/codegen.py

@@ -64,12 +64,10 @@ class Version():
 # 历史自动生成版本号，计划用于用于生成代码稳定性测试
 # TODO： 支持生成代码稳定性测试，确保生成的代码一致性
 history_versions = {
-    "5.0": CodeGenHistory("lb_base/[>=0.8.1 <0.9.0]", "简化接口类名定义;简化枚举变量在接口间传递时的字符串定义", "0"),
-    "5.1": CodeGenHistory("lb_base/[>=0.8.3 <0.9.0]", "方法和信号添加保留字段用于功能扩展，同时设置请求和响应为空标志位", "8002"),
-    "5.2": CodeGenHistory("lb_base/[>=0.8.4 <0.9.0]", "支持校验数值边界、字符串正则以及数组匹配等规则", "8004"),
     "5.3": CodeGenHistory("lb_base/[>=0.8.5 <0.9.0]", "支持32位操作系统", "8004"),
+    "5.4": CodeGenHistory("lb_base/[>=0.9.0 <0.10.0]", "LBInterface增加alias", "9000"),
 }
-__version__=Version("5.3")
+__version__=Version("5.4")
 
 
 def version_check(ver_str: str):
@@ -119,13 +117,13 @@ class CodeGen(object):
             os.makedirs(os.path.join(directory, ct), exist_ok=True)
             out_file = os.path.join(directory, ct, interface.name + ".xml")
             interface.render_dbus_xml("interface.introspect.xml.mako", out_file)
-            out_file = os.path.join(directory, ct, interface.name + ".h")
+            out_file = os.path.join(directory, ct, interface.alias + ".h")
             interface.render_c_source(ct + ".h.mako", out_file)
-            out_file = os.path.join(directory, ct, interface.name + ".c")
+            out_file = os.path.join(directory, ct, interface.alias + ".c")
             interface.render_c_source(ct + ".c.mako", out_file)
             if "server" == ct:
                 # 生成接口schema文件
-                odf_file = os.path.join(directory, "server", "schema", f"{interface.name}.json")
+                odf_file = os.path.join(directory, "server", "schema", f"{interface.alias}.json")
                 os.makedirs(os.path.dirname(odf_file), exist_ok=True)
                 odf_data = interface.odf_schema
                 with open(odf_file, "w", encoding="utf-8") as fp:
@@ -133,7 +131,8 @@ class CodeGen(object):
         json_file = os.path.join(directory, "package.yml")
         data = {
             "version": interface.version,
-            "name": interface.name
+            "name": interface.name,
+            "alias": interface.alias
         }
         with open(json_file, "w", encoding="utf-8") as fp:
             yaml.dump(data, fp, encoding='utf-8', allow_unicode=True)

{lbkit-0.8.9 → lbkit-0.9.1}/lbkit/codegen/idf_interface.py

@@ -7,11 +7,12 @@ from functools import cached_property
 from lbkit.log import Logger
 from lbkit.codegen.renderer import Renderer
 from lbkit.codegen.ctype_defination import CTYPE_OBJS, RefObjArrayValidator, RefObjValidator
-from lbkit.misc import load_yml_with_json_schema_validate
+from lbkit.misc import load_yml_with_json_schema_validate, get_json_schema_file
 from lbkit.errors import OdfValidateException, LiteBmcException
 from lbkit.helper import SigInvalidException, validate_glib_signature
 
 log = Logger("gen_interface")
+alias = None
 
 class IDFException(Exception):
     pass
@@ -37,6 +38,8 @@ class IdfInterfaceBase(Renderer):
         self.description = None
         self.version = None
         self.alias = None
+        self.name = None
+        self.object_path = None
         self.codegen_version = None
 
 class IdfAnnotation():
@@ -120,9 +123,13 @@ CTYPE_SIGNATURE_MAP = {
     None: "s"
 }
 
-def get_intfname_and_ctype(ctype):
+def get_intfname_and_ctype(class_alias: str, ctype: str):
     match = re.findall(r"([\w][\w\d]*)", ctype)
-    return ".".join(match[:-1]), match[-1]
+    intf = ".".join(match[:-1])
+    ctype = match[-1]
+    if intf == "self":
+        return class_alias, class_alias + "_" + ctype
+    return intf, intf + "_" + ctype
 
 def ctype_to_variant_signature(intf: IdfInterfaceBase, ctype: str):
     sig_prefix = ""
@@ -135,8 +142,8 @@ def ctype_to_variant_signature(intf: IdfInterfaceBase, ctype: str):
         return sig_prefix + CTYPE_SIGNATURE_MAP.get(ctype)
     match = re.match(f"^(struct|enum|dict)\[(.*)\]$", ctype)
 
-    match_intf, match_ctype = get_intfname_and_ctype(match.group(2))
-    if match_intf != "self":
+    match_intf, match_ctype = get_intfname_and_ctype(intf.alias, match.group(2))
+    if match_intf != intf.alias:
         intf = intf.dependency_idf_interface[match_intf]
     if match.group(1) == "struct":
         stru = intf.structures.get(match_ctype)
@@ -151,7 +158,7 @@ def ctype_to_variant_signature(intf: IdfInterfaceBase, ctype: str):
             raise IDFException(f"Unknown structure {match_ctype} get")
         return sig_prefix + dictionary.signature
 
-def ctype_to_dependency_interface(ctype: str):
+def ctype_to_dependency_interface(class_alias: str, ctype: str):
     match = re.match(f"^array\[(.*)\]$", ctype)
     if match is not None:
         ctype = match.group(1)
@@ -160,8 +167,8 @@ def ctype_to_dependency_interface(ctype: str):
         return []
     match = re.match(f"^(struct|enum|dict)\[(.*)\]$", ctype)
 
-    match_intf, _ = get_intfname_and_ctype(match.group(2))
-    if match_intf == "self":
+    match_intf, _ = get_intfname_and_ctype(class_alias, match.group(2))
+    if match_intf == class_alias:
         return []
     return [match_intf]
 
@@ -214,7 +221,7 @@ class IdfCtypeRender():
             is_array = True
             ctype = match.group(1)
         match = re.match(f"^(struct|enum|dict)\[(.*)\]$", ctype)
-        _, stru_name = get_intfname_and_ctype(match.group(2))
+        _, stru_name = get_intfname_and_ctype(self.intf.alias, match.group(2))
         if is_array:
             return [f"{stru_name}_validate_odf_v(doc, node, prop, error_list)"]
         else:
@@ -304,8 +311,8 @@ class IdfCtypeRender():
             is_array = True
             ctype = match.group(1)
         match = re.match(f"^(struct|enum|dict)\[(.*)\]$", ctype)
-        intf_name, stru_name = get_intfname_and_ctype(match.group(2))
-        if intf_name == "self":
+        intf_name, stru_name = get_intfname_and_ctype(self.intf.alias, match.group(2))
+        if intf_name == self.intf.alias:
             intf = self.intf
         else:
             intf = self.intf.dependency_idf_interface[intf_name]
@@ -374,7 +381,7 @@ class IdfCtypeRender():
             is_array = True
             ctype = match.group(1)
         match = re.match(f"^(struct|enum|dict)\[(.*)\]$", ctype)
-        _, stru_name = get_intfname_and_ctype(match.group(2))
+        _, stru_name = get_intfname_and_ctype(self.intf.alias, match.group(2))
         if match.group(1) == "struct":
             if is_array:
                 # 结构体数组初始化时为二级空指针，以空指针结束
@@ -414,7 +421,7 @@ class IdfCtypeRender():
             is_array = True
             ctype = match.group(1)
         match = re.match(f"^(struct|enum|dict)\[(.*)\]$", ctype)
-        _, stru_name = get_intfname_and_ctype(match.group(2))
+        _, stru_name = get_intfname_and_ctype(self.intf.alias, match.group(2))
         if match.group(1) == "struct":
             if is_array:
                 # 结构体数组初始化时为二级空指针，以空指针结束
@@ -454,7 +461,7 @@ class IdfCtypeRender():
             is_array = True
             ctype = match.group(1)
         match = re.match(f"^(struct|enum|dict)\[(.*)\]$", ctype)
-        _, stru_name = get_intfname_and_ctype(match.group(2))
+        _, stru_name = get_intfname_and_ctype(self.intf.alias, match.group(2))
         if match.group(1) == "enum":
             if is_array:
                 return [f"lb_free_p((void **)&<arg_name>)"]
@@ -483,7 +490,7 @@ class IdfCtypeRender():
             is_array = True
             ctype = match.group(1)
         match = re.match(f"^(struct|enum|dict)\[(.*)\]$", ctype)
-        _, stru_name = get_intfname_and_ctype(match.group(2))
+        _, stru_name = get_intfname_and_ctype(self.intf.alias, match.group(2))
         if match.group(1) == "enum":
             if is_array:
                 # 入参为二级指针
@@ -516,7 +523,7 @@ class IdfCtypeRender():
             is_array = True
             ctype = match.group(1)
         match = re.match(f"^(struct|enum|dict)\[(.*)\]$", ctype)
-        _, stru_name = get_intfname_and_ctype(match.group(2))
+        _, stru_name = get_intfname_and_ctype(self.intf.alias, match.group(2))
         if match.group(1) == "enum":
             if is_array:
                 # 入参为二级指针
@@ -596,7 +603,7 @@ class IdfCtypeRender():
             is_array = True
             ctype = match.group(1)
         match = re.match(f"^(struct|enum|dict)\[(.*)\]$", ctype)
-        _, stru_name = get_intfname_and_ctype(match.group(2))
+        _, stru_name = get_intfname_and_ctype(self.intf.alias, match.group(2))
         if match.group(1) == "enum":
             if is_array:
                 # 入参为二级指针
@@ -835,7 +842,7 @@ class IdfProperty(IdfCtypeRender):
 
     @cached_property
     def dependency_interface(self):
-        return ctype_to_dependency_interface(self.ctype)
+        return ctype_to_dependency_interface(self.intf.alias, self.ctype)
 
 
 class IdfParameter(IdfCtypeRender):
@@ -853,7 +860,7 @@ class IdfParameter(IdfCtypeRender):
 
     @cached_property
     def dependency_interface(self):
-        return ctype_to_dependency_interface(self.ctype)
+        return ctype_to_dependency_interface(self.intf.alias, self.ctype)
 
 
 class IdfParameters():
@@ -994,10 +1001,7 @@ class IdfEnumeration(IdfBase):
     def odf_schema(self):
         values = []
         for prop in self.values.parameters:
-            if self.intf.codegen_version.lt("5.0"):
-                val = self.intf.name + "." + self.name + "." + prop.name
-            else:
-                val = prop.name
+            val = prop.name
             values.append(val)
 
         odf = {
@@ -1104,7 +1108,6 @@ class IdfInterface(IdfInterfaceBase):
         super().__init__()
         self.lookup = lookup
         self.file = idf_file
-        self.name = os.path.basename(idf_file)[:-5]
         self.properties: list[IdfProperty] = []
         self.methods: list[IdfMethod] = []
         self.signals: list[IdfSignal] = []
@@ -1127,7 +1130,7 @@ class IdfInterface(IdfInterfaceBase):
         deps: dict[str, IdfInterface] = {}
         intfs = self.dependency_interface
         for intf in intfs:
-            intf_path = intf.replace(".", "/") + ".yaml"
+            intf_path = intf + ".yaml"
             cwd = os.getcwd()
             realpath = None
             while cwd != "/":
@@ -1205,13 +1208,13 @@ class IdfInterface(IdfInterfaceBase):
             odf["$defs"] = {
                 "ref_value": {
                     "type": "string",
-                    "description": "Property reference syntax. The format must be `\\$\\{([<]*|:)<interface>:<object_path>.<property name>\\}`",
-                    "pattern": "^\\$\\{([<]*|:)(([a-zA-Z_][A-Za-z0-9_]*)(\\.[a-zA-Z_][A-Za-z0-9_]*)+:)[/]?[A-Z0-9a-z_]+(/[A-Z0-9a-z_]+)*\\.[A-Za-z][a-zA-Z0-9_-]*\\}$"
+                    "description": "Property reference syntax. The format must be `\\$\\{([<]*|:)<object>.<property name>\\}`, for example: Test_Obj.Prop",
+                    "pattern": "^\\$\\{([<]*|:)\\.?[a-zA-Z][a-z0-9A-Z]+_[a-zA-Z0-9][a-z0-9A-Z_]*\\.[a-zA-Z][A-Za-z0-9_-]*\\}$"
                 },
                 "ref_obj": {
                     "type": "string",
-                    "description": "Property reference syntax. The format must be `\\$\\{([<]*|:)<interface>:<object_path>.<property name>\\}`",
-                    "pattern": "^\\$\\{([<]*|:)(([a-zA-Z_][A-Za-z0-9_]*)(\\.[a-zA-Z_][A-Za-z0-9_]*)+:)[/]?[A-Z0-9a-z_]+(/[A-Z0-9a-z_]+)*\\}$"
+                    "description": "Property reference syntax. The format must be `\\$\\{([<]*|:)<object>.<property name>\\}`, for example: Test_Obj",
+                    "pattern": "^\\$\\{([<]*|:)\\.?[a-zA-Z][a-z0-9A-Z]+_[a-zA-Z0-9][a-z0-9A-Z_]*\\}$"
                 },
                 "ref_obj_array": {
                     "type": "array",
@@ -1220,13 +1223,13 @@ class IdfInterface(IdfInterfaceBase):
                         "anyOf": [
                             {
                                 "type": "string",
-                                "description": "Object reference syntax. The format must be `\\$\\{([<]*|:)<interface>:<object_path>\\}`",
-                                "pattern": "^\\$\\{([<]*|:)(([a-zA-Z_][A-Za-z0-9_]*)(\\.[a-zA-Z_][A-Za-z0-9_]*)+:)[/]?[A-Z0-9a-z_]+(/[A-Z0-9a-z_]+)*\\}$"
+                                "description": "Object reference syntax. The format must be `\\$\\{([<]*|:)<object>\\}`, for example: Test_Obj",
+                                "pattern": "^\\$\\{([<]*|:)\\.?[a-zA-Z][a-z0-9A-Z]+_[a-zA-Z0-9][a-z0-9A-Z_]*\\}$"
                             },
                             {
                                 "type": "string",
                                 "description": "Plain string format, if the string start with `$` must add `\\` before `$` to escape; If the string is empty it must be surrounded by `\"`",
-                                "pattern": "^[/]?[A-Z0-9a-z_]+(/[A-Z0-9a-z_]+)*$"
+                                "pattern": "^/?[A-Z0-9a-z_]+(/[A-Z0-9a-z_]+)*$"
                             }
                         ]
                     }
@@ -1246,12 +1249,23 @@ class IdfInterface(IdfInterfaceBase):
     def load_elements(self):
         # 使用schema校验数据，确保IDF文件符合格式要求，减少程序处理过程中的异常处理
         # 验证失败时抛异常，此处不用处理，由外层处理
-        idf = load_yml_with_json_schema_validate(self.file, "/usr/share/litebmc/schema/idf.v1.json")
+        idf = load_yml_with_json_schema_validate(self.file, "/usr/share/litebmc/schema/idf.v2.json")
+        schema = get_json_schema_file(self.file, "/usr/share/litebmc/schema/idf.v2.json")
+        if schema.endswith("idf.v1.json"):
+            self.name = os.path.basename(self.file)[:-5]
+            self.alias = idf.get("alias")
+            self.object_path = ""
+        else:
+            self.alias = os.path.basename(self.file)[:-5]
+            self.name = idf.get("interface")
+            # 别名
+            self.object_path = idf.get("object_path", "")
+
         log.debug(f"validate {self.file} successfully")
         self.version = idf.get("version")
         self.description = idf.get("description", "")
-        # 别名
-        self.alias = idf.get("alias")
+        global alias
+        alias = self.alias
         # 注释
         flags = idf.get("flags", "").split(",")
         for k, v in ANNOTATION_MAP.items():
@@ -1271,6 +1285,7 @@ class IdfInterface(IdfInterfaceBase):
         items = idf.get("structures", [])
         for item in items:
             obj = IdfStructure(self, item)
+            obj.name = alias + "_" + obj.name
             self.structures[obj.name] = obj
         items = idf.get("errors", [])
         for item in items:
@@ -1280,10 +1295,12 @@ class IdfInterface(IdfInterfaceBase):
         items = idf.get("dictionaries", [])
         for item in items:
             obj = IdfDictionary(self, item)
+            obj.name = alias + "_" + obj.name
             self.dictionaries[obj.name] = obj
         items = idf.get("enumerations", [])
         for item in items:
             obj = IdfEnumeration(self, item)
+            obj.name = alias + "_" + obj.name
             self.enumerations[obj.name] = obj
         plugin = idf.get("plugin", None)
         self.plugin = IdfInterfacePlugin()

{lbkit-0.8.9 → lbkit-0.9.1}/lbkit/codegen/template/client.c.mako

@@ -1,5 +1,8 @@
+<%
+from inflection import underscore
+%>\
 #include "lb_base.h"
-#include "${intf.name}.h"
+#include "${intf.alias}.h"
 
 <% class_name = intf.alias + "_Cli"
 properties = "_" + class_name + "_properties"
@@ -113,6 +116,10 @@ static LBInterface _${class_name}_interface = {
     .name = "${intf.name}",
     .properties = (LBProperty *)&${properties},
     .interface = NULL, /* load from usr/share/dbus-1/interfaces/${intf.name}.xml by lb_init */
+#ifdef LB_CODEGEN_BE_5_4
+    .alias = "${class_name}",
+    .object_template = "${intf.object_path}",
+#endif
 };
 
 static LBBase *_get_real_object(LBO *obj)
@@ -160,18 +167,10 @@ static LBO *_${class_name}_create(const gchar *name, gpointer opaque)
 
 % for signal in intf.signals:
 % if signal.deprecated:
-    % if codegen_version.be("5.1"):
 __deprecated guint ${class_name}_Subscribe_${signal.name}(${class_name}_${signal.name}_Callback handler,
-    % else:
-__deprecated guint ${class_name}_Subscribe_${signal.name}(${class_name}_${signal.name}_Signal handler,
-    % endif
     const gchar *bus_name, const gchar *object_path, const gchar *arg0, gpointer user_data)
 % else:
-    % if codegen_version.be("5.1"):
 guint ${class_name}_Subscribe_${signal.name}(${class_name}_${signal.name}_Callback handler,
-    % else:
-guint ${class_name}_Subscribe_${signal.name}(${class_name}_${signal.name}_Signal handler,
-    % endif
     const gchar *bus_name, const gchar *object_path, const gchar *arg0, gpointer user_data)
 % endif
 {
@@ -200,7 +199,6 @@ ${class_name}_Properties *${class_name}_properties(void)
     return &${properties};
 }
 
-% if codegen_version.be("4.0"):
 ${class_name} ${class_name}_get(const gchar *well_known, const gchar *name)
 {
     return lb_impl._cli_get(&_${class_name}_interface, well_known, name);
@@ -314,7 +312,6 @@ void ${class_name}_${prop.name}_hook(${class_name}_after_changed_hook after, gpo
 }
 
 % endfor
-% endif
 static void __constructor(150) ${class_name}_register(void)
 {
     // 从公共库中复制信号处理函数

{lbkit-0.8.9 → lbkit-0.9.1}/lbkit/codegen/template/client.h.mako

@@ -5,7 +5,7 @@
 #include <glib-2.0/glib.h>
 #include <glib-2.0/gio/gio.h>
 #include "lb_base.h"
-#include "public/${intf.name}.h"
+#include "public/${intf.alias}.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -88,15 +88,9 @@ int ${class_name}_Call_${method.name}(${class_name} obj,
  % endfor
 % endif
  */
-    % if codegen_version.be("5.1"):
 typedef void (*${class_name}_${signal.name}_Callback)(${class_name} obj, const gchar *destination,
     const ${intf.alias}_${signal.name}_Msg *req, gpointer user_data, const LBSignalExtData *ext_data);
-    % else:
-typedef void (*${class_name}_${signal.name}_Signal)(${class_name} obj, const gchar *destination,
-    const ${intf.alias}_${signal.name}_Msg *req, gpointer user_data);
-    % endif
 /**/
-    % if codegen_version.be("5.1"):
         % if signal.deprecated:
 __deprecated guint ${class_name}_Subscribe_${signal.name}(${class_name}_${signal.name}_Callback handler,
     const gchar *bus_name, const gchar *object_path, const gchar *arg0, gpointer user_data);
@@ -104,15 +98,6 @@ __deprecated guint ${class_name}_Subscribe_${signal.name}(${class_name}_${signal
 guint ${class_name}_Subscribe_${signal.name}(${class_name}_${signal.name}_Callback handler,
     const gchar *bus_name, const gchar *object_path, const gchar *arg0, gpointer user_data);
         % endif
-    % else:
-        % if signal.deprecated:
-__deprecated guint ${class_name}_Subscribe_${signal.name}(${class_name}_${signal.name}_Signal handler,
-    const gchar *bus_name, const gchar *object_path, const gchar *arg0, gpointer user_data);
-        % else:
-guint ${class_name}_Subscribe_${signal.name}(${class_name}_${signal.name}_Signal handler,
-    const gchar *bus_name, const gchar *object_path, const gchar *arg0, gpointer user_data);
-        % endif
-    % endif
     % if signal.deprecated:
 __deprecated void ${class_name}_Unsubscribe_${signal.name}(guint *id);
     % else:
@@ -125,7 +110,6 @@ ${class_name}_Properties *${class_name}_properties(void);
 LBInterface *${class_name}_interface(void);
 #define ${hump2underline(class_name).upper()}    ${class_name}_interface()
 
-% if codegen_version.be("4.0"):
 /* notes: 对象变更加回调函数 */
 typedef void (*${class_name}_on_changed_hook)(${class_name} obj, gpointer user_data);
 /* notes: 属性变更后回调，远程对象或本地对象变更后都会调用 */
@@ -205,7 +189,6 @@ static inline void _cleanup_${class_name}_list(GSList **ptr)
 
 #define cleanup_${class_name} __attribute__((cleanup(_cleanup_${class_name}_)))
 #define cleanup_${class_name}_list __attribute__((cleanup(_cleanup_${class_name}_list)))
-% endif
 #ifdef __cplusplus
 }
 #endif