Author: ymandel Date: Wed Sep 25 06:34:04 2019 New Revision: 372870 URL: http://llvm.org/viewvc/llvm-project?rev=372870&view=rev Log: [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 Added: cfe/trunk/include/clang/Tooling/Refactoring/MatchConsumer.h Modified: cfe/trunk/include/clang/Tooling/Refactoring/RangeSelector.h cfe/trunk/include/clang/Tooling/Refactoring/Transformer.h cfe/trunk/lib/Tooling/Refactoring/RangeSelector.cpp Added: cfe/trunk/include/clang/Tooling/Refactoring/MatchConsumer.h URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Tooling/Refactoring/MatchConsumer.h?rev=372870&view=auto ============================================================================== --- cfe/trunk/include/clang/Tooling/Refactoring/MatchConsumer.h (added) +++ cfe/trunk/include/clang/Tooling/Refactoring/MatchConsumer.h Wed Sep 25 06:34:04 2019 @@ -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 <typename T> +using MatchConsumer = + std::function<Expected<T>(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::StringError>(llvm::errc::invalid_argument, + "Id not bound: " + Id); +} + +/// Chooses between the two consumers, based on whether \p ID is bound in the +/// match. +template <typename T> +MatchConsumer<T> ifBound(std::string ID, MatchConsumer<T> TrueC, + MatchConsumer<T> 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_ Modified: cfe/trunk/include/clang/Tooling/Refactoring/RangeSelector.h URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Tooling/Refactoring/RangeSelector.h?rev=372870&r1=372869&r2=372870&view=diff ============================================================================== --- cfe/trunk/include/clang/Tooling/Refactoring/RangeSelector.h (original) +++ cfe/trunk/include/clang/Tooling/Refactoring/RangeSelector.h Wed Sep 25 06:34:04 2019 @@ -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 <functional> #include <string> namespace clang { namespace tooling { -using RangeSelector = std::function<Expected<CharSourceRange>( - const ast_matchers::MatchFinder::MatchResult &)>; +using RangeSelector = MatchConsumer<CharSourceRange>; 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 Modified: cfe/trunk/include/clang/Tooling/Refactoring/Transformer.h URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Tooling/Refactoring/Transformer.h?rev=372870&r1=372869&r2=372870&view=diff ============================================================================== --- cfe/trunk/include/clang/Tooling/Refactoring/Transformer.h (original) +++ cfe/trunk/include/clang/Tooling/Refactoring/Transformer.h Wed Sep 25 06:34:04 2019 @@ -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<Expected<std::string>( - const ast_matchers::MatchFinder::MatchResult &)>; +using TextGenerator = MatchConsumer<std::string>; /// Wraps a string as a TextGenerator. inline TextGenerator text(std::string M) { Modified: cfe/trunk/lib/Tooling/Refactoring/RangeSelector.cpp URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/lib/Tooling/Refactoring/RangeSelector.cpp?rev=372870&r1=372869&r2=372870&view=diff ============================================================================== --- cfe/trunk/lib/Tooling/Refactoring/RangeSelector.cpp (original) +++ cfe/trunk/lib/Tooling/Refactoring/RangeSelector.cpp Wed Sep 25 06:34:04 2019 @@ -310,11 +310,3 @@ RangeSelector tooling::expansion(RangeSe 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); - }; -} _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
