diff options
Diffstat (limited to 'include/clang/ASTMatchers/ASTMatchFinder.h')
| -rw-r--r-- | include/clang/ASTMatchers/ASTMatchFinder.h | 294 |
1 files changed, 0 insertions, 294 deletions
diff --git a/include/clang/ASTMatchers/ASTMatchFinder.h b/include/clang/ASTMatchers/ASTMatchFinder.h deleted file mode 100644 index 92ec92c..0000000 --- a/include/clang/ASTMatchers/ASTMatchFinder.h +++ /dev/null @@ -1,294 +0,0 @@ -//===--- ASTMatchFinder.h - Structural query framework ----------*- C++ -*-===// -// -// The LLVM Compiler Infrastructure -// -// This file is distributed under the University of Illinois Open Source -// License. See LICENSE.TXT for details. -// -//===----------------------------------------------------------------------===// -// -// Provides a way to construct an ASTConsumer that runs given matchers -// over the AST and invokes a given callback on every match. -// -// The general idea is to construct a matcher expression that describes a -// subtree match on the AST. Next, a callback that is executed every time the -// expression matches is registered, and the matcher is run over the AST of -// some code. Matched subexpressions can be bound to string IDs and easily -// be accessed from the registered callback. The callback can than use the -// AST nodes that the subexpressions matched on to output information about -// the match or construct changes that can be applied to the code. -// -// Example: -// class HandleMatch : public MatchFinder::MatchCallback { -// public: -// virtual void Run(const MatchFinder::MatchResult &Result) { -// const CXXRecordDecl *Class = -// Result.Nodes.GetDeclAs<CXXRecordDecl>("id"); -// ... -// } -// }; -// -// int main(int argc, char **argv) { -// ClangTool Tool(argc, argv); -// MatchFinder finder; -// finder.AddMatcher(Id("id", record(hasName("::a_namespace::AClass"))), -// new HandleMatch); -// return Tool.Run(newFrontendActionFactory(&finder)); -// } -// -//===----------------------------------------------------------------------===// - -#ifndef LLVM_CLANG_ASTMATCHERS_ASTMATCHFINDER_H -#define LLVM_CLANG_ASTMATCHERS_ASTMATCHFINDER_H - -#include "clang/ASTMatchers/ASTMatchers.h" -#include "llvm/ADT/SmallPtrSet.h" -#include "llvm/ADT/StringMap.h" -#include "llvm/Support/Timer.h" - -namespace clang { - -namespace ast_matchers { - -/// \brief A class to allow finding matches over the Clang AST. -/// -/// After creation, you can add multiple matchers to the MatchFinder via -/// calls to addMatcher(...). -/// -/// Once all matchers are added, newASTConsumer() returns an ASTConsumer -/// that will trigger the callbacks specified via addMatcher(...) when a match -/// is found. -/// -/// The order of matches is guaranteed to be equivalent to doing a pre-order -/// traversal on the AST, and applying the matchers in the order in which they -/// were added to the MatchFinder. -/// -/// See ASTMatchers.h for more information about how to create matchers. -/// -/// Not intended to be subclassed. -class MatchFinder { -public: - /// \brief Contains all information for a given match. - /// - /// Every time a match is found, the MatchFinder will invoke the registered - /// MatchCallback with a MatchResult containing information about the match. - struct MatchResult { - MatchResult(const BoundNodes &Nodes, clang::ASTContext *Context); - - /// \brief Contains the nodes bound on the current match. - /// - /// This allows user code to easily extract matched AST nodes. - const BoundNodes Nodes; - - /// \brief Utilities for interpreting the matched AST structures. - /// @{ - clang::ASTContext * const Context; - clang::SourceManager * const SourceManager; - /// @} - }; - - /// \brief Called when the Match registered for it was successfully found - /// in the AST. - class MatchCallback { - public: - virtual ~MatchCallback(); - - /// \brief Called on every match by the \c MatchFinder. - virtual void run(const MatchResult &Result) = 0; - - /// \brief Called at the start of each translation unit. - /// - /// Optionally override to do per translation unit tasks. - virtual void onStartOfTranslationUnit() {} - - /// \brief Called at the end of each translation unit. - /// - /// Optionally override to do per translation unit tasks. - virtual void onEndOfTranslationUnit() {} - - /// \brief An id used to group the matchers. - /// - /// This id is used, for example, for the profiling output. - /// It defaults to "<unknown>". - virtual StringRef getID() const; - }; - - /// \brief Called when parsing is finished. Intended for testing only. - class ParsingDoneTestCallback { - public: - virtual ~ParsingDoneTestCallback(); - virtual void run() = 0; - }; - - struct MatchFinderOptions { - struct Profiling { - Profiling(llvm::StringMap<llvm::TimeRecord> &Records) - : Records(Records) {} - - /// \brief Per bucket timing information. - llvm::StringMap<llvm::TimeRecord> &Records; - }; - - /// \brief Enables per-check timers. - /// - /// It prints a report after match. - llvm::Optional<Profiling> CheckProfiling; - }; - - MatchFinder(MatchFinderOptions Options = MatchFinderOptions()); - ~MatchFinder(); - - /// \brief Adds a matcher to execute when running over the AST. - /// - /// Calls 'Action' with the BoundNodes on every match. - /// Adding more than one 'NodeMatch' allows finding different matches in a - /// single pass over the AST. - /// - /// Does not take ownership of 'Action'. - /// @{ - void addMatcher(const DeclarationMatcher &NodeMatch, - MatchCallback *Action); - void addMatcher(const TypeMatcher &NodeMatch, - MatchCallback *Action); - void addMatcher(const StatementMatcher &NodeMatch, - MatchCallback *Action); - void addMatcher(const NestedNameSpecifierMatcher &NodeMatch, - MatchCallback *Action); - void addMatcher(const NestedNameSpecifierLocMatcher &NodeMatch, - MatchCallback *Action); - void addMatcher(const TypeLocMatcher &NodeMatch, - MatchCallback *Action); - /// @} - - /// \brief Adds a matcher to execute when running over the AST. - /// - /// This is similar to \c addMatcher(), but it uses the dynamic interface. It - /// is more flexible, but the lost type information enables a caller to pass - /// a matcher that cannot match anything. - /// - /// \returns \c true if the matcher is a valid top-level matcher, \c false - /// otherwise. - bool addDynamicMatcher(const internal::DynTypedMatcher &NodeMatch, - MatchCallback *Action); - - /// \brief Creates a clang ASTConsumer that finds all matches. - std::unique_ptr<clang::ASTConsumer> newASTConsumer(); - - /// \brief Calls the registered callbacks on all matches on the given \p Node. - /// - /// Note that there can be multiple matches on a single node, for - /// example when using decl(forEachDescendant(stmt())). - /// - /// @{ - template <typename T> void match(const T &Node, ASTContext &Context) { - match(clang::ast_type_traits::DynTypedNode::create(Node), Context); - } - void match(const clang::ast_type_traits::DynTypedNode &Node, - ASTContext &Context); - /// @} - - /// \brief Finds all matches in the given AST. - void matchAST(ASTContext &Context); - - /// \brief Registers a callback to notify the end of parsing. - /// - /// The provided closure is called after parsing is done, before the AST is - /// traversed. Useful for benchmarking. - /// Each call to FindAll(...) will call the closure once. - void registerTestCallbackAfterParsing(ParsingDoneTestCallback *ParsingDone); - - /// \brief For each \c Matcher<> a \c MatchCallback that will be called - /// when it matches. - struct MatchersByType { - std::vector<std::pair<internal::DynTypedMatcher, MatchCallback *>> - DeclOrStmt; - std::vector<std::pair<TypeMatcher, MatchCallback *>> Type; - std::vector<std::pair<NestedNameSpecifierMatcher, MatchCallback *>> - NestedNameSpecifier; - std::vector<std::pair<NestedNameSpecifierLocMatcher, MatchCallback *>> - NestedNameSpecifierLoc; - std::vector<std::pair<TypeLocMatcher, MatchCallback *>> TypeLoc; - /// \brief All the callbacks in one container to simplify iteration. - llvm::SmallPtrSet<MatchCallback *, 16> AllCallbacks; - }; - -private: - MatchersByType Matchers; - - MatchFinderOptions Options; - - /// \brief Called when parsing is done. - ParsingDoneTestCallback *ParsingDone; -}; - -/// \brief Returns the results of matching \p Matcher on \p Node. -/// -/// Collects the \c BoundNodes of all callback invocations when matching -/// \p Matcher on \p Node and returns the collected results. -/// -/// Multiple results occur when using matchers like \c forEachDescendant, -/// which generate a result for each sub-match. -/// -/// \see selectFirst -/// @{ -template <typename MatcherT, typename NodeT> -SmallVector<BoundNodes, 1> -match(MatcherT Matcher, const NodeT &Node, ASTContext &Context); - -template <typename MatcherT> -SmallVector<BoundNodes, 1> -match(MatcherT Matcher, const ast_type_traits::DynTypedNode &Node, - ASTContext &Context); -/// @} - -/// \brief Returns the first result of type \c NodeT bound to \p BoundTo. -/// -/// Returns \c NULL if there is no match, or if the matching node cannot be -/// casted to \c NodeT. -/// -/// This is useful in combanation with \c match(): -/// \code -/// const Decl *D = selectFirst<Decl>("id", match(Matcher.bind("id"), -/// Node, Context)); -/// \endcode -template <typename NodeT> -const NodeT * -selectFirst(StringRef BoundTo, const SmallVectorImpl<BoundNodes> &Results) { - for (const BoundNodes &N : Results) { - if (const NodeT *Node = N.getNodeAs<NodeT>(BoundTo)) - return Node; - } - return nullptr; -} - -namespace internal { -class CollectMatchesCallback : public MatchFinder::MatchCallback { -public: - void run(const MatchFinder::MatchResult &Result) override { - Nodes.push_back(Result.Nodes); - } - SmallVector<BoundNodes, 1> Nodes; -}; -} - -template <typename MatcherT> -SmallVector<BoundNodes, 1> -match(MatcherT Matcher, const ast_type_traits::DynTypedNode &Node, - ASTContext &Context) { - internal::CollectMatchesCallback Callback; - MatchFinder Finder; - Finder.addMatcher(Matcher, &Callback); - Finder.match(Node, Context); - return std::move(Callback.Nodes); -} - -template <typename MatcherT, typename NodeT> -SmallVector<BoundNodes, 1> -match(MatcherT Matcher, const NodeT &Node, ASTContext &Context) { - return match(Matcher, ast_type_traits::DynTypedNode::create(Node), Context); -} - -} // end namespace ast_matchers -} // end namespace clang - -#endif |
