[WIP][NotForLand] IDL dictionary support

Source/bindings/scripts/code_generator_v8.py

 # Copyright (C) 2013 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
 # copyright notice, this list of conditions and the following disclaimer
@@ skipping 55 matching lines @@
 
 # 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
 sys.path.insert(1, third_party_dir)
 import jinja2
 
 import idl_types
 from idl_types import IdlType
 import v8_callback_interface
+import v8_dictionary
 from v8_globals import includes, interfaces
 import v8_interface
 import v8_types
 from v8_utilities import capitalize, cpp_name, conditional_string, v8_class_name
 
 
+class GenerationResult(object):

[Nils Barth (inactive), 2014/07/18 21:52:33]

collections.namedtuple
(or just use a 2-tuple?)

[bashi, 2014/07/22 02:33:56]

Removed and used 2-tuples.

+    def __init__(self, output_path, output_code):
+        self.output_path = output_path
+        self.output_code = output_code
+
+
 class CodeGeneratorV8(object):
-    def __init__(self, interfaces_info, cache_dir):
+    def __init__(self, interfaces_info, cache_dir,
+                 v8_output_dir, impl_output_dir=None):
         interfaces_info = interfaces_info or {}
         self.interfaces_info = interfaces_info
         self.jinja_env = initialize_jinja_env(cache_dir)
+        self.v8_output_dir = v8_output_dir
+        self.impl_output_dir = impl_output_dir
 
         # Set global type info
         idl_types.set_ancestors(dict(
             (interface_name, interface_info['ancestors'])
             for interface_name, interface_info in interfaces_info.iteritems()
             if interface_info['ancestors']))
         IdlType.set_callback_interfaces(set(
             interface_name
             for interface_name, interface_info in interfaces_info.iteritems()
             if interface_info['is_callback_interface']))
+        IdlType.set_dictionaries(set(
+            dictionary_name
+            for dictionary_name, interface_info in interfaces_info.iteritems()
+            if interface_info['is_dictionary']))
         IdlType.set_implemented_as_interfaces(dict(
             (interface_name, interface_info['implemented_as'])
             for interface_name, interface_info in interfaces_info.iteritems()
             if interface_info['implemented_as']))
         IdlType.set_garbage_collected_types(set(
             interface_name
             for interface_name, interface_info in interfaces_info.iteritems()
             if 'GarbageCollected' in interface_info['inherited_extended_attributes']))
         IdlType.set_will_be_garbage_collected_types(set(
             interface_name
             for interface_name, interface_info in interfaces_info.iteritems()
             if 'WillBeGarbageCollected' in interface_info['inherited_extended_attributes']))
         v8_types.set_component_dirs(dict(
             (interface_name, interface_info['component_dir'])
             for interface_name, interface_info in interfaces_info.iteritems()))
 
-    def generate_code(self, definitions, interface_name):
+    def generate_code(self, definitions, definition_name):
         """Returns .h/.cpp code as (header_text, cpp_text)."""
-        try:
-            interface = definitions.interfaces[interface_name]
-        except KeyError:
-            raise Exception('%s not in IDL definitions' % interface_name)
-
-        # Store other interfaces for introspection
-        interfaces.update(definitions.interfaces)
-
         # Set local type info
         IdlType.set_callback_functions(definitions.callback_functions.keys())
         IdlType.set_enums((enum.name, enum.values)
                           for enum in definitions.enumerations.values())
 
+        if definition_name in definitions.interfaces:
+            return self.generate_interface_code(
+                definitions, definition_name,
+                definitions.interfaces[definition_name])
+        elif definition_name in definitions.dictionaries:

[Nils Barth (inactive), 2014/07/18 21:52:33]

No else after return (if, not elif).

[bashi, 2014/07/22 02:33:56]

Done.

+            return self.generate_dictionary_code(
+                definitions, definition_name,
+                definitions.dictionaries[definition_name])
+        else:

[Nils Barth (inactive), 2014/07/18 21:52:34]

No else after return

[bashi, 2014/07/22 02:33:56]

Done.

+            raise Exception('%s is not in IDL definitions' % definition_name)

[Nils Barth (inactive), 2014/07/18 21:52:33]

Exception => ValueError
(similar to key missing)

[bashi, 2014/07/22 02:33:56]

Done.

+
+    def render_template(self, interface_info, header_template, cpp_template,

[Nils Barth (inactive), 2014/07/18 21:52:33]

This can be a function, not a method, right?

[bashi, 2014/07/22 02:33:56]

Yes. Done.

+                        template_context):
+        template_context['code_generator'] = module_pyname
+
+        # Add includes for any dependencies
+        template_context['header_includes'] = sorted(template_context['header_includes'])
+        includes.update(interface_info.get('dependencies_include_paths', []))
+        template_context['cpp_includes'] = sorted(includes)
+
+        header_text = header_template.render(template_context)
+        cpp_text = cpp_template.render(template_context)
+        return header_text, cpp_text
+
+    def output_paths_for_bindings(self, definition_name):
+        header_path = posixpath.join(self.v8_output_dir,
+                                     'V8%s.h' % definition_name)
+        cpp_path = posixpath.join(self.v8_output_dir,
+                                  'V8%s.cpp' % definition_name)
+        return header_path, cpp_path
+
+    def output_paths_for_impl(self, definition_name, relative_dir):

[Nils Barth (inactive), 2014/07/18 21:52:33]

output_dir = posixpath.join(self.impl_output_dir, relative_dir) if
self.impl_output_dir else self.v8_output_dir
...then simpler.

