IDL: Add forEach() method to iterable<>/maplike<>/setlike<> interfaces

Source/bindings/scripts/v8_interface.py

 # Copyright (C) 2013 Google Inc. All rights reserved.
 # coding=utf-8
 #
 # 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 19 matching lines @@
 """Generate template values for an interface.
 
 Design doc: http://www.chromium.org/developers/design-documents/idl-compiler
 """
 
 from collections import defaultdict
 import itertools
 from operator import itemgetter
 
 import idl_definitions
-from idl_definitions import IdlOperation
+from idl_definitions import IdlOperation, IdlArgument
 import idl_types
 from idl_types import IdlType, inherits_interface
 import v8_attributes
 from v8_globals import includes
 import v8_methods
 import v8_types
 from v8_types import cpp_ptr_type, cpp_template_type
 import v8_utilities
 from v8_utilities import (cpp_name_or_partial, capitalize, conditional_string, cpp_name, gc_type,
                           has_extended_attribute_value, runtime_enabled_function_name,
@@ skipping 274 matching lines @@
     def generated_method(return_type, name, arguments=None, extended_attributes=None):
         operation = IdlOperation(interface.idl_name)
         operation.idl_type = return_type
         operation.name = name
         if arguments:
             operation.arguments = arguments
         if extended_attributes:
             operation.extended_attributes.update(extended_attributes)
         return v8_methods.method_context(interface, operation)
 
+    def generated_argument(idl_type, name, is_optional=False, default_value=None, extended_attributes=None):

[haraken, 2015/01/27 01:56:30]

It looks like default_value is unused.

[Jens Widell, 2015/01/27 07:19:23]

Yes, not needed at the moment. Not on the radar that it will be either, so might
as well remove it.

+        argument = IdlArgument(interface.idl_name)
+        argument.idl_type = idl_type
+        argument.name = name
+        argument.is_optional = is_optional
+        argument.default_value = default_value
+        if extended_attributes:
+            argument.extended_attributes.update(extended_attributes)
+        return argument
+
     # [Iterable], iterable<>, maplike<> and setlike<>
     iterator_method = None
     # FIXME: support Iterable in partial interfaces. However, we don't
     # need to support iterator overloads between interface and
     # partial interface definitions.
     # http://heycam.github.io/webidl/#idl-overloading
     if (not interface.is_partial
         and (interface.iterable or interface.maplike or interface.setlike
              or 'Iterable' in extended_attributes)):
 
         used_extended_attributes = {}
 
         if interface.iterable:
             used_extended_attributes.update(interface.iterable.extended_attributes)
         elif interface.maplike:
             used_extended_attributes.update(interface.maplike.extended_attributes)
         elif interface.setlike:
             used_extended_attributes.update(interface.setlike.extended_attributes)
 
         if 'RaisesException' in used_extended_attributes:
             raise ValueError('[RaisesException] is implied for iterable<>/maplike<>/setlike<>')
         if 'CallWith' in used_extended_attributes:
             raise ValueError('[CallWith=ScriptState] is implied for iterable<>/maplike<>/setlike<>')
 
         used_extended_attributes.update({
             'RaisesException': None,
             'CallWith': 'ScriptState',
         })
 
+        forEach_extended_attributes = used_extended_attributes.copy()

[haraken, 2015/01/27 01:56:30]

Can't we just use used_extended_attributes? In other words, is it important that
forEach_extended_attributes doesn't have 'RaisesException: None'?

[Jens Widell, 2015/01/27 07:19:23]

I am essentially using used_extended_attributes. I'm cloning it to modify
'CallWith' (adding 'ThisValue').

+        forEach_extended_attributes.update({
+            'CallWith': ['ScriptState', 'ThisValue'],
+        })
+
         def generated_iterator_method(name):
             return generated_method(
                 return_type=IdlType('Iterator'),
                 name=name,
                 extended_attributes=used_extended_attributes)
 
         iterator_method = generated_iterator_method('iterator')
 
         if interface.iterable or interface.maplike or interface.setlike:
             methods.extend([
                 generated_iterator_method('keys'),
                 generated_iterator_method('values'),
                 generated_iterator_method('entries'),
+
+                # void forEach(Function callback, [Default=Undefined] optional any thisArg)
+                generated_method(IdlType('void'), 'forEach',
+                                 arguments=[generated_argument(IdlType('Function'), 'callback'),
+                                            generated_argument(IdlType('any'), 'thisArg',
+                                                               is_optional=True,
+                                                               extended_attributes={'Default': 'Undefined'})],
+                                 extended_attributes=forEach_extended_attributes),
             ])
 
         # FIXME: maplike<> and setlike<> should also imply the presence of a
         # subset of keys(), values(), entries(), forEach(), has(), get(), add(),
         # set(), delete() and clear(), and a 'size' attribute.
 
     # Stringifier
     if interface.stringifier:
         stringifier = interface.stringifier
         stringifier_ext_attrs = stringifier.extended_attributes.copy()
@@ skipping 924 matching lines @@
         deleter = next(
             method
             for method in interface.operations
             if ('deleter' in method.specials and
                 len(method.arguments) == 1 and
                 str(method.arguments[0].idl_type) == 'DOMString'))
     except StopIteration:
         return None
 
     return property_deleter(deleter)