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
|
/*
* 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.LocalInspectionToolSession;
import com.intellij.codeInspection.ProblemsHolder;
import com.intellij.psi.PsiComment;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiElementVisitor;
import com.intellij.psi.PsiFile;
import com.jetbrains.python.PyBundle;
import com.jetbrains.python.PythonFileType;
import com.jetbrains.python.inspections.quickfix.AddEncodingQuickFix;
import com.jetbrains.python.psi.LanguageLevel;
import com.jetbrains.python.psi.PyStringLiteralExpression;
import org.jetbrains.annotations.Nls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import javax.swing.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.nio.charset.Charset;
import java.nio.charset.CharsetEncoder;
/**
* User : catherine
*/
public class PyNonAsciiCharInspection extends PyInspection {
@Nls
@NotNull
@Override
public String getDisplayName() {
return PyBundle.message("INSP.NAME.non.ascii");
}
@NotNull
@Override
public PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder,
boolean isOnTheFly,
@NotNull LocalInspectionToolSession session) {
return new Visitor(holder, session);
}
private class Visitor extends PyInspectionVisitor {
public Visitor(@Nullable ProblemsHolder holder, @NotNull LocalInspectionToolSession session) {
super(holder, session);
}
@Override
public void visitComment(PsiComment node) {
checkString(node, node.getText());
}
private void checkString(PsiElement node, String value) {
if (LanguageLevel.forElement(node).isPy3K()) return;
PsiFile file = node.getContainingFile(); // can't cache this in the instance, alas
if (file == null) return;
final String charsetString = PythonFileType.getCharsetFromEncodingDeclaration(file);
boolean hasNonAscii = false;
CharsetEncoder asciiEncoder = Charset.forName("US-ASCII").newEncoder();
int length = value.length();
char c = 0;
for (int i = 0; i < length; ++i) {
c = value.charAt(i);
if (!asciiEncoder.canEncode(c)) {
hasNonAscii = true;
break;
}
}
if (hasNonAscii) {
if (charsetString == null)
registerProblem(node, "Non-ASCII character " + c + " in file, but no encoding declared",
new AddEncodingQuickFix(myDefaultEncoding, myEncodingFormatIndex));
}
}
@Override
public void visitPyStringLiteralExpression(PyStringLiteralExpression node) {
checkString(node, node.getText());
}
}
public String myDefaultEncoding = "utf-8";
public int myEncodingFormatIndex = 0;
@Override
public JComponent createOptionsPanel() {
final JComboBox defaultEncoding = new JComboBox(PyEncodingUtil.POSSIBLE_ENCODINGS);
defaultEncoding.setSelectedItem(myDefaultEncoding);
defaultEncoding.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
JComboBox cb = (JComboBox)e.getSource();
myDefaultEncoding = (String)cb.getSelectedItem();
}
});
final JComboBox encodingFormat = new JComboBox(PyEncodingUtil.ENCODING_FORMAT);
encodingFormat.setSelectedIndex(myEncodingFormatIndex);
encodingFormat.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
JComboBox cb = (JComboBox)e.getSource();
myEncodingFormatIndex = cb.getSelectedIndex();
}
});
return PyEncodingUtil.createEncodingOptionsPanel(defaultEncoding, encodingFormat);
}
}
|
