[{"id":23823,"web_url":"https://patchwork.libcamera.org/comment/23823/","msgid":"<20220712070138.GA2364006@pyrite.rasen.tech>","date":"2022-07-12T07:01:38","subject":"Re: [libcamera-devel] [PATCH 1/5] libcamera: yaml_parser: Add\n\tgetList() function","submitter":{"id":97,"url":"https://patchwork.libcamera.org/api/people/97/","name":"Nicolas Dufresne via libcamera-devel","email":"libcamera-devel@lists.libcamera.org"},"content":"Hi Florian,\n\nOn Wed, Jun 22, 2022 at 05:19:14PM +0200, Florian Sylvestre via libcamera-devel wrote:\n> Allow to retrieve a YAML list of any already supported types in a std::vector.\n> \n> Signed-off-by: Florian Sylvestre \n> ---\n> include/libcamera/internal/yaml_parser.h | 16 ++++++\n> src/libcamera/yaml_parser.cpp | 73 ++++++++++++++++++++++++\n> test/yaml-parser.cpp | 6 ++\n> 3 files changed, 95 insertions(+)\n> \n> diff --git a/include/libcamera/internal/yaml_parser.h b/include/libcamera/internal/yaml_parser.h\n> index 064cf443..ea9189bd 100644\n> --- a/include/libcamera/internal/yaml_parser.h\n> +++ b/include/libcamera/internal/yaml_parser.h\n> @@ -167,6 +167,22 @@ public:\n> #endif\n> \tT get(const T &defaultValue, bool *ok = nullptr) const;\n> \n> +#ifndef __DOXYGEN__\n> +\ttemplate +\t\t typename std::enable_if_t<\n> +\t\t\t std::is_same::value ||\n> +\t\t\t std::is_same::value ||\n> +\t\t\t std::is_same::value ||\n> +\t\t\t std::is_same::value ||\n> +\t\t\t std::is_same::value ||\n> +\t\t\t std::is_same::value ||\n> +\t\t\t std::is_same::value ||\n> +\t\t\t std::is_same::value> * = nullptr>\n\nShould these be is_same_v ?\n\n\nOtherwise, looks good.\n\nReviewed-by: Paul Elder \n\n> +#else\n> +\ttemplate\n> +#endif\n> +\tstd::vector getList(bool *ok = nullptr) const;\n> +\n> \tDictAdapter asDict() const { return DictAdapter{ dictionary_ }; }\n> \tListAdapter asList() const { return ListAdapter{ list_ }; }\n> \n> diff --git a/src/libcamera/yaml_parser.cpp b/src/libcamera/yaml_parser.cpp\n> index 5c45e44e..95c0038b 100644\n> --- a/src/libcamera/yaml_parser.cpp\n> +++ b/src/libcamera/yaml_parser.cpp\n> @@ -117,6 +117,23 @@ std::size_t YamlObject::size() const\n> * \\return Value as a bool type\n> */\n> \n> +/**\n> + * \\fn template YamlObject::getList(\n> + *\tbool *ok) const\n> + * \\brief Parse the YamlObject as a list of \\a T.\n> + * \\param[out] ok The result of whether the parse succeeded\n> + *\n> + * This function parses the value of the YamlObject as a list of \\a T objects,\n> + * and returns the value as a \\a std::vector. If parsing fails \\a ok is set\n> + * to false and a default empty vector is returned. Otherwise, the\n> + * YamlObject list of values is returned, and \\a ok is set to true.\n> + *\n> + * The \\a ok pointer is optional and can be a nullptr if the caller doesn't\n> + * need to know if parsing succeeded.\n> + *\n> + * \\return Value as a std::vector type\n> + */\n> +\n> #ifndef __DOXYGEN__\n> \n> template<>\n> @@ -323,6 +340,62 @@ Size YamlObject::get(const Size &defaultValue, bool *ok) const\n> \treturn Size(width, height);\n> }\n> \n> +template +\t typename std::enable_if_t<\n> +\t\t std::is_same::value ||\n> +\t\t std::is_same::value ||\n> +\t\t std::is_same::value ||\n> +\t\t std::is_same::value ||\n> +\t\t std::is_same::value ||\n> +\t\t std::is_same::value ||\n> +\t\t std::is_same::value ||\n> +\t\t std::is_same::value> *>\n> +std::vector YamlObject::getList(bool *ok) const\n> +{\n> +\tsetOk(ok, false);\n> +\n> +\tstd::vector defaultValue;\n> +\n> +\tif (type_ != Type::List)\n> +\t\treturn defaultValue;\n> +\n> +\tstd::vector value = std::vector(list_.size());\n> +\n> +\t/*\n> +\t * Provide somme dummy defaultValue to get() function\n> +\t * and rely on the ok variable to know if the parsing\n> +\t * was correct.\n> +\t */\n> +\tT defaultArgument = T();\n> +\tbool result;\n> +\tfor (unsigned int i = 0; i < list_.size(); ++i) {\n> +\t\tresult = true;\n> +\t\tvalue[i] = list_[i]->get(defaultArgument, &result);\n> +\n> +\t\tif (!result)\n> +\t\t\treturn defaultValue;\n> +\t}\n> +\n> +\tsetOk(ok, true);\n> +\treturn value;\n> +}\n> +\n> +template std::vector YamlObject::getList(bool *ok) const;\n> +\n> +template std::vector YamlObject::getList(bool *ok) const;\n> +\n> +template std::vector YamlObject::getList(bool *ok) const;\n> +\n> +template std::vector YamlObject::getList(bool *ok) const;\n> +\n> +template std::vector YamlObject::getList(bool *ok) const;\n> +\n> +template std::vector YamlObject::getList(bool *ok) const;\n> +\n> +template std::vector YamlObject::getList(bool *ok) const;\n> +\n> +template std::vector YamlObject::getList(bool *ok) const;\n> +\n> #endif /* __DOXYGEN__ */\n> \n> /**\n> diff --git a/test/yaml-parser.cpp b/test/yaml-parser.cpp\n> index 38f84823..bb96a11b 100644\n> --- a/test/yaml-parser.cpp\n> +++ b/test/yaml-parser.cpp\n> @@ -524,6 +524,12 @@ protected:\n> \t\t\treturn TestFail;\n> \t\t}\n> \n> +\t\tstd::vector values = firstElement.getList();\n> +\t\tif (values.size() != 2 || values[0] != 1 || values[1] != 2) {\n> +\t\t\tcerr << \"getList() failed to return correct vector\" << std::endl;\n> +\t\t\treturn TestFail;\n> +\t\t}\n> +\n> \t\tauto &secondElement = level2Obj[1];\n> \t\tif (!secondElement.isDictionary() ||\n> \t\t !secondElement.contains(\"one\") ||\n> -- \n> 2.34.1\n>","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 BA0E9BD1F1\n\tfor ;\n\tTue, 12 Jul 2022 07:01:49 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id F1BF363312;\n\tTue, 12 Jul 2022 09:01:48 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 8138C6330E\n\tfor ;\n\tTue, 12 Jul 2022 09:01:47 +0200 (CEST)","from pyrite.rasen.tech (softbank036240121080.bbtec.net\n\t[36.240.121.80])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id E101C30B;\n\tTue, 12 Jul 2022 09:01:45 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1657609309;\n\tbh=0yR1AybF5jXeOIJRIvpfohgWuLeVWJXlqPCsZHJyfsc=;\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:Cc:\n\tFrom;\n\tb=1mPINUj0NK02MdlpDNhETtVb7/QsntE9NynSPxTy1+mJZW3AuIelZ6hVD4+NGc5GP\n\tmiCJzFipynwncCia9LtcC51VdEig/QBgUqaGJ6OVIse1uuP2iyeiu0nf+dgu04qKPW\n\tH+2baIyJsbg0v6js/EL/zIMHZF1uHcIjzLxtUbIcJXstlBIIPdlpgEvOVfrKUgMzbn\n\tzCPKJ0wLafGwXYeN50glIONS9qzc0iw2L1tFgue2Chc057UQ4kD4i41CAiMK/m9T7j\n\tVUvUW9d0oS/i859gkab4MWakkKqGcvGmbPSdjtgoFEs/ITN2G+u2M2UpM1zhglWV2n\n\t9laYp9XQvM80A==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1657609307;\n\tbh=0yR1AybF5jXeOIJRIvpfohgWuLeVWJXlqPCsZHJyfsc=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=eAmx7kTh12EucbUttnVyZFXV3nlddlZh+viEQQ9d85B7WlmtLa7pmiuIlYd4WziXb\n\tCSVEUszpA/IcjXVhxSglwNLFdiv6mXC/FkljNpvvDnpWyeEAjC3zNB3BORwYE9PezV\n\tjRGwI1eReS5//PCwQWBmBnSL0sV19goSj0Jlz5gM="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"eAmx7kTh\"; dkim-atps=neutral","Date":"Tue, 12 Jul 2022 16:01:38 +0900","To":"Florian Sylvestre ","Message-ID":"<20220712070138.GA2364006@pyrite.rasen.tech>","References":"<20220622151918.451635-1-fsylvestre@baylibre.com>\n\t<20220622151918.451635-2-fsylvestre@baylibre.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=us-ascii","Content-Disposition":"inline","In-Reply-To":"<20220622151918.451635-2-fsylvestre@baylibre.com>","Subject":"Re: [libcamera-devel] [PATCH 1/5] libcamera: yaml_parser: Add\n\tgetList() function","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":"Paul Elder via libcamera-devel ","Reply-To":"paul.elder@ideasonboard.com","Cc":"libcamera-devel@lists.libcamera.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}},{"id":23845,"web_url":"https://patchwork.libcamera.org/comment/23845/","msgid":"","date":"2022-07-12T22:36:16","subject":"Re: [libcamera-devel] [PATCH 1/5] libcamera: yaml_parser: Add\n\tgetList() function","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hello,\n\nOn Tue, Jul 12, 2022 at 04:01:38PM +0900, Paul Elder via libcamera-devel wrote:\n> On Wed, Jun 22, 2022 at 05:19:14PM +0200, Florian Sylvestre via libcamera-devel wrote:\n> > Allow to retrieve a YAML list of any already supported types in a std::vector.\n> > \n> > Signed-off-by: Florian Sylvestre \n> > ---\n> > include/libcamera/internal/yaml_parser.h | 16 ++++++\n> > src/libcamera/yaml_parser.cpp | 73 ++++++++++++++++++++++++\n> > test/yaml-parser.cpp | 6 ++\n> > 3 files changed, 95 insertions(+)\n> > \n> > diff --git a/include/libcamera/internal/yaml_parser.h b/include/libcamera/internal/yaml_parser.h\n> > index 064cf443..ea9189bd 100644\n> > --- a/include/libcamera/internal/yaml_parser.h\n> > +++ b/include/libcamera/internal/yaml_parser.h\n> > @@ -167,6 +167,22 @@ public:\n> > #endif\n> > \tT get(const T &defaultValue, bool *ok = nullptr) const;\n> > \n> > +#ifndef __DOXYGEN__\n> > +\ttemplate > +\t\t typename std::enable_if_t<\n> > +\t\t\t std::is_same::value ||\n> > +\t\t\t std::is_same::value ||\n> > +\t\t\t std::is_same::value ||\n> > +\t\t\t std::is_same::value ||\n> > +\t\t\t std::is_same::value ||\n> > +\t\t\t std::is_same::value ||\n> > +\t\t\t std::is_same::value ||\n> > +\t\t\t std::is_same::value> * = nullptr>\n> \n> Should these be is_same_v ?\n\nYes, now that we use C++17, is_same_v is a nice shortcut.\n\n> Otherwise, looks good.\n> \n> Reviewed-by: Paul Elder \n> \n> > +#else\n> > +\ttemplate\n> > +#endif\n> > +\tstd::vector getList(bool *ok = nullptr) const;\n> > +\n> > \tDictAdapter asDict() const { return DictAdapter{ dictionary_ }; }\n> > \tListAdapter asList() const { return ListAdapter{ list_ }; }\n> > \n> > diff --git a/src/libcamera/yaml_parser.cpp b/src/libcamera/yaml_parser.cpp\n> > index 5c45e44e..95c0038b 100644\n> > --- a/src/libcamera/yaml_parser.cpp\n> > +++ b/src/libcamera/yaml_parser.cpp\n> > @@ -117,6 +117,23 @@ std::size_t YamlObject::size() const\n> > * \\return Value as a bool type\n> > */\n> > \n> > +/**\n> > + * \\fn template YamlObject::getList(\n> > + *\tbool *ok) const\n\nNo need for a line wrap.\n\n> > + * \\brief Parse the YamlObject as a list of \\a T.\n\ns/.$//\n\n> > + * \\param[out] ok The result of whether the parse succeeded\n> > + *\n> > + * This function parses the value of the YamlObject as a list of \\a T objects,\n> > + * and returns the value as a \\a std::vector. If parsing fails \\a ok is set\n> > + * to false and a default empty vector is returned. Otherwise, the\n> > + * YamlObject list of values is returned, and \\a ok is set to true.\n> > + *\n> > + * The \\a ok pointer is optional and can be a nullptr if the caller doesn't\n> > + * need to know if parsing succeeded.\n> > + *\n> > + * \\return Value as a std::vector type\n> > + */\n\nThis should go just before the YamlObject::getList() function (with an\nadditional #ifndef __DOXYGEN__ block for the function itself).\n\n> > +\n> > #ifndef __DOXYGEN__\n> > \n> > template<>\n> > @@ -323,6 +340,62 @@ Size YamlObject::get(const Size &defaultValue, bool *ok) const\n> > \treturn Size(width, height);\n> > }\n> > \n> > +template > +\t typename std::enable_if_t<\n> > +\t\t std::is_same::value ||\n> > +\t\t std::is_same::value ||\n> > +\t\t std::is_same::value ||\n> > +\t\t std::is_same::value ||\n> > +\t\t std::is_same::value ||\n> > +\t\t std::is_same::value ||\n> > +\t\t std::is_same::value ||\n> > +\t\t std::is_same::value> *>\n> > +std::vector YamlObject::getList(bool *ok) const\n> > +{\n> > +\tsetOk(ok, false);\n> > +\n> > +\tstd::vector defaultValue;\n> > +\n> > +\tif (type_ != Type::List)\n> > +\t\treturn defaultValue;\n\n\t\treturn {};\n\nand the same below, and drop the defaultValue variable.\n\n> > +\n> > +\tstd::vector value = std::vector(list_.size());\n\nThis will initialize all the entries in the vector, while you overwrite\nthem all later. I would do\n\n\tstd::vector value;\n\tvalue.reserve(list_.size());\n\n> > +\n> > +\t/*\n> > +\t * Provide somme dummy defaultValue to get() function\n> > +\t * and rely on the ok variable to know if the parsing\n> > +\t * was correct.\n\nI know I usually ask for line to be wrapped, but here you can expand to\nthe 80 columns limit ;-)\n\n> > +\t */\n> > +\tT defaultArgument = T();\n\nRename this to defaultValue, and you can write\n\n\tT defaultArgument{};\n\nwhich avoid separate default contruction (T()) and copy construction\n(=) (it only makes a difference for std::string and Size).\n\n> > +\tbool result;\n\nYou can move the variable inside the loop.\n\n> > +\tfor (unsigned int i = 0; i < list_.size(); ++i) {\n> > +\t\tresult = true;\n\n\t\tbool result;\n\n(no need to initialize it)\n\n> > +\t\tvalue[i] = list_[i]->get(defaultArgument, &result);\n\nAnd here, to match the reserve() call,\n\n\t\tvalue.emplace_back(list_[i]->get(defaultArgument, &result));\n\nThis allows using a for range loop:\n\n\tfor (const YamlObject &entry : asList()) {\n\t\tbool result;\n\t\tvalue.emplace_back(entry.get(defaultArgument, &result));\n\t\tif (!result)\n\t\t\treturn defaultValue;\n\t}\n\n> > +\n> > +\t\tif (!result)\n> > +\t\t\treturn defaultValue;\n> > +\t}\n> > +\n> > +\tsetOk(ok, true);\n> > +\treturn value;\n> > +}\n> > +\n> > +template std::vector YamlObject::getList(bool *ok) const;\n> > +\n> > +template std::vector YamlObject::getList(bool *ok) const;\n> > +\n> > +template std::vector YamlObject::getList(bool *ok) const;\n> > +\n> > +template std::vector YamlObject::getList(bool *ok) const;\n> > +\n> > +template std::vector YamlObject::getList(bool *ok) const;\n> > +\n> > +template std::vector YamlObject::getList(bool *ok) const;\n> > +\n> > +template std::vector YamlObject::getList(bool *ok) const;\n> > +\n\nYou can drop all the blank lines.\n\n> > +template std::vector YamlObject::getList(bool *ok) const;\n> > +\n> > #endif /* __DOXYGEN__ */\n> > \n> > /**\n> > diff --git a/test/yaml-parser.cpp b/test/yaml-parser.cpp\n> > index 38f84823..bb96a11b 100644\n> > --- a/test/yaml-parser.cpp\n> > +++ b/test/yaml-parser.cpp\n> > @@ -524,6 +524,12 @@ protected:\n> > \t\t\treturn TestFail;\n> > \t\t}\n> > \n> > +\t\tstd::vector values = firstElement.getList();\n> > +\t\tif (values.size() != 2 || values[0] != 1 || values[1] != 2) {\n> > +\t\t\tcerr << \"getList() failed to return correct vector\" << std::endl;\n> > +\t\t\treturn TestFail;\n> > +\t\t}\n> > +\n> > \t\tauto &secondElement = level2Obj[1];\n> > \t\tif (!secondElement.isDictionary() ||\n> > \t\t !secondElement.contains(\"one\") ||","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 38FA2BD1F1\n\tfor ;\n\tTue, 12 Jul 2022 22:36:49 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 800CC6330F;\n\tWed, 13 Jul 2022 00:36:48 +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 97D8860401\n\tfor ;\n\tWed, 13 Jul 2022 00:36:46 +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 D94806C8;\n\tWed, 13 Jul 2022 00:36:45 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1657665408;\n\tbh=2Zrs2n0JckFsEJN2m1n1gJqdQ2F+R7izosu3Bmd3TPw=;\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:Cc:\n\tFrom;\n\tb=hMNXlwDWKm+oxZJLjTKJdfvEsVy72gOJxwKKPvNsZiTNlvcexIl4RnOQvk48Ly0Mv\n\tGVyeNnXGh6JRayWgJzb0WiJJGVUYgPIwGXUVOSCjncwWTAbs8Fv7XdZE8VFz8Wiuw6\n\t52a6IKdiTH+aBe03cFpmzZ5XXts5UfYbXSpty2Fv+N/Av/4Z2cdrYYRVfJBrXpF68Q\n\t2twauSFD7UqFUzWFC7c/qIxUpfbfHBSmMGOjPffX8yofR3sr/YC8PG02lXFq24vf07\n\tWiNnK1UixLueuXkWdLBsG/10aNjMiVgeFS1bfDf6H2q4c0gyANGhd+lsmc27NtfgDS\n\twKGBXxLdLvdug==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1657665406;\n\tbh=2Zrs2n0JckFsEJN2m1n1gJqdQ2F+R7izosu3Bmd3TPw=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=e48FxEQWKtZ2wie0Ouy7D/ifyk4C5NJF33Wja2BywjF4f0Zj9zplnRnyUuSjnm9m5\n\tpMV2mRphbRHk0CZ4As7NotMJU+hPA9QjIBcrrhieJVk0bpXguhjjwsOF2QkyKmmj08\n\tydDJECc8sM9PUwkqZV0/MlNKH0O9t5/+MCAZ0M+E="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"e48FxEQW\"; dkim-atps=neutral","Date":"Wed, 13 Jul 2022 01:36:16 +0300","To":"paul.elder@ideasonboard.com","Message-ID":"","References":"<20220622151918.451635-1-fsylvestre@baylibre.com>\n\t<20220622151918.451635-2-fsylvestre@baylibre.com>\n\t<20220712070138.GA2364006@pyrite.rasen.tech>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20220712070138.GA2364006@pyrite.rasen.tech>","Subject":"Re: [libcamera-devel] [PATCH 1/5] libcamera: yaml_parser: Add\n\tgetList() function","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":"Laurent Pinchart via libcamera-devel\n\t","Reply-To":"Laurent Pinchart ","Cc":"libcamera-devel@lists.libcamera.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]