tools/json_schema_compiler/js_externs_generator.py - Issue 1488773003: Add js_interface_generator for generating extensions interfaces

Unified Diff: tools/json_schema_compiler/js_externs_generator.py

Issue 1488773003: Add js_interface_generator for generating extensions interfaces (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master

Patch Set: Rebase + shorten line Created 5 years ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

« tools/json_schema_compiler/code.py ('K') | « tools/json_schema_compiler/compiler.py ('k') | tools/json_schema_compiler/js_externs_generator_test.py » ('j') | tools/json_schema_compiler/js_externs_generator_test.py » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: tools/json_schema_compiler/js_externs_generator.py

diff --git a/tools/json_schema_compiler/js_externs_generator.py b/tools/json_schema_compiler/js_externs_generator.py

index 20796e9be56895efb7ed5591fac1abd179dee332..e1dfcf2869dfa78b4fbb089ddfc0f7514a1d36a4 100644

--- a/tools/json_schema_compiler/js_externs_generator.py

+++ b/tools/json_schema_compiler/js_externs_generator.py

@@ -9,22 +9,15 @@ See https://developers.google.com/closure/compiler/docs/api-tutorial3#externs

"""

from code import Code

+from js_util import JsUtil

from model import *

from schema_util import *

import os

import sys

-from datetime import datetime

import re

-// Use of this source code is governed by a BSD-style license that can be

-// found in the LICENSE file.

-""" % datetime.now().year)

-INFO = """// This file was generated by:

-// %s.

-// NOTE: The format of types has changed. 'FooType' is now

+NOTE = """// NOTE: The format of types has changed. 'FooType' is now

// 'chrome.%s.FooType'.

// Please run the closure compiler before committing changes.

// See https://code.google.com/p/chromium/wiki/ClosureCompilation.

@@ -37,18 +30,14 @@ class JsExternsGenerator(object):

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(LICENSE)

- .Append()

- .Append(INFO % (sys.argv[0], self._namespace.name))

- .Append()

- .Append('/** @fileoverview Externs generated from namespace: %s */' %

- self._namespace.name)

- .Append())

+ (c.Append(self._GetHeader(sys.argv[0], self._namespace.name))

+ .Append())

c.Cblock(self._GenerateNamespaceObject())

@@ -61,8 +50,19 @@ class _Generator(object):

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.

"""

@@ -80,7 +80,8 @@ class _Generator(object):

c = Code()

(c.Sblock(line='/**', line_prefix=' * ')

.Append('@enum {string}')

- .Append(self._GenerateSeeLink('type', js_type.simple_name))

+ .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))

@@ -127,7 +128,8 @@ class _Generator(object):

else:

c.Concat(self._GenerateTypedef(js_type.properties))

- c.Append(self._GenerateSeeLink('type', js_type.simple_name))

+ 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)

@@ -144,130 +146,12 @@ class _Generator(object):

c = Code()

c.Append('@typedef {')

- c.Concat(self._GenerateObjectDefinition(properties), new_line=False)

+ c.Concat(self._js_util.GenerateObjectDefinition(self._namespace.name,

+ properties),

+ new_line=False)

c.Append('}', new_line=False)

return c

- def _GenerateObjectDefinition(self, properties):

- """Given an OrderedDict of properties, returns a Code containing the

- description of an object.

- """

- if not properties: return Code()

- c = Code()

- c.Sblock('{')

- first = True

- for field, prop in properties.items():

- # Avoid trailing comma.

- # TODO(devlin): This will be unneeded, if/when

- # https://github.com/google/closure-compiler/issues/796 is fixed.

- if not first:

- c.Append(',', new_line=False)

- first = False

- js_type = self._TypeToJsType(prop.type_)

- if prop.optional:

- js_type = (Code().

- Append('(').

- Concat(js_type, new_line=False).

- Append('|undefined)', new_line=False))

- c.Append('%s: ' % field, strip_right=False)

- c.Concat(js_type, new_line=False)

- c.Eblock('}')

- return c

- def _GenerateFunctionJsDoc(self, function):

- """Generates the documentation for a function as a Code.

- Returns an empty code object if the object has no documentation.

