DevTools: Introduce Target class which holds connection & models

Source/devtools/scripts/generate_protocol_externs.py

 #!/usr/bin/env python
 # Copyright (c) 2011 Google Inc. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are
 # met:
 #
 #     * Redistributions of source code must retain the above copyright
 # notice, this list of conditions and the following disclaimer.
 #     * Redistributions in binary form must reproduce the above
@@ skipping 90 matching lines @@
 
     for domain in json_api:
         domain_name = domain["domain"]
         if "types" in domain:
             for type in domain["types"]:
                 type_id = full_qualified_type_id(domain_name, type["id"])
                 ref_types[type_id] = "%sAgent.%s" % (domain_name, type["id"])
 
     for domain in json_api:
         domain_name = domain["domain"]
-        output_file.write("\n\n\nvar %sAgent = {};\n" % domain_name)

[vsevik, 2014/03/06 14:49:45]

Why did this move?

[sergeyv, 2014/03/06 16:18:34]

I've done this move, cause now we need to create Agent's prototype before
instantiating Agent itself

-        if "types" in domain:
-            for type in domain["types"]:
-                if type["type"] == "object":
-                    typedef_args = []
-                    if "properties" in type:
-                        for property in type["properties"]:
-                            suffix = ""
-                            if ("optional" in property):
-                                suffix = "|undefined"
-                            if "enum" in property:
-                                enum_name = "%sAgent.%s%s" % (domain_name, type["id"], to_title_case(property["name"]))
-                                output_file.write(generate_enum(enum_name, property))
-                                typedef_args.append("%s:(%s%s)" % (property["name"], enum_name, suffix))
-                            else:
-                                typedef_args.append("%s:(%s%s)" % (property["name"], param_type(domain_name, property), suffix))
-                    if (typedef_args):
-                        output_file.write("\n/** @typedef {!{%s}} */\n%sAgent.%s;\n" % (", ".join(typedef_args), domain_name, type["id"]))
-                    else:
-                        output_file.write("\n/** @typedef {!Object} */\n%sAgent.%s;\n" % (domain_name, type["id"]))
-                elif type["type"] == "string" and "enum" in type:
-                    output_file.write(generate_enum("%sAgent.%s" % (domain_name, type["id"]), type))
-                elif type["type"] == "array":
-                    output_file.write("\n/** @typedef {!Array.<!%s>} */\n%sAgent.%s;\n" % (param_type(domain_name, type["items"]), domain_name, type["id"]))
-                else:
-                    output_file.write("\n/** @typedef {%s} */\n%sAgent.%s;\n" % (type_traits[type["type"]], domain_name, type["id"]))
+
+        output_file.write("\n\n/**\n * @constructor\n*/\n")
+        output_file.write("Protocol.%sAgent = function(){};\n" % domain_name)
 
         if "commands" in domain:
             for command in domain["commands"]:
                 output_file.write("\n/**\n")
                 params = []
                 if ("parameters" in command):
                     for in_param in command["parameters"]:
                         if ("optional" in in_param):
                             params.append("opt_%s" % in_param["name"])
                             output_file.write(" * @param {%s=} opt_%s\n" % (param_type(domain_name, in_param), in_param["name"]))
                         else:
                             params.append(in_param["name"])
                             output_file.write(" * @param {%s} %s\n" % (param_type(domain_name, in_param), in_param["name"]))
                 returns = ["?Protocol.Error"]
                 if ("error" in command):
                     returns.append("%s=" % param_type(domain_name, command["error"]))
                 if ("returns" in command):
                     for out_param in command["returns"]:
                         if ("optional" in out_param):
                             returns.append("%s=" % param_type(domain_name, out_param))
                         else:
                             returns.append("%s" % param_type(domain_name, out_param))
                 output_file.write(" * @param {function(%s):void=} opt_callback\n" % ", ".join(returns))
                 output_file.write(" */\n")
                 params.append("opt_callback")
-                output_file.write("%sAgent.%s = function(%s) {}\n" % (domain_name, command["name"], ", ".join(params)))
+                output_file.write("Protocol.%sAgent.prototype.%s = function(%s) {}\n" % (domain_name, command["name"], ", ".join(params)))
                 output_file.write("/** @param {function(%s):void=} opt_callback */\n" % ", ".join(returns))
