[{"id":25337,"web_url":"https://patchwork.libcamera.org/comment/25337/","msgid":"","date":"2022-10-07T14:12:09","subject":"Re: [libcamera-devel] [PATCH v2 1/4] utils: gen-controls: Factor\n\tout YAML data handling in classes","submitter":{"id":86,"url":"https://patchwork.libcamera.org/api/people/86/","name":"Umang Jain","email":"umang.jain@ideasonboard.com"},"content":"Hi Laurent,\n\nThanks for the patch\n\nOn 10/7/22 4:37 AM, Laurent Pinchart via libcamera-devel wrote:\n> The gen-controls.py script handles the data structure produced by the\n> YAML parser manually through the whole code base. Clean this up by\n> encapsulating it in Control and ControlEnum classes to model a control\n> and its enum values respectively, to decouple YAML data handling from\n> generation.\n>\n> No functional change intended.\n>\n> Signed-off-by: Laurent Pinchart \n> Reviewed-by: Jacopo Mondi \n\nReviewed-by: Umang Jain \n\n> ---\n> Changes 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(-)\n>\n> diff --git a/utils/gen-controls.py b/utils/gen-controls.py\n> index 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\"\n> + else:\n> + # variable-sized Span\n> + return f\"Span\"\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\"\n> - else:\n> - # variable-sized Span\n> - return f\"Span\"\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)","headers":{"Return-Path":"","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 2F83BC0DA4\n\tfor ;\n\tFri, 7 Oct 2022 14:12:17 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id C4C8B62D19;\n\tFri, 7 Oct 2022 16:12:16 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 69AC160A88\n\tfor ;\n\tFri, 7 Oct 2022 16:12:15 +0200 (CEST)","from [192.168.1.103] (unknown [103.251.226.3])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 33245BBE;\n\tFri, 7 Oct 2022 16:12:13 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1665151936;\n\tbh=ivJ0tgmCHk4aBtjfPmOo1qtn6LtQgGhldtkUOvkU240=;\n\th=Date:To:References:In-Reply-To:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:\n\tFrom;\n\tb=KY+k+SW4ZCjCeEFobRSH0x0BZgueSltF1w3Jk4LrnXx+X92tFZ5aSXsb1XrfQF5/V\n\tiIaF9KpngGpjml02aw+35Z3k9a41CloGldU70OS3ER0yzJQtMpLiIUuExmUXkCOcWP\n\tt6/+5Dp6eA4ApT8Vs6eLz/e/1N5C3cpgecIvRnFq8v7VAmTRQQmkWO5BtOi2A7v24Z\n\tm4F8FT9/KcqQ+37DUMHZb9QhVdfHGn+pdKXwCDSwJqvyS4g5g2mBoksmZIt8KEsc3T\n\teziXhGkp6Trlvu0n8Us//7+xglAP1AC2KDXrM55VraQZd9KAmdGIBlX6svWXpRQo6p\n\tFa2Cz7Mdy2OCw==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1665151935;\n\tbh=ivJ0tgmCHk4aBtjfPmOo1qtn6LtQgGhldtkUOvkU240=;\n\th=Date:Subject:To:References:From:In-Reply-To:From;\n\tb=ug2IGQeB5qxgcjq3f1tPnq0Q8oXBVMQDsgwBbqQc+1PlKgL9EVGe81rJj0YiPQDm/\n\tA46KXbBhwsAHi6XaTDJJDBvvcTvJDsLcJDFEEyyUYZL/FcMHbsP0ZDoimfgIwotJOh\n\tdJbSa29Z0b+lGfcc7gH+RvLKj4iEyCIXfnZO59ZM="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"ug2IGQeB\"; dkim-atps=neutral","Message-ID":"","Date":"Fri, 7 Oct 2022 19:42:09 +0530","MIME-Version":"1.0","User-Agent":"Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101\n\tThunderbird/102.2.1","Content-Language":"en-US","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","References":"<20221006230747.11688-1-laurent.pinchart@ideasonboard.com>\n\t<20221006230747.11688-2-laurent.pinchart@ideasonboard.com>","In-Reply-To":"<20221006230747.11688-2-laurent.pinchart@ideasonboard.com>","Content-Type":"text/plain; charset=UTF-8; format=flowed","Content-Transfer-Encoding":"7bit","Subject":"Re: [libcamera-devel] [PATCH v2 1/4] utils: gen-controls: Factor\n\tout YAML data handling in classes","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","From":"Umang Jain via libcamera-devel ","Reply-To":"Umang Jain ","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]