com.google.gwt.resources.rg.CssResourceGenerator Maven / Gradle / Ivy
Show all versions of vaadin-client Show documentation
/*
* Copyright 2008 Google Inc.
*
* Licensed 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 com.google.gwt.resources.rg;
import com.google.gwt.core.ext.BadPropertyValueException;
import com.google.gwt.core.ext.ConfigurationProperty;
import com.google.gwt.core.ext.Generator;
import com.google.gwt.core.ext.PropertyOracle;
import com.google.gwt.core.ext.TreeLogger;
import com.google.gwt.core.ext.TreeLogger.Type;
import com.google.gwt.core.ext.UnableToCompleteException;
import com.google.gwt.core.ext.linker.EmittedArtifact.Visibility;
import com.google.gwt.core.ext.typeinfo.JClassType;
import com.google.gwt.core.ext.typeinfo.JMethod;
import com.google.gwt.core.ext.typeinfo.JPrimitiveType;
import com.google.gwt.core.ext.typeinfo.NotFoundException;
import com.google.gwt.core.ext.typeinfo.TypeOracle;
import com.google.gwt.core.shared.impl.StringCase;
import com.google.gwt.dev.util.DefaultTextOutput;
import com.google.gwt.dev.util.Util;
import com.google.gwt.i18n.client.LocaleInfo;
import com.google.gwt.resources.client.CssResource;
import com.google.gwt.resources.client.CssResource.ClassName;
import com.google.gwt.resources.client.CssResource.Import;
import com.google.gwt.resources.client.CssResource.ImportedWithPrefix;
import com.google.gwt.resources.client.CssResource.NotStrict;
import com.google.gwt.resources.client.CssResource.Shared;
import com.google.gwt.resources.client.CssResourceBase;
import com.google.gwt.resources.css.ClassRenamer;
import com.google.gwt.resources.css.CssGenerationVisitor;
import com.google.gwt.resources.css.DefsCollector;
import com.google.gwt.resources.css.ExternalClassesCollector;
import com.google.gwt.resources.css.GenerateCssAst;
import com.google.gwt.resources.css.IfEvaluator;
import com.google.gwt.resources.css.MergeIdenticalSelectorsVisitor;
import com.google.gwt.resources.css.MergeRulesByContentVisitor;
import com.google.gwt.resources.css.RequirementsCollector;
import com.google.gwt.resources.css.RtlVisitor;
import com.google.gwt.resources.css.SplitRulesVisitor;
import com.google.gwt.resources.css.Spriter;
import com.google.gwt.resources.css.SubstitutionCollector;
import com.google.gwt.resources.css.SubstitutionReplacer;
import com.google.gwt.resources.css.ast.CollapsedNode;
import com.google.gwt.resources.css.ast.CssCompilerException;
import com.google.gwt.resources.css.ast.CssDef;
import com.google.gwt.resources.css.ast.CssIf;
import com.google.gwt.resources.css.ast.CssNode;
import com.google.gwt.resources.css.ast.CssProperty;
import com.google.gwt.resources.css.ast.CssProperty.DotPathValue;
import com.google.gwt.resources.css.ast.CssProperty.ListValue;
import com.google.gwt.resources.css.ast.CssProperty.NumberValue;
import com.google.gwt.resources.css.ast.CssProperty.Value;
import com.google.gwt.resources.css.ast.CssRule;
import com.google.gwt.resources.css.ast.CssStylesheet;
import com.google.gwt.resources.css.ast.CssSubstitution;
import com.google.gwt.resources.css.ast.HasNodes;
import com.google.gwt.resources.ext.ClientBundleRequirements;
import com.google.gwt.resources.ext.ResourceContext;
import com.google.gwt.resources.ext.ResourceGeneratorUtil;
import com.google.gwt.resources.ext.SupportsGeneratorResultCaching;
import com.google.gwt.thirdparty.guava.common.base.Joiner;
import com.google.gwt.user.rebind.SourceWriter;
import com.google.gwt.user.rebind.StringSourceWriter;
import java.io.BufferedWriter;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Serializable;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Comparator;
import java.util.HashMap;
import java.util.IdentityHashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeMap;
import java.util.TreeSet;
import java.util.zip.Adler32;
/**
* Provides implementations of CSSResources.
*/
public class CssResourceGenerator extends AbstractCssResourceGenerator
implements SupportsGeneratorResultCaching {
@SuppressWarnings("serial")
static class JClassOrderComparator implements Comparator,
Serializable {
@Override
public int compare(JClassType o1, JClassType o2) {
return o1.getQualifiedSourceName().compareTo(o2.getQualifiedSourceName());
}
}
/**
* A lookup table of base-32 chars we use to encode CSS idents. Because CSS
* class selectors may be case-insensitive, we don't have enough characters to
* use a base-64 encoding.
*
* Note that the character {@value #RESERVED_IDENT_CHAR} is intentionally
* missing from this array. It is used to prefix identifiers produced by
* {@link #makeIdent} if they conflict with reserved class-name prefixes.
*/
static final char[] BASE32_CHARS = new char[] {
'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N',
'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', '-', '0', '1',
'2', '3', '4', '5'};
/**
* This value is used by {@link #concatOp} to help create a more balanced AST
* tree by producing parenthetical expressions.
*/
private static final int CONCAT_EXPRESSION_LIMIT = 20;
/**
* These constants are used to cache obfuscated class names.
*/
private static final String KEY_BY_CLASS_AND_METHOD = "classAndMethod";
private static final String KEY_CLASS_PREFIX = "prefix";
private static final String KEY_CLASS_COUNTER = "counter";
private static final String KEY_HAS_CACHED_DATA = "hasCachedData";
private static final String KEY_MERGE_ENABLED = "CssResource.mergeEnabled";
private static final String KEY_OBFUSCATION_PREFIX = "CssResource.obfuscationPrefix";
private static final String KEY_RESERVED_PREFIXES = "CssResource.reservedClassPrefixes";
private static final String KEY_SHARED_METHODS = "sharedMethods";
private static final String KEY_STYLE = "CssResource.style";
private static final String KEY_ENABLE_GSS = "CssResource.enableGss";
/**
* This character must not appear in {@link #BASE32_CHARS}.
*/
private static final char RESERVED_IDENT_CHAR = 'Z';
/**
* Returns the import prefix for a type, including the trailing hyphen.
*/
public static String getImportPrefix(JClassType importType) {
String prefix = importType.getSimpleSourceName();
ImportedWithPrefix exp = importType.getAnnotation(ImportedWithPrefix.class);
if (exp != null) {
prefix = exp.value();
}
return prefix + "-";
}
public static boolean haveCommonProperties(CssRule a, CssRule b) {
if (a.getProperties().size() == 0 || b.getProperties().size() == 0) {
return false;
}
SortedSet aProperties = new TreeSet();
SortedSet bProperties = new TreeSet();
for (CssProperty p : a.getProperties()) {
aProperties.add(p.getName());
}
for (CssProperty p : b.getProperties()) {
bProperties.add(p.getName());
}
Iterator ai = aProperties.iterator();
Iterator bi = bProperties.iterator();
String aName = ai.next();
String bName = bi.next();
for (;;) {
int comp = aName.compareToIgnoreCase(bName);
if (comp == 0) {
return true;
} else if (comp > 0) {
if (aName.startsWith(bName + "-")) {
return true;
}
if (!bi.hasNext()) {
break;
}
bName = bi.next();
} else {
if (bName.startsWith(aName + "-")) {
return true;
}
if (!ai.hasNext()) {
break;
}
aName = ai.next();
}
}
return false;
}
/**
* Compute an obfuscated CSS class name that is guaranteed not to conflict
* with a set of reserved prefixes. Visible for testing.
*/
static String computeObfuscatedClassName(String classPrefix,
Counter classCounter, SortedSet reservedPrefixes) {
String obfuscatedClassName = classPrefix + makeIdent(classCounter.next());
/*
* Ensure that the name won't conflict with any reserved prefixes. We can't
* just keep incrementing the counter, because that could take an
* arbitrarily long amount of time to return a good value.
*/
String conflict = stringStartsWithAny(obfuscatedClassName, reservedPrefixes);
while (conflict != null) {
Adler32 hash = new Adler32();
hash.update(Util.getBytes(conflict));
/*
* Compute a new prefix for the identifier to mask the prefix and add the
* reserved identifier character to prevent conflicts with makeIdent().
*
* Assuming "gwt-" is a reserved prefix: gwt-A -> ab32ZA
*/
String newPrefix = makeIdent(hash.getValue()).substring(0,
conflict.length())
+ RESERVED_IDENT_CHAR;
obfuscatedClassName = newPrefix
+ obfuscatedClassName.substring(conflict.length());
conflict = stringStartsWithAny(obfuscatedClassName, reservedPrefixes);
}
return obfuscatedClassName;
}
/**
* Create a Java expression that evaluates to a string representation of the
* given node. Visible only for testing.
*/
static String makeExpression(
TreeLogger logger, ResourceContext context,
T node, boolean prettyOutput) throws UnableToCompleteException {
// Generate the CSS template
DefaultTextOutput out = new DefaultTextOutput(!prettyOutput);
CssGenerationVisitor v = new CssGenerationVisitor(out);
v.accept(node);
// Generate the final Java expression
String template = out.toString();
StringBuilder b = new StringBuilder();
int start = 0;
/*
* Very large concatenation expressions using '+' cause the GWT compiler to
* overflow the stack due to deep AST nesting. The workaround for now is to
* force it to be more balanced using intermediate concatenation groupings.
*
* This variable is used to track the number of subexpressions within the
* current parenthetical expression.
*/
int numExpressions = 0;
b.append('(');
for (Map.Entry> entry : v.getSubstitutionPositions().entrySet()) {
// Add the static section between start and the substitution point
b.append('"');
b.append(Generator.escape(template.substring(start, entry.getKey())));
b.append('\"');
numExpressions = concatOp(numExpressions, b);
// Add the nodes at the substitution point
for (CssSubstitution x : entry.getValue()) {
TreeLogger loopLogger = logger.branch(TreeLogger.DEBUG,
"Performing substitution in node " + x.toString());
if (x instanceof CssIf) {
CssIf asIf = (CssIf) x;
// Generate the sub-expressions
String expression = makeExpression(loopLogger, context,
new CollapsedNode(asIf), prettyOutput);
String elseExpression;
if (asIf.getElseNodes().isEmpty()) {
// We'll treat an empty else block as an empty string
elseExpression = "\"\"";
} else {
elseExpression = makeExpression(loopLogger, context,
new CollapsedNode(asIf.getElseNodes()), prettyOutput);
}
// ((expr) ? "CSS" : "elseCSS") +
b.append("((" + asIf.getExpression() + ") ? " + expression + " : "
+ elseExpression + ") ");
numExpressions = concatOp(numExpressions, b);
} else if (x instanceof CssProperty) {
CssProperty property = (CssProperty) x;
validateValue(loopLogger, context.getClientBundleType(),
property.getValues());
// (expr) +
b.append("(" + property.getValues().getExpression() + ") ");
numExpressions = concatOp(numExpressions, b);
} else {
// This indicates that some unexpected node is slipping by our visitors
loopLogger.log(TreeLogger.ERROR, "Unhandled substitution "
+ x.getClass());
throw new UnableToCompleteException();
}
}
start = entry.getKey();
}
// Add the remaining parts of the template
b.append('"');
b.append(Generator.escape(template.substring(start)));
b.append('"');
b.append(')');
return b.toString();
}
/**
* Check if number of concat expressions currently exceeds limit and either
* append '+' if the limit isn't reached or ') + (' if it is.
*
* @return numExpressions + 1 or 0 if limit was exceeded.
*/
private static int concatOp(int numExpressions, StringBuilder b) {
/*
* TODO: Fix the compiler to better handle arbitrarily long concatenation
* expressions.
*/
if (numExpressions >= CONCAT_EXPRESSION_LIMIT) {
b.append(") + (");
return 0;
}
b.append(" + ");
return numExpressions + 1;
}
private static String makeIdent(long id) {
assert id >= 0;
StringBuilder b = new StringBuilder();
// Use only guaranteed-alpha characters for the first character
b.append(BASE32_CHARS[(int) (id & 0xf)]);
id >>= 4;
while (id != 0) {
b.append(BASE32_CHARS[(int) (id & 0x1f)]);
id >>= 5;
}
return b.toString();
}
/**
* Returns true if target starts with any of the
* prefixes in the supplied set. The check is performed in a case-insensitive
* manner, assuming that the values in prefixes have already been
* converted to lower-case.
*/
private static String stringStartsWithAny(String target,
SortedSet prefixes) {
if (prefixes.isEmpty()) {
return null;
}
/*
* The headSet() method returns values strictly less than the search value,
* so we want to append a trailing character to the end of the search in
* case the obfuscated class name is exactly equal to one of the prefixes.
*/
String search = StringCase.toLower(target.toString()) + " ";
SortedSet headSet = prefixes.headSet(search);
if (!headSet.isEmpty()) {
String prefix = headSet.last();
if (search.startsWith(prefix)) {
return prefix;
}
}
return null;
}
/**
* This function validates any context-sensitive Values.
*/
private static void validateValue(TreeLogger logger,
JClassType resourceBundleType, Value value)
throws UnableToCompleteException {
ListValue list = value.isListValue();
if (list != null) {
for (Value v : list.getValues()) {
validateValue(logger, resourceBundleType, v);
}
return;
}
DotPathValue dot = value.isDotPathValue();
if (dot != null) {
try {
// This will either succeed or throw an exception
ResourceGeneratorUtil.getMethodByPath(resourceBundleType,
dot.getParts(), null);
} catch (NotFoundException e) {
logger.log(TreeLogger.ERROR, e.getMessage());
throw new UnableToCompleteException();
}
}
}
protected CssObfuscationStyle obfuscationStyle;
private Counter classCounter;
private boolean enableMerge;
private boolean gssEnabled;
private GssResourceGenerator gssResourceGenerator;
private List ignoredMethods = new ArrayList();
private Map> replacementsByClassAndMethod;
private Map replacementsForSharedMethods;
private Map stylesheetMap;
@Override
public String createAssignment(TreeLogger logger, ResourceContext context,
JMethod method) throws UnableToCompleteException {
// if Gss is enabled, defer the call to the Gss generator.
if (gssEnabled) {
return gssResourceGenerator.createAssignment(logger, context, method);
}
JClassType cssResourceSubtype = method.getReturnType().isInterface();
assert cssResourceSubtype != null;
CssStylesheet stylesheet = stylesheetMap.get(method);
// Optimize the stylesheet, recording the class selector obfuscations
Map actualReplacements = optimize(logger, context, method);
outputCssMapArtifact(logger, context, method, actualReplacements);
outputAdditionalArtifacts(logger, context, method, actualReplacements,
cssResourceSubtype, stylesheet);
return getResourceImplAsString(logger, context, method, actualReplacements,
cssResourceSubtype, stylesheet);
}
@Override
public void init(TreeLogger logger, ResourceContext context)
throws UnableToCompleteException {
// if Gss is enabled, defer the call to the Gss generator.
if (checkIfGssEnabled(context, logger)) {
gssEnabled = true;
gssResourceGenerator = new GssResourceGenerator();
gssResourceGenerator.init(logger, context);
return;
}
gssEnabled = false;
String classPrefix;
try {
PropertyOracle propertyOracle =
context.getGeneratorContext().getPropertyOracle();
ConfigurationProperty styleProp =
propertyOracle.getConfigurationProperty(KEY_STYLE);
obfuscationStyle = CssObfuscationStyle.getObfuscationStyle(
styleProp.getValues().get(0));
ConfigurationProperty mergeProp =
propertyOracle.getConfigurationProperty(KEY_MERGE_ENABLED);
String merge = mergeProp.getValues().get(0);
enableMerge = merge.equals("true");
ConfigurationProperty classPrefixProp =
propertyOracle.getConfigurationProperty(KEY_OBFUSCATION_PREFIX);
classPrefix = classPrefixProp.getValues().get(0);
// add these configuration properties to our requirements
ClientBundleRequirements requirements = context.getRequirements();
requirements.addConfigurationProperty(KEY_STYLE);
requirements.addConfigurationProperty(KEY_MERGE_ENABLED);
requirements.addConfigurationProperty(KEY_OBFUSCATION_PREFIX);
} catch (BadPropertyValueException e) {
logger.log(TreeLogger.ERROR, "Unable to query module property", e);
throw new UnableToCompleteException();
}
TypeOracle typeOracle = context.getGeneratorContext().getTypeOracle();
JClassType superInterface = typeOracle.findType(getSuperclassInterfaceName());
JClassType baseInterface = typeOracle.findType(getBaseclassInterfaceName());
for (JMethod m : superInterface.getInheritableMethods()) {
ignoredMethods.add(m.getName());
}
stylesheetMap = new IdentityHashMap();
SortedSet cssResourceSubtypes =
computeOperableTypes(logger, baseInterface);
initReplacements(logger, context, classPrefix, cssResourceSubtypes);
}
@Override
public void prepare(TreeLogger logger, ResourceContext context,
ClientBundleRequirements requirements, JMethod method)
throws UnableToCompleteException {
// if Gss is enabled, defer the call to the Gss generator.
if (gssEnabled) {
gssResourceGenerator.prepare(logger, context, requirements, method);
return;
}
if (method.getReturnType().isInterface() == null) {
logger.log(TreeLogger.ERROR, "Return type must be an interface");
throw new UnableToCompleteException();
}
URL[] resources = getResources(logger, context, method);
if (resources.length == 0) {
logger.log(TreeLogger.ERROR, "At least one source must be specified");
throw new UnableToCompleteException();
}
// At this point, gss is not enabled so we shouldn't try to compile a gss file.
ensureNoGssFile(resources, logger);
// Create the AST and do a quick scan for requirements
CssStylesheet sheet = GenerateCssAst.exec(logger, resources);
checkSheet(logger, sheet);
stylesheetMap.put(method, sheet);
(new RequirementsCollector(logger, context.getRequirements())).accept(sheet);
}
private void ensureNoGssFile(URL[] resources, TreeLogger logger)
throws UnableToCompleteException {
for (URL stylesheet : resources) {
if (stylesheet.getFile().endsWith(".gss")) {
logger.log(Type.ERROR, "GSS is not enabled. Add the following line to your gwt.xml file " +
"to enable it: " +
" actualReplacements,
JClassType cssResourceSubtype,
CssStylesheet stylesheet) throws UnableToCompleteException {
SourceWriter sw = new StringSourceWriter();
// Write the expression to create the subtype.
sw.println("new " + method.getReturnType().getQualifiedSourceName()
+ "() {");
sw.indent();
// Methods defined by CssResource interface
writeEnsureInjected(sw);
writeGetName(method, sw);
// Create the Java expression that generates the CSS
writeGetText(logger, context, method, sw);
// getOverridableMethods is used to handle CssResources extending
// non-CssResource types. See the discussion in computeReplacementsForType.
writeUserMethods(logger, sw, stylesheet,
cssResourceSubtype.getOverridableMethods(), actualReplacements);
sw.outdent();
sw.println("}");
return sw.toString();
}
protected URL[] getResources(TreeLogger logger, ResourceContext context,
JMethod method) throws UnableToCompleteException {
return ResourceGeneratorUtil.findResources(logger, context, method);
}
/**
* Return the name of the class which is the direct superclass of the
* interface being implemented.
*/
protected String getSuperclassInterfaceName() {
return CssResource.class.getCanonicalName();
}
/**
* Output additional artifacts. Does nothing in this baseclass, but is a hook
* for subclasses to do so.
*/
protected void outputAdditionalArtifacts(TreeLogger logger,
ResourceContext context, JMethod method,
Map actualReplacements, JClassType cssResourceSubtype,
CssStylesheet stylesheet) throws UnableToCompleteException {
}
/**
* Builds a CSV file mapping obfuscated CSS class names to their qualified source name and
* outputs it as a private build artifact.
*/
protected void outputCssMapArtifact(TreeLogger logger, ResourceContext context, JMethod method,
Map actualReplacements) {
// There may be several css resources that have the same css resource subtype (e.g. CssResource)
// so the qualified accessor method name is used for the unique output file name.
JClassType bundleType = method.getEnclosingType();
String qualifiedMethodName = bundleType.getQualifiedSourceName() + "." + method.getName();
String mappingFileName = "cssResource/" + qualifiedMethodName + ".cssmap";
OutputStream os = null;
try {
os = context.getGeneratorContext().tryCreateResource(logger, mappingFileName);
} catch (UnableToCompleteException e) {
logger.log(TreeLogger.WARN, "Could not create resource: " + mappingFileName);
return;
}
if (os == null) {
// If the returned OutputStream is null, that typically means the resource already exists.
// No need to write it out again.
return;
}
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(os));
try {
for (Map.Entry replacement : actualReplacements.entrySet()) {
String qualifiedName = replacement.getKey().getEnclosingType().getQualifiedSourceName();
String baseName = replacement.getKey().getName();
writer.write(qualifiedName.replaceAll("[.$]", "-") + "-" + baseName);
writer.write(",");
writer.write(replacement.getValue());
writer.newLine();
}
writer.flush();
writer.close();
} catch (IOException e) {
logger.log(TreeLogger.WARN, "Error writing artifact: " + mappingFileName);
}
try {
context.getGeneratorContext().commitResource(logger, os).setVisibility(Visibility.Private);
} catch (UnableToCompleteException e) {
logger.log(TreeLogger.WARN, "Error trying to commit artifact: " + mappingFileName);
}
}
/**
* Write all of the user-defined methods in the CssResource subtype.
*/
protected void writeUserMethods(TreeLogger logger, SourceWriter sw,
CssStylesheet sheet, JMethod[] methods,
Map obfuscatedClassNames)
throws UnableToCompleteException {
// Get list of @defs
DefsCollector collector = new DefsCollector();
collector.accept(sheet);
Set defs = collector.getDefs();
for (JMethod toImplement : methods) {
String name = toImplement.getName();
if (ignoredMethods.contains(name)) {
continue;
}
// Bomb out if there is a collision between @def and a style name
if (defs.contains(name) && obfuscatedClassNames.containsKey(toImplement)) {
logger.log(TreeLogger.ERROR, "@def shadows CSS class name: " + name
+ ". Fix by renaming the @def name or the CSS class name.");
throw new UnableToCompleteException();
}
if (defs.contains(toImplement.getName())
&& toImplement.getParameters().length == 0) {
writeDefAssignment(logger, sw, toImplement, sheet);
} else if (toImplement.getReturnType().getQualifiedSourceName()
.equals("java.lang.String")
&& toImplement.getParameters().length == 0) {
writeClassAssignment(sw, toImplement, obfuscatedClassNames);
} else {
logger.log(TreeLogger.ERROR, "Don't know how to implement method "
+ toImplement.getName());
throw new UnableToCompleteException();
}
}
}
/**
* Determine the class prefix that will be used. If a value is automatically
* computed, the reservedPrefixes set will be cleared because the
* returned value is guaranteed to not conflict with any reserved prefixes.
*/
private String computeClassPrefix(String classPrefix,
SortedSet cssResourceSubtypes,
TreeSet reservedPrefixes) {
if ("default".equals(classPrefix)) {
classPrefix = null;
} else if ("empty".equals(classPrefix)) {
classPrefix = "";
}
if (classPrefix == null) {
/*
* Note that the checksum will miss some or all of the subtypes generated
* by other generators.
*/
Adler32 checksum = new Adler32();
for (JClassType type : cssResourceSubtypes) {
checksum.update(Util.getBytes(type.getQualifiedSourceName()));
}
final int seed = Math.abs((int) checksum.getValue());
classPrefix = "G" + computeObfuscatedClassName("", new Counter() {
@Override
int next() {
return seed;
}
}, reservedPrefixes);
// No conflicts are possible now
reservedPrefixes.clear();
}
return classPrefix;
}
/**
* Each distinct type of CssResource has a unique collection of values that it
* will return, excepting for those methods that are defined within an
* interface that is tagged with {@code @Shared}.
*/
private void computeObfuscatedNames(TreeLogger logger, String classPrefix,
SortedSet reservedPrefixes, Set cssResourceSubtypes) {
logger = logger.branch(TreeLogger.DEBUG, "Computing CSS class replacements");
for (JClassType type : cssResourceSubtypes) {
if (replacementsByClassAndMethod.containsKey(type)) {
continue;
}
Map replacements = new IdentityHashMap();
replacementsByClassAndMethod.put(type, replacements);
for (JMethod method : type.getOverridableMethods()) {
String name = method.getName();
if (ignoredMethods.contains(name)) {
continue;
}
// The user provided the class name to use
ClassName classNameOverride = method.getAnnotation(ClassName.class);
if (classNameOverride != null) {
name = classNameOverride.value();
}
/*
* Short name, based off a counter that is shared by all of the
* obfuscated css names in this compile.
*/
String obfuscatedClassName = computeObfuscatedClassName(classPrefix,
classCounter, reservedPrefixes);
// Modify the name based on the obfuscation style requested
obfuscatedClassName = obfuscationStyle.getPrettyName(name, type,
obfuscatedClassName);
replacements.put(method, obfuscatedClassName);
if (method.getEnclosingType() == type) {
Shared shared = type.getAnnotation(Shared.class);
if (shared != null) {
replacementsForSharedMethods.put(method, obfuscatedClassName);
}
}
if (logger.isLoggable(TreeLogger.SPAM)) {
logger.log(TreeLogger.SPAM, "Mapped " + type.getQualifiedSourceName()
+ "." + name + " to " + obfuscatedClassName);
}
}
}
}
/**
* Returns all interfaces derived from CssResource, sorted by qualified name.
*
* We'll ignore concrete implementations of CssResource, which include types
* previously-generated by CssResourceGenerator and user-provided
* implementations of CssResource, which aren't valid for use with
* CssResourceGenerator anyway. By ignoring newly-generated CssResource types,
* we'll ensure a stable ordering, regardless of the actual execution order
* used by the Generator framework.
*
* It is still possible that additional pure-interfaces could be introduced by
* other generators, which would change the result of this computation, but
* there is presently no way to determine when, or by what means, a type was
* added to the TypeOracle.
*/
private SortedSet computeOperableTypes(TreeLogger logger,
JClassType baseInterface) {
logger = logger.branch(TreeLogger.DEBUG,
"Finding operable CssResource subtypes");
SortedSet toReturn = new TreeSet(
new JClassOrderComparator());
JClassType[] cssResourceSubtypes = baseInterface.getSubtypes();
for (JClassType type : cssResourceSubtypes) {
if (type.isInterface() != null) {
if (logger.isLoggable(TreeLogger.SPAM)) {
logger.log(TreeLogger.SPAM, "Added " + type.getQualifiedSourceName());
}
toReturn.add(type);
} else {
if (logger.isLoggable(TreeLogger.SPAM)) {
logger.log(TreeLogger.SPAM, "Ignored " + type.getQualifiedSourceName());
}
}
}
return toReturn;
}
/**
* Compute the mapping of original class names to obfuscated type names for a
* given subtype of CssResource. Mappings are inherited from the type's
* supertypes.
*/
private Map computeReplacementsForType(JClassType type) {
Map toReturn = new IdentityHashMap();
if (replacementsByClassAndMethod.containsKey(type)) {
toReturn.putAll(replacementsByClassAndMethod.get(type));
}
/*
* Replacements for methods defined in shared types will override any
* locally-computed values.
*/
for (JMethod method : type.getOverridableMethods()) {
if (replacementsForSharedMethods.containsKey(method)) {
assert toReturn.containsKey(method);
toReturn.put(method, replacementsForSharedMethods.get(method));
}
}
return toReturn;
}
/**
* Determine if a type is derived from CssResource.
*/
private boolean derivedFromCssResource(JClassType type, JClassType cssResourceType) {
List superInterfaces = Arrays.asList(type.getImplementedInterfaces());
if (superInterfaces.contains(cssResourceType)) {
return true;
}
JClassType superClass = type.getSuperclass();
if (superClass != null) {
if (derivedFromCssResource(superClass, cssResourceType)) {
return true;
}
}
for (JClassType superInterface : superInterfaces) {
if (derivedFromCssResource(superInterface, cssResourceType)) {
return true;
}
}
return false;
}
/**
* This method will initialize the maps that contain the obfuscated class
* names.
*/
@SuppressWarnings("unchecked")
private void initReplacements(TreeLogger logger, ResourceContext context,
String classPrefix, SortedSet operableTypes) {
/*
* This code was originally written to take a snapshot of all the
* CssResource descendants in the TypeOracle on its first run and calculate
* the obfuscated names in one go, to ensure that the same obfuscation would
* result regardless of the order in which the generators fired. (It no
* longer behaves that way, as that scheme prevented the generation of new
* CssResource interfaces, but the complexity lives on.)
*
* TODO(rjrjr,bobv) These days scottb tells us we're guaranteed that the
* recompiling the same code will fire the generators in a consistent order,
* so the old gymnastics aren't really justified anyway. It would probably
* be be worth the effort to simplify this.
*/
if (context.getCachedData(KEY_HAS_CACHED_DATA, Boolean.class) != Boolean.TRUE) {
ConfigurationProperty prop;
TreeSet reservedPrefixes = new TreeSet();
try {
prop = context.getGeneratorContext().getPropertyOracle()
.getConfigurationProperty(KEY_RESERVED_PREFIXES);
// add this configuration property to our requirements
context.getRequirements().addConfigurationProperty(KEY_RESERVED_PREFIXES);
for (String value : prop.getValues()) {
value = value.trim();
if (value.length() == 0) {
logger.log(TreeLogger.WARN,
"Ignoring nonsensical empty string value for "
+ KEY_RESERVED_PREFIXES + " configuration property");
continue;
}
// Strip leading dots
if (value.startsWith(".")) {
value = value.substring(1);
}
reservedPrefixes.add(StringCase.toLower(value));
}
} catch (BadPropertyValueException e) {
// Do nothing. Unexpected, but we can live with it.
}
String computedPrefix = computeClassPrefix(classPrefix,
operableTypes, reservedPrefixes);
context.putCachedData(KEY_BY_CLASS_AND_METHOD,
new IdentityHashMap>());
context.putCachedData(KEY_CLASS_PREFIX, computedPrefix);
context.putCachedData(KEY_CLASS_COUNTER, new Counter());
context.putCachedData(KEY_HAS_CACHED_DATA, Boolean.TRUE);
context.putCachedData(KEY_RESERVED_PREFIXES, reservedPrefixes);
context.putCachedData(KEY_SHARED_METHODS,
new IdentityHashMap());
}
classCounter = context.getCachedData(KEY_CLASS_COUNTER, Counter.class);
replacementsByClassAndMethod = context.getCachedData(
KEY_BY_CLASS_AND_METHOD, Map.class);
replacementsForSharedMethods = context.getCachedData(KEY_SHARED_METHODS,
Map.class);
classPrefix = context.getCachedData(KEY_CLASS_PREFIX, String.class);
SortedSet reservedPrefixes = context.getCachedData(
KEY_RESERVED_PREFIXES, SortedSet.class);
computeObfuscatedNames(logger, classPrefix, reservedPrefixes,
operableTypes);
}
/**
* Check for the presence of the NotStrict annotation on the method. This will
* also perform some limited sanity-checking for the now-deprecated Strict
* annotation.
*/
@SuppressWarnings("deprecation")
// keep references to deprecated Strict annotation local
private boolean isStrict(TreeLogger logger, JMethod method) {
com.google.gwt.resources.client.CssResource.Strict strictAnnotation = method.getAnnotation(com.google.gwt.resources.client.CssResource.Strict.class);
NotStrict nonStrictAnnotation = method.getAnnotation(NotStrict.class);
boolean strict = true;
if (strictAnnotation != null && nonStrictAnnotation != null) {
// Both annotations
logger.log(TreeLogger.WARN, "Contradictory annotations "
+ com.google.gwt.resources.client.CssResource.Strict.class.getName()
+ " and " + NotStrict.class.getName()
+ " applied to the CssResource accessor method; assuming strict");
} else if (nonStrictAnnotation != null) {
// Only the non-strict annotation
strict = false;
}
return strict;
}
@Override
protected String getCssExpression(TreeLogger logger, ResourceContext context,
JMethod method) throws UnableToCompleteException {
return makeExpression(logger, context, stylesheetMap.get(method));
}
/**
* Create a Java expression that evaluates to the string representation of the
* stylesheet resource.
*
* @param actualReplacements An out parameter that will be populated by the
* obfuscated class names that should be used for the particular
* instance of the CssResource, based on any substitution
* modifications encoded in the source CSS file
*/
private String makeExpression(TreeLogger logger, ResourceContext context,
CssStylesheet sheet)
throws UnableToCompleteException {
try {
String standard = makeExpression(logger, context, sheet, obfuscationStyle.isPretty());
(new RtlVisitor()).accept(sheet);
String reversed = makeExpression(logger, context, sheet, obfuscationStyle.isPretty());
if (standard.equals(reversed)) {
return standard;
} else {
return LocaleInfo.class.getName() + ".getCurrentLocale().isRTL() ? ("
+ reversed + ") : (" + standard + ")";
}
} catch (CssCompilerException e) {
// Take this as a sign that one of the visitors was unhappy, but only
// log the stack trace if there's a causal (i.e. unknown) exception.
logger.log(TreeLogger.ERROR, "Unable to process CSS",
e.getCause() == null ? null : e);
throw new UnableToCompleteException();
}
}
private Map optimize(TreeLogger logger,
ResourceContext context, JMethod method) throws UnableToCompleteException {
TypeOracle typeOracle = context.getGeneratorContext().getTypeOracle();
JClassType cssResourceSubtype = method.getReturnType().isInterface();
assert cssResourceSubtype != null;
assert derivedFromCssResource(cssResourceSubtype,
typeOracle.findType(getBaseclassInterfaceName()));
// Compute the local effective namespace
Map> classReplacementsWithPrefix = processImports(
logger, typeOracle, cssResourceSubtype, method, context);
boolean strict = isStrict(logger, method);
CssStylesheet sheet = stylesheetMap.get(method);
// Create CSS sprites
(new Spriter(logger, context)).accept(sheet);
// Perform @def and @eval substitutions
SubstitutionCollector collector = new SubstitutionCollector();
collector.accept(sheet);
(new SubstitutionReplacer(logger, context, collector.getSubstitutions()))
.accept(sheet);
// Evaluate @if statements based on deferred binding properties
(new IfEvaluator(logger,
context.getGeneratorContext().getPropertyOracle())).accept(sheet);
// Rename css .class selectors. We look for all @external declarations in
// the stylesheet and then compute the per-instance replacements.
ExternalClassesCollector externalClasses = new ExternalClassesCollector();
externalClasses.accept(sheet);
ClassRenamer renamer = new ClassRenamer(logger,
classReplacementsWithPrefix, strict, externalClasses.getClasses());
renamer.accept(sheet);
Map actualReplacements = new TreeMap(
new Comparator() {
@Override
public int compare(JMethod o1, JMethod o2) {
int result = source(o1).compareTo(source(o2));
if (result == 0) {
result = o1.getName().compareTo(o2.getName());
}
return result;
}
private String source(JMethod o) {
return o.getEnclosingType().getQualifiedSourceName();
}
});
actualReplacements.putAll(renamer.getReplacements());
// Combine rules with identical selectors
if (enableMerge) {
(new SplitRulesVisitor()).accept(sheet);
(new MergeIdenticalSelectorsVisitor()).accept(sheet);
(new MergeRulesByContentVisitor()).accept(sheet);
}
return actualReplacements;
}
/**
* Process the Import annotation on the associated JMethod and return a map of
* prefixes to JMethods to locally obfuscated names.
*/
private Map> processImports(TreeLogger logger,
TypeOracle typeOracle, JClassType cssResourceSubtype, JMethod method,
ResourceContext context)
throws UnableToCompleteException {
Map> replacementsWithPrefix =
new HashMap>();
replacementsWithPrefix.put("",
computeReplacementsForType(cssResourceSubtype));
Import imp = method.getAnnotation(Import.class);
if (imp != null) {
boolean fail = false;
for (Class clazz : imp.value()) {
JClassType importType = typeOracle.findType(clazz.getName().replace(
'$', '.'));
assert importType != null : "TypeOracle does not have type "
+ clazz.getName();
// add this import type as a requirement for this generator
context.getRequirements().addTypeHierarchy(importType);
String prefix = getImportPrefix(importType);
if (replacementsWithPrefix.put(prefix,
computeReplacementsForType(importType)) != null) {
logger.log(TreeLogger.ERROR,
"Multiple imports that would use the prefix " + prefix);
fail = true;
}
}
if (fail) {
throw new UnableToCompleteException();
}
}
return replacementsWithPrefix;
}
/**
* Write the CssResource accessor method for simple String return values.
*/
private void writeClassAssignment(SourceWriter sw, JMethod toImplement,
Map classReplacements) {
String replacement = classReplacements.get(toImplement);
assert replacement != null : "Missing replacement for "
+ toImplement.getName();
writeSimpleGetter(toImplement, "\"" + replacement + "\"", sw);
}
private void writeDefAssignment(TreeLogger logger, SourceWriter sw,
JMethod toImplement, CssStylesheet cssStylesheet)
throws UnableToCompleteException {
SubstitutionCollector collector = new SubstitutionCollector();
collector.accept(cssStylesheet);
String name = toImplement.getName();
// TODO: Annotation for override
CssDef def = collector.getSubstitutions().get(name);
if (def == null) {
logger.log(TreeLogger.ERROR, "No @def rule for name " + name);
throw new UnableToCompleteException();
}
JClassType classReturnType = toImplement.getReturnType().isClass();
if (def.getValues().size() != 1 && !isReturnTypeString(classReturnType)) {
logger.log(TreeLogger.ERROR, "@def rule " + name
+ " must define exactly one value or return type must be String");
throw new UnableToCompleteException();
}
String returnExpr = "";
if (isReturnTypeString(classReturnType)) {
List returnValues = new ArrayList();
for (Value val : def.getValues()) {
returnValues.add(Generator.escape(val.toString()));
}
returnExpr = "\"" + Joiner.on(" ").join(returnValues) + "\"";
} else {
JPrimitiveType returnType = toImplement.getReturnType().isPrimitive();
if (returnType == null) {
logger.log(TreeLogger.ERROR, toImplement.getName()
+ ": Return type must be primitive type or String for "
+ "@def accessors");
throw new UnableToCompleteException();
}
NumberValue numberValue = def.getValues().get(0).isNumberValue();
if (returnType == JPrimitiveType.INT || returnType == JPrimitiveType.LONG) {
returnExpr = "" + Math.round(numberValue.getValue());
} else if (returnType == JPrimitiveType.FLOAT) {
returnExpr = numberValue.getValue() + "F";
} else if (returnType == JPrimitiveType.DOUBLE) {
returnExpr = "" + numberValue.getValue();
} else {
logger.log(TreeLogger.ERROR, returnType.getQualifiedSourceName()
+ " is not a valid primitive return type for @def accessors");
throw new UnableToCompleteException();
}
}
writeSimpleGetter(toImplement, returnExpr, sw);
}
private boolean checkIfGssEnabled(ResourceContext context, TreeLogger logger)
throws UnableToCompleteException {
try {
PropertyOracle propertyOracle =
context.getGeneratorContext().getPropertyOracle();
ConfigurationProperty enableGssProp =
propertyOracle.getConfigurationProperty(KEY_ENABLE_GSS);
String enableGss = enableGssProp.getValues().get(0);
return "true".equals(enableGss);
} catch (BadPropertyValueException ex) {
logger.log(Type.ERROR, "Unable to determine if GSS need to be used");
throw new UnableToCompleteException();
}
}
}