{"id":2617,"url":"https://patchwork.libcamera.org/api/patches/2617/?format=json","web_url":"https://patchwork.libcamera.org/patch/2617/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/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":"<20200113164245.52535-3-jacopo@jmondi.org>","date":"2020-01-13T16:42:24","name":"[libcamera-devel,02/23] libcamera: controls: Parse 'enum' in gen-controls.py","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"50a06d286f624e9b26fa9514a2341e32dc0a3057","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/people/3/?format=json","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/2617/mbox/","series":[{"id":618,"url":"https://patchwork.libcamera.org/api/series/618/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=618","date":"2020-01-13T16:42:22","name":"Properties and compound controls","version":1,"mbox":"https://patchwork.libcamera.org/series/618/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/2617/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/2617/checks/","tags":{},"headers":{"Return-Path":"","Received":["from relay11.mail.gandi.net (relay11.mail.gandi.net\n\t[217.70.178.231])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 9C5B6606EA\n\tfor ;\n\tMon, 13 Jan 2020 17:40:25 +0100 (CET)","from uno.lan (2-224-242-101.ip172.fastwebnet.it [2.224.242.101])\n\t(Authenticated sender: jacopo@jmondi.org)\n\tby relay11.mail.gandi.net (Postfix) with ESMTPSA id D24CD100004;\n\tMon, 13 Jan 2020 16:40:24 +0000 (UTC)"],"From":"Jacopo Mondi ","To":"libcamera-devel@lists.libcamera.org","Date":"Mon, 13 Jan 2020 17:42:24 +0100","Message-Id":"<20200113164245.52535-3-jacopo@jmondi.org>","X-Mailer":"git-send-email 2.24.0","In-Reply-To":"<20200113164245.52535-1-jacopo@jmondi.org>","References":"<20200113164245.52535-1-jacopo@jmondi.org>","MIME-Version":"1.0","Content-Type":"text/plain; charset=UTF-8","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH 02/23] libcamera: controls: Parse 'enum'\n\tin gen-controls.py","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","X-List-Received-Date":"Mon, 13 Jan 2020 16:40:25 -0000"},"content":"In preparation to add libcamera Camera properties definitions by re-using\nthe control generation framework, augment the gen_controls.py script to\nsupport parsing the 'enum' yaml tag and generate documentation and\ndefinition of possible values associated with a Control or a Property\nand defined through an enumeration of supported values.\n\nReviewed-by: Niklas Söderlund \nSigned-off-by: Laurent Pinchart \nSigned-off-by: Jacopo Mondi \n---\n src/libcamera/gen-controls.py | 48 +++++++++++++++++++++++++++++++----\n 1 file changed, 43 insertions(+), 5 deletions(-)","diff":"diff --git a/src/libcamera/gen-controls.py b/src/libcamera/gen-controls.py\nindex 940386cc68c8..7369ab4b0fdb 100755\n--- a/src/libcamera/gen-controls.py\n+++ b/src/libcamera/gen-controls.py\n@@ -16,7 +16,18 @@ def snake_case(s):\n return ''.join([c.isupper() and ('_' + c) or c for c in s]).strip('_')\n \n \n+def format_description(description):\n+ description = description.strip('\\n').split('\\n')\n+ description[0] = '\\\\brief ' + description[0]\n+ return '\\n'.join([(line and ' * ' or ' *') + line for line in description])\n+\n+\n def generate_cpp(controls):\n+ enum_doc_start_template = string.Template('''/**\n+ * \\\\enum ${name}Values\n+ * \\\\brief Supported ${name} values''')\n+ enum_doc_value_template = string.Template(''' * \\\\var ${name}Values::${value}\n+${description}''')\n doc_template = string.Template('''/**\n * \\\\var extern const Control<${type}> ${name}\n ${description}\n@@ -31,17 +42,30 @@ ${description}\n name, ctrl = ctrl.popitem()\n id_name = snake_case(name).upper()\n \n- description = ctrl['description'].strip('\\n').split('\\n')\n- description[0] = '\\\\brief ' + description[0]\n- description = '\\n'.join([(line and ' * ' or ' *') + line for line in description])\n-\n info = {\n 'name': name,\n 'type': ctrl['type'],\n- 'description': description,\n+ 'description': format_description(ctrl['description']),\n 'id_name': id_name,\n }\n \n+ enum = ctrl.get('enum')\n+ if enum:\n+ enum_doc = []\n+ enum_doc.append(enum_doc_start_template.substitute(info))\n+\n+ for value in enum:\n+ value_info = {\n+ 'name' : name,\n+ 'value': list(value.keys())[0],\n+ 'description': format_description(value['description']),\n+ }\n+ enum_doc.append(enum_doc_value_template.substitute(value_info))\n+\n+ enum_doc = '\\n *\\n'.join(enum_doc)\n+ enum_doc += '\\n */'\n+ ctrls_doc.append(enum_doc)\n+\n ctrls_doc.append(doc_template.substitute(info))\n ctrls_def.append(def_template.substitute(info))\n ctrls_map.append('\\t{ ' + id_name + ', &' + name + ' },')\n@@ -54,6 +78,8 @@ ${description}\n \n \n def generate_h(controls):\n+ enum_template_start = string.Template('''enum ${name}Values {''')\n+ enum_value_template = string.Template('''\\t${name} = ${value},''')\n template = string.Template('''extern const Control<${type}> ${name};''')\n \n ctrls = []\n@@ -71,6 +97,18 @@ def generate_h(controls):\n 'type': ctrl['type'],\n }\n \n+ enum = ctrl.get('enum')\n+ if enum:\n+ ctrls.append(enum_template_start.substitute(info))\n+\n+ for value in enum:\n+ value_info = {\n+ 'name': list(value.keys())[0],\n+ 'value': value['value'],\n+ }\n+ ctrls.append(enum_value_template.substitute(value_info))\n+ ctrls.append(\"};\")\n+\n ctrls.append(template.substitute(info))\n id_value += 1\n \n","prefixes":["libcamera-devel","02/23"]}