Roll IDL to Dartium37 (r181268)

bindings/scripts/v8_methods.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
+# in the documentation and/or other materials provided with the
+# distribution.
+#     * Neither the name of Google Inc. nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# 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 template values for methods.
+
+Extends IdlType and IdlUnionType with property |union_arguments|.
+
+Design doc: http://www.chromium.org/developers/design-documents/idl-compiler
+"""
+
+from idl_types import IdlType, IdlUnionType, inherits_interface
+from v8_globals import includes
+import v8_types
+import v8_utilities
+from v8_utilities import has_extended_attribute_value
+
+
+# Methods with any of these require custom method registration code in the
+# interface's configure*Template() function.
+CUSTOM_REGISTRATION_EXTENDED_ATTRIBUTES = frozenset([
+    'DoNotCheckSecurity',
+    'DoNotCheckSignature',
+    'NotEnumerable',
+    'ReadOnly',
+    'Unforgeable',
+])
+
+
+def argument_needs_try_catch(argument):
+    idl_type = argument.idl_type
+    base_type = not idl_type.array_or_sequence_type and idl_type.base_type
+
+    return not (
+        # These cases are handled by separate code paths in the
+        # generate_argument() macro in Source/bindings/templates/methods.cpp.
+        idl_type.is_callback_interface or
+        base_type == 'SerializedScriptValue' or
+        (argument.is_variadic and idl_type.is_wrapper_type) or
+        # String and enumeration arguments converted using one of the
+        # TOSTRING_* macros in Source/bindings/v8/V8BindingMacros.h don't
+        # use a v8::TryCatch.
+        (base_type == 'DOMString' and not argument.is_variadic))
+
+
+def generate_method(interface, method):
+    arguments = method.arguments
+    extended_attributes = method.extended_attributes
+    idl_type = method.idl_type
+    is_static = method.is_static
+    name = method.name
+
+    idl_type.add_includes_for_type()
+    this_cpp_value = cpp_value(interface, method, len(arguments))
+
+    def function_template():
+        if is_static:
+            return 'functionTemplate'
+        if 'Unforgeable' in extended_attributes:
+            return 'instanceTemplate'
+        return 'prototypeTemplate'
+
+    is_call_with_script_arguments = has_extended_attribute_value(method, 'CallWith', 'ScriptArguments')
+    if is_call_with_script_arguments:
+        includes.update(['bindings/v8/ScriptCallStackFactory.h',
+                         'core/inspector/ScriptArguments.h'])
+    is_call_with_script_state = has_extended_attribute_value(method, 'CallWith', 'ScriptState')
+    if is_call_with_script_state:
+        includes.add('bindings/v8/V8ScriptState.h')
+    is_check_security_for_node = 'CheckSecurity' in extended_attributes
+    if is_check_security_for_node:
+        includes.add('bindings/common/BindingSecurity.h')
+    is_custom_element_callbacks = 'CustomElementCallbacks' in extended_attributes
+    if is_custom_element_callbacks:
+        includes.add('core/dom/custom/CustomElementCallbackDispatcher.h')
+
+    has_event_listener_argument = any(
+        argument for argument in arguments
+        if argument.idl_type.name == 'EventListener')
+    is_check_security_for_frame = (
+        'CheckSecurity' in interface.extended_attributes and
+        'DoNotCheckSecurity' not in extended_attributes)
+    is_raises_exception = 'RaisesException' in extended_attributes
+
+    arguments_need_try_catch = any(argument_needs_try_catch(argument)
+                                   for argument in arguments)
+
+    return {
+        'activity_logging_world_list': v8_utilities.activity_logging_world_list(method),  # [ActivityLogging]
+        'arguments': [generate_argument(interface, method, argument, index)
+                      for index, argument in enumerate(arguments)],
+        'arguments_need_try_catch': arguments_need_try_catch,
+        'conditional_string': v8_utilities.conditional_string(method),
+        'cpp_type': idl_type.cpp_type,
+        'cpp_value': this_cpp_value,
+        'custom_registration_extended_attributes':
+            CUSTOM_REGISTRATION_EXTENDED_ATTRIBUTES.intersection(
+                extended_attributes.iterkeys()),
+        'deprecate_as': v8_utilities.deprecate_as(method),  # [DeprecateAs]
+        'function_template': function_template(),
+        'has_custom_registration': is_static or
+            v8_utilities.has_extended_attribute(
+                method, CUSTOM_REGISTRATION_EXTENDED_ATTRIBUTES),
+        'has_event_listener_argument': has_event_listener_argument,
+        'has_exception_state':
+            has_event_listener_argument or
+            is_raises_exception or
+            is_check_security_for_frame or
+            any(argument for argument in arguments
+                if argument.idl_type.name in ('ByteString',
+                                              'ScalarValueString',
+                                              'SerializedScriptValue') or
+                   argument.idl_type.is_integer_type),
+        'idl_type': idl_type.base_type,
+        'is_call_with_execution_context': has_extended_attribute_value(method, 'CallWith', 'ExecutionContext'),
+        'is_call_with_script_arguments': is_call_with_script_arguments,
+        'is_call_with_script_state': is_call_with_script_state,
+        'is_check_security_for_frame': is_check_security_for_frame,
+        'is_check_security_for_node': is_check_security_for_node,
+        'is_custom': 'Custom' in extended_attributes,
+        'is_custom_element_callbacks': is_custom_element_callbacks,
+        'is_do_not_check_security': 'DoNotCheckSecurity' in extended_attributes,
+        'is_do_not_check_signature': 'DoNotCheckSignature' in extended_attributes,
+        'is_partial_interface_member':
+            'PartialInterfaceImplementedAs' in extended_attributes,
+        'is_per_world_bindings': 'PerWorldBindings' in extended_attributes,
+        'is_raises_exception': is_raises_exception,
+        'is_read_only': 'ReadOnly' in extended_attributes,
+        'is_static': is_static,
+        'is_variadic': arguments and arguments[-1].is_variadic,
+        'measure_as': v8_utilities.measure_as(method),  # [MeasureAs]
+        'name': name,
+        'number_of_arguments': len(arguments),
+        'number_of_required_arguments': len([
+            argument for argument in arguments
+            if not (argument.is_optional or argument.is_variadic)]),
+        'number_of_required_or_variadic_arguments': len([
+            argument for argument in arguments
+            if not argument.is_optional]),
+        'per_context_enabled_function': v8_utilities.per_context_enabled_function_name(method),  # [PerContextEnabled]
+        'property_attributes': property_attributes(method),
+        'runtime_enabled_function': v8_utilities.runtime_enabled_function_name(method),  # [RuntimeEnabled]
+        'signature': 'v8::Local<v8::Signature>()' if is_static or 'DoNotCheckSignature' in extended_attributes else 'defaultSignature',
+        'union_arguments': idl_type.union_arguments,
+        'v8_set_return_value_for_main_world': v8_set_return_value(interface.name, method, this_cpp_value, for_main_world=True),
+        'v8_set_return_value': v8_set_return_value(interface.name, method, this_cpp_value),
+        'world_suffixes': ['', 'ForMainWorld'] if 'PerWorldBindings' in extended_attributes else [''],  # [PerWorldBindings]
+    }
+
+
+def generate_argument(interface, method, argument, index):
+    extended_attributes = argument.extended_attributes
+    idl_type = argument.idl_type
+    this_cpp_value = cpp_value(interface, method, index)
+    is_variadic_wrapper_type = argument.is_variadic and idl_type.is_wrapper_type
+
+    return {
+        'cpp_type': idl_type.cpp_type_args(extended_attributes=extended_attributes,
+                                           used_as_argument=True,
+                                           used_as_variadic_argument=argument.is_variadic),
+        'cpp_value': this_cpp_value,
+        # FIXME: check that the default value's type is compatible with the argument's
+        'default_value': str(argument.default_value) if argument.default_value else None,
+        'enum_validation_expression': idl_type.enum_validation_expression,
+        # FIXME: remove once [Default] removed and just use argument.default_value
+        'has_default': 'Default' in extended_attributes or argument.default_value,
+        'has_event_listener_argument': any(
+            argument_so_far for argument_so_far in method.arguments[:index]
+            if argument_so_far.idl_type.name == 'EventListener'),
+        'has_type_checking_interface':
+            (has_extended_attribute_value(interface, 'TypeChecking', 'Interface') or
+             has_extended_attribute_value(method, 'TypeChecking', 'Interface')) and
+            idl_type.is_wrapper_type,
+        'has_type_checking_unrestricted':
+            (has_extended_attribute_value(interface, 'TypeChecking', 'Unrestricted') or
+             has_extended_attribute_value(method, 'TypeChecking', 'Unrestricted')) and
+            idl_type.name in ('Float', 'Double'),
+        # Dictionary is special-cased, but arrays and sequences shouldn't be
+        'idl_type': not idl_type.array_or_sequence_type and idl_type.base_type,
+        'idl_type_object': idl_type,
+        'index': index,
+        'is_clamp': 'Clamp' in extended_attributes,
+        'is_callback_interface': idl_type.is_callback_interface,
+        'is_nullable': idl_type.is_nullable,
+        'is_optional': argument.is_optional,
+        'is_variadic_wrapper_type': is_variadic_wrapper_type,
+        'vector_type': v8_types.cpp_ptr_type('Vector', 'HeapVector', idl_type.gc_type),
+        'is_wrapper_type': idl_type.is_wrapper_type,
+        'name': argument.name,
+        'v8_set_return_value_for_main_world': v8_set_return_value(interface.name, method, this_cpp_value, for_main_world=True),
+        'v8_set_return_value': v8_set_return_value(interface.name, method, this_cpp_value),
+        'v8_value_to_local_cpp_value': v8_value_to_local_cpp_value(argument, index),
+    }
+
+
+################################################################################
+# Value handling
+################################################################################
+
+def cpp_value(interface, method, number_of_arguments):
+    def cpp_argument(argument):
+        idl_type = argument.idl_type
+        if idl_type.name == 'EventListener':
+            if (interface.name == 'EventTarget' and
+                method.name == 'removeEventListener'):
+                # FIXME: remove this special case by moving get() into
+                # EventTarget::removeEventListener
+                return '%s.get()' % argument.name
+            return argument.name
+        if (idl_type.is_callback_interface or
+            idl_type.name in ['NodeFilter', 'XPathNSResolver']):
+            # FIXME: remove this special case
+            return '%s.release()' % argument.name
+        return argument.name
+
+    # Truncate omitted optional arguments
+    arguments = method.arguments[:number_of_arguments]
+    cpp_arguments = []
+    if method.is_constructor:
+        call_with_values = interface.extended_attributes.get('ConstructorCallWith')
+    else:
+        call_with_values = method.extended_attributes.get('CallWith')
+    cpp_arguments.extend(v8_utilities.call_with_arguments(call_with_values))
+    # Members of IDL partial interface definitions are implemented in C++ as
+    # static member functions, which for instance members (non-static members)
+    # take *impl as their first argument
+    if ('PartialInterfaceImplementedAs' in method.extended_attributes and
+        not method.is_static):
+        cpp_arguments.append('*impl')
+    cpp_arguments.extend(cpp_argument(argument) for argument in arguments)
+    this_union_arguments = method.idl_type and method.idl_type.union_arguments
+    if this_union_arguments:
+        cpp_arguments.extend(this_union_arguments)
+
+    if ('RaisesException' in method.extended_attributes or
+        (method.is_constructor and
+         has_extended_attribute_value(interface, 'RaisesException', 'Constructor'))):
+        cpp_arguments.append('exceptionState')
+
+    if method.name == 'Constructor':
+        base_name = 'create'
+    elif method.name == 'NamedConstructor':
+        base_name = 'createForJSConstructor'
+    else:
+        base_name = v8_utilities.cpp_name(method)
+
+    cpp_method_name = v8_utilities.scoped_name(interface, method, base_name)
+    return '%s(%s)' % (cpp_method_name, ', '.join(cpp_arguments))
+
+
+def v8_set_return_value(interface_name, method, cpp_value, for_main_world=False):
+    idl_type = method.idl_type
+    extended_attributes = method.extended_attributes
+    if not idl_type or idl_type.name == 'void':
+        # Constructors and void methods don't have a return type
+        return None
+
+    release = False
+    # [CallWith=ScriptState], [RaisesException]
+    if (has_extended_attribute_value(method, 'CallWith', 'ScriptState') or
+        'RaisesException' in extended_attributes or
+        idl_type.is_union_type):
+        cpp_value = 'result'  # use local variable for value
+        release = idl_type.release
+
+    script_wrappable = 'impl' if inherits_interface(interface_name, 'Node') else ''
+    return idl_type.v8_set_return_value(cpp_value, extended_attributes, script_wrappable=script_wrappable, release=release, for_main_world=for_main_world)
+
+
+def v8_value_to_local_cpp_variadic_value(argument, index):
+    assert argument.is_variadic
+    idl_type = argument.idl_type
+
+    macro = 'TONATIVE_VOID_INTERNAL'
+    macro_args = [
+      argument.name,
+      'toNativeArguments<%s>(info, %s)' % (idl_type.cpp_type, index),
+    ]
+
+    return '%s(%s)' % (macro, ', '.join(macro_args))
+
+
+def v8_value_to_local_cpp_value(argument, index):
+    extended_attributes = argument.extended_attributes
+    idl_type = argument.idl_type
+    name = argument.name
+    if argument.is_variadic:
+        return v8_value_to_local_cpp_variadic_value(argument, index)
+    # FIXME: This special way of handling string arguments with null defaults
+    # can go away once we fully support default values.
+    if (argument.is_optional and
+        idl_type.name in ('String', 'ByteString', 'ScalarValueString') and
+        argument.default_value and argument.default_value.is_null):
+        v8_value = 'argumentOrNull(info, %s)' % index
+    else:
+        v8_value = 'info[%s]' % index
+    return idl_type.v8_value_to_local_cpp_value(extended_attributes, v8_value,
+                                                name, index=index, declare_variable=False)
+
+
+################################################################################
+# Auxiliary functions
+################################################################################
+
+# [NotEnumerable]
+def property_attributes(method):
+    extended_attributes = method.extended_attributes
+    property_attributes_list = []
+    if 'NotEnumerable' in extended_attributes:
+        property_attributes_list.append('v8::DontEnum')
+    if 'ReadOnly' in extended_attributes:
+        property_attributes_list.append('v8::ReadOnly')
+    if property_attributes_list:
+        property_attributes_list.insert(0, 'v8::DontDelete')
+    return property_attributes_list
+
+
+def union_arguments(idl_type):
+    """Return list of ['result0Enabled', 'result0', 'result1Enabled', ...] for union types, for use in setting return value"""
+    return [arg
+            for i in range(len(idl_type.member_types))
+            for arg in ['result%sEnabled' % i, 'result%s' % i]]
+
+IdlType.union_arguments = property(lambda self: None)
+IdlUnionType.union_arguments = property(union_arguments)