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
|
/*
* Copyright 2000-2013 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.jetbrains.python.inspections;
import com.intellij.codeInspection.*;
import com.intellij.codeInspection.ex.ProblemDescriptorImpl;
import com.intellij.openapi.util.Key;
import com.intellij.openapi.util.TextRange;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiErrorElement;
import com.jetbrains.python.psi.PyElementVisitor;
import com.jetbrains.python.psi.resolve.PyResolveContext;
import com.jetbrains.python.psi.types.TypeEvalContext;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* @author dcheryasov
*/
public abstract class PyInspectionVisitor extends PyElementVisitor {
@Nullable private final ProblemsHolder myHolder;
@NotNull private final LocalInspectionToolSession mySession;
protected final TypeEvalContext myTypeEvalContext;
public static final Key<TypeEvalContext> INSPECTION_TYPE_EVAL_CONTEXT = Key.create("PyInspectionTypeEvalContext");
public PyInspectionVisitor(@Nullable ProblemsHolder holder,
@NotNull LocalInspectionToolSession session) {
myHolder = holder;
mySession = session;
TypeEvalContext context;
synchronized (INSPECTION_TYPE_EVAL_CONTEXT) {
context = session.getUserData(INSPECTION_TYPE_EVAL_CONTEXT);
if (context == null) {
context = TypeEvalContext.codeAnalysis(session.getFile());
session.putUserData(INSPECTION_TYPE_EVAL_CONTEXT, context);
}
}
myTypeEvalContext = context;
}
protected PyResolveContext getResolveContext() {
return PyResolveContext.noImplicits().withTypeEvalContext(myTypeEvalContext);
}
@Nullable
protected ProblemsHolder getHolder() {
return myHolder;
}
@NotNull
public LocalInspectionToolSession getSession() {
return mySession;
}
protected final void registerProblem(final PsiElement element,
final String message) {
if (element == null || element.getTextLength() == 0) {
return;
}
if (myHolder != null) {
myHolder.registerProblem(element, message);
}
}
protected final void registerProblem(@Nullable final PsiElement element,
@NotNull final String message,
@NotNull final LocalQuickFix quickFix) {
if (element == null || element.getTextLength() == 0) {
return;
}
if (myHolder != null) {
myHolder.registerProblem(element, message, quickFix);
}
}
protected final void registerProblem(final PsiElement element,
final String message,
final ProblemHighlightType type) {
if (element == null || element.getTextLength() == 0) {
return;
}
if (myHolder != null) {
myHolder.registerProblem(myHolder.getManager().createProblemDescriptor(element, message, (LocalQuickFix)null, type, myHolder.isOnTheFly()));
}
}
/**
* The most full-blown version.
*
* @see com.intellij.codeInspection.ProblemDescriptor
*/
protected final void registerProblem(
@NotNull final PsiElement psiElement,
@NotNull final String descriptionTemplate,
final ProblemHighlightType highlightType,
@Nullable final HintAction hintAction,
final LocalQuickFix... fixes) {
registerProblem(psiElement, descriptionTemplate, highlightType, hintAction, null, fixes);
}
/**
* The most full-blown version.
*
* @see ProblemDescriptor
*/
protected final void registerProblem(
@NotNull final PsiElement psiElement,
@NotNull final String descriptionTemplate,
final ProblemHighlightType highlightType,
@Nullable final HintAction hintAction,
@Nullable final TextRange rangeInElement,
final LocalQuickFix... fixes) {
if (myHolder != null && !(psiElement instanceof PsiErrorElement)) {
myHolder.registerProblem(new ProblemDescriptorImpl(psiElement, psiElement, descriptionTemplate, fixes, highlightType, false,
rangeInElement, hintAction, myHolder.isOnTheFly()));
}
}
}
|
