[{"id":2951,"web_url":"https://patchwork.libcamera.org/comment/2951/","msgid":"<20191023140853.GE4763@pendragon.ideasonboard.com>","date":"2019-10-23T14:08:53","subject":"Re: [libcamera-devel] [PATCH 3/4] utils: checkstyle.py: Add include\n\tchecker","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"This is missing a commit message, sorry :-S\n\nAdd an include checker to verify usage of the C compatibility headers.\n \nSigned-off-by: Laurent Pinchart \n\nOn Wed, Oct 23, 2019 at 04:52:57PM +0300, Laurent Pinchart wrote:\n> ---\n> utils/checkstyle.py | 32 ++++++++++++++++++++++++++++++++\n> 1 file changed, 32 insertions(+)\n> \n> diff --git a/utils/checkstyle.py b/utils/checkstyle.py\n> index 42a96f6d6102..335e58f5fddf 100755\n> --- a/utils/checkstyle.py\n> +++ b/utils/checkstyle.py\n> @@ -240,6 +240,38 @@ class StyleIssue(object):\n> self.msg = msg\n> \n> \n> +class IncludeChecker(StyleChecker):\n> + patterns = ('*.cpp', '*.h')\n> +\n> + headers = ('assert', 'ctype', 'errno', 'fenv', 'float', 'inttypes',\n> + 'limits', 'locale', 'math', 'setjmp', 'signal', 'stdarg',\n> + 'stddef', 'stdint', 'stdio', 'stdlib', 'string', 'time', 'uchar',\n> + 'wchar', 'wctype')\n> + include_regex = re.compile('^#include ')\n> +\n> + def __init__(self, content):\n> + super().__init__()\n> + self.__content = content\n> +\n> + def check(self, line_numbers):\n> + issues = []\n> +\n> + for line_number in line_numbers:\n> + line = self.__content[line_number - 1]\n> + match = IncludeChecker.include_regex.match(line)\n> + if not match:\n> + continue\n> +\n> + header = match.group(1)\n> + if header not in IncludeChecker.headers:\n> + continue\n> +\n> + issues.append(StyleIssue(line_number, line,\n> + 'C compatibility header <%s.h> is preferred' % header))\n> +\n> + return issues\n> +\n> +\n> class LogCategoryChecker(StyleChecker):\n> log_regex = re.compile('\\\\bLOG\\((Debug|Info|Warning|Error|Fatal)\\)')\n> patterns = ('*.cpp',)\n> -- \n> Regards,\n> \n> Laurent Pinchart\n> \n> _______________________________________________\n> libcamera-devel mailing list\n> libcamera-devel@lists.libcamera.org\n> https://lists.libcamera.org/listinfo/libcamera-devel","headers":{"Return-Path":"","Received":["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 2ADE86138B\n\tfor ;\n\tWed, 23 Oct 2019 16:08:59 +0200 (CEST)","from pendragon.ideasonboard.com (143.121.2.93.rev.sfr.net\n\t[93.2.121.143])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id B017A71F\n\tfor ;\n\tWed, 23 Oct 2019 16:08:58 +0200 (CEST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1571839738;\n\tbh=psGYhAki5lpkvd/0067S1SnLOPS3NIaCThbI4+LbzEE=;\n\th=Date:From:To:Subject:References:In-Reply-To:From;\n\tb=OYphK+yFXfmBsahkn0ua1XLobSVdS77NcvXHcf8WjYpLGVMGQeHv2im2PxXFZY441\n\tHtOIUSXznRh6LnKI5YQJGorSikdesrC8/78DpTjfGK8a7+7IhlApzbUCN1OlMfbYwQ\n\tp4C3OLYJtw2UdH3jb/gErS+x0G8+H4SQMn4hIfGc=","Date":"Wed, 23 Oct 2019 17:08:53 +0300","From":"Laurent Pinchart ","To":"libcamera-devel@lists.libcamera.org","Message-ID":"<20191023140853.GE4763@pendragon.ideasonboard.com>","References":"<20191023135258.32256-1-laurent.pinchart@ideasonboard.com>\n\t<20191023135258.32256-3-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20191023135258.32256-3-laurent.pinchart@ideasonboard.com>","User-Agent":"Mutt/1.10.1 (2018-07-13)","Subject":"Re: [libcamera-devel] [PATCH 3/4] utils: checkstyle.py: Add include\n\tchecker","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":"Wed, 23 Oct 2019 14:08:59 -0000"}},{"id":2952,"web_url":"https://patchwork.libcamera.org/comment/2952/","msgid":"<652ad819-cb95-c496-3efb-002fb0c475ff@ideasonboard.com>","date":"2019-10-23T14:10:26","subject":"Re: [libcamera-devel] [PATCH 3/4] utils: checkstyle.py: Add include\n\tchecker","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Hi Laurent,\n\nOn 23/10/2019 14:52, Laurent Pinchart wrote:\n\n ..insert commit log here.. ?\n\n ..insert SoB here..?\n\nWith the above populated,\n\nReviewed-by: <...insert tag here...>\n\n\n> ---\n> utils/checkstyle.py | 32 ++++++++++++++++++++++++++++++++\n> 1 file changed, 32 insertions(+)\n> \n> diff --git a/utils/checkstyle.py b/utils/checkstyle.py\n> index 42a96f6d6102..335e58f5fddf 100755\n> --- a/utils/checkstyle.py\n> +++ b/utils/checkstyle.py\n> @@ -240,6 +240,38 @@ class StyleIssue(object):\n> self.msg = msg\n> \n> \n> +class IncludeChecker(StyleChecker):\n> + patterns = ('*.cpp', '*.h')\n> +\n> + headers = ('assert', 'ctype', 'errno', 'fenv', 'float', 'inttypes',\n> + 'limits', 'locale', 'math', 'setjmp', 'signal', 'stdarg',\n> + 'stddef', 'stdint', 'stdio', 'stdlib', 'string', 'time', 'uchar',\n> + 'wchar', 'wctype')\n\nIs this an exhaustive list? (defined by the spec?) or will there\npotentially be later additions?\n\nI expect it's a full list, but I don't know where it's referenced from.\nMight be worth putting a reference to where the list was determined from\nif it was extracted from somewhere...\n\n\n> + include_regex = re.compile('^#include ')\n> +\n> + def __init__(self, content):\n> + super().__init__()\n> + self.__content = content\n> +\n\nI expect this is fine, and I think I recall other checkers do this - but\n/why/ do we store the content again for every checker, rather than parse\nit line by line?\n\n\n\n\n> + def check(self, line_numbers):\n> + issues = []\n> +\n> + for line_number in line_numbers:\n> + line = self.__content[line_number - 1]\n> + match = IncludeChecker.include_regex.match(line)\n> + if not match:\n> + continue\n> +\n> + header = match.group(1)\n> + if header not in IncludeChecker.headers:\n> + continue\n> +\n> + issues.append(StyleIssue(line_number, line,\n> + 'C compatibility header <%s.h> is preferred' % header))\n> +\n> + return issues\n> +\n> +\n> class LogCategoryChecker(StyleChecker):\n> log_regex = re.compile('\\\\bLOG\\((Debug|Info|Warning|Error|Fatal)\\)')\n> patterns = ('*.cpp',)\n>","headers":{"Return-Path":"","Received":["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 759836138B\n\tfor ;\n\tWed, 23 Oct 2019 16:10:29 +0200 (CEST)","from [192.168.0.20]\n\t(cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 056EB71F;\n\tWed, 23 Oct 2019 16:10:28 +0200 (CEST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1571839829;\n\tbh=gapdK9HPVS6HEuBXdmyjo3H5TKmuhBhPJcDxfWv3gUc=;\n\th=Reply-To:Subject:To:References:From:Date:In-Reply-To:From;\n\tb=CMJrGJvfUjNpJuR6JGdEEhzyenoap/2ciMws96C3WQE7mfa13TQeBwzVCMTUxdJXr\n\tTqfwUDG9Cn1JDTD7PQE5YmnHITtuxIoFE2Z7XmvYB3TNcez6CJBKh60JTCGgPrYl1l\n\trFLoeP0170YFWtcreVl6NkZhTJBtqTjOG1m8lBV0=","Reply-To":"kieran.bingham@ideasonboard.com","To":"Laurent Pinchart ,\n\tlibcamera-devel@lists.libcamera.org","References":"<20191023135258.32256-1-laurent.pinchart@ideasonboard.com>\n\t<20191023135258.32256-3-laurent.pinchart@ideasonboard.com>","From":"Kieran Bingham ","Openpgp":"preference=signencrypt","Autocrypt":"addr=kieran.bingham@ideasonboard.com; keydata=\n\tmQINBFYE/WYBEACs1PwjMD9rgCu1hlIiUA1AXR4rv2v+BCLUq//vrX5S5bjzxKAryRf0uHat\n\tV/zwz6hiDrZuHUACDB7X8OaQcwhLaVlq6byfoBr25+hbZG7G3+5EUl9cQ7dQEdvNj6V6y/SC\n\trRanWfelwQThCHckbobWiQJfK9n7rYNcPMq9B8e9F020LFH7Kj6YmO95ewJGgLm+idg1Kb3C\n\tpotzWkXc1xmPzcQ1fvQMOfMwdS+4SNw4rY9f07Xb2K99rjMwZVDgESKIzhsDB5GY465sCsiQ\n\tcSAZRxqE49RTBq2+EQsbrQpIc8XiffAB8qexh5/QPzCmR4kJgCGeHIXBtgRj+nIkCJPZvZtf\n\tKr2EAbc6tgg6DkAEHJb+1okosV09+0+TXywYvtEop/WUOWQ+zo+Y/OBd+8Ptgt1pDRyOBzL8\n\tRXa8ZqRf0Mwg75D+dKntZeJHzPRJyrlfQokngAAs4PaFt6UfS+ypMAF37T6CeDArQC41V3ko\n\tlPn1yMsVD0p+6i3DPvA/GPIksDC4owjnzVX9kM8Zc5Cx+XoAN0w5Eqo4t6qEVbuettxx55gq\n\t8K8FieAjgjMSxngo/HST8TpFeqI5nVeq0/lqtBRQKumuIqDg+Bkr4L1V/PSB6XgQcOdhtd36\n\tOe9X9dXB8YSNt7VjOcO7BTmFn/Z8r92mSAfHXpb07YJWJosQOQARAQABtDBLaWVyYW4gQmlu\n\tZ2hhbSA8a2llcmFuLmJpbmdoYW1AaWRlYXNvbmJvYXJkLmNvbT6JAlcEEwEKAEECGwMFCwkI\n\tBwIGFQgJCgsCBBYCAwECHgECF4ACGQEWIQSQLdeYP70o/eNy1HqhHkZyEKRh/QUCXWTtygUJ\n\tCyJXZAAKCRChHkZyEKRh/f8dEACTDsbLN2nioNZMwyLuQRUAFcXNolDX48xcUXsWS2QjxaPm\n\tVsJx8Uy8aYkS85mdPBh0C83OovQR/OVbr8AxhGvYqBs3nQvbWuTl/+4od7DfK2VZOoKBAu5S\n\tQK2FYuUcikDqYcFWJ8DQnubxfE8dvzojHEkXw0sA4igINHDDFX3HJGZtLio+WpEFQtCbfTAG\n\tYZslasz1YZRbwEdSsmO3/kqy5eMnczlm8a21A3fKUo3g8oAZEFM+f4DUNzqIltg31OAB/kZS\n\tenKZQ/SWC8PmLg/ZXBrReYakxXtkP6w3FwMlzOlhGxqhIRNiAJfXJBaRhuUWzPOpEDE9q5YJ\n\tBmqQL2WJm1VSNNVxbXJHpaWMH1sA2R00vmvRrPXGwyIO0IPYeUYQa3gsy6k+En/aMQJd27dp\n\taScf9am9PFICPY5T4ppneeJLif2lyLojo0mcHOV+uyrds9XkLpp14GfTkeKPdPMrLLTsHRfH\n\tfA4I4OBpRrEPiGIZB/0im98MkGY/Mu6qxeZmYLCcgD6qz4idOvfgVOrNh+aA8HzIVR+RMW8H\n\tQGBN9f0E3kfwxuhl3omo6V7lDw8XOdmuWZNC9zPq1UfryVHANYbLGz9KJ4Aw6M+OgBC2JpkD\n\thXMdHUkC+d20dwXrwHTlrJi1YNp6rBc+xald3wsUPOZ5z8moTHUX/uPA/qhGsbkCDQRWBP1m\n\tARAAzijkb+Sau4hAncr1JjOY+KyFEdUNxRy+hqTJdJfaYihxyaj0Ee0P0zEi35CbE6lgU0Uz\n\ttih9fiUbSV3wfsWqg1Ut3/5rTKu7kLFp15kF7eqvV4uezXRD3Qu4yjv/rMmEJbbD4cTvGCYI\n\td6MDC417f7vK3hCbCVIZSp3GXxyC1LU+UQr3fFcOyCwmP9vDUR9JV0BSqHHxRDdpUXE26Dk6\n\tmhf0V1YkspE5St814ETXpEus2urZE5yJIUROlWPIL+hm3NEWfAP06vsQUyLvr/GtbOT79vXl\n\tEn1aulcYyu20dRRxhkQ6iILaURcxIAVJJKPi8dsoMnS8pB0QW12AHWuirPF0g6DiuUfPmrA5\n\tPKe56IGlpkjc8cO51lIxHkWTpCMWigRdPDexKX+Sb+W9QWK/0JjIc4t3KBaiG8O4yRX8ml2R\n\t+rxfAVKM6V769P/hWoRGdgUMgYHFpHGSgEt80OKK5HeUPy2cngDUXzwrqiM5Sz6Od0qw5pCk\n\tNlXqI0W/who0iSVM+8+RmyY0OEkxEcci7rRLsGnM15B5PjLJjh1f2ULYkv8s4SnDwMZ/kE04\n\t/UqCMK/KnX8pwXEMCjz0h6qWNpGwJ0/tYIgQJZh6bqkvBrDogAvuhf60Sogw+mH8b+PBlx1L\n\toeTK396wc+4c3BfiC6pNtUS5GpsPMMjYMk7kVvEAEQEAAYkCPAQYAQoAJgIbDBYhBJAt15g/\n\tvSj943LUeqEeRnIQpGH9BQJdizzIBQkLSKZiAAoJEKEeRnIQpGH9eYgQAJpjaWNgqNOnMTmD\n\tMJggbwjIotypzIXfhHNCeTkG7+qCDlSaBPclcPGYrTwCt0YWPU2TgGgJrVhYT20ierN8LUvj\n\t6qOPTd+Uk7NFzL65qkh80ZKNBFddx1AabQpSVQKbdcLb8OFs85kuSvFdgqZwgxA1vl4TFhNz\n\tPZ79NAmXLackAx3sOVFhk4WQaKRshCB7cSl+RIng5S/ThOBlwNlcKG7j7W2MC06BlTbdEkUp\n\tECzuuRBv8wX4OQl+hbWbB/VKIx5HKlLu1eypen/5lNVzSqMMIYkkZcjV2SWQyUGxSwq0O/sx\n\tS0A8/atCHUXOboUsn54qdxrVDaK+6jIAuo8JiRWctP16KjzUM7MO0/+4zllM8EY57rXrj48j\n\tsbEYX0YQnzaj+jO6kJtoZsIaYR7rMMq9aUAjyiaEZpmP1qF/2sYenDx0Fg2BSlLvLvXM0vU8\n\tpQk3kgDu7kb/7PRYrZvBsr21EIQoIjXbZxDz/o7z95frkP71EaICttZ6k9q5oxxA5WC6sTXc\n\tMW8zs8avFNuA9VpXt0YupJd2ijtZy2mpZNG02fFVXhIn4G807G7+9mhuC4XG5rKlBBUXTvPU\n\tAfYnB4JBDLmLzBFavQfvonSfbitgXwCG3vS+9HEwAjU30Bar1PEOmIbiAoMzuKeRm2LVpmq4\n\tWZw01QYHU/GUV/zHJSFk","Organization":"Ideas on Board","Message-ID":"<652ad819-cb95-c496-3efb-002fb0c475ff@ideasonboard.com>","Date":"Wed, 23 Oct 2019 15:10:26 +0100","User-Agent":"Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101\n\tThunderbird/60.8.0","MIME-Version":"1.0","In-Reply-To":"<20191023135258.32256-3-laurent.pinchart@ideasonboard.com>","Content-Type":"text/plain; charset=utf-8","Content-Language":"en-GB","Content-Transfer-Encoding":"8bit","Subject":"Re: [libcamera-devel] [PATCH 3/4] utils: checkstyle.py: Add include\n\tchecker","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":"Wed, 23 Oct 2019 14:10:29 -0000"}}]