def method_context(self, interface, operation):
"""Create template values for generating method bindings."""
context = {
'idl_name':
operation.name,
'name':
capitalize_function_name(operation.name),
'type':
self.typed_object_to_cobalt_type(interface, operation),
'is_static':
operation.is_static,
'on_instance':
v8_utilities.on_instance(interface, operation),
'on_interface':
v8_utilities.on_interface(interface, operation),
'on_prototype':
v8_utilities.on_prototype(interface, operation),
'call_with':
operation.extended_attributes.get('CallWith', None),
'raises_exception':
operation.extended_attributes.has_key('RaisesException'),
'conditional':
operation.extended_attributes.get('Conditional', None),
'unsupported':
'NotSupported' in operation.extended_attributes,
}
context.update(self.partial_context(interface, operation))
return context
def method_context(interface, method, is_visible=True):
arguments = method.arguments
extended_attributes = method.extended_attributes
idl_type = method.idl_type
is_static = method.is_static
name = method.name
if is_visible:
idl_type.add_includes_for_type(extended_attributes)
this_cpp_value = cpp_value(interface, method, len(arguments))
is_implemented_in_private_script = 'ImplementedInPrivateScript' in extended_attributes
if is_implemented_in_private_script:
includes.add('bindings/core/v8/PrivateScriptRunner.h')
includes.add('core/frame/LocalFrame.h')
includes.add('platform/ScriptForbiddenScope.h')
# [OnlyExposedToPrivateScript]
is_only_exposed_to_private_script = 'OnlyExposedToPrivateScript' in extended_attributes
is_call_with_script_arguments = has_extended_attribute_value(method, 'CallWith', 'ScriptArguments')
if is_call_with_script_arguments:
includes.update(['bindings/core/v8/ScriptCallStackFactory.h',
'core/inspector/ScriptArguments.h'])
is_call_with_script_state = has_extended_attribute_value(method, 'CallWith', 'ScriptState')
is_call_with_this_value = has_extended_attribute_value(method, 'CallWith', 'ThisValue')
if is_call_with_script_state or is_call_with_this_value:
includes.add('bindings/core/v8/ScriptState.h')
is_check_security_for_node = 'CheckSecurity' in extended_attributes
if is_check_security_for_node:
includes.add('bindings/core/v8/BindingSecurity.h')
is_custom_element_callbacks = 'CustomElementCallbacks' in extended_attributes
if is_custom_element_callbacks:
includes.add('core/dom/custom/CustomElementProcessingStack.h')
is_do_not_check_security = 'DoNotCheckSecurity' in extended_attributes
is_check_security_for_frame = (
has_extended_attribute_value(interface, 'CheckSecurity', 'Frame') and
not is_do_not_check_security)
is_check_security_for_window = (
has_extended_attribute_value(interface, 'CheckSecurity', 'Window') and
not is_do_not_check_security)
is_raises_exception = 'RaisesException' in extended_attributes
is_custom_call_prologue = has_extended_attribute_value(method, 'Custom', 'CallPrologue')
is_custom_call_epilogue = has_extended_attribute_value(method, 'Custom', 'CallEpilogue')
is_post_message = 'PostMessage' in extended_attributes
if is_post_message:
includes.add('bindings/core/v8/SerializedScriptValueFactory.h')
includes.add('core/dom/DOMArrayBuffer.h')
includes.add('core/dom/MessagePort.h')
if 'LenientThis' in extended_attributes:
raise Exception('[LenientThis] is not supported for operations.')
return {
'activity_logging_world_list': v8_utilities.activity_logging_world_list(method), # [ActivityLogging]
'arguments': [argument_context(interface, method, argument, index, is_visible=is_visible)
for index, argument in enumerate(arguments)],
'argument_declarations_for_private_script':
argument_declarations_for_private_script(interface, method),
'conditional_string': v8_utilities.conditional_string(method),
'cpp_type': (v8_types.cpp_template_type('Nullable', idl_type.cpp_type)
if idl_type.is_explicit_nullable else idl_type.cpp_type),
'cpp_value': this_cpp_value,
'cpp_type_initializer': idl_type.cpp_type_initializer,
'custom_registration_extended_attributes':
CUSTOM_REGISTRATION_EXTENDED_ATTRIBUTES.intersection(
extended_attributes.iterkeys()),
'deprecate_as': v8_utilities.deprecate_as(method), # [DeprecateAs]
'exposed_test': v8_utilities.exposed(method, interface), # [Exposed]
# TODO(yukishiino): Retire has_custom_registration flag. Should be
# replaced with V8DOMConfiguration::PropertyLocationConfiguration.
'has_custom_registration':
is_static or
is_unforgeable(interface, method) or
v8_utilities.has_extended_attribute(
method, CUSTOM_REGISTRATION_EXTENDED_ATTRIBUTES),
'has_exception_state':
is_raises_exception or
is_check_security_for_frame or
is_check_security_for_window or
any(argument for argument in arguments
if (argument.idl_type.name == 'SerializedScriptValue' or
argument_conversion_needs_exception_state(method, argument))),
'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_call_with_this_value': is_call_with_this_value,
'is_check_security_for_frame': is_check_security_for_frame,
'is_check_security_for_node': is_check_security_for_node,
'is_check_security_for_window': is_check_security_for_window,
'is_custom': 'Custom' in extended_attributes and
not (is_custom_call_prologue or is_custom_call_epilogue),
'is_custom_call_prologue': is_custom_call_prologue,
'is_custom_call_epilogue': is_custom_call_epilogue,
'is_custom_element_callbacks': is_custom_element_callbacks,
'is_do_not_check_security': is_do_not_check_security,
'is_do_not_check_signature': 'DoNotCheckSignature' in extended_attributes,
'is_explicit_nullable': idl_type.is_explicit_nullable,
'is_implemented_in_private_script': is_implemented_in_private_script,
'is_partial_interface_member':
'PartialInterfaceImplementedAs' in extended_attributes,
'is_per_world_bindings': 'PerWorldBindings' in extended_attributes,
'is_post_message': is_post_message,
'is_raises_exception': is_raises_exception,
'is_read_only': is_unforgeable(interface, method),
'is_static': is_static,
'is_variadic': arguments and arguments[-1].is_variadic,
'measure_as': v8_utilities.measure_as(method, interface), # [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]),
'on_instance': v8_utilities.on_instance(interface, method),
'on_interface': v8_utilities.on_interface(interface, method),
'on_prototype': v8_utilities.on_prototype(interface, method),
'only_exposed_to_private_script': is_only_exposed_to_private_script,
'private_script_v8_value_to_local_cpp_value': idl_type.v8_value_to_local_cpp_value(
extended_attributes, 'v8Value', 'cppValue', isolate='scriptState->isolate()', bailout_return_value='false'),
'property_attributes': property_attributes(interface, method),
'returns_promise': method.returns_promise,
'runtime_enabled_function': v8_utilities.runtime_enabled_function_name(method), # [RuntimeEnabled]
'should_be_exposed_to_script': not (is_implemented_in_private_script and is_only_exposed_to_private_script),
'use_output_parameter_for_result': idl_type.use_output_parameter_for_result,
'use_local_result': use_local_result(method),
'v8_set_return_value': v8_set_return_value(interface.name, method, this_cpp_value),
'v8_set_return_value_for_main_world': v8_set_return_value(interface.name, method, this_cpp_value, for_main_world=True),
'visible': is_visible,
'world_suffixes': ['', 'ForMainWorld'] if 'PerWorldBindings' in extended_attributes else [''], # [PerWorldBindings],
}
def attribute_context(interface, attribute, interfaces, component_info):
"""Creates a Jinja template context for an attribute of an interface.
Args:
interface: An interface which |attribute| belongs to
attribute: An attribute to create the context for
interfaces: A dict which maps an interface name to the definition
which can be referred if needed
component_info: A dict containing component wide information
Returns:
A Jinja template context for |attribute|
"""
idl_type = attribute.idl_type
base_idl_type = idl_type.base_type
extended_attributes = attribute.extended_attributes
idl_type.add_includes_for_type(extended_attributes)
if idl_type.enum_values:
includes.add('core/inspector/console_message.h')
includes.add('platform/heap/heap.h')
# [CheckSecurity]
is_cross_origin = 'CrossOrigin' in extended_attributes
is_check_security_for_receiver = (has_extended_attribute_value(
interface, 'CheckSecurity', 'Receiver') and is_cross_origin)
is_check_security_for_return_value = (has_extended_attribute_value(
attribute, 'CheckSecurity', 'ReturnValue'))
if is_check_security_for_receiver or is_check_security_for_return_value:
includes.add('bindings/core/v8/binding_security.h')
if is_check_security_for_return_value:
includes.add('core/frame/web_feature.h')
includes.add('platform/instrumentation/use_counter.h')
# [CrossOrigin]
if has_extended_attribute_value(attribute, 'CrossOrigin', 'Setter'):
includes.add('platform/bindings/v8_cross_origin_callback_info.h')
# [Constructor]
# TODO(yukishiino): Constructors are much like methods although constructors
# are not methods. Constructors must be data-type properties, and we can
# support them as a kind of methods.
constructor_type = idl_type.constructor_type_name if is_constructor_attribute(
attribute) else None
# [CEReactions]
is_ce_reactions = 'CEReactions' in extended_attributes
if is_ce_reactions:
includes.add('core/html/custom/ce_reactions_scope.h')
# [CustomElementCallbacks], [Reflect]
is_custom_element_callbacks = 'CustomElementCallbacks' in extended_attributes
is_reflect = 'Reflect' in extended_attributes
# [ReflectOnly]
reflect_only = extended_attribute_value_as_list(attribute, 'ReflectOnly')
if reflect_only:
reflect_only = map(
lambda v: cpp_content_attribute_value_name(interface, v),
reflect_only)
if is_custom_element_callbacks or is_reflect:
includes.add('core/html/custom/v0_custom_element_processing_stack.h')
# [PerWorldBindings]
if 'PerWorldBindings' in extended_attributes:
assert idl_type.is_wrapper_type or 'LogActivity' in \
extended_attributes, \
'[PerWorldBindings] should only be used with wrapper types: %s.%s' % \
(interface.name, attribute.name)
# [SaveSameObject]
is_save_same_object = ('SameObject' in attribute.extended_attributes and
'SaveSameObject' in attribute.extended_attributes)
# [StringContext]
if idl_type.has_string_context:
includes.add('bindings/core/v8/generated_code_helper.h')
# [CachedAccessor]
is_cached_accessor = 'CachedAccessor' in extended_attributes
# [LenientSetter]
is_lenient_setter = 'LenientSetter' in extended_attributes
# [CachedAttribute]
cached_attribute_validation_method = extended_attributes.get(
'CachedAttribute')
keep_alive_for_gc = is_keep_alive_for_gc(interface, attribute)
does_generate_getter = (not has_custom_getter(attribute)
and not constructor_type)
does_generate_setter = (
has_setter(interface, attribute)
and not (has_custom_setter(attribute) or is_lenient_setter))
use_private_property_in_getter = (does_generate_getter
and (cached_attribute_validation_method
or is_save_same_object
or keep_alive_for_gc))
use_private_property_in_setter = (does_generate_setter
and cached_attribute_validation_method)
private_property_is_shared_between_getter_and_setter = (
use_private_property_in_getter and use_private_property_in_setter)
does_use_private_property = (use_private_property_in_getter
or use_private_property_in_setter
or is_cached_accessor)
if does_use_private_property:
includes.add('platform/bindings/v8_private_property.h')
# [LogActivity]
if 'LogActivity' in extended_attributes:
includes.add('platform/bindings/v8_per_context_data.h')
# [DeprecateAs], [MeasureAs]
deprecate_as = v8_utilities.deprecate_as(attribute)
measure_as = v8_utilities.measure_as(attribute, interface)
# [HighEntropy]
high_entropy = v8_utilities.high_entropy(attribute)
is_lazy_data_attribute = \
(constructor_type and not (measure_as or deprecate_as)) or \
(str(idl_type) == 'Window' and attribute.name in ('frames', 'self', 'window'))
runtime_features = component_info['runtime_enabled_features']
internal_name = cpp_encoded_property_name(attribute)
cpp_type = idl_type.cpp_type
if idl_type.is_explicit_nullable:
cpp_type = v8_types.cpp_template_type('base::Optional', cpp_type)
context = {
# [ActivityLogging]
'activity_logging_world_list_for_getter':
v8_utilities.activity_logging_world_list(attribute, 'Getter'),
# [ActivityLogging]
'activity_logging_world_list_for_setter':
v8_utilities.activity_logging_world_list(attribute, 'Setter'),
# [ActivityLogging]
'activity_logging_world_check':
v8_utilities.activity_logging_world_check(attribute),
'cached_accessor_name':
'k%s%s' % (interface.name, attribute.name.capitalize()),
'cached_attribute_validation_method':
cached_attribute_validation_method,
'camel_case_name':
NameStyleConverter(internal_name).to_upper_camel_case(),
'constructor_type':
constructor_type,
'context_enabled_feature_name':
v8_utilities.context_enabled_feature_name(attribute),
'cpp_name': cpp_name(attribute),
'cpp_type': cpp_type,
'cpp_type_initializer': idl_type.cpp_type_initializer,
'deprecate_as': deprecate_as,
'does_generate_getter': does_generate_getter,
'does_generate_setter': does_generate_setter,
'enum_type': idl_type.enum_type,
'enum_values': idl_type.enum_values,
# [Exposed]
'exposed_test':
v8_utilities.exposed(attribute, interface),
'getter_has_no_side_effect':
has_extended_attribute_value(attribute, 'Affects', 'Nothing'),
'has_cross_origin_getter':
has_extended_attribute_value(attribute, 'CrossOrigin', None) or
has_extended_attribute_value(attribute, 'CrossOrigin', 'Getter'),
'has_cross_origin_setter':
has_extended_attribute_value(attribute, 'CrossOrigin', 'Setter'),
'has_custom_getter': has_custom_getter(attribute),
'has_custom_setter': has_custom_setter(attribute),
'has_promise_type': idl_type.name == 'Promise',
'has_setter': has_setter(interface, attribute),
'high_entropy': high_entropy,
'idl_type': str(idl_type),
'is_cached_accessor': is_cached_accessor,
'is_call_with_execution_context':
has_extended_attribute_value(attribute, 'CallWith', 'ExecutionContext'),
'is_call_with_script_state':
has_extended_attribute_value(attribute, 'CallWith', 'ScriptState'),
'is_ce_reactions': is_ce_reactions,
'is_check_security_for_receiver': is_check_security_for_receiver,
'is_check_security_for_return_value':
is_check_security_for_return_value,
'is_custom_element_callbacks': is_custom_element_callbacks,
# TODO(yukishiino): Make all DOM attributes accessor-type properties.
'is_data_type_property': is_data_type_property(interface, attribute),
'is_getter_raises_exception': # [RaisesException]
'RaisesException' in extended_attributes and
extended_attributes['RaisesException'] in (None, 'Getter'),
'is_keep_alive_for_gc': keep_alive_for_gc,
'is_lazy_data_attribute': is_lazy_data_attribute,
'is_lenient_setter': is_lenient_setter,
'is_lenient_this': 'LegacyLenientThis' in extended_attributes,
'is_nullable': idl_type.is_nullable,
'is_explicit_nullable': idl_type.is_explicit_nullable,
'is_named_constructor': is_named_constructor_attribute(attribute),
'is_partial_interface_member':
'PartialInterfaceImplementedAs' in extended_attributes,
'is_per_world_bindings': 'PerWorldBindings' in extended_attributes,
'is_put_forwards': 'PutForwards' in extended_attributes,
'is_read_only': attribute.is_read_only,
'is_reflect': is_reflect,
'is_replaceable': 'Replaceable' in attribute.extended_attributes,
'is_save_same_object': is_save_same_object,
'is_static': attribute.is_static,
'is_url': 'URL' in extended_attributes,
'is_unforgeable': is_unforgeable(attribute),
'measure_as': measure_as,
'name': attribute.name,
'on_instance': v8_utilities.on_instance(interface, attribute),
'on_interface': v8_utilities.on_interface(interface, attribute),
'on_prototype': v8_utilities.on_prototype(interface, attribute),
# [RuntimeEnabled] for origin trial
'origin_trial_feature_name':
v8_utilities.origin_trial_feature_name(attribute, runtime_features),
'private_property_is_shared_between_getter_and_setter':
private_property_is_shared_between_getter_and_setter,
'property_attributes': property_attributes(interface, attribute),
'reflect_empty': cpp_content_attribute_value_name(
interface, extended_attributes.get('ReflectEmpty')),
'reflect_invalid': cpp_content_attribute_value_name(
interface, extended_attributes.get('ReflectInvalid', '')),
'reflect_missing': cpp_content_attribute_value_name(
interface, extended_attributes.get('ReflectMissing')),
'reflect_only': reflect_only,
# [RuntimeEnabled] if not in origin trial
'runtime_enabled_feature_name':
v8_utilities.runtime_enabled_feature_name(attribute, runtime_features),
# [SecureContext]
'secure_context_test': v8_utilities.secure_context(attribute, interface),
'use_output_parameter_for_result': idl_type.use_output_parameter_for_result,
'world_suffixes': (
['', 'ForMainWorld']
if 'PerWorldBindings' in extended_attributes
else ['']), # [PerWorldBindings]
}
if not has_custom_getter(attribute):
getter_context(interface, attribute, context)
if not has_custom_setter(attribute) and has_setter(interface, attribute):
setter_context(interface, attribute, interfaces, context)
# [RuntimeCallStatsCounter]
runtime_call_stats_context(interface, attribute, context)
# [CrossOrigin] is incompatible with a number of other attributes, so check
# for them here.
if is_cross_origin:
if context['has_cross_origin_setter'] and context['has_custom_setter']:
raise Exception(
'[CrossOrigin] and [Custom] are incompatible on the same setter: %s.%s',
interface.name, attribute.name)
if context['is_per_world_bindings']:
raise Exception(
'[CrossOrigin] and [PerWorldBindings] are incompatible: %s.%s',
interface.name, attribute.name)
if context['constructor_type']:
raise Exception(
'[CrossOrigin] cannot be used for constructors: %s.%s',
interface.name, attribute.name)
return context
def attribute_context(interface, attribute):
idl_type = attribute.idl_type
base_idl_type = idl_type.base_type
extended_attributes = attribute.extended_attributes
idl_type.add_includes_for_type(extended_attributes)
if idl_type.enum_values:
includes.add('core/inspector/ConsoleMessage.h')
# [CheckSecurity]
is_do_not_check_security = 'DoNotCheckSecurity' in extended_attributes
is_check_security_for_receiver = (has_extended_attribute_value(
interface, 'CheckSecurity', 'Receiver')
and not is_do_not_check_security)
is_check_security_for_return_value = (has_extended_attribute_value(
attribute, 'CheckSecurity', 'ReturnValue'))
if is_check_security_for_receiver or is_check_security_for_return_value:
includes.add('bindings/core/v8/BindingSecurity.h')
# [Constructor]
# TODO(yukishiino): Constructors are much like methods although constructors
# are not methods. Constructors must be data-type properties, and we can
# support them as a kind of methods.
constructor_type = idl_type.constructor_type_name if is_constructor_attribute(
attribute) else None
# [CustomElementCallbacks], [Reflect]
is_custom_element_callbacks = 'CustomElementCallbacks' in extended_attributes
is_reflect = 'Reflect' in extended_attributes
if is_custom_element_callbacks or is_reflect:
includes.add('core/dom/custom/CustomElementProcessingStack.h')
# [ImplementedInPrivateScript]
is_implemented_in_private_script = 'ImplementedInPrivateScript' in extended_attributes
if is_implemented_in_private_script:
includes.add('bindings/core/v8/PrivateScriptRunner.h')
includes.add('core/frame/LocalFrame.h')
includes.add('platform/ScriptForbiddenScope.h')
# [OnlyExposedToPrivateScript]
is_only_exposed_to_private_script = 'OnlyExposedToPrivateScript' in extended_attributes
# [PerWorldBindings]
if 'PerWorldBindings' in extended_attributes:
assert idl_type.is_wrapper_type or 'LogActivity' in extended_attributes, '[PerWorldBindings] should only be used with wrapper types: %s.%s' % (
interface.name, attribute.name)
if (base_idl_type == 'EventHandler'
and interface.name in ['Window', 'WorkerGlobalScope']
and attribute.name == 'onerror'):
includes.add('bindings/core/v8/V8ErrorHandler.h')
cached_attribute_validation_method = extended_attributes.get(
'CachedAttribute')
keep_alive_for_gc = is_keep_alive_for_gc(interface, attribute)
if cached_attribute_validation_method or keep_alive_for_gc:
includes.add('bindings/core/v8/V8HiddenValue.h')
if 'RuntimeEnabled' in extended_attributes:
includes.add('platform/RuntimeEnabledFeatures.h')
if 'OriginTrialEnabled' in extended_attributes:
includes.add('core/inspector/ConsoleMessage.h')
includes.add('core/origin_trials/OriginTrials.h')
context = {
'access_control_list': access_control_list(interface, attribute),
'activity_logging_world_list_for_getter': v8_utilities.activity_logging_world_list(attribute, 'Getter'), # [ActivityLogging]
'activity_logging_world_list_for_setter': v8_utilities.activity_logging_world_list(attribute, 'Setter'), # [ActivityLogging]
'activity_logging_world_check': v8_utilities.activity_logging_world_check(attribute), # [ActivityLogging]
'argument_cpp_type': idl_type.cpp_type_args(used_as_rvalue_type=True),
'cached_attribute_validation_method': cached_attribute_validation_method,
'constructor_type': constructor_type,
'cpp_name': cpp_name(attribute),
'cpp_type': idl_type.cpp_type,
'cpp_type_initializer': idl_type.cpp_type_initializer,
'deprecate_as': v8_utilities.deprecate_as(attribute), # [DeprecateAs]
'enum_type': idl_type.enum_type,
'enum_values': idl_type.enum_values,
'exposed_test': v8_utilities.exposed(attribute, interface), # [Exposed]
'has_custom_getter': has_custom_getter(attribute),
'has_custom_setter': has_custom_setter(attribute),
'has_setter': has_setter(attribute),
'idl_type': str(idl_type), # need trailing [] on array for Dictionary::ConversionContext::setConversionType
'is_origin_trial_enabled': v8_utilities.origin_trial_enabled_function(attribute) or v8_utilities.origin_trial_enabled_function(interface), # [OriginTrialEnabled]
'is_call_with_execution_context': has_extended_attribute_value(attribute, 'CallWith', 'ExecutionContext'),
'is_call_with_script_state': has_extended_attribute_value(attribute, 'CallWith', 'ScriptState'),
'is_check_security_for_receiver': is_check_security_for_receiver,
'is_check_security_for_return_value': is_check_security_for_return_value,
'is_custom_element_callbacks': is_custom_element_callbacks,
# TODO(yukishiino): Make all DOM attributes accessor-type properties.
'is_data_type_property': constructor_type or interface.name == 'Window' or interface.name == 'Location',
'is_getter_raises_exception': # [RaisesException]
'RaisesException' in extended_attributes and
extended_attributes['RaisesException'] in (None, 'Getter'),
'is_implemented_in_private_script': is_implemented_in_private_script,
'is_keep_alive_for_gc': keep_alive_for_gc,
'is_lenient_this': 'LenientThis' in extended_attributes,
'is_nullable': idl_type.is_nullable,
'is_explicit_nullable': idl_type.is_explicit_nullable,
'is_partial_interface_member':
'PartialInterfaceImplementedAs' in extended_attributes,
'is_per_world_bindings': 'PerWorldBindings' in extended_attributes,
'is_put_forwards': 'PutForwards' in extended_attributes,
'is_read_only': attribute.is_read_only,
'is_reflect': is_reflect,
'is_replaceable': 'Replaceable' in attribute.extended_attributes,
'is_static': attribute.is_static,
'is_url': 'URL' in extended_attributes,
'is_unforgeable': is_unforgeable(interface, attribute),
'on_instance': v8_utilities.on_instance(interface, attribute),
'on_interface': v8_utilities.on_interface(interface, attribute),
'on_prototype': v8_utilities.on_prototype(interface, attribute),
'origin_trial_enabled': v8_utilities.origin_trial_enabled_function(attribute), # [OriginTrialEnabled]
'origin_trial_enabled_per_interface': v8_utilities.origin_trial_enabled_function(interface), # [OriginTrialEnabled]
'origin_trial_name': extended_attributes.get('OriginTrialEnabled'), # [OriginTrialEnabled]
'use_output_parameter_for_result': idl_type.use_output_parameter_for_result,
'measure_as': v8_utilities.measure_as(attribute, interface), # [MeasureAs]
'name': attribute.name,
'only_exposed_to_private_script': is_only_exposed_to_private_script,
'private_script_v8_value_to_local_cpp_value': idl_type.v8_value_to_local_cpp_value(
extended_attributes, 'v8Value', 'cppValue', bailout_return_value='false', isolate='scriptState->isolate()'),
'property_attributes': property_attributes(interface, attribute),
'reflect_empty': extended_attributes.get('ReflectEmpty'),
'reflect_invalid': extended_attributes.get('ReflectInvalid', ''),
'reflect_missing': extended_attributes.get('ReflectMissing'),
'reflect_only': extended_attribute_value_as_list(attribute, 'ReflectOnly'),
'runtime_enabled_function': v8_utilities.runtime_enabled_function_name(attribute), # [RuntimeEnabled]
'should_be_exposed_to_script': not (is_implemented_in_private_script and is_only_exposed_to_private_script),
'world_suffixes': ['', 'ForMainWorld']
if 'PerWorldBindings' in extended_attributes
else [''], # [PerWorldBindings]
}
if is_constructor_attribute(attribute):
update_constructor_attribute_context(interface, attribute, context)
if not has_custom_getter(attribute):
getter_context(interface, attribute, context)
if not has_custom_setter(attribute) and has_setter(attribute):
setter_context(interface, attribute, context)
return context
def attribute_context(interface, attribute, interfaces):
"""Creates a Jinja template context for an attribute of an interface.
Args:
interface: An interface which |attribute| belongs to
attribute: An attribute to create the context for
interfaces: A dict which maps an interface name to the definition
which can be referred if needed
Returns:
A Jinja template context for |attribute|
"""
idl_type = attribute.idl_type
base_idl_type = idl_type.base_type
extended_attributes = attribute.extended_attributes
idl_type.add_includes_for_type(extended_attributes)
if idl_type.enum_values:
includes.add('core/inspector/ConsoleMessage.h')
# [CheckSecurity]
is_cross_origin = 'CrossOrigin' in extended_attributes
is_check_security_for_receiver = (has_extended_attribute_value(
interface, 'CheckSecurity', 'Receiver') and is_cross_origin)
is_check_security_for_return_value = (has_extended_attribute_value(
attribute, 'CheckSecurity', 'ReturnValue'))
if is_check_security_for_receiver or is_check_security_for_return_value:
includes.add('bindings/core/v8/BindingSecurity.h')
# [CrossOrigin]
if has_extended_attribute_value(attribute, 'CrossOrigin', 'Setter'):
includes.add('bindings/core/v8/V8CrossOriginSetterInfo.h')
# [Constructor]
# TODO(yukishiino): Constructors are much like methods although constructors
# are not methods. Constructors must be data-type properties, and we can
# support them as a kind of methods.
constructor_type = idl_type.constructor_type_name if is_constructor_attribute(
attribute) else None
# [CEReactions]
is_ce_reactions = 'CEReactions' in extended_attributes
if is_ce_reactions:
includes.add('core/dom/custom/CEReactionsScope.h')
# [CustomElementCallbacks], [Reflect]
is_custom_element_callbacks = 'CustomElementCallbacks' in extended_attributes
is_reflect = 'Reflect' in extended_attributes
if is_custom_element_callbacks or is_reflect:
includes.add('core/dom/custom/V0CustomElementProcessingStack.h')
# [PerWorldBindings]
if 'PerWorldBindings' in extended_attributes:
assert idl_type.is_wrapper_type or 'LogActivity' in extended_attributes, '[PerWorldBindings] should only be used with wrapper types: %s.%s' % (
interface.name, attribute.name)
# [SaveSameObject]
is_save_same_object = ('SameObject' in attribute.extended_attributes and
'SaveSameObject' in attribute.extended_attributes)
if is_save_same_object:
includes.add('bindings/core/v8/V8PrivateProperty.h')
if (base_idl_type == 'EventHandler'
and interface.name in ['Window', 'WorkerGlobalScope']
and attribute.name == 'onerror'):
includes.add('bindings/core/v8/V8ErrorHandler.h')
cached_attribute_validation_method = extended_attributes.get(
'CachedAttribute')
keep_alive_for_gc = is_keep_alive_for_gc(interface, attribute)
if cached_attribute_validation_method or keep_alive_for_gc:
includes.add('bindings/core/v8/V8HiddenValue.h')
# [CachedAccessor]
is_cached_accessor = 'CachedAccessor' in extended_attributes
if is_cached_accessor:
includes.add('bindings/core/v8/V8PrivateProperty.h')
context = {
'access_control_list': access_control_list(interface, attribute),
'activity_logging_world_list_for_getter': v8_utilities.activity_logging_world_list(attribute, 'Getter'), # [ActivityLogging]
'activity_logging_world_list_for_setter': v8_utilities.activity_logging_world_list(attribute, 'Setter'), # [ActivityLogging]
'activity_logging_world_check': v8_utilities.activity_logging_world_check(attribute), # [ActivityLogging]
'cached_attribute_validation_method': cached_attribute_validation_method,
'constructor_type': constructor_type,
'cpp_name': cpp_name(attribute),
'cpp_type': idl_type.cpp_type,
'cpp_type_initializer': idl_type.cpp_type_initializer,
'deprecate_as': v8_utilities.deprecate_as(attribute), # [DeprecateAs]
'enum_type': idl_type.enum_type,
'enum_values': idl_type.enum_values,
'exposed_test': v8_utilities.exposed(attribute, interface), # [Exposed]
'has_cross_origin_getter':
has_extended_attribute_value(attribute, 'CrossOrigin', None) or
has_extended_attribute_value(attribute, 'CrossOrigin', 'Getter'),
'has_cross_origin_setter': has_extended_attribute_value(attribute, 'CrossOrigin', 'Setter'),
'has_custom_getter': has_custom_getter(attribute),
'has_custom_setter': has_custom_setter(attribute),
'has_setter': has_setter(interface, attribute),
'idl_type': str(idl_type), # need trailing [] on array for Dictionary::ConversionContext::setConversionType
'is_cached_accessor': is_cached_accessor,
'is_call_with_execution_context': has_extended_attribute_value(attribute, 'CallWith', 'ExecutionContext'),
'is_call_with_script_state': has_extended_attribute_value(attribute, 'CallWith', 'ScriptState'),
'is_ce_reactions': is_ce_reactions,
'is_check_security_for_receiver': is_check_security_for_receiver,
'is_check_security_for_return_value': is_check_security_for_return_value,
'is_custom_element_callbacks': is_custom_element_callbacks,
# TODO(yukishiino): Make all DOM attributes accessor-type properties.
'is_data_type_property': is_data_type_property(interface, attribute),
'is_getter_raises_exception': # [RaisesException]
'RaisesException' in extended_attributes and
extended_attributes['RaisesException'] in (None, 'Getter'),
'is_keep_alive_for_gc': keep_alive_for_gc,
'is_lenient_this': 'LenientThis' in extended_attributes,
'is_nullable': idl_type.is_nullable,
'is_explicit_nullable': idl_type.is_explicit_nullable,
'is_partial_interface_member':
'PartialInterfaceImplementedAs' in extended_attributes,
'is_per_world_bindings': 'PerWorldBindings' in extended_attributes,
'is_put_forwards': 'PutForwards' in extended_attributes,
'is_read_only': attribute.is_read_only,
'is_reflect': is_reflect,
'is_replaceable': 'Replaceable' in attribute.extended_attributes,
'is_save_same_object': is_save_same_object,
'is_static': attribute.is_static,
'is_url': 'URL' in extended_attributes,
'is_unforgeable': is_unforgeable(interface, attribute),
'on_instance': v8_utilities.on_instance(interface, attribute),
'on_interface': v8_utilities.on_interface(interface, attribute),
'on_prototype': v8_utilities.on_prototype(interface, attribute),
'origin_trial_enabled_function': v8_utilities.origin_trial_enabled_function_name(attribute), # [OriginTrialEnabled]
'origin_trial_feature_name': v8_utilities.origin_trial_feature_name(attribute), # [OriginTrialEnabled]
'use_output_parameter_for_result': idl_type.use_output_parameter_for_result,
'measure_as': v8_utilities.measure_as(attribute, interface), # [MeasureAs]
'name': attribute.name,
'property_attributes': property_attributes(interface, attribute),
'reflect_empty': extended_attributes.get('ReflectEmpty'),
'reflect_invalid': extended_attributes.get('ReflectInvalid', ''),
'reflect_missing': extended_attributes.get('ReflectMissing'),
'reflect_only': extended_attribute_value_as_list(attribute, 'ReflectOnly'),
'runtime_enabled_feature_name': v8_utilities.runtime_enabled_feature_name(attribute), # [RuntimeEnabled]
'secure_context_test': v8_utilities.secure_context(attribute, interface), # [SecureContext]
'cached_accessor_name': '%s%sCachedAccessor' % (interface.name, attribute.name.capitalize()),
'world_suffixes': (
['', 'ForMainWorld']
if 'PerWorldBindings' in extended_attributes
else ['']), # [PerWorldBindings]
}
if is_constructor_attribute(attribute):
update_constructor_attribute_context(interface, attribute, context)
if not has_custom_getter(attribute):
getter_context(interface, attribute, context)
if not has_custom_setter(attribute) and has_setter(interface, attribute):
setter_context(interface, attribute, interfaces, context)
# [CrossOrigin] is incompatible with a number of other attributes, so check
# for them here.
if is_cross_origin:
if context['has_cross_origin_getter'] and context['has_custom_getter']:
raise Exception(
'[CrossOrigin] and [Custom] are incompatible on the same getter: %s.%s',
interface.name, attribute.name)
if context['has_cross_origin_setter'] and context['has_custom_setter']:
raise Exception(
'[CrossOrigin] and [Custom] are incompatible on the same setter: %s.%s',
interface.name, attribute.name)
if context['is_per_world_bindings']:
raise Exception(
'[CrossOrigin] and [PerWorldBindings] are incompatible: %s.%s',
interface.name, attribute.name)
if context['constructor_type']:
raise Exception(
'[CrossOrigin] cannot be used for constructors: %s.%s',
interface.name, attribute.name)
return context
def method_context(interface, method, is_visible=True):
arguments = method.arguments
extended_attributes = method.extended_attributes
idl_type = method.idl_type
is_static = method.is_static
name = method.name
if is_visible:
idl_type.add_includes_for_type(extended_attributes)
this_cpp_value = cpp_value(interface, method, len(arguments))
is_call_with_script_arguments = has_extended_attribute_value(method, 'CallWith', 'ScriptArguments')
if is_call_with_script_arguments:
includes.update(['bindings/core/v8/ScriptCallStack.h',
'core/inspector/ScriptArguments.h'])
is_call_with_script_state = has_extended_attribute_value(method, 'CallWith', 'ScriptState')
is_call_with_this_value = has_extended_attribute_value(method, 'CallWith', 'ThisValue')
if is_call_with_script_state or is_call_with_this_value:
includes.add('platform/bindings/ScriptState.h')
# [CheckSecurity]
is_cross_origin = 'CrossOrigin' in extended_attributes
is_check_security_for_receiver = (
has_extended_attribute_value(interface, 'CheckSecurity', 'Receiver') and
not is_cross_origin)
is_check_security_for_return_value = (
has_extended_attribute_value(method, 'CheckSecurity', 'ReturnValue'))
if is_check_security_for_receiver or is_check_security_for_return_value:
includes.add('bindings/core/v8/BindingSecurity.h')
is_ce_reactions = 'CEReactions' in extended_attributes
if is_ce_reactions:
includes.add('core/html/custom/CEReactionsScope.h')
is_custom_element_callbacks = 'CustomElementCallbacks' in extended_attributes
if is_custom_element_callbacks:
includes.add('core/html/custom/V0CustomElementProcessingStack.h')
is_raises_exception = 'RaisesException' in extended_attributes
is_custom_call_prologue = has_extended_attribute_value(method, 'Custom', 'CallPrologue')
is_custom_call_epilogue = has_extended_attribute_value(method, 'Custom', 'CallEpilogue')
is_post_message = 'PostMessage' in extended_attributes
if is_post_message:
includes.add('bindings/core/v8/serialization/SerializedScriptValueFactory.h')
includes.add('bindings/core/v8/serialization/Transferables.h')
includes.add('core/typed_arrays/DOMArrayBufferBase.h')
includes.add('core/imagebitmap/ImageBitmap.h')
if 'LenientThis' in extended_attributes:
raise Exception('[LenientThis] is not supported for operations.')
argument_contexts = [
argument_context(interface, method, argument, index, is_visible=is_visible)
for index, argument in enumerate(arguments)]
return {
'activity_logging_world_list': v8_utilities.activity_logging_world_list(method), # [ActivityLogging]
'arguments': argument_contexts,
'cpp_type': (v8_types.cpp_template_type('Nullable', idl_type.cpp_type)
if idl_type.is_explicit_nullable else idl_type.cpp_type),
'cpp_value': this_cpp_value,
'cpp_type_initializer': idl_type.cpp_type_initializer,
'deprecate_as': v8_utilities.deprecate_as(method), # [DeprecateAs]
'do_not_test_new_object': 'DoNotTestNewObject' in extended_attributes,
'exposed_test': v8_utilities.exposed(method, interface), # [Exposed]
'has_exception_state':
is_raises_exception or
is_check_security_for_receiver or
any(argument for argument in arguments
if (argument.idl_type.name == 'SerializedScriptValue' or
argument_conversion_needs_exception_state(method, argument))),
'has_optional_argument_without_default_value':
any(True for argument_context in argument_contexts
if argument_context['is_optional_without_default_value']),
'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_call_with_this_value': is_call_with_this_value,
'is_ce_reactions': is_ce_reactions,
'is_check_security_for_receiver': is_check_security_for_receiver,
'is_check_security_for_return_value': is_check_security_for_return_value,
'is_cross_origin': 'CrossOrigin' in extended_attributes,
'is_custom': 'Custom' in extended_attributes and
not (is_custom_call_prologue or is_custom_call_epilogue),
'is_custom_call_prologue': is_custom_call_prologue,
'is_custom_call_epilogue': is_custom_call_epilogue,
'is_custom_element_callbacks': is_custom_element_callbacks,
'is_explicit_nullable': idl_type.is_explicit_nullable,
'is_new_object': 'NewObject' in extended_attributes,
'is_partial_interface_member':
'PartialInterfaceImplementedAs' in extended_attributes,
'is_per_world_bindings': 'PerWorldBindings' in extended_attributes,
'is_post_message': is_post_message,
'is_raises_exception': is_raises_exception,
'is_static': is_static,
'is_unforgeable': is_unforgeable(interface, method),
'is_variadic': arguments and arguments[-1].is_variadic,
'measure_as': v8_utilities.measure_as(method, interface), # [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]),
'on_instance': v8_utilities.on_instance(interface, method),
'on_interface': v8_utilities.on_interface(interface, method),
'on_prototype': v8_utilities.on_prototype(interface, method),
'origin_trial_enabled_function': v8_utilities.origin_trial_enabled_function_name(method), # [OriginTrialEnabled]
'origin_trial_feature_name': v8_utilities.origin_trial_feature_name(method), # [OriginTrialEnabled]
'property_attributes': property_attributes(interface, method),
'returns_promise': method.returns_promise,
'runtime_call_stats': runtime_call_stats_context(interface, method),
'runtime_enabled_feature_name': v8_utilities.runtime_enabled_feature_name(method), # [RuntimeEnabled]
'secure_context_test': v8_utilities.secure_context(method, interface), # [SecureContext]
'use_output_parameter_for_result': idl_type.use_output_parameter_for_result,
'use_local_result': use_local_result(method),
'v8_set_return_value': v8_set_return_value(interface.name, method, this_cpp_value),
'v8_set_return_value_for_main_world': v8_set_return_value(interface.name, method, this_cpp_value, for_main_world=True),
'visible': is_visible,
'world_suffixes': ['', 'ForMainWorld'] if 'PerWorldBindings' in extended_attributes else [''], # [PerWorldBindings],
}
def attribute_context(interface, attribute):
idl_type = attribute.idl_type
base_idl_type = idl_type.base_type
extended_attributes = attribute.extended_attributes
idl_type.add_includes_for_type(extended_attributes)
if idl_type.enum_values:
includes.add("core/inspector/ConsoleMessage.h")
# [CheckSecurity]
is_do_not_check_security = "DoNotCheckSecurity" in extended_attributes
is_check_security_for_receiver = (
has_extended_attribute_value(interface, "CheckSecurity", "Receiver") and not is_do_not_check_security
)
is_check_security_for_return_value = has_extended_attribute_value(attribute, "CheckSecurity", "ReturnValue")
if is_check_security_for_receiver or is_check_security_for_return_value:
includes.add("bindings/core/v8/BindingSecurity.h")
# [Constructor]
# TODO(yukishiino): Constructors are much like methods although constructors
# are not methods. Constructors must be data-type properties, and we can
# support them as a kind of methods.
constructor_type = idl_type.constructor_type_name if is_constructor_attribute(attribute) else None
# [CustomElementCallbacks], [Reflect]
is_custom_element_callbacks = "CustomElementCallbacks" in extended_attributes
is_reflect = "Reflect" in extended_attributes
if is_custom_element_callbacks or is_reflect:
includes.add("core/dom/custom/CustomElementProcessingStack.h")
# [ImplementedInPrivateScript]
is_implemented_in_private_script = "ImplementedInPrivateScript" in extended_attributes
if is_implemented_in_private_script:
includes.add("bindings/core/v8/PrivateScriptRunner.h")
includes.add("core/frame/LocalFrame.h")
includes.add("platform/ScriptForbiddenScope.h")
# [OnlyExposedToPrivateScript]
is_only_exposed_to_private_script = "OnlyExposedToPrivateScript" in extended_attributes
# [PerWorldBindings]
if "PerWorldBindings" in extended_attributes:
assert (
idl_type.is_wrapper_type or "LogActivity" in extended_attributes
), "[PerWorldBindings] should only be used with wrapper types: %s.%s" % (interface.name, attribute.name)
if (
base_idl_type == "EventHandler"
and interface.name in ["Window", "WorkerGlobalScope"]
and attribute.name == "onerror"
):
includes.add("bindings/core/v8/V8ErrorHandler.h")
conditional_string = v8_utilities.conditional_string(attribute)
if conditional_string:
includes.add("wtf/build_config.h")
cached_attribute_validation_method = extended_attributes.get("CachedAttribute")
keep_alive_for_gc = is_keep_alive_for_gc(interface, attribute)
if cached_attribute_validation_method or keep_alive_for_gc:
includes.add("bindings/core/v8/V8HiddenValue.h")
if "APIExperimentEnabled" in extended_attributes:
includes.add("core/experiments/ExperimentalFeatures.h")
includes.add("core/inspector/ConsoleMessage.h")
context = {
"access_control_list": access_control_list(interface, attribute),
"activity_logging_world_list_for_getter": v8_utilities.activity_logging_world_list(
attribute, "Getter"
), # [ActivityLogging]
"activity_logging_world_list_for_setter": v8_utilities.activity_logging_world_list(
attribute, "Setter"
), # [ActivityLogging]
"activity_logging_world_check": v8_utilities.activity_logging_world_check(attribute), # [ActivityLogging]
"api_experiment_enabled": v8_utilities.api_experiment_enabled_function(attribute), # [APIExperimentEnabled]
"api_experiment_enabled_per_interface": v8_utilities.api_experiment_enabled_function(
interface
), # [APIExperimentEnabled]
"api_experiment_name": extended_attributes.get("APIExperimentEnabled"), # [APIExperimentEnabled]
"argument_cpp_type": idl_type.cpp_type_args(used_as_rvalue_type=True),
"cached_attribute_validation_method": cached_attribute_validation_method,
"conditional_string": conditional_string,
"constructor_type": constructor_type,
"cpp_name": cpp_name(attribute),
"cpp_type": idl_type.cpp_type,
"cpp_type_initializer": idl_type.cpp_type_initializer,
"deprecate_as": v8_utilities.deprecate_as(attribute), # [DeprecateAs]
"enum_type": idl_type.enum_type,
"enum_values": idl_type.enum_values,
"exposed_test": v8_utilities.exposed(attribute, interface), # [Exposed]
"has_custom_getter": has_custom_getter(attribute),
"has_custom_setter": has_custom_setter(attribute),
"has_setter": has_setter(attribute),
"idl_type": str(idl_type), # need trailing [] on array for Dictionary::ConversionContext::setConversionType
"is_api_experiment_enabled": v8_utilities.api_experiment_enabled_function(attribute)
or v8_utilities.api_experiment_enabled_function(interface), # [APIExperimentEnabled]
"is_call_with_execution_context": has_extended_attribute_value(attribute, "CallWith", "ExecutionContext"),
"is_call_with_script_state": has_extended_attribute_value(attribute, "CallWith", "ScriptState"),
"is_check_security_for_receiver": is_check_security_for_receiver,
"is_check_security_for_return_value": is_check_security_for_return_value,
"is_custom_element_callbacks": is_custom_element_callbacks,
# TODO(yukishiino): Make all DOM attributes accessor-type properties.
"is_data_type_property": constructor_type or interface.name == "Window" or interface.name == "Location",
"is_getter_raises_exception": "RaisesException" in extended_attributes # [RaisesException]
and extended_attributes["RaisesException"] in (None, "Getter"),
"is_implemented_in_private_script": is_implemented_in_private_script,
"is_keep_alive_for_gc": keep_alive_for_gc,
"is_lenient_this": "LenientThis" in extended_attributes,
"is_nullable": idl_type.is_nullable,
"is_explicit_nullable": idl_type.is_explicit_nullable,
"is_partial_interface_member": "PartialInterfaceImplementedAs" in extended_attributes,
"is_per_world_bindings": "PerWorldBindings" in extended_attributes,
"is_put_forwards": "PutForwards" in extended_attributes,
"is_read_only": attribute.is_read_only,
"is_reflect": is_reflect,
"is_replaceable": "Replaceable" in attribute.extended_attributes,
"is_static": attribute.is_static,
"is_url": "URL" in extended_attributes,
"is_unforgeable": is_unforgeable(interface, attribute),
"on_instance": v8_utilities.on_instance(interface, attribute),
"on_interface": v8_utilities.on_interface(interface, attribute),
"on_prototype": v8_utilities.on_prototype(interface, attribute),
"use_output_parameter_for_result": idl_type.use_output_parameter_for_result,
"measure_as": v8_utilities.measure_as(attribute, interface), # [MeasureAs]
"name": attribute.name,
"only_exposed_to_private_script": is_only_exposed_to_private_script,
"private_script_v8_value_to_local_cpp_value": idl_type.v8_value_to_local_cpp_value(
extended_attributes, "v8Value", "cppValue", bailout_return_value="false", isolate="scriptState->isolate()"
),
"property_attributes": property_attributes(interface, attribute),
"reflect_empty": extended_attributes.get("ReflectEmpty"),
"reflect_invalid": extended_attributes.get("ReflectInvalid", ""),
"reflect_missing": extended_attributes.get("ReflectMissing"),
"reflect_only": extended_attribute_value_as_list(attribute, "ReflectOnly"),
"runtime_enabled_function": v8_utilities.runtime_enabled_function_name(attribute), # [RuntimeEnabled]
"should_be_exposed_to_script": not (is_implemented_in_private_script and is_only_exposed_to_private_script),
"world_suffixes": ["", "ForMainWorld"]
if "PerWorldBindings" in extended_attributes
else [""], # [PerWorldBindings]
}
if is_constructor_attribute(attribute):
update_constructor_attribute_context(interface, attribute, context)
if not has_custom_getter(attribute):
getter_context(interface, attribute, context)
if not has_custom_setter(attribute) and has_setter(attribute):
setter_context(interface, attribute, context)
return context
def method_context(interface, method, is_visible=True):
arguments = method.arguments
extended_attributes = method.extended_attributes
idl_type = method.idl_type
is_static = method.is_static
name = method.name
if is_visible:
idl_type.add_includes_for_type(extended_attributes)
this_cpp_value = cpp_value(interface, method, len(arguments))
is_implemented_in_private_script = 'ImplementedInPrivateScript' in extended_attributes
if is_implemented_in_private_script:
includes.add('bindings/core/v8/PrivateScriptRunner.h')
includes.add('core/frame/LocalFrame.h')
includes.add('platform/ScriptForbiddenScope.h')
# [OnlyExposedToPrivateScript]
is_only_exposed_to_private_script = 'OnlyExposedToPrivateScript' in extended_attributes
is_call_with_script_arguments = has_extended_attribute_value(
method, 'CallWith', 'ScriptArguments')
if is_call_with_script_arguments:
includes.update([
'bindings/core/v8/ScriptCallStack.h',
'core/inspector/ScriptArguments.h'
])
is_call_with_script_state = has_extended_attribute_value(
method, 'CallWith', 'ScriptState')
is_call_with_this_value = has_extended_attribute_value(
method, 'CallWith', 'ThisValue')
if is_call_with_script_state or is_call_with_this_value:
includes.add('bindings/core/v8/ScriptState.h')
# [CheckSecurity]
is_do_not_check_security = 'DoNotCheckSecurity' in extended_attributes
is_check_security_for_receiver = (has_extended_attribute_value(
interface, 'CheckSecurity', 'Receiver')
and not is_do_not_check_security)
is_check_security_for_return_value = (has_extended_attribute_value(
method, 'CheckSecurity', 'ReturnValue'))
if is_check_security_for_receiver or is_check_security_for_return_value:
includes.add('bindings/core/v8/BindingSecurity.h')
is_ce_reactions = 'CEReactions' in extended_attributes
if is_ce_reactions:
includes.add('core/dom/custom/CEReactionsScope.h')
is_custom_element_callbacks = 'CustomElementCallbacks' in extended_attributes
if is_custom_element_callbacks:
includes.add('core/dom/custom/V0CustomElementProcessingStack.h')
is_raises_exception = 'RaisesException' in extended_attributes
is_custom_call_prologue = has_extended_attribute_value(
method, 'Custom', 'CallPrologue')
is_custom_call_epilogue = has_extended_attribute_value(
method, 'Custom', 'CallEpilogue')
is_post_message = 'PostMessage' in extended_attributes
if is_post_message:
includes.add('bindings/core/v8/SerializedScriptValueFactory.h')
includes.add('bindings/core/v8/Transferables.h')
includes.add('core/dom/DOMArrayBufferBase.h')
if 'LenientThis' in extended_attributes:
raise Exception('[LenientThis] is not supported for operations.')
argument_contexts = [
argument_context(interface,
method,
argument,
index,
is_visible=is_visible)
for index, argument in enumerate(arguments)
]
return {
'activity_logging_world_list':
v8_utilities.activity_logging_world_list(method), # [ActivityLogging]
'arguments':
argument_contexts,
'argument_declarations_for_private_script':
argument_declarations_for_private_script(interface, method),
'cpp_type': (v8_types.cpp_template_type('Nullable', idl_type.cpp_type)
if idl_type.is_explicit_nullable else idl_type.cpp_type),
'cpp_value':
this_cpp_value,
'cpp_type_initializer':
idl_type.cpp_type_initializer,
'custom_registration_extended_attributes':
CUSTOM_REGISTRATION_EXTENDED_ATTRIBUTES.intersection(
extended_attributes.iterkeys()),
'deprecate_as':
v8_utilities.deprecate_as(method), # [DeprecateAs]
'do_not_test_new_object':
'DoNotTestNewObject' in extended_attributes,
'exposed_test':
v8_utilities.exposed(method, interface), # [Exposed]
# TODO(yukishiino): Retire has_custom_registration flag. Should be
# replaced with V8DOMConfiguration::PropertyLocationConfiguration.
'has_custom_registration':
v8_utilities.has_extended_attribute(
method, CUSTOM_REGISTRATION_EXTENDED_ATTRIBUTES),
'has_exception_state':
is_raises_exception or is_check_security_for_receiver
or any(argument for argument in arguments if (
argument.idl_type.name == 'SerializedScriptValue'
or argument_conversion_needs_exception_state(method, argument))),
'has_optional_argument_without_default_value':
any(True for argument_context in argument_contexts
if argument_context['is_optional_without_default_value']),
'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_call_with_this_value':
is_call_with_this_value,
'is_ce_reactions':
is_ce_reactions,
'is_check_security_for_receiver':
is_check_security_for_receiver,
'is_check_security_for_return_value':
is_check_security_for_return_value,
'is_custom':
'Custom' in extended_attributes
and not (is_custom_call_prologue or is_custom_call_epilogue),
'is_custom_call_prologue':
is_custom_call_prologue,
'is_custom_call_epilogue':
is_custom_call_epilogue,
'is_custom_element_callbacks':
is_custom_element_callbacks,
'is_do_not_check_security':
is_do_not_check_security,
'is_explicit_nullable':
idl_type.is_explicit_nullable,
'is_implemented_in_private_script':
is_implemented_in_private_script,
'is_new_object':
'NewObject' in extended_attributes,
'is_partial_interface_member':
'PartialInterfaceImplementedAs' in extended_attributes,
'is_per_world_bindings':
'PerWorldBindings' in extended_attributes,
'is_post_message':
is_post_message,
'is_raises_exception':
is_raises_exception,
'is_static':
is_static,
'is_unforgeable':
is_unforgeable(interface, method),
'is_variadic':
arguments and arguments[-1].is_variadic,
'measure_as':
v8_utilities.measure_as(method, interface), # [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]),
'on_instance':
v8_utilities.on_instance(interface, method),
'on_interface':
v8_utilities.on_interface(interface, method),
'on_prototype':
v8_utilities.on_prototype(interface, method),
'only_exposed_to_private_script':
is_only_exposed_to_private_script,
'origin_trial_enabled_function':
v8_utilities.origin_trial_enabled_function_name(
method), # [OriginTrialEnabled]
'origin_trial_feature_name':
v8_utilities.origin_trial_feature_name(method), # [OriginTrialEnabled]
'private_script_v8_value_to_local_cpp_value':
idl_type.v8_value_to_local_cpp_value(extended_attributes,
'v8Value',
'cppValue',
isolate='scriptState->isolate()',
bailout_return_value='false'),
'property_attributes':
property_attributes(interface, method),
'returns_promise':
method.returns_promise,
'runtime_enabled_function':
v8_utilities.runtime_enabled_function_name(method), # [RuntimeEnabled]
'secure_context_test':
v8_utilities.secure_context(method, interface), # [SecureContext]
'should_be_exposed_to_script':
not (is_implemented_in_private_script
and is_only_exposed_to_private_script),
'use_output_parameter_for_result':
idl_type.use_output_parameter_for_result,
'use_local_result':
use_local_result(method),
'v8_set_return_value':
v8_set_return_value(interface.name, method, this_cpp_value),
'v8_set_return_value_for_main_world':
v8_set_return_value(interface.name,
method,
this_cpp_value,
for_main_world=True),
'visible':
is_visible,
'world_suffixes': ['', 'ForMainWorld'] if 'PerWorldBindings'
in extended_attributes else [''], # [PerWorldBindings],
}
def attribute_context(interface, attribute, interfaces):
"""Creates a Jinja template context for an attribute of an interface.
Args:
interface: An interface which |attribute| belongs to
attribute: An attribute to create the context for
interfaces: A dict which maps an interface name to the definition
which can be referred if needed
Returns:
A Jinja template context for |attribute|
"""
idl_type = attribute.idl_type
base_idl_type = idl_type.base_type
extended_attributes = attribute.extended_attributes
idl_type.add_includes_for_type(extended_attributes)
if idl_type.enum_values:
includes.add('core/inspector/ConsoleMessage.h')
# [CheckSecurity]
is_cross_origin = 'CrossOrigin' in extended_attributes
is_check_security_for_receiver = (
has_extended_attribute_value(interface, 'CheckSecurity', 'Receiver') and
is_cross_origin)
is_check_security_for_return_value = (
has_extended_attribute_value(attribute, 'CheckSecurity', 'ReturnValue'))
if is_check_security_for_receiver or is_check_security_for_return_value:
includes.add('bindings/core/v8/BindingSecurity.h')
# [CrossOrigin]
if has_extended_attribute_value(attribute, 'CrossOrigin', 'Setter'):
includes.add('bindings/core/v8/V8CrossOriginSetterInfo.h')
# [Constructor]
# TODO(yukishiino): Constructors are much like methods although constructors
# are not methods. Constructors must be data-type properties, and we can
# support them as a kind of methods.
constructor_type = idl_type.constructor_type_name if is_constructor_attribute(attribute) else None
# [CEReactions]
is_ce_reactions = 'CEReactions' in extended_attributes
if is_ce_reactions:
includes.add('core/dom/custom/CEReactionsScope.h')
# [CustomElementCallbacks], [Reflect]
is_custom_element_callbacks = 'CustomElementCallbacks' in extended_attributes
is_reflect = 'Reflect' in extended_attributes
if is_custom_element_callbacks or is_reflect:
includes.add('core/dom/custom/V0CustomElementProcessingStack.h')
# [ImplementedInPrivateScript]
is_implemented_in_private_script = 'ImplementedInPrivateScript' in extended_attributes
if is_implemented_in_private_script:
includes.add('bindings/core/v8/PrivateScriptRunner.h')
includes.add('core/frame/LocalFrame.h')
includes.add('platform/ScriptForbiddenScope.h')
# [OnlyExposedToPrivateScript]
is_only_exposed_to_private_script = 'OnlyExposedToPrivateScript' in extended_attributes
# [PerWorldBindings]
if 'PerWorldBindings' in extended_attributes:
assert idl_type.is_wrapper_type or 'LogActivity' in extended_attributes, '[PerWorldBindings] should only be used with wrapper types: %s.%s' % (interface.name, attribute.name)
# [SaveSameObject]
is_save_same_object = (
'SameObject' in attribute.extended_attributes and
'SaveSameObject' in attribute.extended_attributes)
if is_save_same_object:
includes.add('bindings/core/v8/V8PrivateProperty.h')
if (base_idl_type == 'EventHandler' and
interface.name in ['Window', 'WorkerGlobalScope'] and
attribute.name == 'onerror'):
includes.add('bindings/core/v8/V8ErrorHandler.h')
cached_attribute_validation_method = extended_attributes.get('CachedAttribute')
keep_alive_for_gc = is_keep_alive_for_gc(interface, attribute)
if cached_attribute_validation_method or keep_alive_for_gc:
includes.add('bindings/core/v8/V8HiddenValue.h')
# [CachedAccessor]
is_cached_accessor = 'CachedAccessor' in extended_attributes
if is_cached_accessor:
includes.add('bindings/core/v8/V8PrivateProperty.h')
context = {
'access_control_list': access_control_list(interface, attribute),
'activity_logging_world_list_for_getter': v8_utilities.activity_logging_world_list(attribute, 'Getter'), # [ActivityLogging]
'activity_logging_world_list_for_setter': v8_utilities.activity_logging_world_list(attribute, 'Setter'), # [ActivityLogging]
'activity_logging_world_check': v8_utilities.activity_logging_world_check(attribute), # [ActivityLogging]
'argument_cpp_type': idl_type.cpp_type_args(used_as_rvalue_type=True),
'cached_attribute_validation_method': cached_attribute_validation_method,
'constructor_type': constructor_type,
'cpp_name': cpp_name(attribute),
'cpp_type': idl_type.cpp_type,
'cpp_type_initializer': idl_type.cpp_type_initializer,
'deprecate_as': v8_utilities.deprecate_as(attribute), # [DeprecateAs]
'enum_type': idl_type.enum_type,
'enum_values': idl_type.enum_values,
'exposed_test': v8_utilities.exposed(attribute, interface), # [Exposed]
'has_cross_origin_getter':
has_extended_attribute_value(attribute, 'CrossOrigin', None) or
has_extended_attribute_value(attribute, 'CrossOrigin', 'Getter'),
'has_cross_origin_setter': has_extended_attribute_value(attribute, 'CrossOrigin', 'Setter'),
'has_custom_getter': has_custom_getter(attribute),
'has_custom_setter': has_custom_setter(attribute),
'has_setter': has_setter(interface, attribute),
'idl_type': str(idl_type), # need trailing [] on array for Dictionary::ConversionContext::setConversionType
'is_cached_accessor': is_cached_accessor,
'is_call_with_execution_context': has_extended_attribute_value(attribute, 'CallWith', 'ExecutionContext'),
'is_call_with_script_state': has_extended_attribute_value(attribute, 'CallWith', 'ScriptState'),
'is_ce_reactions': is_ce_reactions,
'is_check_security_for_receiver': is_check_security_for_receiver,
'is_check_security_for_return_value': is_check_security_for_return_value,
'is_custom_element_callbacks': is_custom_element_callbacks,
# TODO(yukishiino): Make all DOM attributes accessor-type properties.
'is_data_type_property': is_data_type_property(interface, attribute),
'is_getter_raises_exception': # [RaisesException]
'RaisesException' in extended_attributes and
extended_attributes['RaisesException'] in (None, 'Getter'),
'is_implemented_in_private_script': is_implemented_in_private_script,
'is_keep_alive_for_gc': keep_alive_for_gc,
'is_lenient_this': 'LenientThis' in extended_attributes,
'is_nullable': idl_type.is_nullable,
'is_explicit_nullable': idl_type.is_explicit_nullable,
'is_partial_interface_member':
'PartialInterfaceImplementedAs' in extended_attributes,
'is_per_world_bindings': 'PerWorldBindings' in extended_attributes,
'is_put_forwards': 'PutForwards' in extended_attributes,
'is_read_only': attribute.is_read_only,
'is_reflect': is_reflect,
'is_replaceable': 'Replaceable' in attribute.extended_attributes,
'is_save_same_object': is_save_same_object,
'is_static': attribute.is_static,
'is_url': 'URL' in extended_attributes,
'is_unforgeable': is_unforgeable(interface, attribute),
'on_instance': v8_utilities.on_instance(interface, attribute),
'on_interface': v8_utilities.on_interface(interface, attribute),
'on_prototype': v8_utilities.on_prototype(interface, attribute),
'origin_trial_enabled_function': v8_utilities.origin_trial_enabled_function_name(attribute), # [OriginTrialEnabled]
'origin_trial_feature_name': v8_utilities.origin_trial_feature_name(attribute), # [OriginTrialEnabled]
'use_output_parameter_for_result': idl_type.use_output_parameter_for_result,
'measure_as': v8_utilities.measure_as(attribute, interface), # [MeasureAs]
'name': attribute.name,
'only_exposed_to_private_script': is_only_exposed_to_private_script,
'private_script_v8_value_to_local_cpp_value': idl_type.v8_value_to_local_cpp_value(
extended_attributes, 'v8Value', 'cppValue', bailout_return_value='false', isolate='scriptState->isolate()'),
'property_attributes': property_attributes(interface, attribute),
'reflect_empty': extended_attributes.get('ReflectEmpty'),
'reflect_invalid': extended_attributes.get('ReflectInvalid', ''),
'reflect_missing': extended_attributes.get('ReflectMissing'),
'reflect_only': extended_attribute_value_as_list(attribute, 'ReflectOnly'),
'runtime_enabled_function': v8_utilities.runtime_enabled_function_name(attribute), # [RuntimeEnabled]
'runtime_feature_name': v8_utilities.runtime_feature_name(attribute), # [RuntimeEnabled]
'secure_context_test': v8_utilities.secure_context(attribute, interface), # [SecureContext]
'should_be_exposed_to_script': not (is_implemented_in_private_script and is_only_exposed_to_private_script),
'cached_accessor_name': '%s%sCachedAccessor' % (interface.name, attribute.name.capitalize()),
'world_suffixes': (
['', 'ForMainWorld']
if 'PerWorldBindings' in extended_attributes
else ['']), # [PerWorldBindings]
}
if is_constructor_attribute(attribute):
update_constructor_attribute_context(interface, attribute, context)
if not has_custom_getter(attribute):
getter_context(interface, attribute, context)
if not has_custom_setter(attribute) and has_setter(interface, attribute):
setter_context(interface, attribute, interfaces, context)
# [CrossOrigin] is incompatible with a number of other attributes, so check
# for them here.
if is_cross_origin:
if context['has_cross_origin_getter'] and context['has_custom_getter']:
raise Exception('[CrossOrigin] and [Custom] are incompatible on the same getter: %s.%s', interface.name, attribute.name)
if context['has_cross_origin_setter'] and context['has_custom_setter']:
raise Exception('[CrossOrigin] and [Custom] are incompatible on the same setter: %s.%s', interface.name, attribute.name)
if context['is_per_world_bindings']:
raise Exception('[CrossOrigin] and [PerWorldBindings] are incompatible: %s.%s', interface.name, attribute.name)
if context['constructor_type']:
raise Exception('[CrossOrigin] cannot be used for constructors: %s.%s', interface.name, attribute.name)
if not context['should_be_exposed_to_script']:
raise Exception('[CrossOrigin] attributes must be exposed to script: %s.%s', interface.name, attribute.name)
return context
def method_context(interface, method, component_info, is_visible=True):
arguments = method.arguments
extended_attributes = method.extended_attributes
idl_type = method.idl_type
is_static = method.is_static
name = method.name
if is_visible:
idl_type.add_includes_for_type(extended_attributes)
this_cpp_value = cpp_value(interface, method, len(arguments))
is_call_with_script_state = has_extended_attribute_value(
method, 'CallWith', 'ScriptState')
is_call_with_this_value = has_extended_attribute_value(
method, 'CallWith', 'ThisValue')
if is_call_with_script_state or is_call_with_this_value:
includes.add('platform/bindings/script_state.h')
# [CheckSecurity]
is_cross_origin = 'CrossOrigin' in extended_attributes
is_check_security_for_receiver = (has_extended_attribute_value(
interface, 'CheckSecurity', 'Receiver') and not is_cross_origin)
is_check_security_for_return_value = (has_extended_attribute_value(
method, 'CheckSecurity', 'ReturnValue'))
if is_check_security_for_receiver or is_check_security_for_return_value:
includes.add('bindings/core/v8/binding_security.h')
if is_check_security_for_return_value:
includes.add('core/frame/web_feature.h')
includes.add('platform/instrumentation/use_counter.h')
is_ce_reactions = 'CEReactions' in extended_attributes
if is_ce_reactions:
includes.add('core/html/custom/ce_reactions_scope.h')
is_custom_element_callbacks = 'CustomElementCallbacks' in extended_attributes
if is_custom_element_callbacks:
includes.add('core/html/custom/v0_custom_element_processing_stack.h')
is_raises_exception = 'RaisesException' in extended_attributes
if 'LenientThis' in extended_attributes:
raise Exception('[LenientThis] is not supported for operations.')
if has_extended_attribute_value(method, 'Affects', 'Nothing'):
side_effect_type = 'V8DOMConfiguration::kHasNoSideEffect'
else:
side_effect_type = 'V8DOMConfiguration::kHasSideEffect'
# [LogActivity]
if 'LogActivity' in extended_attributes:
includes.add('platform/bindings/v8_per_context_data.h')
argument_contexts = [
argument_context(interface,
method,
argument,
index,
is_visible=is_visible)
for index, argument in enumerate(arguments)
]
runtime_features = component_info['runtime_enabled_features']
return {
'activity_logging_world_list':
v8_utilities.activity_logging_world_list(method), # [ActivityLogging]
'arguments':
argument_contexts,
'camel_case_name':
NameStyleConverter(name).to_upper_camel_case(),
'cpp_type':
(v8_types.cpp_template_type('base::Optional', idl_type.cpp_type)
if idl_type.is_explicit_nullable else v8_types.cpp_type(
idl_type, extended_attributes=extended_attributes)),
'cpp_value':
this_cpp_value,
'cpp_type_initializer':
idl_type.cpp_type_initializer,
'high_entropy':
v8_utilities.high_entropy(method), # [HighEntropy]
'deprecate_as':
v8_utilities.deprecate_as(method), # [DeprecateAs]
'do_not_test_new_object':
'DoNotTestNewObject' in extended_attributes,
'exposed_test':
v8_utilities.exposed(method, interface), # [Exposed]
'has_exception_state':
is_raises_exception or is_check_security_for_receiver
or any(argument for argument in arguments
if argument_conversion_needs_exception_state(method, argument)),
'has_optional_argument_without_default_value':
any(True for argument_context in argument_contexts
if argument_context['is_optional_without_default_value']),
'idl_type':
idl_type.base_type,
'is_call_with_execution_context':
has_extended_attribute_value(method, 'CallWith', 'ExecutionContext'),
'is_call_with_script_state':
is_call_with_script_state,
'is_call_with_this_value':
is_call_with_this_value,
'is_ce_reactions':
is_ce_reactions,
'is_check_security_for_receiver':
is_check_security_for_receiver,
'is_check_security_for_return_value':
is_check_security_for_return_value,
'is_cross_origin':
'CrossOrigin' in extended_attributes,
'is_custom':
'Custom' in extended_attributes,
'is_custom_element_callbacks':
is_custom_element_callbacks,
'is_explicit_nullable':
idl_type.is_explicit_nullable,
'is_new_object':
'NewObject' 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_static':
is_static,
'is_unforgeable':
is_unforgeable(method),
'is_variadic':
arguments and arguments[-1].is_variadic,
'measure_as':
v8_utilities.measure_as(method, interface), # [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]),
'on_instance':
v8_utilities.on_instance(interface, method),
'on_interface':
v8_utilities.on_interface(interface, method),
'on_prototype':
v8_utilities.on_prototype(interface, method),
# [RuntimeEnabled] for origin trial
'origin_trial_feature_name':
v8_utilities.origin_trial_feature_name(method, runtime_features),
'property_attributes':
property_attributes(interface, method),
'returns_promise':
method.returns_promise,
'runtime_call_stats':
runtime_call_stats_context(interface, method),
# [RuntimeEnabled] if not in origin trial
'runtime_enabled_feature_name':
v8_utilities.runtime_enabled_feature_name(method, runtime_features),
# [SecureContext]
'secure_context_test':
v8_utilities.secure_context(method, interface),
# [Affects]
'side_effect_type':
side_effect_type,
'snake_case_name':
NameStyleConverter(name).to_snake_case(),
'use_output_parameter_for_result':
idl_type.use_output_parameter_for_result,
'use_local_result':
use_local_result(method),
'v8_set_return_value':
v8_set_return_value(interface.name, method, this_cpp_value),
'v8_set_return_value_for_main_world':
v8_set_return_value(interface.name,
method,
this_cpp_value,
for_main_world=True),
'visible':
is_visible,
'world_suffixes': ['', 'ForMainWorld'] if 'PerWorldBindings'
in extended_attributes else [''], # [PerWorldBindings],
}
def attribute_context(interface, attribute):
idl_type = attribute.idl_type
base_idl_type = idl_type.base_type
extended_attributes = attribute.extended_attributes
idl_type.add_includes_for_type(extended_attributes)
if idl_type.enum_values:
includes.add('core/inspector/ConsoleMessage.h')
# [CheckSecurity]
is_do_not_check_security = 'DoNotCheckSecurity' in extended_attributes
is_check_security_for_frame = (
has_extended_attribute_value(interface, 'CheckSecurity', 'Frame') and
not is_do_not_check_security)
is_check_security_for_node = (
has_extended_attribute_value(attribute, 'CheckSecurity', 'Node'))
is_check_security_for_window = (
has_extended_attribute_value(interface, 'CheckSecurity', 'Window') and
not is_do_not_check_security)
if is_check_security_for_frame or is_check_security_for_node or is_check_security_for_window:
includes.add('bindings/core/v8/BindingSecurity.h')
# [Constructor]
# TODO(yukishiino): Constructors are much like methods although constructors
# are not methods. Constructors must be data-type properties, and we can
# support them as a kind of methods.
constructor_type = idl_type.constructor_type_name if is_constructor_attribute(attribute) else None
# [CustomElementCallbacks], [Reflect]
is_custom_element_callbacks = 'CustomElementCallbacks' in extended_attributes
is_reflect = 'Reflect' in extended_attributes
if is_custom_element_callbacks or is_reflect:
includes.add('core/dom/custom/CustomElementProcessingStack.h')
# [ImplementedInPrivateScript]
is_implemented_in_private_script = 'ImplementedInPrivateScript' in extended_attributes
if is_implemented_in_private_script:
includes.add('bindings/core/v8/PrivateScriptRunner.h')
includes.add('core/frame/LocalFrame.h')
includes.add('platform/ScriptForbiddenScope.h')
# [OnlyExposedToPrivateScript]
is_only_exposed_to_private_script = 'OnlyExposedToPrivateScript' in extended_attributes
# [PerWorldBindings]
if 'PerWorldBindings' in extended_attributes:
assert idl_type.is_wrapper_type or 'LogActivity' in extended_attributes, '[PerWorldBindings] should only be used with wrapper types: %s.%s' % (interface.name, attribute.name)
if (base_idl_type == 'EventHandler' and
interface.name in ['Window', 'WorkerGlobalScope'] and
attribute.name == 'onerror'):
includes.add('bindings/core/v8/V8ErrorHandler.h')
cached_attribute_validation_method = extended_attributes.get('CachedAttribute')
keep_alive_for_gc = is_keep_alive_for_gc(interface, attribute)
if cached_attribute_validation_method or keep_alive_for_gc:
includes.add('bindings/core/v8/V8HiddenValue.h')
context = {
'access_control_list': access_control_list(interface, attribute),
'activity_logging_world_list_for_getter': v8_utilities.activity_logging_world_list(attribute, 'Getter'), # [ActivityLogging]
'activity_logging_world_list_for_setter': v8_utilities.activity_logging_world_list(attribute, 'Setter'), # [ActivityLogging]
'activity_logging_world_check': v8_utilities.activity_logging_world_check(attribute), # [ActivityLogging]
'argument_cpp_type': idl_type.cpp_type_args(used_as_rvalue_type=True),
'cached_attribute_validation_method': cached_attribute_validation_method,
'conditional_string': v8_utilities.conditional_string(attribute),
'constructor_type': constructor_type,
'cpp_name': cpp_name(attribute),
'cpp_type': idl_type.cpp_type,
'cpp_type_initializer': idl_type.cpp_type_initializer,
'deprecate_as': v8_utilities.deprecate_as(attribute), # [DeprecateAs]
'enum_type': idl_type.enum_type,
'enum_values': idl_type.enum_values,
'exposed_test': v8_utilities.exposed(attribute, interface), # [Exposed]
'has_custom_getter': has_custom_getter(attribute),
'has_custom_setter': has_custom_setter(attribute),
'has_setter': has_setter(attribute),
'idl_type': str(idl_type), # need trailing [] on array for Dictionary::ConversionContext::setConversionType
'is_call_with_execution_context': has_extended_attribute_value(attribute, 'CallWith', 'ExecutionContext'),
'is_call_with_script_state': has_extended_attribute_value(attribute, 'CallWith', 'ScriptState'),
'is_check_security_for_frame': is_check_security_for_frame,
'is_check_security_for_node': is_check_security_for_node,
'is_check_security_for_window': is_check_security_for_window,
'is_custom_element_callbacks': is_custom_element_callbacks,
# TODO(yukishiino): Make all DOM attributes accessor-type properties.
'is_data_type_property': constructor_type or interface.name == 'Window' or interface.name == 'Location',
'is_getter_raises_exception': # [RaisesException]
'RaisesException' in extended_attributes and
extended_attributes['RaisesException'] in (None, 'Getter'),
'is_implemented_in_private_script': is_implemented_in_private_script,
'is_keep_alive_for_gc': keep_alive_for_gc,
'is_lenient_this': 'LenientThis' in extended_attributes,
'is_nullable': idl_type.is_nullable,
'is_explicit_nullable': idl_type.is_explicit_nullable,
'is_partial_interface_member':
'PartialInterfaceImplementedAs' in extended_attributes,
'is_per_world_bindings': 'PerWorldBindings' in extended_attributes,
'is_put_forwards': 'PutForwards' in extended_attributes,
'is_read_only': attribute.is_read_only,
'is_reflect': is_reflect,
'is_replaceable': 'Replaceable' in attribute.extended_attributes,
'is_static': attribute.is_static,
'is_url': 'URL' in extended_attributes,
'is_unforgeable': is_unforgeable(interface, attribute),
'on_instance': v8_utilities.on_instance(interface, attribute),
'on_interface': v8_utilities.on_interface(interface, attribute),
'on_prototype': v8_utilities.on_prototype(interface, attribute),
'use_output_parameter_for_result': idl_type.use_output_parameter_for_result,
'measure_as': v8_utilities.measure_as(attribute, interface), # [MeasureAs]
'name': attribute.name,
'only_exposed_to_private_script': is_only_exposed_to_private_script,
'private_script_v8_value_to_local_cpp_value': idl_type.v8_value_to_local_cpp_value(
extended_attributes, 'v8Value', 'cppValue', bailout_return_value='false', isolate='scriptState->isolate()'),
'property_attributes': property_attributes(interface, attribute),
'reflect_empty': extended_attributes.get('ReflectEmpty'),
'reflect_invalid': extended_attributes.get('ReflectInvalid', ''),
'reflect_missing': extended_attributes.get('ReflectMissing'),
'reflect_only': extended_attribute_value_as_list(attribute, 'ReflectOnly'),
'runtime_enabled_function': v8_utilities.runtime_enabled_function_name(attribute), # [RuntimeEnabled]
'should_be_exposed_to_script': not (is_implemented_in_private_script and is_only_exposed_to_private_script),
'world_suffixes': ['', 'ForMainWorld']
if 'PerWorldBindings' in extended_attributes
else [''], # [PerWorldBindings]
}
if is_constructor_attribute(attribute):
update_constructor_attribute_context(interface, attribute, context)
if not has_custom_getter(attribute):
getter_context(interface, attribute, context)
if not has_custom_setter(attribute) and has_setter(attribute):
setter_context(interface, attribute, context)
return context
def method_context(interface, method, is_visible=True):
arguments = method.arguments
extended_attributes = method.extended_attributes
idl_type = method.idl_type
is_static = method.is_static
name = method.name
if is_visible:
idl_type.add_includes_for_type(extended_attributes)
this_cpp_value = cpp_value(interface, method, len(arguments))
is_call_with_script_arguments = has_extended_attribute_value(method, 'CallWith', 'ScriptArguments')
if is_call_with_script_arguments:
includes.update(['bindings/core/v8/ScriptCallStack.h',
'core/inspector/ScriptArguments.h'])
is_call_with_script_state = has_extended_attribute_value(method, 'CallWith', 'ScriptState')
is_call_with_this_value = has_extended_attribute_value(method, 'CallWith', 'ThisValue')
if is_call_with_script_state or is_call_with_this_value:
includes.add('platform/bindings/ScriptState.h')
# [CheckSecurity]
is_cross_origin = 'CrossOrigin' in extended_attributes
is_check_security_for_receiver = (
has_extended_attribute_value(interface, 'CheckSecurity', 'Receiver') and
not is_cross_origin)
is_check_security_for_return_value = (
has_extended_attribute_value(method, 'CheckSecurity', 'ReturnValue'))
if is_check_security_for_receiver or is_check_security_for_return_value:
includes.add('bindings/core/v8/BindingSecurity.h')
is_ce_reactions = 'CEReactions' in extended_attributes
if is_ce_reactions:
includes.add('core/html/custom/CEReactionsScope.h')
is_custom_element_callbacks = 'CustomElementCallbacks' in extended_attributes
if is_custom_element_callbacks:
includes.add('core/html/custom/V0CustomElementProcessingStack.h')
is_raises_exception = 'RaisesException' in extended_attributes
is_custom_call_prologue = has_extended_attribute_value(method, 'Custom', 'CallPrologue')
is_custom_call_epilogue = has_extended_attribute_value(method, 'Custom', 'CallEpilogue')
is_post_message = 'PostMessage' in extended_attributes
if is_post_message:
includes.add('bindings/core/v8/serialization/SerializedScriptValueFactory.h')
includes.add('bindings/core/v8/serialization/Transferables.h')
includes.add('core/typed_arrays/DOMArrayBufferBase.h')
includes.add('core/imagebitmap/ImageBitmap.h')
if 'LenientThis' in extended_attributes:
raise Exception('[LenientThis] is not supported for operations.')
argument_contexts = [
argument_context(interface, method, argument, index, is_visible=is_visible)
for index, argument in enumerate(arguments)]
return {
'activity_logging_world_list': v8_utilities.activity_logging_world_list(method), # [ActivityLogging]
'arguments': argument_contexts,
'cpp_type': (v8_types.cpp_template_type('Nullable', idl_type.cpp_type)
if idl_type.is_explicit_nullable else idl_type.cpp_type),
'cpp_value': this_cpp_value,
'cpp_type_initializer': idl_type.cpp_type_initializer,
'deprecate_as': v8_utilities.deprecate_as(method), # [DeprecateAs]
'do_not_test_new_object': 'DoNotTestNewObject' in extended_attributes,
'exposed_test': v8_utilities.exposed(method, interface), # [Exposed]
'has_exception_state':
is_raises_exception or
is_check_security_for_receiver or
any(argument for argument in arguments
if (argument.idl_type.name == 'SerializedScriptValue' or
argument_conversion_needs_exception_state(method, argument))),
'has_optional_argument_without_default_value':
any(True for argument_context in argument_contexts
if argument_context['is_optional_without_default_value']),
'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_call_with_this_value': is_call_with_this_value,
'is_ce_reactions': is_ce_reactions,
'is_check_security_for_receiver': is_check_security_for_receiver,
'is_check_security_for_return_value': is_check_security_for_return_value,
'is_cross_origin': 'CrossOrigin' in extended_attributes,
'is_custom': 'Custom' in extended_attributes and
not (is_custom_call_prologue or is_custom_call_epilogue),
'is_custom_call_prologue': is_custom_call_prologue,
'is_custom_call_epilogue': is_custom_call_epilogue,
'is_custom_element_callbacks': is_custom_element_callbacks,
'is_explicit_nullable': idl_type.is_explicit_nullable,
'is_new_object': 'NewObject' in extended_attributes,
'is_partial_interface_member':
'PartialInterfaceImplementedAs' in extended_attributes,
'is_per_world_bindings': 'PerWorldBindings' in extended_attributes,
'is_post_message': is_post_message,
'is_raises_exception': is_raises_exception,
'is_static': is_static,
'is_unforgeable': is_unforgeable(interface, method),
'is_variadic': arguments and arguments[-1].is_variadic,
'measure_as': v8_utilities.measure_as(method, interface), # [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]),
'on_instance': v8_utilities.on_instance(interface, method),
'on_interface': v8_utilities.on_interface(interface, method),
'on_prototype': v8_utilities.on_prototype(interface, method),
'origin_trial_enabled_function': v8_utilities.origin_trial_enabled_function_name(method), # [OriginTrialEnabled]
'origin_trial_feature_name': v8_utilities.origin_trial_feature_name(method), # [OriginTrialEnabled]
'property_attributes': property_attributes(interface, method),
'returns_promise': method.returns_promise,
'runtime_call_stats': runtime_call_stats_context(interface, method),
'runtime_enabled_feature_name': v8_utilities.runtime_enabled_feature_name(method), # [RuntimeEnabled]
'secure_context_test': v8_utilities.secure_context(method, interface), # [SecureContext]
'use_output_parameter_for_result': idl_type.use_output_parameter_for_result,
'use_local_result': use_local_result(method),
'v8_set_return_value': v8_set_return_value(interface.name, method, this_cpp_value),
'v8_set_return_value_for_main_world': v8_set_return_value(interface.name, method, this_cpp_value, for_main_world=True),
'visible': is_visible,
'world_suffixes': ['', 'ForMainWorld'] if 'PerWorldBindings' in extended_attributes else [''], # [PerWorldBindings],
}
def method_context(interface, method, is_visible=True):
arguments = method.arguments
extended_attributes = method.extended_attributes
idl_type = method.idl_type
is_static = method.is_static
name = method.name
if is_visible:
idl_type.add_includes_for_type(extended_attributes)
this_cpp_value = cpp_value(interface, method, len(arguments))
is_implemented_in_private_script = "ImplementedInPrivateScript" in extended_attributes
if is_implemented_in_private_script:
includes.add("bindings/core/v8/PrivateScriptRunner.h")
includes.add("core/frame/LocalFrame.h")
includes.add("platform/ScriptForbiddenScope.h")
# [OnlyExposedToPrivateScript]
is_only_exposed_to_private_script = "OnlyExposedToPrivateScript" in extended_attributes
is_call_with_script_arguments = has_extended_attribute_value(method, "CallWith", "ScriptArguments")
if is_call_with_script_arguments:
includes.update(["bindings/core/v8/ScriptCallStack.h", "core/inspector/ScriptArguments.h"])
is_call_with_script_state = has_extended_attribute_value(method, "CallWith", "ScriptState")
is_call_with_this_value = has_extended_attribute_value(method, "CallWith", "ThisValue")
if is_call_with_script_state or is_call_with_this_value:
includes.add("bindings/core/v8/ScriptState.h")
# [CheckSecurity]
is_do_not_check_security = "DoNotCheckSecurity" in extended_attributes
is_check_security_for_receiver = (
has_extended_attribute_value(interface, "CheckSecurity", "Receiver") and not is_do_not_check_security
)
is_check_security_for_return_value = has_extended_attribute_value(method, "CheckSecurity", "ReturnValue")
if is_check_security_for_receiver or is_check_security_for_return_value:
includes.add("bindings/core/v8/BindingSecurity.h")
is_ce_reactions = "CEReactions" in extended_attributes
if is_ce_reactions:
includes.add("core/dom/custom/CEReactionsScope.h")
is_custom_element_callbacks = "CustomElementCallbacks" in extended_attributes
if is_custom_element_callbacks:
includes.add("core/dom/custom/V0CustomElementProcessingStack.h")
is_raises_exception = "RaisesException" in extended_attributes
is_custom_call_prologue = has_extended_attribute_value(method, "Custom", "CallPrologue")
is_custom_call_epilogue = has_extended_attribute_value(method, "Custom", "CallEpilogue")
is_post_message = "PostMessage" in extended_attributes
if is_post_message:
includes.add("bindings/core/v8/SerializedScriptValueFactory.h")
includes.add("bindings/core/v8/Transferables.h")
if "LenientThis" in extended_attributes:
raise Exception("[LenientThis] is not supported for operations.")
argument_contexts = [
argument_context(interface, method, argument, index, is_visible=is_visible)
for index, argument in enumerate(arguments)
]
return {
"activity_logging_world_list": v8_utilities.activity_logging_world_list(method), # [ActivityLogging]
"arguments": argument_contexts,
"argument_declarations_for_private_script": argument_declarations_for_private_script(interface, method),
"cpp_type": (
v8_types.cpp_template_type("Nullable", idl_type.cpp_type)
if idl_type.is_explicit_nullable
else idl_type.cpp_type
),
"cpp_value": this_cpp_value,
"cpp_type_initializer": idl_type.cpp_type_initializer,
"custom_registration_extended_attributes": CUSTOM_REGISTRATION_EXTENDED_ATTRIBUTES.intersection(
extended_attributes.iterkeys()
),
"deprecate_as": v8_utilities.deprecate_as(method), # [DeprecateAs]
"do_not_test_new_object": "DoNotTestNewObject" in extended_attributes,
"exposed_test": v8_utilities.exposed(method, interface), # [Exposed]
# TODO(yukishiino): Retire has_custom_registration flag. Should be
# replaced with V8DOMConfiguration::PropertyLocationConfiguration.
"has_custom_registration": v8_utilities.has_extended_attribute(method, CUSTOM_REGISTRATION_EXTENDED_ATTRIBUTES),
"has_exception_state": is_raises_exception
or is_check_security_for_receiver
or any(
argument
for argument in arguments
if (
argument.idl_type.name == "SerializedScriptValue"
or argument_conversion_needs_exception_state(method, argument)
)
),
"has_optional_argument_without_default_value": any(
True for argument_context in argument_contexts if argument_context["is_optional_without_default_value"]
),
"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_call_with_this_value": is_call_with_this_value,
"is_ce_reactions": is_ce_reactions,
"is_check_security_for_receiver": is_check_security_for_receiver,
"is_check_security_for_return_value": is_check_security_for_return_value,
"is_custom": "Custom" in extended_attributes and not (is_custom_call_prologue or is_custom_call_epilogue),
"is_custom_call_prologue": is_custom_call_prologue,
"is_custom_call_epilogue": is_custom_call_epilogue,
"is_custom_element_callbacks": is_custom_element_callbacks,
"is_do_not_check_security": is_do_not_check_security,
"is_explicit_nullable": idl_type.is_explicit_nullable,
"is_implemented_in_private_script": is_implemented_in_private_script,
"is_new_object": "NewObject" in extended_attributes,
"is_partial_interface_member": "PartialInterfaceImplementedAs" in extended_attributes,
"is_per_world_bindings": "PerWorldBindings" in extended_attributes,
"is_post_message": is_post_message,
"is_raises_exception": is_raises_exception,
"is_static": is_static,
"is_unforgeable": is_unforgeable(interface, method),
"is_variadic": arguments and arguments[-1].is_variadic,
"measure_as": v8_utilities.measure_as(method, interface), # [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]
),
"on_instance": v8_utilities.on_instance(interface, method),
"on_interface": v8_utilities.on_interface(interface, method),
"on_prototype": v8_utilities.on_prototype(interface, method),
"only_exposed_to_private_script": is_only_exposed_to_private_script,
"origin_trial_enabled_function": v8_utilities.origin_trial_enabled_function_name(
method
), # [OriginTrialEnabled]
"origin_trial_feature_name": v8_utilities.origin_trial_feature_name(method), # [OriginTrialEnabled]
"private_script_v8_value_to_local_cpp_value": idl_type.v8_value_to_local_cpp_value(
extended_attributes, "v8Value", "cppValue", isolate="scriptState->isolate()", bailout_return_value="false"
),
"property_attributes": property_attributes(interface, method),
"returns_promise": method.returns_promise,
"runtime_enabled_function": v8_utilities.runtime_enabled_function_name(method), # [RuntimeEnabled]
"should_be_exposed_to_script": not (is_implemented_in_private_script and is_only_exposed_to_private_script),
"use_output_parameter_for_result": idl_type.use_output_parameter_for_result,
"use_local_result": use_local_result(method),
"v8_set_return_value": v8_set_return_value(interface.name, method, this_cpp_value),
"v8_set_return_value_for_main_world": v8_set_return_value(
interface.name, method, this_cpp_value, for_main_world=True
),
"visible": is_visible,
"world_suffixes": ["", "ForMainWorld"]
if "PerWorldBindings" in extended_attributes
else [""], # [PerWorldBindings],
}
def attribute_context(self, interface, attribute, definitions):
"""Create template values for attribute bindings."""
cobalt_name = attribute.extended_attributes.get(
'ImplementedAs', convert_to_cobalt_name(attribute.name))
context = {
'idl_name':
attribute.name,
'getter_function_name':
cobalt_name,
'setter_function_name':
'set_' + cobalt_name,
'type':
self.typed_object_to_cobalt_type(interface, attribute),
'is_static':
attribute.is_static,
'on_instance':
v8_utilities.on_instance(interface, attribute),
'on_interface':
v8_utilities.on_interface(interface, attribute),
'on_prototype':
v8_utilities.on_prototype(interface, attribute),
'is_read_only':
attribute.is_read_only,
'call_with':
attribute.extended_attributes.get('CallWith', None),
'raises_exception':
attribute.extended_attributes.has_key('RaisesException'),
'conversion_flags':
get_conversion_flags(self.resolve_typedef(attribute.idl_type),
attribute.extended_attributes),
'conditional':
attribute.extended_attributes.get('Conditional', None),
'unsupported':
'NotSupported' in attribute.extended_attributes,
}
forwarded_attribute_name = attribute.extended_attributes.get(
'PutForwards')
if forwarded_attribute_name:
assert attribute.idl_type.is_interface_type, (
'PutForwards must be declared on a property of interface type.'
)
assert attribute.is_read_only, (
'PutForwards must be on a readonly attribute.')
forwarded_interface = definitions.interfaces[get_interface_name(
attribute.idl_type)]
matching_attributes = [
a for a in forwarded_interface.attributes
if a.name == forwarded_attribute_name
]
assert len(matching_attributes) == 1
context['put_forwards'] = self.attribute_context(
forwarded_interface, matching_attributes[0], definitions)
context[
'has_setter'] = not attribute.is_read_only or forwarded_attribute_name
if is_constructor_attribute(attribute):
context['is_constructor_attribute'] = True
context['interface_name'] = get_interface_name(attribute.idl_type)
# Blink's IDL parser uses the convention that attributes ending with
# 'ConstructorConstructor' are for Named Constructors.
context['is_named_constructor_attribute'] = (
attribute.idl_type.name.endswith('ConstructorConstructor'))
return context
