Improve and fix setting up modules and language levels per module

Author: halirutan

src/de/halirutan/mathematica/codeinsight/inspections/bugs/UnsupportedVersion.java

@@ -27,16 +27,12 @@
 import com.intellij.codeInspection.LocalInspectionToolSession;
 import com.intellij.codeInspection.ProblemsHolder;
 import com.intellij.openapi.module.Module;
-import com.intellij.openapi.module.ModuleManager;
-import com.intellij.openapi.module.ModuleType;
+import com.intellij.openapi.module.ModuleUtilCore;
 import com.intellij.openapi.projectRoots.Sdk;
-import com.intellij.openapi.roots.ModuleFileIndex;
-import com.intellij.openapi.roots.ModuleRootManager;
 import com.intellij.openapi.roots.ProjectRootManager;
 import com.intellij.openapi.ui.ComboBox;
 import com.intellij.openapi.ui.VerticalFlowLayout;
 import com.intellij.openapi.util.TextRange;
-import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiElementVisitor;
 import com.intellij.psi.PsiFile;
@@ -48,8 +44,7 @@
 import de.halirutan.mathematica.lang.psi.api.Symbol;
 import de.halirutan.mathematica.lang.psi.api.lists.Association;
 import de.halirutan.mathematica.lang.psi.impl.LightBuiltInSymbol;
-import de.halirutan.mathematica.module.MathematicaLanguageLevelModuleExtensionImpl;
-import de.halirutan.mathematica.module.MathematicaModuleType;
+import de.halirutan.mathematica.module.MathematicaLanguageLevelModuleExtension;
 import de.halirutan.mathematica.sdk.MathematicaLanguageLevel;
 import de.halirutan.mathematica.sdk.MathematicaSdkType;
 import org.jetbrains.annotations.Nls;
