Patch Detail
Show a patch.
GET /api/patches/2778/?format=api
{ "id": 2778, "url": "https://patchwork.libcamera.org/api/patches/2778/?format=api", "web_url": "https://patchwork.libcamera.org/patch/2778/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/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": "<20200206012601.153858-3-jacopo@jmondi.org>", "date": "2020-02-06T01:25:54", "name": "[libcamera-devel,v5,2/9] libcamera: controls: Parse 'enum' in gen-controls.py", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": false, "hash": "edbbf14fdbb95ac04d32c8dfac40607fe05ff706", "submitter": { "id": 3, "url": "https://patchwork.libcamera.org/api/people/3/?format=api", "name": "Jacopo Mondi", "email": "jacopo@jmondi.org" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/2778/mbox/", "series": [ { "id": 662, "url": "https://patchwork.libcamera.org/api/series/662/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=662", "date": "2020-02-06T01:25:52", "name": "Introduce camera properties", "version": 5, "mbox": "https://patchwork.libcamera.org/series/662/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/2778/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/2778/checks/", "tags": {}, "headers": { "Return-Path": "<jacopo@jmondi.org>", "Received": [ "from relay10.mail.gandi.net (relay10.mail.gandi.net\n\t[217.70.178.230])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 21FC660446\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tThu, 6 Feb 2020 02:23:34 +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 relay10.mail.gandi.net (Postfix) with ESMTPSA id E88E4240002\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tThu, 6 Feb 2020 01:23:33 +0000 (UTC)" ], "From": "Jacopo Mondi <jacopo@jmondi.org>", "To": "libcamera-devel@lists.libcamera.org", "Date": "Thu, 6 Feb 2020 02:25:54 +0100", "Message-Id": "<20200206012601.153858-3-jacopo@jmondi.org>", "X-Mailer": "git-send-email 2.24.1", "In-Reply-To": "<20200206012601.153858-1-jacopo@jmondi.org>", "References": "<20200206012601.153858-1-jacopo@jmondi.org>", "MIME-Version": "1.0", "Content-Type": "text/plain; charset=UTF-8", "Content-Transfer-Encoding": "8bit", "Subject": "[libcamera-devel] [PATCH v5 2/9] 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": "<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": "Thu, 06 Feb 2020 01:23:34 -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 <niklas.soderlund@ragnatech.se>\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\nSigned-off-by: Jacopo Mondi <jacopo@jmondi.org>\n---\n src/libcamera/gen-controls.py | 50 +++++++++++++++++++++++++++++++----\n 1 file changed, 45 insertions(+), 5 deletions(-)", "diff": "diff --git a/src/libcamera/gen-controls.py b/src/libcamera/gen-controls.py\nindex 2e5ac5c81cca..b251e528d50b 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,31 @@ ${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 entry in enum:\n+ entry_name, entry_info = entry.popitem()\n+ value_info = {\n+ 'name' : name,\n+ 'value': entry_name,\n+ 'description': format_description(entry_info['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 +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,19 @@ 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 entry in enum:\n+ entry_name, entry_info = entry.popitem()\n+ value_info = {\n+ 'name': entry_name,\n+ 'value': entry_info['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", "v5", "2/9" ] }