Split generate_global_constructors.py out of compute_dependencies.py

Source/bindings/generated_bindings.gyp

 #
 # 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
@@ skipping 10 matching lines @@
 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
+# Generate IDL bindings, together with auxiliary files
+# (constructors on global objects, aggregate bindings files).
+#
+# Design doc:
+# https://sites.google.com/a/chromium.org/dev/developers/design-documents/idl-build
+
 {
   'includes': [
     '../build/scripts/scripts.gypi',
     '../build/win/precompile.gypi',
     '../build/scripts/scripts.gypi',
     '../core/core.gypi',
     '../modules/modules.gypi',
     'bindings.gypi',
   ],
 
   'variables': {
     # For details, see: http://www.chromium.org/developers/web-idl-interfaces
     #
     # Interface IDL files / Dependency IDL files
     # Interface IDL files: generate individual bindings (includes testing)
     'interface_idl_files': [
       '<@(static_interface_idl_files)',
       '<@(generated_interface_idl_files)',
     ],
     # Dependency IDL files: don't generate individual bindings, but do process
     # in IDL dependency computation, and count as build dependencies
     'dependency_idl_files': [
       '<@(static_dependency_idl_files)',
       '<@(generated_dependency_idl_files)',
     ],
-    # Include in aggregate bindings (exclude testing)
-    # The only differences for testing files are:
-    # * They are not included in aggregate bindings (excluded from below list)
-    # * They do not appear as a property on the global object (Window):
-    #   specify [NoInterfaceObject] on the interface in the .idl file
+    # Main interface IDL files (excluding dependencies and testing)
+    # are included as properties on global objects, and in aggregate bindings
     'main_interface_idl_files': [
       '<@(core_idl_files)',
       '<@(modules_idl_files)',
     ],
 
     # Static IDL files / Generated IDL files
     # Paths need to be passed separately for static and generated files, as
     # static files are listed in a temporary file (b/c too long for command
     # line), but generated files must be passed at the command line, as they are
     # not present at GYP time, when the temporary file is generated
     'static_idl_files': [
       '<@(static_interface_idl_files)',
       '<@(static_dependency_idl_files)',
     ],
     'generated_idl_files': [
       '<@(generated_interface_idl_files)',
-      # FIXME: generate global constructors *before* computing dependencies
-      # '<@(generated_dependency_idl_files)',
+      '<@(generated_dependency_idl_files)',
     ],
 
     # Static IDL files
     'static_interface_idl_files': [
       '<@(core_idl_files)',
       '<@(webcore_testing_idl_files)',
       '<@(modules_idl_files)',
     ],
     'static_dependency_idl_files': [
       '<@(core_dependency_idl_files)',
       '<@(modules_dependency_idl_files)',
       '<@(modules_testing_dependency_idl_files)',
     ],
 
     # Generated IDL files
     'generated_interface_idl_files': [
       '<@(generated_webcore_testing_idl_files)',  # interfaces
     ],
     'generated_dependency_idl_files': [
       '<@(generated_global_constructors_idl_files)',  # partial interfaces
     ],
 
     'generated_global_constructors_idl_files': [
-       '<(SHARED_INTERMEDIATE_DIR)/blink/WindowConstructors.idl',
-       '<(SHARED_INTERMEDIATE_DIR)/blink/WorkerGlobalScopeConstructors.idl',
-       '<(SHARED_INTERMEDIATE_DIR)/blink/SharedWorkerGlobalScopeConstructors.idl',
-       '<(SHARED_INTERMEDIATE_DIR)/blink/DedicatedWorkerGlobalScopeConstructors.idl',
-       '<(SHARED_INTERMEDIATE_DIR)/ServiceWorkerGlobalScopeConstructors.idl',
+      '<(SHARED_INTERMEDIATE_DIR)/blink/WindowConstructors.idl',
+      '<(SHARED_INTERMEDIATE_DIR)/blink/WorkerGlobalScopeConstructors.idl',
+      '<(SHARED_INTERMEDIATE_DIR)/blink/SharedWorkerGlobalScopeConstructors.idl',
+      '<(SHARED_INTERMEDIATE_DIR)/blink/DedicatedWorkerGlobalScopeConstructors.idl',
+      '<(SHARED_INTERMEDIATE_DIR)/ServiceWorkerGlobalScopeConstructors.idl',
     ],
 
     'compiler_module_files': [
       'scripts/unstable/idl_compiler.py',
       '<(DEPTH)/third_party/ply/lex.py',
       '<(DEPTH)/third_party/ply/yacc.py',
       # jinja2/__init__.py contains version string, so sufficient for package
       '<(DEPTH)/third_party/jinja2/__init__.py',
       '<(DEPTH)/third_party/markupsafe/__init__.py',  # jinja2 dep
       '<(DEPTH)/tools/idl_parser/idl_lexer.py',
@@ skipping 46 matching lines @@
         # depending on what the user has locally it could be. So, don't use on
         # Windows is the simplest solution.
         'json_perl_module_include_path': '-I<(DEPTH)/third_party/JSON/out/lib/perl5',
       }, {
         'json_perl_module_include_path': '',
       }],
     ],
   },
 
   'targets': [{
-    'target_name': 'interface_dependencies',
+    'target_name': 'global_constructors_idls',
+    'type': 'none',
+    'actions': [{
+      'action_name': 'generate_global_constructors_idls',
+      'variables': {
+        # Write list of IDL files to a file, so that the command line doesn't
+        # exceed OS length limits.
+        # Only includes main IDL files (exclude dependencies and testing,
+        # which should not appear on global objects).
+        'main_interface_idl_files_list': '<|(main_interface_idl_files_list.tmp <@(main_interface_idl_files))',
+      },
+      'inputs': [
+        'scripts/generate_global_constructors.py',
+        'scripts/utilities.py',
+        '<(main_interface_idl_files_list)',
+        '<@(main_interface_idl_files)',
+      ],
+      'outputs': [
+        '<@(generated_global_constructors_idl_files)',
+      ],
+      'action': [
+        'python',
+        'scripts/generate_global_constructors.py',
+        '--idl-files-list',
+        '<(main_interface_idl_files_list)',
+        '<@(write_file_only_if_changed)',
+        '--',
+        'Window',
+        '<(SHARED_INTERMEDIATE_DIR)/blink/WindowConstructors.idl',
+        'WorkerGlobalScope',
+        '<(SHARED_INTERMEDIATE_DIR)/blink/WorkerGlobalScopeConstructors.idl',
+        'SharedWorkerGlobalScope',
+        '<(SHARED_INTERMEDIATE_DIR)/blink/SharedWorkerGlobalScopeConstructors.idl',
+        'DedicatedWorkerGlobalScope',
+        '<(SHARED_INTERMEDIATE_DIR)/blink/DedicatedWorkerGlobalScopeConstructors.idl',
+        'ServiceWorkerGlobalScope',
+        '<(SHARED_INTERMEDIATE_DIR)/ServiceWorkerGlobalScopeConstructors.idl',
+       ],
+       'message': 'Generating IDL files for interface properties on global objects',
+      }]
+  },
+  {
+    'target_name': 'interfaces_info',
     'type': 'none',
     'dependencies': [
+      'global_constructors_idls',
       '../core/core_generated.gyp:generated_testing_idls',
     ],
     'actions': [{
-      'action_name': 'compute_interface_dependencies',
+      'action_name': 'compute_interfaces_info',
       'variables': {
         # Write list of static IDL files to a file, so that the command line
         # doesn't exceed OS length limits.
         # Generated IDL files cannot be included, as their path depends on the
         # build directory, and must instead be passed as command line arguments.
         'idl_files_list': '<|(idl_files_list.tmp <@(static_idl_files))',
       },
       'inputs': [
-        'scripts/compute_dependencies.py',
+        'scripts/compute_interfaces_info.py',
+        'scripts/utilities.py',
         '<(idl_files_list)',
         '<@(static_idl_files)',
         '<@(generated_idl_files)',
-       ],
-       'outputs': [
-         '<(SHARED_INTERMEDIATE_DIR)/blink/InterfaceDependencies.txt',
-         '<(SHARED_INTERMEDIATE_DIR)/blink/InterfacesInfo.pickle',
-         '<@(generated_global_constructors_idl_files)',
-         '<(SHARED_INTERMEDIATE_DIR)/blink/EventInterfaces.in',
-       ],
-       'action': [
-         'python',
-         'scripts/compute_dependencies.py',
-         '--idl-files-list',
-         '<(idl_files_list)',
-         '--interface-dependencies-file',
-         '<(SHARED_INTERMEDIATE_DIR)/blink/InterfaceDependencies.txt',
-         '--interfaces-info-file',
-         '<(SHARED_INTERMEDIATE_DIR)/blink/InterfacesInfo.pickle',
-         '--window-constructors-file',
-         '<(SHARED_INTERMEDIATE_DIR)/blink/WindowConstructors.idl',
-         '--workerglobalscope-constructors-file',
-         '<(SHARED_INTERMEDIATE_DIR)/blink/WorkerGlobalScopeConstructors.idl',
-         '--sharedworkerglobalscope-constructors-file',
-         '<(SHARED_INTERMEDIATE_DIR)/blink/SharedWorkerGlobalScopeConstructors.idl',
-         '--dedicatedworkerglobalscope-constructors-file',
-         '<(SHARED_INTERMEDIATE_DIR)/blink/DedicatedWorkerGlobalScopeConstructors.idl',
-         '--serviceworkerglobalscope-constructors-file',
-         '<(SHARED_INTERMEDIATE_DIR)/ServiceWorkerGlobalScopeConstructors.idl',
-         '--event-names-file',
-         '<(SHARED_INTERMEDIATE_DIR)/blink/EventInterfaces.in',
-         '<@(write_file_only_if_changed)',
-         '--',
-         '<@(generated_idl_files)',
-       ],
-       'message': 'Computing dependencies between IDL files, and generating global scope constructor IDLs files and list of Event interfaces',
+      ],
+      'outputs': [
+        '<(SHARED_INTERMEDIATE_DIR)/blink/InterfaceDependencies.txt',
+        '<(SHARED_INTERMEDIATE_DIR)/blink/InterfacesInfo.pickle',
+        '<(SHARED_INTERMEDIATE_DIR)/blink/EventInterfaces.in',
+      ],
+      'action': [
+        'python',
+        'scripts/compute_interfaces_info.py',
+        '--idl-files-list',
+        '<(idl_files_list)',
+        '--interface-dependencies-file',
+        '<(SHARED_INTERMEDIATE_DIR)/blink/InterfaceDependencies.txt',
+        '--interfaces-info-file',
+        '<(SHARED_INTERMEDIATE_DIR)/blink/InterfacesInfo.pickle',
+        '--event-names-file',
+        '<(SHARED_INTERMEDIATE_DIR)/blink/EventInterfaces.in',
+        '<@(write_file_only_if_changed)',
+        '--',
+        '<@(generated_idl_files)',
+      ],
+      'message': 'Computing global information about IDL files, and generating list of Event interfaces',
       }]
     },
     {
       'target_name': 'individual_generated_bindings',
       'type': 'none',
       # The 'binding' rule generates .h files, so mark as hard_dependency, per:
       # https://code.google.com/p/gyp/wiki/InputFormatReference#Linking_Dependencies
       'hard_dependency': 1,
       'dependencies': [
-        'interface_dependencies',
+        'interfaces_info',
         '../core/core_generated.gyp:generated_testing_idls',
       ],
       'sources': [
         '<@(interface_idl_files)',
       ],
       'rules': [{
         'rule_name': 'binding',
         'extension': 'idl',
         'msvs_external_rule': 1,
         'inputs': [
           'scripts/generate_bindings.pl',
           'scripts/code_generator_v8.pm',
           'scripts/idl_parser.pm',
           'scripts/idl_serializer.pm',
           '../build/scripts/preprocessor.pm',
           'IDLExtendedAttributes.txt',
           # If the dependency structure or public interface info (e.g.,
           # [ImplementedAs]) changes, we rebuild all files, since we're not
           # computing dependencies file-by-file in the build.
           # This data is generally stable.
           '<(SHARED_INTERMEDIATE_DIR)/blink/InterfaceDependencies.txt',
           '<(SHARED_INTERMEDIATE_DIR)/blink/InterfacesInfo.pickle',
           # Further, if any dependency (partial interface or implemented
           # interface) changes, rebuild everything, since every IDL potentially
           # depends on them, because we're not computing dependencies
           # file-by-file.
           # FIXME: This is too conservative, and causes excess rebuilds:
-          # compute this file-by-file.
+          # compute this file-by-file.  http://crbug.com/341748
           '<@(dependency_idl_files)',
         ],
         'outputs': [
           '<(bindings_output_dir)/V8<(RULE_INPUT_ROOT).cpp',
           '<(bindings_output_dir)/V8<(RULE_INPUT_ROOT).h',
         ],
         'variables': {
           # IDL include paths. The generator will search recursively for IDL
           # files under these locations.
           'generator_include_dirs': [
@@ skipping 59 matching lines @@
     {
       'target_name': 'generated_bindings',
       'type': 'none',
       'dependencies': [
         'aggregate_generated_bindings',
         'individual_generated_bindings',
       ],
     },
   ],
 }