scripts.prototype_htmleventgenerator.Prototype_HtmlEventGenerator Class Reference

Inheritance diagram for scripts.prototype_htmleventgenerator.Prototype_HtmlEventGenerator:

Public Member Functions
	__init__ (self, database, renamer, metadata, htmleventgenerator)
	CollectStreamProviders (self, interface, custom_events, library_name)
	CollectStreamGetters (self, interface, custom_events, library_name)
	WriteFile (self, dart_bin)

Protected Member Functions
	_isElement (self, interface)
	_formatEventType (self, event_type)
	_writeProviders (self, output_file)
	_writeEventGetters (self, output_file)

Protected Attributes
	_database
	_renamer
	_metadata
	_html_event_generator
	_all_event_providers
	_all_event_getters

Detailed Description

Definition at line 34 of file prototype_htmleventgenerator.py.

Constructor & Destructor Documentation

__init__()

scripts.prototype_htmleventgenerator.Prototype_HtmlEventGenerator.__init__	(		self,
			database,
			renamer,
			metadata,
			htmleventgenerator
	)

Definition at line 36 of file prototype_htmleventgenerator.py.

    def __init__(self, database, renamer, metadata, htmleventgenerator):
        self._database = database
        self._renamer = renamer
        self._metadata = metadata
        self._html_event_generator = htmleventgenerator
        self._all_event_providers = {}
        self._all_event_getters = {}
 

Member Function Documentation

_formatEventType()

scripts.prototype_htmleventgenerator.Prototype_HtmlEventGenerator._formatEventType (   self,   event_type  )

protected

Definition at line 111 of file prototype_htmleventgenerator.py.

    def _formatEventType(self, event_type):
        if '.' in event_type:
            event_type = event_type[event_type.index('.') + 1:]
        return event_type
 

_isElement()

scripts.prototype_htmleventgenerator.Prototype_HtmlEventGenerator._isElement (   self,   interface  )

protected

Definition at line 104 of file prototype_htmleventgenerator.py.

    def _isElement(self, interface):
        for parent in self._database.Hierarchy(interface):
            if parent.id == 'Element':
                return True
        return False
 

_writeEventGetters()

scripts.prototype_htmleventgenerator.Prototype_HtmlEventGenerator._writeEventGetters (   self,   output_file  )

protected

Definition at line 157 of file prototype_htmleventgenerator.py.

    def _writeEventGetters(self, output_file):
        for interface, events in self._all_event_getters.items():
            isElement = self._isElement(interface)
            interface_name = interface.doc_js_name
            if interface_name in _deprecated_event_interfaces:
                continue
            interface_name = self._renamer.RenameInterface(interface)
            interface_prefix = ('html' if interface_name not in _non_html_types
                                else _non_html_types[interface_name])
            output_file.write("""
 
/// Additional Event getters for [%s].
extension %sEventGetters on %s.%s {
""" % (interface_name, interface_name, interface_prefix, interface_name))
            for getter_name, info in sorted(events.items()):
                (annotations, event_type, provider) = info
                if event_type in _deprecated_event_types:
                    continue
                event_prefix = ('html' if event_type not in _non_html_types else
                                _non_html_types[event_type])
                output_file.write("""
%s
%sStream<%s.%s> get %s => EventStreamProviders.%s.%s(this);
""" % (annotations, 'Element' if isElement else '', event_prefix, event_type,
                getter_name, provider, 'forElement' if isElement else 'forTarget'))
            output_file.write("""\n}\n""")

_writeProviders()

scripts.prototype_htmleventgenerator.Prototype_HtmlEventGenerator._writeProviders (   self,   output_file  )

protected

Definition at line 138 of file prototype_htmleventgenerator.py.

    def _writeProviders(self, output_file):
        output_file.write("""
/// Statically accessible `EventStreamProvider`s for all event types.
class EventStreamProviders {
""")
        for html_name, info in sorted(self._all_event_providers.items()):
            (annotations, dom_name, event_type) = info
            if event_type in _deprecated_event_types:
                continue
            event_prefix = ('html' if event_type not in _non_html_types else
                            _non_html_types[event_type])
            output_file.write("""
  %sstatic const EventStreamProvider<%s.%s> %sEvent = 
  const EventStreamProvider<%s.%s>('%s');
""" % (annotations, event_prefix, event_type, html_name, event_prefix,
            event_type, dom_name))
        output_file.write("""\n}\n""")
 

CollectStreamGetters()

