Patch Detail
Show a patch.
GET /api/1.1/patches/17062/?format=api
{ "id": 17062, "url": "https://patchwork.libcamera.org/api/1.1/patches/17062/?format=api", "web_url": "https://patchwork.libcamera.org/patch/17062/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/1.1/projects/1/?format=api", "name": "libcamera", "link_name": "libcamera", "list_id": "libcamera_core", "list_email": "libcamera-devel@lists.libcamera.org", "web_url": "", "scm_url": "", "webscm_url": "" }, "msgid": "<20220810002906.5406-2-laurent.pinchart@ideasonboard.com>", "date": "2022-08-10T00:29:03", "name": "[libcamera-devel,1/4] utils: gen-controls: Factor out YAML data handling in classes", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": false, "hash": "be92fd52c9b9c63fe85a5a9ceac4de6679112922", "submitter": { "id": 2, "url": "https://patchwork.libcamera.org/api/1.1/people/2/?format=api", "name": "Laurent Pinchart", "email": "laurent.pinchart@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/17062/mbox/", "series": [ { "id": 3401, "url": "https://patchwork.libcamera.org/api/1.1/series/3401/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=3401", "date": "2022-08-10T00:29:02", "name": "libcamera: Improve handling of fixed-size array controls", "version": 1, "mbox": "https://patchwork.libcamera.org/series/3401/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/17062/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/17062/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 64918C3275\n\tfor <parsemail@patchwork.libcamera.org>;\n\tWed, 10 Aug 2022 00:29:23 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 33B6D63332;\n\tWed, 10 Aug 2022 02:29:23 +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 06A5563326\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 10 Aug 2022 02:29:20 +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 931CB481;\n\tWed, 10 Aug 2022 02:29:19 +0200 (CEST)" ], "DKIM-Signature": [ "v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1660091363;\n\tbh=kSo2TbnvJTbGucRoEEULwHJAUv/a7vzP3VhgcPh9QIM=;\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=v77kDBkCdbR2/cjBtfYeqkOddVrbSOZpE+jgN8qJ1mV+eo4b0hF5eFz9UUvJw+Kr4\n\toP8J4eYXJzmzktI1yvf42LLjybwvWbijZJEWweXGdYJjbel/L1jIny4dlS0AkSuOhT\n\tJHiO0V1Mj5s88qerdoA5xGcUgWivCNBkLh+piRxb25mP18e4Ai1tKrK0vmKqhxEUUl\n\tI0UX70R1RMIvbOYifjTMbNYoQOmWstco3oo2oKEzCAm0ws7vvgh4MFT7n/II+F2jYY\n\tu1PiivY9PkwCbiLdN1sQZAoS0iRAyf4TsPrChQRC6io5Xe4E+WjyStxe85B8sqCSNO\n\tUZoMBkdFEPVsA==", "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1660091359;\n\tbh=kSo2TbnvJTbGucRoEEULwHJAUv/a7vzP3VhgcPh9QIM=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=a9737xUu1a8QYifbPsY5RdhtSqNczAOq3nh9bOCbLNaYLNJnZK8HLeq9eV8rGssLA\n\t0PgFpcNYPW3A2CRbNzrC9NjhVMQf3zp5bfI890nmSkQIuy2BMEBKC6YI+ON0wUskuA\n\tn9/ggqLjvnAZCpCdNOQn/+xUNwDO49PvL3K7gERU=" ], "Authentication-Results": "lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"a9737xUu\"; dkim-atps=neutral", "To": "libcamera-devel@lists.libcamera.org", "Date": "Wed, 10 Aug 2022 03:29:03 +0300", "Message-Id": "<20220810002906.5406-2-laurent.pinchart@ideasonboard.com>", "X-Mailer": "git-send-email 2.35.1", "In-Reply-To": "<20220810002906.5406-1-laurent.pinchart@ideasonboard.com>", "References": "<20220810002906.5406-1-laurent.pinchart@ideasonboard.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[libcamera-devel] [PATCH 1/4] utils: gen-controls: Factor out YAML\n\tdata 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>\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..f6a3ae39cc84 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 = 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.__data.get('enum') 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 (CameCase)\"\"\"\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", "1/4" ] }