clang-tools  10.0.0svn
AbseilMatcher.h
Go to the documentation of this file.
1 //===- AbseilMatcher.h - clang-tidy ---------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "clang/AST/ASTContext.h"
10 #include "clang/ASTMatchers/ASTMatchFinder.h"
11 #include <algorithm>
12 
13 namespace clang {
14 namespace ast_matchers {
15 
16 /// Matches AST nodes that were found within Abseil files.
17 ///
18 /// Example matches Y but not X
19 /// (matcher = cxxRecordDecl(isInAbseilFile())
20 /// \code
21 /// #include "absl/strings/internal-file.h"
22 /// class X {};
23 /// \endcode
24 /// absl/strings/internal-file.h:
25 /// \code
26 /// class Y {};
27 /// \endcode
28 ///
29 /// Usable as: Matcher<Decl>, Matcher<Stmt>, Matcher<TypeLoc>,
30 /// Matcher<NestedNameSpecifierLoc>
32  isInAbseilFile, AST_POLYMORPHIC_SUPPORTED_TYPES(Decl, Stmt, TypeLoc,
33  NestedNameSpecifierLoc)) {
34  auto &SourceManager = Finder->getASTContext().getSourceManager();
35  SourceLocation Loc = SourceManager.getSpellingLoc(Node.getBeginLoc());
36  if (Loc.isInvalid())
37  return false;
38  const FileEntry *FileEntry =
39  SourceManager.getFileEntryForID(SourceManager.getFileID(Loc));
40  if (!FileEntry)
41  return false;
42  // Determine whether filepath contains "absl/[absl-library]" substring, where
43  // [absl-library] is AbseilLibraries list entry.
44  StringRef Path = FileEntry->getName();
45  static constexpr llvm::StringLiteral AbslPrefix("absl/");
46  size_t PrefixPosition = Path.find(AbslPrefix);
47  if (PrefixPosition == StringRef::npos)
48  return false;
49  Path = Path.drop_front(PrefixPosition + AbslPrefix.size());
50  static const char *AbseilLibraries[] = {
51  "algorithm", "base", "container", "debugging", "flags",
52  "hash", "iterator", "memory", "meta", "numeric",
53  "random", "strings", "synchronization", "time", "types",
54  "utility"};
55  return std::any_of(
56  std::begin(AbseilLibraries), std::end(AbseilLibraries),
57  [&](const char *Library) { return Path.startswith(Library); });
58 }
59 
60 } // namespace ast_matchers
61 } // namespace clang
SourceLocation Loc
&#39;#&#39; location in the include directive
AST_POLYMORPHIC_MATCHER(isInAbseilFile, AST_POLYMORPHIC_SUPPORTED_TYPES(Decl, Stmt, TypeLoc, NestedNameSpecifierLoc))
Matches AST nodes that were found within Abseil files.
Definition: AbseilMatcher.h:31
std::vector< HeaderHandle > Path
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//