@@ -73,6 +68,7 @@ public class UnsupportedVersion extends AbstractInspection {
 
   @SuppressWarnings({"InstanceVariableNamingConvention", "WeakerAccess"})
   public boolean useSDKLanguageLevelOrHighest = true;
+  @SuppressWarnings("WeakerAccess")
   public boolean useModuleLanguageLevelOrHighest = true;
 
   /**
@@ -168,23 +164,13 @@ public HighlightDisplayLevel getDefaultLevel() {
   public PsiElementVisitor buildVisitor(@NotNull final ProblemsHolder holder, final boolean isOnTheFly, @NotNull LocalInspectionToolSession session) {
     if (session.getFile().getFileType() instanceof MathematicaFileType) {
 
-      // TODO: There must be a simpler way to find the module for a source file
       if (useModuleLanguageLevelOrHighest) {
         final PsiFile file = session.getFile();
-        final ModuleManager instance = ModuleManager.getInstance(file.getProject());
-        for (Module module : instance.getModules()) {
-          if (ModuleType.is(module, MathematicaModuleType.getInstance())) {
-            final ModuleRootManager moduleRootManager = ModuleRootManager.getInstance(module);
-            final ModuleFileIndex fileIndex = moduleRootManager.getFileIndex();
-            final VirtualFile virtualFile = file.getVirtualFile();
-            if (fileIndex.isInContent(virtualFile)) {
-              final MathematicaLanguageLevelModuleExtensionImpl languageLevelModuleExtension =
-                  moduleRootManager.getModuleExtension(MathematicaLanguageLevelModuleExtensionImpl.class);
-              if (languageLevelModuleExtension.getMathematicaLanguageLevel() != null) {
-                return new WrongVersionVisitor(holder, languageLevelModuleExtension.getMathematicaLanguageLevel());
-              }
-            }
-          }
+        final Module moduleForFile = ModuleUtilCore.findModuleForFile(file.getVirtualFile(), file.getProject());
+        if (moduleForFile != null) {
+          final MathematicaLanguageLevel mathematicaLanguageLevel =
+              MathematicaLanguageLevelModuleExtension.getInstance(moduleForFile).getMathematicaLanguageLevel();
+          return new WrongVersionVisitor(holder, mathematicaLanguageLevel);
         }
       }
 

src/de/halirutan/mathematica/lang/resolve/processors/LocalDefinitionResolveProcessor.kt

@@ -83,15 +83,15 @@ import de.halirutan.mathematica.lang.resolve.resolvers.TableLikeResolver
 class LocalDefinitionResolveProcessor(private val myStartElement: Symbol) : BaseScopeProcessor() {
     /**
      * Returns the list of all symbols collected during a  run. Before returning
-     * the list, it removes duplicates, so that no entry appears more than once in the autocompletion window.
+     * the list, it removes duplicates, so that no entry appears more than once in the auto-completion window.
      *
      * @return Sorted and cleaned list of collected symbols.
      */
     var resolveResult: SymbolResolveResult? = null
 
     /**
      * There are several places where a local variable can be "defined". First I check all localization constructs which
-     * are always function call like `Module[{blub},...]`. The complete list of localization constructs can be
+     * are always function call like `Module[{var},...]`. The complete list of localization constructs can be
      * found in [MScope].
      *
      *

src/de/halirutan/mathematica/lang/resolve/resolvers/FunctionLikeResolver.kt

@@ -27,6 +27,7 @@ import com.intellij.psi.ResolveState
 import de.halirutan.mathematica.lang.psi.LocalizationConstruct
 import de.halirutan.mathematica.lang.psi.api.FunctionCall
 import de.halirutan.mathematica.lang.psi.api.Symbol
+import de.halirutan.mathematica.lang.psi.api.lists.MList
 import de.halirutan.mathematica.lang.resolve.SymbolResolveHint
 import de.halirutan.mathematica.lang.resolve.SymbolResolveResult
 
@@ -49,14 +50,25 @@ class FunctionLikeResolver : Resolver {
 
     // Symbol to resolve is located in the body of Compile
     if (lastParent == body) {
-      defLists
-          .filter { it is Symbol && it.hasSameName(symbol) }
-          .forEach { return SymbolResolveResult(it, scope, scopingElement, true) }
+      for (defList in defLists) {
+        if (defList is MList) {
+          for (elm in defList.listElements) {
+            if (elm is Symbol && elm.hasSameName(symbol)) {
+              return SymbolResolveResult(elm, scope, scopingElement, true)
+            }
+
+          }
+        }
+      }
     } else {
       defLists.indexOf(lastParent).takeUnless { it == -1 }?.let {
-        val defList = defLists[it]
-        if (defList is Symbol && defList == symbol) {
-          return SymbolResolveResult(defList, scope, scopingElement, true)
+        val expr = defLists[it]
+        if (expr is MList) {
+          for (elm in expr.listElements) {
+            if (elm is Symbol && elm == symbol) {
+              return SymbolResolveResult(elm, scope, scopingElement, true)
+            }
+          }
         }
       }
     }

src/de/halirutan/mathematica/module/MathematicaApplicationModule.java

@@ -5,13 +5,15 @@
 import de.halirutan.mathematica.MathematicaBundle;
 
 /**
- * @author patrick (08.12.17).
+ * A module builder that creates a package structure containing a separate folder for the source code. Under this folder
+ * it creates PacletInfo.m, package and notebook file and a Kernel directory with an init.m
  */
 public class MathematicaApplicationModule extends MathematicaModuleBuilder {
+
+  @SuppressWarnings("WeakerAccess")
   public MathematicaApplicationModule() {
   }
 
-
   @Override
   public String getPresentableName() {
     return MathematicaBundle.message("project.template.application");

src/de/halirutan/mathematica/module/MathematicaBasicModule.java

@@ -1,21 +1,21 @@
 package de.halirutan.mathematica.module;
 
-import com.intellij.ide.util.projectWizard.ModuleWizardStep;
-import com.intellij.ide.util.projectWizard.WizardContext;
-import com.intellij.openapi.roots.ui.configuration.ModulesProvider;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.vfs.VirtualFile;
 import de.halirutan.mathematica.MathematicaBundle;
-import org.jetbrains.annotations.NotNull;
 
 /**
- * @author patrick (08.12.17).
+ * A module builder that adds a simple package and a notebook file and nothing more
  */
 public class MathematicaBasicModule extends MathematicaModuleBuilder {
+
+  @SuppressWarnings("WeakerAccess")
   public MathematicaBasicModule() {
   }
 
   @Override
-  public ModuleWizardStep[] createWizardSteps(@NotNull WizardContext wizardContext, @NotNull ModulesProvider modulesProvider) {
-    return ModuleWizardStep.EMPTY_ARRAY;
+  protected void createModuleStructure(Project project, VirtualFile contentRoot) {
+    createProjectFiles(project, contentRoot);
   }
 
   @Override

src/de/halirutan/mathematica/module/MathematicaEmptyModule.java

@@ -3,9 +3,11 @@
 import de.halirutan.mathematica.MathematicaBundle;
 
 /**
- * @author patrick (08.12.17).
+ * Module builder for an empty module that does not create any folder structure or files
  */
 public class MathematicaEmptyModule extends MathematicaModuleBuilder {
+
+  @SuppressWarnings("WeakerAccess")
   public MathematicaEmptyModule() {
   }
 

src/de/halirutan/mathematica/module/MathematicaGeneralModuleSettingsEditor.java

@@ -1,16 +1,43 @@
 package de.halirutan.mathematica.module;
 
+import com.intellij.openapi.module.Module;
+import com.intellij.openapi.roots.ModuleExtension;
+import com.intellij.openapi.roots.ModuleRootManager;
 import de.halirutan.mathematica.sdk.MathematicaLanguageLevel;
-
-import javax.annotation.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 /**
+ * Interface declaring the methods that should be used by the user. Most other stuff in {@link MathematicaLanguageLevelModuleExtensionImpl}
+ * is internal (although declared public to make it accessible for the IntelliJ framework).
  * @author patrick (21.12.17).
  */
-public interface MathematicaLanguageLevelModuleExtension {
-  @Nullable
-  MathematicaLanguageLevel getMathematicaLanguageLevel();
+public abstract class MathematicaLanguageLevelModuleExtension extends ModuleExtension {
+
+  /**
+   * Returns an instance of the extension for a module. Always use this and not the constructor of the implementing
+   * class.
+   *
+   * @param module The module you want the extension for
+   *
+   * @return Instance that can be accessed and changed
+   */
+  public static MathematicaLanguageLevelModuleExtension getInstance(Module module) {
+    return ModuleRootManager.getInstance(module).getModuleExtension(MathematicaLanguageLevelModuleExtension.class);
+  }
+
+  /**
+   * Gets the current the language version for the module.
+   *
+   * @return Mathematica version that is used in the module
+   */
+  @NotNull
+  public abstract MathematicaLanguageLevel getMathematicaLanguageLevel();
 
-  void setMathematicaLanguageLevel(MathematicaLanguageLevel languageLevel);
+  /**
+   * Sets the language version for a module.
+   *
+   * @param languageLevel New language version.
+   */
+  public abstract void setMathematicaLanguageLevel(MathematicaLanguageLevel languageLevel);
 
 }