class _Generator(object): def __init__(self, namespace): self._namespace = namespace self._js_util = JsUtil() def Generate(self): """Generates a Code object with the schema for the entire namespace. """ c = Code() (c.Append(self._GetHeader(sys.argv[0], self._namespace.name)).Append()) c.Cblock(self._GenerateNamespaceObject()) for js_type in self._namespace.types.values(): c.Cblock(self._GenerateType(js_type)) for function in self._namespace.functions.values(): c.Cblock(self._GenerateFunction(function)) for event in self._namespace.events.values(): c.Cblock(self._GenerateEvent(event)) c.TrimTrailingNewlines() return c def _GetHeader(self, tool, namespace): """Returns the file header text. """ return (self._js_util.GetLicense() + '\n' + self._js_util.GetInfo(tool) + (NOTE % namespace) + '\n' + ('/** @fileoverview Externs generated from namespace: %s */' % namespace)) def _GenerateType(self, js_type): """Given a Type object, returns the Code for this type's definition. """ c = Code() if js_type.property_type is PropertyType.ENUM: c.Concat(self._GenerateEnumJsDoc(js_type)) else: c.Concat(self._GenerateTypeJsDoc(js_type)) return c def _GenerateEnumJsDoc(self, js_type): """ Given an Enum Type object, returns the Code for the enum's definition. """ c = Code() (c.Sblock(line='/**', line_prefix=' * ').Append('@enum {string}').Append( self._js_util.GenerateSeeLink( self._namespace.name, 'type', js_type.simple_name)).Eblock(' */')) c.Append('chrome.%s.%s = {' % (self._namespace.name, js_type.name)) def get_property_name(e): # Enum properties are normified to be in ALL_CAPS_STYLE. # Assume enum '1ring-rulesThemAll'. # Transform to '1ring-rules_Them_All'. e = re.sub(r'([a-z])([A-Z])', r'\1_\2', e) # Transform to '1ring_rules_Them_All'. e = re.sub(r'\W', '_', e) # Transform to '_1ring_rules_Them_All'. e = re.sub(r'^(\d)', r'_\1', e) # Transform to '_1RING_RULES_THEM_ALL'. return e.upper() c.Append('\n'.join([ " %s: '%s'," % (get_property_name(v.name), v.name) for v in js_type.enum_values ])) c.Append('};') return c def _IsTypeConstructor(self, js_type): """Returns true if the given type should be a @constructor. If this returns false, the type is a typedef. """ return any(prop.type_.property_type is PropertyType.FUNCTION for prop in js_type.properties.values()) def _GenerateTypeJsDoc(self, js_type): """Generates the documentation for a type as a Code. Returns an empty code object if the object has no documentation. """ c = Code() c.Sblock(line='/**', line_prefix=' * ') if js_type.description: for line in js_type.description.splitlines(): c.Append(line) is_constructor = self._IsTypeConstructor(js_type) if is_constructor: c.Comment('@constructor', comment_prefix=' * ', wrap_indent=4) else: c.Concat(self._GenerateTypedef(js_type.properties)) c.Append( self._js_util.GenerateSeeLink(self._namespace.name, 'type', js_type.simple_name)) c.Eblock(' */') var = 'chrome.%s.%s' % (js_type.namespace.name, js_type.simple_name) if is_constructor: var += ' = function() {}' var += ';' c.Append(var) return c def _GenerateTypedef(self, properties): """Given an OrderedDict of properties, returns a Code containing a @typedef. """ if not properties: return Code() c = Code() c.Append('@typedef {') c.Concat(self._js_util.GenerateObjectDefinition( self._namespace.name, properties), new_line=False) c.Append('}', new_line=False) return c def _GenerateFunction(self, function): """Generates the code representing a function, including its documentation. For example: /** * @param {string} title The new title. */ chrome.window.setTitle = function(title) {}; """ c = Code() params = self._GenerateFunctionParams(function) (c.Concat( self._js_util.GenerateFunctionJsDoc( self._namespace.name, function)).Append( 'chrome.%s.%s = function(%s) {};' % (self._namespace.name, function.name, params))) return c def _GenerateEvent(self, event): """Generates the code representing an event. For example: /** @type {!ChromeEvent} */ chrome.bookmarks.onChildrenReordered; """ c = Code() c.Sblock(line='/**', line_prefix=' * ') if (event.description): c.Comment(event.description, comment_prefix='') c.Append('@type {!ChromeEvent}') c.Append( self._js_util.GenerateSeeLink(self._namespace.name, 'event', event.name)) c.Eblock(' */') c.Append('chrome.%s.%s;' % (self._namespace.name, event.name)) return c def _GenerateNamespaceObject(self): """Generates the code creating namespace object. For example: /** * @const */ chrome.bookmarks = {}; """ c = Code() (c.Append("""/** * @const */""").Append('chrome.%s = {};' % self._namespace.name)) return c def _GenerateFunctionParams(self, function): params = function.params[:] if function.callback: params.append(function.callback) return ', '.join(param.name for param in params)
class _Generator(object): def __init__(self, namespace): self._namespace = namespace first = namespace.name[0].upper() rest = namespace.name[1:] self._interface = first + rest self._js_util = JsUtil() def Generate(self): """Generates a Code object with the schema for the entire namespace. """ c = Code() (c.Append(self._GetHeader(sys.argv[0], self._namespace.name)).Append()) c.Cblock(self._GenerateInterfaceObject()) c.Sblock('%s.prototype = {' % self._interface) for function in self._namespace.functions.values(): c.Cblock(self._GenerateFunction(function)) for event in self._namespace.events.values(): c.Cblock(self._GenerateEvent(event)) c.TrimTrailingNewlines() c.Eblock('};') return c def _GetHeader(self, tool, namespace): """Returns the file header text. """ return ( self._js_util.GetLicense() + '\n' + self._js_util.GetInfo(tool) + '\n' + ('/** @fileoverview Interface for %s that can be overriden. */' % namespace) + '\n' + ASSERT) def _GenerateInterfaceObject(self): """Generates the code creating the interface object. For example: /** @interface */ function SettingsPrivate() {} """ c = Code() (c.Append('/** @interface */').Append('function %s() {}' % self._interface)) return c def _GenerateFunction(self, function): """Generates the inteface for a function, including a JSDoc comment. """ c = Code() if function.deprecated: return c (c.Concat( self._js_util.GenerateFunctionJsDoc( self._namespace.name, function)).Append('%s: assertNotReached,' % (function.name))) return c def _GenerateEvent(self, event): """Generates the interface for an event. """ c = Code() c.Sblock(line='/**', line_prefix=' * ') if (event.description): c.Comment(event.description, comment_prefix='') c.Append('@type {!ChromeEvent}') c.Append( self._js_util.GenerateSeeLink(self._namespace.name, 'event', event.name)) c.Eblock(' */') c.Append('%s: new ChromeEvent(),' % (event.name)) return c