inplace change signature: delegate in template
[idea/community.git] / platform / lang-impl / src / com / intellij / refactoring / changeSignature / inplace / LanguageChangeSignatureDetector.java
1 /*
2  * Copyright 2000-2016 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.refactoring.changeSignature.inplace;
17
18 import com.intellij.openapi.editor.Editor;
19 import com.intellij.openapi.fileTypes.FileType;
20 import com.intellij.openapi.util.TextRange;
21 import com.intellij.psi.PsiElement;
22 import com.intellij.refactoring.changeSignature.ChangeInfo;
23 import org.jetbrains.annotations.NotNull;
24 import org.jetbrains.annotations.Nullable;
25
26 import java.util.List;
27
28 /**
29  * User: anna
30  * Date: Sep 6, 2010
31  */
32 public interface LanguageChangeSignatureDetector<C extends ChangeInfo> {
33
34   @NotNull  C createInitialChangeInfo(final @NotNull PsiElement element);
35   boolean ignoreChanges(PsiElement element);
36   @Nullable C createNextChangeInfo(String signature, @NotNull C currentInfo, boolean delegate);
37
38   void performChange(C changeInfo, Editor editor, @NotNull String oldText);
39
40   boolean isChangeSignatureAvailableOnElement(@NotNull PsiElement element, C currentInfo);
41
42   TextRange getHighlightingRange(@NotNull C changeInfo);
43
44   default @NotNull String extractSignature(@NotNull C initialChangeInfo) {
45     final TextRange signatureRange = getHighlightingRange(initialChangeInfo);
46     return signatureRange.shiftRight(-signatureRange.getStartOffset()).substring(initialChangeInfo.getMethod().getText());
47   }
48
49   default String getMethodSignaturePreview(C info, final List<TextRange> deleteRanges, final List<TextRange> newRanges) {
50     return extractSignature(info);
51   }
52
53   FileType getFileType();
54 }