[DevTools] Prepare inspector_protocol build to move.

third_party/WebKit/Source/platform/inspector_protocol/CodeGenerator.py

 # Copyright 2016 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 import os.path
 import sys
 import optparse
 import collections
 import functools
 try:
     import json
 except ImportError:
     import simplejson as json
 
 # Path handling for libraries and templates
 # Paths have to be normalized because Jinja uses the exact template path to
 # determine the hash used in the cache filename, and we need a pre-caching step
 # to be concurrency-safe. Use absolute path because __file__ is absolute if
 # module is imported, and relative if executed directly.
 # If paths differ between pre-caching and individual file compilation, the cache
 # is regenerated, which causes a race condition and breaks concurrent build,
 # since some compile processes will try to read the partially written cache.
 module_path, module_filename = os.path.split(os.path.realpath(__file__))
-templates_dir = module_path
-
-# In Blink, jinja2 is in chromium's third_party directory.
-# Insert at 1 so at front to override system libraries, and
-# after path[0] == invoking script dir
-blink_third_party_dir = os.path.normpath(os.path.join(
-    module_path, os.pardir, os.pardir, os.pardir, os.pardir, os.pardir,
-    "third_party"))
-if os.path.isdir(blink_third_party_dir):
-    sys.path.insert(1, blink_third_party_dir)
-
-# In V8, it is in third_party folder
-v8_third_party_dir = os.path.normpath(os.path.join(
-    module_path, os.pardir, os.pardir, "third_party"))
-
-if os.path.isdir(v8_third_party_dir):
-    sys.path.insert(1, v8_third_party_dir)
-
-# In Node, it is in deps folder
-deps_dir = os.path.normpath(os.path.join(
-    module_path, os.pardir, os.pardir, os.pardir, os.pardir, "third_party"))
-
-if os.path.isdir(deps_dir):
-    sys.path.insert(1, os.path.join(deps_dir, "jinja2"))
-    sys.path.insert(1, os.path.join(deps_dir, "markupsafe"))
-
-import jinja2
-
 
 def read_config():
     # pylint: disable=W0703
     def json_to_object(data, output_base, config_base):
         def json_object_hook(object_dict):
             items = [(k, os.path.join(config_base, v) if k == "path" else v) for (k, v) in object_dict.items()]
             items = [(k, os.path.join(output_base, v) if k == "output" else v) for (k, v) in items]
             keys, values = zip(*items)
             return collections.namedtuple('X', keys)(*values)
         return json.loads(data, object_hook=json_object_hook)
 
     try:
         cmdline_parser = optparse.OptionParser()
         cmdline_parser.add_option("--output_base")
+        cmdline_parser.add_option("--jinja_dir")
         cmdline_parser.add_option("--config")
         arg_options, _ = cmdline_parser.parse_args()
+        jinja_dir = arg_options.jinja_dir
+        if not jinja_dir:
+            raise Exception("jinja directory must be specified")
         output_base = arg_options.output_base
         if not output_base:
             raise Exception("Base output directory must be specified")
         config_file = arg_options.config
         if not config_file:
             raise Exception("Config file name must be specified")
         config_base = os.path.dirname(config_file)
     except Exception:
         # Work with python 2 and 3 http://docs.python.org/py3k/howto/pyporting.html
         exc = sys.exc_info()[1]
         sys.stderr.write("Failed to parse command-line arguments: %s\n\n" % exc)
         exit(1)
 
     try:
         config_json_file = open(config_file, "r")
         config_json_string = config_json_file.read()
         config_partial = json_to_object(config_json_string, output_base, config_base)
         keys = list(config_partial._fields)  # pylint: disable=E1101
         values = [getattr(config_partial, k) for k in keys]
         for optional in ["imported", "exported", "lib"]:
             if optional not in keys:
                 keys.append(optional)
                 values.append(False)
         config_json_file.close()
-        return (config_file, collections.namedtuple('X', keys)(*values))
+        return (jinja_dir, config_file, collections.namedtuple('X', keys)(*values))
     except Exception:
         # Work with python 2 and 3 http://docs.python.org/py3k/howto/pyporting.html
         exc = sys.exc_info()[1]
         sys.stderr.write("Failed to parse config file: %s\n\n" % exc)
         exit(1)
 
 
 def to_title_case(name):
     return name[:1].upper() + name[1:]
 
 
 def dash_to_camelcase(word):
     prefix = ""
     if word[0] == "-":
         prefix = "Negative"
         word = word[1:]
     return prefix + "".join(to_title_case(x) or "-" for x in word.split("-"))
 
 
-def initialize_jinja_env(cache_dir):
+def initialize_jinja_env(jinja_dir, cache_dir):
+    # pylint: disable=F0401
+    sys.path.insert(1, os.path.abspath(jinja_dir))
+    import jinja2
+
     jinja_env = jinja2.Environment(
-        loader=jinja2.FileSystemLoader(templates_dir),
+        loader=jinja2.FileSystemLoader(module_path),
         # Bytecode cache is not concurrency-safe unless pre-cached:
         # if pre-cached this is read-only, but writing creates a race condition.
         bytecode_cache=jinja2.FileSystemBytecodeCache(cache_dir),
         keep_trailing_newline=True,  # newline-terminate generated files
         lstrip_blocks=True,  # so can indent control flow tags
         trim_blocks=True)
     jinja_env.filters.update({"to_title_case": to_title_case, "dash_to_camelcase": dash_to_camelcase})
     jinja_env.add_extension("jinja2.ext.loopcontrols")
     return jinja_env
 
