com.sencha.gwt.uibinder.rebind.UiBinderWriter Maven / Gradle / Ivy
/*
* 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.sencha.gwt.uibinder.rebind;
import com.google.gwt.core.ext.UnableToCompleteException;
import com.google.gwt.core.ext.typeinfo.JClassType;
import com.google.gwt.core.ext.typeinfo.JPackage;
import com.google.gwt.core.ext.typeinfo.JParameterizedType;
import com.google.gwt.core.ext.typeinfo.JTypeParameter;
import com.google.gwt.core.ext.typeinfo.TypeOracle;
import com.google.gwt.dom.client.TagName;
import com.google.gwt.resources.client.ClientBundle;
import com.sencha.gwt.uibinder.attributeparsers.AttributeParser;
import com.sencha.gwt.uibinder.attributeparsers.AttributeParsers;
import com.sencha.gwt.uibinder.attributeparsers.BundleAttributeParser;
import com.sencha.gwt.uibinder.attributeparsers.BundleAttributeParsers;
import com.google.gwt.uibinder.client.LazyDomElement;
import com.google.gwt.uibinder.client.UiBinder;
import com.sencha.gwt.uibinder.elementparsers.AttributeMessageParser;
import com.sencha.gwt.uibinder.elementparsers.BeanParser;
import com.sencha.gwt.uibinder.elementparsers.ElementParser;
import com.sencha.gwt.uibinder.elementparsers.IsEmptyParser;
import com.sencha.gwt.uibinder.elementparsers.UiChildParser;
import com.sencha.gwt.uibinder.rebind.messages.MessagesWriter;
import com.sencha.gwt.uibinder.rebind.model.HtmlTemplates;
import com.sencha.gwt.uibinder.rebind.model.ImplicitClientBundle;
import com.sencha.gwt.uibinder.rebind.model.ImplicitCssResource;
import com.sencha.gwt.uibinder.rebind.model.OwnerClass;
import com.sencha.gwt.uibinder.rebind.model.OwnerField;
import com.google.gwt.user.client.ui.IsRenderable;
import com.google.gwt.user.client.ui.IsWidget;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Locale;
import java.util.Map;
/**
* Writer for UiBinder generated classes.
*
* TODO(rdamazio): Refactor this, extract model classes, improve ordering
* guarantees, etc.
*
* TODO(rjrjr): Line numbers in error messages.
*/
@SuppressWarnings("deprecation")
public class UiBinderWriter implements Statements {
private static final String PACKAGE_URI_SCHEME = "urn:import:";
// TODO(rjrjr) Another place that we need a general anonymous field
// mechanism
private static final String CLIENT_BUNDLE_FIELD =
"clientBundleFieldNameUnlikelyToCollideWithUserSpecifiedFieldOkay";
public static String asCommaSeparatedList(String... args) {
StringBuilder b = new StringBuilder();
for (String arg : args) {
if (b.length() > 0) {
b.append(", ");
}
b.append(arg);
}
return b.toString();
}
/**
* Escape text that will be part of a string literal to be interpreted at
* runtime as an HTML attribute value.
*/
public static String escapeAttributeText(String text) {
text = escapeText(text, false);
/*
* Escape single-quotes to make them safe to be interpreted at runtime as an
* HTML attribute value (for which we by convention use single quotes).
*/
text = text.replaceAll("'", "'");
return text;
}
/**
* Escape text that will be part of a string literal to be interpreted at
* runtime as HTML, optionally preserving whitespace.
*/
public static String escapeText(String text, boolean preserveWhitespace) {
// Replace reserved XML characters with entities. Note that we *don't*
// replace single- or double-quotes here, because they're safe in text
// nodes.
text = text.replaceAll("&", "&");
text = text.replaceAll("<", "<");
text = text.replaceAll(">", ">");
if (!preserveWhitespace) {
text = text.replaceAll("\\s+", " ");
}
return escapeTextForJavaStringLiteral(text);
}
/**
* Escape characters that would mess up interpretation of this string as a
* string literal in generated code (that is, protect \, \n and " ).
*/
public static String escapeTextForJavaStringLiteral(String text) {
text = text.replace("\\", "\\\\");
text = text.replace("\"", "\\\"");
text = text.replace("\n", "\\n");
return text;
}
/**
* Returns a list of the given type and all its superclasses and implemented
* interfaces in a breadth-first traversal.
*
* @param type the base type
* @return a breadth-first collection of its type hierarchy
*/
static Iterable getClassHierarchyBreadthFirst(JClassType type) {
LinkedList list = new LinkedList();
LinkedList q = new LinkedList();
q.add(type);
while (!q.isEmpty()) {
// Pop the front of the queue and add it to the result list.
JClassType curType = q.removeFirst();
list.add(curType);
// Add implemented interfaces to the back of the queue (breadth first,
// remember?)
for (JClassType intf : curType.getImplementedInterfaces()) {
q.add(intf);
}
// Add then add superclasses
JClassType superClass = curType.getSuperclass();
if (superClass != null) {
q.add(superClass);
}
}
return list;
}
private static String capitalizePropName(String propName) {
return propName.substring(0, 1).toUpperCase() + propName.substring(1);
}
private final MortalLogger logger;
/**
* Class names of parsers for various ui types, keyed by the classname of the
* UI class they can build.
*/
private final Map elementParsers = new HashMap();
private final List initStatements = new ArrayList();
private final List statements = new ArrayList();
private final HtmlTemplates htmlTemplates = new HtmlTemplates();
private final HandlerEvaluator handlerEvaluator;
private final MessagesWriter messages;
private final DesignTimeUtils designTime;
private final Tokenator tokenator = new Tokenator();
private final String templatePath;
private final TypeOracle oracle;
/**
* The type we have been asked to generated, e.g. MyUiBinder
*/
private final JClassType baseClass;
/**
* The name of the class we're creating, e.g. MyUiBinderImpl
*/
private final String implClassName;
private final JClassType uiOwnerType;
private final JClassType uiRootType;
private final JClassType isRenderableClassType;
private final JClassType lazyDomElementClass;
private final OwnerClass ownerClass;
private final FieldManager fieldManager;
private final ImplicitClientBundle bundleClass;
private final boolean useLazyWidgetBuilders;
private final boolean useSafeHtmlTemplates;
private int domId = 0;
private int fieldIndex;
private String gwtPrefix;
private String rendered;
/**
* Stack of element variable names that have been attached.
*/
private final LinkedList attachSectionElements = new LinkedList();
/**
* Maps from field element name to the temporary attach record variable name.
*/
private final Map attachedVars = new HashMap();
private int nextAttachVar = 0;
/**
* Stack of statements to be executed after we detach the current attach
* section.
*/
private final LinkedList> detachStatementsStack = new LinkedList>();
private final AttributeParsers attributeParsers;
private final BundleAttributeParsers bundleParsers;
private final UiBinderContext uiBinderCtx;
private final String binderUri;
public UiBinderWriter(JClassType baseClass, String implClassName,
String templatePath, TypeOracle oracle, MortalLogger logger,
FieldManager fieldManager, MessagesWriter messagesWriter,
DesignTimeUtils designTime, UiBinderContext uiBinderCtx,
boolean useSafeHtmlTemplates, boolean useLazyWidgetBuilders,
String binderUri)
throws UnableToCompleteException {
this.baseClass = baseClass;
this.implClassName = implClassName;
this.oracle = oracle;
this.logger = logger;
this.templatePath = templatePath;
this.fieldManager = fieldManager;
this.messages = messagesWriter;
this.designTime = designTime;
this.uiBinderCtx = uiBinderCtx;
this.useSafeHtmlTemplates = useSafeHtmlTemplates;
this.useLazyWidgetBuilders = useLazyWidgetBuilders;
this.binderUri = binderUri;
// Check for possible misuse 'GWT.create(UiBinder.class)'
JClassType uibinderItself = oracle.findType(UiBinder.class.getCanonicalName());
if (uibinderItself.equals(baseClass)) {
die("You must use a subtype of UiBinder in GWT.create(). E.g.,\n"
+ " interface Binder extends UiBinder {}\n"
+ " GWT.create(Binder.class);");
}
JClassType[] uiBinderTypes = baseClass.getImplementedInterfaces();
if (uiBinderTypes.length == 0) {
throw new RuntimeException("No implemented interfaces for "
+ baseClass.getName());
}
JClassType uiBinderType = uiBinderTypes[0];
JClassType[] typeArgs = uiBinderType.isParameterized().getTypeArgs();
if (typeArgs.length < 2) {
throw new RuntimeException(
"Root and owner type parameters are required for type %s"
+ uiBinderType.getName());
}
uiRootType = typeArgs[0];
uiOwnerType = typeArgs[1];
isRenderableClassType = oracle.findType(IsRenderable.class.getCanonicalName());
lazyDomElementClass = oracle.findType(LazyDomElement.class.getCanonicalName());
ownerClass = new OwnerClass(uiOwnerType, logger, uiBinderCtx);
bundleClass = new ImplicitClientBundle(baseClass.getPackage().getName(),
this.implClassName, CLIENT_BUNDLE_FIELD, logger);
handlerEvaluator = new HandlerEvaluator(
ownerClass, logger, oracle, useLazyWidgetBuilders);
attributeParsers = new AttributeParsers(oracle, fieldManager, logger);
bundleParsers = new BundleAttributeParsers(oracle, logger, getOwnerClass(),
templatePath, uiOwnerType);
}
/**
* Add a statement to be executed right after the current attached element is
* detached. This is useful for doing things that might be expensive while the
* element is attached to the DOM.
*
* @param format
* @param args
* @see #beginAttachedSection(String)
*/
public void addDetachStatement(String format, Object... args) {
detachStatementsStack.getFirst().add(String.format(format, args));
}
/**
* Add a statement to be run after everything has been instantiated, in the
* style of {@link String#format}.
*/
public void addInitStatement(String format, Object... params) {
initStatements.add(formatCode(format, params));
}
/**
* Adds a statement to the block run after fields are declared, in the style
* of {@link String#format}.
*/
public void addStatement(String format, Object... args) {
String code = formatCode(format, args);
if (useLazyWidgetBuilders) {
/**
* I'm intentionally over-simplifying this and assuming that the input
* comes always in the format: field.somestatement();
* Thus, field can be extracted easily and the element parsers don't
* need to be changed all at once.
*/
int idx = code.indexOf(".");
String fieldName = code.substring(0, idx);
fieldManager.require(fieldName).addStatement(format, args);
} else {
statements.add(code);
}
}
/**
* Begin a section where a new attachable element is being parsed--that is,
* one that will be constructed as a big innerHTML string, and then briefly
* attached to the dom to allow fields accessing its to be filled (at the
* moment, HasHTMLParser, HTMLPanelParser, and DomElementParser.).
*
* Succeeding calls made to {@link #ensureAttached} and
* {@link #ensureCurrentFieldAttached} must refer to children of this element,
* until {@link #endAttachedSection} is called.
*
* @param element Java expression for the generated code that will return the
* dom element to be attached.
*/
public void beginAttachedSection(String element) {
attachSectionElements.addFirst(element);
detachStatementsStack.addFirst(new ArrayList());
}
/**
* Declare a field that will hold an Element instance. Returns a token that
* the caller must set as the id attribute of that element in whatever
* innerHTML expression will reproduce it at runtime.
*
* In the generated code, this token will be replaced by an expression to
* generate a unique dom id at runtime. Further code will be generated to be
* run after widgets are instantiated, to use that dom id in a getElementById
* call and assign the Element instance to its field.
*
* @param fieldName The name of the field being declared
* @param ancestorField The name of fieldName parent
*/
public String declareDomField(String fieldName, String ancestorField)
throws UnableToCompleteException {
ensureAttached();
String name = declareDomIdHolder();
if (useLazyWidgetBuilders) {
// Create and initialize the dom field with LazyDomElement.
FieldWriter field = fieldManager.require(fieldName);
/**
* But if the owner field is an instance of LazyDomElement then the code
* can be optimized, no cast is needed and the getter doesn't need to be
* called in its ancestral.
*/
if (isOwnerFieldLazyDomElement(fieldName)) {
field.setInitializer(formatCode("new %s(%s)",
field.getQualifiedSourceName(),
fieldManager.convertFieldToGetter(name)));
} else {
field.setInitializer(formatCode("new %s(%s).get().cast()",
LazyDomElement.class.getCanonicalName(),
fieldManager.convertFieldToGetter(name)));
// The dom must be created by its ancestor.
fieldManager.require(ancestorField).addAttachStatement(
fieldManager.convertFieldToGetter(fieldName) + ";");
}
} else {
setFieldInitializer(fieldName, "null");
addInitStatement(
"%s = com.google.gwt.dom.client.Document.get().getElementById(%s).cast();",
fieldName, name);
addInitStatement("%s.removeAttribute(\"id\");", fieldName);
}
return tokenForStringExpression(fieldManager.convertFieldToGetter(name));
}
/**
* Declare a variable that will be filled at runtime with a unique id, safe
* for use as a dom element's id attribute.
*
* @return that variable's name.
*/
public String declareDomIdHolder() throws UnableToCompleteException {
String domHolderName = "domId" + domId++;
FieldWriter domField = fieldManager.registerField(FieldWriterType.DOM_ID_HOLDER,
oracle.findType(String.class.getName()), domHolderName);
domField.setInitializer("com.google.gwt.dom.client.Document.get().createUniqueId()");
return domHolderName;
}
/**
* Declares a field of the given type name, returning the name of the declared
* field. If the element has a field or id attribute, use its value.
* Otherwise, create and return a new, private field name for it.
*/
public String declareField(String typeName, XMLElement elem)
throws UnableToCompleteException {
JClassType type = oracle.findType(typeName);
if (type == null) {
die(elem, "Unknown type %s", typeName);
}
String fieldName = getFieldName(elem);
if (fieldName == null) {
// TODO(rjrjr) could collide with user declared name, as is
// also a worry in HandlerEvaluator. Need a general scheme for
// anonymous fields. See the note in HandlerEvaluator and do
// something like that, but in FieldManager.
fieldName = "f_" + elem.getLocalName() + ++fieldIndex;
}
fieldName = normalizeFieldName(fieldName);
fieldManager.registerField(type, fieldName);
return fieldName;
}
/**
* If this element has a gwt:field attribute, create a field for it of the
* appropriate type, and return the field name. If no gwt:field attribute is
* found, do nothing and return null
*
* @return The new field name, or null if no field is created
*/
public String declareFieldIfNeeded(XMLElement elem)
throws UnableToCompleteException {
String fieldName = getFieldName(elem);
if (fieldName != null) {
/**
* We can switch types if useLazyWidgetBuilders is enabled and the
* respective owner field is a LazyDomElement.
*/
if (useLazyWidgetBuilders && isOwnerFieldLazyDomElement(fieldName)) {
fieldManager.registerFieldForLazyDomElement(findFieldType(elem), ownerClass.getUiField(fieldName));
} else {
fieldManager.registerField(findFieldType(elem), fieldName);
}
}
return fieldName;
}
/**
* Writes a new SafeHtml template to the generated BinderImpl.
*
* @return The invocation of the SafeHtml template function with the arguments
* filled in
*/
public String declareTemplateCall(String html)
throws IllegalArgumentException {
if (!useSafeHtmlTemplates) {
return '"' + html + '"';
}
return htmlTemplates.addSafeHtmlTemplate(html, tokenator);
}
/**
* Given a string containing tokens returned by {@link #tokenForStringExpression},
* {@link #tokenForSafeHtmlExpression} or {@link #declareDomField}, return a
* string with those tokens replaced by the appropriate expressions. (It is
* not normally necessary for an {@link XMLElement.Interpreter} or
* {@link ElementParser} to make this call, as the tokens are typically
* replaced by the TemplateWriter itself.)
*/
public String detokenate(String betokened) {
return tokenator.detokenate(betokened);
}
/**
* Post an error message and halt processing. This method always throws an
* {@link UnableToCompleteException}
*/
public void die(String message) throws UnableToCompleteException {
logger.die(message);
}
/**
* Post an error message and halt processing. This method always throws an
* {@link UnableToCompleteException}
*/
public void die(String message, Object... params)
throws UnableToCompleteException {
logger.die(message, params);
}
/**
* Post an error message about a specific XMLElement and halt processing. This
* method always throws an {@link UnableToCompleteException}
*/
public void die(XMLElement context, String message, Object... params)
throws UnableToCompleteException {
logger.die(context, message, params);
}
/**
* End the current attachable section. This will detach the element if it was
* ever attached and execute any detach statements.
*
* @see #beginAttachedSection(String)
*/
public void endAttachedSection() {
String elementVar = attachSectionElements.removeFirst();
List detachStatements = detachStatementsStack.removeFirst();
if (attachedVars.containsKey(elementVar)) {
String attachedVar = attachedVars.remove(elementVar);
addInitStatement("%s.detach();", attachedVar);
for (String statement : detachStatements) {
addInitStatement(statement);
}
}
}
/**
* Ensure that the specified element is attached to the DOM.
*
* @see #beginAttachedSection(String)
*/
public void ensureAttached() {
String attachSectionElement = attachSectionElements.getFirst();
if (!attachedVars.containsKey(attachSectionElement)) {
String attachedVar = "attachRecord" + nextAttachVar;
addInitStatement(
"UiBinderUtil.TempAttachment %s = UiBinderUtil.attachToDom(%s);",
attachedVar, attachSectionElement);
attachedVars.put(attachSectionElement, attachedVar);
nextAttachVar++;
}
}
/**
* Ensure that the specified field is attached to the DOM. The field must hold
* an object that responds to Element getElement(). Convenience wrapper for
* {@link #ensureAttached}(field + ".getElement()").
*
* @see #beginAttachedSection(String)
*/
public void ensureCurrentFieldAttached() {
ensureAttached();
}
/**
* Finds the JClassType that corresponds to this XMLElement, which must be a
* Widget or an Element.
*
* @throws UnableToCompleteException If no such widget class exists
* @throws RuntimeException if asked to handle a non-widget, non-DOM element
*/
public JClassType findFieldType(XMLElement elem)
throws UnableToCompleteException {
String tagName = elem.getLocalName();
if (!isImportedElement(elem)) {
return findDomElementTypeForTag(tagName);
}
String ns = elem.getNamespaceUri();
String packageName = ns;
String className = tagName;
while (true) {
JPackage pkg = parseNamespacePackage(packageName);
if (pkg == null) {
throw new RuntimeException("No such package: " + packageName);
}
JClassType rtn = pkg.findType(className);
if (rtn != null) {
return rtn;
}
// Try again: shift one element of the class name onto the package name.
// If the class name has only one element left, fail.
int index = className.indexOf(".");
if (index == -1) {
die(elem, "No class matching \"%s\" in %s", tagName, ns);
}
packageName = packageName + "." + className.substring(0, index);
className = className.substring(index + 1);
}
}
/**
* Generates the code to set a property value (assumes that 'value' is a valid
* Java expression).
*/
public void genPropertySet(String fieldName, String propName, String value) {
addStatement("%1$s.set%2$s(%3$s);", fieldName,
capitalizePropName(propName), value);
}
/**
* Generates the code to set a string property.
*/
public void genStringPropertySet(String fieldName, String propName,
String value) {
genPropertySet(fieldName, propName, "\"" + value + "\"");
}
/**
* Finds an attribute {@link BundleAttributeParser} for the given xml
* attribute, if any, based on its namespace uri.
*
* @return the parser or null
* @deprecated exists only to support {@link BundleAttributeParser}, which
* will be leaving us soon.
*/
@Deprecated
public AttributeParser getBundleAttributeParser(XMLAttribute attribute)
throws UnableToCompleteException {
return bundleParsers.get(attribute);
}
public ImplicitClientBundle getBundleClass() {
return bundleClass;
}
/**
* Returns the {@link DesignTimeUtils}, not null.
*/
public DesignTimeUtils getDesignTime() {
return designTime;
}
public FieldManager getFieldManager() {
return fieldManager;
}
/**
* Returns the logger, at least until we get get it handed off to parsers via
* constructor args.
*/
public MortalLogger getLogger() {
return logger;
}
/**
* Get the {@link MessagesWriter} for this UI, generating it if necessary.
*/
public MessagesWriter getMessages() {
return messages;
}
/**
* Gets the type oracle.
*/
public TypeOracle getOracle() {
return oracle;
}
public OwnerClass getOwnerClass() {
return ownerClass;
}
public String getUiFieldAttributeName() {
return gwtPrefix + ":field";
}
public boolean isBinderElement(XMLElement elem) {
String uri = elem.getNamespaceUri();
return uri != null && binderUri.equals(uri);
}
public boolean isElementAssignableTo(XMLElement elem, Class possibleSuperclass)
throws UnableToCompleteException {
JClassType classType = oracle.findType(possibleSuperclass.getCanonicalName());
return isElementAssignableTo(elem, classType);
}
public boolean isElementAssignableTo(XMLElement elem, JClassType possibleSupertype)
throws UnableToCompleteException {
/*
* Things like
*/
JTypeParameter typeParameter = possibleSupertype.isTypeParameter();
if (typeParameter != null) {
JClassType[] bounds = typeParameter.getBounds();
for (JClassType bound : bounds) {
if (!isElementAssignableTo(elem, bound)) {
return false;
}
}
return true;
}
/*
* Binder fields are always declared raw, so we're cheating if the
* user is playing with parameterized types. We're happy enough if the
* raw types match, and rely on them to make sure the specific types
* really do work.
*/
JParameterizedType parameterized = possibleSupertype.isParameterized();
if (parameterized != null) {
return isElementAssignableTo(elem, parameterized.getRawType());
}
JClassType fieldtype = findFieldType(elem);
if (fieldtype == null) {
return false;
}
return fieldtype.isAssignableTo(possibleSupertype);
}
public boolean isImportedElement(XMLElement elem) {
String uri = elem.getNamespaceUri();
return uri != null && uri.startsWith(PACKAGE_URI_SCHEME);
}
/**
* Checks whether the given owner field name is a LazyDomElement or not.
*/
public boolean isOwnerFieldLazyDomElement(String fieldName) {
OwnerField ownerField = ownerClass.getUiField(fieldName);
if (ownerField == null) {
return false;
}
return lazyDomElementClass.isAssignableFrom(ownerField.getType().getRawType());
}
public boolean isRenderableElement(XMLElement elem)
throws UnableToCompleteException {
return findFieldType(elem).isAssignableTo(isRenderableClassType);
}
public boolean isWidgetElement(XMLElement elem) throws UnableToCompleteException {
return isElementAssignableTo(elem, IsWidget.class);
}
/**
* Parses the object associated with the specified element, and returns the
* name of the field (possibly private) that will hold it. The element is
* likely to make recursive calls back to this method to have its children
* parsed.
*
* @param elem the xml element to be parsed
* @return the name of the field containing the parsed widget
*/
public String parseElementToField(XMLElement elem)
throws UnableToCompleteException {
/**
* TODO(hermes,rjrjr,rdcastro): seems bad we have to run
* parseElementToFieldWriter(), get the field writer and
* then call fieldManager.convertFieldToGetter().
*
* Can't we move convertFieldToGetter() to FieldWriter?
*
* The current answer is no because convertFieldToGetter() might be called
* before a given FieldWriter is actually created.
*/
FieldWriter field = parseElementToFieldWriter(elem);
return fieldManager.convertFieldToGetter(field.getName());
}
/**
* Parses the object associated with the specified element, and returns the
* field writer that will hold it. The element is likely to make recursive
* calls back to this method to have its children parsed.
*
* @param elem the xml element to be parsed
* @return the field holder just created
*/
public FieldWriter parseElementToFieldWriter(XMLElement elem)
throws UnableToCompleteException {
if (elementParsers.isEmpty()) {
registerParsers();
}
// Get the class associated with this element.
JClassType type = findFieldType(elem);
// Declare its field.
String fieldName = declareField(type.getQualifiedSourceName(), elem);
FieldWriter field = fieldManager.lookup(fieldName);
// Push the field that will hold this widget on top of the parsedFieldStack
// to ensure that fields registered by its parsers will be noted as
// dependencies of the new widget. See registerField.
fieldManager.push(field);
// Give all the parsers a chance to generate their code.
for (ElementParser parser : getParsersForClass(type)) {
parser.parse(elem, fieldName, type, this);
}
fieldManager.pop();
return field;
}
/**
* Gives the writer the initializer to use for this field instead of the
* default GWT.create call.
*
* @throws IllegalStateException if an initializer has already been set
*/
public void setFieldInitializer(String fieldName, String factoryMethod) {
fieldManager.lookup(fieldName).setInitializer(factoryMethod);
}
/**
* Instructs the writer to initialize the field with a specific constructor
* invocation, instead of the default GWT.create call.
*
* @param fieldName the field to initialize
* @param type the type of the field
* @param args arguments to the constructor call
*/
public void setFieldInitializerAsConstructor(String fieldName,
JClassType type, String... args) {
setFieldInitializer(fieldName, formatCode("new %s(%s)",
type.getQualifiedSourceName(), asCommaSeparatedList(args)));
}
/**
* Like {@link #tokenForStringExpression}, but used for runtime expressions
* that we trust to be safe to interpret at runtime as HTML without escaping,
* like translated messages with simple formatting. Wrapped in a call to
* {@link com.google.gwt.safehtml.shared.SafeHtmlUtils#fromSafeConstant} to
* keep the expression from being escaped by the SafeHtml template.
*
* @param expression must resolve to trusted HTML string
*/
public String tokenForSafeConstant(String expression) {
if (!useSafeHtmlTemplates) {
return tokenForStringExpression(expression);
}
expression = "SafeHtmlUtils.fromSafeConstant(" + expression + ")";
htmlTemplates.noteSafeConstant(expression);
return tokenator.nextToken(expression);
}
/**
* Like {@link #tokenForStringExpression}, but used for runtime
* {@link com.google.gwt.safehtml.shared.SafeHtml SafeHtml} instances.
*
* @param expression must resolve to SafeHtml object
*/
public String tokenForSafeHtmlExpression(String expression) {
if (!useSafeHtmlTemplates) {
return tokenForStringExpression(expression + ".asString()");
}
htmlTemplates.noteSafeConstant(expression);
return tokenator.nextToken(expression);
}
/**
* Returns a string token that can be used in place the given expression
* inside any string literals. Before the generated code is written, the
* expression will be stitched back into the generated code in place of the
* token, surrounded by plus signs. This is useful in strings to be handed to
* setInnerHTML() and setText() calls, to allow a unique dom id attribute or
* other runtime expression in the string.
*
* @param expression must resolve to String
*/
public String tokenForStringExpression(String expression) {
return tokenator.nextToken(("\" + " + expression + " + \""));
}
public boolean useLazyWidgetBuilders() {
return useLazyWidgetBuilders;
}
/**
* @return true of SafeHtml integration is in effect
*/
public boolean useSafeHtmlTemplates() {
return useSafeHtmlTemplates;
}
/**
* Post a warning message.
*/
public void warn(String message) {
logger.warn(message);
}
/**
* Post a warning message.
*/
public void warn(String message, Object... params) {
logger.warn(message, params);
}
/**
* Post a warning message.
*/
public void warn(XMLElement context, String message, Object... params) {
logger.warn(context, message, params);
}
/**
* Entry point for the code generation logic. It generates the
* implementation's superstructure, and parses the root widget (leading to all
* of its children being parsed as well).
*
* @param doc TODO
*/
void parseDocument(Document doc, PrintWriter printWriter)
throws UnableToCompleteException {
JClassType uiBinderClass = getOracle().findType(UiBinder.class.getName());
if (!baseClass.isAssignableTo(uiBinderClass)) {
die(baseClass.getName() + " must implement UiBinder");
}
Element documentElement = doc.getDocumentElement();
gwtPrefix = documentElement.lookupPrefix(binderUri);
XMLElement elem = new XMLElementProviderImpl(attributeParsers,
bundleParsers, oracle, logger, designTime).get(documentElement);
this.rendered = tokenator.detokenate(parseDocumentElement(elem));
printWriter.print(rendered);
}
private void addElementParser(String gwtClass, String parser) {
elementParsers.put(gwtClass, parser);
}
private void addWidgetParser(String className) {
String gwtClass = "com.google.gwt.user.client.ui." + className;
String parser = "com.sencha.gwt.uibinder.elementparsers." + className
+ "Parser";
addElementParser(gwtClass, parser);
}
/**
* Outputs a bundle resource for a given bundle attribute parser.
*/
private String declareStaticField(BundleAttributeParser parser) {
if (!parser.isBundleStatic()) {
return null;
}
String fullBundleClassName = parser.fullBundleClassName();
StringBuilder b = new StringBuilder();
b.append("static ").append(fullBundleClassName).append(" ").append(
parser.bundleInstance()).append(" = GWT.create(").append(
fullBundleClassName).append(".class);");
return b.toString();
}
/**
* Ensures that all of the internal data structures are cleaned up correctly
* at the end of parsing the document.
*
* @throws IllegalStateException
*/
private void ensureAttachmentCleanedUp() {
if (!attachSectionElements.isEmpty()) {
throw new IllegalStateException("Attachments not cleaned up: "
+ attachSectionElements);
}
if (!detachStatementsStack.isEmpty()) {
throw new IllegalStateException("Detach not cleaned up: "
+ detachStatementsStack);
}
}
/**
* Evaluate whether all @UiField attributes are also defined in the
* template. Dies if not.
*/
private void evaluateUiFields() throws UnableToCompleteException {
if (designTime.isDesignTime()) {
return;
}
for (OwnerField ownerField : getOwnerClass().getUiFields()) {
String fieldName = ownerField.getName();
FieldWriter fieldWriter = fieldManager.lookup(fieldName);
if (fieldWriter == null) {
die("Template %s has no %s attribute for %s.%s#%s", templatePath,
getUiFieldAttributeName(), uiOwnerType.getPackage().getName(),
uiOwnerType.getName(), fieldName);
}
}
}
/**
* Given a DOM tag name, return the corresponding JSO subclass.
*/
private JClassType findDomElementTypeForTag(String tag) {
JClassType elementClass = oracle.findType("com.google.gwt.dom.client.Element");
JClassType[] types = elementClass.getSubtypes();
for (JClassType type : types) {
TagName annotation = type.getAnnotation(TagName.class);
if (annotation != null) {
for (String annotationTag : annotation.value()) {
if (annotationTag.equals(tag)) {
return type;
}
}
}
}
return elementClass;
}
/**
* Use this method to format code. It forces the use of the en-US locale, so
* that things like decimal format don't get mangled.
*/
private String formatCode(String format, Object... params) {
String r = String.format(Locale.US, format, params);
return r;
}
/**
* Inspects this element for a gwt:field attribute. If one is found, the
* attribute is consumed and its value returned.
*
* @return The field name declared by an element, or null if none is declared
*/
private String getFieldName(XMLElement elem) throws UnableToCompleteException {
String fieldName = null;
boolean hasOldSchoolId = false;
if (elem.hasAttribute("id") && isWidgetElement(elem)) {
hasOldSchoolId = true;
// If an id is specified on the element, use that.
fieldName = elem.consumeRawAttribute("id");
warn(elem, "Deprecated use of id=\"%1$s\" for field name. "
+ "Please switch to gwt:field=\"%1$s\" instead. "
+ "This will soon be a compile error!", fieldName);
}
if (elem.hasAttribute(getUiFieldAttributeName())) {
if (hasOldSchoolId) {
die(elem, "Cannot declare both id and field on the same element");
}
fieldName = elem.consumeRawAttribute(getUiFieldAttributeName());
}
return fieldName;
}
private Class getParserForClass(JClassType uiClass) {
// Find the associated parser.
String uiClassName = uiClass.getQualifiedSourceName();
String parserClassName = elementParsers.get(uiClassName);
if (parserClassName == null) {
return null;
}
// And instantiate it.
try {
return Class.forName(parserClassName).asSubclass(ElementParser.class);
} catch (ClassNotFoundException e) {
throw new RuntimeException("Unable to instantiate parser", e);
} catch (ClassCastException e) {
throw new RuntimeException(parserClassName + " must extend ElementParser");
}
}
/**
* Find a set of element parsers for the given ui type.
*
* The list of parsers will be returned in order from most- to least-specific.
*/
private Iterable getParsersForClass(JClassType type) {
List parsers = new ArrayList();
/*
* Let this non-widget parser go first (it finds ownerFields = getOwnerClass().getUiFields();
for (OwnerField ownerField : ownerFields) {
if (ownerField.isProvided()) {
String fieldName = ownerField.getName();
FieldWriter fieldWriter = fieldManager.lookup(fieldName);
// TODO why can this be null?
if (fieldWriter != null) {
String initializer;
if (designTime.isDesignTime()) {
String typeName = ownerField.getType().getRawType().getQualifiedSourceName();
initializer = designTime.getProvidedField(typeName,
ownerField.getName());
} else {
initializer = formatCode("owner.%1$s", fieldName);
}
fieldManager.lookup(fieldName).setInitializer(initializer);
}
}
}
// Write gwt field declarations.
fieldManager.writeGwtFieldsDeclaration(niceWriter, uiOwnerType.getName());
}
private void writeHandlers(IndentedWriter w) throws UnableToCompleteException {
if (designTime.isDesignTime()) {
return;
}
handlerEvaluator.run(w, fieldManager, "owner");
}
private void writeImports(IndentedWriter w) {
w.write("import com.google.gwt.core.client.GWT;");
w.write("import com.google.gwt.dom.client.Element;");
if (!(htmlTemplates.isEmpty())) {
w.write("import com.google.gwt.safehtml.client.SafeHtmlTemplates;");
w.write("import com.google.gwt.safehtml.shared.SafeHtml;");
w.write("import com.google.gwt.safehtml.shared.SafeHtmlUtils;");
}
w.write("import com.google.gwt.uibinder.client.UiBinder;");
w.write("import com.google.gwt.uibinder.client.UiBinderUtil;");
w.write("import %s.%s;", uiRootType.getPackage().getName(),
uiRootType.getName());
}
/**
* Write statements created by {@link #addInitStatement}. This code must be
* placed after all instantiation code.
*/
private void writeInitStatements(IndentedWriter niceWriter) {
for (String s : initStatements) {
niceWriter.write(s);
}
}
/**
* Write the statements to fill in the fields of the UI owner.
*/
private void writeOwnerFieldSetters(IndentedWriter niceWriter)
throws UnableToCompleteException {
if (designTime.isDesignTime()) {
return;
}
for (OwnerField ownerField : getOwnerClass().getUiFields()) {
String fieldName = ownerField.getName();
FieldWriter fieldWriter = fieldManager.lookup(fieldName);
BundleAttributeParser bundleParser = bundleParsers.get(ownerField.getType());
if (bundleParser != null) {
// ownerField is a bundle resource.
maybeWriteFieldSetter(niceWriter, ownerField,
bundleParser.bundleClass(), bundleParser.bundleInstance());
} else if (fieldWriter != null) {
// ownerField is a widget.
JClassType type = fieldWriter.getInstantiableType();
if (type != null) {
maybeWriteFieldSetter(niceWriter, ownerField,
fieldWriter.getInstantiableType(), fieldName);
} else {
// Must be a generated type
if (!ownerField.isProvided()) {
niceWriter.write("owner.%1$s = %1$s;", fieldName);
}
}
} else {
// ownerField was not found as bundle resource or widget, must die.
die("Template %s has no %s attribute for %s.%s#%s", templatePath,
getUiFieldAttributeName(), uiOwnerType.getPackage().getName(),
uiOwnerType.getName(), fieldName);
}
}
}
private void writePackage(IndentedWriter w) {
String packageName = baseClass.getPackage().getName();
if (packageName.length() > 0) {
w.write("package %1$s;", packageName);
w.newline();
}
}
/**
* Write statements created by {@link HtmlTemplates#addSafeHtmlTemplate}. This
* code must be placed after all instantiation code.
*/
private void writeSafeHtmlTemplates(IndentedWriter w) {
if (!(htmlTemplates.isEmpty())) {
assert useSafeHtmlTemplates : "SafeHtml is off, but templates were made.";
w.write("interface Template extends SafeHtmlTemplates {");
w.indent();
htmlTemplates.writeTemplates(w);
w.outdent();
w.write("}");
w.newline();
w.write("Template template = GWT.create(Template.class);");
w.newline();
}
}
/**
* Generates instances of any bundle classes that have been referenced by a
* namespace entry in the top level element. This must be called *after* all
* parsing is through, as the bundle list is generated lazily as dom elements
* are parsed.
*/
private void writeStaticBundleInstances(IndentedWriter niceWriter) {
// TODO(rjrjr) It seems bad that this method has special
// knowledge of BundleAttributeParser, but that'll die soon so...
Map bpMap = bundleParsers.getMap();
for (String key : bpMap.keySet()) {
String declaration = declareStaticField(bpMap.get(key));
if (declaration != null) {
niceWriter.write(declaration);
}
}
}
private void writeStaticMessagesInstance(IndentedWriter niceWriter) {
if (messages.hasMessages()) {
niceWriter.write(messages.getDeclaration());
}
}
private void writeStatics(IndentedWriter w) {
writeStaticMessagesInstance(w);
writeStaticBundleInstances(w);
designTime.addDeclarations(w);
}
}