OLD | NEW |
| (Empty) |
1 # Copyright 2017 The Chromium Authors. All rights reserved. | |
2 # Use of this source code is governed by a BSD-style license that can be | |
3 # found in the LICENSE file. | |
4 | |
5 # pylint: disable=relative-import | |
6 | |
7 import argparse | |
8 import os | |
9 | |
10 from code_generator import initialize_jinja_env | |
11 from idl_reader import IdlReader | |
12 from utilities import create_component_info_provider, write_file | |
13 import utilities | |
14 import v8_attributes | |
15 import v8_interface | |
16 import v8_types | |
17 import v8_utilities | |
18 | |
19 | |
20 INCLUDES = frozenset([ | |
21 'bindings/core/v8/GeneratedCodeHelper.h', | |
22 'bindings/core/v8/V8HTMLDocument.h', | |
23 'bindings/core/v8/V8Initializer.h', | |
24 'bindings/core/v8/V8Window.h', | |
25 'platform/bindings/DOMWrapperWorld.h', | |
26 'platform/bindings/V8ObjectConstructor.h', | |
27 'platform/bindings/V8PerIsolateData.h', | |
28 'platform/bindings/V8PrivateProperty.h', | |
29 'v8/include/v8.h']) | |
30 | |
31 TEMPLATE_FILE = 'external_reference_table.cpp.tmpl' | |
32 | |
33 WHITE_LIST_INTERFACES = frozenset([ | |
34 'DOMMatrix', # crbug.com/733481 | |
35 ]) | |
36 | |
37 SNAPSHOTTED_INTERFACES = frozenset([ | |
38 'Window', | |
39 'EventTarget', | |
40 'HTMLDocument', | |
41 'Document', | |
42 'Node', | |
43 ]) | |
44 | |
45 | |
46 def parse_args(): | |
47 parser = argparse.ArgumentParser() | |
48 parser.add_argument('--idl-files-list', type=str, required=True, | |
49 help='file listing IDL files') | |
50 parser.add_argument('--output', type=str, required=True, | |
51 help='output file path') | |
52 parser.add_argument('--info-dir', type=str, required=True, | |
53 help='directory contains component info') | |
54 parser.add_argument('--cache-dir', type=str, required=True, | |
55 help='cache directory') | |
56 parser.add_argument('--target-component', type=str, required=True, | |
57 help='target component') | |
58 return parser.parse_known_args() | |
59 | |
60 | |
61 # This class creates a Jinja template context about an interface. | |
62 class InterfaceTemplateContextBuilder(object): | |
63 | |
64 def __init__(self, opts, info_provider): | |
65 self._opts = opts | |
66 self._info_provider = info_provider | |
67 | |
68 def create_interface_context(self, interface, interfaces): | |
69 '''Creates a Jinja context which is based on an interface.''' | |
70 | |
71 name = '%s%s' % (v8_utilities.cpp_name(interface), 'Partial' if interfac
e.is_partial else '') | |
72 | |
73 # Constructors | |
74 constructors = any(constructor.name == 'Constructor' for constructor in
interface.constructors) | |
75 custom_constructors = interface.custom_constructors | |
76 html_constructor = 'HTMLConstructor' in interface.extended_attributes | |
77 has_constructor_callback = constructors or custom_constructors or html_c
onstructor | |
78 | |
79 attributes = [] | |
80 methods = [] | |
81 has_cross_origin_indexed_getter = False | |
82 has_cross_origin_named_enum = False | |
83 has_cross_origin_named_getter = False | |
84 has_cross_origin_named_setter = False | |
85 has_origin_safe_method_setter = False | |
86 has_security_check = False | |
87 indexed_property_getter = None | |
88 is_global = False | |
89 named_property_getter = None | |
90 if interface.name in SNAPSHOTTED_INTERFACES: | |
91 attributes = [v8_attributes.attribute_context(interface, attribute,
interfaces) | |
92 for attribute in interface.attributes] | |
93 methods = v8_interface.methods_context(interface)['methods'] | |
94 is_global = ('PrimaryGlobal' in interface.extended_attributes or | |
95 'Global' in interface.extended_attributes) | |
96 | |
97 named_property_getter = v8_interface.property_getter( | |
98 interface.named_property_getter, ['name']) | |
99 indexed_property_getter = v8_interface.property_getter( | |
100 interface.indexed_property_getter, ['index']) | |
101 | |
102 if not interface.is_partial: | |
103 has_origin_safe_method_setter = is_global and any( | |
104 method['is_check_security_for_receiver'] and not method['is_
unforgeable'] | |
105 for method in methods) | |
106 has_security_check = ('CheckSecurity' in interface.extended_attr
ibutes and | |
107 interface.name != 'EventTarget') | |
108 has_cross_origin_named_getter = (any(method['is_cross_origin'] f
or method in methods) or | |
109 any(attribute['has_cross_origin
_getter'] for attribute in attributes)) | |
110 has_cross_origin_named_setter = any(attribute['has_cross_origin_
setter'] for attribute in attributes) | |
111 has_cross_origin_indexed_getter = indexed_property_getter and in
dexed_property_getter['is_cross_origin'] | |
112 has_cross_origin_named_enum = has_cross_origin_named_getter or h
as_cross_origin_named_setter | |
113 if named_property_getter and named_property_getter['is_cross_ori
gin']: | |
114 has_cross_origin_named_getter = True | |
115 | |
116 return { | |
117 'attributes': attributes, | |
118 'has_origin_safe_method_setter': has_origin_safe_method_setter, | |
119 'has_constructor_callback': has_constructor_callback, | |
120 'has_cross_origin_named_getter': has_cross_origin_named_getter, | |
121 'has_cross_origin_named_setter': has_cross_origin_named_setter, | |
122 'has_cross_origin_named_enumerator': has_cross_origin_named_enum, | |
123 'has_cross_origin_indexed_getter': has_cross_origin_indexed_getter, | |
124 'has_security_check': has_security_check, | |
125 'indexed_property_getter': indexed_property_getter, | |
126 'indexed_property_setter': v8_interface.property_setter(interface.in
dexed_property_setter, interface), | |
127 'indexed_property_deleter': v8_interface.property_deleter(interface.
indexed_property_deleter), | |
128 'is_array_buffer_or_view': interface.idl_type.is_array_buffer_or_vie
w, | |
129 'is_callback': interface.is_callback, | |
130 'is_partial': interface.is_partial, | |
131 'is_snapshotted': interface in SNAPSHOTTED_INTERFACES, | |
132 'methods': methods, | |
133 'name': name, | |
134 'named_constructor': v8_interface.named_constructor_context(interfac
e), | |
135 'named_property_getter': named_property_getter, | |
136 'named_property_setter': v8_interface.property_setter(interface.name
d_property_setter, interface), | |
137 'named_property_deleter': v8_interface.property_deleter(interface.na
med_property_deleter), | |
138 'v8_name': v8_utilities.v8_class_name_or_partial(interface), | |
139 } | |
140 | |
141 | |
142 # This class applies a Jinja template and creates a .cpp file for the external r
eference table. | |
143 class ExternalReferenceTableGenerator(object): | |
144 def __init__(self, opts, info_provider): | |
145 self._opts = opts | |
146 self._info_provider = info_provider | |
147 self._reader = IdlReader( | |
148 info_provider.interfaces_info, opts.cache_dir) | |
149 self._interface_contexts = {} | |
150 self._include_files = set(INCLUDES) | |
151 v8_types.set_component_dirs(info_provider.interfaces_info['component_dir
s']) | |
152 | |
153 # Creates a Jinja context from an IDL file. | |
154 def process_idl_file(self, idl_filename): | |
155 definitions = self._reader.read_idl_definitions(idl_filename) | |
156 base_name, _ = os.path.splitext(os.path.basename(idl_filename)) | |
157 for component in definitions: | |
158 target_definitions = definitions[component] | |
159 interfaces = target_definitions.interfaces | |
160 if base_name in interfaces.keys(): | |
161 interface = interfaces[base_name] | |
162 self._process_interface(interface, component, interfaces) | |
163 | |
164 # Creates a Jinja context from an interface. Some interfaces are not used | |
165 # in V8 context snapshot, so we can skip them. | |
166 def _process_interface(self, interface, component, interfaces): | |
167 def has_impl(interface): | |
168 if interface.name in WHITE_LIST_INTERFACES: | |
169 return True | |
170 # Non legacy callback interface does not provide V8 callbacks. | |
171 if interface.is_callback: | |
172 return len(interface.constants) > 0 | |
173 if 'RuntimeEnabled' in interface.extended_attributes: | |
174 return False | |
175 return True | |
176 | |
177 if not has_impl(interface): | |
178 return | |
179 | |
180 context_builder = InterfaceTemplateContextBuilder(self._opts, self._info
_provider) | |
181 context = context_builder.create_interface_context(interface, interfaces
) | |
182 name = '%s%s' % (interface.name, 'Partial' if interface.is_partial else
'') | |
183 self._interface_contexts[name] = context | |
184 include_file = 'bindings/%s/v8/%s.h' % (component, context['v8_name']) | |
185 self._include_files.add(include_file) | |
186 | |
187 # Gathers all interface-dependent information and returns as a Jinja templat
e context. | |
188 def _create_template_context(self): | |
189 interfaces = [] | |
190 for name in sorted(self._interface_contexts): | |
191 interfaces.append(self._interface_contexts[name]) | |
192 return { | |
193 'class': 'V8ContextSnapshotExternalReferences', | |
194 'interfaces': interfaces, | |
195 'include_files': sorted(list(self._include_files)), | |
196 } | |
197 | |
198 # Applies a Jinja template on a context and generates a C++ code. | |
199 def generate(self): | |
200 jinja_env = initialize_jinja_env(self._opts.cache_dir) | |
201 context = self._create_template_context() | |
202 cpp_template = jinja_env.get_template(TEMPLATE_FILE) | |
203 cpp_text = cpp_template.render(context) | |
204 return cpp_text | |
205 | |
206 | |
207 def main(): | |
208 opts, _ = parse_args() | |
209 # TODO(peria): get rid of |info_provider| | |
210 info_provider = create_component_info_provider( | |
211 opts.info_dir, opts.target_component) | |
212 generator = ExternalReferenceTableGenerator(opts, info_provider) | |
213 | |
214 idl_files = utilities.read_idl_files_list_from_file(opts.idl_files_list, Fal
se) | |
215 for idl_file in idl_files: | |
216 generator.process_idl_file(idl_file) | |
217 output_code = generator.generate() | |
218 output_path = opts.output | |
219 write_file(output_code, output_path) | |
220 | |
221 | |
222 if __name__ == '__main__': | |
223 main() | |
OLD | NEW |