From: Yitzhak Mandelbaum Date: Wed, 25 Sep 2019 13:34:04 +0000 (+0000) Subject: [libTooling] Introduce the MatchConsumer abstraction X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=63dd6c10d6468ffef49cee8311f384c8254a181a;p=clang [libTooling] Introduce the MatchConsumer abstraction Summary: This revision introduces a separate (small) library for the `MatchConsumer` abstraction: computations over AST match results. This abstraction is central to the Transformer framework, and there deserves being defined explicitly. Reviewers: gribozavr Subscribers: cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D67961 git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@372870 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/include/clang/Tooling/Refactoring/MatchConsumer.h b/include/clang/Tooling/Refactoring/MatchConsumer.h new file mode 100644 index 0000000000..d516550d0f --- /dev/null +++ b/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 failable computation over nodes bound by AST matchers. +/// +/// The computation should report any errors though its return value (rather +/// than terminating the program) to enable usage in interactive scenarios like +/// clang-query. +/// +/// This is a central abstraction of the Transformer framework. +template +using MatchConsumer = + std::function(const ast_matchers::MatchFinder::MatchResult &)>; + +/// Creates an error that signals that a `MatchConsumer` expected a certain node +/// to be bound by AST matchers, but it was not actually bound. +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/include/clang/Tooling/Refactoring/RangeSelector.h b/include/clang/Tooling/Refactoring/RangeSelector.h index e5fe051413..d5b5c8fbd8 100644 --- a/include/clang/Tooling/Refactoring/RangeSelector.h +++ b/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 @@ RangeSelector elseBranch(std::string ID); /// 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/include/clang/Tooling/Refactoring/Transformer.h b/include/clang/Tooling/Refactoring/Transformer.h index d5d4adf1f0..587edb9d02 100644 --- a/include/clang/Tooling/Refactoring/Transformer.h +++ b/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/lib/Tooling/Refactoring/RangeSelector.cpp b/lib/Tooling/Refactoring/RangeSelector.cpp index ae55698189..972c7e6554 100644 --- a/lib/Tooling/Refactoring/RangeSelector.cpp +++ b/lib/Tooling/Refactoring/RangeSelector.cpp @@ -310,11 +310,3 @@ RangeSelector tooling::expansion(RangeSelector S) { 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); - }; -}