Adding annotations to event streams.

tools/dom/scripts/htmleventgenerator.py

 #!/usr/bin/python
 # 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.
 
 """This module provides functionality to generate dart:html event classes."""
 
 import logging
+from generator import FindCommonAnnotations, FormatAnnotations
 
 _logger = logging.getLogger('dartgenerator')
 
 # Events without onEventName attributes in the  IDL we want to support.
 # We can automatically extract most event names by checking for
 # onEventName methods in the IDL but some events aren't listed so we need
 # to manually add them here so that they are easy for users to find.
 _html_manual_events = {
   'Element': ['touchleave', 'touchenter', 'webkitTransitionEnd'],
   'Window': ['DOMContentLoaded']
@@ skipping 367 matching lines @@
     if not events:
       return
 
     for event_info in events:
       (dom_name, html_name, event_type) = event_info
 
       # If we're using a different provider, then don't declare one.
       if self._GetEventRedirection(interface, html_name, event_type):
         continue
 
+      annotations = FormatAnnotations(
+          FindCommonAnnotations(interface.id, dom_name), '  ')
+
       members_emitter.Emit(
           "\n"
-          "  static const EventStreamProvider<$TYPE> $(NAME)Event = "
-          "const EventStreamProvider<$TYPE>('$DOM_NAME');\n",
+          "  $(ANNOTATIONS)static const EventStreamProvider<$TYPE> "
+          "$(NAME)Event = const EventStreamProvider<$TYPE>('$DOM_NAME');\n",
+          ANNOTATIONS=annotations,
           NAME=html_name,
           DOM_NAME=dom_name,
           TYPE=event_type)
 
   def EmitStreamGetters(self, interface, custom_events,
       members_emitter):
     events = self._GetEvents(interface, custom_events)
     if not events:
       return
 
     for event_info in events:
       (dom_name, html_name, event_type) = event_info
       getter_name = 'on%s%s' % (html_name[:1].upper(), html_name[1:])
 
       # If the provider is declared elsewhere, point to that.
       redirection = self._GetEventRedirection(interface, html_name, event_type)
       if redirection:
         provider = '%s.%sEvent' % (redirection, html_name)
       else:
         provider = html_name + 'Event'
 
+      annotations = FormatAnnotations(
+          FindCommonAnnotations(interface.id, dom_name), '  ')
+
       members_emitter.Emit(
           "\n"
-          "  Stream<$TYPE> get $(NAME) => $PROVIDER.forTarget(this);\n",
+          "  $(ANNOTATIONS)Stream<$TYPE> get $(NAME) => "
+          "$PROVIDER.forTarget(this);\n",
+          ANNOTATIONS=annotations,
           NAME=getter_name,
           PROVIDER=provider,
           TYPE=event_type)
 
   def _GetEvents(self, interface, custom_events):
     """ Gets a list of all of the events for the specified interface.
     """
     events = set([attr for attr in interface.attributes
                   if attr.type.id == 'EventListener'])
     if not events and interface.id not in _html_explicit_event_classes:
@@ skipping 141 matching lines @@
     parent_events_class_name = 'Events'
     interfaces_with_events = set()
     for parent in self._database.Hierarchy(interface):
       if parent != interface and parent.id in self._event_classes:
         parent_name = self._renamer.RenameInterface(parent)
         parent_events_class_name = parent_name + 'Events'
         interfaces_with_events.add(parent)
     if len(interfaces_with_events) > 1:
       raise Exception('Only one parent event class allowed ' + interface.id)
     return parent_events_class_name