summaryrefslogtreecommitdiff
path: root/java/java-impl/src/com/intellij/refactoring/changeSignature/JavaChangeSignatureDetector.java
blob: 522ea10336f83ca2f0da107f9b89cc150c03b55f (plain)
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
/*
 * Copyright 2000-2011 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.refactoring.changeSignature;

import com.intellij.lang.Language;
import com.intellij.lang.StdLanguages;
import com.intellij.openapi.application.Result;
import com.intellij.openapi.command.WriteCommandAction;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.editor.Document;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.TextRange;
import com.intellij.psi.*;
import com.intellij.psi.impl.light.LightModifierList;
import com.intellij.psi.util.PsiTreeUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
 * User: anna
 * Date: Sep 6, 2010
 */
public class JavaChangeSignatureDetector implements LanguageChangeSignatureDetector {
  private static final Logger LOG = Logger.getInstance("#" + JavaChangeSignatureDetector.class.getName());

  @Override
  public ChangeInfo createInitialChangeInfo(final @NotNull PsiElement element) {
    final PsiMethod method = PsiTreeUtil.getParentOfType(element, PsiMethod.class, false);
    if (method != null && isInsideMethodSignature(element, method)) {
      //do not initialize change signature on return type change
      if (element.getTextRange().getEndOffset() <= method.getTextOffset()) return null;
      return DetectedJavaChangeInfo.createFromMethod(method);
    } else {
      final PsiVariable variable = PsiTreeUtil.getParentOfType(element, PsiVariable.class);
      if (variable != null) {
        return new RenameChangeInfo(variable, null) {
          @Override
          public Language getLanguage() {
            return StdLanguages.JAVA;
          }
        };
      }
    }
    return null;
  }

  @Override
  public boolean performChange(final ChangeInfo changeInfo, ChangeInfo initialChangeInfo, @NotNull final String oldText, boolean silently) {
    if (changeInfo instanceof DetectedJavaChangeInfo) {
      return ((DetectedJavaChangeInfo)changeInfo).perform(initialChangeInfo, oldText, silently);
    } else if (changeInfo instanceof RenameChangeInfo) {
      ((RenameChangeInfo)changeInfo).perform();
      return true;
    }
    return false;

  }

  @Override
  public boolean isChangeSignatureAvailableOnElement(PsiElement element, ChangeInfo currentInfo) {
    if (currentInfo instanceof RenameChangeInfo) {
      final PsiElement nameIdentifier = ((RenameChangeInfo)currentInfo).getNameIdentifier();
      if (nameIdentifier != null) {
        final TextRange nameIdentifierTextRange = nameIdentifier.getTextRange();
        return nameIdentifierTextRange.contains(element.getTextRange()) ||
               nameIdentifierTextRange.getEndOffset() == element.getTextOffset();
      }
    }
    else if (currentInfo instanceof JavaChangeInfo) {
      final PsiMethod method = (PsiMethod)currentInfo.getMethod();
      return getSignatureRange(method).contains(element.getTextRange());
    }
    return false;
  }

  @Override
  public boolean ignoreChanges(PsiElement element) {
    if (element instanceof PsiMethod) return true;
    return PsiTreeUtil.getParentOfType(element, PsiImportList.class) != null;
  }

  @Nullable
  @Override
  public TextRange getHighlightingRange(ChangeInfo changeInfo) {
    if (changeInfo == null) return null;
    if (changeInfo instanceof RenameChangeInfo) {
      PsiElement nameIdentifier = ((RenameChangeInfo)changeInfo).getNameIdentifier();
      return nameIdentifier != null ? nameIdentifier.getTextRange() : null;
    }

    PsiElement method = changeInfo.getMethod();
    return method instanceof PsiMethod ? getSignatureRange((PsiMethod)method) : null;
  }

  @Nullable
  @Override
  public String extractSignature(PsiElement element, @NotNull ChangeInfo initialChangeInfo) {
    final PsiMethod method = PsiTreeUtil.getParentOfType(element, PsiMethod.class, false);
    if (method != null && isInsideMethodSignature(element, method) && method == initialChangeInfo.getMethod()) {
      final TextRange signatureRange = getSignatureRange(method);
      return element.getContainingFile().getText().substring(signatureRange.getStartOffset(), signatureRange.getEndOffset());
    } else if (element instanceof PsiIdentifier && element.getParent() instanceof PsiNamedElement) {
      return element.getText();
    }
    return null;
  }

