clang  6.0.0svn
RefactoringRuleContext.h
Go to the documentation of this file.
1 //===--- RefactoringRuleContext.h - Clang refactoring library -------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #ifndef LLVM_CLANG_TOOLING_REFACTOR_REFACTORING_RULE_CONTEXT_H
11 #define LLVM_CLANG_TOOLING_REFACTOR_REFACTORING_RULE_CONTEXT_H
12 
16 
17 namespace clang {
18 
19 class ASTContext;
20 
21 namespace tooling {
22 
23 /// The refactoring rule context stores all of the inputs that might be needed
24 /// by a refactoring action rule. It can create the specialized
25 /// \c ASTRefactoringOperation or \c PreprocessorRefactoringOperation values
26 /// that can be used by the refactoring action rules.
27 ///
28 /// The following inputs are stored by the operation:
29 ///
30 /// - SourceManager: a reference to a valid source manager.
31 ///
32 /// - SelectionRange: an optional source selection ranges that can be used
33 /// to represent a selection in an editor.
35 public:
36  RefactoringRuleContext(const SourceManager &SM) : SM(SM) {}
37 
38  const SourceManager &getSources() const { return SM; }
39 
40  /// Returns the current source selection range as set by the
41  /// refactoring engine. Can be invalid.
42  SourceRange getSelectionRange() const { return SelectionRange; }
43 
44  void setSelectionRange(SourceRange R) { SelectionRange = R; }
45 
46  bool hasASTContext() const { return AST; }
47 
49  assert(AST && "no AST!");
50  return *AST;
51  }
52 
53  void setASTContext(ASTContext &Context) { AST = &Context; }
54 
55  /// Creates an llvm::Error value that contains a diagnostic.
56  ///
57  /// The errors should not outlive the context.
59  return DiagnosticError::create(Loc, PartialDiagnostic(DiagID, DiagStorage));
60  }
61 
63  return createDiagnosticError(SourceLocation(), DiagID);
64  }
65 
66  void setASTSelection(std::unique_ptr<SelectedASTNode> Node) {
67  ASTNodeSelection = std::move(Node);
68  }
69 
70 private:
71  /// The source manager for the translation unit / file on which a refactoring
72  /// action might operate on.
73  const SourceManager &SM;
74  /// An optional source selection range that's commonly used to represent
75  /// a selection in an editor.
76  SourceRange SelectionRange;
77  /// An optional AST for the translation unit on which a refactoring action
78  /// might operate on.
79  ASTContext *AST = nullptr;
80  /// The allocator for diagnostics.
82 
83  // FIXME: Remove when memoized.
84  std::unique_ptr<SelectedASTNode> ASTNodeSelection;
85 };
86 
87 } // end namespace tooling
88 } // end namespace clang
89 
90 #endif // LLVM_CLANG_TOOLING_REFACTOR_REFACTORING_RULE_CONTEXT_H
Defines the SourceManager interface.
SourceRange getSelectionRange() const
Returns the current source selection range as set by the refactoring engine.
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:149
llvm::Error createDiagnosticError(SourceLocation Loc, unsigned DiagID)
Creates an llvm::Error value that contains a diagnostic.
void setASTSelection(std::unique_ptr< SelectedASTNode > Node)
The refactoring rule context stores all of the inputs that might be needed by a refactoring action ru...
An allocator for Storage objects, which uses a small cache to objects, used to reduce malloc()/free()...
Encodes a location in the source.
const SourceManager & getSources() const
llvm::Error createDiagnosticError(unsigned DiagID)
ast_type_traits::DynTypedNode Node
Dataflow Directional Tag Classes.
static llvm::Error create(SourceLocation Loc, PartialDiagnostic Diag)
Creates a new DiagnosticError that contains the given diagnostic at the given location.
A trivial tuple used to represent a source range.
This class handles loading and caching of source files into memory.