From patchwork Mon Aug 9 16:14:25 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kieran Bingham X-Patchwork-Id: 13268 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 33B00BD87D for ; Mon, 9 Aug 2021 16:14:31 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 96B636884F; Mon, 9 Aug 2021 18:14:30 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="gHojTycH"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 272EF60269 for ; Mon, 9 Aug 2021 18:14:29 +0200 (CEST) Received: from Monstersaurus.local (cpc89244-aztw30-2-0-cust3082.18-1.cable.virginm.net [86.31.172.11]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id B4E6A466; Mon, 9 Aug 2021 18:14:28 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1628525668; bh=/It9OcDXwR1pMOqaZdHbRyvBt27tX2iKv6Dg2lBhTvY=; h=From:To:Cc:Subject:Date:From; b=gHojTycHMZF3WmfHJBiAYzuCpzsqisij6MOclD+Pd37gePpmmcSmiCfQJMPP5cKCp rOPfNcrvOQEk4DFU/rmhXSqVhuw1P1YhwUri04ZanYprZqKPTBUsQC9jLzrLa35/tR PvNjUgz5g+Tgi+R3SnJeiCdAyZ60kRwBpesy5RDQ= From: Kieran Bingham To: libcamera devel Date: Mon, 9 Aug 2021 17:14:25 +0100 Message-Id: <20210809161425.1885984-1-kieran.bingham@ideasonboard.com> X-Mailer: git-send-email 2.30.2 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v2] clang-format: Regroup sort orders X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" Utilise the clang-format header sort to provide a regex based pattern match for our header inclusion coding style. Signed-off-by: Kieran Bingham Reviewed-by: Jean-Michel Hautbois Reviewed-by: Laurent Pinchart --- A sample of all headers from the project (+ a couple of extra tests) parsed through this can be seen at https://paste.ubuntu.com/p/Bt87C6M77y/ This was generated by: git grep -h "^#include" | sort | uniq > all-headers.cpp git add all-headers.cpp git commit all-headers.cpp -m "Header Test" ./utils/checkstyle.py | patch -p0 While some false positives are visible in this list (for instance in c/system headers section) this provides a great deal of the checks automatically, and the remaining cases may have to be spotted during review. .clang-format | 49 +++++++++++++++++++++++++++++++--- Documentation/coding-style.rst | 20 +++++++++++--- 2 files changed, 62 insertions(+), 7 deletions(-) diff --git a/.clang-format b/.clang-format index 3a8a896e373d..56cfbfa1bec4 100644 --- a/.clang-format +++ b/.clang-format @@ -66,10 +66,53 @@ ExperimentalAutoDetectBinPacking: false FixNamespaceComments: true ForEachMacros: - 'udev_list_entry_foreach' -IncludeBlocks: Preserve +SortIncludes: true +IncludeBlocks: Regroup IncludeCategories: - - Regex: '.*' - Priority: 1 + # Headers matching the name of the component are matched automatically. + # Priority 1 + # Headers in <> with an extension. (+system libraries) + - Regex: '<([A-Za-z0-9\-_])+\.h>' + Priority: 2 + - Regex: '' + Priority: 2 + # Qt includes (match before C++ standard library) + - Regex: '' + Priority: 10 + CaseSensitive: true + # C++ standard library includes (no extension) + - Regex: '<([A-Za-z0-9\-_/])+>' + Priority: 3 + # Linux headers, as a second group/subset of system headers + - Regex: '' + Priority: 4 + # Headers for libcamera Base support + - Regex: '' + Priority: 5 + - Regex: '' + Priority: 6 + # Public API Headers for libcamera, which are not in a subdir (i.e. ipa/,internal/) + - Regex: '' + Priority: 7 + # IPA Interfaces + - Regex: '' + Priority: 8 + # libcamera Internal headers in "" + - Regex: '"libcamera/internal/.*\.h"' + Priority: 9 + # Other libraries headers with one group per library (.h or .hpp) + - Regex: '<.*/.*\.hp*>' + Priority: 10 + # local modular includes "path/file.h" (.h or .hpp) + - Regex: '"(.*/)+.*\.hp*"' + Priority: 11 + # Other local headers "file.h" with extension (.h or .hpp) + - Regex: '".*.hp*"' + Priority: 12 + # Any unmatched line, separated from the last group + - Regex: '"*"' + Priority: 100 + IncludeIsMainRegex: '(_test)?$' IndentCaseLabels: false IndentPPDirectives: None diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst index 30c1778ed8bf..e4f1bb26024e 100644 --- a/Documentation/coding-style.rst +++ b/Documentation/coding-style.rst @@ -70,19 +70,31 @@ macro. For .cpp files, if the file implements an API declared in a header file, that header file shall be included first in order to ensure it is self-contained. +While the following list is extensive, it documents the expected behaviour +defined by the clang-format configuraiton and tooling should assist with +ordering. + The headers shall be grouped and ordered as follows: 1. The header declaring the API being implemented (if any) -2. The C and C++ system and standard library headers -3. Other libraries' headers, with one group per library -4. Other project's headers +2. The C standard library and system headers +3. The C++ standard library headers +4. Linux kernel headers +5. The libcamera base private header if required +6. The libcamera base library headers +7. The libcamera public API headers +8. The libcamera IPA interfaces +9. The internal libcamera headers +10. Other libraries' headers, with one group per library +11. Local headers grouped by subdirectory +12. Any local headers Groups of headers shall be separated by a single blank line. Headers within each group shall be sorted alphabetically. System and library headers shall be included with angle brackets. Project headers shall be included with angle brackets for the libcamera public API -headers, and with double quotes for other libcamera headers. +headers, and with double quotes for internal libcamera headers. C++ Specific Rules