  @Override
  public ChangeInfo createNextChangeInfo(String signature, @NotNull final ChangeInfo currentInfo, String initialName) {
    final Project project = currentInfo.getMethod().getProject();
    if (currentInfo instanceof RenameChangeInfo) {
      return currentInfo;
    }
    
    final PsiMethod oldMethod = (PsiMethod)currentInfo.getMethod();
    String visibility = "";
    PsiClass containingClass = oldMethod.getContainingClass();
    if (containingClass != null && containingClass.isInterface()) {
      visibility = PsiModifier.PUBLIC + " ";
    }
    PsiMethod method = JavaPsiFacade.getElementFactory(project).createMethodFromText((visibility + signature).trim(), oldMethod);
    return ((DetectedJavaChangeInfo)currentInfo).createNextInfo(method);
  }

  private static boolean isInsideMethodSignature(PsiElement element, @NotNull PsiMethod method) {
    final PsiCodeBlock body = method.getBody();
    final TextRange textRange = element.getTextRange();
    final PsiModifierList psiModifierList = method.getModifierList();
    if (psiModifierList instanceof LightModifierList) return false;
    if (body != null) {
      return textRange.getEndOffset() <= body.getTextOffset() && textRange.getStartOffset() >= psiModifierList.getTextRange().getEndOffset();
    }
    return textRange.getStartOffset() >= psiModifierList.getTextRange().getEndOffset() &&
           textRange.getEndOffset() <= method.getTextRange().getEndOffset();
  }

  public static TextRange getSignatureRange(PsiMethod method) {
    final PsiCodeBlock body = method.getBody();
    if (body != null) {
      return new TextRange(method.getTextRange().getStartOffset(), body.getTextOffset());
    }
    return new TextRange(method.getTextRange().getStartOffset(),
                         method.getTextRange().getEndOffset());
  }

  @Override
  public boolean isMoveParameterAvailable(PsiElement element, boolean left) {
    if (element instanceof PsiParameter) {
      final PsiParameter parameter = (PsiParameter)element;
      final PsiElement declarationScope = parameter.getDeclarationScope();
      if (declarationScope instanceof PsiMethod) {
        final PsiMethod method = (PsiMethod)declarationScope;
        final int parameterIndex = method.getParameterList().getParameterIndex(parameter);
        if (left) {
          return parameterIndex > 0;
        } else {
          return parameterIndex < method.getParameterList().getParametersCount() - 1;
        }
      }
    }
    return false;
  }

  @Override
  public void moveParameter(final PsiElement element, final Editor editor, final boolean left) {
    final PsiParameter parameter = (PsiParameter)element;
    final PsiMethod method = (PsiMethod)parameter.getDeclarationScope();
    final int parameterIndex = method.getParameterList().getParameterIndex(parameter);
    new WriteCommandAction(element.getProject(), MOVE_PARAMETER){
      @Override
      protected void run(Result result) throws Throwable {
        final PsiParameterList parameterList = method.getParameterList();
        final PsiParameter[] parameters = parameterList.getParameters();
        final int deltaOffset = editor.getCaretModel().getOffset() - parameter.getTextRange().getStartOffset();
        final PsiParameter frst = left ? parameters[parameterIndex - 1] : parameter;
        final PsiParameter scnd = left ? parameter : parameters[parameterIndex + 1];
        final int startOffset = frst.getTextRange().getStartOffset();
        final int endOffset = scnd.getTextRange().getEndOffset();

        final PsiFile file = method.getContainingFile();
        final Document document = PsiDocumentManager.getInstance(getProject()).getDocument(file);
        if (document != null) {
          final String comma_whitespace_between =
            document.getText().substring(frst.getTextRange().getEndOffset(), scnd.getTextRange().getStartOffset());
          document.replaceString(startOffset, endOffset, scnd.getText() + comma_whitespace_between + frst.getText());
          editor.getCaretModel().moveToOffset(document.getText().indexOf(parameter.getText(), startOffset) + deltaOffset);
        }
      }
    }.execute();
  }
}