/*
* Copyright 2000-2009 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.usages.impl;
import com.intellij.icons.AllIcons;
import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.actionSystem.CustomShortcutSet;
import com.intellij.openapi.extensions.Extensions;
import com.intellij.openapi.project.Project;
import com.intellij.usageView.UsageViewBundle;
import com.intellij.usages.UsageView;
import com.intellij.usages.UsageViewSettings;
import com.intellij.usages.impl.rules.*;
import com.intellij.usages.rules.UsageGroupingRule;
import com.intellij.usages.rules.UsageGroupingRuleProvider;
import com.intellij.util.containers.ContainerUtil;
import org.jetbrains.annotations.NotNull;
import javax.swing.*;
import java.awt.event.InputEvent;
import java.awt.event.KeyEvent;
import java.util.ArrayList;
import java.util.List;
/**
* @author max
*/
public class UsageGroupingRuleProviderImpl implements UsageGroupingRuleProvider {
protected boolean supportsNonCodeRule() {
return true;
}
protected boolean supportsModuleRule() {
return true;
}
protected boolean supportsScopesRule() {
return true;
}
@Override
@NotNull
public UsageGroupingRule[] getActiveRules(Project project) {
List<UsageGroupingRule> rules = new ArrayList<>();
if (supportsNonCodeRule()) {
rules.add(new NonCodeUsageGroupingRule(project));
}
if (supportsScopesRule() && UsageViewSettings.getInstance().GROUP_BY_SCOPE) {
rules.add(new UsageScopeGroupingRule());
}
if (UsageViewSettings.getInstance().GROUP_BY_USAGE_TYPE) {
rules.add(new UsageTypeGroupingRule());
}
if (supportsModuleRule() && UsageViewSettings.getInstance().GROUP_BY_MODULE) {
rules.add(new ModuleGroupingRule(project, UsageViewSettings.getInstance().FLATTEN_MODULES));
}
if (UsageViewSettings.getInstance().GROUP_BY_PACKAGE) {
rules.add(DirectoryGroupingRule.getInstance(project));
}
if (UsageViewSettings.getInstance().GROUP_BY_FILE_STRUCTURE) {
FileStructureGroupRuleProvider[] providers = Extensions.getExtensions(FileStructureGroupRuleProvider.EP_NAME);
for (FileStructureGroupRuleProvider ruleProvider : providers) {
ContainerUtil.addIfNotNull(rules, ruleProvider.getUsageGroupingRule(project));
}
}
else {
rules.add(new FileGroupingRule(project));
}
return rules.toArray(new UsageGroupingRule[rules.size()]);
}
@Override
@NotNull
public AnAction[] createGroupingActions(UsageView view) {
UsageViewImpl impl = (UsageViewImpl)view;
JComponent component = impl.getComponent();
GroupByModuleTypeAction groupByModuleTypeAction = supportsModuleRule() ? new GroupByModuleTypeAction(impl) : null;
if (groupByModuleTypeAction != null) {
groupByModuleTypeAction.registerCustomShortcutSet(new CustomShortcutSet(KeyStroke.getKeyStroke(KeyEvent.VK_D, InputEvent.CTRL_DOWN_MASK)), component, impl);
}
GroupByFileStructureAction groupByFileStructureAction = createGroupByFileStructureAction(impl);
GroupByScopeAction groupByScopeAction = supportsScopesRule() ? new GroupByScopeAction(impl) : null;
GroupByPackageAction groupByPackageAction = new GroupByPackageAction(impl);
groupByPackageAction.registerCustomShortcutSet(new CustomShortcutSet(KeyStroke.getKeyStroke(KeyEvent.VK_P, InputEvent.CTRL_DOWN_MASK)), component, impl);
ArrayList<AnAction> result = ContainerUtil.newArrayList();
if (view.getPresentation().isUsageTypeFilteringAvailable()) {
GroupByUsageTypeAction groupByUsageTypeAction = new GroupByUsageTypeAction(impl);
groupByUsageTypeAction.registerCustomShortcutSet(new CustomShortcutSet(KeyStroke.getKeyStroke(KeyEvent.VK_T, InputEvent.CTRL_DOWN_MASK)), component, impl);
ContainerUtil.addIfNotNull(result, groupByUsageTypeAction);
ContainerUtil.addIfNotNull(result, groupByScopeAction);
ContainerUtil.addIfNotNull(result, groupByModuleTypeAction);
if (supportsModuleRule()) {
result.add(new FlattenModulesAction(impl));
}
ContainerUtil.addIfNotNull(result, groupByPackageAction);
ContainerUtil.addIfNotNull(result, groupByFileStructureAction);
}
else {
ContainerUtil.addIfNotNull(result, groupByScopeAction);
ContainerUtil.addIfNotNull(result, groupByModuleTypeAction);
ContainerUtil.addIfNotNull(result, groupByPackageAction);
ContainerUtil.addIfNotNull(result, groupByFileStructureAction);
}
return result.toArray(new AnAction[result.size()]);
}
public static GroupByFileStructureAction createGroupByFileStructureAction(UsageViewImpl impl) {
final JComponent component = impl.getComponent();
final GroupByFileStructureAction groupByFileStructureAction = new GroupByFileStructureAction(impl);
groupByFileStructureAction.registerCustomShortcutSet(new CustomShortcutSet(KeyStroke.getKeyStroke(KeyEvent.VK_M,
InputEvent.CTRL_DOWN_MASK)), component,
impl);
return groupByFileStructureAction;
}
private static class GroupByUsageTypeAction extends RuleAction {
private GroupByUsageTypeAction(UsageViewImpl view) {
super(view, UsageViewBundle.message("action.group.by.usage.type"), AllIcons.General.Filter); //TODO: special icon
}
@Override
protected boolean getOptionValue() {
return UsageViewSettings.getInstance().GROUP_BY_USAGE_TYPE;
}
@Override
protected void setOptionValue(boolean value) {
UsageViewSettings.getInstance().GROUP_BY_USAGE_TYPE = value;
}
}
private static class GroupByScopeAction extends RuleAction {
private GroupByScopeAction(UsageViewImpl view) {
super(view, "Group by test/production", AllIcons.Actions.GroupByTestProduction);
}
@Override
protected boolean getOptionValue() {
return UsageViewSettings.getInstance().GROUP_BY_SCOPE;
}
@Override
protected void setOptionValue(boolean value) {
UsageViewSettings.getInstance().GROUP_BY_SCOPE = value;
}
}
private static class GroupByModuleTypeAction extends RuleAction {
private GroupByModuleTypeAction(UsageViewImpl view) {
super(view, UsageViewBundle.message("action.group.by.module"), AllIcons.Actions.GroupByModule);
}
@Override
protected boolean getOptionValue() {
return UsageViewSettings.getInstance().GROUP_BY_MODULE;
}
@Override
protected void setOptionValue(boolean value) {
UsageViewSettings.getInstance().GROUP_BY_MODULE = value;
}
}
private static class FlattenModulesAction extends RuleAction {
private FlattenModulesAction(UsageViewImpl view) {
super(view, UsageViewBundle.message("action.flatten.modules"), AllIcons.ObjectBrowser.FlattenModules);
}
@Override
protected boolean getOptionValue() {
return UsageViewSettings.getInstance().FLATTEN_MODULES;
}
@Override
protected void setOptionValue(boolean value) {
UsageViewSettings.getInstance().FLATTEN_MODULES = value;
}
@Override
public void update(@NotNull AnActionEvent e) {
super.update(e);
e.getPresentation().setEnabled(UsageViewSettings.getInstance().GROUP_BY_MODULE);
}
}
private static class GroupByPackageAction extends RuleAction {
private GroupByPackageAction(UsageViewImpl view) {
super(view, DirectoryGroupingRule.getInstance(view.getProject()).getActionTitle(), AllIcons.Actions.GroupByPackage);
}
@Override
protected boolean getOptionValue() {
return UsageViewSettings.getInstance().GROUP_BY_PACKAGE;
}
@Override
protected void setOptionValue(boolean value) {
UsageViewSettings.getInstance().GROUP_BY_PACKAGE = value;
}
}
private static class GroupByFileStructureAction extends RuleAction {
private GroupByFileStructureAction(UsageViewImpl view) {
super(view, UsageViewBundle.message("action.group.by.file.structure"), AllIcons.Actions.GroupByMethod);
}
@Override
protected boolean getOptionValue() {
return UsageViewSettings.getInstance().GROUP_BY_FILE_STRUCTURE;
}
@Override
protected void setOptionValue(boolean value) {
UsageViewSettings.getInstance().GROUP_BY_FILE_STRUCTURE = value;
}
}
}