Select in project view: when calculating element to select, filter tree structure...
[idea/community.git] / platform / lang-impl / src / com / intellij / ide / impl / ProjectViewSelectInTarget.java
1 /*
2  * Copyright 2000-2009 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package com.intellij.ide.impl;
18
19 import com.intellij.ide.CompositeSelectInTarget;
20 import com.intellij.ide.SelectInContext;
21 import com.intellij.ide.SelectInTarget;
22 import com.intellij.ide.projectView.ProjectView;
23 import com.intellij.ide.projectView.SelectableTreeStructureProvider;
24 import com.intellij.ide.projectView.TreeStructureProvider;
25 import com.intellij.ide.projectView.impl.AbstractProjectViewPane;
26 import com.intellij.openapi.extensions.Extensions;
27 import com.intellij.openapi.project.DumbService;
28 import com.intellij.openapi.project.Project;
29 import com.intellij.openapi.util.ActionCallback;
30 import com.intellij.openapi.vfs.VirtualFile;
31 import com.intellij.openapi.wm.ToolWindow;
32 import com.intellij.openapi.wm.ToolWindowId;
33 import com.intellij.openapi.wm.ToolWindowManager;
34 import com.intellij.psi.*;
35 import com.intellij.psi.util.PsiUtilBase;
36 import org.jetbrains.annotations.NotNull;
37 import org.jetbrains.annotations.Nullable;
38
39 import java.util.ArrayList;
40 import java.util.Arrays;
41 import java.util.Collection;
42 import java.util.List;
43
44 public abstract class ProjectViewSelectInTarget extends SelectInTargetPsiWrapper implements CompositeSelectInTarget {
45   private String mySubId;
46
47   protected ProjectViewSelectInTarget(Project project) {
48     super(project);
49   }
50
51   protected final void select(final Object selector, final VirtualFile virtualFile, final boolean requestFocus) {
52     select(myProject, selector, getMinorViewId(), mySubId, virtualFile, requestFocus);
53   }
54
55   public static ActionCallback select(@NotNull Project project,
56                             final Object toSelect,
57                             @Nullable final String viewId,
58                             @Nullable final String subviewId,
59                             final VirtualFile virtualFile,
60                             final boolean requestFocus) {
61     final ActionCallback result = new ActionCallback();
62
63
64     final ProjectView projectView = ProjectView.getInstance(project);
65     ToolWindowManager windowManager=ToolWindowManager.getInstance(project);
66     final ToolWindow projectViewToolWindow = windowManager.getToolWindow(ToolWindowId.PROJECT_VIEW);
67     final Runnable runnable = new Runnable() {
68       public void run() {
69         if (requestFocus) {
70           projectView.changeView(viewId, subviewId);
71         }
72
73         projectView.selectCB(toSelect, virtualFile, requestFocus).notify(result);
74       }
75     };
76
77     if (requestFocus) {
78       projectViewToolWindow.activate(runnable, false);
79     } else {
80       projectViewToolWindow.show(runnable);
81     }
82
83     return result;
84   }
85
86
87   @NotNull
88   public Collection<SelectInTarget> getSubTargets(SelectInContext context) {
89     List<SelectInTarget> result = new ArrayList<SelectInTarget>();
90     AbstractProjectViewPane pane = ProjectView.getInstance(myProject).getProjectViewPaneById(getMinorViewId());
91     int index = 0;
92     for (String subId : pane.getSubIds()) {
93       result.add(new ProjectSubViewSelectInTarget(this, subId, index++));
94     }
95     return result;
96   }
97
98   public boolean isSubIdSelectable(String subId, SelectInContext context) {
99     return false;
100   }
101
102   @Override
103   protected boolean canSelect(PsiFileSystemItem file) {
104     return true;
105   }
106
107   public String getSubIdPresentableName(String subId) {
108     AbstractProjectViewPane pane = ProjectView.getInstance(myProject).getProjectViewPaneById(getMinorViewId());
109     return pane.getPresentableSubIdName(subId);
110   }
111
112   public void select(PsiElement element, final boolean requestFocus) {
113     PsiElement toSelect = null;
114     for (TreeStructureProvider provider : getProvidersDumbAware()) {
115       if (provider instanceof SelectableTreeStructureProvider) {
116         toSelect = ((SelectableTreeStructureProvider) provider).getTopLevelElement(element);
117       }
118       if (toSelect != null) break;
119     }
120     if (toSelect == null) {
121       if (element instanceof PsiFile || element instanceof PsiDirectory) {
122         toSelect = element;
123       }
124       else {
125         final PsiFile containingFile = element.getContainingFile();
126         if (containingFile == null) return;
127         final FileViewProvider viewProvider = containingFile.getViewProvider();
128         toSelect = viewProvider.getPsi(viewProvider.getBaseLanguage());
129       }
130     }
131     if (toSelect == null) return;
132     PsiElement originalElement = toSelect.getOriginalElement();
133     final VirtualFile virtualFile = PsiUtilBase.getVirtualFile(originalElement);
134     select(originalElement, virtualFile, requestFocus);
135   }
136
137   private TreeStructureProvider[] getProvidersDumbAware() {
138     List<TreeStructureProvider> allProviders = Arrays.asList(Extensions.getExtensions(TreeStructureProvider.EP_NAME, myProject));
139     List<TreeStructureProvider> dumbAware = DumbService.getInstance(myProject).filterByDumbAwareness(allProviders);
140     return dumbAware.toArray(new TreeStructureProvider[dumbAware.size()]);
141   }
142
143   public final String getToolWindowId() {
144     return ToolWindowId.PROJECT_VIEW;
145   }
146
147   protected boolean canWorkWithCustomObjects() {
148     return true;
149   }
150
151   public final void setSubId(String subId) {
152     mySubId = subId;
153   }
154 }