[ES] suppress invalid notification group for notifications created only to call Notif...
[idea/community.git] / java / java-impl / src / com / intellij / cyclicDependencies / CyclicDependenciesBuilder.java
1 /*
2  * Copyright 2000-2016 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 package com.intellij.cyclicDependencies;
17
18 import com.intellij.analysis.AnalysisScope;
19 import com.intellij.java.JavaBundle;
20 import com.intellij.openapi.progress.ProgressIndicator;
21 import com.intellij.openapi.progress.ProgressManager;
22 import com.intellij.openapi.progress.util.ProgressIndicatorUtils;
23 import com.intellij.openapi.project.Project;
24 import com.intellij.openapi.roots.ProjectFileIndex;
25 import com.intellij.openapi.roots.ProjectRootManager;
26 import com.intellij.packageDependencies.DependenciesBuilder;
27 import com.intellij.packageDependencies.ForwardDependenciesBuilder;
28 import com.intellij.psi.*;
29 import com.intellij.util.graph.*;
30 import org.jetbrains.annotations.Nls;
31 import org.jetbrains.annotations.NotNull;
32
33 import java.util.*;
34
35 public class CyclicDependenciesBuilder{
36   @NotNull
37   private final Project myProject;
38   private final AnalysisScope myScope;
39   private final Map<String, PsiPackage> myPackages = new HashMap<>();
40   private Graph<PsiPackage> myGraph;
41   private final Map<PsiPackage, Map<PsiPackage, Set<PsiFile>>> myFilesInDependentPackages = new HashMap<>();
42   private final Map<PsiPackage, Map<PsiPackage, Set<PsiFile>>> myBackwardFilesInDependentPackages = new HashMap<>();
43   private final Map<PsiPackage, Set<PsiPackage>> myPackageDependencies = new HashMap<>();
44   private HashMap<PsiPackage, Set<List<PsiPackage>>> myCyclicDependencies = new HashMap<>();
45   private int myFileCount;
46   private final ForwardDependenciesBuilder myForwardBuilder;
47
48   private @Nls String myRootNodeNameInUsageView;
49
50   public CyclicDependenciesBuilder(@NotNull Project project, @NotNull AnalysisScope scope) {
51     myProject = project;
52     myScope = scope;
53     myForwardBuilder = new ForwardDependenciesBuilder(myProject, myScope){
54       @Override
55       public String getRootNodeNameInUsageView() {
56         return CyclicDependenciesBuilder.this.getRootNodeNameInUsageView();
57       }
58
59       @Override
60       public String getInitialUsagesPosition() {
61         return JavaBundle.message("cyclic.dependencies.usage.view.initial.text");
62       }
63     };
64   }
65
66   @NotNull
67   private @Nls String getRootNodeNameInUsageView() {
68     return myRootNodeNameInUsageView;
69   }
70
71   public void setRootNodeNameInUsageView(@NotNull @Nls String rootNodeNameInUsageView) {
72     myRootNodeNameInUsageView = rootNodeNameInUsageView;
73   }
74
75   @NotNull
76   public Project getProject() {
77     return myProject;
78   }
79
80   @NotNull
81   public AnalysisScope getScope() {
82     return myScope;
83   }
84
85   @NotNull
86   public DependenciesBuilder getForwardBuilder() {
87     return myForwardBuilder;
88   }
89
90   public void analyze() {
91     final ProjectFileIndex projectFileIndex = ProjectRootManager.getInstance(getProject()).getFileIndex();
92     getScope().accept(new PsiRecursiveElementVisitor() {
93       @Override public void visitFile(@NotNull PsiFile file) {
94         if (file instanceof PsiJavaFile) {
95           PsiJavaFile psiJavaFile = (PsiJavaFile)file;
96           if (getScope().contains(psiJavaFile)) {
97             final PsiPackage aPackage = findPackage(psiJavaFile.getPackageName());
98             if (aPackage != null) {
99               myPackages.put(psiJavaFile.getPackageName(), aPackage);
100             }
101           }
102           final Set<PsiPackage> packs = getPackageHierarchy(psiJavaFile.getPackageName());
103           final ForwardDependenciesBuilder builder = new ForwardDependenciesBuilder(getProject(), new AnalysisScope(psiJavaFile));
104           builder.setTotalFileCount(getScope().getFileCount());
105           builder.setInitialFileCount(++myFileCount);
106           builder.analyze();
107           final Set<PsiFile> psiFiles = builder.getDependencies().get(psiJavaFile);
108           if (psiFiles == null) return;
109           for (PsiPackage pack : packs) {
110             Set<PsiPackage> pack2Packages = myPackageDependencies.computeIfAbsent(pack, __ -> new HashSet<>());
111             for (PsiFile psiFile : psiFiles) {
112               if (!(psiFile instanceof PsiJavaFile) ||
113                   !projectFileIndex.isInSourceContent(psiFile.getVirtualFile()) ||
114                   !getScope().contains(psiFile)) {
115                 continue;
116               }
117
118               // construct dependent packages
119               final String packageName = ((PsiJavaFile)psiFile).getPackageName();
120               //do not depend on parent packages
121               if (packageName.startsWith(pack.getQualifiedName())) {
122                 continue;
123               }
124               final PsiPackage depPackage = findPackage(packageName);
125               if (depPackage == null) { //not from analyze scope
126                 continue;
127               }
128               pack2Packages.add(depPackage);
129
130               constractFilesInDependenciesPackagesMap(pack, depPackage, psiFile, myFilesInDependentPackages);
131               constractFilesInDependenciesPackagesMap(depPackage, pack, psiJavaFile, myBackwardFilesInDependentPackages);
132               constractWholeDependenciesMap(psiJavaFile, psiFile);
133             }
134           }
135         }
136       }
137     });
138     ProgressIndicator indicator = ProgressManager.getInstance().getProgressIndicator();
139     if (indicator != null) {
140       ProgressIndicatorUtils.checkCancelledEvenWithPCEDisabled(indicator);
141       indicator.setText(JavaBundle.message("cyclic.dependencies.progress.text"));
142       indicator.setText2("");
143       indicator.setIndeterminate(true);
144     }
145     myCyclicDependencies = getCycles(myPackages.values());
146   }
147
148   private void constractFilesInDependenciesPackagesMap(final PsiPackage pack,
149                                                        final PsiPackage depPackage,
150                                                        final PsiFile file,
151                                                        final Map<PsiPackage, Map<PsiPackage, Set<PsiFile>>> filesInDependentPackages) {
152     Map<PsiPackage, Set<PsiFile>> dependentPackages2Files = filesInDependentPackages.get(pack);
153     if (dependentPackages2Files == null) {
154       dependentPackages2Files = new HashMap<>();
155       filesInDependentPackages.put(pack, dependentPackages2Files);
156     }
157     Set<PsiFile> depFiles = dependentPackages2Files.get(depPackage);
158     if (depFiles == null) {
159       depFiles = new HashSet<>();
160       dependentPackages2Files.put(depPackage, depFiles);
161     }
162     depFiles.add(file);
163   }
164
165 //construct all dependencies for usage view
166   private void constractWholeDependenciesMap(final PsiJavaFile psiJavaFile, final PsiFile psiFile) {
167     Set<PsiFile> wholeDependencies = myForwardBuilder.getDependencies().get(psiJavaFile);
168     if (wholeDependencies == null) {
169       wholeDependencies = new HashSet<>();
170       myForwardBuilder.getDependencies().put(psiJavaFile, wholeDependencies);
171     }
172     wholeDependencies.add(psiFile);
173   }
174
175   public Set<PsiFile> getDependentFilesInPackage(PsiPackage pack, PsiPackage depPack) {
176     Set<PsiFile> psiFiles = new HashSet<>();
177     final Map<PsiPackage, Set<PsiFile>> map = myFilesInDependentPackages.get(pack);
178     if (map != null){
179       psiFiles = map.get(depPack);
180     }
181     if (psiFiles == null) {
182       psiFiles = new HashSet<>();
183     }
184     return psiFiles;
185   }
186
187   public Set<PsiFile> getDependentFilesInPackage(PsiPackage firstPack, PsiPackage middlePack, PsiPackage lastPack) {
188     Set<PsiFile> result = new HashSet<>();
189     final Map<PsiPackage, Set<PsiFile>> forwardMap = myFilesInDependentPackages.get(firstPack);
190     if (forwardMap != null && forwardMap.get(middlePack) != null){
191       result.addAll(forwardMap.get(middlePack));
192     }
193     final Map<PsiPackage, Set<PsiFile>> backwardMap = myBackwardFilesInDependentPackages.get(lastPack);
194     if (backwardMap != null && backwardMap.get(middlePack) != null){
195       result.addAll(backwardMap.get(middlePack));
196     }
197     return result;
198   }
199
200
201   public HashMap<PsiPackage, Set<List<PsiPackage>>> getCyclicDependencies() {
202     return myCyclicDependencies;
203   }
204
205   public HashMap<PsiPackage, Set<List<PsiPackage>>> getCycles(Collection<? extends PsiPackage> packages) {
206     if (myGraph == null){
207       myGraph = buildGraph();
208     }
209     final HashMap<PsiPackage, Set<List<PsiPackage>>> result = new HashMap<>();
210     for (PsiPackage psiPackage : packages) {
211       Set<List<PsiPackage>> paths2Pack = result.computeIfAbsent(psiPackage, __ -> new HashSet<>());
212       paths2Pack.addAll(GraphAlgorithms.getInstance().findCycles(myGraph, psiPackage));
213     }
214     return result;
215   }
216
217   public Map<String, PsiPackage> getAllScopePackages() {
218     if (myPackages.isEmpty()) {
219       final PsiManager psiManager = PsiManager.getInstance(getProject());
220       getScope().accept(new PsiRecursiveElementVisitor() {
221         @Override public void visitFile(@NotNull PsiFile file) {
222           if (file instanceof PsiJavaFile) {
223             PsiJavaFile psiJavaFile = (PsiJavaFile)file;
224             final PsiPackage aPackage = JavaPsiFacade.getInstance(psiManager.getProject()).findPackage(psiJavaFile.getPackageName());
225             if (aPackage != null) {
226               myPackages.put(aPackage.getQualifiedName(), aPackage);
227             }
228           }
229         }
230       });
231     }
232     return myPackages;
233   }
234
235   private Graph<PsiPackage> buildGraph() {
236     return GraphGenerator.generate(CachingSemiGraph.cache(new InboundSemiGraph<>() {
237       @Override
238       @NotNull
239       public Collection<PsiPackage> getNodes() {
240         return getAllScopePackages().values();
241       }
242
243       @NotNull
244       @Override
245       public Iterator<PsiPackage> getIn(PsiPackage psiPack) {
246         final Set<PsiPackage> psiPackages = myPackageDependencies.get(psiPack);
247         if (psiPackages == null) {     //for packs without java classes
248           return Collections.emptyIterator();
249         }
250         return psiPackages.iterator();
251       }
252     }));
253   }
254
255   @NotNull
256   private Set<PsiPackage> getPackageHierarchy(@NotNull String packageName) {
257     final Set<PsiPackage> result = new HashSet<>();
258     PsiPackage psiPackage = findPackage(packageName);
259     if (psiPackage != null) {
260       result.add(psiPackage);
261     }
262     else {
263       return result;
264     }
265     while (psiPackage.getParentPackage() != null && !psiPackage.getParentPackage().getQualifiedName().isEmpty()) {
266       final PsiPackage aPackage = findPackage(psiPackage.getParentPackage().getQualifiedName());
267       if (aPackage == null) {
268         break;
269       }
270       result.add(aPackage);
271       psiPackage = psiPackage.getParentPackage();
272     }
273     return result;
274   }
275
276   private PsiPackage findPackage(@NotNull String packName) {
277     return getAllScopePackages().get(packName);
278   }
279 }