From 6fdb1bfbc7846f9978fe98c658deb440534d2ca0 Mon Sep 17 00:00:00 2001 From: nvartolomei Date: Thu, 9 Nov 2023 17:18:40 +0000 Subject: [PATCH] [clang-tidy] readability-identifier-naming: add support for concepts (#71586) Added support for C++20 ``concept`` declarations. --- .../readability/IdentifierNamingCheck.cpp | 4 ++ clang-tools-extra/docs/ReleaseNotes.rst | 1 + .../checks/readability/identifier-naming.rst | 41 +++++++++++++++++++ .../readability/identifier-naming.cpp | 10 +++++ 4 files changed, 56 insertions(+) diff --git a/clang-tools-extra/clang-tidy/readability/IdentifierNamingCheck.cpp b/clang-tools-extra/clang-tidy/readability/IdentifierNamingCheck.cpp index 7539b3899682e1..066057fa7208d5 100644 --- a/clang-tools-extra/clang-tidy/readability/IdentifierNamingCheck.cpp +++ b/clang-tools-extra/clang-tidy/readability/IdentifierNamingCheck.cpp @@ -124,6 +124,7 @@ namespace readability { m(TypeAlias) \ m(MacroDefinition) \ m(ObjcIvar) \ + m(Concept) \ enum StyleKind : int { #define ENUMERATE(v) SK_ ## v, @@ -1391,6 +1392,9 @@ StyleKind IdentifierNamingCheck::findStyleKind( return SK_Invalid; } + if (isa(D) && NamingStyles[SK_Concept]) + return SK_Concept; + return SK_Invalid; } diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst index fe8c7175d554c7..655b9a33c3b72a 100644 --- a/clang-tools-extra/docs/ReleaseNotes.rst +++ b/clang-tools-extra/docs/ReleaseNotes.rst @@ -399,6 +399,7 @@ Changes in existing checks ``Leading_upper_snake_case`` naming convention. The handling of ``typedef`` has been enhanced, particularly within complex types like function pointers and cases where style checks were omitted when functions started with macros. + Added support for C++20 ``concept`` declarations. - Improved :doc:`readability-implicit-bool-conversion ` check to take diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability/identifier-naming.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/identifier-naming.rst index 608bc2acdc0d5e..e36bbee394f17a 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/readability/identifier-naming.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/readability/identifier-naming.rst @@ -46,6 +46,7 @@ The following options are described below: - :option:`ClassConstantCase`, :option:`ClassConstantPrefix`, :option:`ClassConstantSuffix`, :option:`ClassConstantIgnoredRegexp`, :option:`ClassConstantHungarianPrefix` - :option:`ClassMemberCase`, :option:`ClassMemberPrefix`, :option:`ClassMemberSuffix`, :option:`ClassMemberIgnoredRegexp`, :option:`ClassMemberHungarianPrefix` - :option:`ClassMethodCase`, :option:`ClassMethodPrefix`, :option:`ClassMethodSuffix`, :option:`ClassMethodIgnoredRegexp` + - :option:`ConceptCase`, :option:`ConceptPrefix`, :option:`ConceptSuffix`, :option:`ConceptIgnoredRegexp` - :option:`ConstantCase`, :option:`ConstantPrefix`, :option:`ConstantSuffix`, :option:`ConstantIgnoredRegexp`, :option:`ConstantHungarianPrefix` - :option:`ConstantMemberCase`, :option:`ConstantMemberPrefix`, :option:`ConstantMemberSuffix`, :option:`ConstantMemberIgnoredRegexp`, :option:`ConstantMemberHungarianPrefix` - :option:`ConstantParameterCase`, :option:`ConstantParameterPrefix`, :option:`ConstantParameterSuffix`, :option:`ConstantParameterIgnoredRegexp`, :option:`ConstantParameterHungarianPrefix` @@ -410,6 +411,46 @@ After: int pre_class_member_post(); }; +.. option:: ConceptCase + + When defined, the check will ensure concept names conform to the + selected casing. + +.. option:: ConceptPrefix + + When defined, the check will ensure concept names will add the + prefixed with the given value (regardless of casing). + +.. option:: ConceptIgnoredRegexp + + Identifier naming checks won't be enforced for concept names + matching this regular expression. + +.. option:: ConceptSuffix + + When defined, the check will ensure concept names will add the + suffix with the given value (regardless of casing). + +For example using values of: + + - ConceptCase of ``CamelCase`` + - ConceptPrefix of ``Pre`` + - ConceptSuffix of ``Post`` + +Identifies and/or transforms concept names as follows: + +Before: + +.. code-block:: c++ + + template concept my_concept = requires (T t) { {t++}; }; + +After: + +.. code-block:: c++ + + template concept PreMyConceptPost = requires (T t) { {t++}; }; + .. option:: ConstantCase When defined, the check will ensure constant names conform to the diff --git a/clang-tools-extra/test/clang-tidy/checkers/readability/identifier-naming.cpp b/clang-tools-extra/test/clang-tidy/checkers/readability/identifier-naming.cpp index 84bf7764583e80..e375aa098972bf 100644 --- a/clang-tools-extra/test/clang-tidy/checkers/readability/identifier-naming.cpp +++ b/clang-tools-extra/test/clang-tidy/checkers/readability/identifier-naming.cpp @@ -11,6 +11,7 @@ // RUN: readability-identifier-naming.ClassConstantPrefix: 'k', \ // RUN: readability-identifier-naming.ClassMemberCase: CamelCase, \ // RUN: readability-identifier-naming.ClassMethodCase: camelBack, \ +// RUN: readability-identifier-naming.ConceptCase: CamelCase, \ // RUN: readability-identifier-naming.ConstantCase: UPPER_CASE, \ // RUN: readability-identifier-naming.ConstantSuffix: '_CST', \ // RUN: readability-identifier-naming.ConstexprFunctionCase: lower_case, \ @@ -251,6 +252,15 @@ class my_derived_class : public virtual my_class {}; class CMyWellNamedClass {}; // No warning expected as this class is well named. +template +concept MyConcept = requires (t_t a_t) { {a_t++}; }; +// No warning expected as this concept is well named. + +template +concept my_concept_2 = requires (t_t a_t) { {a_t++}; }; +// CHECK-MESSAGES: :[[@LINE-1]]:9: warning: invalid case style for concept 'my_concept_2' +// CHECK-FIXES: {{^}}concept MyConcept2 = requires (t_t a_t) { {a_t++}; };{{$}} + template class CMyWellNamedClass2 : public my_class { // CHECK-FIXES: {{^}}class CMyWellNamedClass2 : public CMyClass {{{$}}