/*
* Copyright 2000-2017 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.intellij.profile.codeInspection.ui.filter;
import com.intellij.codeHighlighting.HighlightDisplayLevel;
import com.intellij.codeInsight.daemon.impl.SeverityRegistrar;
import com.intellij.codeInspection.ex.InspectionProfileImpl;
import com.intellij.codeInspection.ex.ScopeToolState;
import com.intellij.icons.AllIcons;
import com.intellij.lang.Language;
import com.intellij.lang.MetaLanguage;
import com.intellij.lang.annotation.HighlightSeverity;
import com.intellij.openapi.actionSystem.*;
import com.intellij.openapi.actionSystem.ex.CheckboxAction;
import com.intellij.openapi.application.ApplicationInfo;
import com.intellij.openapi.application.ApplicationNamesInfo;
import com.intellij.openapi.project.DumbAware;
import com.intellij.openapi.project.DumbAwareAction;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.profile.codeInspection.ui.LevelChooserAction;
import com.intellij.profile.codeInspection.ui.SingleInspectionProfilePanel;
import com.intellij.ui.FilterComponent;
import com.intellij.util.SmartList;
import gnu.trove.THashSet;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Set;
/**
* @author Dmitry Batkovich
*/
public class InspectionFilterAction extends DefaultActionGroup implements Toggleable, DumbAware {
private final static int MIN_LANGUAGE_COUNT_TO_WRAP = 11;
private final SeverityRegistrar mySeverityRegistrar;
private final InspectionsFilter myInspectionsFilter;
@NotNull private final FilterComponent myFilterComponent;
public InspectionFilterAction(@NotNull InspectionProfileImpl profile,
@NotNull InspectionsFilter inspectionsFilter,
@NotNull Project project,
@NotNull FilterComponent filterComponent) {
super("Filter Inspections", true);
myInspectionsFilter = inspectionsFilter;
myFilterComponent = filterComponent;
mySeverityRegistrar = profile.getProfileManager().getOwnSeverityRegistrar();
getTemplatePresentation().setIcon(AllIcons.General.Filter);
tune(profile, project);
}
@Override
public void update(AnActionEvent e) {
super.update(e);
e.getPresentation().putClientProperty(Toggleable.SELECTED_PROPERTY, !myInspectionsFilter.isEmptyFilter());
}
private void tune(InspectionProfileImpl profile, Project project) {
addAction(new ResetFilterAction());
addSeparator();
if (ApplicationNamesInfo.getInstance().getProductName().contains("IDEA")) {
// minor IDEs don't have "New in XXX" in inspection descriptions
addAction(new ShowNewInspectionsAction());
}
addSeparator();
addAction(new ShowEnabledOrDisabledInspectionsAction(true));
addAction(new ShowEnabledOrDisabledInspectionsAction(false));
addAction(new ShowOnlyModifiedInspectionsAction());
addSeparator();
for (final HighlightSeverity severity : LevelChooserAction.getSeverities(mySeverityRegistrar)) {
add(new ShowWithSpecifiedSeverityInspectionsAction(severity));
}
addSeparator();
final Set<String> languageIds = new THashSet<>();
for (ScopeToolState state : profile.getDefaultStates(project)) {
languageIds.add(state.getTool().getLanguage());
}
final List<Language> languages = new SmartList<>();
for (String id : languageIds) {
if (id != null) {
final Language language = Language.findLanguageByID(id);
if (language != null && !(language instanceof MetaLanguage)) {
languages.add(language);
}
}
}
if (!languages.isEmpty()) {
final DefaultActionGroup languageActionGroupParent =
new DefaultActionGroup("Filter by Language", languages.size() >= MIN_LANGUAGE_COUNT_TO_WRAP);
add(languageActionGroupParent);
Collections.sort(languages, Comparator.comparing(Language::getDisplayName));
for (Language language : languages) {
languageActionGroupParent.add(new LanguageFilterAction(language));
}
languageActionGroupParent.add(new LanguageFilterAction(null));
addSeparator();
}
add(new ShowAvailableOnlyOnAnalyzeInspectionsAction());
add(new ShowOnlyCleanupInspectionsAction());
}
private class ResetFilterAction extends DumbAwareAction {
public ResetFilterAction() {
super("Reset Filter");
}
@Override
public void actionPerformed(@NotNull AnActionEvent e) {
myInspectionsFilter.reset();
}
@Override
public void update(@NotNull AnActionEvent e) {
final Presentation presentation = e.getPresentation();
presentation.setEnabled(!myInspectionsFilter.isEmptyFilter());
}
}
private class ShowOnlyCleanupInspectionsAction extends CheckboxAction implements DumbAware{
public ShowOnlyCleanupInspectionsAction() {
super("Show Only Cleanup Inspections");
}
@Override
public boolean isSelected(final AnActionEvent e) {
return myInspectionsFilter.isShowOnlyCleanupInspections();
}
@Override
public void setSelected(final AnActionEvent e, final boolean state) {
myInspectionsFilter.setShowOnlyCleanupInspections(state);
}
}
private class ShowAvailableOnlyOnAnalyzeInspectionsAction extends CheckboxAction implements DumbAware {
public ShowAvailableOnlyOnAnalyzeInspectionsAction() {
super("Show Only \"Available only for Analyze | Inspect Code\"");
}
@Override
public boolean isSelected(final AnActionEvent e) {
return myInspectionsFilter.isAvailableOnlyForAnalyze();
}
@Override
public void setSelected(final AnActionEvent e, final boolean state) {
myInspectionsFilter.setAvailableOnlyForAnalyze(state);
}
}
private class ShowWithSpecifiedSeverityInspectionsAction extends CheckboxAction implements DumbAware {
private final HighlightSeverity mySeverity;
private ShowWithSpecifiedSeverityInspectionsAction(final HighlightSeverity severity) {
super(SingleInspectionProfilePanel.renderSeverity(severity),
null,
HighlightDisplayLevel.find(severity).getIcon());
mySeverity = severity;
}
@Override
public boolean isSelected(final AnActionEvent e) {
return myInspectionsFilter.containsSeverity(mySeverity);
}
@Override
public void setSelected(final AnActionEvent e, final boolean state) {
if (state) {
myInspectionsFilter.addSeverity(mySeverity);
} else {
myInspectionsFilter.removeSeverity(mySeverity);
}
}
}
private class ShowEnabledOrDisabledInspectionsAction extends CheckboxAction implements DumbAware{
private final Boolean myShowEnabledActions;
public ShowEnabledOrDisabledInspectionsAction(final boolean showEnabledActions) {
super("Show Only " + (showEnabledActions ? "Enabled" : "Disabled"));
myShowEnabledActions = showEnabledActions;
}
@Override
public boolean isSelected(final AnActionEvent e) {
return myInspectionsFilter.getSuitableInspectionsStates() == myShowEnabledActions;
}
@Override
public void setSelected(final AnActionEvent e, final boolean state) {
final boolean previousState = isSelected(e);
myInspectionsFilter.setSuitableInspectionsStates(previousState ? null : myShowEnabledActions);
}
}
private class LanguageFilterAction extends CheckboxAction implements DumbAware {
private final Language myLanguage;
public LanguageFilterAction(final @Nullable Language language) {
super(language == null ? "Language is not specified" : language.getDisplayName());
myLanguage = language;
}
@Override
public boolean isSelected(AnActionEvent e) {
return myInspectionsFilter.containsLanguage(myLanguage);
}
@Override
public void setSelected(AnActionEvent e, boolean state) {
if (state) {
myInspectionsFilter.addLanguage(myLanguage);
} else {
myInspectionsFilter.removeLanguage(myLanguage);
}
}
}
private final String version = ApplicationInfo.getInstance().getMajorVersion() +
(StringUtil.isEmptyOrSpaces(StringUtil.trimStart(ApplicationInfo.getInstance().getMinorVersion(),"0")) ?
"" : "."+ApplicationInfo.getInstance().getMinorVersion());
private final String presentableVersion = ApplicationNamesInfo.getInstance().getProductName() + " " + version;
private class ShowNewInspectionsAction extends AnAction implements DumbAware {
private ShowNewInspectionsAction() {
super("Show New Inspections in " + presentableVersion,
"Shows new inspections which are available since " + presentableVersion,
AllIcons.Actions.Lightning);
}
@Override
public void actionPerformed(AnActionEvent e) {
myFilterComponent.setFilter("\"New in " + version + "\"");
}
}
private class ShowOnlyModifiedInspectionsAction extends CheckboxAction implements DumbAware {
public ShowOnlyModifiedInspectionsAction() {
super("Show Only Modified Inspections");
}
@Override
public boolean isSelected(AnActionEvent e) {
return myInspectionsFilter.isShowOnlyModifiedInspections();
}
@Override
public void setSelected(AnActionEvent e, boolean state) {
myInspectionsFilter.setShowOnlyModifiedInspections(state);
}
}
}