[bashi, 2014/07/22 02:33:57]

Done.

+        if self.impl_output_dir:
+            header_path = posixpath.join(self.impl_output_dir,
+                                         relative_dir,
+                                         '%s.h' % definition_name)
+            cpp_path = posixpath.join(self.impl_output_dir,
+                                      relative_dir,
+                                      '%s.cpp' % definition_name)
+        else:
+            header_path = posixpath.join(self.v8_output_dir,
+                                         '%s.h' % definition_name)
+            cpp_path = posixpath.join(self.v8_output_dir,
+                                         '%s.cpp' % definition_name)
+        return header_path, cpp_path
+
+    def generate_interface_code(self, definitions, interface_name, interface):
+        # Store other interfaces for introspection
+        interfaces.update(definitions.interfaces)

[Nils Barth (inactive), 2014/07/18 21:52:33]

*self.*interfaces ?

[bashi, 2014/07/22 02:33:56]

No. it comes from v8_globals.

+
         # Select appropriate Jinja template and contents function
         if interface.is_callback:
             header_template_filename = 'callback_interface.h'
             cpp_template_filename = 'callback_interface.cpp'
             interface_context = v8_callback_interface.callback_interface_context
         else:
             header_template_filename = 'interface.h'
             cpp_template_filename = 'interface.cpp'
             interface_context = v8_interface.interface_context
         header_template = self.jinja_env.get_template(header_template_filename)
         cpp_template = self.jinja_env.get_template(cpp_template_filename)
 
-        # Compute context (input values for Jinja)
+        interface_info = self.interfaces_info[interface_name]
+
         template_context = interface_context(interface)
-        template_context['code_generator'] = module_pyname
+        # Add the include for interface itself
+        template_context['header_includes'].add(interface_info['include_path'])
+        header_text, cpp_text = self.render_template(
+            interface_info, header_template, cpp_template, template_context)
+        header_path, cpp_path = self.output_paths_for_bindings(interface_name)
+        return [

[Nils Barth (inactive), 2014/07/18 21:52:33]

nit: () instead of []
(fixed return value: you're not going to be modifying the returned value)

[bashi, 2014/07/22 02:33:56]

Done.

+            GenerationResult(header_path, header_text),
+            GenerationResult(cpp_path, cpp_text),
+        ]
 
-        # Add includes for interface itself and any dependencies
-        interface_info = self.interfaces_info[interface_name]
+    def generate_dictionary_code(self, definitions, dictionary_name,
+                                 dictionary):
+        interface_info = self.interfaces_info[dictionary_name]
+        bindings_results = self.generate_dictionary_bindings(
+            dictionary_name, interface_info, dictionary)
+        impl_results = self.generate_dictionary_impl(
+            dictionary_name, interface_info, dictionary)
+        return bindings_results + impl_results
+
+    def generate_dictionary_bindings(self, dictionary_name,
+                                     interface_info, dictionary):
+        header_template = self.jinja_env.get_template('dictionary_v8.h')
+        cpp_template = self.jinja_env.get_template('dictionary_v8.cpp')
+        template_context = v8_dictionary.dictionary_context_v8(dictionary)
+        # Add the include for interface itself
         template_context['header_includes'].add(interface_info['include_path'])
-        template_context['header_includes'] = sorted(template_context['header_includes'])
-        includes.update(interface_info.get('dependencies_include_paths', []))
-        template_context['cpp_includes'] = sorted(includes)
+        header_text, cpp_text = self.render_template(
+            interface_info, header_template, cpp_template, template_context)
+        header_path, cpp_path = self.output_paths_for_bindings(dictionary_name)
+        return [

[Nils Barth (inactive), 2014/07/18 21:52:33]

ditto

[bashi, 2014/07/22 02:33:56]

Done.

+            GenerationResult(header_path, header_text),
+            GenerationResult(cpp_path, cpp_text),
+        ]
 
-        # Render Jinja templates
-        header_text = header_template.render(template_context)
-        cpp_text = cpp_template.render(template_context)
-        return header_text, cpp_text
-
+    def generate_dictionary_impl(self, dictionary_name,
+                                 interface_info, dictionary):
+        header_template = self.jinja_env.get_template('dictionary_impl.h')
+        cpp_template = self.jinja_env.get_template('dictionary_impl.cpp')
+        template_context = v8_dictionary.dictionary_context_impl(
+            dictionary, self.interfaces_info)
+        header_text, cpp_text = self.render_template(
+            interface_info, header_template, cpp_template, template_context)
+        header_path, cpp_path = self.output_paths_for_impl(
+            dictionary_name, interface_info['relative_dir'])
+        return [

[Nils Barth (inactive), 2014/07/18 21:52:33]

ditto

[bashi, 2014/07/22 02:33:56]

Done.

+            GenerationResult(header_path, header_text),
+            GenerationResult(cpp_path, cpp_text),
+        ]
 
 def initialize_jinja_env(cache_dir):
     jinja_env = jinja2.Environment(
         loader=jinja2.FileSystemLoader(templates_dir),
         # 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)
@@ skipping 47 matching lines @@
 
     # Create a dummy file as output for the build system,
     # since filenames of individual cache files are unpredictable and opaque
     # (they are hashes of the template path, which varies based on environment)
     with open(dummy_filename, 'w') as dummy_file:
         pass  # |open| creates or touches the file
 
 
 if __name__ == '__main__':
     sys.exit(main(sys.argv))