- """

- c = Code()

- c.Sblock(line='/**', line_prefix=' * ')

- if function.description:

- c.Comment(function.description, comment_prefix='')

- def append_field(c, tag, js_type, name, optional, description):

- c.Append('@%s {' % tag)

- c.Concat(js_type, new_line=False)

- if optional:

- c.Append('=', new_line=False)

- c.Append('} %s' % name, new_line=False)

- if description:

- c.Comment(' %s' % description, comment_prefix='',

- wrap_indent=4, new_line=False)

- for param in function.params:

- append_field(c, 'param', self._TypeToJsType(param.type_), param.name,

- param.optional, param.description)

- if function.callback:

- append_field(c, 'param', self._FunctionToJsFunction(function.callback),

- function.callback.name, function.callback.optional,

- function.callback.description)

- if function.returns:

- append_field(c, 'return', self._TypeToJsType(function.returns),

- '', False, function.returns.description)

- if function.deprecated:

- c.Append('@deprecated %s' % function.deprecated)

- c.Append(self._GenerateSeeLink('method', function.name))

- c.Eblock(' */')

- return c

- def _FunctionToJsFunction(self, function):

- """Converts a model.Function to a JS type (i.e., function([params])...)"""

- c = Code()

- c.Append('function(')

- for i, param in enumerate(function.params):

- c.Concat(self._TypeToJsType(param.type_), new_line=False)

- if i is not len(function.params) - 1:

- c.Append(', ', new_line=False, strip_right=False)

- c.Append('):', new_line=False)

- if function.returns:

- c.Concat(self._TypeToJsType(function.returns), new_line=False)

- else:

- c.Append('void', new_line=False)

- return c

- def _TypeToJsType(self, js_type):

- """Converts a model.Type to a JS type (number, Array, etc.)"""

- if js_type.property_type in (PropertyType.INTEGER, PropertyType.DOUBLE):

- return Code().Append('number')

- if js_type.property_type is PropertyType.OBJECT:

- if js_type.properties:

- return self._GenerateObjectDefinition(js_type.properties)

- return Code().Append('Object')

- if js_type.property_type is PropertyType.ARRAY:

- return (Code().Append('!Array<').

- Concat(self._TypeToJsType(js_type.item_type), new_line=False).

- Append('>', new_line=False))

- if js_type.property_type is PropertyType.REF:

- ref_type = '!chrome.%s.%s' % (self._namespace.name, js_type.ref_type)

- return Code().Append(ref_type)

- if js_type.property_type is PropertyType.CHOICES:

- c = Code()

- c.Append('(')

- for i, choice in enumerate(js_type.choices):

- c.Concat(self._TypeToJsType(choice), new_line=False)

- if i is not len(js_type.choices) - 1:

- c.Append('|', new_line=False)

- c.Append(')', new_line=False)

- return c

- if js_type.property_type is PropertyType.FUNCTION:

- return self._FunctionToJsFunction(js_type.function)

- if js_type.property_type is PropertyType.ANY:

- return Code().Append('*')

- if js_type.property_type.is_fundamental:

- return Code().Append(js_type.property_type.name)

- return Code().Append('?') # TODO(tbreisacher): Make this more specific.

def _GenerateFunction(self, function):

"""Generates the code representing a function, including its documentation.

For example:

@@ -279,7 +163,8 @@ class _Generator(object):

"""

c = Code()

params = self._GenerateFunctionParams(function)

- (c.Concat(self._GenerateFunctionJsDoc(function))

+ (c.Concat(self._js_util.GenerateFunctionJsDoc(self._namespace.name,

+ function))

.Append('chrome.%s.%s = function(%s) {};' % (self._namespace.name,

function.name,

params))

@@ -298,7 +183,8 @@ class _Generator(object):

if (event.description):

c.Comment(event.description, comment_prefix='')

c.Append('@type {!ChromeEvent}')

- c.Append(self._GenerateSeeLink('event', event.name))

+ 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

@@ -324,15 +210,3 @@ class _Generator(object):

if function.callback:

params.append(function.callback)

return ', '.join(param.name for param in params)

- def _GenerateSeeLink(self, object_type, object_name):

- """Generates a @see link for a given API 'object' (type, method, or event).

- """

- # NOTE(devlin): This is kind of a hack. Some APIs will be hosted on

- # developer.chrome.com/apps/ instead of /extensions/, and some APIs have

- # '.'s in them (like app.window), which should resolve to 'app_window'.

- # Luckily, the doc server has excellent url resolution, and knows exactly

- # what we mean. This saves us from needing any complicated logic here.

- return ('@see https://developer.chrome.com/extensions/%s#%s-%s' %

- (self._namespace.name, object_type, object_name))