| /* |
| * Copyright (c) 2009, 2016, Oracle and/or its affiliates. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Oracle designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Oracle in the LICENSE file that accompanied this code. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| |
| package com.sun.tools.javac.comp; |
| |
| import java.io.IOException; |
| import java.util.Arrays; |
| import java.util.Collection; |
| import java.util.Collections; |
| import java.util.EnumSet; |
| import java.util.HashMap; |
| import java.util.HashSet; |
| import java.util.LinkedHashMap; |
| import java.util.LinkedHashSet; |
| import java.util.Map; |
| import java.util.Map.Entry; |
| import java.util.Set; |
| import java.util.function.Predicate; |
| import java.util.regex.Matcher; |
| import java.util.regex.Pattern; |
| import java.util.stream.Stream; |
| |
| import javax.lang.model.SourceVersion; |
| import javax.tools.JavaFileManager; |
| import javax.tools.JavaFileManager.Location; |
| import javax.tools.JavaFileObject; |
| import javax.tools.JavaFileObject.Kind; |
| import javax.tools.StandardLocation; |
| |
| import com.sun.tools.javac.code.Directive; |
| import com.sun.tools.javac.code.Directive.ExportsDirective; |
| import com.sun.tools.javac.code.Directive.RequiresDirective; |
| import com.sun.tools.javac.code.Directive.RequiresFlag; |
| import com.sun.tools.javac.code.Directive.UsesDirective; |
| import com.sun.tools.javac.code.Flags; |
| import com.sun.tools.javac.code.Kinds; |
| import com.sun.tools.javac.code.ModuleFinder; |
| import com.sun.tools.javac.code.Source; |
| import com.sun.tools.javac.code.Symbol; |
| import com.sun.tools.javac.code.Symbol.ClassSymbol; |
| import com.sun.tools.javac.code.Symbol.Completer; |
| import com.sun.tools.javac.code.Symbol.CompletionFailure; |
| import com.sun.tools.javac.code.Symbol.MethodSymbol; |
| import com.sun.tools.javac.code.Symbol.ModuleSymbol; |
| import com.sun.tools.javac.code.Symbol.PackageSymbol; |
| import com.sun.tools.javac.code.Symtab; |
| import com.sun.tools.javac.code.Type; |
| import com.sun.tools.javac.jvm.ClassWriter; |
| import com.sun.tools.javac.jvm.JNIWriter; |
| import com.sun.tools.javac.main.Option; |
| import com.sun.tools.javac.resources.CompilerProperties.Errors; |
| import com.sun.tools.javac.resources.CompilerProperties.Warnings; |
| import com.sun.tools.javac.tree.JCTree; |
| import com.sun.tools.javac.tree.JCTree.JCCompilationUnit; |
| import com.sun.tools.javac.tree.JCTree.JCExports; |
| import com.sun.tools.javac.tree.JCTree.JCExpression; |
| import com.sun.tools.javac.tree.JCTree.JCModuleDecl; |
| import com.sun.tools.javac.tree.JCTree.JCPackageDecl; |
| import com.sun.tools.javac.tree.JCTree.JCProvides; |
| import com.sun.tools.javac.tree.JCTree.JCRequires; |
| import com.sun.tools.javac.tree.JCTree.JCUses; |
| import com.sun.tools.javac.tree.TreeInfo; |
| import com.sun.tools.javac.util.Assert; |
| import com.sun.tools.javac.util.Context; |
| import com.sun.tools.javac.util.JCDiagnostic; |
| import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition; |
| import com.sun.tools.javac.util.List; |
| import com.sun.tools.javac.util.ListBuffer; |
| import com.sun.tools.javac.util.Log; |
| import com.sun.tools.javac.util.Name; |
| import com.sun.tools.javac.util.Names; |
| import com.sun.tools.javac.util.Options; |
| |
| import static com.sun.tools.javac.code.Flags.UNATTRIBUTED; |
| import static com.sun.tools.javac.code.Kinds.Kind.MDL; |
| import static com.sun.tools.javac.code.TypeTag.CLASS; |
| |
| import com.sun.tools.javac.tree.JCTree.JCDirective; |
| import com.sun.tools.javac.tree.JCTree.Tag; |
| |
| import static com.sun.tools.javac.code.Flags.ABSTRACT; |
| import static com.sun.tools.javac.code.Flags.PUBLIC; |
| import static com.sun.tools.javac.tree.JCTree.Tag.MODULEDEF; |
| |
| /** |
| * TODO: fill in |
| * |
| * <p><b>This is NOT part of any supported API. |
| * If you write code that depends on this, you do so at your own risk. |
| * This code and its internal interfaces are subject to change or |
| * deletion without notice.</b> |
| */ |
| public class Modules extends JCTree.Visitor { |
| private static final String ALL_SYSTEM = "ALL-SYSTEM"; |
| private static final String ALL_MODULE_PATH = "ALL-MODULE-PATH"; |
| |
| private final Log log; |
| private final Names names; |
| private final Symtab syms; |
| private final Attr attr; |
| private final TypeEnvs typeEnvs; |
| private final JavaFileManager fileManager; |
| private final ModuleFinder moduleFinder; |
| private final boolean allowModules; |
| |
| public final boolean multiModuleMode; |
| public final boolean noModules; |
| |
| private final String moduleOverride; |
| |
| ModuleSymbol defaultModule; |
| |
| private final String addExportsOpt; |
| private Map<ModuleSymbol, Set<ExportsDirective>> addExports; |
| private final String addReadsOpt; |
| private Map<ModuleSymbol, Set<RequiresDirective>> addReads; |
| private final String addModsOpt; |
| private final String limitModsOpt; |
| |
| private Set<ModuleSymbol> rootModules = Collections.emptySet(); |
| |
| public static Modules instance(Context context) { |
| Modules instance = context.get(Modules.class); |
| if (instance == null) |
| instance = new Modules(context); |
| return instance; |
| } |
| |
| protected Modules(Context context) { |
| context.put(Modules.class, this); |
| log = Log.instance(context); |
| names = Names.instance(context); |
| syms = Symtab.instance(context); |
| attr = Attr.instance(context); |
| typeEnvs = TypeEnvs.instance(context); |
| moduleFinder = ModuleFinder.instance(context); |
| fileManager = context.get(JavaFileManager.class); |
| allowModules = Source.instance(context).allowModules(); |
| Options options = Options.instance(context); |
| |
| moduleOverride = options.get(Option.XMODULE); |
| |
| // The following is required, for now, to support building |
| // Swing beaninfo via javadoc. |
| noModules = options.isSet("noModules"); |
| |
| multiModuleMode = fileManager.hasLocation(StandardLocation.MODULE_SOURCE_PATH); |
| ClassWriter classWriter = ClassWriter.instance(context); |
| classWriter.multiModuleMode = multiModuleMode; |
| JNIWriter jniWriter = JNIWriter.instance(context); |
| jniWriter.multiModuleMode = multiModuleMode; |
| |
| addExportsOpt = options.get(Option.XADDEXPORTS); |
| addReadsOpt = options.get(Option.XADDREADS); |
| addModsOpt = options.get(Option.ADDMODS); |
| limitModsOpt = options.get(Option.LIMITMODS); |
| } |
| |
| int depth = -1; |
| private void dprintln(String msg) { |
| for (int i = 0; i < depth; i++) |
| System.err.print(" "); |
| System.err.println(msg); |
| } |
| |
| public boolean enter(List<JCCompilationUnit> trees, ClassSymbol c) { |
| if (!allowModules || noModules) { |
| for (JCCompilationUnit tree: trees) { |
| tree.modle = syms.noModule; |
| } |
| defaultModule = syms.noModule; |
| return true; |
| } |
| |
| int startErrors = log.nerrors; |
| |
| depth++; |
| try { |
| // scan trees for module defs |
| Set<ModuleSymbol> roots = enterModules(trees, c); |
| |
| setCompilationUnitModules(trees, roots); |
| |
| if (!roots.isEmpty() && this.rootModules.isEmpty()) { |
| this.rootModules = roots; |
| allModules(); //ensure errors reported |
| } |
| |
| for (ModuleSymbol msym: roots) { |
| msym.complete(); |
| } |
| } finally { |
| depth--; |
| } |
| |
| return (log.nerrors == startErrors); |
| } |
| |
| public Completer getCompleter() { |
| return mainCompleter; |
| } |
| |
| public ModuleSymbol getDefaultModule() { |
| return defaultModule; |
| } |
| |
| private Set<ModuleSymbol> enterModules(List<JCCompilationUnit> trees, ClassSymbol c) { |
| Set<ModuleSymbol> modules = new LinkedHashSet<>(); |
| for (JCCompilationUnit tree : trees) { |
| JavaFileObject prev = log.useSource(tree.sourcefile); |
| try { |
| enterModule(tree, c, modules); |
| } finally { |
| log.useSource(prev); |
| } |
| } |
| return modules; |
| } |
| |
| |
| private void enterModule(JCCompilationUnit toplevel, ClassSymbol c, Set<ModuleSymbol> modules) { |
| boolean isModuleInfo = toplevel.sourcefile.isNameCompatible("module-info", Kind.SOURCE); |
| boolean isModuleDecl = toplevel.defs.nonEmpty() && toplevel.defs.head.hasTag(MODULEDEF); |
| if (isModuleInfo && isModuleDecl) { |
| JCModuleDecl decl = (JCModuleDecl) toplevel.defs.head; |
| Name name = TreeInfo.fullName(decl.qualId); |
| ModuleSymbol sym; |
| if (c != null) { |
| sym = (ModuleSymbol) c.owner; |
| if (sym.name == null) { |
| //ModuleFinder.findSingleModule creates a stub of a ModuleSymbol without a name, |
| //fill the name here after the module-info.java has been parsed |
| //also enter the ModuleSymbol among modules: |
| syms.enterModule(sym, name); |
| } else { |
| // TODO: validate name |
| } |
| } else { |
| sym = syms.enterModule(name); |
| if (sym.module_info.sourcefile != null && sym.module_info.sourcefile != toplevel.sourcefile) { |
| log.error(decl.pos(), Errors.DuplicateModule(sym)); |
| return; |
| } |
| } |
| sym.completer = getSourceCompleter(toplevel); |
| sym.module_info.sourcefile = toplevel.sourcefile; |
| decl.sym = sym; |
| |
| if (multiModuleMode || modules.isEmpty()) { |
| modules.add(sym); |
| } else { |
| log.error(toplevel.pos(), Errors.TooManyModules); |
| } |
| |
| Env<AttrContext> provisionalEnv = new Env<>(decl, null); |
| |
| provisionalEnv.toplevel = toplevel; |
| typeEnvs.put(sym, provisionalEnv); |
| } else if (isModuleInfo) { |
| if (multiModuleMode) { |
| JCTree tree = toplevel.defs.isEmpty() ? toplevel : toplevel.defs.head; |
| log.error(tree.pos(), Errors.ExpectedModule); |
| } |
| } else if (isModuleDecl) { |
| JCTree tree = toplevel.defs.head; |
| log.error(tree.pos(), Errors.ModuleDeclSbInModuleInfoJava); |
| } |
| } |
| |
| private void setCompilationUnitModules(List<JCCompilationUnit> trees, Set<ModuleSymbol> rootModules) { |
| // update the module for each compilation unit |
| if (multiModuleMode) { |
| checkNoAllModulePath(); |
| for (JCCompilationUnit tree: trees) { |
| if (tree.defs.isEmpty()) { |
| tree.modle = syms.unnamedModule; |
| continue; |
| } |
| |
| JavaFileObject prev = log.useSource(tree.sourcefile); |
| try { |
| Location locn = getModuleLocation(tree); |
| if (locn != null) { |
| Name name = names.fromString(fileManager.inferModuleName(locn)); |
| ModuleSymbol msym; |
| if (tree.defs.head.hasTag(MODULEDEF)) { |
| JCModuleDecl decl = (JCModuleDecl) tree.defs.head; |
| msym = decl.sym; |
| if (msym.name != name) { |
| log.error(decl.qualId, Errors.ModuleNameMismatch(msym.name, name)); |
| } |
| } else { |
| msym = syms.enterModule(name); |
| } |
| if (msym.sourceLocation == null) { |
| msym.sourceLocation = locn; |
| if (fileManager.hasLocation(StandardLocation.CLASS_OUTPUT)) { |
| msym.classLocation = fileManager.getModuleLocation( |
| StandardLocation.CLASS_OUTPUT, msym.name.toString()); |
| } |
| } |
| tree.modle = msym; |
| rootModules.add(msym); |
| } else { |
| log.error(tree.pos(), Errors.UnnamedPkgNotAllowedNamedModules); |
| tree.modle = syms.errModule; |
| } |
| } catch (IOException e) { |
| throw new Error(e); // FIXME |
| } finally { |
| log.useSource(prev); |
| } |
| } |
| if (syms.unnamedModule.sourceLocation == null) { |
| syms.unnamedModule.completer = getUnnamedModuleCompleter(); |
| syms.unnamedModule.sourceLocation = StandardLocation.SOURCE_PATH; |
| syms.unnamedModule.classLocation = StandardLocation.CLASS_PATH; |
| } |
| defaultModule = syms.unnamedModule; |
| } else { |
| if (defaultModule == null) { |
| switch (rootModules.size()) { |
| case 0: |
| defaultModule = moduleFinder.findSingleModule(); |
| if (defaultModule == syms.unnamedModule) { |
| if (moduleOverride != null) { |
| checkNoAllModulePath(); |
| defaultModule = moduleFinder.findModule(names.fromString(moduleOverride)); |
| } else { |
| // Question: why not do findAllModules and initVisiblePackages here? |
| // i.e. body of unnamedModuleCompleter |
| defaultModule.completer = getUnnamedModuleCompleter(); |
| defaultModule.classLocation = StandardLocation.CLASS_PATH; |
| } |
| } else { |
| checkSpecifiedModule(trees, Errors.ModuleInfoWithXmoduleClasspath); |
| checkNoAllModulePath(); |
| defaultModule.complete(); |
| // Question: why not do completeModule here? |
| defaultModule.completer = new Completer() { |
| @Override |
| public void complete(Symbol sym) throws CompletionFailure { |
| completeModule((ModuleSymbol) sym); |
| } |
| }; |
| } |
| rootModules.add(defaultModule); |
| break; |
| case 1: |
| checkSpecifiedModule(trees, Errors.ModuleInfoWithXmoduleSourcepath); |
| checkNoAllModulePath(); |
| defaultModule = rootModules.iterator().next(); |
| defaultModule.classLocation = StandardLocation.CLASS_OUTPUT; |
| break; |
| default: |
| Assert.error("too many modules"); |
| } |
| defaultModule.sourceLocation = StandardLocation.SOURCE_PATH; |
| } else if (rootModules.size() == 1 && defaultModule == rootModules.iterator().next()) { |
| defaultModule.complete(); |
| defaultModule.completer = sym -> completeModule((ModuleSymbol) sym); |
| } else { |
| Assert.check(rootModules.isEmpty()); |
| } |
| |
| if (defaultModule != syms.unnamedModule) { |
| syms.unnamedModule.completer = getUnnamedModuleCompleter(); |
| syms.unnamedModule.sourceLocation = StandardLocation.SOURCE_PATH; |
| syms.unnamedModule.classLocation = StandardLocation.CLASS_PATH; |
| } |
| |
| for (JCCompilationUnit tree: trees) { |
| tree.modle = defaultModule; |
| } |
| } |
| } |
| |
| private Location getModuleLocation(JCCompilationUnit tree) throws IOException { |
| switch (tree.defs.head.getTag()) { |
| case MODULEDEF: |
| return getModuleLocation(tree.sourcefile, null); |
| |
| case PACKAGEDEF: |
| JCPackageDecl pkg = (JCPackageDecl) tree.defs.head; |
| return getModuleLocation(tree.sourcefile, TreeInfo.fullName(pkg.pid)); |
| |
| default: |
| // code in unnamed module |
| return null; |
| } |
| } |
| |
| private Location getModuleLocation(JavaFileObject fo, Name pkgName) throws IOException { |
| // For now, just check module source path. |
| // We may want to check source path as well. |
| return fileManager.getModuleLocation(StandardLocation.MODULE_SOURCE_PATH, |
| fo, (pkgName == null) ? null : pkgName.toString()); |
| } |
| |
| private void checkSpecifiedModule(List<JCCompilationUnit> trees, JCDiagnostic.Error error) { |
| if (moduleOverride != null) { |
| JavaFileObject prev = log.useSource(trees.head.sourcefile); |
| try { |
| log.error(trees.head.pos(), error); |
| } finally { |
| log.useSource(prev); |
| } |
| } |
| } |
| |
| private void checkNoAllModulePath() { |
| if (addModsOpt != null && Arrays.asList(addModsOpt.split(",")).contains(ALL_MODULE_PATH)) { |
| log.error(Errors.AddmodsAllModulePathInvalid); |
| } |
| } |
| |
| private final Completer mainCompleter = new Completer() { |
| @Override |
| public void complete(Symbol sym) throws CompletionFailure { |
| ModuleSymbol msym = moduleFinder.findModule((ModuleSymbol) sym); |
| |
| if (msym.kind == Kinds.Kind.ERR) { |
| log.error(Errors.CantFindModule(msym)); |
| //make sure the module is initialized: |
| msym.directives = List.nil(); |
| msym.exports = List.nil(); |
| msym.provides = List.nil(); |
| msym.requires = List.nil(); |
| msym.uses = List.nil(); |
| } else if ((msym.flags_field & Flags.AUTOMATIC_MODULE) != 0) { |
| completeAutomaticModule(msym); |
| } else { |
| msym.module_info.complete(); |
| } |
| |
| // If module-info comes from a .java file, the underlying |
| // call of classFinder.fillIn will have called through the |
| // source completer, to Enter, and then to Modules.enter, |
| // which will call completeModule. |
| // But, if module-info comes from a .class file, the underlying |
| // call of classFinder.fillIn will just call ClassReader to read |
| // the .class file, and so we call completeModule here. |
| if (msym.module_info.classfile == null || msym.module_info.classfile.getKind() == Kind.CLASS) { |
| completeModule(msym); |
| } |
| } |
| |
| @Override |
| public String toString() { |
| return "mainCompleter"; |
| } |
| }; |
| |
| private void completeAutomaticModule(ModuleSymbol msym) throws CompletionFailure { |
| try { |
| ListBuffer<Directive> directives = new ListBuffer<>(); |
| ListBuffer<ExportsDirective> exports = new ListBuffer<>(); |
| Set<String> seenPackages = new HashSet<>(); |
| |
| for (JavaFileObject clazz : fileManager.list(msym.classLocation, "", EnumSet.of(Kind.CLASS), true)) { |
| String binName = fileManager.inferBinaryName(msym.classLocation, clazz); |
| String pack = binName.lastIndexOf('.') != (-1) ? binName.substring(0, binName.lastIndexOf('.')) : ""; //unnamed package???? |
| if (seenPackages.add(pack)) { |
| ExportsDirective d = new ExportsDirective(syms.enterPackage(msym, names.fromString(pack)), null); |
| directives.add(d); |
| exports.add(d); |
| } |
| } |
| |
| ListBuffer<RequiresDirective> requires = new ListBuffer<>(); |
| |
| //ensure all modules are found: |
| moduleFinder.findAllModules(); |
| |
| for (ModuleSymbol ms : allModules()) { |
| if (ms == syms.unnamedModule || ms == msym) |
| continue; |
| RequiresDirective d = new RequiresDirective(ms, EnumSet.of(RequiresFlag.PUBLIC)); |
| directives.add(d); |
| requires.add(d); |
| } |
| |
| RequiresDirective requiresUnnamed = new RequiresDirective(syms.unnamedModule); |
| directives.add(requiresUnnamed); |
| requires.add(requiresUnnamed); |
| |
| msym.exports = exports.toList(); |
| msym.provides = List.nil(); |
| msym.requires = requires.toList(); |
| msym.uses = List.nil(); |
| msym.directives = directives.toList(); |
| msym.flags_field |= Flags.ACYCLIC; |
| } catch (IOException ex) { |
| throw new IllegalStateException(ex); |
| } |
| } |
| |
| private Completer getSourceCompleter(JCCompilationUnit tree) { |
| return new Completer() { |
| @Override |
| public void complete(Symbol sym) throws CompletionFailure { |
| ModuleSymbol msym = (ModuleSymbol) sym; |
| msym.flags_field |= UNATTRIBUTED; |
| ModuleVisitor v = new ModuleVisitor(); |
| JavaFileObject prev = log.useSource(tree.sourcefile); |
| try { |
| tree.defs.head.accept(v); |
| completeModule(msym); |
| checkCyclicDependencies((JCModuleDecl) tree.defs.head); |
| } finally { |
| log.useSource(prev); |
| msym.flags_field &= ~UNATTRIBUTED; |
| } |
| } |
| |
| @Override |
| public String toString() { |
| return "SourceCompleter: " + tree.sourcefile.getName(); |
| } |
| |
| }; |
| } |
| |
| class ModuleVisitor extends JCTree.Visitor { |
| private ModuleSymbol sym; |
| private final Set<ModuleSymbol> allRequires = new HashSet<>(); |
| private final Set<PackageSymbol> allExports = new HashSet<>(); |
| |
| @Override |
| public void visitModuleDef(JCModuleDecl tree) { |
| sym = Assert.checkNonNull(tree.sym); |
| |
| sym.requires = List.nil(); |
| sym.exports = List.nil(); |
| tree.directives.forEach(t -> t.accept(this)); |
| sym.requires = sym.requires.reverse(); |
| sym.exports = sym.exports.reverse(); |
| ensureJavaBase(); |
| } |
| |
| @Override |
| public void visitRequires(JCRequires tree) { |
| ModuleSymbol msym = lookupModule(tree.moduleName); |
| if (msym.kind != MDL) { |
| log.error(tree.moduleName.pos(), Errors.ModuleNotFound(msym)); |
| } else if (allRequires.contains(msym)) { |
| log.error(tree.moduleName.pos(), Errors.DuplicateRequires(msym)); |
| } else { |
| allRequires.add(msym); |
| Set<RequiresFlag> flags = EnumSet.noneOf(RequiresFlag.class); |
| if (tree.isPublic) |
| flags.add(RequiresFlag.PUBLIC); |
| RequiresDirective d = new RequiresDirective(msym, flags); |
| tree.directive = d; |
| sym.requires = sym.requires.prepend(d); |
| } |
| } |
| |
| @Override |
| public void visitExports(JCExports tree) { |
| Name name = TreeInfo.fullName(tree.qualid); |
| PackageSymbol packge = syms.enterPackage(sym, name); |
| attr.setPackageSymbols(tree.qualid, packge); |
| if (!allExports.add(packge)) { |
| log.error(tree.qualid.pos(), Errors.DuplicateExports(packge)); |
| } |
| |
| List<ModuleSymbol> toModules = null; |
| if (tree.moduleNames != null) { |
| Set<ModuleSymbol> to = new HashSet<>(); |
| for (JCExpression n: tree.moduleNames) { |
| ModuleSymbol msym = lookupModule(n); |
| if (msym.kind != MDL) { |
| log.error(n.pos(), Errors.ModuleNotFound(msym)); |
| } else if (!to.add(msym)) { |
| log.error(n.pos(), Errors.DuplicateExports(msym)); |
| } |
| } |
| toModules = List.from(to); |
| } |
| |
| if (toModules == null || !toModules.isEmpty()) { |
| ExportsDirective d = new ExportsDirective(packge, toModules); |
| tree.directive = d; |
| sym.exports = sym.exports.prepend(d); |
| } |
| } |
| |
| @Override |
| public void visitProvides(JCProvides tree) { } |
| |
| @Override |
| public void visitUses(JCUses tree) { } |
| |
| private void ensureJavaBase() { |
| if (sym.name == names.java_base) |
| return; |
| |
| for (RequiresDirective d: sym.requires) { |
| if (d.module.name == names.java_base) |
| return; |
| } |
| |
| ModuleSymbol java_base = syms.enterModule(names.java_base); |
| Directive.RequiresDirective d = |
| new Directive.RequiresDirective(java_base, |
| EnumSet.of(Directive.RequiresFlag.MANDATED)); |
| sym.requires = sym.requires.prepend(d); |
| } |
| |
| private ModuleSymbol lookupModule(JCExpression moduleName) { |
| try { |
| Name name = TreeInfo.fullName(moduleName); |
| ModuleSymbol msym = moduleFinder.findModule(name); |
| TreeInfo.setSymbol(moduleName, msym); |
| return msym; |
| } catch (Throwable t) { |
| System.err.println("Module " + sym + "; lookup export " + moduleName); |
| throw t; |
| } |
| } |
| } |
| |
| public Completer getUsesProvidesCompleter() { |
| return sym -> { |
| ModuleSymbol msym = (ModuleSymbol) sym; |
| Env<AttrContext> env = typeEnvs.get(msym); |
| UsesProvidesVisitor v = new UsesProvidesVisitor(msym, env); |
| JavaFileObject prev = log.useSource(env.toplevel.sourcefile); |
| try { |
| env.toplevel.defs.head.accept(v); |
| } finally { |
| log.useSource(prev); |
| } |
| }; |
| } |
| |
| class UsesProvidesVisitor extends JCTree.Visitor { |
| private final ModuleSymbol msym; |
| private final Env<AttrContext> env; |
| |
| private final Set<Directive.UsesDirective> allUses = new HashSet<>(); |
| private final Set<Directive.ProvidesDirective> allProvides = new HashSet<>(); |
| |
| public UsesProvidesVisitor(ModuleSymbol msym, Env<AttrContext> env) { |
| this.msym = msym; |
| this.env = env; |
| } |
| |
| @Override @SuppressWarnings("unchecked") |
| public void visitModuleDef(JCModuleDecl tree) { |
| msym.directives = List.nil(); |
| msym.provides = List.nil(); |
| msym.uses = List.nil(); |
| tree.directives.forEach(t -> t.accept(this)); |
| msym.directives = msym.directives.reverse(); |
| msym.provides = msym.provides.reverse(); |
| msym.uses = msym.uses.reverse(); |
| |
| if (msym.requires.nonEmpty() && msym.requires.head.flags.contains(RequiresFlag.MANDATED)) |
| msym.directives = msym.directives.prepend(msym.requires.head); |
| |
| msym.directives = msym.directives.appendList(List.from(addReads.getOrDefault(msym, Collections.emptySet()))); |
| |
| checkForCorrectness(); |
| } |
| |
| @Override |
| public void visitExports(JCExports tree) { |
| if (tree.directive.packge.members().isEmpty()) { |
| log.error(tree.qualid.pos(), Errors.PackageEmptyOrNotFound(tree.directive.packge)); |
| } |
| msym.directives = msym.directives.prepend(tree.directive); |
| } |
| |
| MethodSymbol noArgsConstructor(ClassSymbol tsym) { |
| for (Symbol sym : tsym.members().getSymbolsByName(names.init)) { |
| MethodSymbol mSym = (MethodSymbol)sym; |
| if (mSym.params().isEmpty()) { |
| return mSym; |
| } |
| } |
| return null; |
| } |
| |
| Map<Directive.ProvidesDirective, JCProvides> directiveToTreeMap = new HashMap<>(); |
| |
| @Override |
| public void visitProvides(JCProvides tree) { |
| Type st = attr.attribType(tree.serviceName, env, syms.objectType); |
| Type it = attr.attribType(tree.implName, env, st); |
| ClassSymbol service = (ClassSymbol) st.tsym; |
| ClassSymbol impl = (ClassSymbol) it.tsym; |
| if ((impl.flags() & ABSTRACT) != 0) { |
| log.error(tree.implName.pos(), Errors.ServiceImplementationIsAbstract(impl)); |
| } else if (impl.isInner()) { |
| log.error(tree.implName.pos(), Errors.ServiceImplementationIsInner(impl)); |
| } else if (service.isInner()) { |
| log.error(tree.serviceName.pos(), Errors.ServiceDefinitionIsInner(service)); |
| } else { |
| MethodSymbol constr = noArgsConstructor(impl); |
| if (constr == null) { |
| log.error(tree.implName.pos(), Errors.ServiceImplementationDoesntHaveANoArgsConstructor(impl)); |
| } else if ((constr.flags() & PUBLIC) == 0) { |
| log.error(tree.implName.pos(), Errors.ServiceImplementationNoArgsConstructorNotPublic(impl)); |
| } |
| } |
| if (st.hasTag(CLASS) && it.hasTag(CLASS)) { |
| Directive.ProvidesDirective d = new Directive.ProvidesDirective(service, impl); |
| if (!allProvides.add(d)) { |
| log.error(tree.pos(), Errors.DuplicateProvides(service, impl)); |
| } |
| msym.provides = msym.provides.prepend(d); |
| msym.directives = msym.directives.prepend(d); |
| directiveToTreeMap.put(d, tree); |
| } |
| } |
| |
| @Override |
| public void visitRequires(JCRequires tree) { |
| msym.directives = msym.directives.prepend(tree.directive); |
| } |
| |
| @Override |
| public void visitUses(JCUses tree) { |
| Type st = attr.attribType(tree.qualid, env, syms.objectType); |
| if (st.hasTag(CLASS)) { |
| ClassSymbol service = (ClassSymbol) st.tsym; |
| Directive.UsesDirective d = new Directive.UsesDirective(service); |
| if (!allUses.add(d)) { |
| log.error(tree.pos(), Errors.DuplicateUses(service)); |
| } |
| msym.uses = msym.uses.prepend(d); |
| msym.directives = msym.directives.prepend(d); |
| } |
| } |
| |
| private void checkForCorrectness() { |
| for (Directive.ProvidesDirective provides : allProvides) { |
| JCProvides tree = directiveToTreeMap.get(provides); |
| /** The implementation must be defined in the same module as the provides directive |
| * (else, error) |
| */ |
| PackageSymbol implementationDefiningPackage = provides.impl.packge(); |
| if (implementationDefiningPackage.modle != msym) { |
| log.error(tree.pos(), Errors.ServiceImplementationNotInRightModule(implementationDefiningPackage.modle)); |
| } |
| |
| /** There is no inherent requirement that module that provides a service should actually |
| * use it itself. However, it is a pointless declaration if the service package is not |
| * exported and there is no uses for the service. |
| */ |
| PackageSymbol interfaceDeclaringPackage = provides.service.packge(); |
| boolean isInterfaceDeclaredInCurrentModule = interfaceDeclaringPackage.modle == msym; |
| boolean isInterfaceExportedFromAReadableModule = |
| msym.visiblePackages.get(interfaceDeclaringPackage.fullname) == interfaceDeclaringPackage; |
| if (isInterfaceDeclaredInCurrentModule && !isInterfaceExportedFromAReadableModule) { |
| // ok the interface is declared in this module. Let's check if it's exported |
| boolean warn = true; |
| for (ExportsDirective export : msym.exports) { |
| if (interfaceDeclaringPackage == export.packge) { |
| warn = false; |
| break; |
| } |
| } |
| if (warn) { |
| for (UsesDirective uses : msym.uses) { |
| if (provides.service == uses.service) { |
| warn = false; |
| break; |
| } |
| } |
| } |
| if (warn) { |
| log.warning(tree.pos(), Warnings.ServiceProvidedButNotExportedOrUsed(provides.service)); |
| } |
| } |
| } |
| } |
| } |
| |
| private Set<ModuleSymbol> allModulesCache; |
| |
| private Set<ModuleSymbol> allModules() { |
| if (allModulesCache != null) |
| return allModulesCache; |
| |
| Set<ModuleSymbol> observable; |
| |
| if (limitModsOpt == null) { |
| observable = null; |
| } else { |
| Set<ModuleSymbol> limitMods = new HashSet<>(); |
| for (String limit : limitModsOpt.split(",")) { |
| limitMods.add(syms.enterModule(names.fromString(limit))); |
| } |
| observable = computeTransitiveClosure(limitMods, null); |
| observable.addAll(rootModules); |
| } |
| |
| Predicate<ModuleSymbol> observablePred = sym -> observable == null || observable.contains(sym); |
| Predicate<ModuleSymbol> systemModulePred = sym -> (sym.flags() & Flags.SYSTEM_MODULE) != 0; |
| Set<ModuleSymbol> enabledRoot = new LinkedHashSet<>(); |
| |
| if (rootModules.contains(syms.unnamedModule)) { |
| for (ModuleSymbol sym : syms.getAllModules()) { |
| if (systemModulePred.test(sym) && observablePred.test(sym)) { |
| enabledRoot.add(sym); |
| } |
| } |
| } |
| |
| enabledRoot.addAll(rootModules); |
| |
| if (addModsOpt != null) { |
| for (String added : addModsOpt.split(",")) { |
| Stream<ModuleSymbol> modules; |
| switch (added) { |
| case ALL_SYSTEM: |
| modules = syms.getAllModules() |
| .stream() |
| .filter(systemModulePred.and(observablePred)); |
| break; |
| case ALL_MODULE_PATH: |
| modules = syms.getAllModules() |
| .stream() |
| .filter(systemModulePred.negate().and(observablePred)); |
| break; |
| default: |
| modules = Stream.of(syms.enterModule(names.fromString(added))); |
| break; |
| } |
| modules.forEach(sym -> { |
| enabledRoot.add(sym); |
| if (observable != null) |
| observable.add(sym); |
| }); |
| } |
| } |
| |
| Set<ModuleSymbol> result = computeTransitiveClosure(enabledRoot, observable); |
| |
| result.add(syms.unnamedModule); |
| |
| if (!rootModules.isEmpty()) |
| allModulesCache = result; |
| |
| return result; |
| } |
| |
| public void enableAllModules() { |
| allModulesCache = new HashSet<>(); |
| |
| moduleFinder.findAllModules(); |
| |
| for (ModuleSymbol msym : syms.getAllModules()) { |
| allModulesCache.add(msym); |
| } |
| } |
| |
| private Set<ModuleSymbol> computeTransitiveClosure(Iterable<? extends ModuleSymbol> base, Set<ModuleSymbol> observable) { |
| List<ModuleSymbol> todo = List.nil(); |
| |
| for (ModuleSymbol ms : base) { |
| todo = todo.prepend(ms); |
| } |
| |
| Set<ModuleSymbol> result = new LinkedHashSet<>(); |
| result.add(syms.java_base); |
| |
| while (todo.nonEmpty()) { |
| ModuleSymbol current = todo.head; |
| todo = todo.tail; |
| if (observable != null && !observable.contains(current)) |
| continue; |
| if (!result.add(current) || current == syms.unnamedModule || ((current.flags_field & Flags.AUTOMATIC_MODULE) != 0)) |
| continue; |
| current.complete(); |
| for (RequiresDirective rd : current.requires) { |
| todo = todo.prepend(rd.module); |
| } |
| } |
| |
| return result; |
| } |
| |
| public ModuleSymbol getObservableModule(Name name) { |
| ModuleSymbol mod = syms.getModule(name); |
| |
| if (allModules().contains(mod)) { |
| return mod; |
| } |
| |
| return null; |
| } |
| |
| private Completer getUnnamedModuleCompleter() { |
| moduleFinder.findAllModules(); |
| return new Symbol.Completer() { |
| @Override |
| public void complete(Symbol sym) throws CompletionFailure { |
| ModuleSymbol msym = (ModuleSymbol) sym; |
| Set<ModuleSymbol> allModules = allModules(); |
| for (ModuleSymbol m : allModules) { |
| m.complete(); |
| } |
| initVisiblePackages(msym, allModules); |
| } |
| |
| @Override |
| public String toString() { |
| return "unnamedModule Completer"; |
| } |
| }; |
| } |
| |
| private final Map<ModuleSymbol, Set<ModuleSymbol>> requiresPublicCache = new HashMap<>(); |
| |
| private void completeModule(ModuleSymbol msym) { |
| Assert.checkNonNull(msym.requires); |
| |
| initAddReads(); |
| |
| msym.requires = msym.requires.appendList(List.from(addReads.getOrDefault(msym, Collections.emptySet()))); |
| |
| List<RequiresDirective> requires = msym.requires; |
| List<RequiresDirective> previous = null; |
| |
| while (requires.nonEmpty()) { |
| if (!allModules().contains(requires.head.module)) { |
| Env<AttrContext> env = typeEnvs.get(msym); |
| if (env != null) { |
| JavaFileObject origSource = log.useSource(env.toplevel.sourcefile); |
| try { |
| log.error(/*XXX*/env.tree, Errors.ModuleNotFound(requires.head.module)); |
| } finally { |
| log.useSource(origSource); |
| } |
| } else { |
| Assert.check((msym.flags() & Flags.AUTOMATIC_MODULE) == 0); |
| } |
| if (previous != null) { |
| previous.tail = requires.tail; |
| } else { |
| msym.requires.tail = requires.tail; |
| } |
| } else { |
| previous = requires; |
| } |
| requires = requires.tail; |
| } |
| |
| Set<ModuleSymbol> readable = new LinkedHashSet<>(); |
| Set<ModuleSymbol> requiresPublic = new HashSet<>(); |
| if ((msym.flags() & Flags.AUTOMATIC_MODULE) == 0) { |
| for (RequiresDirective d : msym.requires) { |
| d.module.complete(); |
| readable.add(d.module); |
| Set<ModuleSymbol> s = retrieveRequiresPublic(d.module); |
| Assert.checkNonNull(s, () -> "no entry in cache for " + d.module); |
| readable.addAll(s); |
| if (d.flags.contains(RequiresFlag.PUBLIC)) { |
| requiresPublic.add(d.module); |
| requiresPublic.addAll(s); |
| } |
| } |
| } else { |
| //the module graph may contain cycles involving automatic modules |
| //handle automatic modules separatelly: |
| Set<ModuleSymbol> s = retrieveRequiresPublic(msym); |
| |
| readable.addAll(s); |
| requiresPublic.addAll(s); |
| |
| //ensure the unnamed module is added (it is not requires public): |
| readable.add(syms.unnamedModule); |
| } |
| requiresPublicCache.put(msym, requiresPublic); |
| initVisiblePackages(msym, readable); |
| for (ExportsDirective d: msym.exports) { |
| d.packge.modle = msym; |
| } |
| |
| } |
| |
| private Set<ModuleSymbol> retrieveRequiresPublic(ModuleSymbol msym) { |
| Set<ModuleSymbol> requiresPublic = requiresPublicCache.get(msym); |
| |
| if (requiresPublic == null) { |
| //the module graph may contain cycles involving automatic modules or -XaddReads edges |
| requiresPublic = new HashSet<>(); |
| |
| Set<ModuleSymbol> seen = new HashSet<>(); |
| List<ModuleSymbol> todo = List.of(msym); |
| |
| while (todo.nonEmpty()) { |
| ModuleSymbol current = todo.head; |
| todo = todo.tail; |
| if (!seen.add(current)) |
| continue; |
| requiresPublic.add(current); |
| current.complete(); |
| Iterable<? extends RequiresDirective> requires; |
| if (current != syms.unnamedModule) { |
| Assert.checkNonNull(current.requires, () -> current + ".requires == null; " + msym); |
| requires = current.requires; |
| for (RequiresDirective rd : requires) { |
| if (rd.isPublic()) |
| todo = todo.prepend(rd.module); |
| } |
| } else { |
| for (ModuleSymbol mod : allModules()) { |
| todo = todo.prepend(mod); |
| } |
| } |
| } |
| |
| requiresPublic.remove(msym); |
| } |
| |
| return requiresPublic; |
| } |
| |
| private void initVisiblePackages(ModuleSymbol msym, Collection<ModuleSymbol> readable) { |
| initAddExports(); |
| |
| msym.visiblePackages = new LinkedHashMap<>(); |
| |
| Map<Name, ModuleSymbol> seen = new HashMap<>(); |
| |
| for (ModuleSymbol rm : readable) { |
| if (rm == syms.unnamedModule) |
| continue; |
| addVisiblePackages(msym, seen, rm, rm.exports); |
| } |
| |
| for (Entry<ModuleSymbol, Set<ExportsDirective>> addExportsEntry : addExports.entrySet()) |
| addVisiblePackages(msym, seen, addExportsEntry.getKey(), addExportsEntry.getValue()); |
| } |
| |
| private void addVisiblePackages(ModuleSymbol msym, |
| Map<Name, ModuleSymbol> seenPackages, |
| ModuleSymbol exportsFrom, |
| Collection<ExportsDirective> exports) { |
| for (ExportsDirective d : exports) { |
| if (d.modules == null || d.modules.contains(msym)) { |
| Name packageName = d.packge.fullname; |
| ModuleSymbol previousModule = seenPackages.get(packageName); |
| |
| if (previousModule != null && previousModule != exportsFrom) { |
| Env<AttrContext> env = typeEnvs.get(msym); |
| JavaFileObject origSource = env != null ? log.useSource(env.toplevel.sourcefile) |
| : null; |
| DiagnosticPosition pos = env != null ? env.tree.pos() : null; |
| try { |
| log.error(pos, Errors.PackageClashFromRequires(msym, packageName, |
| previousModule, exportsFrom)); |
| } finally { |
| if (env != null) |
| log.useSource(origSource); |
| } |
| continue; |
| } |
| |
| seenPackages.put(packageName, exportsFrom); |
| msym.visiblePackages.put(d.packge.fullname, d.packge); |
| } |
| } |
| } |
| |
| private void initAddExports() { |
| if (addExports != null) |
| return; |
| |
| addExports = new LinkedHashMap<>(); |
| |
| if (addExportsOpt == null) |
| return; |
| |
| // System.err.println("Modules.addExports:\n " + addExportsOpt.replace("\0", "\n ")); |
| |
| Pattern ep = Pattern.compile("([^/]+)/([^=]+)=(.*)"); |
| for (String s: addExportsOpt.split("\0+")) { |
| if (s.isEmpty()) |
| continue; |
| Matcher em = ep.matcher(s); |
| if (!em.matches()) { |
| continue; |
| } |
| |
| // Terminology comes from |
| // -XaddExports:module/package=target,... |
| // Compare to |
| // module module { exports package to target, ... } |
| String moduleName = em.group(1); |
| String packageName = em.group(2); |
| String targetNames = em.group(3); |
| |
| ModuleSymbol msym = syms.enterModule(names.fromString(moduleName)); |
| PackageSymbol p = syms.enterPackage(msym, names.fromString(packageName)); |
| p.modle = msym; // TODO: do we need this? |
| |
| List<ModuleSymbol> targetModules = List.nil(); |
| for (String toModule : targetNames.split("[ ,]+")) { |
| ModuleSymbol m; |
| if (toModule.equals("ALL-UNNAMED")) { |
| m = syms.unnamedModule; |
| } else { |
| if (!SourceVersion.isName(toModule)) { |
| // TODO: error: invalid module name |
| continue; |
| } |
| m = syms.enterModule(names.fromString(toModule)); |
| } |
| targetModules = targetModules.prepend(m); |
| } |
| |
| Set<ExportsDirective> extra = addExports.computeIfAbsent(msym, _x -> new LinkedHashSet<>()); |
| ExportsDirective d = new ExportsDirective(p, targetModules); |
| extra.add(d); |
| } |
| } |
| |
| private void initAddReads() { |
| if (addReads != null) |
| return; |
| |
| addReads = new LinkedHashMap<>(); |
| |
| if (addReadsOpt == null) |
| return; |
| |
| // System.err.println("Modules.addReads:\n " + addReadsOpt.replace("\0", "\n ")); |
| |
| Pattern rp = Pattern.compile("([^=]+)=(.*)"); |
| for (String s : addReadsOpt.split("\0+")) { |
| if (s.isEmpty()) |
| continue; |
| Matcher rm = rp.matcher(s); |
| if (!rm.matches()) { |
| continue; |
| } |
| |
| // Terminology comes from |
| // -XaddReads:target-module=source-module,... |
| // Compare to |
| // module target-module { requires source-module; ... } |
| String targetName = rm.group(1); |
| String sources = rm.group(2); |
| |
| ModuleSymbol msym = syms.enterModule(names.fromString(targetName)); |
| for (String source : sources.split("[ ,]+")) { |
| ModuleSymbol sourceModule; |
| if (source.equals("ALL-UNNAMED")) { |
| sourceModule = syms.unnamedModule; |
| } else { |
| if (!SourceVersion.isName(source)) { |
| // TODO: error: invalid module name |
| continue; |
| } |
| sourceModule = syms.enterModule(names.fromString(source)); |
| } |
| addReads.computeIfAbsent(msym, m -> new HashSet<>()) |
| .add(new RequiresDirective(sourceModule, EnumSet.of(RequiresFlag.EXTRA))); |
| } |
| } |
| } |
| |
| private void checkCyclicDependencies(JCModuleDecl mod) { |
| for (JCDirective d : mod.directives) { |
| if (!d.hasTag(Tag.REQUIRES)) |
| continue; |
| JCRequires rd = (JCRequires) d; |
| Set<ModuleSymbol> nonSyntheticDeps = new HashSet<>(); |
| List<ModuleSymbol> queue = List.of(rd.directive.module); |
| while (queue.nonEmpty()) { |
| ModuleSymbol current = queue.head; |
| queue = queue.tail; |
| if (!nonSyntheticDeps.add(current)) |
| continue; |
| if ((current.flags() & Flags.ACYCLIC) != 0) |
| continue; |
| current.complete(); |
| Assert.checkNonNull(current.requires, () -> current.toString()); |
| for (RequiresDirective dep : current.requires) { |
| if (!dep.flags.contains(RequiresFlag.EXTRA)) |
| queue = queue.prepend(dep.module); |
| } |
| } |
| if (nonSyntheticDeps.contains(mod.sym)) { |
| log.error(rd.moduleName.pos(), Errors.CyclicRequires(rd.directive.module)); |
| } |
| mod.sym.flags_field |= Flags.ACYCLIC; |
| } |
| } |
| |
| // DEBUG |
| private String toString(ModuleSymbol msym) { |
| return msym.name + "[" |
| + "kind:" + msym.kind + ";" |
| + "locn:" + toString(msym.sourceLocation) + "," + toString(msym.classLocation) + ";" |
| + "info:" + toString(msym.module_info.sourcefile) + "," |
| + toString(msym.module_info.classfile) + "," |
| + msym.module_info.completer |
| + "]"; |
| } |
| |
| // DEBUG |
| String toString(Location locn) { |
| return (locn == null) ? "--" : locn.getName(); |
| } |
| |
| // DEBUG |
| String toString(JavaFileObject fo) { |
| return (fo == null) ? "--" : fo.getName(); |
| } |
| |
| public void newRound() { |
| } |
| } |
