-
Notifications
You must be signed in to change notification settings - Fork 323
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Exporting non-existing symbols fails with compiler error (#7960)
Adds a new compiler analysis pass that ensures that all the symbols exported via `export ...` or `from ... export ...` statements exist. If not, generates an IR Error. # Important Notes We already have such a compiler pass for the version with imports in [ImportSymbolAnalysis.scala](https://github.com/enso-org/enso/blob/develop/engine/runtime/src/main/scala/org/enso/compiler/pass/analyse/ImportSymbolAnalysis.scala)
- Loading branch information
Showing
8 changed files
with
309 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
146 changes: 146 additions & 0 deletions
146
engine/runtime/src/main/java/org/enso/compiler/pass/analyse/ExportSymbolAnalysis.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| package org.enso.compiler.pass.analyse; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.UUID; | ||
| import org.enso.compiler.context.InlineContext; | ||
| import org.enso.compiler.context.ModuleContext; | ||
| import org.enso.compiler.core.IR; | ||
| import org.enso.compiler.core.ir.Expression; | ||
| import org.enso.compiler.core.ir.Module; | ||
| import org.enso.compiler.core.ir.expression.errors.ImportExport; | ||
| import org.enso.compiler.core.ir.module.scope.Export; | ||
| import org.enso.compiler.data.BindingsMap; | ||
| import org.enso.compiler.pass.IRPass; | ||
| import org.enso.interpreter.util.ScalaConversions; | ||
| import scala.collection.immutable.Seq; | ||
| import scala.jdk.javaapi.CollectionConverters; | ||
|
|
||
| /** | ||
| * This pass ensures that all the symbols that are exported exist. If not, an IR error is generated. | ||
| */ | ||
| public final class ExportSymbolAnalysis implements IRPass { | ||
| public static final ExportSymbolAnalysis INSTANCE = new ExportSymbolAnalysis(); | ||
| private static scala.collection.immutable.List<IRPass> precursorPasses; | ||
| private UUID uuid; | ||
|
|
||
| private ExportSymbolAnalysis() {} | ||
|
|
||
| @Override | ||
| public UUID key() { | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public void org$enso$compiler$pass$IRPass$_setter_$key_$eq(UUID v) { | ||
| this.uuid = v; | ||
| } | ||
|
|
||
| @Override | ||
| public Seq<IRPass> precursorPasses() { | ||
| if (precursorPasses == null) { | ||
| List<IRPass> passes = List.of( | ||
| BindingAnalysis$.MODULE$, | ||
| ImportSymbolAnalysis$.MODULE$ | ||
| ); | ||
| precursorPasses = CollectionConverters.asScala(passes).toList(); | ||
| } | ||
| return precursorPasses; | ||
| } | ||
|
|
||
| @Override | ||
| public Seq<IRPass> invalidatedPasses() { | ||
| return ScalaConversions.nil(); | ||
| } | ||
|
|
||
| @Override | ||
| public Module runModule(Module moduleIr, ModuleContext moduleContext) { | ||
| List<Export> exportErrors = new ArrayList<>(); | ||
| var bindingsMap = (BindingsMap) moduleIr.passData().get(BindingAnalysis$.MODULE$).get(); | ||
|
|
||
| moduleIr.exports().foreach(export -> switch (export) { | ||
| case Export.Module exportMod -> { | ||
| var exportNameParts = exportMod.name().parts(); | ||
| var symbolName = exportMod.name().parts().last(); | ||
| assert exportNameParts.size() > 1; | ||
| var moduleOrTypeName = exportNameParts.apply(exportNameParts.size() - 2); | ||
| var foundResolvedExp = findResolvedExportForIr(export, bindingsMap); | ||
| if (foundResolvedExp == null) { | ||
| exportErrors.add( | ||
| ImportExport.apply( | ||
| symbolName, | ||
| new ImportExport.SymbolDoesNotExist(symbolName.name(), moduleOrTypeName.name()), | ||
| ImportExport.apply$default$3(), | ||
| ImportExport.apply$default$4() | ||
| ) | ||
| ); | ||
| } else { | ||
| if (exportMod.onlyNames().isDefined()) { | ||
| assert exportMod.onlyNames().isDefined(); | ||
| var exportedSymbols = exportMod.onlyNames().get(); | ||
| exportedSymbols.foreach(exportedSymbol -> { | ||
| var foundSymbols = foundResolvedExp.target().findExportedSymbolsFor(exportedSymbol.name()); | ||
| if (foundSymbols.isEmpty()) { | ||
| exportErrors.add( | ||
| ImportExport.apply( | ||
| exportedSymbol, | ||
| new ImportExport.SymbolDoesNotExist(exportedSymbol.name(), moduleOrTypeName.name()), | ||
| ImportExport.apply$default$3(), | ||
| ImportExport.apply$default$4() | ||
| ) | ||
| ); | ||
| } | ||
| return null; | ||
| }); | ||
| } | ||
| } | ||
| yield null; | ||
| } | ||
| default -> export; | ||
| }); | ||
|
|
||
| if (exportErrors.isEmpty()) { | ||
| return moduleIr; | ||
| } else { | ||
| return moduleIr.copy( | ||
| moduleIr.imports(), | ||
| CollectionConverters.asScala(exportErrors).toList(), | ||
| moduleIr.bindings(), | ||
| moduleIr.location(), | ||
| moduleIr.passData(), | ||
| moduleIr.diagnostics(), | ||
| moduleIr.id() | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public Expression runExpression(Expression ir, InlineContext inlineContext) { | ||
| return ir; | ||
| } | ||
|
|
||
| /** | ||
| * Finds a resolved export that corresponds to the export IR. | ||
| * @param exportIr Export IR that is being resolved | ||
| * @param bindingsMap Bindings map of the module that contains the export IR | ||
| * @return null if no resolved export was found, otherwise the resolved export | ||
| */ | ||
| private BindingsMap.ExportedModule findResolvedExportForIr(Export exportIr, BindingsMap bindingsMap) { | ||
| switch (exportIr) { | ||
| case Export.Module exportedModIr -> { | ||
| var exportedModName = exportedModIr.name().name(); | ||
| var foundResolvedExp = bindingsMap.resolvedExports().find(resolvedExport -> { | ||
| var resolvedExportName = resolvedExport.target().qualifiedName(); | ||
| return resolvedExportName.toString().equals(exportedModName); | ||
| }); | ||
| return foundResolvedExp.isEmpty() ? null : foundResolvedExp.get(); | ||
| } | ||
| default -> throw new IllegalStateException("Unexpected value: " + exportIr); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public <T extends IR> T updateMetadataInDuplicate(T sourceIr, T copyOfIr) { | ||
| return IRPass.super.updateMetadataInDuplicate(sourceIr, copyOfIr); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.