diff --git a/clang/include/clang/Tooling/Refactoring/MatchConsumer.h b/clang/include/clang/Tooling/Refactoring/MatchConsumer.h new file mode 100644 --- /dev/null +++ b/clang/include/clang/Tooling/Refactoring/MatchConsumer.h @@ -0,0 +1,58 @@ +//===--- MatchConsumer.h - MatchConsumer abstraction ------------*- C++ -*-===// +// +// 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 +// +//===----------------------------------------------------------------------===// +/// +/// /file This file defines the *MatchConsumer* abstraction: a computation over +/// match results, specifically the `ast_matchers::MatchFinder::MatchResult` +/// class. +/// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_CLANG_TOOLING_REFACTOR_MATCH_CONSUMER_H_ +#define LLVM_CLANG_TOOLING_REFACTOR_MATCH_CONSUMER_H_ + +#include "clang/AST/ASTTypeTraits.h" +#include "clang/ASTMatchers/ASTMatchFinder.h" +#include "llvm/ADT/StringRef.h" +#include "llvm/Support/Errc.h" +#include "llvm/Support/Error.h" + +namespace clang { +namespace tooling { + +/// A central abstraction of the Transformer framework is computation over the +/// results of a match (represented by \c MatchFinder::MatchResult). We +/// standardize this abstraction with the \c MatchConsumer type. Since match +/// results include dynamically-bound variables, these computations are allowed +/// to fail, for example when trying to access a matched node that was not +/// bound. Allowing for failure in the return type avoids the need for +/// computations to terminate on failure, which simplifies error handling for +/// interactive tools like clang-query. +template +using MatchConsumer = std::function( + const ast_matchers::MatchFinder::MatchResult &)>; + +/// Convenience function for a common error generated by `MatchConsumer`s. +inline llvm::Error notBoundError(llvm::StringRef Id) { + return llvm::make_error(llvm::errc::invalid_argument, + "Id not bound: " + Id); +} + +/// Chooses between the two consumers, based on whether \p ID is bound in the +/// match. +template +MatchConsumer ifBound(std::string ID, MatchConsumer TrueC, + MatchConsumer FalseC) { + return [=](const ast_matchers::MatchFinder::MatchResult &Result) { + auto &Map = Result.Nodes.getMap(); + return (Map.find(ID) != Map.end() ? TrueC : FalseC)(Result); + }; +} + +} // namespace tooling +} // namespace clang +#endif // LLVM_CLANG_TOOLING_REFACTOR_MATCH_CONSUMER_H_ diff --git a/clang/include/clang/Tooling/Refactoring/RangeSelector.h b/clang/include/clang/Tooling/Refactoring/RangeSelector.h --- a/clang/include/clang/Tooling/Refactoring/RangeSelector.h +++ b/clang/include/clang/Tooling/Refactoring/RangeSelector.h @@ -17,14 +17,14 @@ #include "clang/ASTMatchers/ASTMatchFinder.h" #include "clang/Basic/SourceLocation.h" +#include "clang/Tooling/Refactoring/MatchConsumer.h" #include "llvm/Support/Error.h" #include #include namespace clang { namespace tooling { -using RangeSelector = std::function( - const ast_matchers::MatchFinder::MatchResult &)>; +using RangeSelector = MatchConsumer; inline RangeSelector charRange(CharSourceRange R) { return [R](const ast_matchers::MatchFinder::MatchResult &) @@ -87,11 +87,6 @@ /// source), if `S` is an expansion, and `S` itself, otherwise. Corresponds to /// `SourceManager::getExpansionRange`. RangeSelector expansion(RangeSelector S); - -/// Chooses between the two selectors, based on whether \p ID is bound in the -/// match. -RangeSelector ifBound(std::string ID, RangeSelector TrueSelector, - RangeSelector FalseSelector); } // namespace tooling } // namespace clang diff --git a/clang/include/clang/Tooling/Refactoring/Transformer.h b/clang/include/clang/Tooling/Refactoring/Transformer.h --- a/clang/include/clang/Tooling/Refactoring/Transformer.h +++ b/clang/include/clang/Tooling/Refactoring/Transformer.h @@ -19,6 +19,7 @@ #include "clang/ASTMatchers/ASTMatchers.h" #include "clang/ASTMatchers/ASTMatchersInternal.h" #include "clang/Tooling/Refactoring/AtomicChange.h" +#include "clang/Tooling/Refactoring/MatchConsumer.h" #include "clang/Tooling/Refactoring/RangeSelector.h" #include "llvm/ADT/STLExtras.h" #include "llvm/ADT/SmallVector.h" @@ -32,11 +33,7 @@ namespace clang { namespace tooling { -// Note that \p TextGenerator is allowed to fail, e.g. when trying to access a -// matched node that was not bound. Allowing this to fail simplifies error -// handling for interactive tools like clang-query. -using TextGenerator = std::function( - const ast_matchers::MatchFinder::MatchResult &)>; +using TextGenerator = MatchConsumer; /// Wraps a string as a TextGenerator. inline TextGenerator text(std::string M) { diff --git a/clang/lib/Tooling/Refactoring/RangeSelector.cpp b/clang/lib/Tooling/Refactoring/RangeSelector.cpp --- a/clang/lib/Tooling/Refactoring/RangeSelector.cpp +++ b/clang/lib/Tooling/Refactoring/RangeSelector.cpp @@ -310,11 +310,3 @@ return Result.SourceManager->getExpansionRange(*SRange); }; } - -RangeSelector tooling::ifBound(std::string ID, RangeSelector TrueSelector, - RangeSelector FalseSelector) { - return [=](const MatchResult &Result) { - auto &Map = Result.Nodes.getMap(); - return (Map.find(ID) != Map.end() ? TrueSelector : FalseSelector)(Result); - }; -}