-
Notifications
You must be signed in to change notification settings - Fork 5.2k
/
PsiElementRenameHandler.java
257 lines (220 loc) · 11 KB
/
PsiElementRenameHandler.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
// Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
package com.intellij.refactoring.rename;
import com.intellij.ide.scratch.ScratchUtil;
import com.intellij.openapi.actionSystem.CommonDataKeys;
import com.intellij.openapi.actionSystem.DataContext;
import com.intellij.openapi.actionSystem.DataKey;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.editor.ScrollType;
import com.intellij.openapi.extensions.ExtensionPointName;
import com.intellij.openapi.fileEditor.impl.NonProjectFileWritingAccessProvider;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.MessageDialogBuilder;
import com.intellij.openapi.util.Condition;
import com.intellij.openapi.util.NlsContexts;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.psi.*;
import com.intellij.psi.impl.source.tree.injected.InjectedLanguageUtilBase;
import com.intellij.psi.meta.PsiMetaOwner;
import com.intellij.psi.meta.PsiWritableMetaData;
import com.intellij.psi.util.PsiUtilCore;
import com.intellij.refactoring.RefactoringBundle;
import com.intellij.refactoring.util.CommonRefactoringUtil;
import com.intellij.util.ui.UIUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import static java.util.Objects.requireNonNullElse;
/**
* created at Nov 13, 2001
*
* @author Jeka, dsl
*/
public class PsiElementRenameHandler implements RenameHandler {
private static final Logger LOG = Logger.getInstance(PsiElementRenameHandler.class);
private static final ExtensionPointName<Condition<? super PsiElement>> VETO_RENAME_CONDITION_EP = ExtensionPointName.create("com.intellij.vetoRenameCondition");
public static final DataKey<String> DEFAULT_NAME = DataKey.create("DEFAULT_NAME");
public static final DataKey<List<String>> NAME_SUGGESTIONS = DataKey.create("renameNameSuggestions");
@Override
public void invoke(@NotNull Project project, Editor editor, PsiFile file, @NotNull DataContext dataContext) {
PsiElement element = getElement(dataContext);
if (element == null) {
element = CommonRefactoringUtil.getElementAtCaret(editor, file);
}
if (ApplicationManager.getApplication().isUnitTestMode()) {
final String newName = DEFAULT_NAME.getData(dataContext);
if (newName != null) {
rename(element, project, element, editor, newName);
return;
}
}
editor.getScrollingModel().scrollToCaret(ScrollType.MAKE_VISIBLE);
final PsiElement nameSuggestionContext = InjectedLanguageUtilBase.findElementAtNoCommit(file, editor.getCaretModel().getOffset());
boolean checkInProject = shouldCheckInProject();
List<String> suggestedNames = requireNonNullElse(NAME_SUGGESTIONS.getData(dataContext), List.of());
invoke(element, project, nameSuggestionContext, suggestedNames, editor, checkInProject);
}
@Override
public void invoke(@NotNull Project project, PsiElement @NotNull [] elements, DataContext dataContext) {
PsiElement element = elements.length == 1 ? elements[0] : null;
if (element == null) element = getElement(dataContext);
LOG.assertTrue(element != null);
Editor editor = CommonDataKeys.EDITOR.getData(dataContext);
if (ApplicationManager.getApplication().isUnitTestMode()) {
final String newName = DEFAULT_NAME.getData(dataContext);
LOG.assertTrue(newName != null);
rename(element, project, element, editor, newName);
}
else {
invoke(element, project, element, editor, shouldCheckInProject());
}
}
protected boolean shouldCheckInProject() {
return true;
}
public static void invoke(@NotNull PsiElement element, @NotNull Project project, PsiElement nameSuggestionContext, @Nullable Editor editor) {
invoke(element, project, nameSuggestionContext, editor, true);
}
public static void invoke(@NotNull PsiElement element,
@NotNull Project project,
PsiElement nameSuggestionContext,
@Nullable Editor editor,
boolean checkInProject) {
invoke(element, project, nameSuggestionContext, List.of(), editor, checkInProject);
}
private static void invoke(@NotNull PsiElement element,
@NotNull Project project,
PsiElement nameSuggestionContext,
@NotNull List<String> suggestedNames,
@Nullable Editor editor,
boolean checkInProject) {
if (!canRename(project, editor, element)) {
return;
}
VirtualFile contextFile = PsiUtilCore.getVirtualFile(nameSuggestionContext);
if (checkInProject && nameSuggestionContext != null &&
nameSuggestionContext.isPhysical() &&
(contextFile == null || !ScratchUtil.isScratch(contextFile)) &&
!PsiManager.getInstance(project).isInProject(nameSuggestionContext)) {
final String message = RefactoringBundle.message("dialog.message.selected.element.used.from.non.project.files");
if (ApplicationManager.getApplication().isUnitTestMode()) throw new CommonRefactoringUtil.RefactoringErrorHintException(message);
if (!MessageDialogBuilder.yesNo(RefactoringBundle.getCannotRefactorMessage(null), message, UIUtil.getWarningIcon()).ask(project)) {
return;
}
}
var processor = RenamePsiElementProcessorBase.forPsiElement(element);
rename(element, project, nameSuggestionContext, suggestedNames, editor, null, processor);
}
public static boolean canRename(@NotNull Project project, Editor editor, PsiElement element) throws CommonRefactoringUtil.RefactoringErrorHintException {
String message = element == null ? null : renameabilityStatus(project, element);
if (StringUtil.isNotEmpty(message)) {
showErrorMessage(project, editor, message);
return false;
}
return true;
}
@Nullable
private static @NlsContexts.DialogMessage String renameabilityStatus(@NotNull Project project, @NotNull PsiElement element) {
boolean hasRenameProcessor = !(RenamePsiElementProcessorBase.forPsiElement(element) instanceof RenamePsiElementProcessorBase.DefaultRenamePsiElementProcessor);
boolean hasWritableMetaData = element instanceof PsiMetaOwner && ((PsiMetaOwner)element).getMetaData() instanceof PsiWritableMetaData;
if (!hasRenameProcessor && !hasWritableMetaData && !(element instanceof PsiNamedElement)) {
return RefactoringBundle.getCannotRefactorMessage(RefactoringBundle.message("error.wrong.caret.position.symbol.to.rename"));
}
if (!PsiManager.getInstance(project).isInProject(element)) {
if (element.isPhysical()) {
VirtualFile virtualFile = PsiUtilCore.getVirtualFile(element);
if (!(virtualFile != null && NonProjectFileWritingAccessProvider.isWriteAccessAllowed(virtualFile, project))) {
String message = RefactoringBundle.message("error.out.of.project.element", RenameUtil.getUsageViewType(element));
return RefactoringBundle.getCannotRefactorMessage(message);
}
}
if (!element.isWritable()) {
return RefactoringBundle.getCannotRefactorMessage(RefactoringBundle.message("error.cannot.be.renamed"));
}
}
if (InjectedLanguageUtilBase.isInInjectedLanguagePrefixSuffix(element)) {
final String message = RefactoringBundle.message("error.in.injected.lang.prefix.suffix", RenameUtil.getUsageViewType(element));
return RefactoringBundle.getCannotRefactorMessage(message);
}
return null;
}
private static void showErrorMessage(@NotNull Project project, @Nullable Editor editor, @NotNull @NlsContexts.DialogMessage String message) {
CommonRefactoringUtil.showErrorHint(project, editor, message, RefactoringBundle.message("rename.title"), null);
}
public static void rename(@NotNull PsiElement element, @NotNull Project project, PsiElement nameSuggestionContext, Editor editor) {
rename(element, project, nameSuggestionContext, editor, null);
}
public static void rename(@NotNull PsiElement element, @NotNull Project project, PsiElement nameSuggestionContext, Editor editor, String defaultName) {
RenamePsiElementProcessorBase processor = RenamePsiElementProcessorBase.forPsiElement(element);
rename(element, project, nameSuggestionContext, editor, defaultName, processor);
}
public static void rename(@NotNull PsiElement element,
@NotNull Project project,
PsiElement nameSuggestionContext,
Editor editor,
String defaultName,
RenamePsiElementProcessorBase processor) {
rename(element, project, nameSuggestionContext, List.of(), editor, defaultName, processor);
}
private static void rename(@NotNull PsiElement element,
@NotNull Project project,
PsiElement nameSuggestionContext,
@NotNull Collection<String> suggestedNames,
Editor editor,
String defaultName,
RenamePsiElementProcessorBase processor) {
PsiElement substituted = processor.substituteElementToRename(element, editor);
if (substituted == null || !canRename(project, editor, substituted)) return;
RenameRefactoringDialog dialog = processor.createDialog(project, substituted, nameSuggestionContext, editor);
dialog.addSuggestedNames(suggestedNames);
if (defaultName == null && ApplicationManager.getApplication().isUnitTestMode()) {
String[] strings = dialog.getSuggestedNames();
if (strings != null && strings.length > 0) {
Arrays.sort(strings);
defaultName = strings[0];
}
else {
defaultName = "undefined"; // need to avoid show dialog in test
}
}
if (defaultName != null) {
try {
dialog.performRename(defaultName);
}
finally {
dialog.close(); // to avoid dialog leak
}
}
else {
dialog.show();
}
}
@Override
public boolean isAvailableOnDataContext(@NotNull DataContext dataContext) {
return !isVetoed(getElement(dataContext));
}
public static boolean isVetoed(PsiElement element) {
if (element == null ||
element instanceof SyntheticElement ||
element instanceof PsiNamedElement namedElement && namedElement.getName() == null) {
return true;
}
for(Condition<? super PsiElement> condition: VETO_RENAME_CONDITION_EP.getExtensionList()) {
if (condition.value(element)) return true;
}
return false;
}
@Nullable
public static PsiElement getElement(@NotNull DataContext dataContext) {
PsiElement[] elementArray = CommonRefactoringUtil.getPsiElementArray(dataContext);
if (elementArray.length != 1) {
return null;
}
return elementArray[0];
}
}