cleanup
[idea/community.git] / platform / core-api / src / com / intellij / openapi / roots / FileIndexFacade.java
index 96dde81c6a80f85ce44a368ec88650bbe014944e..4ecf56688d6cd9428c91a98b08f4997c1e54902d 100644 (file)
@@ -1,22 +1,8 @@
-/*
- * Copyright 2000-2011 JetBrains s.r.o.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+// Copyright 2000-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
 package com.intellij.openapi.roots;
 
 package com.intellij.openapi.roots;
 
-import com.intellij.openapi.components.ServiceManager;
 import com.intellij.openapi.module.Module;
 import com.intellij.openapi.module.Module;
+import com.intellij.openapi.module.UnloadedModuleDescription;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.util.ModificationTracker;
 import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.util.ModificationTracker;
 import com.intellij.openapi.vfs.VirtualFile;
@@ -24,18 +10,20 @@ import com.intellij.psi.search.GlobalSearchScope;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import java.util.Collection;
+
 /**
  * @author yole
  */
 public abstract class FileIndexFacade {
   protected final Project myProject;
 
 /**
  * @author yole
  */
 public abstract class FileIndexFacade {
   protected final Project myProject;
 
-  protected FileIndexFacade(final Project project) {
+  protected FileIndexFacade(@NotNull Project project) {
     myProject = project;
   }
 
   public static FileIndexFacade getInstance(Project project) {
     myProject = project;
   }
 
   public static FileIndexFacade getInstance(Project project) {
-    return ServiceManager.getService(project, FileIndexFacade.class);
+    return project.getService(FileIndexFacade.class);
   }
 
   public abstract boolean isInContent(@NotNull VirtualFile file);
   }
 
   public abstract boolean isInContent(@NotNull VirtualFile file);
@@ -47,11 +35,10 @@ public abstract class FileIndexFacade {
   public abstract boolean isExcludedFile(@NotNull VirtualFile file);
   public abstract boolean isUnderIgnored(@NotNull VirtualFile file);
 
   public abstract boolean isExcludedFile(@NotNull VirtualFile file);
   public abstract boolean isUnderIgnored(@NotNull VirtualFile file);
 
-  @Nullable
-  public abstract Module getModuleForFile(@NotNull VirtualFile file);
+  public abstract @Nullable Module getModuleForFile(@NotNull VirtualFile file);
 
   /**
 
   /**
-   * Checks if <code>file</code> is an ancestor of <code>baseDir</code> and none of the files
+   * Checks if {@code file} is an ancestor of {@code baseDir} and none of the files
    * between them are excluded from the project.
    *
    * @param baseDir the parent directory to check for ancestry.
    * between them are excluded from the project.
    *
    * @param baseDir the parent directory to check for ancestry.
@@ -60,9 +47,29 @@ public abstract class FileIndexFacade {
    */
   public abstract boolean isValidAncestor(@NotNull VirtualFile baseDir, @NotNull VirtualFile child);
 
    */
   public abstract boolean isValidAncestor(@NotNull VirtualFile baseDir, @NotNull VirtualFile child);
 
-  public boolean shouldBeFound(GlobalSearchScope scope, VirtualFile virtualFile) {
-    return (scope.isSearchOutsideRootModel() || isInContent(virtualFile) || isInLibrarySource(virtualFile)) && !virtualFile.getFileType().isBinary();
+  /**
+   * @deprecated always returns true, just remove the calls
+   */
+  @SuppressWarnings("unused")
+  @Deprecated
+  public boolean shouldBeFound(@NotNull GlobalSearchScope scope, @NotNull VirtualFile virtualFile) {
+    return true;
   }
 
   }
 
-  @NotNull public abstract ModificationTracker getRootModificationTracker();
+  public abstract @NotNull ModificationTracker getRootModificationTracker();
+
+  /**
+   * @return descriptions of all modules which are unloaded from the project
+   * @see UnloadedModuleDescription
+   */
+  public abstract @NotNull Collection<UnloadedModuleDescription> getUnloadedModuleDescriptions();
+
+  /**
+   * @return true if the {@code file} is {@link #isInContent} except when it's in {@link #isInLibraryClasses} and not in {@link #isInLibrarySource}
+   */
+  public boolean isInProjectScope(@NotNull VirtualFile file) {
+    if (isInLibraryClasses(file) && !isInSourceContent(file)) return false;
+
+    return isInContent(file);
+  }
 }
 }