def _generate_container_code(self, union_type):
union_type = union_type.resolve_typedefs(self.typedefs)
header_template = self.jinja_env.get_template('union_container.h.tmpl')
cpp_template = self.jinja_env.get_template('union_container.cpp.tmpl')
template_context = v8_union.container_context(union_type,
self.info_provider)
template_context['header_includes'].append(
self.info_provider.include_path_for_export)
template_context['header_includes'] = normalize_and_sort_includes(
template_context['header_includes'],
self.snake_case_generated_files)
template_context['cpp_includes'] = normalize_and_sort_includes(
template_context['cpp_includes'], self.snake_case_generated_files)
template_context['code_generator'] = self.generator_name
template_context['exported'] = self.info_provider.specifier_for_export
snake_base_name = to_snake_case(shorten_union_name(union_type))
template_context['this_include_header_name'] = snake_base_name
header_text = render_template(header_template, template_context)
cpp_text = render_template(cpp_template, template_context)
header_path = posixpath.join(self.output_dir, '%s.h' % snake_base_name)
cpp_path = posixpath.join(self.output_dir, '%s.cc' % snake_base_name)
return (
(header_path, header_text),
(cpp_path, cpp_text),
)
def _generate_container_code(self, union_type):
header_template = self.jinja_env.get_template("union_container.h.tmpl")
cpp_template = self.jinja_env.get_template("union_container.cpp.tmpl")
template_context = v8_union.container_context(union_type, self.info_provider.interfaces_info)
template_context["header_includes"].append(self.info_provider.include_path_for_export)
template_context["header_includes"] = normalize_and_sort_includes(template_context["header_includes"])
template_context["code_generator"] = self.generator_name
template_context["exported"] = self.info_provider.specifier_for_export
name = shorten_union_name(union_type)
template_context["this_include_header_name"] = name
header_text = header_template.render(template_context)
cpp_text = cpp_template.render(template_context)
header_path = posixpath.join(self.output_dir, "%s.h" % name)
cpp_path = posixpath.join(self.output_dir, "%s.cpp" % name)
return ((header_path, header_text), (cpp_path, cpp_text))
def _generate_container_code(self, union_type):
header_template = self.jinja_env.get_template('union_container.h')
cpp_template = self.jinja_env.get_template('union_container.cpp')
template_context = v8_union.container_context(
union_type, self.info_provider.interfaces_info)
template_context['header_includes'].append(
self.info_provider.include_path_for_export)
template_context['header_includes'] = normalize_and_sort_includes(
template_context['header_includes'])
template_context['code_generator'] = module_pyname
template_context['exported'] = self.info_provider.specifier_for_export
name = shorten_union_name(union_type)
template_context['this_include_header_name'] = name
header_text = header_template.render(template_context)
cpp_text = cpp_template.render(template_context)
header_path = posixpath.join(self.output_dir, '%s.h' % name)
cpp_path = posixpath.join(self.output_dir, '%s.cpp' % name)
return (
(header_path, header_text),
(cpp_path, cpp_text),
)
def _generate_container_code(self, union_type):
header_template = self.jinja_env.get_template('union_container.h')
cpp_template = self.jinja_env.get_template('union_container.cpp')
template_context = v8_union.container_context(
union_type, self.info_provider.interfaces_info)
template_context['header_includes'].append(
self.info_provider.include_path_for_export)
template_context['header_includes'] = normalize_and_sort_includes(
template_context['header_includes'])
template_context['code_generator'] = module_pyname
template_context['exported'] = self.info_provider.specifier_for_export
name = shorten_union_name(union_type)
template_context['this_include_header_name'] = name
header_text = header_template.render(template_context)
cpp_text = cpp_template.render(template_context)
header_path = posixpath.join(self.output_dir, '%s.h' % name)
cpp_path = posixpath.join(self.output_dir, '%s.cpp' % name)
return (
(header_path, header_text),
(cpp_path, cpp_text),
)
def _generate_container_code(self, union_type):
includes.clear()
union_type = union_type.resolve_typedefs(self.typedefs)
header_template = self.jinja_env.get_template('union_container.h.tmpl')
cpp_template = self.jinja_env.get_template('union_container.cc.tmpl')
template_context = v8_union.container_context(union_type, self.info_provider)
template_context['header_includes'].append(
self.info_provider.include_path_for_export)
template_context['exported'] = self.info_provider.specifier_for_export
snake_base_name = to_snake_case(shorten_union_name(union_type))
header_path = posixpath.join(self.output_dir, '%s.h' % snake_base_name)
cpp_path = posixpath.join(self.output_dir, '%s.cc' % snake_base_name)
this_include_header_path = self.normalize_this_header_path(header_path)
template_context['this_include_header_path'] = this_include_header_path
template_context['header_guard'] = to_header_guard(this_include_header_path)
header_text, cpp_text = self.render_templates(
[], header_template, cpp_template, template_context)
return (
(header_path, header_text),
(cpp_path, cpp_text),
)
def compute_interfaces_info_overall(info_individuals):
"""Compute information about IDL files.
Information is stored in global interfaces_info.
"""
for info in info_individuals:
merge_dict_recursively(interfaces_info, info['interfaces_info'])
# Interfaces in one component may have partial interfaces in
# another component. This is ok (not a layering violation), since
# partial interfaces are used to *extend* interfaces.
# We thus need to update or append if already present
dict_of_dicts_of_lists_update_or_append(
partial_interface_files, info['partial_interface_files'])
interfaces_referenced_from_partial_interfaces.update(
info['partial_interface_referenced_interfaces'])
# Append interfaces referenced from partial interfaces into the full
# interface's list of partial interfaces
for interface_name, referenced_interfaces in interfaces_referenced_from_partial_interfaces.items():
interface_info = interfaces_info[interface_name]
interface_info['referenced_interfaces'].extend(referenced_interfaces)
# Record inheritance information individually
for interface_name, interface_info in interfaces_info.iteritems():
extended_attributes = interface_info['extended_attributes']
inherited_extended_attributes_by_interface[interface_name] = dict(
(key, value)
for key, value in extended_attributes.iteritems()
if key in INHERITED_EXTENDED_ATTRIBUTES)
parent = interface_info['parent']
if parent:
parent_interfaces[interface_name] = parent
# Once all individual files handled, can compute inheritance information
# and dependencies
# Compute inheritance info
for interface_name in interfaces_info:
compute_inheritance_info(interface_name)
# Compute dependencies
# Move implements info from implement*ed* interface (rhs of 'implements')
# to implement*ing* interface (lhs of 'implements').
# Note that moving an 'implements' statement between implementing and
# implemented files does not change the info (or hence cause a rebuild)!
for right_interface_name, interface_info in interfaces_info.iteritems():
for left_interface_name in interface_info['implemented_by_interfaces']:
interfaces_info[left_interface_name]['implements_interfaces'].append(right_interface_name)
del interface_info['implemented_by_interfaces']
# An IDL file's dependencies are partial interface files that extend it,
# and files for other interfaces that this interfaces implements.
for interface_name, interface_info in interfaces_info.iteritems():
partial_interface_paths = partial_interface_files[interface_name]
partial_interfaces_full_paths = partial_interface_paths['full_paths']
# Partial interface definitions each need an include, as they are
# implemented in separate classes from the main interface.
partial_interfaces_include_paths = partial_interface_paths['include_paths']
implemented_interfaces = interface_info['implements_interfaces']
try:
implemented_interfaces_info = [
interfaces_info[interface]
for interface in implemented_interfaces]
except KeyError as key_name:
raise IdlInterfaceFileNotFoundError('Could not find the IDL file where the following implemented interface is defined: %s' % key_name)
implemented_interfaces_full_paths = [
implemented_interface_info['full_path']
for implemented_interface_info in implemented_interfaces_info]
# Implemented interfaces don't need includes, as this is handled in
# the Blink implementation (they are implemented on |impl| itself,
# hence header is included in implementing class).
# However, they are needed for legacy implemented interfaces that
# are being treated as partial interfaces, until we remove these.
# http://crbug.com/360435
implemented_interfaces_include_paths = [
implemented_interface_info['include_path']
for implemented_interface_info in implemented_interfaces_info
if implemented_interface_info['is_legacy_treat_as_partial_interface']]
dependencies_full_paths = implemented_interfaces_full_paths
dependencies_include_paths = implemented_interfaces_include_paths
dependencies_other_component_full_paths = []
dependencies_other_component_include_paths = []
component = idl_filename_to_component(interface_info['full_path'])
for full_path in partial_interfaces_full_paths:
partial_interface_component = idl_filename_to_component(full_path)
if component == partial_interface_component:
dependencies_full_paths.append(full_path)
else:
dependencies_other_component_full_paths.append(full_path)
for include_path in partial_interfaces_include_paths:
partial_interface_component = idl_filename_to_component(include_path)
if component == partial_interface_component:
dependencies_include_paths.append(include_path)
else:
dependencies_other_component_include_paths.append(include_path)
for union_type in interface_info.get('union_types', []):
name = shorten_union_name(union_type)
dependencies_include_paths.append(
'bindings/%s/v8/%s.h' % (component, name))
interface_info.update({
'dependencies_full_paths': dependencies_full_paths,
'dependencies_include_paths': dependencies_include_paths,
'dependencies_other_component_full_paths':
dependencies_other_component_full_paths,
'dependencies_other_component_include_paths':
dependencies_other_component_include_paths,
})
# Clean up temporary private information
for interface_info in interfaces_info.itervalues():
del interface_info['extended_attributes']
del interface_info['union_types']
del interface_info['is_legacy_treat_as_partial_interface']
# Compute global_type_info to interfaces_info so that idl_compiler does
# not need to always calculate the info in __init__.
compute_global_type_info()
def collect_info(self, idl_filename):
"""Reads an idl file and collects information which is required by the
binding code generation."""
def collect_unforgeable_attributes(definition, idl_filename):
"""Collects [Unforgeable] attributes so that we can define them on
sub-interfaces later. The resulting structure is as follows.
interfaces_info[interface_name] = {
'unforgeable_attributes': {
'core': [IdlAttribute, ...],
'modules': [IdlAttribute, ...],
},
...
}
"""
interface_info = {}
unforgeable_attributes = get_unforgeable_attributes_from_definition(
definition)
if not unforgeable_attributes:
return interface_info
if definition.is_partial:
interface_basename = idl_filename_to_interface_name(
idl_filename)
# TODO(yukishiino): [PartialInterfaceImplementedAs] is treated
# in interface_dependency_resolver.transfer_extended_attributes.
# Come up with a better way to keep them consistent.
for attr in unforgeable_attributes:
attr.extended_attributes[
'PartialInterfaceImplementedAs'] = definition.extended_attributes.get(
'ImplementedAs', interface_basename)
component = idl_filename_to_component(idl_filename)
interface_info['unforgeable_attributes'] = {}
interface_info['unforgeable_attributes'][
component] = unforgeable_attributes
return interface_info
definitions = self.reader.read_idl_file(idl_filename)
this_union_types = collect_union_types_from_definitions(definitions)
self.union_types.update(this_union_types)
self.typedefs.update(definitions.typedefs)
# Check enum duplication.
for enum_name in definitions.enumerations.keys():
for defined_enum in self.enumerations:
if defined_enum.name == enum_name:
raise Exception('Enumeration %s has multiple definitions' %
enum_name)
self.enumerations.update(definitions.enumerations.values())
if definitions.interfaces:
definition = next(definitions.interfaces.itervalues())
interface_info = {
'is_callback_interface':
definition.is_callback,
'is_dictionary':
False,
# Interfaces that are referenced (used as types) and that we
# introspect during code generation (beyond interface-level
# data ([ImplementedAs], is_callback_interface, ancestors, and
# inherited extended attributes): deep dependencies.
# These cause rebuilds of referrers, due to the dependency,
# so these should be minimized; currently only targets of
# [PutForwards].
'referenced_interfaces':
get_put_forward_interfaces_from_definition(definition),
}
elif definitions.dictionaries:
definition = next(definitions.dictionaries.itervalues())
interface_info = {
'is_callback_interface': False,
'is_dictionary': True,
'referenced_interfaces': None,
}
else:
return
if definition.name not in self.interfaces_info:
self.interfaces_info[definition.name] = {}
# Remember [Unforgeable] attributes.
if definitions.interfaces:
merge_dict_recursively(
self.interfaces_info[definition.name],
collect_unforgeable_attributes(definition, idl_filename))
component = idl_filename_to_component(idl_filename)
extended_attributes = definition.extended_attributes
implemented_as = extended_attributes.get('ImplementedAs')
full_path = os.path.realpath(idl_filename)
this_include_path = None if 'NoImplHeader' in extended_attributes else include_path(
idl_filename, implemented_as)
if definition.is_partial:
# We don't create interface_info for partial interfaces, but
# adds paths to another dict.
partial_include_paths = []
if this_include_path:
partial_include_paths.append(this_include_path)
for union_type in this_union_types:
name = shorten_union_name(union_type)
partial_include_paths.append('bindings/%s/v8/%s.h' %
(component, name))
self.add_paths_to_partials_dict(definition.name, full_path,
partial_include_paths)
# Collects C++ header paths which should be included from generated
# .cpp files. The resulting structure is as follows.
# interfaces_info[interface_name] = {
# 'cpp_includes': {
# 'core': set(['core/foo/Foo.h', ...]),
# 'modules': set(['modules/bar/Bar.h', ...]),
# },
# ...
# }
if this_include_path:
merge_dict_recursively(
self.interfaces_info[definition.name],
{'cpp_includes': {
component: set([this_include_path])
}})
return
# 'implements' statements can be included in either the file for the
# implement*ing* interface (lhs of 'implements') or implement*ed* interface
# (rhs of 'implements'). Store both for now, then merge to implement*ing*
# interface later.
left_interfaces, right_interfaces = get_implements_from_definitions(
definitions, definition.name)
interface_info.update({
'extended_attributes':
extended_attributes,
'full_path':
full_path,
'union_types':
this_union_types,
'implemented_as':
implemented_as,
'implemented_by_interfaces':
left_interfaces,
'implements_interfaces':
right_interfaces,
'include_path':
this_include_path,
# FIXME: temporary private field, while removing old treatement of
# 'implements': http://crbug.com/360435
'is_legacy_treat_as_partial_interface':
'LegacyTreatAsPartialInterface' in extended_attributes,
'parent':
definition.parent,
'relative_dir':
relative_dir_posix(idl_filename, source_path),
})
merge_dict_recursively(self.interfaces_info[definition.name],
interface_info)
def collect_info(self, idl_filename):
"""Reads an idl file and collects information which is required by the
binding code generation."""
def collect_unforgeable_attributes(definition, idl_filename):
"""Collects [Unforgeable] attributes so that we can define them on
sub-interfaces later. The resulting structure is as follows.
interfaces_info[interface_name] = {
'unforgeable_attributes': {
'core': [IdlAttribute, ...],
'modules': [IdlAttribute, ...],
},
...
}
"""
interface_info = {}
unforgeable_attributes = get_unforgeable_attributes_from_definition(definition)
if not unforgeable_attributes:
return interface_info
if definition.is_partial:
interface_basename = idl_filename_to_interface_name(idl_filename)
# TODO(yukishiino): [PartialInterfaceImplementedAs] is treated
# in interface_dependency_resolver.transfer_extended_attributes.
# Come up with a better way to keep them consistent.
for attr in unforgeable_attributes:
attr.extended_attributes['PartialInterfaceImplementedAs'] = definition.extended_attributes.get('ImplementedAs', interface_basename)
component = idl_filename_to_component(idl_filename)
interface_info['unforgeable_attributes'] = {}
interface_info['unforgeable_attributes'][component] = unforgeable_attributes
return interface_info
definitions = self.reader.read_idl_file(idl_filename)
this_union_types = collect_union_types_from_definitions(definitions)
self.union_types.update(this_union_types)
self.typedefs.update(definitions.typedefs)
for callback_function_name, callback_function in definitions.callback_functions.iteritems():
# Set 'component_dir' to specify a directory that callback function files belong to
self.callback_functions[callback_function_name] = {
'callback_function': callback_function,
'component_dir': idl_filename_to_component(idl_filename),
'full_path': os.path.realpath(idl_filename),
}
# Check enum duplication.
for enum_name in definitions.enumerations.keys():
for defined_enum in self.enumerations:
if defined_enum.name == enum_name:
raise Exception('Enumeration %s has multiple definitions' % enum_name)
self.enumerations.update(definitions.enumerations.values())
if definitions.interfaces:
definition = next(definitions.interfaces.itervalues())
interface_info = {
'is_callback_interface': definition.is_callback,
'is_dictionary': False,
# Interfaces that are referenced (used as types) and that we
# introspect during code generation (beyond interface-level
# data ([ImplementedAs], is_callback_interface, ancestors, and
# inherited extended attributes): deep dependencies.
# These cause rebuilds of referrers, due to the dependency,
# so these should be minimized; currently only targets of
# [PutForwards].
'referenced_interfaces': get_put_forward_interfaces_from_definition(definition),
}
elif definitions.dictionaries:
definition = next(definitions.dictionaries.itervalues())
interface_info = {
'is_callback_interface': False,
'is_dictionary': True,
'referenced_interfaces': None,
}
else:
return
if definition.name not in self.interfaces_info:
self.interfaces_info[definition.name] = {}
# Remember [Unforgeable] attributes.
if definitions.interfaces:
merge_dict_recursively(self.interfaces_info[definition.name],
collect_unforgeable_attributes(definition, idl_filename))
component = idl_filename_to_component(idl_filename)
extended_attributes = definition.extended_attributes
implemented_as = extended_attributes.get('ImplementedAs')
full_path = os.path.realpath(idl_filename)
this_include_path = None if 'NoImplHeader' in extended_attributes else include_path(idl_filename, implemented_as)
if definition.is_partial:
# We don't create interface_info for partial interfaces, but
# adds paths to another dict.
partial_include_paths = []
if this_include_path:
partial_include_paths.append(this_include_path)
for union_type in this_union_types:
name = shorten_union_name(union_type)
partial_include_paths.append(
'bindings/%s/v8/%s.h' % (component, name))
self.add_paths_to_partials_dict(definition.name, full_path, partial_include_paths)
# Collects C++ header paths which should be included from generated
# .cpp files. The resulting structure is as follows.
# interfaces_info[interface_name] = {
# 'cpp_includes': {
# 'core': set(['core/foo/Foo.h', ...]),
# 'modules': set(['modules/bar/Bar.h', ...]),
# },
# ...
# }
if this_include_path:
merge_dict_recursively(
self.interfaces_info[definition.name],
{'cpp_includes': {component: set([this_include_path])}})
return
# 'implements' statements can be included in either the file for the
# implement*ing* interface (lhs of 'implements') or implement*ed* interface
# (rhs of 'implements'). Store both for now, then merge to implement*ing*
# interface later.
left_interfaces, right_interfaces = get_implements_from_definitions(
definitions, definition.name)
interface_info.update({
'extended_attributes': extended_attributes,
'full_path': full_path,
'union_types': this_union_types,
'implemented_as': implemented_as,
'implemented_by_interfaces': left_interfaces,
'implements_interfaces': right_interfaces,
'include_path': this_include_path,
# FIXME: temporary private field, while removing old treatement of
# 'implements': http://crbug.com/360435
'is_legacy_treat_as_partial_interface': 'LegacyTreatAsPartialInterface' in extended_attributes,
'parent': definition.parent,
'relative_dir': relative_dir_posix(idl_filename, source_path),
})
merge_dict_recursively(self.interfaces_info[definition.name], interface_info)
def compute_interfaces_info_overall(info_individuals):
"""Compute information about IDL files.
Information is stored in global interfaces_info.
"""
for info in info_individuals:
merge_dict_recursively(interfaces_info, info["interfaces_info"])
# Interfaces in one component may have partial interfaces in
# another component. This is ok (not a layering violation), since
# partial interfaces are used to *extend* interfaces.
# We thus need to update or append if already present
dict_of_dicts_of_lists_update_or_append(partial_interface_files, info["partial_interface_files"])
# Record inheritance information individually
for interface_name, interface_info in interfaces_info.iteritems():
extended_attributes = interface_info["extended_attributes"]
inherited_extended_attributes_by_interface[interface_name] = dict(
(key, value) for key, value in extended_attributes.iteritems() if key in INHERITED_EXTENDED_ATTRIBUTES
)
parent = interface_info["parent"]
if parent:
parent_interfaces[interface_name] = parent
# Once all individual files handled, can compute inheritance information
# and dependencies
# Compute inheritance info
for interface_name in interfaces_info:
compute_inheritance_info(interface_name)
# Compute dependencies
# Move implements info from implement*ed* interface (rhs of 'implements')
# to implement*ing* interface (lhs of 'implements').
# Note that moving an 'implements' statement between implementing and
# implemented files does not change the info (or hence cause a rebuild)!
for right_interface_name, interface_info in interfaces_info.iteritems():
for left_interface_name in interface_info["implemented_by_interfaces"]:
interfaces_info[left_interface_name]["implements_interfaces"].append(right_interface_name)
del interface_info["implemented_by_interfaces"]
# An IDL file's dependencies are partial interface files that extend it,
# and files for other interfaces that this interfaces implements.
for interface_name, interface_info in interfaces_info.iteritems():
partial_interface_paths = partial_interface_files[interface_name]
partial_interfaces_full_paths = partial_interface_paths["full_paths"]
# Partial interface definitions each need an include, as they are
# implemented in separate classes from the main interface.
partial_interfaces_include_paths = partial_interface_paths["include_paths"]
implemented_interfaces = interface_info["implements_interfaces"]
try:
implemented_interfaces_info = [interfaces_info[interface] for interface in implemented_interfaces]
except KeyError as key_name:
raise IdlInterfaceFileNotFoundError(
"Could not find the IDL file where the following implemented interface is defined: %s" % key_name
)
implemented_interfaces_full_paths = [
implemented_interface_info["full_path"] for implemented_interface_info in implemented_interfaces_info
]
# Implemented interfaces don't need includes, as this is handled in
# the Blink implementation (they are implemented on |impl| itself,
# hence header is included in implementing class).
# However, they are needed for legacy implemented interfaces that
# are being treated as partial interfaces, until we remove these.
# http://crbug.com/360435
implemented_interfaces_include_paths = []
for implemented_interface_info in implemented_interfaces_info:
if (
implemented_interface_info["is_legacy_treat_as_partial_interface"]
and implemented_interface_info["include_path"]
):
implemented_interfaces_include_paths.append(implemented_interface_info["include_path"])
dependencies_full_paths = implemented_interfaces_full_paths
dependencies_include_paths = implemented_interfaces_include_paths
dependencies_other_component_full_paths = []
dependencies_other_component_include_paths = []
component = idl_filename_to_component(interface_info["full_path"])
for full_path in partial_interfaces_full_paths:
partial_interface_component = idl_filename_to_component(full_path)
if component == partial_interface_component:
dependencies_full_paths.append(full_path)
else:
dependencies_other_component_full_paths.append(full_path)
for include_path in partial_interfaces_include_paths:
partial_interface_component = idl_filename_to_component(include_path)
if component == partial_interface_component:
dependencies_include_paths.append(include_path)
else:
dependencies_other_component_include_paths.append(include_path)
for union_type in interface_info.get("union_types", []):
name = shorten_union_name(union_type)
dependencies_include_paths.append("bindings/%s/v8/%s.h" % (component, name))
interface_info.update(
{
"dependencies_full_paths": dependencies_full_paths,
"dependencies_include_paths": dependencies_include_paths,
"dependencies_other_component_full_paths": dependencies_other_component_full_paths,
"dependencies_other_component_include_paths": dependencies_other_component_include_paths,
}
)
# Clean up temporary private information
for interface_info in interfaces_info.itervalues():
del interface_info["extended_attributes"]
del interface_info["union_types"]
del interface_info["is_legacy_treat_as_partial_interface"]
# Compute global_type_info to interfaces_info so that idl_compiler does
# not need to always calculate the info in __init__.
compute_global_type_info()
