[clang-tools-extra] [llvm] [clang-tidy] New check `misc-header-guard` (PR #177315)

[Baranov Victor via cfe-commits]

================
@@ -0,0 +1,101 @@
+//===----------------------------------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "HeaderGuardCheck.h"
+#include "../utils/LexerUtils.h"
+#include "../utils/OptionsUtils.h"
+#include "clang/Basic/SourceManager.h"
+#include "clang/Lex/PPCallbacks.h"
+#include "clang/Lex/Preprocessor.h"
+#include "clang/Tooling/Tooling.h"
+#include "llvm/Support/Path.h"
+
+namespace clang::tidy::misc {
+
+HeaderGuardCheck::HeaderGuardCheck(StringRef Name, ClangTidyContext *Context)
+    : clang::tidy::utils::HeaderGuardCheck(Name, Context),
+      AllowPragmaOnce(Options.get("AllowPragmaOnce", false)),
+      HeaderDirs(utils::options::parseStringList(
+          Options.get("HeaderDirs", "include"))),
+      EndifComment(Options.get("EndifComment", false)),
+      Prefix(Options.get("Prefix", "")) {}
+
+std::string HeaderGuardCheck::getHeaderGuard(StringRef Filename,
+                                             StringRef /*OldGuard*/) {
+  // When running under Windows, need to convert the path separators from
+  // `\` to `/`.
+  std::string AbsPath =
+      llvm::sys::path::convert_to_slash(tooling::getAbsolutePath(Filename));
+
+  // consider all directories from HeaderDirs option. Stop at first found.
+  for (const StringRef HeaderDir : HeaderDirs) {
+    const size_t PosHeaderDir = AbsPath.rfind("/" + HeaderDir.str() + "/");
+    if (PosHeaderDir != StringRef::npos) {
+      // We don't want the header dir in our guards, i.e. _INCLUDE_
+      AbsPath = AbsPath.substr(PosHeaderDir + HeaderDir.size() + 2);
+      break; // stop at first found
+    }
+  }
+
+  std::string Guard = AbsPath;
+  llvm::replace(Guard, '/', '_');
+  llvm::replace(Guard, '.', '_');
+  llvm::replace(Guard, '-', '_');
+  Guard = Prefix.str() + Guard;
+
+  return StringRef(Guard).upper();
+}
+
+bool HeaderGuardCheck::shouldSuggestEndifComment(StringRef /*Filename*/) {
+  return EndifComment;
+}
+
+bool HeaderGuardCheck::shouldSuggestToAddHeaderGuard(StringRef Filename) {
+  if (HasPragmaOnce && AllowPragmaOnce)
+    return false;
+  return utils::HeaderGuardCheck::shouldSuggestToAddHeaderGuard(Filename);
----------------
vbvictor wrote:

After suggesting header we could have `pragma once` + header guards.
I think we need to remove `pragma once` if we found one with `HasPragmaOnce`.


https://github.com/llvm/llvm-project/pull/177315