scripts.htmleventgenerator.HtmlEventGenerator Class Reference

Inheritance diagram for scripts.htmleventgenerator.HtmlEventGenerator:

Public Member Functions
def	__init__ (self, database, renamer, metadata, template_loader)
def	EmitStreamProviders (self, interface, custom_events, members_emitter, library_name)
def	EmitStreamGetters (self, interface, custom_events, members_emitter, library_name, stream_getter_signatures_emitter=None, element_stream_getters_emitter=None)
def	GetEvents (self, interface, custom_events)

Detailed Description

Definition at line 277 of file htmleventgenerator.py.

Constructor & Destructor Documentation

__init__()

def scripts.htmleventgenerator.HtmlEventGenerator.__init__	(		self,
			database,
			renamer,
			metadata,
			template_loader
	)

Definition at line 279 of file htmleventgenerator.py.

    def __init__(self, database, renamer, metadata, template_loader):
        self._event_classes = set()
        self._database = database
        self._renamer = renamer
        self._metadata = metadata
        self._template_loader = template_loader
        self._media_events = None
 

Member Function Documentation

EmitStreamGetters()

def scripts.htmleventgenerator.HtmlEventGenerator.EmitStreamGetters	(		self,
			interface,
			custom_events,
			members_emitter,
			library_name,
			stream_getter_signatures_emitter = None,
			element_stream_getters_emitter = None
	)

Definition at line 316 of file htmleventgenerator.py.

                          element_stream_getters_emitter=None):
 
        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:])
            annotation_name = 'on' + dom_name
 
            # 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 = self._metadata.GetFormattedMetadata(
                library_name, interface, annotation_name, '  ')
 
            isElement = False
            for parent in self._database.Hierarchy(interface):
                if parent.id == 'Element':
                    isElement = True
            # We add the same event stream getters Element, ElementList, and
            # _FrozenElementList. So, in impl_Element.darttemplate, we have two
            # additional emitters to add the correct variation of the stream getter
            # for that context.
            for emitter in [
                    members_emitter, stream_getter_signatures_emitter,
                    element_stream_getters_emitter
            ]:
                if emitter == None:
                    continue
                elem_type = 'Element' if isElement else ''
                call_name = 'forElement' if isElement else 'forTarget'
                if emitter == element_stream_getters_emitter:
                    call_name = '_forElementList'
                emitter.Emit(
                    "\n"
                    "  $(ANNOTATIONS)$(ELEM_TYPE)Stream<$TYPE> get $(NAME)$BODY;\n",
                    ANNOTATIONS=annotations,
                    ELEM_TYPE=elem_type,
                    NAME=getter_name,
                    BODY=('' if emitter == stream_getter_signatures_emitter else
                          ' => %s.%s(this)' % ((
                              ('' if emitter != element_stream_getters_emitter
                               else 'Element.') + provider), call_name)),
                    TYPE=event_type)
 

EmitStreamProviders()

def scripts.htmleventgenerator.HtmlEventGenerator.EmitStreamProviders	(		self,
			interface,
			custom_events,
			members_emitter,
			library_name
	)

Definition at line 287 of file htmleventgenerator.py.

                            library_name):
 
        events = self.GetEvents(interface, custom_events)
        if not events:
            return
 
        for event_info in events:
            (dom_name, html_name, event_type) = event_info
            annotation_name = dom_name + 'Event'
 
            # If we're using a different provider, then don't declare one.
            if self._GetEventRedirection(interface, html_name, event_type):
                continue
 
            annotations = self._metadata.FormatMetadata(
                self._metadata.GetMetadata(library_name, interface,
                                           annotation_name, 'on' + dom_name),
                '  ')
 
            members_emitter.Emit(
                "\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)
 

GetEvents()

def scripts.htmleventgenerator.HtmlEventGenerator.GetEvents	(		self,
			interface,
			custom_events
	)

 Gets a list of all of the events for the specified interface.

Definition at line 389 of file htmleventgenerator.py.

    def GetEvents(self, interface, custom_events):
        """ Gets a list of all of the events for the specified interface.
    """
        html_interface_name = interface.doc_js_name
 
        events = self._GetRawEvents(interface)
 
        if html_interface_name in _html_manual_events:
            events.update(_html_manual_events[html_interface_name])
 
        if not events and interface.id not in _html_explicit_event_classes:
            return None
 
        dom_event_names = set()
        for event in events:
            dom_name = event[2:]
            dom_name = _on_attribute_to_event_name_mapping.get(
                dom_name, dom_name)
            dom_event_names.add(dom_name)
 
        events = []
        for dom_name in sorted(dom_event_names):
            event_info = self._FindEventInfo(html_interface_name, dom_name)
            if not event_info:
                continue
 
            (html_name, event_type) = event_info
            if self._IsEventSuppressed(interface, html_name, event_type):
                continue
 
            full_event_name = '%sEvents.%s' % (html_interface_name, html_name)
            if not full_event_name in custom_events:
                events.append((dom_name, html_name, event_type))
        return events
 

---

The documentation for this class was generated from the following file:

• third_party/dart-lang/sdk/tools/dom/scripts/htmleventgenerator.py