-                output_file.write("%sAgent.invoke_%s = function(obj, opt_callback) {}\n" % (domain_name, command["name"]))
+                output_file.write("Protocol.%sAgent.prototype.invoke_%s = function(obj, opt_callback) {}\n" % (domain_name, command["name"]))
+
+        output_file.write("\n\n\nvar %sAgent = new Protocol.%sAgent();\n" % (domain_name, domain_name))
+
+        if "types" in domain:
+            for type in domain["types"]:
+                if type["type"] == "object":
+                    typedef_args = []
+                    if "properties" in type:
+                        for property in type["properties"]:
+                            suffix = ""
+                            if ("optional" in property):
+                                suffix = "|undefined"
+                            if "enum" in property:
+                                enum_name = "%sAgent.%s%s" % (domain_name, type["id"], to_title_case(property["name"]))
+                                output_file.write(generate_enum(enum_name, property))
+                                typedef_args.append("%s:(%s%s)" % (property["name"], enum_name, suffix))
+                            else:
+                                typedef_args.append("%s:(%s%s)" % (property["name"], param_type(domain_name, property), suffix))
+                    if (typedef_args):
+                        output_file.write("\n/** @typedef {!{%s}} */\n%sAgent.%s;\n" % (", ".join(typedef_args), domain_name, type["id"]))
+                    else:
+                        output_file.write("\n/** @typedef {!Object} */\n%sAgent.%s;\n" % (domain_name, type["id"]))
+                elif type["type"] == "string" and "enum" in type:
+                    output_file.write(generate_enum("%sAgent.%s" % (domain_name, type["id"]), type))
+                elif type["type"] == "array":
+                    output_file.write("\n/** @typedef {!Array.<!%s>} */\n%sAgent.%s;\n" % (param_type(domain_name, type["items"]), domain_name, type["id"]))
+                else:
+                    output_file.write("\n/** @typedef {%s} */\n%sAgent.%s;\n" % (type_traits[type["type"]], domain_name, type["id"]))
 
         output_file.write("/** @interface */\n")
         output_file.write("%sAgent.Dispatcher = function() {};\n" % domain_name)
         if "events" in domain:
             for event in domain["events"]:
                 params = []
                 if ("parameters" in event):
                     output_file.write("/**\n")
                     for param in event["parameters"]:
                         if ("optional" in param):
                             params.append("opt_%s" % param["name"])
                             output_file.write(" * @param {%s=} opt_%s\n" % (param_type(domain_name, param), param["name"]))
                         else:
                             params.append(param["name"])
                             output_file.write(" * @param {%s} %s\n" % (param_type(domain_name, param), param["name"]))
                     output_file.write(" */\n")
                 output_file.write("%sAgent.Dispatcher.prototype.%s = function(%s) {};\n" % (domain_name, event["name"], ", ".join(params)))
         output_file.write("/**\n * @param {%sAgent.Dispatcher} dispatcher\n */\n" % domain_name)
         output_file.write("InspectorBackend.register%sDispatcher = function(dispatcher) {}\n" % domain_name)
+
+    output_file.write("\n/** @constructor */\n")
+    output_file.write("Protocol.Agents = function(){};\n")
+
+    for domain in json_api:
+        domain_name = domain["domain"]
+        uppercase_length = 0
+        while uppercase_length < len(domain_name) and domain_name[uppercase_length].isupper():
+            uppercase_length += 1
+
+        output_file.write("/** @return {!Protocol.%sAgent}*/\n" % domain_name)
+        output_file.write("Protocol.Agents.prototype.%s = function(){};\n" % (domain_name[:uppercase_length].lower() + domain_name[uppercase_length:] + "Agent"))
+
     output_file.close()
 
 if __name__ == "__main__":
     import sys
     import os.path
     program_name = os.path.basename(__file__)
     if len(sys.argv) < 4 or sys.argv[1] != "-o":
         sys.stderr.write("Usage: %s -o OUTPUT_FILE INPUT_FILE\n" % program_name)
         exit(1)
     output_path = sys.argv[2]
     input_path = sys.argv[3]
     generate_protocol_externs(output_path, input_path)