def write_header_and_cpp(self):
interface = self.interface
template_contents = self.generate_contents(interface)
template_contents['header_includes'].add(self.include_for_cpp_class)
template_contents['header_includes'] = sorted(template_contents['header_includes'])
template_contents['cpp_includes'] = sorted(includes)
header_basename = v8_class_name(interface) + '.h'
header_file_text = self.header_template.render(template_contents)
self.write_file(header_basename, header_file_text)
cpp_basename = v8_class_name(interface) + '.cpp'
cpp_file_text = self.cpp_template.render(template_contents)
self.write_file(cpp_basename, cpp_file_text)
def write_header_and_cpp(self):
interface = self.interface
template_contents = self.generate_contents(interface)
template_contents['header_includes'].add(self.include_for_cpp_class)
template_contents['header_includes'] = sorted(template_contents['header_includes'])
template_contents['cpp_includes'] = sorted(includes)
header_basename = v8_class_name(interface) + '.h'
header_file_text = self.header_template.render(template_contents)
self.write_file(header_basename, header_file_text)
cpp_basename = v8_class_name(interface) + '.cpp'
cpp_file_text = self.cpp_template.render(template_contents)
self.write_file(cpp_basename, cpp_file_text)
def generate_interface(interface):
includes.clear()
includes.update(INTERFACE_CPP_INCLUDES)
v8_class_name = v8_utilities.v8_class_name(interface)
template_contents = {
'cpp_class_name': cpp_name(interface),
'header_includes': INTERFACE_H_INCLUDES,
'interface_name': interface.name,
'v8_class_name': v8_class_name,
}
template_contents.update({
'constants': [generate_constant(constant) for constant in interface.constants],
'do_not_check_constants': 'DoNotCheckConstants' in interface.extended_attributes,
})
attributes = [v8_attributes.generate_attribute(interface, attribute)
for attribute in interface.attributes]
template_contents.update({
'attributes': attributes,
'has_constructor_attributes': any(attribute['is_constructor'] for attribute in attributes),
'has_per_context_enabled_attributes': any(attribute['per_context_enabled_function_name'] for attribute in attributes),
'has_replaceable_attributes': any(attribute['is_replaceable'] for attribute in attributes),
'has_runtime_enabled_attributes': any(attribute['runtime_enabled_function_name'] for attribute in attributes),
})
template_contents['methods'] = [v8_methods.generate_method(method)
for method in interface.operations]
return template_contents
def callback_interface_context(callback_interface, _):
includes.clear()
includes.update(CALLBACK_INTERFACE_CPP_INCLUDES)
# https://heycam.github.io/webidl/#dfn-single-operation-callback-interface
is_single_operation = True
if (callback_interface.parent or
len(callback_interface.attributes) > 0 or
len(callback_interface.operations) == 0):
is_single_operation = False
else:
operations = callback_interface.operations
basis = operations[0]
for op in operations[1:]:
if op.name != basis.name:
is_single_operation = False
break
return {
'cpp_class': callback_interface.name,
'forward_declarations': sorted(forward_declarations(callback_interface)),
'header_includes': set(CALLBACK_INTERFACE_H_INCLUDES),
'is_single_operation_callback_interface': is_single_operation,
'methods': [method_context(operation)
for operation in callback_interface.operations],
'v8_class': v8_utilities.v8_class_name(callback_interface),
}
def generate_attributes_common(interface):
attributes = interface.attributes
v8_class_name = v8_utilities.v8_class_name(interface)
return {
# Size 0 constant array is not allowed in VC++
'number_of_attributes': 'WTF_ARRAY_LENGTH(%sAttributes)' % v8_class_name if attributes else '0',
'attribute_templates': '%sAttributes' % v8_class_name if attributes else '0',
}
def callback_interface_context(callback_interface):
includes.clear()
includes.update(CALLBACK_INTERFACE_CPP_INCLUDES)
return {
"cpp_class": callback_interface.name,
"v8_class": v8_utilities.v8_class_name(callback_interface),
"header_includes": set(CALLBACK_INTERFACE_H_INCLUDES),
"methods": [method_context(operation) for operation in callback_interface.operations],
}
def dictionary_context(dictionary):
includes.clear()
includes.update(DICTIONARY_CPP_INCLUDES)
return {
"cpp_class": v8_utilities.cpp_name(dictionary),
"header_includes": set(DICTIONARY_H_INCLUDES),
"members": [member_context(member) for member in sorted(dictionary.members, key=operator.attrgetter("name"))],
"v8_class": v8_utilities.v8_class_name(dictionary),
}
def callback_interface_context(callback_interface):
includes.clear()
includes.update(CALLBACK_INTERFACE_CPP_INCLUDES)
return {
'cpp_class': callback_interface.name,
'v8_class': v8_utilities.v8_class_name(callback_interface),
'header_includes': set(CALLBACK_INTERFACE_H_INCLUDES),
'methods': [method_context(operation)
for operation in callback_interface.operations],
}
def dictionary_context(dictionary):
includes.clear()
includes.update(DICTIONARY_CPP_INCLUDES)
return {
'cpp_class': v8_utilities.cpp_name(dictionary),
'header_includes': set(DICTIONARY_H_INCLUDES),
'members': [member_context(member)
for member in sorted(dictionary.members,
key=operator.attrgetter('name'))],
'v8_class': v8_utilities.v8_class_name(dictionary),
}
def generate_callback_interface(callback_interface):
includes.clear()
includes.update(CALLBACK_INTERFACE_CPP_INCLUDES)
return {
'conditional_string': v8_utilities.conditional_string(callback_interface),
'cpp_class': callback_interface.name,
'v8_class': v8_utilities.v8_class_name(callback_interface),
'header_includes': set(CALLBACK_INTERFACE_H_INCLUDES),
'methods': [generate_method(operation)
for operation in callback_interface.operations],
}
def dictionary_context(dictionary):
includes.clear()
includes.update(DICTIONARY_CPP_INCLUDES)
return {
'cpp_class': v8_utilities.cpp_name(dictionary),
'header_includes': set(DICTIONARY_H_INCLUDES),
'members': [member_context(member)
for member in sorted(dictionary.members,
key=operator.attrgetter('name'))],
'v8_class': v8_utilities.v8_class_name(dictionary),
}
def private_script_interface_context(private_script_interface):
includes.clear()
includes.update(BLINK_IN_JS_INTERFACE_CPP_INCLUDES)
return {
'cpp_class': private_script_interface.name,
'forward_declarations': forward_declarations(private_script_interface),
'header_includes': set(BLINK_IN_JS_INTERFACE_H_INCLUDES),
'methods': [method_context(operation)
for operation in private_script_interface.operations],
'v8_class': v8_utilities.v8_class_name(private_script_interface),
}
def generate_callback_interface(callback_interface):
includes.clear()
includes.update(CALLBACK_INTERFACE_CPP_INCLUDES)
methods = [generate_method(operation) for operation in callback_interface.operations]
template_contents = {
'cpp_class_name': callback_interface.name,
'v8_class_name': v8_class_name(callback_interface),
'header_includes': CALLBACK_INTERFACE_H_INCLUDES,
'methods': methods,
}
return template_contents
def legacy_callback_interface_context(callback_interface, _):
includes.clear()
includes.update(LEGACY_CALLBACK_INTERFACE_CPP_INCLUDES)
return {
# TODO(bashi): Fix crbug.com/630986, and add 'methods'.
'constants': [constant_context(constant, callback_interface)
for constant in callback_interface.constants],
'cpp_class': callback_interface.name,
'header_includes': set(CALLBACK_INTERFACE_H_INCLUDES),
'interface_name': callback_interface.name,
'v8_class': v8_utilities.v8_class_name(callback_interface),
}
def legacy_callback_interface_context(callback_interface, _):
includes.clear()
includes.update(LEGACY_CALLBACK_INTERFACE_CPP_INCLUDES)
return {
# TODO(bashi): Fix crbug.com/630986, and add 'methods'.
'constants': [constant_context(constant, callback_interface)
for constant in callback_interface.constants],
'cpp_class': callback_interface.name,
'header_includes': set(LEGACY_CALLBACK_INTERFACE_H_INCLUDES),
'interface_name': callback_interface.name,
'v8_class': v8_utilities.v8_class_name(callback_interface),
}
def callback_interface_context(callback_interface, _):
is_legacy_callback_interface = len(callback_interface.constants) > 0
includes.clear()
includes.update(CALLBACK_INTERFACE_CPP_INCLUDES)
if is_legacy_callback_interface:
includes.update(LEGACY_CALLBACK_INTERFACE_CPP_INCLUDES)
header_includes = set(CALLBACK_INTERFACE_H_INCLUDES)
if is_legacy_callback_interface:
header_includes.update(LEGACY_CALLBACK_INTERFACE_H_INCLUDES)
# https://heycam.github.io/webidl/#dfn-single-operation-callback-interface
is_single_operation = True
if (callback_interface.parent or len(callback_interface.attributes) > 0
or len(callback_interface.operations) == 0):
is_single_operation = False
else:
operations = callback_interface.operations
basis = operations[0]
for op in operations[1:]:
if op.name != basis.name:
is_single_operation = False
break
return {
'constants': [
constant_context(constant, callback_interface)
for constant in callback_interface.constants
],
'cpp_class':
callback_interface.name,
'do_not_check_constants':
'DoNotCheckConstants' in callback_interface.extended_attributes,
'forward_declarations':
sorted(forward_declarations(callback_interface)),
'header_includes':
header_includes,
'interface_name':
callback_interface.name,
'is_legacy_callback_interface':
is_legacy_callback_interface,
'is_single_operation_callback_interface':
is_single_operation,
'methods': [
method_context(operation)
for operation in callback_interface.operations
],
'v8_class':
v8_utilities.v8_class_name(callback_interface),
}
def conditional_features_info(info_provider, reader, idl_filenames,
target_component):
"""Read a set of IDL files and compile the mapping between interfaces and
the conditional features defined on them.
Returns a tuple (features_for_type, types_for_feature, includes):
- features_for_type is a mapping of interface->feature
- types_for_feature is the reverse mapping: feature->interface
- includes is a set of header files which need to be included in the
generated implementation code.
"""
features_for_type = defaultdict(set)
types_for_feature = defaultdict(set)
includes = set()
for idl_filename in idl_filenames:
interface = read_idl_file(reader, idl_filename)
feature_names = get_conditional_feature_names_from_interface(interface)
if feature_names:
is_global = interface_is_global(interface)
if interface.is_partial:
# For partial interfaces, we need to generate different
# includes if the parent interface is in a different
# component.
parent_interface_info = info_provider.interfaces_info[
interface.name]
parent_interface = read_idl_file(
reader, parent_interface_info.get('full_path'))
is_global = is_global or interface_is_global(parent_interface)
parent_component = idl_filename_to_component(
parent_interface_info.get('full_path'))
if interface.is_partial and target_component != parent_component:
includes.add('bindings/%s/v8/V8%s.h' %
(parent_component, interface.name))
includes.add('bindings/%s/v8/V8%sPartial.h' %
(target_component, interface.name))
else:
includes.add('bindings/%s/v8/V8%s.h' %
(target_component, interface.name))
# If this is a partial interface in the same component as
# its parent, then treat it as a non-partial interface.
interface.is_partial = False
interface_info = ConditionalInterfaceInfo(
interface.name, v8_class_name(interface),
v8_class_name_or_partial(interface), is_global)
for feature_name in feature_names:
features_for_type[interface_info].add(feature_name)
types_for_feature[feature_name].add(interface_info)
return features_for_type, types_for_feature, includes
def generate_callback_interface(callback_interface):
includes.clear()
includes.update(CALLBACK_INTERFACE_CPP_INCLUDES)
methods = [
generate_method(operation)
for operation in callback_interface.operations
]
template_contents = {
'cpp_class_name': callback_interface.name,
'v8_class_name': v8_class_name(callback_interface),
'header_includes': CALLBACK_INTERFACE_H_INCLUDES,
'methods': methods,
}
return template_contents
def generate_callback_interface(callback_interface):
includes.clear()
includes.update(CALLBACK_INTERFACE_CPP_INCLUDES)
return {
'conditional_string':
v8_utilities.conditional_string(callback_interface),
'cpp_class':
callback_interface.name,
'v8_class':
v8_utilities.v8_class_name(callback_interface),
'header_includes':
set(CALLBACK_INTERFACE_H_INCLUDES),
'methods': [
generate_method(operation)
for operation in callback_interface.operations
],
}
def generate_callback_interface(callback_interface):
cpp_includes = CALLBACK_INTERFACE_CPP_INCLUDES
def generate_method(operation):
method_contents, method_cpp_includes = generate_method_and_includes(operation)
cpp_includes.update(method_cpp_includes)
return method_contents
methods = [generate_method(operation) for operation in callback_interface.operations]
template_contents = {
'cpp_class_name': callback_interface.name,
'v8_class_name': v8_class_name(callback_interface),
'header_includes': CALLBACK_INTERFACE_H_INCLUDES,
'cpp_includes': cpp_includes,
'methods': methods,
}
return template_contents
def generate_interface(interface):
header_includes = INTERFACE_H_INCLUDES
cpp_includes = INTERFACE_CPP_INCLUDES
template_contents = {
'interface_name': interface.name,
'cpp_class_name': cpp_class_name(interface),
'v8_class_name': v8_class_name(interface),
'constants': [generate_constant(constant) for constant in interface.constants],
'do_not_check_constants': 'DoNotCheckConstants' in interface.extended_attributes,
# Includes are modified in-place after generating members
'header_includes': header_includes,
'cpp_includes': cpp_includes,
}
attributes_contents, attributes_includes = v8_attributes.generate_attributes(interface)
template_contents.update(attributes_contents)
cpp_includes |= attributes_includes
return template_contents
def generate_interface(interface):
includes.clear()
includes.update(INTERFACE_CPP_INCLUDES)
v8_class_name = v8_utilities.v8_class_name(interface)
template_contents = {
'cpp_class_name': cpp_name(interface),
'header_includes': INTERFACE_H_INCLUDES,
'interface_name': interface.name,
'v8_class_name': v8_class_name,
}
template_contents.update({
'constants':
[generate_constant(constant) for constant in interface.constants],
'do_not_check_constants':
'DoNotCheckConstants' in interface.extended_attributes,
})
attributes = [
v8_attributes.generate_attribute(interface, attribute)
for attribute in interface.attributes
]
template_contents.update({
'attributes':
attributes,
'has_constructor_attributes':
any(attribute['is_constructor'] for attribute in attributes),
'has_per_context_enabled_attributes':
any(attribute['per_context_enabled_function_name']
for attribute in attributes),
'has_replaceable_attributes':
any(attribute['is_replaceable'] for attribute in attributes),
'has_runtime_enabled_attributes':
any(attribute['runtime_enabled_function_name']
for attribute in attributes),
})
template_contents['methods'] = [
v8_methods.generate_method(method) for method in interface.operations
]
return template_contents
def generate_interface(interface):
includes.clear()
includes.update(INTERFACE_CPP_INCLUDES)
header_includes = INTERFACE_H_INCLUDES
parent_interface = interface.parent
if parent_interface:
header_includes.update(v8_types.includes_for_type(parent_interface))
extended_attributes = interface.extended_attributes
# [CheckSecurity]
is_check_security = 'CheckSecurity' in extended_attributes
if is_check_security:
includes.add('bindings/v8/BindingSecurity.h')
# [GenerateVisitDOMWrapper]
generate_visit_dom_wrapper_function = extended_attributes.get(
'GenerateVisitDOMWrapper')
if generate_visit_dom_wrapper_function:
includes.update(['bindings/v8/V8GCController.h', 'core/dom/Element.h'])
# [MeasureAs]
is_measure_as = 'MeasureAs' in extended_attributes
if is_measure_as:
includes.add('core/frame/UseCounter.h')
# [SpecialWrapFor]
if 'SpecialWrapFor' in extended_attributes:
special_wrap_for = extended_attributes['SpecialWrapFor'].split('|')
else:
special_wrap_for = []
for special_wrap_interface in special_wrap_for:
v8_types.add_includes_for_type(special_wrap_interface)
# Constructors
constructors = [
generate_constructor(interface, constructor)
for constructor in interface.constructors
# FIXME: shouldn't put named constructors with constructors
# (currently needed for Perl compatibility)
# Handle named constructors separately
if constructor.name == 'Constructor'
]
generate_constructor_overloads(constructors)
# [CustomConstructor]
has_custom_constructor = 'CustomConstructor' in extended_attributes
# [EventConstructor]
has_event_constructor = 'EventConstructor' in extended_attributes
any_type_attributes = [
attribute for attribute in interface.attributes
if attribute.idl_type == 'any'
]
if has_event_constructor:
includes.add('bindings/v8/Dictionary.h')
if any_type_attributes:
includes.add('bindings/v8/SerializedScriptValue.h')
# [NamedConstructor]
if 'NamedConstructor' in extended_attributes:
# FIXME: parser should return named constructor separately;
# included in constructors (and only name stored in extended attribute)
# for Perl compatibility
named_constructor = {'name': extended_attributes['NamedConstructor']}
else:
named_constructor = None
if (constructors or has_custom_constructor or has_event_constructor
or named_constructor):
includes.add('bindings/v8/V8ObjectConstructor.h')
template_contents = {
'any_type_attributes':
any_type_attributes,
'conditional_string':
conditional_string(interface), # [Conditional]
'constructors':
constructors,
'cpp_class':
cpp_name(interface),
'generate_visit_dom_wrapper_function':
generate_visit_dom_wrapper_function,
'has_custom_constructor':
has_custom_constructor,
'has_custom_legacy_call_as_function':
has_extended_attribute_value(
interface, 'Custom',
'LegacyCallAsFunction'), # [Custom=LegacyCallAsFunction]
'has_custom_to_v8':
has_extended_attribute_value(interface, 'Custom',
'ToV8'), # [Custom=ToV8]
'has_custom_wrap':
has_extended_attribute_value(interface, 'Custom',
'Wrap'), # [Custom=Wrap]
'has_event_constructor':
has_event_constructor,
'has_visit_dom_wrapper': (
# [Custom=Wrap], [GenerateVisitDOMWrapper]
has_extended_attribute_value(interface, 'Custom',
'VisitDOMWrapper')
or 'GenerateVisitDOMWrapper' in extended_attributes),
'header_includes':
header_includes,
'interface_length':
interface_length(interface, constructors),
'interface_name':
interface.name,
'is_active_dom_object':
'ActiveDOMObject' in extended_attributes, # [ActiveDOMObject]
'is_check_security':
is_check_security,
'is_constructor_call_with_document':
has_extended_attribute_value(
interface, 'ConstructorCallWith',
'Document'), # [ConstructorCallWith=Document]
'is_constructor_call_with_execution_context':
has_extended_attribute_value(
interface, 'ConstructorCallWith',
'ExecutionContext'), # [ConstructorCallWith=ExeuctionContext]
'is_constructor_raises_exception':
extended_attributes.get('RaisesException') ==
'Constructor', # [RaisesException=Constructor]
'is_dependent_lifetime':
'DependentLifetime' in extended_attributes, # [DependentLifetime]
'is_event_target':
inherits_interface(interface, 'EventTarget'),
'is_node':
inherits_interface(interface, 'Node'),
'measure_as':
v8_utilities.measure_as(interface), # [MeasureAs]
'named_constructor':
named_constructor,
'parent_interface':
parent_interface,
'runtime_enabled_function':
runtime_enabled_function_name(interface), # [RuntimeEnabled]
'special_wrap_for':
special_wrap_for,
'v8_class':
v8_utilities.v8_class_name(interface),
}
template_contents.update({
'constants':
[generate_constant(constant) for constant in interface.constants],
'do_not_check_constants':
'DoNotCheckConstants' in extended_attributes,
})
attributes = [
v8_attributes.generate_attribute(interface, attribute)
for attribute in interface.attributes
]
template_contents.update({
'attributes':
attributes,
'has_accessors':
any(attribute['is_expose_js_accessors'] for attribute in attributes),
'has_constructor_attributes':
any(attribute['constructor_type'] for attribute in attributes),
'has_per_context_enabled_attributes':
any(attribute['per_context_enabled_function']
for attribute in attributes),
'has_replaceable_attributes':
any(attribute['is_replaceable'] for attribute in attributes),
})
methods = [
v8_methods.generate_method(interface, method)
for method in interface.operations
]
generate_overloads(methods)
for method in methods:
method['do_generate_method_configuration'] = (
method['do_not_check_signature']
and not method['per_context_enabled_function'] and
# For overloaded methods, only generate one accessor
('overload_index' not in method or method['overload_index'] == 1))
template_contents.update({
'has_origin_safe_method_setter':
any(method['is_check_security_for_frame']
and not method['is_read_only'] for method in methods),
'has_method_configuration':
any(method['do_generate_method_configuration'] for method in methods),
'has_per_context_enabled_methods':
any(method['per_context_enabled_function'] for method in methods),
'methods':
methods,
})
return template_contents
def generate_interface(interface):
includes.clear()
includes.update(INTERFACE_CPP_INCLUDES)
header_includes = set(INTERFACE_H_INCLUDES)
parent_interface = interface.parent
if parent_interface:
header_includes.update(
v8_types.includes_for_interface(parent_interface))
extended_attributes = interface.extended_attributes
is_audio_buffer = inherits_interface(interface.name, 'AudioBuffer')
if is_audio_buffer:
includes.add('modules/webaudio/AudioBuffer.h')
is_document = inherits_interface(interface.name, 'Document')
if is_document:
includes.update([
'bindings/v8/ScriptController.h', 'bindings/v8/V8WindowShell.h',
'core/frame/LocalFrame.h'
])
# [ActiveDOMObject]
is_active_dom_object = 'ActiveDOMObject' in extended_attributes
# [CheckSecurity]
is_check_security = 'CheckSecurity' in extended_attributes
if is_check_security:
includes.add('bindings/v8/BindingSecurity.h')
# [DependentLifetime]
is_dependent_lifetime = 'DependentLifetime' in extended_attributes
# [MeasureAs]
is_measure_as = 'MeasureAs' in extended_attributes
if is_measure_as:
includes.add('core/frame/UseCounter.h')
# [SetWrapperReferenceFrom]
reachable_node_function = extended_attributes.get(
'SetWrapperReferenceFrom')
if reachable_node_function:
includes.update(['bindings/v8/V8GCController.h', 'core/dom/Element.h'])
# [SetWrapperReferenceTo]
set_wrapper_reference_to_list = [
{
'name': argument.name,
# FIXME: properly should be:
# 'cpp_type': argument.idl_type.cpp_type_args(used_as_argument=True),
# (if type is non-wrapper type like NodeFilter, normally RefPtr)
# Raw pointers faster though, and NodeFilter hacky anyway.
'cpp_type': argument.idl_type.implemented_as + '*',
'idl_type': argument.idl_type,
'v8_type': v8_types.v8_type(argument.idl_type.name),
} for argument in extended_attributes.get('SetWrapperReferenceTo', [])
]
for set_wrapper_reference_to in set_wrapper_reference_to_list:
set_wrapper_reference_to['idl_type'].add_includes_for_type()
# [SpecialWrapFor]
if 'SpecialWrapFor' in extended_attributes:
special_wrap_for = extended_attributes['SpecialWrapFor'].split('|')
else:
special_wrap_for = []
for special_wrap_interface in special_wrap_for:
v8_types.add_includes_for_interface(special_wrap_interface)
# [Custom=Wrap], [SetWrapperReferenceFrom]
has_visit_dom_wrapper = (has_extended_attribute_value(
interface, 'Custom', 'VisitDOMWrapper') or reachable_node_function
or set_wrapper_reference_to_list)
this_gc_type = gc_type(interface)
template_contents = {
'conditional_string':
conditional_string(interface), # [Conditional]
'cpp_class':
cpp_name(interface),
'gc_type':
this_gc_type,
'has_custom_legacy_call_as_function':
has_extended_attribute_value(
interface, 'Custom',
'LegacyCallAsFunction'), # [Custom=LegacyCallAsFunction]
'has_custom_to_v8':
has_extended_attribute_value(interface, 'Custom',
'ToV8'), # [Custom=ToV8]
'has_custom_wrap':
has_extended_attribute_value(interface, 'Custom',
'Wrap'), # [Custom=Wrap]
'has_visit_dom_wrapper':
has_visit_dom_wrapper,
'header_includes':
header_includes,
'interface_name':
interface.name,
'is_active_dom_object':
is_active_dom_object,
'is_audio_buffer':
is_audio_buffer,
'is_check_security':
is_check_security,
'is_dependent_lifetime':
is_dependent_lifetime,
'is_document':
is_document,
'is_event_target':
inherits_interface(interface.name, 'EventTarget'),
'is_exception':
interface.is_exception,
'is_node':
inherits_interface(interface.name, 'Node'),
'measure_as':
v8_utilities.measure_as(interface), # [MeasureAs]
'parent_interface':
parent_interface,
'pass_cpp_type':
cpp_template_type(cpp_ptr_type('PassRefPtr', 'RawPtr', this_gc_type),
cpp_name(interface)),
'reachable_node_function':
reachable_node_function,
'runtime_enabled_function':
runtime_enabled_function_name(interface), # [RuntimeEnabled]
'set_wrapper_reference_to_list':
set_wrapper_reference_to_list,
'special_wrap_for':
special_wrap_for,
'v8_class':
v8_utilities.v8_class_name(interface),
'wrapper_configuration':
'WrapperConfiguration::Dependent' if
(has_visit_dom_wrapper or is_active_dom_object
or is_dependent_lifetime) else 'WrapperConfiguration::Independent',
}
# Constructors
constructors = [
generate_constructor(interface, constructor)
for constructor in interface.constructors
# FIXME: shouldn't put named constructors with constructors
# (currently needed for Perl compatibility)
# Handle named constructors separately
if constructor.name == 'Constructor'
]
if len(constructors) > 1:
template_contents['constructor_overloads'] = generate_overloads(
constructors)
# [CustomConstructor]
custom_constructors = [{ # Only needed for computing interface length
'number_of_required_arguments':
number_of_required_arguments(constructor),
} for constructor in interface.custom_constructors]
# [EventConstructor]
has_event_constructor = 'EventConstructor' in extended_attributes
any_type_attributes = [
attribute for attribute in interface.attributes
if attribute.idl_type.name == 'Any'
]
if has_event_constructor:
includes.add('bindings/v8/Dictionary.h')
if any_type_attributes:
includes.add('bindings/v8/SerializedScriptValue.h')
# [NamedConstructor]
named_constructor = generate_named_constructor(interface)
if (constructors or custom_constructors or has_event_constructor
or named_constructor):
includes.add('bindings/v8/V8ObjectConstructor.h')
includes.add('core/frame/DOMWindow.h')
template_contents.update({
'any_type_attributes':
any_type_attributes,
'constructors':
constructors,
'has_custom_constructor':
bool(custom_constructors),
'has_event_constructor':
has_event_constructor,
'interface_length':
interface_length(interface, constructors + custom_constructors),
'is_constructor_call_with_document':
has_extended_attribute_value(
interface, 'ConstructorCallWith',
'Document'), # [ConstructorCallWith=Document]
'is_constructor_call_with_execution_context':
has_extended_attribute_value(
interface, 'ConstructorCallWith',
'ExecutionContext'), # [ConstructorCallWith=ExeuctionContext]
'is_constructor_raises_exception':
extended_attributes.get('RaisesException') ==
'Constructor', # [RaisesException=Constructor]
'named_constructor':
named_constructor,
})
# Constants
template_contents.update({
'constants':
[generate_constant(constant) for constant in interface.constants],
'do_not_check_constants':
'DoNotCheckConstants' in extended_attributes,
})
# Attributes
attributes = [
v8_attributes.generate_attribute(interface, attribute)
for attribute in interface.attributes
]
template_contents.update({
'attributes':
attributes,
'has_accessors':
any(attribute['is_expose_js_accessors'] for attribute in attributes),
'has_attribute_configuration':
any(not (attribute['is_expose_js_accessors'] or attribute['is_static']
or attribute['runtime_enabled_function']
or attribute['per_context_enabled_function'])
for attribute in attributes),
'has_constructor_attributes':
any(attribute['constructor_type'] for attribute in attributes),
'has_per_context_enabled_attributes':
any(attribute['per_context_enabled_function']
for attribute in attributes),
'has_replaceable_attributes':
any(attribute['is_replaceable'] for attribute in attributes),
})
# Methods
methods = [
v8_methods.generate_method(interface, method)
for method in interface.operations if method.name
] # Skip anonymous special operations (methods)
generate_method_overloads(methods)
for method in methods:
method['do_generate_method_configuration'] = (
method['do_not_check_signature']
and not method['per_context_enabled_function'] and
# For overloaded methods, only generate one accessor
('overload_index' not in method or method['overload_index'] == 1))
template_contents.update({
'has_origin_safe_method_setter':
any(method['is_check_security_for_frame']
and not method['is_read_only'] for method in methods),
'has_method_configuration':
any(method['do_generate_method_configuration'] for method in methods),
'has_per_context_enabled_methods':
any(method['per_context_enabled_function'] for method in methods),
'methods':
methods,
})
template_contents.update({
'indexed_property_getter':
indexed_property_getter(interface),
'indexed_property_setter':
indexed_property_setter(interface),
'indexed_property_deleter':
indexed_property_deleter(interface),
'is_override_builtins':
'OverrideBuiltins' in extended_attributes,
'named_property_getter':
named_property_getter(interface),
'named_property_setter':
named_property_setter(interface),
'named_property_deleter':
named_property_deleter(interface),
})
return template_contents
def interface_context(interface):
includes.clear()
includes.update(INTERFACE_CPP_INCLUDES)
header_includes = set(INTERFACE_H_INCLUDES)
parent_interface = interface.parent
if parent_interface:
header_includes.update(v8_types.includes_for_interface(parent_interface))
extended_attributes = interface.extended_attributes
# [ActiveDOMObject]
is_active_dom_object = 'ActiveDOMObject' in extended_attributes
# [CheckSecurity]
is_check_security = 'CheckSecurity' in extended_attributes
if is_check_security:
includes.add('bindings/core/v8/BindingSecurity.h')
# [DependentLifetime]
is_dependent_lifetime = 'DependentLifetime' in extended_attributes
# [Iterable]
iterator_method = None
if 'Iterable' in extended_attributes:
iterator_operation = IdlOperation(interface.idl_name)
iterator_operation.name = 'iterator'
iterator_operation.idl_type = IdlType('Iterator')
iterator_operation.extended_attributes['RaisesException'] = None
iterator_operation.extended_attributes['CallWith'] = 'ScriptState'
iterator_method = v8_methods.method_context(interface,
iterator_operation)
# [MeasureAs]
is_measure_as = 'MeasureAs' in extended_attributes
if is_measure_as:
includes.add('core/frame/UseCounter.h')
# [SetWrapperReferenceFrom]
reachable_node_function = extended_attributes.get('SetWrapperReferenceFrom')
if reachable_node_function:
includes.update(['bindings/core/v8/V8GCController.h',
'core/dom/Element.h'])
# [SetWrapperReferenceTo]
set_wrapper_reference_to_list = [{
'name': argument.name,
# FIXME: properly should be:
# 'cpp_type': argument.idl_type.cpp_type_args(raw_type=True),
# (if type is non-wrapper type like NodeFilter, normally RefPtr)
# Raw pointers faster though, and NodeFilter hacky anyway.
'cpp_type': argument.idl_type.implemented_as + '*',
'idl_type': argument.idl_type,
'v8_type': v8_types.v8_type(argument.idl_type.name),
} for argument in extended_attributes.get('SetWrapperReferenceTo', [])]
for set_wrapper_reference_to in set_wrapper_reference_to_list:
set_wrapper_reference_to['idl_type'].add_includes_for_type()
# [NotScriptWrappable]
is_script_wrappable = 'NotScriptWrappable' not in extended_attributes
# [Custom=Wrap], [SetWrapperReferenceFrom]
has_visit_dom_wrapper = (
has_extended_attribute_value(interface, 'Custom', 'VisitDOMWrapper') or
reachable_node_function or
set_wrapper_reference_to_list)
this_gc_type = gc_type(interface)
wrapper_class_id = ('NodeClassId' if inherits_interface(interface.name, 'Node') else 'ObjectClassId')
context = {
'conditional_string': conditional_string(interface), # [Conditional]
'cpp_class': cpp_name(interface),
'gc_type': this_gc_type,
# FIXME: Remove 'EventTarget' special handling, http://crbug.com/383699
'has_access_check_callbacks': (is_check_security and
interface.name != 'Window' and
interface.name != 'EventTarget'),
'has_custom_legacy_call_as_function': has_extended_attribute_value(interface, 'Custom', 'LegacyCallAsFunction'), # [Custom=LegacyCallAsFunction]
'has_custom_to_v8': has_extended_attribute_value(interface, 'Custom', 'ToV8'), # [Custom=ToV8]
'has_custom_wrap': has_extended_attribute_value(interface, 'Custom', 'Wrap'), # [Custom=Wrap]
'has_visit_dom_wrapper': has_visit_dom_wrapper,
'header_includes': header_includes,
'interface_name': interface.name,
'is_active_dom_object': is_active_dom_object,
'is_check_security': is_check_security,
'is_dependent_lifetime': is_dependent_lifetime,
'is_event_target': inherits_interface(interface.name, 'EventTarget'),
'is_exception': interface.is_exception,
'is_node': inherits_interface(interface.name, 'Node'),
'is_script_wrappable': is_script_wrappable,
'iterator_method': iterator_method,
'lifetime': 'Dependent'
if (has_visit_dom_wrapper or
is_active_dom_object or
is_dependent_lifetime)
else 'Independent',
'measure_as': v8_utilities.measure_as(interface), # [MeasureAs]
'parent_interface': parent_interface,
'pass_cpp_type': cpp_template_type(
cpp_ptr_type('PassRefPtr', 'RawPtr', this_gc_type),
cpp_name(interface)),
'reachable_node_function': reachable_node_function,
'runtime_enabled_function': runtime_enabled_function_name(interface), # [RuntimeEnabled]
'set_wrapper_reference_to_list': set_wrapper_reference_to_list,
'v8_class': v8_utilities.v8_class_name(interface),
'wrapper_class_id': wrapper_class_id,
}
# Constructors
constructors = [constructor_context(interface, constructor)
for constructor in interface.constructors
# FIXME: shouldn't put named constructors with constructors
# (currently needed for Perl compatibility)
# Handle named constructors separately
if constructor.name == 'Constructor']
if len(constructors) > 1:
context['constructor_overloads'] = overloads_context(constructors)
# [CustomConstructor]
custom_constructors = [{ # Only needed for computing interface length
'number_of_required_arguments':
number_of_required_arguments(constructor),
} for constructor in interface.custom_constructors]
# [EventConstructor]
has_event_constructor = 'EventConstructor' in extended_attributes
any_type_attributes = [attribute for attribute in interface.attributes
if attribute.idl_type.name == 'Any']
if has_event_constructor:
includes.add('bindings/core/v8/Dictionary.h')
if any_type_attributes:
includes.add('bindings/core/v8/SerializedScriptValue.h')
# [NamedConstructor]
named_constructor = named_constructor_context(interface)
if (constructors or custom_constructors or has_event_constructor or
named_constructor):
includes.add('bindings/core/v8/V8ObjectConstructor.h')
includes.add('core/frame/LocalDOMWindow.h')
context.update({
'any_type_attributes': any_type_attributes,
'constructors': constructors,
'has_custom_constructor': bool(custom_constructors),
'has_event_constructor': has_event_constructor,
'interface_length':
interface_length(interface, constructors + custom_constructors),
'is_constructor_raises_exception': extended_attributes.get('RaisesException') == 'Constructor', # [RaisesException=Constructor]
'named_constructor': named_constructor,
})
constants = [constant_context(constant) for constant in interface.constants]
special_getter_constants = []
runtime_enabled_constants = []
constant_configuration_constants = []
for constant in constants:
if constant['measure_as'] or constant['deprecate_as']:
special_getter_constants.append(constant)
continue
if constant['runtime_enabled_function']:
runtime_enabled_constants.append(constant)
continue
constant_configuration_constants.append(constant)
# Constants
context.update({
'constant_configuration_constants': constant_configuration_constants,
'constants': constants,
'do_not_check_constants': 'DoNotCheckConstants' in extended_attributes,
'has_constant_configuration': any(
not constant['runtime_enabled_function']
for constant in constants),
'runtime_enabled_constants': runtime_enabled_constants,
'special_getter_constants': special_getter_constants,
})
# Attributes
attributes = [v8_attributes.attribute_context(interface, attribute)
for attribute in interface.attributes]
context.update({
'attributes': attributes,
'has_accessors': any(attribute['is_expose_js_accessors'] and attribute['should_be_exposed_to_script'] for attribute in attributes),
'has_attribute_configuration': any(
not (attribute['is_expose_js_accessors'] or
attribute['is_static'] or
attribute['runtime_enabled_function'] or
attribute['per_context_enabled_function'])
and attribute['should_be_exposed_to_script']
for attribute in attributes),
'has_conditional_attributes': any(attribute['per_context_enabled_function'] or attribute['exposed_test'] for attribute in attributes),
'has_constructor_attributes': any(attribute['constructor_type'] for attribute in attributes),
'has_replaceable_attributes': any(attribute['is_replaceable'] for attribute in attributes),
})
# Methods
methods = [v8_methods.method_context(interface, method)
for method in interface.operations
if method.name] # Skip anonymous special operations (methods)
compute_method_overloads_context(methods)
# Stringifier
if interface.stringifier:
stringifier = interface.stringifier
method = IdlOperation(interface.idl_name)
method.name = 'toString'
method.idl_type = IdlType('DOMString')
method.extended_attributes.update(stringifier.extended_attributes)
if stringifier.attribute:
method.extended_attributes['ImplementedAs'] = stringifier.attribute.name
elif stringifier.operation:
method.extended_attributes['ImplementedAs'] = stringifier.operation.name
methods.append(v8_methods.method_context(interface, method))
conditionally_enabled_methods = []
custom_registration_methods = []
method_configuration_methods = []
for method in methods:
# Skip all but one method in each set of overloaded methods.
if 'overload_index' in method and 'overloads' not in method:
continue
if 'overloads' in method:
overloads = method['overloads']
per_context_enabled_function = overloads['per_context_enabled_function_all']
conditionally_exposed_function = overloads['exposed_test_all']
runtime_enabled_function = overloads['runtime_enabled_function_all']
has_custom_registration = overloads['has_custom_registration_all']
else:
per_context_enabled_function = method['per_context_enabled_function']
conditionally_exposed_function = method['exposed_test']
runtime_enabled_function = method['runtime_enabled_function']
has_custom_registration = method['has_custom_registration']
if per_context_enabled_function or conditionally_exposed_function:
conditionally_enabled_methods.append(method)
continue
if runtime_enabled_function or has_custom_registration:
custom_registration_methods.append(method)
continue
if method['should_be_exposed_to_script']:
method_configuration_methods.append(method)
for method in methods:
# The value of the Function object’s “length” property is a Number
# determined as follows:
# 1. Let S be the effective overload set for regular operations (if the
# operation is a regular operation) or for static operations (if the
# operation is a static operation) with identifier id on interface I and
# with argument count 0.
# 2. Return the length of the shortest argument list of the entries in S.
# FIXME: This calculation doesn't take into account whether runtime
# enabled overloads are actually enabled, so length may be incorrect.
# E.g., [RuntimeEnabled=Foo] void f(); void f(long x);
# should have length 1 if Foo is not enabled, but length 0 if it is.
method['length'] = (method['overloads']['minarg'] if 'overloads' in method else
method['number_of_required_arguments'])
context.update({
'conditionally_enabled_methods': conditionally_enabled_methods,
'custom_registration_methods': custom_registration_methods,
'has_origin_safe_method_setter': any(
method['is_check_security_for_frame'] and not method['is_read_only']
for method in methods),
'has_private_script': any(attribute['is_implemented_in_private_script'] for attribute in attributes) or
any(method['is_implemented_in_private_script'] for method in methods),
'method_configuration_methods': method_configuration_methods,
'methods': methods,
})
context.update({
'indexed_property_getter': indexed_property_getter(interface),
'indexed_property_setter': indexed_property_setter(interface),
'indexed_property_deleter': indexed_property_deleter(interface),
'is_override_builtins': 'OverrideBuiltins' in extended_attributes,
'named_property_getter': named_property_getter(interface),
'named_property_setter': named_property_setter(interface),
'named_property_deleter': named_property_deleter(interface),
})
return context
def interface_context(interface):
includes.clear()
includes.update(INTERFACE_CPP_INCLUDES)
header_includes = set(INTERFACE_H_INCLUDES)
parent_interface = interface.parent
if parent_interface:
header_includes.update(v8_types.includes_for_interface(parent_interface))
extended_attributes = interface.extended_attributes
is_document = inherits_interface(interface.name, 'Document')
if is_document:
includes.update(['bindings/core/v8/ScriptController.h',
'bindings/core/v8/WindowProxy.h',
'core/frame/LocalFrame.h'])
# [ActiveDOMObject]
is_active_dom_object = 'ActiveDOMObject' in extended_attributes
# [CheckSecurity]
is_check_security = 'CheckSecurity' in extended_attributes
if is_check_security:
includes.add('bindings/core/v8/BindingSecurity.h')
# [DependentLifetime]
is_dependent_lifetime = 'DependentLifetime' in extended_attributes
# [Iterable]
iterator_method = None
if 'Iterable' in extended_attributes:
iterator_operation = IdlOperation(interface.idl_name)
iterator_operation.name = 'iterator'
iterator_operation.idl_type = IdlType('Iterator')
iterator_operation.extended_attributes['RaisesException'] = None
iterator_operation.extended_attributes['CallWith'] = 'ScriptState'
iterator_method = v8_methods.method_context(interface,
iterator_operation)
# [MeasureAs]
is_measure_as = 'MeasureAs' in extended_attributes
if is_measure_as:
includes.add('core/frame/UseCounter.h')
# [SetWrapperReferenceFrom]
reachable_node_function = extended_attributes.get('SetWrapperReferenceFrom')
if reachable_node_function:
includes.update(['bindings/core/v8/V8GCController.h',
'core/dom/Element.h'])
# [SetWrapperReferenceTo]
set_wrapper_reference_to_list = [{
'name': argument.name,
# FIXME: properly should be:
# 'cpp_type': argument.idl_type.cpp_type_args(raw_type=True),
# (if type is non-wrapper type like NodeFilter, normally RefPtr)
# Raw pointers faster though, and NodeFilter hacky anyway.
'cpp_type': argument.idl_type.implemented_as + '*',
'idl_type': argument.idl_type,
'v8_type': v8_types.v8_type(argument.idl_type.name),
} for argument in extended_attributes.get('SetWrapperReferenceTo', [])]
for set_wrapper_reference_to in set_wrapper_reference_to_list:
set_wrapper_reference_to['idl_type'].add_includes_for_type()
# [NotScriptWrappable]
is_script_wrappable = 'NotScriptWrappable' not in extended_attributes
# [SpecialWrapFor]
if 'SpecialWrapFor' in extended_attributes:
special_wrap_for = extended_attribute_value_as_list(interface, 'SpecialWrapFor')
else:
special_wrap_for = []
for special_wrap_interface in special_wrap_for:
v8_types.add_includes_for_interface(special_wrap_interface)
# [Custom=Wrap], [SetWrapperReferenceFrom]
has_visit_dom_wrapper = (
has_extended_attribute_value(interface, 'Custom', 'VisitDOMWrapper') or
reachable_node_function or
set_wrapper_reference_to_list)
wrapper_class_id = ('NodeClassId' if inherits_interface(interface.name, 'Node') else 'ObjectClassId')
context = {
'conditional_string': conditional_string(interface), # [Conditional]
'cpp_class': cpp_name(interface),
# FIXME: Remove 'EventTarget' special handling, http://crbug.com/383699
'has_access_check_callbacks': (is_check_security and
interface.name != 'Window' and
interface.name != 'EventTarget'),
'has_custom_legacy_call_as_function': has_extended_attribute_value(interface, 'Custom', 'LegacyCallAsFunction'), # [Custom=LegacyCallAsFunction]
'has_custom_to_v8': has_extended_attribute_value(interface, 'Custom', 'ToV8'), # [Custom=ToV8]
'has_custom_wrap': has_extended_attribute_value(interface, 'Custom', 'Wrap'), # [Custom=Wrap]
'has_visit_dom_wrapper': has_visit_dom_wrapper,
'header_includes': header_includes,
'interface_name': interface.name,
'is_active_dom_object': is_active_dom_object,
'is_check_security': is_check_security,
'is_dependent_lifetime': is_dependent_lifetime,
'is_document': is_document,
'is_event_target': inherits_interface(interface.name, 'EventTarget'),
'is_exception': interface.is_exception,
'is_node': inherits_interface(interface.name, 'Node'),
'is_script_wrappable': is_script_wrappable,
'iterator_method': iterator_method,
'lifetime': 'Dependent'
if (has_visit_dom_wrapper or
is_active_dom_object or
is_dependent_lifetime)
else 'Independent',
'measure_as': v8_utilities.measure_as(interface), # [MeasureAs]
'parent_interface': parent_interface,
'pass_cpp_type': cpp_template_type(
'PassRefPtr',
cpp_name(interface)),
'reachable_node_function': reachable_node_function,
'runtime_enabled_function': runtime_enabled_function_name(interface), # [RuntimeEnabled]
'set_wrapper_reference_to_list': set_wrapper_reference_to_list,
'special_wrap_for': special_wrap_for,
'v8_class': v8_utilities.v8_class_name(interface),
'wrapper_class_id': wrapper_class_id,
}
# Constructors
constructors = [constructor_context(interface, constructor)
for constructor in interface.constructors
# FIXME: shouldn't put named constructors with constructors
# (currently needed for Perl compatibility)
# Handle named constructors separately
if constructor.name == 'Constructor']
if len(constructors) > 1:
context['constructor_overloads'] = overloads_context(constructors)
# [CustomConstructor]
custom_constructors = [{ # Only needed for computing interface length
'number_of_required_arguments':
number_of_required_arguments(constructor),
} for constructor in interface.custom_constructors]
# [EventConstructor]
has_event_constructor = 'EventConstructor' in extended_attributes
any_type_attributes = [attribute for attribute in interface.attributes
if attribute.idl_type.name == 'Any']
if has_event_constructor:
includes.add('bindings/core/v8/Dictionary.h')
if any_type_attributes:
includes.add('bindings/core/v8/SerializedScriptValue.h')
# [NamedConstructor]
named_constructor = named_constructor_context(interface)
if (constructors or custom_constructors or has_event_constructor or
named_constructor):
includes.add('bindings/core/v8/V8ObjectConstructor.h')
includes.add('core/frame/LocalDOMWindow.h')
context.update({
'any_type_attributes': any_type_attributes,
'constructors': constructors,
'has_custom_constructor': bool(custom_constructors),
'has_event_constructor': has_event_constructor,
'interface_length':
interface_length(interface, constructors + custom_constructors),
'is_constructor_raises_exception': extended_attributes.get('RaisesException') == 'Constructor', # [RaisesException=Constructor]
'named_constructor': named_constructor,
})
constants = [constant_context(constant) for constant in interface.constants]
# Constants
context.update({
'constants': constants,
'do_not_check_constants': 'DoNotCheckConstants' in extended_attributes,
'has_constant_configuration': any(
not constant['runtime_enabled_function']
for constant in constants),
})
# Attributes
attributes = [v8_attributes.attribute_context(interface, attribute)
for attribute in interface.attributes]
context.update({
'attributes': attributes,
'has_accessors': any(attribute['is_expose_js_accessors'] and attribute['should_be_exposed_to_script'] for attribute in attributes),
'has_attribute_configuration': any(
not (attribute['is_expose_js_accessors'] or
attribute['is_static'] or
attribute['runtime_enabled_function'])
and attribute['should_be_exposed_to_script']
for attribute in attributes),
'has_conditional_attributes': any(attribute['exposed_test'] for attribute in attributes),
'has_constructor_attributes': any(attribute['constructor_type'] for attribute in attributes),
'has_replaceable_attributes': any(attribute['is_replaceable'] for attribute in attributes),
})
# Methods
methods = [v8_methods.method_context(interface, method)
for method in interface.operations
if method.name] # Skip anonymous special operations (methods)
compute_method_overloads_context(methods)
# Stringifier
if interface.stringifier:
stringifier = interface.stringifier
method = IdlOperation(interface.idl_name)
method.name = 'toString'
method.idl_type = IdlType('DOMString')
method.extended_attributes.update(stringifier.extended_attributes)
if stringifier.attribute:
method.extended_attributes['ImplementedAs'] = stringifier.attribute.name
elif stringifier.operation:
method.extended_attributes['ImplementedAs'] = stringifier.operation.name
methods.append(v8_methods.method_context(interface, method))
conditionally_enabled_methods = []
custom_registration_methods = []
method_configuration_methods = []
for method in methods:
# Skip all but one method in each set of overloaded methods.
if 'overload_index' in method and 'overloads' not in method:
continue
if 'overloads' in method:
overloads = method['overloads']
conditionally_exposed_function = overloads['exposed_test_all']
runtime_enabled_function = overloads['runtime_enabled_function_all']
has_custom_registration = overloads['has_custom_registration_all']
else:
conditionally_exposed_function = method['exposed_test']
runtime_enabled_function = method['runtime_enabled_function']
has_custom_registration = method['has_custom_registration']
if conditionally_exposed_function:
conditionally_enabled_methods.append(method)
continue
if runtime_enabled_function or has_custom_registration:
custom_registration_methods.append(method)
continue
if method['should_be_exposed_to_script']:
method_configuration_methods.append(method)
for method in methods:
# The value of the Function object’s “length” property is a Number
# determined as follows:
# 1. Let S be the effective overload set for regular operations (if the
# operation is a regular operation) or for static operations (if the
# operation is a static operation) with identifier id on interface I and
# with argument count 0.
# 2. Return the length of the shortest argument list of the entries in S.
# FIXME: This calculation doesn't take into account whether runtime
# enabled overloads are actually enabled, so length may be incorrect.
# E.g., [RuntimeEnabled=Foo] void f(); void f(long x);
# should have length 1 if Foo is not enabled, but length 0 if it is.
method['length'] = (method['overloads']['minarg'] if 'overloads' in method else
method['number_of_required_arguments'])
context.update({
'conditionally_enabled_methods': conditionally_enabled_methods,
'custom_registration_methods': custom_registration_methods,
'has_origin_safe_method_setter': any(
method['is_check_security_for_frame'] and not method['is_read_only']
for method in methods),
'has_private_script': any(attribute['is_implemented_in_private_script'] for attribute in attributes) or
any(method['is_implemented_in_private_script'] for method in methods),
'method_configuration_methods': method_configuration_methods,
'methods': methods,
})
context.update({
'indexed_property_getter': indexed_property_getter(interface),
'indexed_property_setter': indexed_property_setter(interface),
'indexed_property_deleter': indexed_property_deleter(interface),
'is_override_builtins': 'OverrideBuiltins' in extended_attributes,
'named_property_getter': named_property_getter(interface),
'named_property_setter': named_property_setter(interface),
'named_property_deleter': named_property_deleter(interface),
})
return context
def write_header_and_cpp(definitions, interface_name, interfaces_info, output_directory):
try:
interface = definitions.interfaces[interface_name]
except KeyError:
raise Exception('%s not in IDL definitions' % interface_name)
# Store other interfaces for introspection
interfaces.update(definitions.interfaces)
# Set up Jinja
if interface.is_callback:
header_template_filename = 'callback_interface.h'
cpp_template_filename = 'callback_interface.cpp'
generate_contents = v8_callback_interface.generate_callback_interface
else:
header_template_filename = 'interface.h'
cpp_template_filename = 'interface.cpp'
generate_contents = v8_interface.generate_interface
jinja_env = jinja2.Environment(
loader=jinja2.FileSystemLoader(templates_dir),
keep_trailing_newline=True, # newline-terminate generated files
lstrip_blocks=True, # so can indent control flow tags
trim_blocks=True)
jinja_env.filters.update({
'blink_capitalize': capitalize,
'conditional': conditional_if_endif,
'runtime_enabled': runtime_enabled_if,
})
header_template = jinja_env.get_template(header_template_filename)
cpp_template = jinja_env.get_template(cpp_template_filename)
# Set type info, both local and global
interface_info = interfaces_info[interface_name]
v8_types.set_callback_functions(definitions.callback_functions.keys())
v8_types.set_enums((enum.name, enum.values)
for enum in definitions.enumerations.values())
v8_types.set_ancestors(dict(
(interface_name, interface_info['ancestors'])
for interface_name, interface_info in interfaces_info.iteritems()
if 'ancestors' in interface_info))
v8_types.set_callback_interfaces(set(
interface_name
for interface_name, interface_info in interfaces_info.iteritems()
if interface_info['is_callback_interface']))
v8_types.set_implemented_as_interfaces(dict(
(interface_name, interface_info['implemented_as'])
for interface_name, interface_info in interfaces_info.iteritems()
if 'implemented_as' in interface_info))
v8_types.set_will_be_garbage_collected_types(set(
interface_name
for interface_name, interface_info in interfaces_info.iteritems()
if 'inherited_extended_attributes' in interface_info and
'WillBeGarbageCollected' in interface_info['inherited_extended_attributes']))
# Generate contents (input parameters for Jinja)
template_contents = generate_contents(interface)
template_contents['header_includes'].add(interface_info['include_path'])
template_contents['header_includes'] = sorted(template_contents['header_includes'])
includes.update(interface_info.get('dependencies_include_paths', []))
template_contents['cpp_includes'] = sorted(includes)
# Render Jinja templates and write files
def write_file(basename, file_text):
filename = os.path.join(output_directory, basename)
with open(filename, 'w') as output_file:
output_file.write(file_text)
header_basename = v8_class_name(interface) + '.h'
header_file_text = header_template.render(template_contents)
write_file(header_basename, header_file_text)
cpp_basename = v8_class_name(interface) + '.cpp'
cpp_file_text = cpp_template.render(template_contents)
write_file(cpp_basename, cpp_file_text)
def generate_interface(interface):
includes.clear()
includes.update(INTERFACE_CPP_INCLUDES)
header_includes = INTERFACE_H_INCLUDES
parent_interface = interface.parent
if parent_interface:
header_includes.update(v8_types.includes_for_type(parent_interface))
extended_attributes = interface.extended_attributes
# [CheckSecurity]
is_check_security = 'CheckSecurity' in extended_attributes
if is_check_security:
includes.update(['bindings/v8/BindingSecurity.h',
'bindings/v8/ExceptionState.h'])
# [GenerateVisitDOMWrapper]
generate_visit_dom_wrapper_function = extended_attributes.get('GenerateVisitDOMWrapper')
if generate_visit_dom_wrapper_function:
includes.update(['bindings/v8/V8GCController.h',
'core/dom/Element.h'])
# [MeasureAs]
is_measure_as = 'MeasureAs' in extended_attributes
if is_measure_as:
includes.add('core/frame/UseCounter.h')
# [RaisesException=Constructor]
is_constructor_raises_exception = extended_attributes.get('RaisesException') == 'Constructor'
if is_constructor_raises_exception:
includes.add('bindings/v8/ExceptionState.h')
# [SpecialWrapFor]
if 'SpecialWrapFor' in extended_attributes:
special_wrap_for = extended_attributes['SpecialWrapFor'].split('|')
else:
special_wrap_for = []
for special_wrap_interface in special_wrap_for:
v8_types.add_includes_for_type(special_wrap_interface)
# Constructors
# [Constructor]
has_constructor = 'Constructor' in extended_attributes
if has_constructor:
includes.add('bindings/v8/V8ObjectConstructor.h')
# [EventConstructor]
has_event_constructor = 'EventConstructor' in extended_attributes
has_any_type_attributes = any(attribute
for attribute in interface.attributes
if attribute.idl_type == 'any')
if has_event_constructor:
includes.update(['bindings/v8/Dictionary.h',
'bindings/v8/V8ObjectConstructor.h'])
if has_any_type_attributes:
includes.add('bindings/v8/SerializedScriptValue.h')
template_contents = {
'conditional_string': conditional_string(interface), # [Conditional]
'constructor_arguments': constructor_arguments(interface),
'cpp_class': cpp_name(interface),
'generate_visit_dom_wrapper_function': generate_visit_dom_wrapper_function,
'has_constructor': has_constructor,
'has_custom_legacy_call_as_function': has_extended_attribute_value(interface, 'Custom', 'LegacyCallAsFunction'), # [Custom=LegacyCallAsFunction]
'has_custom_to_v8': has_extended_attribute_value(interface, 'Custom', 'ToV8'), # [Custom=ToV8]
'has_custom_wrap': has_extended_attribute_value(interface, 'Custom', 'Wrap'), # [Custom=Wrap]
'has_event_constructor': has_event_constructor,
'has_any_type_attributes': has_any_type_attributes,
'has_visit_dom_wrapper': (
# [Custom=Wrap], [GenerateVisitDOMWrapper]
has_extended_attribute_value(interface, 'Custom', 'VisitDOMWrapper') or
'GenerateVisitDOMWrapper' in extended_attributes),
'header_includes': header_includes,
'interface_name': interface.name,
'is_active_dom_object': 'ActiveDOMObject' in extended_attributes, # [ActiveDOMObject]
'is_check_security': is_check_security,
'is_constructor_call_with_document': has_extended_attribute_value(
interface, 'ConstructorCallWith', 'Document'), # [ConstructorCallWith=Document]
'is_constructor_call_with_execution_context': has_extended_attribute_value(
interface, 'ConstructorCallWith', 'ExecutionContext'), # [ConstructorCallWith=ExeuctionContext]
'is_constructor_raises_exception': is_constructor_raises_exception,
'is_dependent_lifetime': 'DependentLifetime' in extended_attributes, # [DependentLifetime]
'length': 1 if has_event_constructor else 0, # FIXME: more complex in general, see discussion of length in http://heycam.github.io/webidl/#es-interface-call
'measure_as': v8_utilities.measure_as(interface), # [MeasureAs]
'parent_interface': parent_interface,
'runtime_enabled_function': runtime_enabled_function_name(interface), # [RuntimeEnabled]
'special_wrap_for': special_wrap_for,
'v8_class': v8_utilities.v8_class_name(interface),
}
template_contents.update({
'constants': [generate_constant(constant) for constant in interface.constants],
'do_not_check_constants': 'DoNotCheckConstants' in extended_attributes,
})
attributes = [v8_attributes.generate_attribute(interface, attribute)
for attribute in interface.attributes]
template_contents.update({
'attributes': attributes,
'has_accessors': any(attribute['is_expose_js_accessors'] for attribute in attributes),
'has_constructor_attributes': any(attribute['constructor_type'] for attribute in attributes),
'has_per_context_enabled_attributes': any(attribute['per_context_enabled_function'] for attribute in attributes),
'has_replaceable_attributes': any(attribute['is_replaceable'] for attribute in attributes),
})
methods = [v8_methods.generate_method(interface, method)
for method in interface.operations]
generate_overloads(methods)
for method in methods:
method['do_generate_method_configuration'] = (
method['do_not_check_signature'] and
not method['per_context_enabled_function'] and
# For overloaded methods, only generate one accessor
('overload_index' not in method or method['overload_index'] == 1))
template_contents.update({
'has_origin_safe_method_setter': any(
method['is_check_security_for_frame'] and not method['is_read_only']
for method in methods),
'has_method_configuration': any(method['do_generate_method_configuration'] for method in methods),
'has_per_context_enabled_methods': any(method['per_context_enabled_function'] for method in methods),
'methods': methods,
})
return template_contents
def write_header_and_cpp(definitions, interface_name, interfaces_info, output_dir):
try:
interface = definitions.interfaces[interface_name]
except KeyError:
raise Exception('%s not in IDL definitions' % interface_name)
# Store other interfaces for introspection
interfaces.update(definitions.interfaces)
# Set up Jinja
jinja_env = initialize_jinja_env(output_dir)
if interface.is_callback:
header_template_filename = 'callback_interface.h'
cpp_template_filename = 'callback_interface.cpp'
generate_contents = v8_callback_interface.generate_callback_interface
else:
header_template_filename = 'interface.h'
cpp_template_filename = 'interface.cpp'
generate_contents = v8_interface.generate_interface
header_template = jinja_env.get_template(header_template_filename)
cpp_template = jinja_env.get_template(cpp_template_filename)
# Set type info, both local and global
interface_info = interfaces_info[interface_name]
v8_types.set_callback_functions(definitions.callback_functions.keys())
v8_types.set_enums((enum.name, enum.values)
for enum in definitions.enumerations.values())
v8_types.set_ancestors(dict(
(interface_name, interface_info['ancestors'])
for interface_name, interface_info in interfaces_info.iteritems()
if 'ancestors' in interface_info))
v8_types.set_callback_interfaces(set(
interface_name
for interface_name, interface_info in interfaces_info.iteritems()
if interface_info['is_callback_interface']))
v8_types.set_implemented_as_interfaces(dict(
(interface_name, interface_info['implemented_as'])
for interface_name, interface_info in interfaces_info.iteritems()
if 'implemented_as' in interface_info))
v8_types.set_will_be_garbage_collected_types(set(
interface_name
for interface_name, interface_info in interfaces_info.iteritems()
if 'inherited_extended_attributes' in interface_info and
'WillBeGarbageCollected' in interface_info['inherited_extended_attributes']))
# Generate contents (input parameters for Jinja)
template_contents = generate_contents(interface)
template_contents['header_includes'].add(interface_info['include_path'])
template_contents['header_includes'] = sorted(template_contents['header_includes'])
includes.update(interface_info.get('dependencies_include_paths', []))
template_contents['cpp_includes'] = sorted(includes)
# Render Jinja templates and write files
def write_file(basename, file_text):
filename = os.path.join(output_dir, basename)
with open(filename, 'w') as output_file:
output_file.write(file_text)
header_basename = v8_class_name(interface) + '.h'
header_file_text = header_template.render(template_contents)
write_file(header_basename, header_file_text)
cpp_basename = v8_class_name(interface) + '.cpp'
cpp_file_text = cpp_template.render(template_contents)
write_file(cpp_basename, cpp_file_text)
def origin_trial_features_info(info_provider, reader, idl_filenames,
target_component):
"""Read a set of IDL files and compile the mapping between interfaces and
the conditional features defined on them.
Returns a tuple (features_for_type, types_for_feature, includes):
- features_for_type is a mapping of interface->feature
- types_for_feature is the reverse mapping: feature->interface
- includes is a set of header files which need to be included in the
generated implementation code.
"""
features_for_type = defaultdict(set)
types_for_feature = defaultdict(set)
include_files = set()
runtime_features = info_provider.component_info['runtime_enabled_features']
for idl_filename in idl_filenames:
interface, includes = read_idl_file(reader, idl_filename)
feature_names = get_origin_trial_feature_names_from_interface(
interface, runtime_features)
# If this interface is a mixin, we don't generate V8 bindings code for
# it.
if interface.is_mixin:
continue
# If this interface include another one,
# it inherits any conditional features from it.
for include in includes:
assert include.interface == interface.name
mixin, _ = read_idl_file(
reader,
info_provider.interfaces_info[include.mixin].get('full_path'))
feature_names |= get_origin_trial_feature_names_from_interface(
mixin, runtime_features)
feature_names = list(feature_names)
if feature_names:
is_global = interface_is_global(interface)
if interface.is_partial:
# For partial interfaces, we need to generate different
# |include_files| if the parent interface is in a different
# component.
parent_interface_info = \
info_provider.interfaces_info[interface.name]
parent_interface, _ = read_idl_file(
reader, parent_interface_info.get('full_path'))
is_global = is_global or interface_is_global(parent_interface)
parent_component = idl_filename_to_component(
parent_interface_info.get('full_path'))
if interface.is_partial and target_component != parent_component:
include_files.add('bindings/%s/v8/%s' %
(parent_component,
binding_header_filename(interface.name)))
include_files.add(
'bindings/%s/v8/%s' %
(target_component,
binding_header_filename(interface.name + 'Partial')))
else:
include_files.add('bindings/%s/v8/%s' %
(target_component,
binding_header_filename(interface.name)))
# If this is a partial interface in the same component as
# its parent, then treat it as a non-partial interface.
interface.is_partial = False
interface_info = OriginTrialInterfaceInfo(
interface.name, v8_class_name(interface),
v8_class_name_or_partial(interface), is_global)
for feature_name in feature_names:
features_for_type[interface_info].add(feature_name)
types_for_feature[feature_name].add(interface_info)
return features_for_type, types_for_feature, include_files
def generate_interface(interface):
includes.clear()
includes.update(INTERFACE_CPP_INCLUDES)
header_includes = set(INTERFACE_H_INCLUDES)
parent_interface = interface.parent
if parent_interface:
header_includes.update(v8_types.includes_for_interface(parent_interface))
extended_attributes = interface.extended_attributes
is_audio_buffer = inherits_interface(interface.name, 'AudioBuffer')
if is_audio_buffer:
includes.add('modules/webaudio/AudioBuffer.h')
is_document = inherits_interface(interface.name, 'Document')
if is_document:
includes.update(['bindings/v8/ScriptController.h',
'bindings/v8/V8WindowShell.h',
'core/frame/LocalFrame.h'])
# [ActiveDOMObject]
is_active_dom_object = 'ActiveDOMObject' in extended_attributes
# [CheckSecurity]
is_check_security = 'CheckSecurity' in extended_attributes
if is_check_security:
includes.add('bindings/v8/BindingSecurity.h')
# [DependentLifetime]
is_dependent_lifetime = 'DependentLifetime' in extended_attributes
# [MeasureAs]
is_measure_as = 'MeasureAs' in extended_attributes
if is_measure_as:
includes.add('core/frame/UseCounter.h')
# [SetWrapperReferenceFrom]
reachable_node_function = extended_attributes.get('SetWrapperReferenceFrom')
if reachable_node_function:
includes.update(['bindings/v8/V8GCController.h',
'core/dom/Element.h'])
# [SetWrapperReferenceTo]
set_wrapper_reference_to_list = [{
'name': argument.name,
# FIXME: properly should be:
# 'cpp_type': argument.idl_type.cpp_type_args(used_as_argument=True),
# (if type is non-wrapper type like NodeFilter, normally RefPtr)
# Raw pointers faster though, and NodeFilter hacky anyway.
'cpp_type': argument.idl_type.implemented_as + '*',
'idl_type': argument.idl_type,
'v8_type': v8_types.v8_type(argument.idl_type.name),
} for argument in extended_attributes.get('SetWrapperReferenceTo', [])]
for set_wrapper_reference_to in set_wrapper_reference_to_list:
set_wrapper_reference_to['idl_type'].add_includes_for_type()
# [SpecialWrapFor]
if 'SpecialWrapFor' in extended_attributes:
special_wrap_for = extended_attributes['SpecialWrapFor'].split('|')
else:
special_wrap_for = []
for special_wrap_interface in special_wrap_for:
v8_types.add_includes_for_interface(special_wrap_interface)
# [WillBeGarbageCollected]
is_will_be_garbage_collected = 'WillBeGarbageCollected' in extended_attributes
# [Custom=Wrap], [SetWrapperReferenceFrom]
has_visit_dom_wrapper = (
has_extended_attribute_value(interface, 'Custom', 'VisitDOMWrapper') or
reachable_node_function or
set_wrapper_reference_to_list)
template_contents = {
'conditional_string': conditional_string(interface), # [Conditional]
'cpp_class': cpp_name(interface),
'has_custom_legacy_call_as_function': has_extended_attribute_value(interface, 'Custom', 'LegacyCallAsFunction'), # [Custom=LegacyCallAsFunction]
'has_custom_to_v8': has_extended_attribute_value(interface, 'Custom', 'ToV8'), # [Custom=ToV8]
'has_custom_wrap': has_extended_attribute_value(interface, 'Custom', 'Wrap'), # [Custom=Wrap]
'has_visit_dom_wrapper': has_visit_dom_wrapper,
'header_includes': header_includes,
'interface_name': interface.name,
'is_active_dom_object': is_active_dom_object,
'is_audio_buffer': is_audio_buffer,
'is_check_security': is_check_security,
'is_dependent_lifetime': is_dependent_lifetime,
'is_document': is_document,
'is_event_target': inherits_interface(interface.name, 'EventTarget'),
'is_exception': interface.is_exception,
'is_will_be_garbage_collected': is_will_be_garbage_collected,
'is_node': inherits_interface(interface.name, 'Node'),
'measure_as': v8_utilities.measure_as(interface), # [MeasureAs]
'parent_interface': parent_interface,
'pass_ref_ptr': 'PassRefPtrWillBeRawPtr'
if is_will_be_garbage_collected else 'PassRefPtr',
'reachable_node_function': reachable_node_function,
'ref_ptr': 'RefPtrWillBeRawPtr'
if is_will_be_garbage_collected else 'RefPtr',
'runtime_enabled_function': runtime_enabled_function_name(interface), # [RuntimeEnabled]
'set_wrapper_reference_to_list': set_wrapper_reference_to_list,
'special_wrap_for': special_wrap_for,
'v8_class': v8_utilities.v8_class_name(interface),
'wrapper_configuration': 'WrapperConfiguration::Dependent'
if (has_visit_dom_wrapper or
is_active_dom_object or
is_dependent_lifetime)
else 'WrapperConfiguration::Independent',
}
# Constructors
constructors = [generate_constructor(interface, constructor)
for constructor in interface.constructors
# FIXME: shouldn't put named constructors with constructors
# (currently needed for Perl compatibility)
# Handle named constructors separately
if constructor.name == 'Constructor']
generate_constructor_overloads(constructors)
# [CustomConstructor]
custom_constructors = [{ # Only needed for computing interface length
'number_of_required_arguments':
number_of_required_arguments(constructor),
} for constructor in interface.custom_constructors]
# [EventConstructor]
has_event_constructor = 'EventConstructor' in extended_attributes
any_type_attributes = [attribute for attribute in interface.attributes
if attribute.idl_type.name == 'Any']
if has_event_constructor:
includes.add('bindings/v8/Dictionary.h')
if any_type_attributes:
includes.add('bindings/v8/SerializedScriptValue.h')
# [NamedConstructor]
named_constructor = generate_named_constructor(interface)
if (constructors or custom_constructors or has_event_constructor or
named_constructor):
includes.add('bindings/v8/V8ObjectConstructor.h')
includes.add('core/frame/DOMWindow.h')
template_contents.update({
'any_type_attributes': any_type_attributes,
'constructors': constructors,
'has_custom_constructor': bool(custom_constructors),
'has_event_constructor': has_event_constructor,
'interface_length':
interface_length(interface, constructors + custom_constructors),
'is_constructor_call_with_document': has_extended_attribute_value(
interface, 'ConstructorCallWith', 'Document'), # [ConstructorCallWith=Document]
'is_constructor_call_with_execution_context': has_extended_attribute_value(
interface, 'ConstructorCallWith', 'ExecutionContext'), # [ConstructorCallWith=ExeuctionContext]
'is_constructor_raises_exception': extended_attributes.get('RaisesException') == 'Constructor', # [RaisesException=Constructor]
'named_constructor': named_constructor,
})
# Constants
template_contents.update({
'constants': [generate_constant(constant) for constant in interface.constants],
'do_not_check_constants': 'DoNotCheckConstants' in extended_attributes,
})
# Attributes
attributes = [v8_attributes.generate_attribute(interface, attribute)
for attribute in interface.attributes]
template_contents.update({
'attributes': attributes,
'has_accessors': any(attribute['is_expose_js_accessors'] for attribute in attributes),
'has_attribute_configuration': any(
not (attribute['is_expose_js_accessors'] or
attribute['is_static'] or
attribute['runtime_enabled_function'] or
attribute['per_context_enabled_function'])
for attribute in attributes),
'has_constructor_attributes': any(attribute['constructor_type'] for attribute in attributes),
'has_per_context_enabled_attributes': any(attribute['per_context_enabled_function'] for attribute in attributes),
'has_replaceable_attributes': any(attribute['is_replaceable'] for attribute in attributes),
})
# Methods
methods = [v8_methods.generate_method(interface, method)
for method in interface.operations
if method.name] # Skip anonymous special operations (methods)
generate_overloads(methods)
for method in methods:
method['do_generate_method_configuration'] = (
method['do_not_check_signature'] and
not method['per_context_enabled_function'] and
# For overloaded methods, only generate one accessor
('overload_index' not in method or method['overload_index'] == 1))
template_contents.update({
'has_origin_safe_method_setter': any(
method['is_check_security_for_frame'] and not method['is_read_only']
for method in methods),
'has_method_configuration': any(method['do_generate_method_configuration'] for method in methods),
'has_per_context_enabled_methods': any(method['per_context_enabled_function'] for method in methods),
'methods': methods,
})
template_contents.update({
'indexed_property_getter': indexed_property_getter(interface),
'indexed_property_setter': indexed_property_setter(interface),
'indexed_property_deleter': indexed_property_deleter(interface),
'is_override_builtins': 'OverrideBuiltins' in extended_attributes,
'named_property_getter': named_property_getter(interface),
'named_property_setter': named_property_setter(interface),
'named_property_deleter': named_property_deleter(interface),
})
return template_contents
def origin_trial_features_info(info_provider, reader, idl_filenames, target_component):
"""Read a set of IDL files and compile the mapping between interfaces and
the conditional features defined on them.
Returns a tuple (features_for_type, types_for_feature, includes):
- features_for_type is a mapping of interface->feature
- types_for_feature is the reverse mapping: feature->interface
- includes is a set of header files which need to be included in the
generated implementation code.
"""
features_for_type = defaultdict(set)
types_for_feature = defaultdict(set)
includes = set()
# Gather interfaces which are implemented by other interfaces.
implemented_interfaces = set()
for name, interface_info in info_provider.interfaces_info.iteritems():
# Skip special entries such as 'dictionaries' or 'ancestors'.
if name.lower() == name:
continue
implemented_interfaces.update(interface_info.get('implements_interfaces'))
for idl_filename in idl_filenames:
interface, implements = read_idl_file(reader, idl_filename)
feature_names = get_origin_trial_feature_names_from_interface(interface)
# If this interface is implemented by other interfaces, we don't generate
# V8 bindings code for it.
if interface.name in implemented_interfaces:
continue
# If this interface implements another one,
# it inherits any conditional features from it.
for implement in implements:
assert implement.left_interface == interface.name
implemented_interface, _ = read_idl_file(
reader,
info_provider.interfaces_info[implement.right_interface].get('full_path'))
feature_names |= get_origin_trial_feature_names_from_interface(implemented_interface)
feature_names = list(feature_names)
if feature_names:
is_global = interface_is_global(interface)
if interface.is_partial:
# For partial interfaces, we need to generate different
# includes if the parent interface is in a different
# component.
parent_interface_info = info_provider.interfaces_info[interface.name]
parent_interface, _ = read_idl_file(
reader, parent_interface_info.get('full_path'))
is_global = is_global or interface_is_global(parent_interface)
parent_component = idl_filename_to_component(
parent_interface_info.get('full_path'))
if interface.is_partial and target_component != parent_component:
includes.add('bindings/%s/v8/%s' %
(parent_component, binding_header_filename(interface.name)))
includes.add('bindings/%s/v8/%s' %
(target_component, binding_header_filename(interface.name + 'Partial')))
else:
includes.add('bindings/%s/v8/%s' %
(target_component, binding_header_filename(interface.name)))
# If this is a partial interface in the same component as
# its parent, then treat it as a non-partial interface.
interface.is_partial = False
interface_info = OriginTrialInterfaceInfo(interface.name,
v8_class_name(interface),
v8_class_name_or_partial(
interface),
is_global)
for feature_name in feature_names:
features_for_type[interface_info].add(feature_name)
types_for_feature[feature_name].add(interface_info)
return features_for_type, types_for_feature, includes
def origin_trial_features_info(info_provider, reader, idl_filenames,
target_component):
"""Read a set of IDL files and compile the mapping between interfaces and
the conditional features defined on them.
Returns a tuple (features_for_type, types_for_feature, includes):
- features_for_type is a mapping of interface->feature
- types_for_feature is the reverse mapping: feature->interface
- includes is a set of header files which need to be included in the
generated implementation code.
"""
features_for_type = defaultdict(set)
types_for_feature = defaultdict(set)
includes = set()
for idl_filename in idl_filenames:
interface, implements = read_idl_file(reader, idl_filename)
feature_names = get_origin_trial_feature_names_from_interface(
interface)
# If this interface has NoInterfaceObject then we don't want to add
# includes for it because it is a base interface to be implemented
# by other interfaces, and does not generate an ECMAScript binding.
if 'NoInterfaceObject' in interface.extended_attributes:
continue
# If this interface implements another one,
# it inherits any conditional features from it.
for implement in implements:
assert implement.left_interface == interface.name
implemented_interface, _ = read_idl_file(
reader, info_provider.interfaces_info[
implement.right_interface].get('full_path'))
feature_names |= get_origin_trial_feature_names_from_interface(
implemented_interface)
feature_names = list(feature_names)
if feature_names:
is_global = interface_is_global(interface)
if interface.is_partial:
# For partial interfaces, we need to generate different
# includes if the parent interface is in a different
# component.
parent_interface_info = info_provider.interfaces_info[
interface.name]
parent_interface, _ = read_idl_file(
reader, parent_interface_info.get('full_path'))
is_global = is_global or interface_is_global(parent_interface)
parent_component = idl_filename_to_component(
parent_interface_info.get('full_path'))
if interface.is_partial and target_component != parent_component:
includes.add('bindings/%s/v8/%s' %
(parent_component,
binding_header_basename(interface.name)))
includes.add(
'bindings/%s/v8/%s' %
(target_component,
binding_header_basename(interface.name + 'Partial')))
else:
includes.add('bindings/%s/v8/%s' %
(target_component,
binding_header_basename(interface.name)))
# If this is a partial interface in the same component as
# its parent, then treat it as a non-partial interface.
interface.is_partial = False
interface_info = OriginTrialInterfaceInfo(
interface.name, v8_class_name(interface),
v8_class_name_or_partial(interface), is_global)
for feature_name in feature_names:
features_for_type[interface_info].add(feature_name)
types_for_feature[feature_name].add(interface_info)
return features_for_type, types_for_feature, includes
def generate_interface(interface):
includes.clear()
includes.update(INTERFACE_CPP_INCLUDES)
header_includes = set(INTERFACE_H_INCLUDES)
parent_interface = interface.parent
if parent_interface:
header_includes.update(v8_types.includes_for_interface(parent_interface))
extended_attributes = interface.extended_attributes
is_audio_buffer = inherits_interface(interface.name, "AudioBuffer")
if is_audio_buffer:
includes.add("modules/webaudio/AudioBuffer.h")
is_document = inherits_interface(interface.name, "Document")
if is_document:
includes.update(["bindings/v8/ScriptController.h", "bindings/v8/V8WindowShell.h", "core/frame/LocalFrame.h"])
# [ActiveDOMObject]
is_active_dom_object = "ActiveDOMObject" in extended_attributes
# [CheckSecurity]
is_check_security = "CheckSecurity" in extended_attributes
if is_check_security:
includes.add("bindings/v8/BindingSecurity.h")
# [DependentLifetime]
is_dependent_lifetime = "DependentLifetime" in extended_attributes
# [MeasureAs]
is_measure_as = "MeasureAs" in extended_attributes
if is_measure_as:
includes.add("core/frame/UseCounter.h")
# [SetWrapperReferenceFrom]
reachable_node_function = extended_attributes.get("SetWrapperReferenceFrom")
if reachable_node_function:
includes.update(["bindings/v8/V8GCController.h", "core/dom/Element.h"])
# [SetWrapperReferenceTo]
set_wrapper_reference_to_list = [
{
"name": argument.name,
# FIXME: properly should be:
# 'cpp_type': argument.idl_type.cpp_type_args(used_as_argument=True),
# (if type is non-wrapper type like NodeFilter, normally RefPtr)
# Raw pointers faster though, and NodeFilter hacky anyway.
"cpp_type": argument.idl_type.implemented_as + "*",
"idl_type": argument.idl_type,
"v8_type": v8_types.v8_type(argument.idl_type.name),
}
for argument in extended_attributes.get("SetWrapperReferenceTo", [])
]
for set_wrapper_reference_to in set_wrapper_reference_to_list:
set_wrapper_reference_to["idl_type"].add_includes_for_type()
# [SpecialWrapFor]
if "SpecialWrapFor" in extended_attributes:
special_wrap_for = extended_attributes["SpecialWrapFor"].split("|")
else:
special_wrap_for = []
for special_wrap_interface in special_wrap_for:
v8_types.add_includes_for_interface(special_wrap_interface)
# [Custom=Wrap], [SetWrapperReferenceFrom]
has_visit_dom_wrapper = (
has_extended_attribute_value(interface, "Custom", "VisitDOMWrapper")
or reachable_node_function
or set_wrapper_reference_to_list
)
this_gc_type = gc_type(interface)
template_contents = {
"conditional_string": conditional_string(interface), # [Conditional]
"cpp_class": cpp_name(interface),
"gc_type": this_gc_type,
"has_custom_legacy_call_as_function": has_extended_attribute_value(
interface, "Custom", "LegacyCallAsFunction"
), # [Custom=LegacyCallAsFunction]
"has_custom_to_v8": has_extended_attribute_value(interface, "Custom", "ToV8"), # [Custom=ToV8]
"has_custom_wrap": has_extended_attribute_value(interface, "Custom", "Wrap"), # [Custom=Wrap]
"has_visit_dom_wrapper": has_visit_dom_wrapper,
"header_includes": header_includes,
"interface_name": interface.name,
"is_active_dom_object": is_active_dom_object,
"is_audio_buffer": is_audio_buffer,
"is_check_security": is_check_security,
"is_dependent_lifetime": is_dependent_lifetime,
"is_document": is_document,
"is_event_target": inherits_interface(interface.name, "EventTarget"),
"is_exception": interface.is_exception,
"is_node": inherits_interface(interface.name, "Node"),
"measure_as": v8_utilities.measure_as(interface), # [MeasureAs]
"parent_interface": parent_interface,
"pass_cpp_type": cpp_template_type(cpp_ptr_type("PassRefPtr", "RawPtr", this_gc_type), cpp_name(interface)),
"reachable_node_function": reachable_node_function,
"runtime_enabled_function": runtime_enabled_function_name(interface), # [RuntimeEnabled]
"set_wrapper_reference_to_list": set_wrapper_reference_to_list,
"special_wrap_for": special_wrap_for,
"v8_class": v8_utilities.v8_class_name(interface),
"wrapper_configuration": "WrapperConfiguration::Dependent"
if (has_visit_dom_wrapper or is_active_dom_object or is_dependent_lifetime)
else "WrapperConfiguration::Independent",
}
# Constructors
constructors = [
generate_constructor(interface, constructor)
for constructor in interface.constructors
# FIXME: shouldn't put named constructors with constructors
# (currently needed for Perl compatibility)
# Handle named constructors separately
if constructor.name == "Constructor"
]
if len(constructors) > 1:
template_contents["constructor_overloads"] = generate_overloads(constructors)
# [CustomConstructor]
custom_constructors = [
{ # Only needed for computing interface length
"number_of_required_arguments": number_of_required_arguments(constructor)
}
for constructor in interface.custom_constructors
]
# [EventConstructor]
has_event_constructor = "EventConstructor" in extended_attributes
any_type_attributes = [attribute for attribute in interface.attributes if attribute.idl_type.name == "Any"]
if has_event_constructor:
includes.add("bindings/v8/Dictionary.h")
if any_type_attributes:
includes.add("bindings/v8/SerializedScriptValue.h")
# [NamedConstructor]
named_constructor = generate_named_constructor(interface)
if constructors or custom_constructors or has_event_constructor or named_constructor:
includes.add("bindings/v8/V8ObjectConstructor.h")
includes.add("core/frame/DOMWindow.h")
template_contents.update(
{
"any_type_attributes": any_type_attributes,
"constructors": constructors,
"has_custom_constructor": bool(custom_constructors),
"has_event_constructor": has_event_constructor,
"interface_length": interface_length(interface, constructors + custom_constructors),
"is_constructor_call_with_document": has_extended_attribute_value(
interface, "ConstructorCallWith", "Document"
), # [ConstructorCallWith=Document]
"is_constructor_call_with_execution_context": has_extended_attribute_value(
interface, "ConstructorCallWith", "ExecutionContext"
), # [ConstructorCallWith=ExeuctionContext]
"is_constructor_raises_exception": extended_attributes.get("RaisesException")
== "Constructor", # [RaisesException=Constructor]
"named_constructor": named_constructor,
}
)
# Constants
template_contents.update(
{
"constants": [generate_constant(constant) for constant in interface.constants],
"do_not_check_constants": "DoNotCheckConstants" in extended_attributes,
}
)
# Attributes
attributes = [v8_attributes.generate_attribute(interface, attribute) for attribute in interface.attributes]
template_contents.update(
{
"attributes": attributes,
"has_accessors": any(attribute["is_expose_js_accessors"] for attribute in attributes),
"has_attribute_configuration": any(
not (
attribute["is_expose_js_accessors"]
or attribute["is_static"]
or attribute["runtime_enabled_function"]
or attribute["per_context_enabled_function"]
)
for attribute in attributes
),
"has_constructor_attributes": any(attribute["constructor_type"] for attribute in attributes),
"has_per_context_enabled_attributes": any(
attribute["per_context_enabled_function"] for attribute in attributes
),
"has_replaceable_attributes": any(attribute["is_replaceable"] for attribute in attributes),
}
)
# Methods
methods = [
v8_methods.generate_method(interface, method) for method in interface.operations if method.name
] # Skip anonymous special operations (methods)
generate_method_overloads(methods)
for method in methods:
method["do_generate_method_configuration"] = (
method["do_not_check_signature"]
and not method["per_context_enabled_function"]
and
# For overloaded methods, only generate one accessor
("overload_index" not in method or method["overload_index"] == 1)
)
template_contents.update(
{
"has_origin_safe_method_setter": any(
method["is_check_security_for_frame"] and not method["is_read_only"] for method in methods
),
"has_method_configuration": any(method["do_generate_method_configuration"] for method in methods),
"has_per_context_enabled_methods": any(method["per_context_enabled_function"] for method in methods),
"methods": methods,
}
)
template_contents.update(
{
"indexed_property_getter": indexed_property_getter(interface),
"indexed_property_setter": indexed_property_setter(interface),
"indexed_property_deleter": indexed_property_deleter(interface),
"is_override_builtins": "OverrideBuiltins" in extended_attributes,
"named_property_getter": named_property_getter(interface),
"named_property_setter": named_property_setter(interface),
"named_property_deleter": named_property_deleter(interface),
}
)
return template_contents
def conditional_features_info(info_provider, reader, idl_filenames, target_component):
"""Read a set of IDL files and compile the mapping between interfaces and
the conditional features defined on them.
Returns a tuple (features_for_type, types_for_feature, includes):
- features_for_type is a mapping of interface->feature
- types_for_feature is the reverse mapping: feature->interface
- includes is a set of header files which need to be included in the
generated implementation code.
"""
features_for_type = defaultdict(set)
types_for_feature = defaultdict(set)
includes = set()
for idl_filename in idl_filenames:
interface, implements = read_idl_file(reader, idl_filename)
feature_names = get_conditional_feature_names_from_interface(interface)
# If this interface implements another one,
# it inherits any conditional features from it.
for implement in implements:
assert implement.left_interface == interface.name
implemented_interface, _ = read_idl_file(
reader,
info_provider.interfaces_info[implement.right_interface].get('full_path'))
feature_names |= get_conditional_feature_names_from_interface(implemented_interface)
feature_names = list(feature_names)
if feature_names:
is_global = interface_is_global(interface)
if interface.is_partial:
# For partial interfaces, we need to generate different
# includes if the parent interface is in a different
# component.
parent_interface_info = info_provider.interfaces_info[interface.name]
parent_interface, _ = read_idl_file(
reader, parent_interface_info.get('full_path'))
is_global = is_global or interface_is_global(parent_interface)
parent_component = idl_filename_to_component(
parent_interface_info.get('full_path'))
if interface.is_partial and target_component != parent_component:
includes.add('bindings/%s/v8/V8%s.h' %
(parent_component, interface.name))
includes.add('bindings/%s/v8/V8%sPartial.h' %
(target_component, interface.name))
else:
includes.add('bindings/%s/v8/V8%s.h' %
(target_component, interface.name))
# If this is a partial interface in the same component as
# its parent, then treat it as a non-partial interface.
interface.is_partial = False
interface_info = ConditionalInterfaceInfo(interface.name,
v8_class_name(interface),
v8_class_name_or_partial(
interface),
is_global)
for feature_name in feature_names:
features_for_type[interface_info].add(feature_name)
types_for_feature[feature_name].add(interface_info)
return features_for_type, types_for_feature, includes