[project-model] findModuleForPsiElement: check original file if PsiFile is supplied
[idea/community.git] / platform / lang-api / src / com / intellij / ide / util / frameworkSupport / FrameworkSupportProvider.java
1 // Copyright 2000-2019 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.
2
3 package com.intellij.ide.util.frameworkSupport;
4
5 import com.intellij.ide.util.projectWizard.ModuleBuilder;
6 import com.intellij.openapi.extensions.ExtensionPointName;
7 import com.intellij.openapi.module.Module;
8 import com.intellij.openapi.module.ModuleType;
9 import com.intellij.openapi.roots.ui.configuration.FacetsProvider;
10 import com.intellij.util.ArrayUtilRt;
11 import org.jetbrains.annotations.Nls;
12 import org.jetbrains.annotations.NonNls;
13 import org.jetbrains.annotations.NotNull;
14 import org.jetbrains.annotations.Nullable;
15
16 import javax.swing.*;
17
18 /**
19  * Extend {@link FrameworkSupportProviderBase} for general and {@link com.intellij.facet.ui.FacetBasedFrameworkSupportProvider} for
20  * {@link com.intellij.facet.Facet}-based framework support in your plugin.
21  */
22 public abstract class FrameworkSupportProvider {
23   public static final ExtensionPointName<FrameworkSupportProvider> EXTENSION_POINT = ExtensionPointName.create("com.intellij.frameworkSupport");
24   private final String myId;
25   private final @Nls(capitalization = Nls.Capitalization.Title) String myTitle;
26
27   protected FrameworkSupportProvider(@NotNull @NonNls final String id,
28                                      @NotNull final @Nls(capitalization = Nls.Capitalization.Title) String title) {
29     myId = id;
30     myTitle = title;
31   }
32
33   /**
34    * Creates configurable for user settings (e.g. choosing version, features, ...).
35    *
36    * @param model Model.
37    * @return Configurable.
38    */
39   @NotNull
40   public abstract FrameworkSupportConfigurable createConfigurable(@NotNull FrameworkSupportModel model);
41
42   @NonNls
43   @Nullable
44   public String getUnderlyingFrameworkId() {
45     return null;
46   }
47
48   @NonNls
49   public String[] getPrecedingFrameworkProviderIds() {
50     return ArrayUtilRt.EMPTY_STRING_ARRAY;
51   }
52
53   @Nls(capitalization = Nls.Capitalization.Title)
54   public String getTitle() {
55     return myTitle;
56   }
57
58   @Nullable @NonNls
59   public String getGroupId() {
60     return null;
61   }
62
63   public String @NotNull [] getProjectCategories() {
64     return getGroupId() == null ? ArrayUtilRt.EMPTY_STRING_ARRAY : new String[] { getGroupId() };
65   }
66
67   public FrameworkRole[] getRoles() {
68     return getGroupId() == null ? FrameworkRole.UNKNOWN : new FrameworkRole[] { new FrameworkRole(getGroupId()) };
69   }
70
71   @Nullable
72   public Icon getIcon() {
73     return null;
74   }
75
76   public abstract boolean isEnabledForModuleType(@NotNull ModuleType moduleType);
77
78   public boolean isEnabledForModuleBuilder(@NotNull ModuleBuilder builder) {
79     return isEnabledForModuleType(builder.getModuleType());
80   }
81
82   public boolean isSupportAlreadyAdded(@NotNull Module module) {
83     return false;
84   }
85
86   public boolean isSupportAlreadyAdded(@NotNull Module module, @NotNull FacetsProvider facetsProvider) {
87     return isSupportAlreadyAdded(module);
88   }
89
90   @NotNull @NonNls
91   public final String getId() {
92     return myId;
93   }
94 }