clang-tools  12.0.0git
Rename.h
Go to the documentation of this file.
1 //===--- Rename.h - Symbol-rename refactorings -------------------*- 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 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_REFACTOR_RENAME_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANGD_REFACTOR_RENAME_H
11 
12 #include "Protocol.h"
13 #include "SourceCode.h"
14 #include "support/Path.h"
15 #include "clang/Basic/LangOptions.h"
16 #include "clang/Tooling/Core/Replacement.h"
17 #include "llvm/Support/Error.h"
18 
19 namespace clang {
20 namespace clangd {
21 class ParsedAST;
22 class SymbolIndex;
23 
24 /// Gets dirty buffer for a given file \p AbsPath.
25 /// Returns None if there is no dirty buffer for the given file.
26 using DirtyBufferGetter =
27  llvm::function_ref<llvm::Optional<std::string>(PathRef AbsPath)>;
28 
29 struct RenameOptions {
30  /// If true, enable cross-file rename; otherwise, only allows to rename a
31  /// symbol that's only used in the current file.
32  bool AllowCrossFile = false;
33  /// The maximum number of affected files (0 means no limit), only meaningful
34  /// when AllowCrossFile = true.
35  /// If the actual number exceeds the limit, rename is forbidden.
36  size_t LimitFiles = 50;
37  /// If true, format the rename edits, only meaningful in ClangdServer layer.
38  bool WantFormat = false;
39 };
40 
41 struct RenameInputs {
42  Position Pos; // the position triggering the rename
43  llvm::StringRef NewName;
44 
46  llvm::StringRef MainFilePath;
47 
48  const SymbolIndex *Index = nullptr;
49 
50  RenameOptions Opts = {};
51  // When set, used by the rename to get file content for all rename-related
52  // files.
53  // If there is no corresponding dirty buffer, we will use the file content
54  // from disk.
55  DirtyBufferGetter GetDirtyBuffer = nullptr;
56 };
57 
58 /// Renames all occurrences of the symbol. The result edits are unformatted.
59 /// If AllowCrossFile is false, returns an error if rename a symbol that's used
60 /// in another file (per the index).
61 llvm::Expected<FileEdits> rename(const RenameInputs &RInputs);
62 
63 /// Generates rename edits that replaces all given occurrences with the
64 /// NewName.
65 /// Exposed for testing only.
66 /// REQUIRED: Occurrences is sorted and doesn't have duplicated ranges.
67 llvm::Expected<Edit> buildRenameEdit(llvm::StringRef AbsFilePath,
68  llvm::StringRef InitialCode,
69  std::vector<Range> Occurrences,
70  llvm::StringRef NewName);
71 
72 /// Adjusts indexed occurrences to match the current state of the file.
73 ///
74 /// The Index is not always up to date. Blindly editing at the locations
75 /// reported by the index may mangle the code in such cases.
76 /// This function determines whether the indexed occurrences can be applied to
77 /// this file, and heuristically repairs the occurrences if necessary.
78 ///
79 /// The API assumes that Indexed contains only named occurrences (each
80 /// occurrence has the same length).
81 /// REQUIRED: Indexed is sorted.
82 llvm::Optional<std::vector<Range>>
83 adjustRenameRanges(llvm::StringRef DraftCode, llvm::StringRef Identifier,
84  std::vector<Range> Indexed, const LangOptions &LangOpts);
85 
86 /// Calculates the lexed occurrences that the given indexed occurrences map to.
87 /// Returns None if we don't find a mapping.
88 ///
89 /// Exposed for testing only.
90 ///
91 /// REQUIRED: Indexed and Lexed are sorted.
92 llvm::Optional<std::vector<Range>> getMappedRanges(ArrayRef<Range> Indexed,
93  ArrayRef<Range> Lexed);
94 /// Evaluates how good the mapped result is. 0 indicates a perfect match.
95 ///
96 /// Exposed for testing only.
97 ///
98 /// REQUIRED: Indexed and Lexed are sorted, Indexed and MappedIndex have the
99 /// same size.
100 size_t renameRangeAdjustmentCost(ArrayRef<Range> Indexed, ArrayRef<Range> Lexed,
101  ArrayRef<size_t> MappedIndex);
102 
103 } // namespace clangd
104 } // namespace clang
105 
106 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_REFACTOR_RENAME_H
bool AllowCrossFile
If true, enable cross-file rename; otherwise, only allows to rename a symbol that&#39;s only used in the ...
Definition: Rename.h:32
size_t LimitFiles
The maximum number of affected files (0 means no limit), only meaningful when AllowCrossFile = true...
Definition: Rename.h:36
llvm::Optional< std::vector< Range > > getMappedRanges(ArrayRef< Range > Indexed, ArrayRef< Range > Lexed)
Calculates the lexed occurrences that the given indexed occurrences map to.
Definition: Rename.cpp:617
llvm::function_ref< llvm::Optional< std::string >(PathRef AbsPath)> DirtyBufferGetter
Gets dirty buffer for a given file AbsPath.
Definition: Rename.h:27
Interface for symbol indexes that can be used for searching or matching symbols among a set of symbol...
Definition: Index.h:85
llvm::StringRef PathRef
A typedef to represent a ref to file path.
Definition: Path.h:23
llvm::StringRef MainFilePath
Definition: Rename.h:46
llvm::StringRef NewName
Definition: Rename.h:43
bool WantFormat
If true, format the rename edits, only meaningful in ClangdServer layer.
Definition: Rename.h:38
Stores and provides access to parsed AST.
Definition: ParsedAST.h:48
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
size_t renameRangeAdjustmentCost(ArrayRef< Range > Indexed, ArrayRef< Range > Lexed, ArrayRef< size_t > MappedIndex)
Evaluates how good the mapped result is.
Definition: Rename.cpp:685
llvm::Optional< std::vector< Range > > adjustRenameRanges(llvm::StringRef DraftCode, llvm::StringRef Identifier, std::vector< Range > Indexed, const LangOptions &LangOpts)
Adjusts indexed occurrences to match the current state of the file.
Definition: Rename.cpp:606
llvm::Expected< FileEdits > rename(const RenameInputs &RInputs)
Renames all occurrences of the symbol.
Definition: Rename.cpp:442
llvm::Expected< Edit > buildRenameEdit(llvm::StringRef AbsFilePath, llvm::StringRef InitialCode, std::vector< Range > Occurrences, llvm::StringRef NewName)
Generates rename edits that replaces all given occurrences with the NewName.
Definition: Rename.cpp:536
const SymbolIndex * Index
Definition: Dexp.cpp:95