clang-tools  14.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 struct RenameOptions {
25  /// The maximum number of affected files (0 means no limit), only meaningful
26  /// when AllowCrossFile = true.
27  /// If the actual number exceeds the limit, rename is forbidden.
28  size_t LimitFiles = 50;
29  /// If true, format the rename edits, only meaningful in ClangdServer layer.
30  bool WantFormat = false;
31 };
32 
33 struct RenameInputs {
34  Position Pos; // the position triggering the rename
35  llvm::StringRef NewName;
36 
38  llvm::StringRef MainFilePath;
39 
40  // The filesystem to query when performing cross file renames.
41  // If this is set, Index must also be set, likewise if this is nullptr, Index
42  // must also be nullptr.
43  llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> FS = nullptr;
44 
45  const SymbolIndex *Index = nullptr;
46 
48 };
49 
50 struct RenameResult {
51  // The range of the symbol that the user can attempt to rename.
53  // Rename occurrences for the current main file.
54  std::vector<Range> LocalChanges;
55  // Complete edits for the rename, including LocalChanges.
56  // If the full set of changes is unknown, this field is empty.
58 };
59 
60 /// Renames all occurrences of the symbol. The result edits are unformatted.
61 /// If AllowCrossFile is false, returns an error if rename a symbol that's used
62 /// in another file (per the index).
63 llvm::Expected<RenameResult> rename(const RenameInputs &RInputs);
64 
65 /// Generates rename edits that replaces all given occurrences with the
66 /// NewName.
67 /// Exposed for testing only.
68 /// REQUIRED: Occurrences is sorted and doesn't have duplicated ranges.
69 llvm::Expected<Edit> buildRenameEdit(llvm::StringRef AbsFilePath,
70  llvm::StringRef InitialCode,
71  std::vector<Range> Occurrences,
72  llvm::StringRef NewName);
73 
74 /// Adjusts indexed occurrences to match the current state of the file.
75 ///
76 /// The Index is not always up to date. Blindly editing at the locations
77 /// reported by the index may mangle the code in such cases.
78 /// This function determines whether the indexed occurrences can be applied to
79 /// this file, and heuristically repairs the occurrences if necessary.
80 ///
81 /// The API assumes that Indexed contains only named occurrences (each
82 /// occurrence has the same length).
83 /// REQUIRED: Indexed is sorted.
84 llvm::Optional<std::vector<Range>>
85 adjustRenameRanges(llvm::StringRef DraftCode, llvm::StringRef Identifier,
86  std::vector<Range> Indexed, const LangOptions &LangOpts);
87 
88 /// Calculates the lexed occurrences that the given indexed occurrences map to.
89 /// Returns None if we don't find a mapping.
90 ///
91 /// Exposed for testing only.
92 ///
93 /// REQUIRED: Indexed and Lexed are sorted.
94 llvm::Optional<std::vector<Range>> getMappedRanges(ArrayRef<Range> Indexed,
95  ArrayRef<Range> Lexed);
96 /// Evaluates how good the mapped result is. 0 indicates a perfect match.
97 ///
98 /// Exposed for testing only.
99 ///
100 /// REQUIRED: Indexed and Lexed are sorted, Indexed and MappedIndex have the
101 /// same size.
102 size_t renameRangeAdjustmentCost(ArrayRef<Range> Indexed, ArrayRef<Range> Lexed,
103  ArrayRef<size_t> MappedIndex);
104 
105 } // namespace clangd
106 } // namespace clang
107 
108 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_REFACTOR_RENAME_H
clang::clangd::rename
llvm::Expected< RenameResult > rename(const RenameInputs &RInputs)
Renames all occurrences of the symbol.
Definition: Rename.cpp:697
clang::clangd::RenameResult::Target
Range Target
Definition: Rename.h:52
clang::clangd::RenameInputs
Definition: Rename.h:33
Path.h
clang::clangd::RenameInputs::MainFilePath
llvm::StringRef MainFilePath
Definition: Rename.h:38
clang::clangd::RenameInputs::AST
ParsedAST & AST
Definition: Rename.h:37
clang::clangd::RenameResult
Definition: Rename.h:50
clang::clangd::RenameResult::GlobalChanges
FileEdits GlobalChanges
Definition: Rename.h:57
clang::clangd::RenameInputs::Opts
RenameOptions Opts
Definition: Rename.h:47
Protocol.h
clang::clangd::Position
Definition: Protocol.h:148
clang::clangd::RenameInputs::FS
llvm::IntrusiveRefCntPtr< llvm::vfs::FileSystem > FS
Definition: Rename.h:43
clang::clangd::RenameInputs::Index
const SymbolIndex * Index
Definition: Rename.h:45
clang::clangd::buildRenameEdit
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:810
clang::clangd::RenameOptions
Definition: Rename.h:24
clang::clangd::RenameResult::LocalChanges
std::vector< Range > LocalChanges
Definition: Rename.h:54
clang::clangd::getMappedRanges
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:889
SourceCode.h
clang::clangd::SymbolIndex
Interface for symbol indexes that can be used for searching or matching symbols among a set of symbol...
Definition: Index.h:111
clang::clangd::RenameOptions::LimitFiles
size_t LimitFiles
The maximum number of affected files (0 means no limit), only meaningful when AllowCrossFile = true.
Definition: Rename.h:28
clang::clangd::Range
Definition: Protocol.h:177
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::clangd::renameRangeAdjustmentCost
size_t renameRangeAdjustmentCost(ArrayRef< Range > Indexed, ArrayRef< Range > Lexed, ArrayRef< size_t > MappedIndex)
Evaluates how good the mapped result is.
Definition: Rename.cpp:957
clang::clangd::FileEdits
llvm::StringMap< Edit > FileEdits
A mapping from absolute file path (the one used for accessing the underlying VFS) to edits.
Definition: SourceCode.h:203
clang::clangd::ParsedAST
Stores and provides access to parsed AST.
Definition: ParsedAST.h:49
clang::clangd::RenameInputs::Pos
Position Pos
Definition: Rename.h:34
clang::clangd::adjustRenameRanges
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:878
clang::clangd::RenameOptions::WantFormat
bool WantFormat
If true, format the rename edits, only meaningful in ClangdServer layer.
Definition: Rename.h:30
clang::clangd::RenameInputs::NewName
llvm::StringRef NewName
Definition: Rename.h:35