PY-6637 Hide Python refactorings in library sources
[idea/community.git] / python / src / com / jetbrains / python / refactoring / PyBaseRefactoringAction.java
1 /*
2  * Copyright 2000-2015 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.jetbrains.python.refactoring;
17
18 import com.intellij.lang.Language;
19 import com.intellij.openapi.actionSystem.DataContext;
20 import com.intellij.openapi.editor.Editor;
21 import com.intellij.openapi.roots.ProjectRootManager;
22 import com.intellij.openapi.vfs.VirtualFile;
23 import com.intellij.psi.PsiElement;
24 import com.intellij.psi.PsiFile;
25 import com.intellij.refactoring.actions.BaseRefactoringAction;
26 import com.jetbrains.python.PythonLanguage;
27 import org.jetbrains.annotations.NotNull;
28
29 /**
30  * @author Mikhail Golubev
31  */
32 public abstract class PyBaseRefactoringAction extends BaseRefactoringAction {
33
34   protected abstract boolean isEnabledOnElementInsideEditor(@NotNull PsiElement element,
35                                                             @NotNull Editor editor,
36                                                             @NotNull PsiFile file,
37                                                             @NotNull DataContext context);
38
39   @Override
40   protected final boolean isAvailableOnElementInEditorAndFile(@NotNull PsiElement element,
41                                                               @NotNull Editor editor,
42                                                               @NotNull PsiFile file,
43                                                               @NotNull DataContext context) {
44     return isEnabledOnElementInsideEditor(element, editor, file, context);
45   }
46
47   protected abstract boolean isEnabledOnElementsOutsideEditor(@NotNull PsiElement[] elements);
48
49   @Override
50   protected final boolean isEnabledOnElements(@NotNull PsiElement[] elements) {
51     return isEnabledOnElementsOutsideEditor(elements);
52   }
53
54   @Override
55   protected final boolean isAvailableForLanguage(Language language) {
56     return language.isKindOf(PythonLanguage.getInstance());
57   }
58
59   @Override
60   protected boolean isAvailableForFile(PsiFile file) {
61     return isAvailableForLanguage(file.getLanguage()) && !isLibraryFile(file);
62   }
63
64   private static boolean isLibraryFile(@NotNull PsiFile file) {
65     final VirtualFile virtualFile = file.getVirtualFile();
66     if (virtualFile != null && ProjectRootManager.getInstance(file.getProject()).getFileIndex().isInLibraryClasses(virtualFile)) {
67       return true;
68     }
69     return false;
70   }
71 }