contrib/llvm-project/clang/include/clang/Tooling/Transformer/RangeSelector.h

   1 //===--- RangeSelector.h - Source-selection library ---------*- C++ -*-===//
   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 ///  \file
  10 ///  Defines a combinator library supporting the definition of _selectors_,
  11 ///  which select source ranges based on (bound) AST nodes.
  12 ///
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_CLANG_TOOLING_REFACTOR_RANGE_SELECTOR_H_
  16 #define LLVM_CLANG_TOOLING_REFACTOR_RANGE_SELECTOR_H_
  17
  18 #include "clang/ASTMatchers/ASTMatchFinder.h"
  19 #include "clang/Basic/SourceLocation.h"
  20 #include "clang/Tooling/Transformer/MatchConsumer.h"
  21 #include "llvm/Support/Error.h"
  22 #include <functional>
  23 #include <string>
  24
  25 namespace clang {
  26 namespace transformer {
  27 using RangeSelector = MatchConsumer<CharSourceRange>;
  28
  29 inline RangeSelector charRange(CharSourceRange R) {
  30   return [R](const ast_matchers::MatchFinder::MatchResult &)
  31              -> Expected<CharSourceRange> { return R; };
  32 }
  33
  34 /// Selects from the start of \p Begin and to the end of \p End.
  35 RangeSelector range(RangeSelector Begin, RangeSelector End);
  36
  37 /// Convenience version of \c range where end-points are bound nodes.
  38 RangeSelector range(std::string BeginID, std::string EndID);
  39
  40 /// Selects the (empty) range [B,B) when \p Selector selects the range [B,E).
  41 RangeSelector before(RangeSelector Selector);
  42
  43 /// Selects the the point immediately following \p Selector. That is, the
  44 /// (empty) range [E,E), when \p Selector selects either
  45 /// * the CharRange [B,E) or
  46 /// * the TokenRange [B,E'] where the token at E' spans the range [E,E').
  47 RangeSelector after(RangeSelector Selector);
  48
  49 /// Selects a node, including trailing semicolon (for non-expression
  50 /// statements). \p ID is the node's binding in the match result.
  51 RangeSelector node(std::string ID);
  52
  53 /// Selects a node, including trailing semicolon (always). Useful for selecting
  54 /// expression statements. \p ID is the node's binding in the match result.
  55 RangeSelector statement(std::string ID);
  56
  57 /// Given a \c MemberExpr, selects the member token. \p ID is the node's
  58 /// binding in the match result.
  59 RangeSelector member(std::string ID);
  60
  61 /// Given a node with a "name", (like \c NamedDecl, \c DeclRefExpr or \c
  62 /// CxxCtorInitializer) selects the name's token.  Only selects the final
  63 /// identifier of a qualified name, but not any qualifiers or template
  64 /// arguments.  For example, for `::foo::bar::baz` and `::foo::bar::baz<int>`,
  65 /// it selects only `baz`.
  66 ///
  67 /// \param ID is the node's binding in the match result.
  68 RangeSelector name(std::string ID);
  69
  70 // Given a \c CallExpr (bound to \p ID), selects the arguments' source text (all
  71 // source between the call's parentheses).
  72 RangeSelector callArgs(std::string ID);
  73
  74 // Given a \c CompoundStmt (bound to \p ID), selects the source of the
  75 // statements (all source between the braces).
  76 RangeSelector statements(std::string ID);
  77
  78 // Given a \c InitListExpr (bound to \p ID), selects the range of the elements
  79 // (all source between the braces).
  80 RangeSelector initListElements(std::string ID);
  81
  82 /// Given an \IfStmt (bound to \p ID), selects the range of the else branch,
  83 /// starting from the \c else keyword.
  84 RangeSelector elseBranch(std::string ID);
  85
  86 /// Selects the range from which `S` was expanded (possibly along with other
  87 /// source), if `S` is an expansion, and `S` itself, otherwise.  Corresponds to
  88 /// `SourceManager::getExpansionRange`.
  89 RangeSelector expansion(RangeSelector S);
  90 } // namespace transformer
  91
  92 namespace tooling {
  93 // DEPRECATED: These are temporary aliases supporting client migration to the
  94 // `transformer` namespace.
  95 using RangeSelector = transformer::RangeSelector;
  96
  97 using transformer::after;
  98 using transformer::before;
  99 using transformer::callArgs;
 100 using transformer::charRange;
 101 using transformer::elseBranch;
 102 using transformer::expansion;
 103 using transformer::initListElements;
 104 using transformer::member;
 105 using transformer::name;
 106 using transformer::node;
 107 using transformer::range;
 108 using transformer::statement;
 109 using transformer::statements;
 110 } // namespace tooling
 111 } // namespace clang
 112
 113 #endif // LLVM_CLANG_TOOLING_REFACTOR_RANGE_SELECTOR_H_