Patch Detail
Show a patch.
GET /api/1.1/patches/2413/?format=api
{ "id": 2413, "url": "https://patchwork.libcamera.org/api/1.1/patches/2413/?format=api", "web_url": "https://patchwork.libcamera.org/patch/2413/", "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": "<20191209163446.32381-3-jacopo@jmondi.org>", "date": "2019-12-09T16:34:38", "name": "[libcamera-devel,v3,02/10] libcamera: controls: Parse 'enum' in gen-controls.py", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": false, "hash": "8af71ff8e9e2a01435b1ee1ca7771d9eddbc4307", "submitter": { "id": 3, "url": "https://patchwork.libcamera.org/api/1.1/people/3/?format=api", "name": "Jacopo Mondi", "email": "jacopo@jmondi.org" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/2413/mbox/", "series": [ { "id": 586, "url": "https://patchwork.libcamera.org/api/1.1/series/586/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=586", "date": "2019-12-09T16:34:36", "name": "Introduce libcamera properties", "version": 3, "mbox": "https://patchwork.libcamera.org/series/586/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/2413/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/2413/checks/", "tags": {}, "headers": { "Return-Path": "<jacopo@jmondi.org>", "Received": [ "from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net\n\t[217.70.183.197])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 89BA760BDB\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 9 Dec 2019 17:32:41 +0100 (CET)", "from uno.lan (93-34-114-233.ip49.fastwebnet.it [93.34.114.233])\n\t(Authenticated sender: jacopo@jmondi.org)\n\tby relay5-d.mail.gandi.net (Postfix) with ESMTPSA id 190E41C0012;\n\tMon, 9 Dec 2019 16:32:40 +0000 (UTC)" ], "X-Originating-IP": "93.34.114.233", "From": "Jacopo Mondi <jacopo@jmondi.org>", "To": "libcamera-devel@lists.libcamera.org", "Date": "Mon, 9 Dec 2019 17:34:38 +0100", "Message-Id": "<20191209163446.32381-3-jacopo@jmondi.org>", "X-Mailer": "git-send-email 2.24.0", "In-Reply-To": "<20191209163446.32381-1-jacopo@jmondi.org>", "References": "<20191209163446.32381-1-jacopo@jmondi.org>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[libcamera-devel] [PATCH v3 02/10] libcamera: controls: Parse\n\t'enum' in gen-controls.py", "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>", "X-List-Received-Date": "Mon, 09 Dec 2019 16:32:41 -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\nSigned-off-by: Jacopo Mondi <jacopo@jmondi.org>\n---\n src/libcamera/gen-controls.py | 41 +++++++++++++++++++++++++++++++++++\n 1 file changed, 41 insertions(+)", "diff": "diff --git a/src/libcamera/gen-controls.py b/src/libcamera/gen-controls.py\nindex 940386cc68c8..4a1ee52cdb04 100755\n--- a/src/libcamera/gen-controls.py\n+++ b/src/libcamera/gen-controls.py\n@@ -17,6 +17,10 @@ def snake_case(s):\n \n \n def generate_cpp(controls):\n+ enum_doc_start_template = string.Template('''/**\n+ * \\enum ${name}Values\\n * Supported ${name} values\\n\\n''')\n+ enum_doc_value_template = string.Template(''' * \\\\var ${name}Values::${value}\n+${description}\\n *\\n''')\n doc_template = string.Template('''/**\n * \\\\var extern const Control<${type}> ${name}\n ${description}\n@@ -42,6 +46,27 @@ ${description}\n 'id_name': id_name,\n }\n \n+ enum_doc = []\n+ try:\n+ enum = ctrl['enum']\n+ enum_doc += enum_doc_start_template.substitute(info)\n+\n+ for value in enum:\n+ enum_description = value['description'].strip('\\n').split('\\n')\n+ enum_description[0] = '\\\\brief ' + enum_description[0]\n+ enum_description = '\\n'.join([' * ' + line for line in enum_description])\n+ value_info = {\n+ 'name' : name,\n+ 'value': list(value.keys())[0],\n+ 'description': enum_description,\n+ }\n+ enum_doc += enum_doc_value_template.substitute(value_info)\n+ enum_doc += \" */\"\n+ enum_doc = ''.join(enum_doc)\n+ ctrls_doc.append(enum_doc)\n+ except KeyError:\n+ pass\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 +79,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 +98,20 @@ def generate_h(controls):\n 'type': ctrl['type'],\n }\n \n+ try:\n+ enum = ctrl['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+ except KeyError:\n+ pass\n+\n ctrls.append(template.substitute(info))\n id_value += 1\n \n", "prefixes": [ "libcamera-devel", "v3", "02/10" ] }