[duplicates] enable duplicates analysis in PyCharm/WebStorm/PhpStorm/RubyMine
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / roots / ProjectFileIndex.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.openapi.roots;
17
18 import com.intellij.openapi.components.ServiceManager;
19 import com.intellij.openapi.fileTypes.FileTypeRegistry;
20 import com.intellij.openapi.module.Module;
21 import com.intellij.openapi.project.Project;
22 import com.intellij.openapi.vfs.VirtualFile;
23 import org.jetbrains.annotations.NotNull;
24 import org.jetbrains.annotations.Nullable;
25
26 import java.util.List;
27
28 /**
29  * Provides information about files contained in a project. Should be used from a read action.
30  *
31  * @see ProjectRootManager#getFileIndex()
32  */
33 public interface ProjectFileIndex extends FileIndex {
34   class SERVICE {
35     private SERVICE() { }
36
37     public static ProjectFileIndex getInstance(Project project) {
38       return ProjectFileIndex.getInstance(project);
39     }
40   }
41
42   @NotNull
43   static ProjectFileIndex getInstance(@NotNull Project project) {
44     return ServiceManager.getService(project, ProjectFileIndex.class);
45   }
46
47   /**
48    * Returns module to which content the specified file belongs or null if the file does not belong to content of any module.
49    */
50   @Nullable
51   Module getModuleForFile(@NotNull VirtualFile file);
52
53   /**
54    * Returns module to which content the specified file belongs or null if the file does not belong to content of any module.
55    *
56    * @param honorExclusion if {@code false} the containing module will be returned even if the file is located under a folder marked as excluded
57    */
58   @Nullable
59   Module getModuleForFile(@NotNull VirtualFile file, boolean honorExclusion);
60
61   /**
62    * Returns the order entries which contain the specified file (either in CLASSES or SOURCES).
63    */
64   @NotNull
65   List<OrderEntry> getOrderEntriesForFile(@NotNull VirtualFile file);
66
67   /**
68    * Returns a classpath entry to which the specified file or directory belongs.
69    *
70    * @return the file for the classpath entry, or null if the file is not a compiled
71    *         class file or directory belonging to a library.
72    */
73   @Nullable
74   VirtualFile getClassRootForFile(@NotNull VirtualFile file);
75
76   /**
77    * Returns the module source root or library source root to which the specified file or directory belongs.
78    *
79    * @return the file for the source root, or null if the file is not located under any of the source roots for the module.
80    */
81   @Nullable
82   VirtualFile getSourceRootForFile(@NotNull VirtualFile file);
83
84   /**
85    * Returns the module content root to which the specified file or directory belongs or null if the file does not belong to content of any module.
86    */
87   @Nullable
88   VirtualFile getContentRootForFile(@NotNull VirtualFile file);
89
90   /**
91    * Returns the module content root to which the specified file or directory belongs or null if the file does not belong to content of any module.
92    *
93    * @param honorExclusion if {@code false} the containing content root will be returned even if the file is located under a folder marked as excluded
94    */
95   @Nullable
96   VirtualFile getContentRootForFile(@NotNull VirtualFile file, final boolean honorExclusion);
97
98   /**
99    * Returns the name of the package corresponding to the specified directory.
100    *
101    * @return the package name, or null if the directory does not correspond to any package.
102    */
103   @Nullable
104   String getPackageNameByDirectory(@NotNull VirtualFile dir); //Q: move to FileIndex?
105
106   /**
107    * Returns true if {@code file} is a file which belongs to the classes (not sources) of some library which is included into dependencies
108    * of some module.
109    */
110   boolean isLibraryClassFile(@NotNull VirtualFile file);
111
112   /**
113    * Returns true if {@code fileOrDir} is a file or directory from production/test sources of some module or sources of some library which is included into dependencies
114    * of some module.
115    */
116   boolean isInSource(@NotNull VirtualFile fileOrDir);
117
118   /**
119    * Returns true if {@code fileOrDir} belongs to classes of some library which is included into dependencies of some module.
120    */
121   boolean isInLibraryClasses(@NotNull VirtualFile fileOrDir);
122
123   /**
124    * @return true if the file belongs to the classes or sources of a library added to dependencies of the project,
125    *         false otherwise
126    */
127   boolean isInLibrary(@NotNull VirtualFile fileOrDir);
128
129   /**
130    * Returns true if {@code fileOrDir} is a file or directory from sources of some library which is included into dependencies
131    * of some module.
132    */
133   boolean isInLibrarySource(@NotNull VirtualFile fileOrDir);
134
135   /**
136    * @deprecated name of this method may be confusing. If you want to check if the file is excluded or ignored use {@link #isExcluded(VirtualFile)}.
137    * If you want to check if the file is ignored use {@link FileTypeRegistry#isFileIgnored(VirtualFile)}.
138    * If you want to check if the file or one of its parents is ignored use {@link #isUnderIgnored(VirtualFile)}.
139    */
140   @Deprecated
141   boolean isIgnored(@NotNull VirtualFile file);
142
143   /**
144    * Checks if the specified file or directory is located under project roots but the file itself or one of its parent directories is
145    * either excluded from the project or ignored by {@link FileTypeRegistry#isFileIgnored(VirtualFile)}).
146    *
147    * @return true if {@code file} is excluded or ignored, false otherwise.
148    */
149   boolean isExcluded(@NotNull VirtualFile file);
150
151   /**
152    * Checks if the specified file or directory is located under project roots but the file itself or one of its parent directories is ignored
153    * by {@link FileTypeRegistry#isFileIgnored(VirtualFile)}).
154    *
155    * @return true if {@code file} is ignored, false otherwise.
156    */
157   boolean isUnderIgnored(@NotNull VirtualFile file);
158 }