75e693f140e8cfc36d3240fc7676fc3889f6f160
[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.openapi.components.ServiceManager;
19 import com.intellij.openapi.module.Module;
20 import com.intellij.openapi.project.Project;
21 import com.intellij.openapi.vfs.VirtualFile;
22 import com.intellij.psi.search.GlobalSearchScope;
23 import org.jetbrains.annotations.Nullable;
24
25 /**
26  * @author yole
27  */
28 public abstract class FileIndexFacade {
29   protected final Project myProject;
30
31   protected FileIndexFacade(final Project project) {
32     myProject = project;
33   }
34
35   public static FileIndexFacade getInstance(Project project) {
36     return ServiceManager.getService(project, FileIndexFacade.class);
37   }
38
39   public abstract boolean isInContent(VirtualFile file);
40   public abstract boolean isInSource(VirtualFile file);
41   public abstract boolean isInSourceContent(VirtualFile file);
42   public abstract boolean isInLibraryClasses(VirtualFile file);
43   public abstract boolean isInSdkClasses(VirtualFile file);
44   public abstract boolean isInLibrarySource(VirtualFile file);
45   public abstract boolean isExcludedFile(VirtualFile file);
46
47   @Nullable
48   public abstract Module getModuleForFile(VirtualFile file);
49
50   /**
51    * Checks if <code>file</code> is an ancestor of <code>baseDir</code> and none of the files
52    * between them are excluded from the project.
53    *
54    * @param baseDir the parent directory to check for ancestry.
55    * @param child the child directory or file to check for ancestry.
56    * @return true if it's a valid ancestor, false otherwise.
57    */
58   public abstract boolean isValidAncestor(final VirtualFile baseDir, final VirtualFile child);
59
60   public boolean shouldBeFound(GlobalSearchScope scope, VirtualFile virtualFile) {
61     return (scope.isSearchOutsideRootModel() || isInContent(virtualFile) || isInLibrarySource(virtualFile)) && !virtualFile.getFileType().isBinary();
62   }
63 }