Add Python flow to bindings generation, move dummy-generating IDL files over

Source/bindings/derived_sources.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 20 matching lines @@
 {
   'includes': [
     '../WebKit/chromium/WinPrecompile.gypi',
     '../core/features.gypi',
     '../core/core.gypi',
     '../modules/modules.gypi',
     'bindings.gypi',
   ],
 
   'variables': {
-    'idl_files': [
-      '<@(core_idl_files)',
-      '<@(modules_idl_files)',
-      '<@(svg_idl_files)',
+    'perl_idl_files': [
+      '<@(perl_core_idl_files)',
+      '<@(perl_modules_idl_files)',
+      '<@(perl_svg_idl_files)',
     ],
+    'python_idl_files': [
+      '<@(python_core_idl_files)',
+      '<@(python_modules_idl_files)',
+      '<@(python_svg_idl_files)',
+    ],
+    'perl_and_python_idl_files': [
+        '<@(perl_idl_files)',
+        '<@(python_idl_files)',
+    ],

[haraken, 2013/07/08 06:06:29]

Shall we rename:

  perl_idl_files => idl_files_for_deprecated_perl
  python_idl_files => idl_files_for_python

to make it clear that the perl flow is deprecated? The same comment for other
target names.

[Nils Barth (inactive), 2013/07/09 08:48:16]

That's pretty clear, done (here and throughout)!

However, we have to keep _files as a suffix, as that's a magic extension
in GYP that means these are treated as path names:
https://code.google.com/p/gyp/wiki/InputFormatReference#Pathname_Relativization

+
+    'bindings_output_dir': '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings',

[Nils Barth (inactive), 2013/07/08 05:24:38]

(Added bindings_output_dir for clarity and consistency.)

     'generated_global_constructors_idl_files': [
          '<(SHARED_INTERMEDIATE_DIR)/WindowConstructors.idl',
          '<(SHARED_INTERMEDIATE_DIR)/WorkerGlobalScopeConstructors.idl',
          '<(SHARED_INTERMEDIATE_DIR)/SharedWorkerGlobalScopeConstructors.idl',
          '<(SHARED_INTERMEDIATE_DIR)/DedicatedWorkerGlobalScopeConstructors.idl',
     ],
 
     'conditions': [
       ['OS=="win" and buildtype=="Official"', {
         # On windows official release builds, we try to preserve symbol space.
         'derived_sources_aggregate_files': [
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSourcesAll.cpp',
+          '<(bindings_output_dir)/V8DerivedSourcesAll.cpp',
         ],
       },{
         'derived_sources_aggregate_files': [
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources01.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources02.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources03.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources04.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources05.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources06.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources07.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources08.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources09.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources10.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources11.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources12.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources13.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources14.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources15.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources16.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources17.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources18.cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8DerivedSources19.cpp',
+          '<(bindings_output_dir)/V8DerivedSources01.cpp',
+          '<(bindings_output_dir)/V8DerivedSources02.cpp',
+          '<(bindings_output_dir)/V8DerivedSources03.cpp',
+          '<(bindings_output_dir)/V8DerivedSources04.cpp',
+          '<(bindings_output_dir)/V8DerivedSources05.cpp',
+          '<(bindings_output_dir)/V8DerivedSources06.cpp',
+          '<(bindings_output_dir)/V8DerivedSources07.cpp',
+          '<(bindings_output_dir)/V8DerivedSources08.cpp',
+          '<(bindings_output_dir)/V8DerivedSources09.cpp',
+          '<(bindings_output_dir)/V8DerivedSources10.cpp',
+          '<(bindings_output_dir)/V8DerivedSources11.cpp',
+          '<(bindings_output_dir)/V8DerivedSources12.cpp',
+          '<(bindings_output_dir)/V8DerivedSources13.cpp',
+          '<(bindings_output_dir)/V8DerivedSources14.cpp',
+          '<(bindings_output_dir)/V8DerivedSources15.cpp',
+          '<(bindings_output_dir)/V8DerivedSources16.cpp',
+          '<(bindings_output_dir)/V8DerivedSources17.cpp',
+          '<(bindings_output_dir)/V8DerivedSources18.cpp',
+          '<(bindings_output_dir)/V8DerivedSources19.cpp',
         ],
       }],
       # The bindings generator can not write generated files if they are identical
       # to the already existing file – that way they don't need to be recompiled.
       # However, a reverse dependency having a newer timestamp than a
       # generated binding can confuse some build systems, so only use this on
       # ninja which explicitly supports this use case (gyp turns all actions into
       # ninja restat rules).
       ['"<(GENERATOR)"=="ninja"', {
         'write_file_only_if_changed': '--write-file-only-if-changed 1',
@@ skipping 10 matching lines @@
   },
 
   'targets': [{
     'target_name': 'supplemental_dependencies',
     'type': 'none',
     'actions': [{
       'action_name': 'generatePartialInterfacesDependency',
       'variables': {
         # Write sources into a file, so that the action command line won't
         # exceed OS limits.
-        'idl_files_list': '<|(idl_files_list.tmp <@(idl_files))',
+        'idl_files_list': '<|(idl_files_list.tmp <@(perl_and_python_idl_files))',
       },
       'inputs': [
         'scripts/preprocess_idls.py',
         '<(idl_files_list)',
         '<!@(cat <(idl_files_list))',
        ],
        'outputs': [
          '<(SHARED_INTERMEDIATE_DIR)/supplemental_dependency.tmp',
          '<@(generated_global_constructors_idl_files)',
          '<(SHARED_INTERMEDIATE_DIR)/EventNames.in',
@@ skipping 15 matching lines @@
          '--dedicatedworkerglobalscope-constructors-file',
          '<(SHARED_INTERMEDIATE_DIR)/DedicatedWorkerGlobalScopeConstructors.idl',
          '--event-names-file',
          '<(SHARED_INTERMEDIATE_DIR)/EventNames.in',
          '<@(write_file_only_if_changed)',
        ],
        'message': 'Resolving partial interfaces dependencies in all IDL files',
       }]
     },
     {
-      'target_name': 'bindings_sources',
+      'target_name': 'perl_bindings_sources',
       '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': [
         'supplemental_dependencies',
         '../core/core_derived_sources.gyp:generate_test_support_idls',
       ],
       'sources': [
-        '<@(idl_files)',
-        '<@(webcore_test_support_idl_files)',
+        '<@(perl_idl_files)',
+        '<@(perl_webcore_test_support_idl_files)',
       ],
       'rules': [{
-        'rule_name': 'binding',
+        'rule_name': 'perl_binding',
         'extension': 'idl',
         'msvs_external_rule': 1,
         'inputs': [
           'scripts/generate-bindings.pl',
           'scripts/CodeGeneratorV8.pm',
           'scripts/IDLParser.pm',
           'scripts/IDLSerializer.pm',
           '../core/scripts/preprocessor.pm',
           'scripts/IDLAttributes.txt',
           # FIXME: If the dependency structure changes, we rebuild all files,
           # since we're not computing dependencies file-by-file in the build.
           '<(SHARED_INTERMEDIATE_DIR)/supplemental_dependency.tmp',
           # FIXME: Similarly, if any partial interface changes, rebuild
           # everything, since every IDL potentially depends on them, because
           # we're not computing dependencies file-by-file.
-          '<!@pymod_do_main(supplemental_idl_files <@(idl_files))',
+          '<!@pymod_do_main(supplemental_idl_files <@(perl_and_python_idl_files))',
           # Generated IDLs are all partial interfaces, hence everything
           # potentially depends on them.
           '<@(generated_global_constructors_idl_files)',
         ],
         'outputs': [
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8<(RULE_INPUT_ROOT).cpp',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings/V8<(RULE_INPUT_ROOT).h',
+          '<(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': [
+            '--include', '../core',
             '--include', '../modules',
-            '--include', '../core',

[Nils Barth (inactive), 2013/07/08 05:24:38]

(Consistent order with overall IDL lists.)

             '--include', '<(SHARED_INTERMEDIATE_DIR)/webkit',
           ],
           # Hook for embedders to specify extra directories to find IDL files.
           'extra_blink_generator_include_dirs%': [],
         },
         'msvs_cygwin_shell': 0,
         # sanitize-win-build-log.sed uses a regex which matches this command
         # line (Perl script + .idl file being processed).
         # Update that regex if command line changes (other than changing flags)
         'action': [
           '<(perl_exe)',
           '-w',
           '-Iscripts',
           '-I../core/scripts',
           '-I../../../JSON/out/lib/perl5',
           'scripts/generate-bindings.pl',

[haraken, 2013/07/08 06:06:29]

Would you rename:

  generate-bindings.pl => deprecated_generate_bindings.pl
  IDLParser.pm => deprecated_idl_parser.pm
  CodeGeneratorV8.pm => deprecated_code_generator.pm

to make it clear that the perl flow is being deprecated?

[Nils Barth (inactive), 2013/07/09 08:48:16]

Done.

           '--outputDir',
-          '<(SHARED_INTERMEDIATE_DIR)/webkit/bindings',
+          '<(bindings_output_dir)',
           '--idlAttributesFile',
           'scripts/IDLAttributes.txt',
           '--defines',
           '<(feature_defines)',
           '<@(generator_include_dirs)',
           '<@(extra_blink_generator_include_dirs)',
           '--supplementalDependencyFile',
           '<(SHARED_INTERMEDIATE_DIR)/supplemental_dependency.tmp',
           '--additionalIdlFiles',
-          '<(webcore_test_support_idl_files)',
+          '<(perl_webcore_test_support_idl_files)',
           '<@(preprocessor)',
           '<@(write_file_only_if_changed)',
           '<(RULE_INPUT_PATH)',
         ],
         'message': 'Generating binding from <(RULE_INPUT_PATH)',
       }],
     },
     {
+      'target_name': 'python_bindings_sources',
+      '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': [
+        'supplemental_dependencies',
+        '../core/core_derived_sources.gyp:generate_test_support_idls',
+      ],
+      'sources': [
+        '<@(python_idl_files)',
+        '<@(python_webcore_test_support_idl_files)',
+      ],
+      'rules': [{
+        'rule_name': 'python_binding',
+        'extension': 'idl',
+        'msvs_external_rule': 1,
+        'inputs': [
+          'scripts/generate_bindings.py',
+          'scripts/build_ir.py',
+          'scripts/code_generator_v8.py',
+          'scripts/IDLAttributes.txt',
+          # FIXME: If the dependency structure changes, we rebuild all files,
+          # since we're not computing dependencies file-by-file in the build.
+          '<(SHARED_INTERMEDIATE_DIR)/supplemental_dependency.tmp',
+          # FIXME: Similarly, if any partial interface changes, rebuild
+          # everything, since every IDL potentially depends on them, because
+          # we're not computing dependencies file-by-file.
+          '<!@pymod_do_main(supplemental_idl_files <@(perl_and_python_idl_files))',
+          # Generated IDLs are all partial interfaces, hence everything
+          # potentially depends on them.
+          '<@(generated_global_constructors_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': [
+            '--include', '../core',
+            '--include', '../modules',
+            '--include', '<(SHARED_INTERMEDIATE_DIR)/webkit',
+          ],
+          # Hook for embedders to specify extra directories to find IDL files.
+          'extra_blink_generator_include_dirs%': [],
+        },
+        'msvs_cygwin_shell': 0,
+        # sanitize-win-build-log.sed uses a regex which matches this command
+        # line (Python script + .idl file being processed).
+        # Update that regex if command line changes (other than changing flags)
+        'action': [
+          'python',
+          'scripts/generate_bindings.py',
+          '--output-dir',
+          '<(bindings_output_dir)',
+          '--idl-attributes-file',
+          'scripts/IDLAttributes.txt',
+          '--defines',
+          '<(feature_defines)',
+          '<@(generator_include_dirs)',
+          '<@(extra_blink_generator_include_dirs)',
+          '--supplemental-dependency-file',
+          '<(SHARED_INTERMEDIATE_DIR)/supplemental_dependency.tmp',
+          '--additional-idl-files',
+          '<(python_webcore_test_support_idl_files)',
+          '<@(write_file_only_if_changed)',
+          '<(RULE_INPUT_PATH)',
+        ],
+        'message': 'Generating binding from <(RULE_INPUT_PATH)',
+      }],
+    },
+    {
       'target_name': 'bindings_derived_sources',
       'type': 'none',
       'dependencies': [
         'supplemental_dependencies',
-        'bindings_sources',
+        'perl_bindings_sources',
+        'python_bindings_sources',
       ],
       'actions': [{
         'action_name': 'derived_sources_all_in_one',
         'inputs': [
           '../core/scripts/action_derivedsourcesallinone.py',
           '<(SHARED_INTERMEDIATE_DIR)/supplemental_dependency.tmp',
         ],
         'outputs': [
           '<@(derived_sources_aggregate_files)',
         ],
         'action': [
           'python',
           '../core/scripts/action_derivedsourcesallinone.py',
           '<(SHARED_INTERMEDIATE_DIR)/supplemental_dependency.tmp',
           '--',
           '<@(derived_sources_aggregate_files)',
         ],
         'message': 'Generating bindings derived sources',
       }],
     },
   ],
 }