org.apache.royale.compiler.internal.projects.RoyaleJSProject 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.apache.royale.compiler.internal.projects;
import java.io.File;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import org.apache.royale.compiler.asdoc.IASDocComment;
import org.apache.royale.compiler.asdoc.royale.ASDocComment;
import org.apache.royale.compiler.clients.JSConfiguration;
import org.apache.royale.compiler.common.DependencyType;
import org.apache.royale.compiler.common.DependencyTypeSet;
import org.apache.royale.compiler.config.CompilerDiagnosticsConstants;
import org.apache.royale.compiler.config.Configuration;
import org.apache.royale.compiler.config.Configurator;
import org.apache.royale.compiler.css.ICSSMediaQueryCondition;
import org.apache.royale.compiler.css.ICSSRule;
import org.apache.royale.compiler.definitions.IDefinition;
import org.apache.royale.compiler.definitions.IFunctionDefinition;
import org.apache.royale.compiler.definitions.ITypeDefinition;
import org.apache.royale.compiler.definitions.metadata.IMetaTag;
import org.apache.royale.compiler.definitions.metadata.IMetaTagAttribute;
import org.apache.royale.compiler.definitions.references.IResolvedQualifiersReference;
import org.apache.royale.compiler.definitions.references.ReferenceFactory;
import org.apache.royale.compiler.driver.IBackend;
import org.apache.royale.compiler.internal.codegen.js.royale.JSRoyaleEmitterTokens;
import org.apache.royale.compiler.internal.codegen.mxml.royale.MXMLRoyaleEmitterTokens;
import org.apache.royale.compiler.internal.common.JSModuleRequireDescription;
import org.apache.royale.compiler.internal.css.codegen.CSSCompilationSession;
import org.apache.royale.compiler.internal.definitions.InterfaceDefinition;
import org.apache.royale.compiler.internal.driver.js.royale.JSCSSCompilationSession;
import org.apache.royale.compiler.internal.driver.js.goog.JSGoogConfiguration;
import org.apache.royale.compiler.internal.mxml.MXMLNamespaceMapping;
import org.apache.royale.compiler.internal.scopes.ASProjectScope.DefinitionPromise;
import org.apache.royale.compiler.internal.targets.ITargetAttributes;
import org.apache.royale.compiler.internal.targets.LinkageChecker;
import org.apache.royale.compiler.internal.tree.mxml.MXMLDocumentNode;
import org.apache.royale.compiler.internal.tree.mxml.MXMLFileNode;
import org.apache.royale.compiler.internal.units.SWCCompilationUnit;
import org.apache.royale.compiler.internal.workspaces.Workspace;
import org.apache.royale.compiler.targets.ITargetSettings;
import org.apache.royale.compiler.tree.as.IASNode;
import org.apache.royale.compiler.tree.as.IClassNode;
import org.apache.royale.compiler.tree.as.IDefinitionNode;
import org.apache.royale.compiler.tree.as.IDocumentableDefinitionNode;
import org.apache.royale.compiler.tree.as.IInterfaceNode;
import org.apache.royale.compiler.units.ICompilationUnit;
import org.apache.royale.compiler.units.ICompilationUnit.UnitType;
import org.apache.royale.swc.ISWC;
import com.google.common.collect.ImmutableList;
/**
* @author aharui
*
*/
public class RoyaleJSProject extends RoyaleProject
{
/**
* Constructor
*
* @param workspace The {@code Workspace} containing this project.
*/
public RoyaleJSProject(Workspace workspace, IBackend backend)
{
super(workspace);
this.backend = backend;
}
private HashMap> interfaces = new HashMap>();
private HashMap> requires = new HashMap>();
private HashMap> jsModules = new HashMap>();
public TreeSet mixinClassNames;
public HashMap remoteClassAliasMap;
public JSGoogConfiguration config;
public Configurator configurator;
private IBackend backend;
public ICompilationUnit mainCU;
@Override
public void addDependency(ICompilationUnit from, ICompilationUnit to, DependencyTypeSet dt, String qname)
{
if (to.getCompilationUnitType() == UnitType.SWC_UNIT)
{
List dp = to.getDefinitionPromises();
if(dp.size() > 0)
{
if (!isGoogProvided(dp.get(0).getQualifiedName()))
{
SWCCompilationUnit swcUnit = (SWCCompilationUnit) to;
swcExterns.add(swcUnit.getSWC());
}
}
}
super.addDependency(from, to, dt, qname);
}
@Override
public void addDependency(ICompilationUnit from, ICompilationUnit to,
DependencyType dt, String qname)
{
List dp = to.getDefinitionPromises();
if (dp.size() == 0)
return;
IDefinition def = dp.get(0);
IDefinition actualDef = ((DefinitionPromise) def).getActualDefinition();
if (to.getCompilationUnitType() == UnitType.AS_UNIT)
{
IDefinitionNode defNode = actualDef != null ? actualDef.getNode() : null;
if (defNode instanceof IClassNode || defNode instanceof IInterfaceNode)
{
String defname = def.getQualifiedName();
IASDocComment asDoc = (defNode instanceof IClassNode) ?
(IASDocComment) ((IClassNode)defNode).getASDocComment() :
(IASDocComment) ((IInterfaceNode)defNode).getASDocComment();
if (asDoc != null && (asDoc instanceof ASDocComment))
{
String asDocString = ((ASDocComment)asDoc).commentNoEnd();
if (asDocString.contains(JSRoyaleEmitterTokens.EXTERNS.getToken()))
{
if (!sourceExterns.contains(defname))
sourceExterns.add(defname);
}
}
}
}
if (to.getCompilationUnitType() == UnitType.SWC_UNIT)
{
if (!isGoogProvided(def.getQualifiedName()))
{
SWCCompilationUnit swcUnit = (SWCCompilationUnit) to;
swcExterns.add(swcUnit.getSWC());
}
}
boolean isInterface = (actualDef instanceof InterfaceDefinition) && (dt == DependencyType.INHERITANCE);
if (!isInterface)
{
if (from != to)
{
if ((CompilerDiagnosticsConstants.diagnostics & CompilerDiagnosticsConstants.ROYALEJSPROJECT) == CompilerDiagnosticsConstants.ROYALEJSPROJECT)
System.out.println("RoyaleJSProject waiting for lock in updateRequiresMap from addDependency");
updateRequiresMap(from, to, dt, qname);
if ((CompilerDiagnosticsConstants.diagnostics & CompilerDiagnosticsConstants.ROYALEJSPROJECT) == CompilerDiagnosticsConstants.ROYALEJSPROJECT)
System.out.println("RoyaleJSProject done with lock in updateRequiresMap from addDependency");
if ((CompilerDiagnosticsConstants.diagnostics & CompilerDiagnosticsConstants.ROYALEJSPROJECT) == CompilerDiagnosticsConstants.ROYALEJSPROJECT)
System.out.println("RoyaleJSProject waiting for lock in updateJSModulesMap from addDependency");
updateJSModulesMap(from, to, dt, qname);
if ((CompilerDiagnosticsConstants.diagnostics & CompilerDiagnosticsConstants.ROYALEJSPROJECT) == CompilerDiagnosticsConstants.ROYALEJSPROJECT)
System.out.println("RoyaleJSProject done with lock in updateJSModulesMap from addDependency");
}
}
else
{
if (from != to)
{
if ((CompilerDiagnosticsConstants.diagnostics & CompilerDiagnosticsConstants.ROYALEJSPROJECT) == CompilerDiagnosticsConstants.ROYALEJSPROJECT)
System.out.println("RoyaleJSProject waiting for lock in updateInterfacesMap from addDependency");
updateInterfacesMap(from, to, dt, qname);
if ((CompilerDiagnosticsConstants.diagnostics & CompilerDiagnosticsConstants.ROYALEJSPROJECT) == CompilerDiagnosticsConstants.ROYALEJSPROJECT)
System.out.println("RoyaleJSProject done with lock in updateInterfacesMap from addDependency");
}
}
super.addDependency(from, to, dt, qname);
}
private synchronized void updateRequiresMap(ICompilationUnit from, ICompilationUnit to,
DependencyType dt, String qname)
{
HashMap reqs;
if (requires.containsKey(from))
reqs = requires.get(from);
else
{
reqs = new HashMap();
requires.put(from, reqs);
}
if (reqs.containsKey(qname))
{
// inheritance is important so remember it
if (reqs.get(qname) != DependencyType.INHERITANCE)
{
if (isGoogProvided(qname))
{
reqs.put(qname, dt);
}
}
}
else if (isGoogProvided(qname) || qname.equals("Namespace"))
{
if (qname.equals("XML"))
{
needXML = true;
}
reqs.put(qname, dt);
}
}
private synchronized void updateJSModulesMap(ICompilationUnit from, ICompilationUnit to,
DependencyType dt, String qname)
{
HashMap reqs;
if (jsModules.containsKey(from))
{
reqs = jsModules.get(from);
}
else
{
reqs = new HashMap();
jsModules.put(from, reqs);
}
IMetaTag tag = getJSModuleMetadata(to, qname);
if (tag != null)
{
IMetaTagAttribute nameAttribute = tag.getAttribute("name");
String moduleName = null;
if (nameAttribute != null)
{
moduleName = nameAttribute.getValue();
}
if(moduleName == null)
{
int idx = qname.indexOf('.');
if(idx == -1)
{
moduleName = qname;
}
else
{
moduleName = qname.substring(0, idx);
}
}
JSModuleRequireDescription module = new JSModuleRequireDescription(moduleName, qname);
reqs.put(module, dt);
}
}
private synchronized void updateInterfacesMap(ICompilationUnit from, ICompilationUnit to,
DependencyType dt, String qname)
{
HashMap interfacesArr;
if (interfaces.containsKey(from))
{
interfacesArr = interfaces.get(from);
}
else
{
interfacesArr = new HashMap();
interfaces.put(from, interfacesArr);
}
if (!interfacesArr.containsKey(qname))
{
if (isGoogProvided(qname))
{
interfacesArr.put(qname, qname);
}
}
}
public boolean needLanguage;
public boolean needCSS;
public boolean needXML;
private LinkageChecker linkageChecker;
private ITargetSettings ts;
// definitions that had @externs in the source
public ArrayList sourceExterns = new ArrayList();
// swcs that contain referenced externs
public Set swcExterns = new HashSet();
// definitions that should be considered external linkage
public Collection unitTestExterns;
private IMetaTag getJSModuleMetadata(ICompilationUnit cu, String qname)
{
try
{
Iterator iterator = cu.getFileScopeRequest().get().getExternallyVisibleDefinitions().iterator();
while(iterator.hasNext())
{
IDefinition def = iterator.next();
if (def.getQualifiedName().equals(qname) && def.hasMetaTagByName("JSModule"))
{
return def.getMetaTagByName("JSModule");
}
}
}
catch (Exception ex)
{
//it's safe to ignore an exception here
}
return null;
}
public boolean isExterns(String qname)
{
ICompilationUnit cu = resolveQNameToCompilationUnit(qname);
if (cu == null)
{
return false;
}
if (cu.getCompilationUnitType().equals(ICompilationUnit.UnitType.SWC_UNIT))
{
return !isGoogProvided(qname);
}
else if (!cu.getCompilationUnitType().equals(ICompilationUnit.UnitType.AS_UNIT))
{
return false;
}
IDefinition def = resolveQNameToDefinition(qname);
if (def == null)
{
return false;
}
IDefinitionNode node = def.getNode();
if (!(node instanceof IDocumentableDefinitionNode))
{
return false;
}
IDocumentableDefinitionNode docNode = (IDocumentableDefinitionNode) node;
IASDocComment comment = docNode.getASDocComment();
if (!(comment instanceof ASDocComment))
{
return false;
}
ASDocComment royaleComment = (ASDocComment) comment;
return royaleComment.commentNoEnd().contains(JSRoyaleEmitterTokens.EXTERNS.getToken());
}
public boolean isGoogProvided(String qname)
{
ICompilationUnit cu = resolveQNameToCompilationUnit(qname);
if (cu == null)
{
//TODO: maybe this this should be false because we can't actually
//check whether it's a goog.provide() object or not
return true;
}
if (cu.getCompilationUnitType().equals(ICompilationUnit.UnitType.SWC_UNIT))
{
SWCCompilationUnit swcUnit = (SWCCompilationUnit) cu;
ISWC swc = swcUnit.getSWC();
String qnameFilePath = "js/out/" + qname.replace('.', '/') + ".js";
return swc.getFile(qnameFilePath) != null;
}
return !isExterns(qname);
}
public boolean isExternalLinkage(ICompilationUnit cu)
{
if (linkageChecker == null)
{
ts = getTargetSettings();
linkageChecker = new LinkageChecker(this, ts);
}
// in unit tests, ts may be null and LinkageChecker NPEs
if (ts == null)
{
if (unitTestExterns != null)
{
try {
if (!(cu instanceof SWCCompilationUnit))
if (unitTestExterns.contains(cu.getQualifiedNames().get(0)))
return true;
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
return false;
}
List qnames;
try {
qnames = cu.getQualifiedNames();
String qname = qnames.get(0);
// if compiling against airglobal/playerglobal, we have to keep QName, XML, XMLList from being seens
// as external otherwise theJS implementations won't get added to the output. But if the definitions
// come from XML.SWC assume the linkage is right in case these files get excluded from modules
if ((cu.getAbsoluteFilename().contains("airglobal") || cu.getAbsoluteFilename().contains("playerglobal")) &&
(qname.equals("QName") || qname.equals("XML") || qname.equals("XMLList")))
return false;
} catch (InterruptedException e1) {
// TODO Auto-generated catch block
e1.printStackTrace();
}
try
{
return linkageChecker.isExternal(cu);
}
catch (InterruptedException e)
{
// TODO Auto-generated catch block
e.printStackTrace();
}
return false;
}
public ArrayList getInterfaces(ICompilationUnit from)
{
if (interfaces.containsKey(from))
{
HashMap map = interfaces.get(from);
ArrayList arr = new ArrayList();
Set cus = map.keySet();
for (String s : cus)
arr.add(s);
return arr;
}
return null;
}
public ArrayList getRequires(ICompilationUnit from)
{
if (requires.containsKey(from))
{
HashMap map = requires.get(from);
ArrayList arr = new ArrayList();
Set cus = map.keySet();
for (String s : cus)
arr.add(s);
return arr;
}
return null;
}
public ArrayList getExternalRequires(ICompilationUnit from)
{
if (jsModules.containsKey(from))
{
HashMap map = jsModules.get(from);
ArrayList arr = new ArrayList();
for (JSModuleRequireDescription m : map.keySet())
{
arr.add(m);
}
return arr;
}
return null;
}
JSCSSCompilationSession cssSession = new JSCSSCompilationSession();
@Override
public CSSCompilationSession getCSSCompilationSession()
{
// When building SWFs, each MXML document may have its own styles
// specified by fx:Style blocks. The CSS is separately compiled and
// stored in the class definition for the MXML document. That helps
// with deferred loading of classes. The styles and thus the
// classes for an MXML document are not initialized until the MXML
// class is initialized.
// For JS compilation, the CSS for non-standard CSS could be done the
// same way, but AFAICT, standard CSS properties are best loaded by
// specifying a .CSS file in the HTML. The CSS is probably less text
// than its codegen'd representation, and the browser can probably
// load a .CSS file faster than us trying to run code to update the
// styles.
// So, for Royale, all style blocks from all MXML files are gathered into
// one .css file and a corresponding codegen block that is output as
// part of the main .JS file.
return cssSession;
}
private HashMap astCache = new HashMap();
@Override
public void addToASTCache(IASNode ast)
{
astCache.put(ast, "");
}
@Override
public void setTargetSettings(ITargetSettings value)
{
super.setTargetSettings(value);
ts = value;
linkageChecker = new LinkageChecker(this, value);
try {
linkageChecker.initExterns();
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
@Override
public String getGeneratedIDBase()
{
return MXMLRoyaleEmitterTokens.ID_PREFIX.getToken();
}
public ITargetAttributes computeTargetAttributes()
{
List names;
try {
names = mainCU.getQualifiedNames();
IDefinition def = this.resolveQNameToDefinition(names.get(0));
IDefinitionNode node = def.getNode();
if (node instanceof MXMLDocumentNode)
{
MXMLDocumentNode mxmlDoc = (MXMLDocumentNode)node;
MXMLFileNode mxmlFile = (MXMLFileNode)mxmlDoc.getParent();
return mxmlFile.getTargetAttributes(this);
}
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
return null;
}
public IBackend getBackend() {
return backend;
}
@Override
protected void overrideDefines(Map defines)
{
if (defines.containsKey("COMPILE::SWF"))
{
if (defines.get("COMPILE::SWF").equals("AUTO"))
defines.put("COMPILE::SWF", "false");
}
if (defines.containsKey("COMPILE::JS"))
{
if (defines.get("COMPILE::JS").equals("AUTO"))
defines.put("COMPILE::JS", "true");
}
}
/**
* List of external libraries so it can be overridden
*/
public List getCompilerExternalLibraryPath(Configuration config)
{
List list = ((JSConfiguration)config).getCompilerJsExternalLibraryPath();
if (list != null && list.size() > 0)
return list;
return config.getCompilerExternalLibraryPath();
}
/**
* List of libraries so it can be overridden
*/
public List getCompilerLibraryPath(Configuration config)
{
List list = ((JSConfiguration)config).getCompilerJsLibraryPath();
if (list != null && list.size() > 0)
return list;
return config.getCompilerLibraryPath();
}
/**
* List of libraries so it can be overridden
*/
public List getCompilerNamespacesManifestMappings(Configuration config)
{
List list = ((JSConfiguration)config).getCompilerJsNamespacesManifestMappings();
if (list != null && list.size() > 0)
return list;
return config.getCompilerNamespacesManifestMappings();
}
@Override
public boolean isPlatformRule(ICSSRule rule) {
ImmutableList mqlist = rule.getMediaQueryConditions();
int n = mqlist.size();
if (n > 0)
{
if (mqlist.get(0).toString().equals("-royale-swf"))
return false;
}
return true;
}
private HashSet exportedNames = new HashSet();
public List compiledResourceBundleNames = new ArrayList();
public List compiledResourceBundleClasses = new ArrayList();
public void addExportedName(String name)
{
exportedNames.add(name);
}
public Set getExportedNames()
{
return exportedNames;
}
public boolean isModule(String mainClass)
{
IResolvedQualifiersReference iModuleRef = ReferenceFactory.packageQualifiedReference(
getWorkspace(), "org.apache.royale.core.IModule");
ITypeDefinition moddef = (ITypeDefinition)iModuleRef.resolve(this);
IResolvedQualifiersReference mainRef = ReferenceFactory.packageQualifiedReference(
getWorkspace(), mainClass);
IDefinition maindef = mainRef.resolve(this);
if (maindef instanceof ITypeDefinition)
{
ITypeDefinition type = (ITypeDefinition)maindef;
return type.isInstanceOf(moddef, this);
}
return false;
}
@Override
public boolean isParameterCountMismatchAllowed(IFunctionDefinition func,
int formalCount, int actualCount) {
if ((func.getBaseName().equals("int") || func.getBaseName().equals("uint")) && func.isConstructor()) {
if (actualCount == 1) return true;
}
return super.isParameterCountMismatchAllowed(func, formalCount, actualCount);
}
/**
* List of compiler defines so it can be overridden
*/
@Override
public Map getCompilerDefine(Configuration config)
{
Map list = ((JSConfiguration)config).getJsCompilerDefine();
return list;
}
public File getLinkReport(Configuration config) {
File f = config.getLinkReport();
if (f != null)
{
String baseName = f.getName();
String suffix = "";
int c = baseName.indexOf(".");
if (c != -1)
{
suffix = baseName.substring(c);
baseName = baseName.substring(0, c);
}
baseName += "-js" + suffix;
f = new File(f.getParentFile(), baseName);
}
return f;
}
/**
* JS Projects do not have static typing at runtime
*/
@Override
public boolean isStaticTypedTarget() {
return false;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy