[{"id":22731,"web_url":"https://patchwork.libcamera.org/comment/22731/","msgid":"","date":"2022-04-19T10:15:00","subject":"Re: [libcamera-devel] [PATCH v2] libcamera: Add operator<< for\n\tclasses in geometry","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Han-Lin,\n\nThank you for the patch.\n\nOn Mon, Apr 18, 2022 at 08:19:09PM +0800, Han-Lin Chen via libcamera-devel wrote:\n> Add operator<< for geometry classes for easier logging.\n> \n> Signed-off-by: Han-Lin Chen \n> ---\n> include/libcamera/geometry.h | 8 +++++\n> src/libcamera/geometry.cpp | 57 +++++++++++++++++++++++++++++++-----\n> 2 files changed, 57 insertions(+), 8 deletions(-)\n> \n> diff --git a/include/libcamera/geometry.h b/include/libcamera/geometry.h\n> index 7838b679..d4a144bc 100644\n> --- a/include/libcamera/geometry.h\n> +++ b/include/libcamera/geometry.h\n> @@ -46,6 +46,8 @@ static inline bool operator!=(const Point &lhs, const Point &rhs)\n> \treturn !(lhs == rhs);\n> }\n> \n> +std::ostream &operator<<(std::ostream &out, const Point &p);\n> +\n> class Size\n> {\n> public:\n> @@ -192,6 +194,8 @@ static inline bool operator>=(const Size &lhs, const Size &rhs)\n> \treturn !(lhs < rhs);\n> }\n> \n> +std::ostream &operator<<(std::ostream &out, const Size &s);\n> +\n> class SizeRange\n> {\n> public:\n> @@ -232,6 +236,8 @@ static inline bool operator!=(const SizeRange &lhs, const SizeRange &rhs)\n> \treturn !(lhs == rhs);\n> }\n> \n> +std::ostream &operator<<(std::ostream &out, const SizeRange &sr);\n> +\n> class Rectangle\n> {\n> public:\n> @@ -291,4 +297,6 @@ static inline bool operator!=(const Rectangle &lhs, const Rectangle &rhs)\n> \treturn !(lhs == rhs);\n> }\n> \n> +std::ostream &operator<<(std::ostream &out, const Rectangle &r);\n> +\n> } /* namespace libcamera */\n> diff --git a/src/libcamera/geometry.cpp b/src/libcamera/geometry.cpp\n> index cb3c2de1..a0696c51 100644\n> --- a/src/libcamera/geometry.cpp\n> +++ b/src/libcamera/geometry.cpp\n> @@ -56,8 +56,7 @@ namespace libcamera {\n> const std::string Point::toString() const\n> {\n> \tstd::stringstream ss;\n> -\n> -\tss << \"(\" << x << \",\" << y << \")\";\n> +\tss << *this;\n> \n> \treturn ss.str();\n> }\n> @@ -83,6 +82,16 @@ bool operator==(const Point &lhs, const Point &rhs)\n> * \\return True if the two points are not equal, false otherwise\n> */\n> \n> +/**\n> + * \\brief Insert operation for Point with ostream\n\nWould\n\n * \\brief Insert a Point into an output stream\n\nor\n\n * \\brief Insert a text representation of a Point into an output stream\n\nbe clearer ?\n\nYou also need to document the arguments\n\n * \\param[in] out The output stream\n * \\param[in] p The point\n\nSame below.\n\nReviewed-by: Laurent Pinchart \n\n> + * \\return The input std::ostream\n> + */\n> +std::ostream &operator<<(std::ostream &out, const Point &p)\n> +{\n> +\tout << \"(\" << p.x << \", \" << p.y << \")\";\n> +\treturn out;\n> +}\n> +\n> /**\n> * \\struct Size\n> * \\brief Describe a two-dimensional size\n> @@ -124,7 +133,10 @@ bool operator==(const Point &lhs, const Point &rhs)\n> */\n> const std::string Size::toString() const\n> {\n> -\treturn std::to_string(width) + \"x\" + std::to_string(height);\n> +\tstd::stringstream ss;\n> +\tss << *this;\n> +\n> +\treturn ss.str();\n> }\n> \n> /**\n> @@ -428,6 +440,16 @@ bool operator<(const Size &lhs, const Size &rhs)\n> * \\sa bool operator<(const Size &lhs, const Size &rhs)\n> */\n> \n> +/**\n> + * \\brief Insert operation for Size with ostream\n> + * \\return The input std::ostream\n> + */\n> +std::ostream &operator<<(std::ostream &out, const Size &s)\n> +{\n> +\tout << s.width << \"x\" << s.height;\n> +\treturn out;\n> +}\n> +\n> /**\n> * \\struct SizeRange\n> * \\brief Describe a range of sizes\n> @@ -528,9 +550,7 @@ bool SizeRange::contains(const Size &size) const\n> std::string SizeRange::toString() const\n> {\n> \tstd::stringstream ss;\n> -\n> -\tss << \"(\" << min.toString() << \")-(\" << max.toString() << \")/(+\"\n> -\t << hStep << \",+\" << vStep << \")\";\n> +\tss << *this;\n> \n> \treturn ss.str();\n> }\n> @@ -550,6 +570,18 @@ bool operator==(const SizeRange &lhs, const SizeRange &rhs)\n> * \\return True if the two size ranges are not equal, false otherwise\n> */\n> \n> +/**\n> + * \\brief Insert operation for SizeRange with ostream\n> + * \\return The input std::ostream\n> + */\n> +std::ostream &operator<<(std::ostream &out, const SizeRange &sr)\n> +{\n> +\tout << \"(\" << sr.min << \")-(\" << sr.max << \")/(+\"\n> +\t << sr.hStep << \",+\" << sr.vStep << \")\";\n> +\n> +\treturn out;\n> +}\n> +\n> /**\n> * \\struct Rectangle\n> * \\brief Describe a rectangle's position and dimensions\n> @@ -624,8 +656,7 @@ bool operator==(const SizeRange &lhs, const SizeRange &rhs)\n> const std::string Rectangle::toString() const\n> {\n> \tstd::stringstream ss;\n> -\n> -\tss << \"(\" << x << \"x\" << y << \")/\" << width << \"x\" << height;\n> +\tss << *this;\n> \n> \treturn ss.str();\n> }\n> @@ -796,4 +827,14 @@ bool operator==(const Rectangle &lhs, const Rectangle &rhs)\n> * \\return True if the two rectangles are not equal, false otherwise\n> */\n> \n> +/**\n> + * \\brief Insert operation for Rectangle with ostream\n> + * \\return The input std::ostream\n> + */\n> +std::ostream &operator<<(std::ostream &out, const Rectangle &r)\n> +{\n> +\tout << \"(\" << r.x << \", \" << r.y << \")/\" << r.width << \"x\" << r.height;\n> +\treturn out;\n> +}\n> +\n> } /* namespace libcamera */","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 DAB51C0F1B\n\tfor ;\n\tTue, 19 Apr 2022 10:15:04 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 35FFC65642;\n\tTue, 19 Apr 2022 12:15:04 +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 CB9FB6563C\n\tfor ;\n\tTue, 19 Apr 2022 12:15:02 +0200 (CEST)","from pendragon.ideasonboard.com (85-76-66-170-nat.elisa-mobile.fi\n\t[85.76.66.170])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 9E529305;\n\tTue, 19 Apr 2022 12:15:01 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1650363304;\n\tbh=mHPPjxg2vtLzgQ4idMwBBax2AiT8gXgzfFC/6ckDtQQ=;\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=H3BBkBKG83yy/1/vkkYcQWGwEFMJ6rYkaKfyeCOkb96xiZ36hPZsBG160/EvMCCpj\n\tM79+7PC2NQNljQeo1696wsTU2i3M9rpU08t8dSyqvxKfVk0xN26iEujUG2jh2sZshw\n\toxr9h/b7tREyXgqy6uM55nQL/ByieagwT5SraJdKVcx18uFtEcPhmVHsCJ/oux+dKn\n\tl4lap7VfOAlrroKWIkazR91il/guZzXFBq1xH86grLkTQ+92NkzqXMT9PQZsElErnx\n\t2GRdJ4/1G0Ux2KaT5Vb706nxAE7IcJzBaiYQzELX2WxnZRB7Z8Fiy3iRbsE3zgmCsr\n\thMT1+2MswgryA==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1650363302;\n\tbh=mHPPjxg2vtLzgQ4idMwBBax2AiT8gXgzfFC/6ckDtQQ=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=QkskciTPNgTCG2ElKCGQ81Styim/U+Uhq1iEYQkVx4Fh4J0r8VsxgGicyKPXtrIH1\n\ts73EBS0OkXyHJLM022KJoLpjg8r7OJVPXCzaqHIK8zEyGjWPSLR8JZEwlH5M8BxFtV\n\tgfANiJqdu6RTEGhi9jOUoTLVIZniZM6SovnEtNJ4="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"QkskciTP\"; dkim-atps=neutral","Date":"Tue, 19 Apr 2022 13:15:00 +0300","To":"Han-Lin Chen ","Message-ID":"","References":"<20220418121909.470519-1-hanlinchen@chromium.org>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20220418121909.470519-1-hanlinchen@chromium.org>","Subject":"Re: [libcamera-devel] [PATCH v2] libcamera: Add operator<< for\n\tclasses in geometry","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\" "}},{"id":22732,"web_url":"https://patchwork.libcamera.org/comment/22732/","msgid":"<165036489642.2548121.1580470039544395114@Monstersaurus>","date":"2022-04-19T10:41:36","subject":"Re: [libcamera-devel] [PATCH v2] libcamera: Add operator<< for\n\tclasses in geometry","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Hi Han-lin,\n\nQuoting Han-Lin Chen via libcamera-devel (2022-04-18 13:19:09)\n> Add operator<< for geometry classes for easier logging.\n> \n\nI can't remember which thread I said it on - but yes I like this ;-)\nI'd rather use << object << than << object.toString() << in debug.\n\nI think it produces more idiomatic C++.\n\n\n> Signed-off-by: Han-Lin Chen \n> ---\n> include/libcamera/geometry.h | 8 +++++\n> src/libcamera/geometry.cpp | 57 +++++++++++++++++++++++++++++++-----\n> 2 files changed, 57 insertions(+), 8 deletions(-)\n> \n> diff --git a/include/libcamera/geometry.h b/include/libcamera/geometry.h\n> index 7838b679..d4a144bc 100644\n> --- a/include/libcamera/geometry.h\n> +++ b/include/libcamera/geometry.h\n> @@ -46,6 +46,8 @@ static inline bool operator!=(const Point &lhs, const Point &rhs)\n> return !(lhs == rhs);\n> }\n> \n> +std::ostream &operator<<(std::ostream &out, const Point &p);\n> +\n> class Size\n> {\n> public:\n> @@ -192,6 +194,8 @@ static inline bool operator>=(const Size &lhs, const Size &rhs)\n> return !(lhs < rhs);\n> }\n> \n> +std::ostream &operator<<(std::ostream &out, const Size &s);\n> +\n> class SizeRange\n> {\n> public:\n> @@ -232,6 +236,8 @@ static inline bool operator!=(const SizeRange &lhs, const SizeRange &rhs)\n> return !(lhs == rhs);\n> }\n> \n> +std::ostream &operator<<(std::ostream &out, const SizeRange &sr);\n> +\n> class Rectangle\n> {\n> public:\n> @@ -291,4 +297,6 @@ static inline bool operator!=(const Rectangle &lhs, const Rectangle &rhs)\n> return !(lhs == rhs);\n> }\n> \n> +std::ostream &operator<<(std::ostream &out, const Rectangle &r);\n> +\n> } /* namespace libcamera */\n> diff --git a/src/libcamera/geometry.cpp b/src/libcamera/geometry.cpp\n> index cb3c2de1..a0696c51 100644\n> --- a/src/libcamera/geometry.cpp\n> +++ b/src/libcamera/geometry.cpp\n> @@ -56,8 +56,7 @@ namespace libcamera {\n> const std::string Point::toString() const\n> {\n> std::stringstream ss;\n> -\n> - ss << \"(\" << x << \",\" << y << \")\";\n> + ss << *this;\n> \n> return ss.str();\n> }\n> @@ -83,6 +82,16 @@ bool operator==(const Point &lhs, const Point &rhs)\n> * \\return True if the two points are not equal, false otherwise\n> */\n> \n> +/**\n> + * \\brief Insert operation for Point with ostream\n\nAha - I was going to complain here, that it sounds like an instruction\n'we will insert an operation here for Point with ostream' - but I've\njust learnt that operator<< is the insertion operator. (And >> is the\n'extraction' operator).\n\nI might suggest a small addition to make the sentence more complete:\n\n\"Insert operation for a Point with an ostream\"\n\nBut it's optional - would apply to other uses too of course.\n\n\n> + * \\return The input std::ostream\n\n'The input ostream' sounds odd here.\n\nHow about\n\n\\return The output stream \\a out\n\n> + */\n> +std::ostream &operator<<(std::ostream &out, const Point &p)\n> +{\n> + out << \"(\" << p.x << \", \" << p.y << \")\";\n> + return out;\n> +}\n> +\n> /**\n> * \\struct Size\n> * \\brief Describe a two-dimensional size\n> @@ -124,7 +133,10 @@ bool operator==(const Point &lhs, const Point &rhs)\n> */\n> const std::string Size::toString() const\n> {\n> - return std::to_string(width) + \"x\" + std::to_string(height);\n> + std::stringstream ss;\n> + ss << *this;\n> +\n> + return ss.str();\n> }\n> \n> /**\n> @@ -428,6 +440,16 @@ bool operator<(const Size &lhs, const Size &rhs)\n> * \\sa bool operator<(const Size &lhs, const Size &rhs)\n> */\n> \n> +/**\n> + * \\brief Insert operation for Size with ostream\n> + * \\return The input std::ostream\n> + */\n> +std::ostream &operator<<(std::ostream &out, const Size &s)\n> +{\n> + out << s.width << \"x\" << s.height;\n> + return out;\n> +}\n> +\n> /**\n> * \\struct SizeRange\n> * \\brief Describe a range of sizes\n> @@ -528,9 +550,7 @@ bool SizeRange::contains(const Size &size) const\n> std::string SizeRange::toString() const\n> {\n> std::stringstream ss;\n> -\n> - ss << \"(\" << min.toString() << \")-(\" << max.toString() << \")/(+\"\n> - << hStep << \",+\" << vStep << \")\";\n> + ss << *this;\n> \n> return ss.str();\n> }\n> @@ -550,6 +570,18 @@ bool operator==(const SizeRange &lhs, const SizeRange &rhs)\n> * \\return True if the two size ranges are not equal, false otherwise\n> */\n> \n> +/**\n> + * \\brief Insert operation for SizeRange with ostream\n> + * \\return The input std::ostream\n> + */\n> +std::ostream &operator<<(std::ostream &out, const SizeRange &sr)\n> +{\n> + out << \"(\" << sr.min << \")-(\" << sr.max << \")/(+\"\n> + << sr.hStep << \",+\" << sr.vStep << \")\";\n> +\n> + return out;\n> +}\n> +\n> /**\n> * \\struct Rectangle\n> * \\brief Describe a rectangle's position and dimensions\n> @@ -624,8 +656,7 @@ bool operator==(const SizeRange &lhs, const SizeRange &rhs)\n> const std::string Rectangle::toString() const\n> {\n> std::stringstream ss;\n> -\n> - ss << \"(\" << x << \"x\" << y << \")/\" << width << \"x\" << height;\n\nI see this is changed to a ','. That sounds like a bug fix, which is\ncorrect - but shouldn't be hidden in this large patch. Please split it\nto either before or after this patch.\n\n\nWith all of that I think you can also add this to your next revision\n\nReviewed-by: Kieran Bingham \n\n> + ss << *this;\n> \n> return ss.str();\n> }\n> @@ -796,4 +827,14 @@ bool operator==(const Rectangle &lhs, const Rectangle &rhs)\n> * \\return True if the two rectangles are not equal, false otherwise\n> */\n> \n> +/**\n> + * \\brief Insert operation for Rectangle with ostream\n> + * \\return The input std::ostream\n> + */\n> +std::ostream &operator<<(std::ostream &out, const Rectangle &r)\n> +{\n> + out << \"(\" << r.x << \", \" << r.y << \")/\" << r.width << \"x\" << r.height;\n> + return out;\n> +}\n> +\n> } /* namespace libcamera */\n> -- \n> 2.36.0.rc0.470.gd361397f0d-goog\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 0C78EC3256\n\tfor ;\n\tTue, 19 Apr 2022 10:41:42 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 81B026563D;\n\tTue, 19 Apr 2022 12:41:41 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 739EB6563C\n\tfor ;\n\tTue, 19 Apr 2022 12:41:39 +0200 (CEST)","from pendragon.ideasonboard.com\n\t(cpc89244-aztw30-2-0-cust3082.18-1.cable.virginm.net [86.31.172.11])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id EC7BC305;\n\tTue, 19 Apr 2022 12:41:38 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1650364901;\n\tbh=cjJvAmlYxa+2smfKdJ3M2GlHEWFIe0FDtQXvDX9f90M=;\n\th=In-Reply-To:References:To:Date:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:\n\tFrom;\n\tb=J9vfZsZz2IiPTumjQXn8aa9mDrKVzScPxDIYX30wf/VLv35BZSpD+gnMVpF5CAmri\n\tBmaiGHkbNqUG0wQstT+a/JqoKTNkU7WuXCqkvfVDfH8scPXSdQN+XkWqVap6YnKDaY\n\tM66ciBdXArm5thpOkBCbvFhvZopjDbDwCw2IKS+7WSPd9CiNg2PFnnhgwwvfJQdHmA\n\toVHS5wt+MXY4pZMIUszr4xrvNfi4pHBqVT7qRv+IZ5vwBjqUYnh76bQ2vXOu/78fiP\n\tylCIEsGQTxPH04JEjJFU/cVRsVwfjeTSbs8PDEZJjr9Q0JMiDXelNPPmEolmc0cIW0\n\tvweiuVUXKnViw==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1650364899;\n\tbh=cjJvAmlYxa+2smfKdJ3M2GlHEWFIe0FDtQXvDX9f90M=;\n\th=In-Reply-To:References:Subject:From:To:Date:From;\n\tb=HIAVJLq1pNLi11IsnP56kkEFECF72C+1o7H0P87v1O8op3Rb7LoHPOMbHT480ncMv\n\tnYcS6tbkOmXb6pSX6iZK25UgiA0aXXyfZ8nnylcfTsGPZkRmzOFrSKN360ZT6BsZoU\n\tyU61l90y+XqVbLSdDdiwgONZvUMIi5kh/+2fekc4="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"HIAVJLq1\"; dkim-atps=neutral","Content-Type":"text/plain; charset=\"utf-8\"","MIME-Version":"1.0","Content-Transfer-Encoding":"quoted-printable","In-Reply-To":"<20220418121909.470519-1-hanlinchen@chromium.org>","References":"<20220418121909.470519-1-hanlinchen@chromium.org>","To":"Han-Lin Chen ,\n\tlibcamera-devel@lists.libcamera.org","Date":"Tue, 19 Apr 2022 11:41:36 +0100","Message-ID":"<165036489642.2548121.1580470039544395114@Monstersaurus>","User-Agent":"alot/0.10","Subject":"Re: [libcamera-devel] [PATCH v2] libcamera: Add operator<< for\n\tclasses in geometry","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":"Kieran Bingham via libcamera-devel\n\t","Reply-To":"Kieran Bingham ","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]