/*
* Copyright 2008-2013 Andre Pfeiler
*
* This file is part of FindBugs-IDEA.
*
* FindBugs-IDEA is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FindBugs-IDEA is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with FindBugs-IDEA. If not, see <http://www.gnu.org/licenses/>.
*/
package org.twodividedbyzero.idea.findbugs.gui.editor;
import com.intellij.codeInsight.daemon.GutterIconNavigationHandler;
import com.intellij.codeInsight.daemon.LineMarkerInfo;
import com.intellij.codeInsight.daemon.LineMarkerProvider;
import com.intellij.openapi.editor.markup.GutterIconRenderer;
import com.intellij.openapi.ui.popup.JBPopup;
import com.intellij.openapi.ui.popup.JBPopupFactory;
import com.intellij.psi.PsiAnonymousClass;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiFile;
import com.intellij.ui.awt.RelativePoint;
import com.intellij.util.Function;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.twodividedbyzero.idea.findbugs.common.ExtendedProblemDescriptor;
import org.twodividedbyzero.idea.findbugs.common.event.EventListener;
import org.twodividedbyzero.idea.findbugs.common.event.EventManagerImpl;
import org.twodividedbyzero.idea.findbugs.common.event.filters.BugReporterEventFilter;
import org.twodividedbyzero.idea.findbugs.common.event.types.BugReporterEvent;
import org.twodividedbyzero.idea.findbugs.common.util.BugInstanceUtil;
import org.twodividedbyzero.idea.findbugs.common.util.GuiUtil;
import org.twodividedbyzero.idea.findbugs.common.util.IdeaUtilImpl;
import org.twodividedbyzero.idea.findbugs.core.FindBugsPlugin;
import org.twodividedbyzero.idea.findbugs.gui.intentions.GroupBugIntentionListPopupStep;
import org.twodividedbyzero.idea.findbugs.gui.intentions.RootGroupBugIntentionListPopupStep;
import org.twodividedbyzero.idea.findbugs.intentions.ClearAndSuppressBugIntentionAction;
import org.twodividedbyzero.idea.findbugs.intentions.ClearBugIntentionAction;
import org.twodividedbyzero.idea.findbugs.intentions.SuppressReportBugForClassIntentionAction;
import org.twodividedbyzero.idea.findbugs.intentions.SuppressReportBugIntentionAction;
import java.awt.event.MouseEvent;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;
/**
* $Date: 2013-12-05 08:09:56 -0600 (Thu, 05 Dec 2013) $
*
* @author Andre Pfeiler<andrepdo@dev.java.net>
* @version $Revision: 257 $
* @since 0.9.92
*/
public class BugsLineMarkerProvider implements LineMarkerProvider, EventListener<BugReporterEvent>/*, DumbAware*/ {
private Map<PsiFile, List<ExtendedProblemDescriptor>> _problemCache;
private boolean _analysisRunning;
private boolean _isRegistered;
public BugsLineMarkerProvider() {
_analysisRunning = false;
_isRegistered = false;
}
@Nullable
public LineMarkerInfo<?> getLineMarkerInfo(final PsiElement psiElement) {
final FindBugsPlugin pluginComponent = IdeaUtilImpl.getPluginComponent(psiElement.getProject());
if (! pluginComponent.getPreferences().isAnnotationGutterIconEnabled()) {
return null;
}
if(!_isRegistered) {
EventManagerImpl.getInstance().addEventListener(new BugReporterEventFilter(psiElement.getProject().getName()), this);
_isRegistered = true;
}
if(_analysisRunning) {
return null;
}
final PsiFile psiFile = IdeaUtilImpl.getPsiFile(psiElement);
_problemCache = pluginComponent.getProblems();
if (_problemCache.containsKey(psiFile)) {
final List<ExtendedProblemDescriptor> matchingDescriptors = new ArrayList<ExtendedProblemDescriptor>();
final List<ExtendedProblemDescriptor> problemDescriptors = _problemCache.get(psiFile);
if (problemDescriptors == null) {
return null;
}
final Iterable<ExtendedProblemDescriptor> descriptors = new ArrayList<ExtendedProblemDescriptor>(problemDescriptors);
for (final ExtendedProblemDescriptor problemDescriptor : descriptors) {
final PsiElement problemPsiElement = problemDescriptor.getPsiElement();
if (psiElement.equals(problemPsiElement)) {
matchingDescriptors.add(problemDescriptor);
if(psiElement instanceof PsiAnonymousClass) {
//final Editor[] editors = com.intellij.openapi.editor.EditorFactory.getInstance().getEditors(IdeaUtilImpl.getDocument(psiFile.getProject(), problemDescriptor));
//editors[0].getMarkupModel().addRangeHighlighter()
}
}
}
if (!matchingDescriptors.isEmpty()) {
final GutterIconNavigationHandler<PsiElement> navHandler = new BugGutterIconNavigationHandler(psiElement, matchingDescriptors);
return new LineMarkerInfo<PsiElement>(psiElement, psiElement.getTextRange().getStartOffset(), GuiUtil.getTinyIcon(matchingDescriptors.get(0)), 4, new TooltipProvider(matchingDescriptors), navHandler, GutterIconRenderer.Alignment.LEFT);
}
}
return null;
}
public void collectSlowLineMarkers(final List<PsiElement> elements, final Collection<LineMarkerInfo> result) {
}
public void onEvent(@NotNull final BugReporterEvent event) {
switch (event.getOperation()) {
case ANALYSIS_STARTED:
_analysisRunning = true;
break;
case ANALYSIS_ABORTED:
case ANALYSIS_FINISHED:
_analysisRunning = false;
break;
case NEW_BUG_INSTANCE:
break;
default:
}
}
private static class BugGutterIconNavigationHandler implements GutterIconNavigationHandler<PsiElement> {
private final List<ExtendedProblemDescriptor> _descriptors;
private final PsiElement _psiElement;
private BugGutterIconNavigationHandler(final PsiElement psiElement, final List<ExtendedProblemDescriptor> descriptors) {
_descriptors = descriptors;
_psiElement = psiElement;
//buildPopupMenu();
}
@SuppressWarnings({"AnonymousInnerClass", "AnonymousInnerClassMayBeStatic"})
private JBPopup buildPopupMenu() {
final List<GroupBugIntentionListPopupStep> intentionGroups = new ArrayList<GroupBugIntentionListPopupStep>();
for (final ExtendedProblemDescriptor problemDescriptor : _descriptors) {
final List<SuppressReportBugIntentionAction> intentionActions = new ArrayList<SuppressReportBugIntentionAction>(_descriptors.size());
intentionActions.add(new SuppressReportBugIntentionAction(problemDescriptor));
intentionActions.add(new SuppressReportBugForClassIntentionAction(problemDescriptor));
intentionActions.add(new ClearBugIntentionAction(problemDescriptor));
intentionActions.add(new ClearAndSuppressBugIntentionAction(problemDescriptor));
final GroupBugIntentionListPopupStep intentionActionGroup = new GroupBugIntentionListPopupStep(_psiElement, intentionActions);
intentionGroups.add(intentionActionGroup);
}
final JBPopupFactory factory = JBPopupFactory.getInstance();
/*return factory.createListPopup(new BaseListPopupStep<SuppressIntentionAction>(FindBugsPluginConstants.PLUGIN_NAME, intentionActions) {
@Override
public PopupStep<?> onChosen(final SuppressIntentionAction selectedValue, final boolean finalChoice) {
final Project project = _psiElement.getProject();
final Editor editor = FileEditorManager.getInstance(project).getSelectedTextEditor();
ApplicationManager.getApplication().runWriteAction(new Runnable() {
public void run() {
selectedValue.invoke(project, editor, _psiElement);
}
});
return super.onChosen(selectedValue, finalChoice);
}
});*/
return factory.createListPopup(new RootGroupBugIntentionListPopupStep(intentionGroups));
}
public void navigate(final MouseEvent e, final PsiElement psiElement) {
// todo: goto tree node - fb result panel view
buildPopupMenu().show(new RelativePoint(e));
}
}
private static class TooltipProvider implements Function<PsiElement, String> {
private final List<ExtendedProblemDescriptor> _problemDescriptors;
@SuppressWarnings("HardcodedLineSeparator")
private static final Pattern PATTERN = Pattern.compile("\n");
private TooltipProvider(final List<ExtendedProblemDescriptor> problemDescriptors) {
_problemDescriptors = problemDescriptors;
}
public String fun(final PsiElement psiElement) {
return getTooltipText(_problemDescriptors);
}
@SuppressWarnings({"HardcodedFileSeparator"})
private static String getTooltipText(final List<ExtendedProblemDescriptor> problemDescriptors) {
final StringBuilder buffer = new StringBuilder();
buffer.append("<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\">");
buffer.append("<HTML><HEAD><TITLE>");
final int problemDescriptorsSize = problemDescriptors.size();
for (int i = 0;i < problemDescriptorsSize; i++) {
final ExtendedProblemDescriptor problemDescriptor = problemDescriptors.get(i);
buffer.append("");
buffer.append("</TITLE></HEAD><BODY><H3>");
buffer.append(BugInstanceUtil.getBugPatternShortDescription(problemDescriptor.getBugInstance()));
buffer.append("</H3>");
buffer.append(PATTERN.matcher(BugInstanceUtil.getDetailText(problemDescriptor.getBugInstance())).replaceAll(""));
if (i < problemDescriptors.size() - 1) {
buffer.append("<HR>");
}
}
buffer.append("</BODY></HTML>");
return buffer.toString();
}
@Override
public String toString() {
return "TooltipProvider" + "{_problemDescriptor=" + _problemDescriptors + '}';
}
}
}