scripts.prototype_htmleventgenerator.Prototype_HtmlEventGenerator.CollectStreamGetters	(		self,
			interface,
			custom_events,
			library_name
	)

Definition at line 74 of file prototype_htmleventgenerator.py.

    def CollectStreamGetters(self, interface, custom_events, library_name):
        events = self._html_event_generator.GetEvents(interface, custom_events)
        if not events:
            return
        interface_events = {}
        for event_info in events:
            (dom_name, html_name, event_type) = event_info
            # Skip custom events that are added to glue code separately
            if html_name in _custom_events:
                continue
            getter_name = 'on%s%s' % (html_name[:1].upper(), html_name[1:])
            annotation_name = 'on' + dom_name
 
            annotations = self._metadata.GetFormattedMetadata(
                library_name, interface, annotation_name, '  ')
 
            # Strip comment from annotations
            if '///' in annotations:
                annotations = annotations[annotations.index('\n') + 1:]
 
            event_type = self._formatEventType(event_type)
            html_name = (html_name if html_name not in _type_specific_events
                         else html_name + interface.doc_js_name)
            provider = html_name + 'Event'
 
            interface_events.update(
                {getter_name: [annotations, event_type, provider]})
        self._all_event_getters.update({interface: interface_events})
 

CollectStreamProviders()

scripts.prototype_htmleventgenerator.Prototype_HtmlEventGenerator.CollectStreamProviders	(		self,
			interface,
			custom_events,
			library_name
	)

Definition at line 45 of file prototype_htmleventgenerator.py.

    def CollectStreamProviders(self, interface, custom_events, library_name):
 
        events = self._html_event_generator.GetEvents(interface, custom_events)
        if not events:
            return
 
        for event_info in events:
            (dom_name, html_name, event_type) = event_info
            # Skip custom events that are added to glue code separately
            if html_name in _custom_events:
                continue
            annotation_name = dom_name + 'Event'
 
            annotations = self._metadata.FormatMetadata(
                self._metadata.GetMetadata(library_name, interface,
                                           annotation_name, 'on' + dom_name),
                '  ')
 
            # Strip comment from annotations
            if '/**' in annotations:
                annotations = annotations[annotations.index('*/') + 2:]
            event_type = self._formatEventType(event_type)
            html_name = (html_name if html_name not in _type_specific_events
                         else html_name + interface.doc_js_name)
 
            self._all_event_providers.update(
                {html_name: [annotations, dom_name, event_type]})
 

WriteFile()

scripts.prototype_htmleventgenerator.Prototype_HtmlEventGenerator.WriteFile	(		self,
			dart_bin
	)

Definition at line 117 of file prototype_htmleventgenerator.py.

    def WriteFile(self, dart_bin):
        output_file = open(OUTPUT_FILE, 'w')
        output_file.write("""
/// Exposing the Streams of events for legacy dart:html.
library dart.html_events;
 
import 'dart:html' as html;
import 'dart:html_common';
import 'dart:indexed_db' as indexed_db;
import 'dart:event_stream' show ElementStream, EventStreamProvider;
import 'dart:svg' as svg;
import 'dart:web_gl' as web_gl;
 
""")
        self._writeProviders(output_file)
        self._writeEventGetters(output_file)
        output_file.close()
        formatCommand = ' '.join([dart_bin, 'format', OUTPUT_FILE])
        subprocess.call([formatCommand], shell=True)
 

Member Data Documentation

_all_event_getters

scripts.prototype_htmleventgenerator.Prototype_HtmlEventGenerator._all_event_getters

protected

Definition at line 42 of file prototype_htmleventgenerator.py.

_all_event_providers

scripts.prototype_htmleventgenerator.Prototype_HtmlEventGenerator._all_event_providers

protected

Definition at line 41 of file prototype_htmleventgenerator.py.

_database

scripts.prototype_htmleventgenerator.Prototype_HtmlEventGenerator._database

protected

Definition at line 37 of file prototype_htmleventgenerator.py.

_html_event_generator

scripts.prototype_htmleventgenerator.Prototype_HtmlEventGenerator._html_event_generator

protected

Definition at line 40 of file prototype_htmleventgenerator.py.

_metadata

scripts.prototype_htmleventgenerator.Prototype_HtmlEventGenerator._metadata

protected

Definition at line 39 of file prototype_htmleventgenerator.py.

_renamer

scripts.prototype_htmleventgenerator.Prototype_HtmlEventGenerator._renamer

protected

Definition at line 38 of file prototype_htmleventgenerator.py.

---

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

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