Add location information to watchers to make them more debuggable.

lib/templating.dart

 // Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 /** Common utility functions used by code generated by the dwc compiler. */
 library templating;
 
 import 'dart:async';
 import 'dart:collection';
 import 'dart:html';
@@ skipping 129 matching lines @@
  *   * binding classes with a string:
  *
  *         bindCssClasses(e, () => "${class1 != null ? class1 : ''} "
  *                                 "${class2 != null ? class2 : ''}");
  *
  *   * binding classes separately:
  *
  *         bindCssClasses(e, () => class1);
  *         bindCssClasses(e, () => class2);
  */
-ChangeUnobserver bindCssClasses(Element elem, dynamic exp()) {
+ChangeUnobserver bindCssClasses(Element elem, dynamic exp(),
+    [String debugLocation]) {
   return watchAndInvoke(exp, (e) {
     if (e.changes != null) {
       for (var change in e.changes) changeCssClasses(elem, change);
     } else {
       updateCssClass(elem, false, e.oldValue);
       updateCssClass(elem, true, e.newValue);
     }
-  }, 'css-class-bind');
+  }, 'css-class-bind', debugLocation);
 }
 
 /** Bind the result of [exp] to the style attribute in [elem]. */
-ChangeUnobserver bindStyle(Element elem, Map<String, String> exp()) {
+ChangeUnobserver bindStyle(Element elem, Map<String, String> exp(),
+    [String debugLocation]) {
   return watchAndInvoke(exp, (e) => updateStyle(elem, e.oldValue, e.newValue),
-      'css-style-bind');
+      'css-style-bind', debugLocation);
 }
 
 /**
  * Changes the style properties from [oldValue] to [newValue]. A runtime error
  * is reported if [newValue] is not a `String` or `Map<String, String>`.
  */
 void updateStyle(Element elem, oldValue, newValue) {
   if (newValue is! String && newValue is! Map<String, String>) {
     elem.style.cssText = '';
     throw new ArgumentError("style must be a String or Map<String, String>.");
@@ skipping 67 matching lines @@
   void insert() {
     _subscription = eventStream.listen(listener);
   }
 
   void remove() {
     _subscription.cancel();
     _subscription = null;
   }
 }
 
-/** Represents a generic data binding and a corresponding action. */
-class Binding extends TemplateItem {
+/** Common logic for all bindings. */
+abstract class Binding extends TemplateItem {
   final exp;
-  final ChangeObserver action;
   final bool isFinal;
+  final String debugLocation;
   ChangeUnobserver stopper;
 
-  Binding(this.exp, this.action, this.isFinal);
+  Binding(this.exp, this.isFinal)
+      : debugLocation = verboseDebugMessages ? _readCurrentStackTrace() : null;
 
   void insert() {
     if (isFinal) {
-      action(new ChangeNotification(null, exp()));
+      invokeCallback();
     } else if (stopper != null) {
       throw new StateError('binding already attached');
     } else {
-      stopper = watchAndInvoke(exp, action, 'generic-binding');
+      stopper = registerAndInvoke();
     }
   }
 
   void remove() {
     if (!isFinal) {
       stopper();
       stopper = null;
     }
   }
+
+  /** Invokes the action associated with this binding. */
+  void invokeCallback();
+
+  /**
+   * Registers the watcher and invokes the action associated with this binding.
+   */
+  ChangeUnobserver registerAndInvoke();
+}
+
+/** Represents a generic data binding and a corresponding action. */
+class GenericBinding extends Binding {
+  final ChangeObserver action;
+
+  GenericBinding(exp, this.action, bool isFinal) : super(exp, isFinal);
+
+  void invokeCallback() => action(new ChangeNotification(null, exp()));
+
+  ChangeUnobserver registerAndInvoke() =>
+      watchAndInvoke(exp, action, 'generic-binding', debugLocation);
 }
 
 /** Represents a binding to a style attribute. */
-class StyleAttrBinding extends TemplateItem {
-  final exp;
+class StyleAttrBinding extends Binding {
   final Element elem;
-  final bool isFinal;
-  ChangeUnobserver stopper;
 
-  StyleAttrBinding(this.elem, this.exp, this.isFinal);
+  StyleAttrBinding(this.elem, exp, bool isFinal) : super(exp, isFinal);
 
-  void insert() {
-    if (isFinal) {
-      updateStyle(elem, null, exp());
-    } else if (stopper != null) {
-      throw new StateError('style binding already attached');
-    } else {
-      stopper = bindStyle(elem, exp);
-    }
-  }
+  void invokeCallback() => updateStyle(elem, null, exp());
 
-  void remove() {
-    if (!isFinal) {
-      stopper();
-      stopper = null;
-    }
-  }
+  ChangeUnobserver registerAndInvoke() => bindStyle(elem, exp, debugLocation);
 }
 
 /** Represents a binding to a class attribute. */
-class ClassAttrBinding extends TemplateItem {
+class ClassAttrBinding extends Binding {
   final Element elem;
-  final exp;
-  final bool isFinal;
-  ChangeUnobserver stopper;
 
-  ClassAttrBinding(this.elem, this.exp, this.isFinal);
+  ClassAttrBinding(this.elem, exp, bool isFinal) : super(exp, isFinal);
 
-  void insert() {
-    if (isFinal) {
-      updateCssClass(elem, true, exp());
-    } else if (stopper != null) {
-      throw new StateError('class binding already attached');
-    } else {
-      stopper = bindCssClasses(elem, exp);
-    }
-  }
+  void invokeCallback() => updateCssClass(elem, true, exp());
 
-  void remove() {
-    if (!isFinal) {
-      stopper();
-      stopper = null;
-    }
-  }
+  ChangeUnobserver registerAndInvoke() =>
+      bindCssClasses(elem, exp, debugLocation);
 }
 
 /**
  * Represents a one-way binding between a dart getter expression and a DOM
  * property, or conversely between a DOM property value and a dart property.
  */
-class DomPropertyBinding extends TemplateItem {
+class DomPropertyBinding extends Binding {
   /** Value updated by this binding. */
   final Setter setter;
 
   /**
-   * Getter that reads the value of the binding, either from a Dart expression
-   * or from a DOM property (which is internally also a Dart expression).
-   */
-  final Getter getter;
-
-  /**
    * Whether this is a binding that assigns a DOM attribute accepting URL
    * values. If so, the value assigned to the attribute needs to be sanitized.
    */
   final bool isUrl;
 
-  final bool isFinal;
-
-  ChangeUnobserver stopper;
-
-  DomPropertyBinding(this.getter, this.setter, this.isUrl, this.isFinal);
+  /**
+   * Creates a DOM property binding, where [getter] reads the value of the
+   * binding, either from a Dart expression or from a DOM property (which is
+   * internally also a Dart expression).
+   */
+  DomPropertyBinding(Getter getter, this.setter, this.isUrl, bool isFinal)
+      : super(getter, isFinal);
 
   void _safeSetter(value) {
     setter(isUrl ? sanitizeUri(value) : value);
   }
+  void invokeCallback() => _safeSetter(exp());
 
-  void insert() {
-    if (isFinal) {
-      _safeSetter(getter());
-    } else if (stopper != null) {
-      throw new StateError('data binding already attached.');
-    } else {
-      stopper = watchAndInvoke(getter, (e) => _safeSetter(e.newValue),
-          'dom-property-binding');
-    }
-  }
-
-  void remove() {
-    if (!isFinal) {
-      stopper();
-      stopper = null;
-    }
-  }
+  ChangeUnobserver registerAndInvoke() =>
+      watchAndInvoke(exp, (e) => _safeSetter(e.newValue),
+          'dom-property-binding', debugLocation);
 }
 
 /** Represents a component added within a template. */
 class ComponentItem extends TemplateItem {
   /** An autogenerated component. */
   final component;
 
   ComponentItem(this.component);
 
   void create() {
@@ skipping 23 matching lines @@
 
   Template(this.node);
 
   /** Associate the event listener while this template is visible.  */
   void listen(Stream<Event> stream, EventListener listener) {
     children.add(new Listener(stream, (e) { listener(e); dispatch(); }));
   }
 
   /** Run [action] when [exp] changes (while this template is visible).  */
   void bind(exp, ChangeObserver action, bool isFinal) {
-    children.add(new Binding(exp, action, isFinal));
+    children.add(new GenericBinding(exp, action, isFinal));
   }
 
   /** Create and bind a [Node] to [exp] while this template is visible. */
   Node contentBind(Function exp, isFinal) {
     var bindNode = new Text('');
-    children.add(new Binding(() => '${exp()}', (e) {
+    children.add(new GenericBinding(() => '${exp()}', (e) {
       bindNode = updateBinding(exp(), bindNode, e.newValue);
     }, isFinal));
     return bindNode;
   }
 
   /** Bind [exp] to `elem.class` while this template is visible.  */
   void bindClass(elem, exp, isFinal) {
     children.add(new ClassAttrBinding(elem, exp, isFinal));
   }
 
@@ skipping 229 matching lines @@
     node.nodes.clear();
     nodes.clear();
   }
 
   void remove() {
     _removeInternal();
     stopper();
     stopper = null;
   }
 }
+
+String _readCurrentStackTrace() {
+  try {
+    throw "";
+  } catch (e, trace) {
+    return trace.toString();

[Jennifer Messerly, 2013/07/11 21:27:23]

use http://pub.dartlang.org/packages/stack_trace ?

[Siggi Cherem (dart-lang), 2013/07/11 22:07:01]

Oh, it used to depend on dart:io, but seems to have changed recently.

I prefer not to add the dependency here, since all of the apps would have it
then, but I made readCurrentStackTrace configurable so you can do it if you want
to while debugging. I made the test use stack_trace as an example.

+  }
+}
+