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.fileTypes.FileType;
  19 import com.intellij.openapi.util.TextRange;
  20 import com.intellij.psi.PsiElement;
  21 import com.intellij.refactoring.changeSignature.ChangeInfo;
  22 import org.jetbrains.annotations.NotNull;
  23 import org.jetbrains.annotations.Nullable;
  24
  25 import java.util.List;
  26
  27 /**
  28  * User: anna
  29  * Date: Sep 6, 2010
  30  */
  31 public interface LanguageChangeSignatureDetector<C extends ChangeInfo> {
  32
  33   @NotNull  C createInitialChangeInfo(final @NotNull PsiElement element);
  34   boolean ignoreChanges(PsiElement element);
  35   @Nullable C createNextChangeInfo(String signature, @NotNull C currentInfo, boolean delegate);
  36
  37   void performChange(C changeInfo, @NotNull String oldText);
  38
  39   boolean isChangeSignatureAvailableOnElement(@NotNull PsiElement element, C currentInfo);
  40
  41   TextRange getHighlightingRange(@NotNull C changeInfo);
  42
  43   default @NotNull String extractSignature(@NotNull C initialChangeInfo) {
  44     final TextRange signatureRange = getHighlightingRange(initialChangeInfo);
  45     return signatureRange.shiftRight(-signatureRange.getStartOffset()).substring(initialChangeInfo.getMethod().getText());
  46   }
  47
  48   default String getMethodSignaturePreview(C info, final List<TextRange> deleteRanges, final List<TextRange> newRanges) {
  49     return extractSignature(info);
  50   }
  51
  52   FileType getFileType();
  53 }