1#!/usr/bin/env python 2# Copyright (c) 2011 Google Inc. All rights reserved. 3# 4# Redistribution and use in source and binary forms, with or without 5# modification, are permitted provided that the following conditions are 6# met: 7# 8# * Redistributions of source code must retain the above copyright 9# notice, this list of conditions and the following disclaimer. 10# * Redistributions in binary form must reproduce the above 11# copyright notice, this list of conditions and the following disclaimer 12# in the documentation and/or other materials provided with the 13# distribution. 14# * Neither the name of Google Inc. nor the names of its 15# contributors may be used to endorse or promote products derived from 16# this software without specific prior written permission. 17# 18# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 30import re 31 32type_traits = { 33 "any": "*", 34 "string": "string", 35 "integer": "number", 36 "number": "number", 37 "boolean": "boolean", 38 "array": "!Array.<*>", 39 "object": "!Object", 40} 41 42ref_types = {} 43 44 45def full_qualified_type_id(domain_name, type_id): 46 if type_id.find(".") == -1: 47 return "%s.%s" % (domain_name, type_id) 48 return type_id 49 50 51def fix_camel_case(name): 52 refined = re.sub(r'-(\w)', lambda pat: pat.group(1).upper(), name) 53 refined = to_title_case(refined) 54 return re.sub(r'(?i)HTML|XML|WML|API', lambda pat: pat.group(0).upper(), refined) 55 56 57def to_title_case(name): 58 return name[:1].upper() + name[1:] 59 60 61def generate_enum(name, json): 62 enum_members = [] 63 for member in json["enum"]: 64 enum_members.append(" %s: \"%s\"" % (fix_camel_case(member), member)) 65 return "\n/** @enum {string} */\n%s = {\n%s\n};\n" % (name, (",\n".join(enum_members))) 66 67 68def param_type(domain_name, param): 69 if "type" in param: 70 if param["type"] == "array": 71 items = param["items"] 72 return "!Array.<%s>" % param_type(domain_name, items) 73 else: 74 return type_traits[param["type"]] 75 if "$ref" in param: 76 type_id = full_qualified_type_id(domain_name, param["$ref"]) 77 if type_id in ref_types: 78 return ref_types[type_id] 79 else: 80 print "Type not found: " + type_id 81 return "!! Type not found: " + type_id 82 83 84def generate_protocol_externs(output_path, input_path): 85 input_file = open(input_path, "r") 86 json_string = input_file.read() 87 json_string = json_string.replace(": true", ": True") 88 json_string = json_string.replace(": false", ": False") 89 json_api = eval(json_string)["domains"] 90 91 output_file = open(output_path, "w") 92 93 output_file.write( 94""" 95var InspectorBackend = {} 96 97var Protocol = {}; 98/** @typedef {string}*/ 99Protocol.Error; 100""") 101 102 for domain in json_api: 103 domain_name = domain["domain"] 104 if "types" in domain: 105 for type in domain["types"]: 106 type_id = full_qualified_type_id(domain_name, type["id"]) 107 ref_types[type_id] = "%sAgent.%s" % (domain_name, type["id"]) 108 109 for domain in json_api: 110 domain_name = domain["domain"] 111 112 output_file.write("\n\n/**\n * @constructor\n*/\n") 113 output_file.write("Protocol.%sAgent = function(){};\n" % domain_name) 114 115 if "commands" in domain: 116 for command in domain["commands"]: 117 output_file.write("\n/**\n") 118 params = [] 119 if ("parameters" in command): 120 for in_param in command["parameters"]: 121 if ("optional" in in_param): 122 params.append("opt_%s" % in_param["name"]) 123 output_file.write(" * @param {%s=} opt_%s\n" % (param_type(domain_name, in_param), in_param["name"])) 124 else: 125 params.append(in_param["name"]) 126 output_file.write(" * @param {%s} %s\n" % (param_type(domain_name, in_param), in_param["name"])) 127 returns = ["?Protocol.Error"] 128 if ("error" in command): 129 returns.append("%s=" % param_type(domain_name, command["error"])) 130 if ("returns" in command): 131 for out_param in command["returns"]: 132 if ("optional" in out_param): 133 returns.append("%s=" % param_type(domain_name, out_param)) 134 else: 135 returns.append("%s" % param_type(domain_name, out_param)) 136 output_file.write(" * @param {function(%s):void=} opt_callback\n" % ", ".join(returns)) 137 output_file.write(" */\n") 138 params.append("opt_callback") 139 output_file.write("Protocol.%sAgent.prototype.%s = function(%s) {}\n" % (domain_name, command["name"], ", ".join(params))) 140 output_file.write("/** @param {function(%s):void=} opt_callback */\n" % ", ".join(returns)) 141 output_file.write("Protocol.%sAgent.prototype.invoke_%s = function(obj, opt_callback) {}\n" % (domain_name, command["name"])) 142 143 output_file.write("\n\n\nvar %sAgent = new Protocol.%sAgent();\n" % (domain_name, domain_name)) 144 145 if "types" in domain: 146 for type in domain["types"]: 147 if type["type"] == "object": 148 typedef_args = [] 149 if "properties" in type: 150 for property in type["properties"]: 151 suffix = "" 152 if ("optional" in property): 153 suffix = "|undefined" 154 if "enum" in property: 155 enum_name = "%sAgent.%s%s" % (domain_name, type["id"], to_title_case(property["name"])) 156 output_file.write(generate_enum(enum_name, property)) 157 typedef_args.append("%s:(%s%s)" % (property["name"], enum_name, suffix)) 158 else: 159 typedef_args.append("%s:(%s%s)" % (property["name"], param_type(domain_name, property), suffix)) 160 if (typedef_args): 161 output_file.write("\n/** @typedef {!{%s}} */\n%sAgent.%s;\n" % (", ".join(typedef_args), domain_name, type["id"])) 162 else: 163 output_file.write("\n/** @typedef {!Object} */\n%sAgent.%s;\n" % (domain_name, type["id"])) 164 elif type["type"] == "string" and "enum" in type: 165 output_file.write(generate_enum("%sAgent.%s" % (domain_name, type["id"]), type)) 166 elif type["type"] == "array": 167 output_file.write("\n/** @typedef {!Array.<!%s>} */\n%sAgent.%s;\n" % (param_type(domain_name, type["items"]), domain_name, type["id"])) 168 else: 169 output_file.write("\n/** @typedef {%s} */\n%sAgent.%s;\n" % (type_traits[type["type"]], domain_name, type["id"])) 170 171 output_file.write("/** @interface */\n") 172 output_file.write("%sAgent.Dispatcher = function() {};\n" % domain_name) 173 if "events" in domain: 174 for event in domain["events"]: 175 params = [] 176 if ("parameters" in event): 177 output_file.write("/**\n") 178 for param in event["parameters"]: 179 if ("optional" in param): 180 params.append("opt_%s" % param["name"]) 181 output_file.write(" * @param {%s=} opt_%s\n" % (param_type(domain_name, param), param["name"])) 182 else: 183 params.append(param["name"]) 184 output_file.write(" * @param {%s} %s\n" % (param_type(domain_name, param), param["name"])) 185 output_file.write(" */\n") 186 output_file.write("%sAgent.Dispatcher.prototype.%s = function(%s) {};\n" % (domain_name, event["name"], ", ".join(params))) 187 188 output_file.write("\n/** @constructor\n * @param {!Object.<string, !Object>} agentsMap\n */\n") 189 output_file.write("Protocol.Agents = function(agentsMap){this._agentsMap;};\n") 190 output_file.write("/**\n * @param {string} domain\n * @param {!Object} dispatcher\n */\n") 191 output_file.write("Protocol.Agents.prototype.registerDispatcher = function(domain, dispatcher){};\n") 192 for domain in json_api: 193 domain_name = domain["domain"] 194 uppercase_length = 0 195 while uppercase_length < len(domain_name) and domain_name[uppercase_length].isupper(): 196 uppercase_length += 1 197 198 output_file.write("/** @return {!Protocol.%sAgent}*/\n" % domain_name) 199 output_file.write("Protocol.Agents.prototype.%s = function(){};\n" % (domain_name[:uppercase_length].lower() + domain_name[uppercase_length:] + "Agent")) 200 201 output_file.write("/**\n * @param {!%sAgent.Dispatcher} dispatcher\n */\n" % domain_name) 202 output_file.write("Protocol.Agents.prototype.register%sDispatcher = function(dispatcher) {}\n" % domain_name) 203 204 205 output_file.close() 206 207if __name__ == "__main__": 208 import sys 209 import os.path 210 program_name = os.path.basename(__file__) 211 if len(sys.argv) < 4 or sys.argv[1] != "-o": 212 sys.stderr.write("Usage: %s -o OUTPUT_FILE INPUT_FILE\n" % program_name) 213 exit(1) 214 output_path = sys.argv[2] 215 input_path = sys.argv[3] 216 generate_protocol_externs(output_path, input_path) 217