@@ skipping 230 matching lines @@
 
 
 class Protocol(object):
     def __init__(self):
         self.json_api = {}
         self.generate_domains = []
         self.imported_domains = []
 
 
 def main():
-    config_file, config = read_config()
+    jinja_dir, config_file, config = read_config()
 
     protocol = Protocol()
     protocol.json_api = {"domains": []}
     protocol.generate_domains = read_protocol_file(config.protocol.path, protocol.json_api)
     protocol.imported_domains = read_protocol_file(config.imported.path, protocol.json_api) if config.imported else []
     patch_full_qualified_refs(protocol)
     calculate_exports(protocol)
     create_type_definitions(protocol, "::".join(config.imported.namespace) if config.imported else "")
 
     if not config.exported:
         for domain_json in protocol.json_api["domains"]:
             if domain_json["has_exports"] and domain_json["domain"] in protocol.generate_domains:
                 sys.stderr.write("Domain %s is exported, but config is missing export entry\n\n" % domain_json["domain"])
                 exit(1)
 
     if not os.path.exists(config.protocol.output):
         os.mkdir(config.protocol.output)
     if protocol.json_api["has_exports"] and not os.path.exists(config.exported.output):
         os.mkdir(config.exported.output)
-    jinja_env = initialize_jinja_env(config.protocol.output)
+    jinja_env = initialize_jinja_env(jinja_dir, config.protocol.output)
 
     inputs = []
     inputs.append(__file__)
     inputs.append(config_file)
     inputs.append(config.protocol.path)
     if config.imported:
         inputs.append(config.imported.path)
+    templates_dir = os.path.join(module_path, "templates")
     inputs.append(os.path.join(templates_dir, "TypeBuilder_h.template"))
     inputs.append(os.path.join(templates_dir, "TypeBuilder_cpp.template"))
     inputs.append(os.path.join(templates_dir, "Exported_h.template"))
     inputs.append(os.path.join(templates_dir, "Imported_h.template"))
 
-    h_template = jinja_env.get_template("TypeBuilder_h.template")
-    cpp_template = jinja_env.get_template("TypeBuilder_cpp.template")
-    exported_template = jinja_env.get_template("Exported_h.template")
-    imported_template = jinja_env.get_template("Imported_h.template")
+    h_template = jinja_env.get_template("templates/TypeBuilder_h.template")
+    cpp_template = jinja_env.get_template("templates/TypeBuilder_cpp.template")
+    exported_template = jinja_env.get_template("templates/Exported_h.template")
+    imported_template = jinja_env.get_template("templates/Imported_h.template")
 
     outputs = dict()
 
     for domain in protocol.json_api["domains"]:
         class_name = domain["domain"]
         template_context = {
             "config": config,
             "domain": domain,
             "join_arrays": join_arrays,
             "resolve_type": functools.partial(resolve_type, protocol),
             "type_definition": functools.partial(type_definition, protocol),
             "has_disable": has_disable
         }
 
         if domain["domain"] in protocol.generate_domains:
             outputs[os.path.join(config.protocol.output, class_name + ".h")] = h_template.render(template_context)
             outputs[os.path.join(config.protocol.output, class_name + ".cpp")] = cpp_template.render(template_context)
             if domain["has_exports"]:
                 outputs[os.path.join(config.exported.output, class_name + ".h")] = exported_template.render(template_context)
         if domain["domain"] in protocol.imported_domains and domain["has_exports"]:
             outputs[os.path.join(config.protocol.output, class_name + ".h")] = imported_template.render(template_context)
 
     if config.lib:
         template_context = {
             "config": config
         }
 
+        lib_templates_dir = os.path.join(module_path, "lib")
         # Note these should be sorted in the right order.
         # TODO(dgozman): sort them programmatically based on commented includes.
         lib_h_templates = [
             "Collections_h.template",
             "ErrorSupport_h.template",
             "Values_h.template",
             "Object_h.template",
             "ValueConversions_h.template",
             "Maybe_h.template",
             "Array_h.template",
@@ skipping 13 matching lines @@
 
         forward_h_templates = [
             "Forward_h.template",
             "Allocator_h.template",
             "FrontendChannel_h.template",
         ]
 
         def generate_lib_file(file_name, template_files):
             parts = []
             for template_file in template_files:
-                inputs.append(os.path.join(templates_dir, template_file))
-                template = jinja_env.get_template(template_file)
+                inputs.append(os.path.join(lib_templates_dir, template_file))
+                template = jinja_env.get_template("lib/" + template_file)
                 parts.append(template.render(template_context))
             outputs[file_name] = "\n\n".join(parts)
 
         generate_lib_file(os.path.join(config.lib.output, "Forward.h"), forward_h_templates)
         generate_lib_file(os.path.join(config.lib.output, "Protocol.h"), lib_h_templates)
         generate_lib_file(os.path.join(config.lib.output, "Protocol.cpp"), lib_cpp_templates)
 
     # Make gyp / make generatos happy, otherwise make rebuilds world.
     inputs_ts = max(map(os.path.getmtime, inputs))
     up_to_date = True
     for output_file in outputs.iterkeys():
         if not os.path.exists(output_file) or os.path.getmtime(output_file) < inputs_ts:
             up_to_date = False
             break
     if up_to_date:
         sys.exit()
 
     for file_name, content in outputs.iteritems():
         out_file = open(file_name, "w")
         out_file.write(content)
         out_file.close()
 
 
 main()