69994d478e39e49b5466b07301254a082b3e4b8f
[idea/community.git] / platform / core-api / src / com / intellij / openapi / roots / FileIndexFacade.java
1 /*
2  * Copyright 2000-2011 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.openapi.roots;
17
18 import com.intellij.injected.editor.VirtualFileWindow;
19 import com.intellij.openapi.components.ServiceManager;
20 import com.intellij.openapi.module.Module;
21 import com.intellij.openapi.module.UnloadedModuleDescription;
22 import com.intellij.openapi.project.Project;
23 import com.intellij.openapi.util.ModificationTracker;
24 import com.intellij.openapi.vfs.VirtualFile;
25 import com.intellij.psi.search.GlobalSearchScope;
26 import org.jetbrains.annotations.NotNull;
27 import org.jetbrains.annotations.Nullable;
28
29 import java.util.Collection;
30
31 /**
32  * @author yole
33  */
34 public abstract class FileIndexFacade {
35   protected final Project myProject;
36
37   protected FileIndexFacade(final Project project) {
38     myProject = project;
39   }
40
41   public static FileIndexFacade getInstance(Project project) {
42     return ServiceManager.getService(project, FileIndexFacade.class);
43   }
44
45   public abstract boolean isInContent(@NotNull VirtualFile file);
46   public abstract boolean isInSource(@NotNull VirtualFile file);
47   public abstract boolean isInSourceContent(@NotNull VirtualFile file);
48   public abstract boolean isInLibraryClasses(@NotNull VirtualFile file);
49
50   public abstract boolean isInLibrarySource(@NotNull VirtualFile file);
51   public abstract boolean isExcludedFile(@NotNull VirtualFile file);
52   public abstract boolean isUnderIgnored(@NotNull VirtualFile file);
53
54   @Nullable
55   public abstract Module getModuleForFile(@NotNull VirtualFile file);
56
57   /**
58    * Checks if {@code file} is an ancestor of {@code baseDir} and none of the files
59    * between them are excluded from the project.
60    *
61    * @param baseDir the parent directory to check for ancestry.
62    * @param child the child directory or file to check for ancestry.
63    * @return true if it's a valid ancestor, false otherwise.
64    */
65   public abstract boolean isValidAncestor(@NotNull VirtualFile baseDir, @NotNull VirtualFile child);
66
67   public boolean shouldBeFound(@NotNull GlobalSearchScope scope, @NotNull VirtualFile virtualFile) {
68     return scope.isSearchOutsideRootModel() || isInContent(virtualFile) || isInLibrarySource(virtualFile);
69   }
70
71   @NotNull public abstract ModificationTracker getRootModificationTracker();
72
73   /**
74    * @return descriptions of all modules which are unloaded from the project
75    * @see UnloadedModuleDescription
76    */
77   @NotNull
78   public abstract Collection<UnloadedModuleDescription> getUnloadedModuleDescriptions();
79
80   /**
81    * @return true if the {@code file} is {@link #isInContent} except when it's in {@link #isInLibraryClasses} and not in {@link #isInLibrarySource}
82    */
83   public boolean isInProjectScope(@NotNull VirtualFile file) {
84     if (file instanceof VirtualFileWindow) return true;
85
86     if (isInLibraryClasses(file) && !isInSourceContent(file)) return false;
87
88     return isInContent(file);
89   }
90 }