OLD | NEW |
1 # Copyright 2014 The Chromium Authors. All rights reserved. | 1 # Copyright 2014 The Chromium Authors. All rights reserved. |
2 # Use of this source code is governed by a BSD-style license that can be | 2 # Use of this source code is governed by a BSD-style license that can be |
3 # found in the LICENSE file. | 3 # found in the LICENSE file. |
4 | 4 |
5 """Generate template contexts of dictionaries for both v8 bindings and | 5 """Generate template contexts of dictionaries for both v8 bindings and |
6 implementation classes that are used by blink's core/modules. | 6 implementation classes that are used by blink's core/modules. |
7 """ | 7 """ |
8 | 8 |
9 import operator | 9 import operator |
| 10 from idl_types import IdlType |
10 from v8_globals import includes | 11 from v8_globals import includes |
11 import v8_types | 12 import v8_types |
12 import v8_utilities | 13 import v8_utilities |
| 14 from v8_utilities import has_extended_attribute_value |
13 | 15 |
14 | 16 |
15 DICTIONARY_H_INCLUDES = frozenset([ | 17 DICTIONARY_H_INCLUDES = frozenset([ |
| 18 'bindings/core/v8/ToV8.h', |
16 'bindings/core/v8/V8Binding.h', | 19 'bindings/core/v8/V8Binding.h', |
17 'platform/heap/Handle.h', | 20 'platform/heap/Handle.h', |
18 ]) | 21 ]) |
19 | 22 |
20 DICTIONARY_CPP_INCLUDES = frozenset([ | 23 DICTIONARY_CPP_INCLUDES = frozenset([ |
21 'bindings/common/ExceptionState.h', | 24 'bindings/core/v8/ExceptionState.h', |
22 # FIXME: Remove this, http://crbug.com/321462 | |
23 'bindings/core/v8/Dictionary.h', | |
24 ]) | 25 ]) |
25 | 26 |
26 | 27 |
27 def setter_name_for_dictionary_member(member): | 28 def setter_name_for_dictionary_member(member): |
28 return 'set%s' % v8_utilities.capitalize(member.name) | 29 name = v8_utilities.cpp_name(member) |
| 30 return 'set%s' % v8_utilities.capitalize(name) |
| 31 |
| 32 |
| 33 def null_setter_name_for_dictionary_member(member): |
| 34 if member.idl_type.is_nullable: |
| 35 name = v8_utilities.cpp_name(member) |
| 36 return 'set%sToNull' % v8_utilities.capitalize(name) |
| 37 return None |
29 | 38 |
30 | 39 |
31 def has_method_name_for_dictionary_member(member): | 40 def has_method_name_for_dictionary_member(member): |
32 return 'has%s' % v8_utilities.capitalize(member.name) | 41 name = v8_utilities.cpp_name(member) |
| 42 return 'has%s' % v8_utilities.capitalize(name) |
33 | 43 |
34 | 44 |
35 def unwrap_nullable_if_needed(idl_type): | 45 def unwrap_nullable_if_needed(idl_type): |
36 if idl_type.is_nullable: | 46 if idl_type.is_nullable: |
37 return idl_type.inner_type | 47 return idl_type.inner_type |
38 return idl_type | 48 return idl_type |
39 | 49 |
40 | 50 |
41 # Context for V8 bindings | 51 # Context for V8 bindings |
42 | 52 |
43 def dictionary_context(dictionary): | 53 def dictionary_context(dictionary, interfaces_info): |
44 includes.clear() | 54 includes.clear() |
45 includes.update(DICTIONARY_CPP_INCLUDES) | 55 includes.update(DICTIONARY_CPP_INCLUDES) |
46 return { | 56 cpp_class = v8_utilities.cpp_name(dictionary) |
47 'cpp_class': v8_utilities.cpp_name(dictionary), | 57 context = { |
| 58 'cpp_class': cpp_class, |
48 'header_includes': set(DICTIONARY_H_INCLUDES), | 59 'header_includes': set(DICTIONARY_H_INCLUDES), |
49 'members': [member_context(member) | 60 'members': [member_context(dictionary, member) |
50 for member in sorted(dictionary.members, | 61 for member in sorted(dictionary.members, |
51 key=operator.attrgetter('name'))], | 62 key=operator.attrgetter('name'))], |
52 'v8_class': v8_utilities.v8_class_name(dictionary), | 63 'use_permissive_dictionary_conversion': 'PermissiveDictionaryConversion'
in dictionary.extended_attributes, |
| 64 'v8_class': v8_types.v8_type(cpp_class), |
| 65 'v8_original_class': v8_types.v8_type(dictionary.name), |
53 } | 66 } |
| 67 if dictionary.parent: |
| 68 IdlType(dictionary.parent).add_includes_for_type() |
| 69 parent_cpp_class = v8_utilities.cpp_name_from_interfaces_info( |
| 70 dictionary.parent, interfaces_info) |
| 71 context.update({ |
| 72 'parent_cpp_class': parent_cpp_class, |
| 73 'parent_v8_class': v8_types.v8_type(parent_cpp_class), |
| 74 }) |
| 75 return context |
54 | 76 |
55 | 77 |
56 def member_context(member): | 78 def member_context(dictionary, member): |
| 79 extended_attributes = member.extended_attributes |
57 idl_type = member.idl_type | 80 idl_type = member.idl_type |
58 idl_type.add_includes_for_type() | 81 idl_type.add_includes_for_type(extended_attributes) |
59 idl_type = unwrap_nullable_if_needed(idl_type) | 82 unwrapped_idl_type = unwrap_nullable_if_needed(idl_type) |
| 83 |
| 84 if member.is_required and member.default_value: |
| 85 raise Exception( |
| 86 'Required member %s must not have a default value.' % member.name) |
60 | 87 |
61 def default_values(): | 88 def default_values(): |
62 if not member.default_value: | 89 if not member.default_value: |
63 return None, None | 90 return None, None |
64 if member.default_value.is_null: | 91 if member.default_value.is_null: |
65 return None, 'v8::Null(isolate)' | 92 return None, 'v8::Null(isolate)' |
66 cpp_default_value = str(member.default_value) | 93 cpp_default_value = unwrapped_idl_type.literal_cpp_value( |
67 v8_default_value = idl_type.cpp_value_to_v8_value( | 94 member.default_value) |
| 95 v8_default_value = unwrapped_idl_type.cpp_value_to_v8_value( |
68 cpp_value=cpp_default_value, isolate='isolate', | 96 cpp_value=cpp_default_value, isolate='isolate', |
69 creation_context='creationContext') | 97 creation_context='creationContext') |
70 return cpp_default_value, v8_default_value | 98 return cpp_default_value, v8_default_value |
71 | 99 |
72 cpp_default_value, v8_default_value = default_values() | 100 cpp_default_value, v8_default_value = default_values() |
| 101 cpp_name = v8_utilities.cpp_name(member) |
73 | 102 |
74 return { | 103 return { |
75 'cpp_default_value': cpp_default_value, | 104 'cpp_default_value': cpp_default_value, |
76 'cpp_type': idl_type.cpp_type, | 105 'cpp_name': cpp_name, |
77 'cpp_value_to_v8_value': idl_type.cpp_value_to_v8_value( | 106 'cpp_type': unwrapped_idl_type.cpp_type, |
78 cpp_value='impl->%s()' % member.name, isolate='isolate', | 107 'cpp_value_to_v8_value': unwrapped_idl_type.cpp_value_to_v8_value( |
| 108 cpp_value='impl.%s()' % cpp_name, isolate='isolate', |
79 creation_context='creationContext', | 109 creation_context='creationContext', |
80 extended_attributes=member.extended_attributes), | 110 extended_attributes=extended_attributes), |
81 'enum_validation_expression': idl_type.enum_validation_expression, | 111 'deprecate_as': v8_utilities.deprecate_as(member), |
| 112 'enum_type': idl_type.enum_type, |
| 113 'enum_values': unwrapped_idl_type.enum_values, |
82 'has_method_name': has_method_name_for_dictionary_member(member), | 114 'has_method_name': has_method_name_for_dictionary_member(member), |
83 'is_object': idl_type.name == 'Object', | 115 'idl_type': idl_type.base_type, |
| 116 'is_interface_type': idl_type.is_interface_type and not idl_type.is_dict
ionary, |
| 117 'is_nullable': idl_type.is_nullable, |
| 118 'is_object': unwrapped_idl_type.name == 'Object', |
| 119 'is_required': member.is_required, |
84 'name': member.name, | 120 'name': member.name, |
85 'setter_name': setter_name_for_dictionary_member(member), | 121 'setter_name': setter_name_for_dictionary_member(member), |
| 122 'null_setter_name': null_setter_name_for_dictionary_member(member), |
86 'v8_default_value': v8_default_value, | 123 'v8_default_value': v8_default_value, |
| 124 'v8_value_to_local_cpp_value': unwrapped_idl_type.v8_value_to_local_cpp_
value( |
| 125 extended_attributes, member.name + 'Value', |
| 126 member.name, isolate='isolate', use_exception_state=True), |
87 } | 127 } |
88 | 128 |
89 | 129 |
90 # Context for implementation classes | 130 # Context for implementation classes |
91 | 131 |
92 def dictionary_impl_context(dictionary, interfaces_info): | 132 def dictionary_impl_context(dictionary, interfaces_info): |
| 133 def remove_duplicate_members(members): |
| 134 # When [ImplementedAs] is used, cpp_name can conflict. For example, |
| 135 # dictionary D { long foo; [ImplementedAs=foo, DeprecateAs=Foo] long old
Foo; }; |
| 136 # This function removes such duplications, checking they have the same t
ype. |
| 137 members_dict = {} |
| 138 for member in members: |
| 139 cpp_name = member['cpp_name'] |
| 140 duplicated_member = members_dict.get(cpp_name) |
| 141 if duplicated_member and duplicated_member != member: |
| 142 raise Exception('Member name conflict: %s' % cpp_name) |
| 143 members_dict[cpp_name] = member |
| 144 return sorted(members_dict.values(), key=lambda member: member['cpp_name
']) |
| 145 |
93 includes.clear() | 146 includes.clear() |
94 header_includes = set(['platform/heap/Handle.h']) | 147 header_includes = set(['platform/heap/Handle.h']) |
95 return { | 148 members = [member_impl_context(member, interfaces_info, header_includes) |
| 149 for member in dictionary.members] |
| 150 members = remove_duplicate_members(members) |
| 151 context = { |
96 'header_includes': header_includes, | 152 'header_includes': header_includes, |
97 'cpp_class': v8_utilities.cpp_name(dictionary), | 153 'cpp_class': v8_utilities.cpp_name(dictionary), |
98 'members': [member_impl_context(member, interfaces_info, | 154 'members': members, |
99 header_includes) | |
100 for member in dictionary.members], | |
101 } | 155 } |
| 156 if dictionary.parent: |
| 157 context['parent_cpp_class'] = v8_utilities.cpp_name_from_interfaces_info
( |
| 158 dictionary.parent, interfaces_info) |
| 159 parent_interface_info = interfaces_info.get(dictionary.parent) |
| 160 if parent_interface_info: |
| 161 context['header_includes'].add( |
| 162 parent_interface_info['include_path']) |
| 163 return context |
102 | 164 |
103 | 165 |
104 def member_impl_context(member, interfaces_info, header_includes): | 166 def member_impl_context(member, interfaces_info, header_includes): |
105 idl_type = unwrap_nullable_if_needed(member.idl_type) | 167 idl_type = unwrap_nullable_if_needed(member.idl_type) |
106 is_object = idl_type.name == 'Object' | 168 cpp_name = v8_utilities.cpp_name(member) |
107 | 169 |
108 def getter_expression(): | 170 def getter_expression(): |
109 if idl_type.impl_should_use_nullable_container: | 171 if idl_type.impl_should_use_nullable_container: |
110 return 'm_%s.get()' % member.name | 172 return 'm_%s.get()' % cpp_name |
111 return 'm_%s' % member.name | 173 return 'm_%s' % cpp_name |
112 | 174 |
113 def has_method_expression(): | 175 def has_method_expression(): |
114 if idl_type.impl_should_use_nullable_container or idl_type.is_enum or id
l_type.is_string_type: | 176 if idl_type.impl_should_use_nullable_container or idl_type.is_enum or id
l_type.is_string_type or idl_type.is_union_type: |
115 return '!m_%s.isNull()' % member.name | 177 return '!m_%s.isNull()' % cpp_name |
116 elif is_object: | 178 elif idl_type.name in ['Any', 'Object']: |
117 return '!(m_{0}.isEmpty() || m_{0}.isNull() || m_{0}.isUndefined())'
.format(member.name) | 179 return '!(m_{0}.isEmpty() || m_{0}.isNull() || m_{0}.isUndefined())'
.format(cpp_name) |
118 else: | 180 else: |
119 return 'm_%s' % member.name | 181 return 'm_%s' % cpp_name |
120 | 182 |
121 def member_cpp_type(): | 183 def member_cpp_type(): |
122 member_cpp_type = idl_type.cpp_type_args(used_in_cpp_sequence=True) | 184 member_cpp_type = idl_type.cpp_type_args(used_in_cpp_sequence=True) |
123 if idl_type.impl_should_use_nullable_container: | 185 if idl_type.impl_should_use_nullable_container: |
124 return v8_types.cpp_template_type('Nullable', member_cpp_type) | 186 return v8_types.cpp_template_type('Nullable', member_cpp_type) |
125 return member_cpp_type | 187 return member_cpp_type |
126 | 188 |
127 cpp_default_value = None | 189 cpp_default_value = None |
128 if member.default_value and not member.default_value.is_null: | 190 if member.default_value and not member.default_value.is_null: |
129 cpp_default_value = str(member.default_value) | 191 cpp_default_value = idl_type.literal_cpp_value(member.default_value) |
130 | 192 |
131 header_includes.update(idl_type.impl_includes_for_type(interfaces_info)) | 193 header_includes.update(idl_type.impl_includes_for_type(interfaces_info)) |
132 return { | 194 return { |
133 'cpp_default_value': cpp_default_value, | 195 'cpp_default_value': cpp_default_value, |
| 196 'cpp_name': cpp_name, |
134 'getter_expression': getter_expression(), | 197 'getter_expression': getter_expression(), |
135 'has_method_expression': has_method_expression(), | 198 'has_method_expression': has_method_expression(), |
136 'has_method_name': has_method_name_for_dictionary_member(member), | 199 'has_method_name': has_method_name_for_dictionary_member(member), |
137 'is_object': is_object, | 200 'is_nullable': idl_type.is_nullable, |
138 'is_traceable': (idl_type.is_garbage_collected or | 201 'is_traceable': idl_type.is_traceable, |
139 idl_type.is_will_be_garbage_collected), | |
140 'member_cpp_type': member_cpp_type(), | 202 'member_cpp_type': member_cpp_type(), |
141 'name': member.name, | 203 'null_setter_name': null_setter_name_for_dictionary_member(member), |
142 'rvalue_cpp_type': idl_type.cpp_type_args(used_as_rvalue_type=True), | 204 'rvalue_cpp_type': idl_type.cpp_type_args(used_as_rvalue_type=True), |
143 'setter_name': setter_name_for_dictionary_member(member), | 205 'setter_name': setter_name_for_dictionary_member(member), |
144 } | 206 } |
OLD | NEW |