/*
* Copyright 2003-2015 Dave Griffith, Bas Leijdekkers
*
* 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.siyeh.ig;
import com.intellij.codeInsight.daemon.HighlightDisplayKey;
import com.intellij.codeInspection.BaseJavaBatchLocalInspectionTool;
import com.intellij.codeInspection.InspectionProfileEntry;
import com.intellij.codeInspection.ProblemsHolder;
import com.intellij.codeInspection.ex.InspectionProfileImpl;
import com.intellij.openapi.util.DefaultJDOMExternalizer;
import com.intellij.openapi.util.WriteExternalException;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.profile.codeInspection.InspectionProjectProfileManager;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiElementVisitor;
import com.intellij.psi.PsiFile;
import com.intellij.ui.DocumentAdapter;
import com.intellij.util.ReflectionUtil;
import com.intellij.util.ui.UIUtil;
import org.jdom.Element;
import org.jetbrains.annotations.Nls;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import javax.swing.*;
import javax.swing.event.DocumentEvent;
import javax.swing.text.Document;
import java.lang.reflect.Field;
import java.text.NumberFormat;
import java.text.ParseException;
import java.util.List;
public abstract class BaseInspection extends BaseJavaBatchLocalInspectionTool {
private String m_shortName = null;
@Override
@NotNull
public String getShortName() {
if (m_shortName == null) {
final Class<? extends BaseInspection> aClass = getClass();
final String name = aClass.getSimpleName();
m_shortName = InspectionProfileEntry.getShortName(name);
if (m_shortName.equals(name)) {
throw new AssertionError("class name must end with 'Inspection' to correctly calculate the short name: " + name);
}
}
return m_shortName;
}
@Nls
@NotNull
@Override
public abstract String getDisplayName();
@Override
@Nls
@NotNull
public final String getGroupDisplayName() {
return GroupDisplayNameUtil.getGroupDisplayName(getClass());
}
@NotNull
protected abstract String buildErrorString(Object... infos);
protected boolean buildQuickFixesOnlyForOnTheFlyErrors() {
return false;
}
@Nullable
protected InspectionGadgetsFix buildFix(Object... infos) {
return null;
}
@NotNull
protected InspectionGadgetsFix[] buildFixes(Object... infos) {
return InspectionGadgetsFix.EMPTY_ARRAY;
}
protected void writeBooleanOption(@NotNull Element node, @NotNull @NonNls String property, boolean defaultValueToIgnore) {
final Boolean value = ReflectionUtil.getField(this.getClass(), this, boolean.class, property);
assert value != null;
if (defaultValueToIgnore == value.booleanValue()) {
return;
}
node.addContent(new Element("option").setAttribute("name", property).setAttribute("value", value.toString()));
}
protected void defaultWriteSettings(@NotNull Element node, final String... excludedProperties) throws WriteExternalException {
DefaultJDOMExternalizer.writeExternal(this, node, new DefaultJDOMExternalizer.JDOMFilter() {
@Override
public boolean isAccept(@NotNull Field field) {
final String name = field.getName();
for (String property : excludedProperties) {
if (name.equals(property)) {
return false;
}
}
return true;
}
});
}
public abstract BaseInspectionVisitor buildVisitor();
@Override
@NotNull
public final PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder, boolean isOnTheFly) {
final PsiFile file = holder.getFile();
assert file.isPhysical();
if (!shouldInspect(file)) {
return PsiElementVisitor.EMPTY_VISITOR;
}
final BaseInspectionVisitor visitor = buildVisitor();
visitor.setProblemsHolder(holder);
visitor.setOnTheFly(isOnTheFly);
visitor.setInspection(this);
return visitor;
}
/**
* To check precondition(s) on the entire file, to prevent doing the check on every PsiElement visited.
* Useful for e.g. a {@link com.intellij.psi.util.PsiUtil#isLanguageLevel5OrHigher(com.intellij.psi.PsiElement)} check
* which will be the same for all elements in the specified file.
* When this method returns false, {@link #buildVisitor()} will not be called.
*/
public boolean shouldInspect(PsiFile file) {
return true;
}
protected JFormattedTextField prepareNumberEditor(@NonNls final String fieldName) {
final NumberFormat formatter = NumberFormat.getIntegerInstance();
formatter.setParseIntegerOnly(true);
final JFormattedTextField valueField = new JFormattedTextField(formatter);
Object value = ReflectionUtil.getField(getClass(), this, null, fieldName);
valueField.setValue(value);
valueField.setColumns(2);
// hack to work around text field becoming unusably small sometimes when using GridBagLayout
valueField.setMinimumSize(valueField.getPreferredSize());
UIUtil.fixFormattedField(valueField);
final Document document = valueField.getDocument();
document.addDocumentListener(new DocumentAdapter() {
@Override
public void textChanged(DocumentEvent evt) {
try {
valueField.commitEdit();
final Number number = (Number)valueField.getValue();
ReflectionUtil.setField(BaseInspection.this.getClass(), BaseInspection.this, int.class, fieldName, number.intValue());
}
catch (ParseException e) {
// No luck this time. Will update the field when correct value is entered.
}
}
});
return valueField;
}
@SafeVarargs
public static void parseString(String string, List<String>... outs) {
final List<String> strings = StringUtil.split(string, ",");
for (List<String> out : outs) {
out.clear();
}
final int iMax = strings.size();
for (int i = 0; i < iMax; i += outs.length) {
for (int j = 0; j < outs.length; j++) {
final List<String> out = outs[j];
if (i + j >= iMax) {
out.add("");
}
else {
out.add(strings.get(i + j));
}
}
}
}
@SafeVarargs
public static String formatString(List<String>... strings) {
final StringBuilder buffer = new StringBuilder();
final int size = strings[0].size();
if (size > 0) {
formatString(strings, 0, buffer);
for (int i = 1; i < size; i++) {
buffer.append(',');
formatString(strings, i, buffer);
}
}
return buffer.toString();
}
private static void formatString(List<String>[] strings, int index, StringBuilder out) {
out.append(strings[0].get(index));
for (int i = 1; i < strings.length; i++) {
out.append(',');
out.append(strings[i].get(index));
}
}
public static boolean isInspectionEnabled(@NonNls String shortName, PsiElement context) {
final InspectionProjectProfileManager profileManager = InspectionProjectProfileManager.getInstance(context.getProject());
final InspectionProfileImpl profile = profileManager.getCurrentProfile();
return profile.isToolEnabled(HighlightDisplayKey.find(shortName), context);
}
}