org.codehaus.groovy.ast.CompileUnit Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
package org.codehaus.groovy.ast;
import groovy.lang.GroovyClassLoader;
import org.codehaus.groovy.control.CompilerConfiguration;
import org.codehaus.groovy.control.SourceUnit;
import org.codehaus.groovy.syntax.SyntaxException;
import java.security.CodeSource;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
/**
* Represents the entire contents of a compilation step which consists of one or
* more {@link ModuleNode} instances. There's one instance of this that's shared
* by all modules and classes compiled during a single invocation of the compiler.
*
* It's attached to MethodNodes and ClassNodes and is used to find fully qualified
* names of classes, resolve imports, and that sort of thing.
*/
public class CompileUnit implements NodeMetaDataHandler {
private final CompilerConfiguration config;
private final GroovyClassLoader loader;
private final CodeSource codeSource;
private Map metaDataMap;
private final List modules = new ArrayList<>();
private final Map classes = new LinkedHashMap<>();
private final Map classesToCompile = new LinkedHashMap<>();
private final Map classNameToSource = new LinkedHashMap<>();
private final Map generatedInnerClasses = new LinkedHashMap<>();
public CompileUnit(final GroovyClassLoader classLoader, final CompilerConfiguration config) {
this(classLoader, null, config);
}
public CompileUnit(final GroovyClassLoader classLoader, final CodeSource codeSource, final CompilerConfiguration config) {
this.loader = classLoader;
this.codeSource = codeSource;
this.config = config;
}
public CompilerConfiguration getConfig() {
return config;
}
public GroovyClassLoader getClassLoader() {
return loader;
}
public CodeSource getCodeSource() {
return codeSource;
}
@Override
public Map getMetaDataMap() {
return metaDataMap;
}
@Override
public void setMetaDataMap(final Map metaDataMap) {
this.metaDataMap = metaDataMap;
}
public List getModules() {
return modules;
}
/**
* @return a list of all the classes in each module in the compilation unit
*/
public List getClasses() {
List answer = new ArrayList<>();
for (ModuleNode module : modules) {
answer.addAll(module.getClasses());
}
return answer;
}
/**
* @return the ClassNode for the given qualified name or returns null if
* the name does not exist in the current compilation unit
* (ignoring the .class files on the classpath)
*/
public ClassNode getClass(final String name) {
ClassNode cn = classes.get(name);
if (cn == null)
cn = classesToCompile.get(name);
return cn;
}
public Map getClassesToCompile() {
return classesToCompile;
}
public SourceUnit getScriptSourceLocation(final String className) {
return classNameToSource.get(className);
}
public Map getGeneratedInnerClasses() {
return Collections.unmodifiableMap(generatedInnerClasses);
}
public InnerClassNode getGeneratedInnerClass(final String name) {
return generatedInnerClasses.get(name);
}
//--------------------------------------------------------------------------
@Deprecated
public boolean hasClassNodeToCompile() {
return !classesToCompile.isEmpty();
}
@Deprecated
public Iterator iterateClassNodeToCompile() {
return classesToCompile.keySet().iterator();
}
//--------------------------------------------------------------------------
public void addModule(final ModuleNode node) {
// null means a compilation error prevented groovy from building an AST
if (node != null) {
modules.add(node);
node.setUnit(this);
addClasses(node.getClasses());
}
}
/**
* Appends all of the fully-qualified class names in this
* module into the given map.
*/
public void addClasses(final List list) {
for (ClassNode node : list) {
addClass(node);
}
}
/**
* Adds a class to the unit.
*/
public void addClass(ClassNode node) {
node = node.redirect();
String name = node.getName();
ClassNode stored = classes.get(name);
if (stored != null && stored != node) {
// we have a duplicate class!
// One possibility for this is, that we declared a script and a
// class in the same file and named the class like the file
SourceUnit nodeSource = node.getModule().getContext();
SourceUnit storedSource = stored.getModule().getContext();
String txt = "Invalid duplicate class definition of class " + node.getName() + " : ";
if (nodeSource == storedSource) {
// same class in same source
txt += "The source " + nodeSource.getName() + " contains at least two definitions of the class " + node.getName() + ".\n";
if (node.isScriptBody() || stored.isScriptBody()) {
txt += "One of the classes is an explicit generated class using the class statement, the other is a class generated from" +
" the script body based on the file name. Solutions are to change the file name or to change the class name.\n";
}
} else {
txt += "The sources " + nodeSource.getName() + " and " + storedSource.getName() + " each contain a class with the name " + node.getName() + ".\n";
}
nodeSource.addErrorAndContinue(new SyntaxException(txt, node));
}
classes.put(name, node);
ClassNode cn = classesToCompile.remove(name);
if (cn != null) cn.setRedirect(node);
}
/**
* this method actually does not compile a class. It's only
* a marker that this type has to be compiled by the CompilationUnit
* at the end of a parse step no node should be left.
*/
public void addClassNodeToCompile(final ClassNode node, final SourceUnit location) {
String nodeName = node.getName();
classesToCompile.put(nodeName, node);
classNameToSource.put(nodeName, location);
}
public void addGeneratedInnerClass(final InnerClassNode icn) {
generatedInnerClasses.put(icn.getName(), icn);
}
}