Merge branch 'llvm:main' into select-case-hlfir-cmpchar

Author: eugeneepshteyn

.git-blame-ignore-revs

@@ -143,3 +143,12 @@ a3a007ad5fa20abc90ead4e1030b481bf109b4cf
 b7e332d3f59f567b1999fbcc660d7837cba8e406
 6056f942abe83b05406df8b04e95ec37a3d160b5
 906295b8a31c8dac5aa845864c0bca9f02f86184
+
+# [clang-tidy][NFC] Remove trailing whitespaces in documentation
+8f2b167de4a1268160c06512d08863a9e8f43290
+
+# [clang-tidy][NFC] Enforce 80 characters limit in docs
+5edf70c41c5d69f3751b4199f642f4585599dade
+c73870dbe89a8219130e21a0b3f13df76d299352
+74c40293c309dbd142bf1f0ebfbfde6be8d30655
+a7ba8dcad76476478100c228a31d9c48391b1e03

clang-tools-extra/clang-doc/assets/class-template.mustache

@@ -174,7 +174,7 @@
                 <h2>Public Methods</h2>
                 <div>
                     {{#PublicFunctions}}
-{{>FunctionPartial}}
+                    {{>FunctionPartial}}
                     {{/PublicFunctions}}
                 </div>
             </section>

clang-tools-extra/clang-doc/assets/comment-template.mustache

@@ -6,61 +6,61 @@
     This file defines templates for generating comments
 }}
 {{#BriefComments}}
-    <div>
-    {{#.}}
-        <p>{{TextComment}}</p>
-    {{/.}}
-    </div>
+<div>
+{{#.}}
+    <p>{{TextComment}}</p>
+{{/.}}
+</div>
 {{/BriefComments}}
 {{#ParagraphComments}}
-    <div>
-    {{#.}}
-        <p>{{TextComment}}</p>
-    {{/.}}
-    </div>
+<div>
+{{#.}}
+    <p>{{TextComment}}</p>
+{{/.}}
+</div>
 {{/ParagraphComments}}
 {{#ParagraphComment}}
-    {{#Children}}
-    {{>Comments}}
-    {{/Children}}
+{{#Children}}
+{{TextComment}}
+{{/Children}}
 {{/ParagraphComment}}
 {{#HasParamComments}}
-    <h3>Parameters</h3>
-    {{#ParamComments}}
-    <div>
-        <b>{{ParamName}}</b> {{#Explicit}}{{Direction}}{{/Explicit}} {{#Children}}{{>Comments}}{{/Children}}
-    </div> 
-    {{/ParamComments}}
+<h3>Parameters</h3>
+{{#ParamComments}}
+<div>
+    <b>{{ParamName}}</b> {{#Explicit}}{{Direction}}{{/Explicit}} {{#Children}}{{TextComment}}{{/Children}}
+</div> 
+{{/ParamComments}}
 {{/HasParamComments}}
 {{#HasReturnComments}}
-    <h3>Returns</h3>
-    {{#ReturnComments}}
-        {{#.}}
-        <p>{{TextComment}}</p>
-        {{/.}}
-    {{/ReturnComments}}
+<h3>Returns</h3>
+{{#ReturnComments}}
+{{#.}}
+<p>{{TextComment}}</p>
+{{/.}}
+{{/ReturnComments}}
 {{/HasReturnComments}}
 {{#HasCodeComments}}
-    <h3>Code</h3> 
-    {{#CodeComments}}
-    <div>
-        <pre class="code-block">
-            <code>
-            {{#.}}
+<h3>Code</h3> 
+{{#CodeComments}}
+<div>
+    <pre class="code-block">
+        <code>
+        {{#.}}
             {{.}}
-            {{/.}}
-            </code>
-        </pre>
-    </div>
-    {{/CodeComments}}
+        {{/.}}
+        </code>
+    </pre>
+</div>
+{{/CodeComments}}
 {{/HasCodeComments}}
 {{#HasThrowsComments}}
-    <h3>Throws</h3>
-    {{#ThrowsComments}}
-    <div>
-        <b>{{Exception}}</b> {{#Children}}{{TextComment}}{{/Children}}
-    </div>
-    {{/ThrowsComments}}
+<h3>Throws</h3>
+{{#ThrowsComments}}
+<div>
+    <b>{{Exception}}</b> {{#Children}}{{TextComment}}{{/Children}}
+</div>
+{{/ThrowsComments}}
 {{/HasThrowsComments}}
 {{#BlockCommandComment}}
     <div class="block-command-comment__command">
@@ -74,8 +74,3 @@
         </div>
     </div>
 {{/BlockCommandComment}}
-{{#TextComment}}
-    <div>
-        <p>{{TextComment}}</p>
-    </div>
-{{/TextComment}}

clang-tools-extra/clang-doc/assets/function-template.mustache

@@ -8,11 +8,7 @@
 <div class="delimiter-container">
     <div id="{{USR}}">
         {{! Function Prototype }}
-        <pre>
-            <code class="language-cpp code-clang-doc">
-{{ReturnType.Name}} {{Name}} ({{#Params}}{{^End}}{{Type}} {{Name}}, {{/End}}{{#End}}{{Type}} {{Name}}{{/End}}{{/Params}})
-            </code>
-        </pre>
+        <pre><code class="language-cpp code-clang-doc">{{ReturnType.Name}} {{Name}} ({{#Params}}{{^End}}{{Type}} {{Name}}, {{/End}}{{#End}}{{Type}} {{Name}}{{/End}}{{/Params}})</code></pre>
         {{! Function Comments }}
         {{#Description}}
         <div>

clang-tools-extra/clang-tidy/readability/DuplicateIncludeCheck.cpp

@@ -7,10 +7,12 @@
 //===----------------------------------------------------------------------===//
 
 #include "DuplicateIncludeCheck.h"
+#include "../utils/OptionsUtils.h"
 #include "clang/Frontend/CompilerInstance.h"
 #include "clang/Lex/Preprocessor.h"
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/ADT/SmallVector.h"
+#include "llvm/Support/Regex.h"
 #include <memory>
 
 namespace clang::tidy::readability {
@@ -33,11 +35,8 @@ using FileList = SmallVector<StringRef>;
 class DuplicateIncludeCallbacks : public PPCallbacks {
 public:
   DuplicateIncludeCallbacks(DuplicateIncludeCheck &Check,
-                            const SourceManager &SM)
-      : Check(Check), SM(SM) {
-    // The main file doesn't participate in the FileChanged notification.
-    Files.emplace_back();
-  }
+                            const SourceManager &SM,
+                            llvm::ArrayRef<StringRef> IgnoredList);
 
   void FileChanged(SourceLocation Loc, FileChangeReason Reason,
                    SrcMgr::CharacteristicKind FileType,
@@ -62,10 +61,31 @@ class DuplicateIncludeCallbacks : public PPCallbacks {
   SmallVector<FileList> Files;
   DuplicateIncludeCheck &Check;
   const SourceManager &SM;
+  SmallVector<llvm::Regex> AllowedRegexes;
 };
 
 } // namespace
 
+DuplicateIncludeCheck::DuplicateIncludeCheck(StringRef Name,
+                                             ClangTidyContext *Context)
+    : ClangTidyCheck(Name, Context),
+      IgnoredFilesList(utils::options::parseStringList(
+          Options.get("IgnoredFilesList", ""))) {}
+
+DuplicateIncludeCallbacks::DuplicateIncludeCallbacks(
+    DuplicateIncludeCheck &Check, const SourceManager &SM,
+    llvm::ArrayRef<StringRef> IgnoredList)
+    : Check(Check), SM(SM) {
+  // The main file doesn't participate in the FileChanged notification.
+  Files.emplace_back();
+
+  AllowedRegexes.reserve(IgnoredList.size());
+  for (const StringRef &It : IgnoredList) {
+    if (!It.empty())
+      AllowedRegexes.emplace_back(It);
+  }
+}
+
 void DuplicateIncludeCallbacks::FileChanged(SourceLocation Loc,
                                             FileChangeReason Reason,
                                             SrcMgr::CharacteristicKind FileType,
@@ -78,14 +98,18 @@ void DuplicateIncludeCallbacks::FileChanged(SourceLocation Loc,
 
 void DuplicateIncludeCallbacks::InclusionDirective(
     SourceLocation HashLoc, const Token &IncludeTok, StringRef FileName,
-    bool IsAngled, CharSourceRange FilenameRange, OptionalFileEntryRef File,
+    bool IsAngled, CharSourceRange FilenameRange, OptionalFileEntryRef /*File*/,
     StringRef SearchPath, StringRef RelativePath, const Module *SuggestedModule,
     bool ModuleImported, SrcMgr::CharacteristicKind FileType) {
   // Skip includes behind macros
   if (FilenameRange.getBegin().isMacroID() ||
       FilenameRange.getEnd().isMacroID())
     return;
   if (llvm::is_contained(Files.back(), FileName)) {
+    if (llvm::any_of(AllowedRegexes, [&FileName](const llvm::Regex &R) {
+          return R.match(FileName);
+        }))
+      return;
     // We want to delete the entire line, so make sure that [Start,End] covers
     // everything.
     const SourceLocation Start =
@@ -111,7 +135,13 @@ void DuplicateIncludeCallbacks::MacroUndefined(const Token &MacroNameTok,
 
 void DuplicateIncludeCheck::registerPPCallbacks(
     const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) {
-  PP->addPPCallbacks(std::make_unique<DuplicateIncludeCallbacks>(*this, SM));
+  PP->addPPCallbacks(
+      std::make_unique<DuplicateIncludeCallbacks>(*this, SM, IgnoredFilesList));
+}
+
+void DuplicateIncludeCheck::storeOptions(ClangTidyOptions::OptionMap &Opts) {
+  Options.store(Opts, "IgnoredFilesList",
+                utils::options::serializeStringList(IgnoredFilesList));
 }
 
 } // namespace clang::tidy::readability

clang-tools-extra/clang-tidy/readability/DuplicateIncludeCheck.h

@@ -19,11 +19,16 @@ namespace clang::tidy::readability {
 /// directives between them are analyzed.
 class DuplicateIncludeCheck : public ClangTidyCheck {
 public:
-  DuplicateIncludeCheck(StringRef Name, ClangTidyContext *Context)
-      : ClangTidyCheck(Name, Context) {}
+  DuplicateIncludeCheck(StringRef Name, ClangTidyContext *Context);
 
   void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
                            Preprocessor *ModuleExpanderPP) override;
+  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
+
+private:
+  // Semicolon-separated list of regexes or file names to ignore from duplicate
+  // warnings.
+  const std::vector<StringRef> IgnoredFilesList;
 };
 
 } // namespace clang::tidy::readability

clang-tools-extra/docs/ReleaseNotes.rst

@@ -527,6 +527,11 @@ Changes in existing checks
   ignoring default constructors with user provided arguments and adding
   detection in container's method except ``empty``.
 
+- Improved :doc:`readability-duplicate-include
+  <clang-tidy/checks/readability/duplicate-include>` check by adding
+  the ``IgnoredFilesList`` option (semicolon-separated list of regexes or
+  filenames) to allow intentional duplicates.
+
 - Improved :doc:`readability-identifier-naming
   <clang-tidy/checks/readability/identifier-naming>` check by ignoring
   declarations and macros in system headers. The documentation is also improved

clang-tools-extra/docs/clang-tidy/checks/readability/duplicate-include.rst

@@ -33,3 +33,12 @@ Because of the intervening macro definitions, this code remains unchanged:
   #define NDEBUG
   #include "assertion.h"
   // ...code with assertions disabled
+
+Options
+-------
+
+.. option:: IgnoredFilesList
+
+  A semicolon-separated list of regular expressions or filenames that are
+  allowed to be included multiple times without diagnostics. Matching is
+  performed against the textual include name. Default is an empty string.