{"id":17556,"url":"https://patchwork.libcamera.org/api/1.1/patches/17556/?format=json","web_url":"https://patchwork.libcamera.org/patch/17556/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20221006230747.11688-2-laurent.pinchart@ideasonboard.com>","date":"2022-10-06T23:07:44","name":"[libcamera-devel,v2,1/4] utils: gen-controls: Factor out YAML data handling in classes","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"85d601c05df70438149332638db693ee4607d86e","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/1.1/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/17556/mbox/","series":[{"id":3541,"url":"https://patchwork.libcamera.org/api/1.1/series/3541/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=3541","date":"2022-10-06T23:07:43","name":"libcamera: Improve handling of fixed-size array controls","version":2,"mbox":"https://patchwork.libcamera.org/series/3541/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/17556/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/17556/checks/","tags":{},"headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 3B182BD16B\n\tfor <parsemail@patchwork.libcamera.org>;\n\tThu,  6 Oct 2022 23:07:57 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id F232862D08;\n\tFri,  7 Oct 2022 01:07:56 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 4314B603D7\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri,  7 Oct 2022 01:07:55 +0200 (CEST)","from pendragon.ideasonboard.com (62-78-145-57.bb.dnainternet.fi\n\t[62.78.145.57])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id BE7A86D6;\n\tFri,  7 Oct 2022 01:07:54 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1665097677;\n\tbh=q6SCLqt0jmn10adSE30c75HoqERoAggP/7dZnuz2fCo=;\n\th=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:\n\tFrom;\n\tb=d4e9dZLt9C7TjmxycuP2AmqUQqvJtPcWbrb7uc7kSW2nlCD+duV6NV0jqY95s9Ip0\n\t9s/hgE43wEBuo06Bc2mPbRhPuGhGsXd6avbdl8CE+tJ8U1IbOxQ6lIlA1yjzpHCtSN\n\tHR3f9yyUylR6rBs+ENf6E2w+g+x3A69ITUlr1l+Cid9VywnN2cTlfpNByxl4jkQohH\n\tci99pFb0S0DhquK/zVs62QvTB5cg4KA0j47CerLPDd1oYOWuiQ5UWAZThLlzeyZAfz\n\txRYOKCfO3YQ9qjQRULAipJ1A4bCJmR28IO+Ia45mes7hN5HyYQMdftVksZOdnAQrC/\n\t+t7nAK4zVp5qg==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1665097675;\n\tbh=q6SCLqt0jmn10adSE30c75HoqERoAggP/7dZnuz2fCo=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=MdVzHwP/mEP0pWJNwHTbuOQbSqfXGvj+Y7m5HoBBhhDt0gCG0A/Wn6OVEozOCEOj7\n\tp9vgNYQYlWg6r/r0EU8LHT7dfy4Q8HabpdFGKuXKaZgZXhFUxbVuyhShvE4Z3+f457\n\tvBNcFMAINaaXGZfhi6Cl+bScWGCxsJc2KlL8OAgc="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"MdVzHwP/\"; dkim-atps=neutral","To":"libcamera-devel@lists.libcamera.org","Date":"Fri,  7 Oct 2022 02:07:44 +0300","Message-Id":"<20221006230747.11688-2-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.35.1","In-Reply-To":"<20221006230747.11688-1-laurent.pinchart@ideasonboard.com>","References":"<20221006230747.11688-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH v2 1/4] utils: gen-controls: Factor out\n\tYAML data handling in classes","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","From":"Laurent Pinchart via libcamera-devel\n\t<libcamera-devel@lists.libcamera.org>","Reply-To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"},"content":"The gen-controls.py script handles the data structure produced by the\nYAML parser manually through the whole code base. Clean this up by\nencapsulating it in Control and ControlEnum classes to model a control\nand its enum values respectively, to decouple YAML data handling from\ngeneration.\n\nNo functional change intended.\n\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\nReviewed-by: Jacopo Mondi <jacopo@jmondi.org>\n---\nChanges since v1:\n\n- Use self.__enum_values to check if Control is an enum\n- Fix typos\n---\n utils/gen-controls.py | 156 ++++++++++++++++++++++++++++--------------\n 1 file changed, 106 insertions(+), 50 deletions(-)","diff":"diff --git a/utils/gen-controls.py b/utils/gen-controls.py\nindex 46ba439439ec..d6b4e30001b2 100755\n--- a/utils/gen-controls.py\n+++ b/utils/gen-controls.py\n@@ -14,6 +14,90 @@ import sys\n import yaml\n \n \n+class ControlEnum(object):\n+    def __init__(self, data):\n+        self.__data = data\n+\n+    @property\n+    def description(self):\n+        \"\"\"The enum description\"\"\"\n+        return self.__data.get('description')\n+\n+    @property\n+    def name(self):\n+        \"\"\"The enum name\"\"\"\n+        return self.__data.get('name')\n+\n+    @property\n+    def value(self):\n+        \"\"\"The enum value\"\"\"\n+        return self.__data.get('value')\n+\n+\n+class Control(object):\n+    def __init__(self, name, data):\n+        self.__name = name\n+        self.__data = data\n+        self.__enum_values = None\n+\n+        enum_values = data.get('enum')\n+        if enum_values is not None:\n+            self.__enum_values = [ControlEnum(enum) for enum in enum_values]\n+\n+    @property\n+    def description(self):\n+        \"\"\"The control description\"\"\"\n+        return self.__data.get('description')\n+\n+    @property\n+    def enum_values(self):\n+        \"\"\"The enum values, if the control is an enumeration\"\"\"\n+        if self.__enum_values is None:\n+            return\n+        for enum in self.__enum_values:\n+            yield enum\n+\n+    @property\n+    def is_enum(self):\n+        \"\"\"Is the control an enumeration\"\"\"\n+        return self.__enum_values is not None\n+\n+    @property\n+    def is_draft(self):\n+        \"\"\"Is the control a draft control\"\"\"\n+        return self.__data.get('draft') is not None\n+\n+    @property\n+    def name(self):\n+        \"\"\"The control name (CamelCase)\"\"\"\n+        return self.__name\n+\n+    @property\n+    def q_name(self):\n+        \"\"\"The control name, qualified with a namespace\"\"\"\n+        ns = 'draft::' if self.is_draft else ''\n+        return ns + self.__name\n+\n+    @property\n+    def type(self):\n+        typ = self.__data.get('type')\n+        size = self.__data.get('size')\n+\n+        if typ == 'string':\n+            return 'std::string'\n+\n+        if size is None:\n+            return typ\n+\n+        if len(size) > 0:\n+            # fixed-sized Span\n+            span_size = reduce(operator.mul, size)\n+            return f\"Span<const {typ}, {span_size}>\"\n+        else:\n+            # variable-sized Span\n+            return f\"Span<const {typ}>\"\n+\n+\n def snake_case(s):\n     return ''.join([c.isupper() and ('_' + c) or c for c in s]).strip('_')\n \n@@ -24,24 +108,6 @@ def format_description(description):\n     return '\\n'.join([(line and ' * ' or ' *') + line for line in description])\n \n \n-def get_ctrl_type(ctrl):\n-    ctrl_type = ctrl['type']\n-    ctrl_size_arr = ctrl.get('size')\n-\n-    if ctrl_type == 'string':\n-        return 'std::string'\n-    elif ctrl_size_arr is not None:\n-        if len(ctrl_size_arr) > 0:\n-            # fixed-sized Span\n-            ctrl_span_size = reduce(operator.mul, ctrl_size_arr)\n-            return f\"Span<const {ctrl_type}, {ctrl_span_size}>\"\n-        else:\n-            # variable-sized Span\n-            return f\"Span<const {ctrl_type}>\"\n-    else:\n-        return ctrl_type\n-\n-\n def generate_cpp(controls):\n     enum_doc_start_template = string.Template('''/**\n  * \\\\enum ${name}Enum\n@@ -67,35 +133,31 @@ ${description}\n     ctrls_map = []\n \n     for ctrl in controls:\n-        name, ctrl = ctrl.popitem()\n-        id_name = snake_case(name).upper()\n-\n-        ctrl_type = get_ctrl_type(ctrl)\n+        id_name = snake_case(ctrl.name).upper()\n \n         info = {\n-            'name': name,\n-            'type': ctrl_type,\n-            'description': format_description(ctrl['description']),\n+            'name': ctrl.name,\n+            'type': ctrl.type,\n+            'description': format_description(ctrl.description),\n             'id_name': id_name,\n         }\n \n         target_doc = ctrls_doc\n         target_def = ctrls_def\n-        if ctrl.get('draft'):\n+        if ctrl.is_draft:\n             target_doc = draft_ctrls_doc\n             target_def = draft_ctrls_def\n \n-        enum = ctrl.get('enum')\n-        if enum:\n+        if ctrl.is_enum:\n             enum_doc = []\n             enum_doc.append(enum_doc_start_template.substitute(info))\n \n             num_entries = 0\n-            for entry in enum:\n+            for enum in ctrl.enum_values:\n                 value_info = {\n-                    'name': name,\n-                    'value': entry['name'],\n-                    'description': format_description(entry['description']),\n+                    'name': ctrl.name,\n+                    'value': enum.name,\n+                    'description': format_description(enum.description),\n                 }\n                 enum_doc.append(enum_doc_value_template.substitute(value_info))\n                 num_entries += 1\n@@ -110,9 +172,9 @@ ${description}\n             }\n             target_doc.append(enum_values_doc.substitute(values_info))\n             target_def.append(enum_values_start.substitute(values_info))\n-            for entry in enum:\n+            for enum in ctrl.enum_values:\n                 value_info = {\n-                    'name': entry['name']\n+                    'name': enum.name\n                 }\n                 target_def.append(enum_values_values.substitute(value_info))\n             target_def.append(\"};\")\n@@ -120,10 +182,7 @@ ${description}\n         target_doc.append(doc_template.substitute(info))\n         target_def.append(def_template.substitute(info))\n \n-        if ctrl.get('draft'):\n-            name = 'draft::' + name\n-\n-        ctrls_map.append('\\t{ ' + id_name + ', &' + name + ' },')\n+        ctrls_map.append('\\t{ ' + id_name + ', &' + ctrl.q_name + ' },')\n \n     return {\n         'controls_doc': '\\n\\n'.join(ctrls_doc),\n@@ -146,31 +205,27 @@ def generate_h(controls):\n     id_value = 1\n \n     for ctrl in controls:\n-        name, ctrl = ctrl.popitem()\n-        id_name = snake_case(name).upper()\n+        id_name = snake_case(ctrl.name).upper()\n \n         ids.append('\\t' + id_name + ' = ' + str(id_value) + ',')\n \n-        ctrl_type = get_ctrl_type(ctrl)\n-\n         info = {\n-            'name': name,\n-            'type': ctrl_type,\n+            'name': ctrl.name,\n+            'type': ctrl.type,\n         }\n \n         target_ctrls = ctrls\n-        if ctrl.get('draft'):\n+        if ctrl.is_draft:\n             target_ctrls = draft_ctrls\n \n-        enum = ctrl.get('enum')\n-        if enum:\n+        if ctrl.is_enum:\n             target_ctrls.append(enum_template_start.substitute(info))\n \n             num_entries = 0\n-            for entry in enum:\n+            for enum in ctrl.enum_values:\n                 value_info = {\n-                    'name': entry['name'],\n-                    'value': entry['value'],\n+                    'name': enum.name,\n+                    'value': enum.value,\n                 }\n                 target_ctrls.append(enum_value_template.substitute(value_info))\n                 num_entries += 1\n@@ -214,6 +269,7 @@ def main(argv):\n \n     data = open(args.input, 'rb').read()\n     controls = yaml.safe_load(data)['controls']\n+    controls = [Control(*ctrl.popitem()) for ctrl in controls]\n \n     if args.template.endswith('.cpp.in'):\n         data = generate_cpp(controls)\n","prefixes":["libcamera-devel","v2","1/4"]}