OLD | NEW |
| (Empty) |
1 # Copyright (C) 2013 Google Inc. All rights reserved. | |
2 # | |
3 # Redistribution and use in source and binary forms, with or without | |
4 # modification, are permitted provided that the following conditions are | |
5 # met: | |
6 # | |
7 # * Redistributions of source code must retain the above copyright | |
8 # notice, this list of conditions and the following disclaimer. | |
9 # * Redistributions in binary form must reproduce the above | |
10 # copyright notice, this list of conditions and the following disclaimer | |
11 # in the documentation and/or other materials provided with the | |
12 # distribution. | |
13 # * Neither the name of Google Inc. nor the names of its | |
14 # contributors may be used to endorse or promote products derived from | |
15 # this software without specific prior written permission. | |
16 # | |
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
28 | |
29 """Generate template values for a callback interface. | |
30 | |
31 Extends IdlType with property |callback_cpp_type|. | |
32 | |
33 Design doc: http://www.chromium.org/developers/design-documents/idl-compiler | |
34 """ | |
35 | |
36 from idl_types import IdlType, IdlTypeBase | |
37 import dart_types | |
38 from dart_utilities import DartUtilities | |
39 from v8_globals import includes | |
40 | |
41 CALLBACK_INTERFACE_H_INCLUDES = frozenset([ | |
42 'bindings/core/dart/DartCallback.h', | |
43 'bindings/core/dart/DartDOMWrapper.h', | |
44 'bindings/core/v8/ActiveDOMCallback.h', | |
45 ]) | |
46 CALLBACK_INTERFACE_CPP_INCLUDES = frozenset([ | |
47 'bindings/core/dart/DartBindingsCommonIncludes.h', | |
48 'wtf/GetPtr.h', | |
49 'wtf/RefPtr.h', | |
50 ]) | |
51 | |
52 def cpp_type(idl_type): | |
53 # FIXME: remove this function by making callback types consistent | |
54 # (always use usual v8_types.cpp_type) | |
55 idl_type_name = idl_type.name | |
56 if idl_type_name == 'String': | |
57 return 'const String&' | |
58 if idl_type_name == 'void': | |
59 return 'void' | |
60 # Callbacks use raw pointers, so raw_type=True | |
61 usual_cpp_type = idl_type.cpp_type_args(raw_type=True) | |
62 if usual_cpp_type.startswith(('Vector', 'HeapVector', 'WillBeHeapVector')): | |
63 return 'const %s&' % usual_cpp_type | |
64 return usual_cpp_type | |
65 | |
66 IdlTypeBase.callback_cpp_type = property(cpp_type) | |
67 | |
68 | |
69 def generate_callback_interface(callback_interface): | |
70 includes.clear() | |
71 includes.update(CALLBACK_INTERFACE_CPP_INCLUDES) | |
72 name = callback_interface.name | |
73 | |
74 methods = [generate_method(operation) | |
75 for operation in callback_interface.operations] | |
76 template_contents = { | |
77 'conditional_string': DartUtilities.conditional_string(callback_interfac
e), | |
78 'cpp_class': name, | |
79 'dart_class': dart_types.dart_type(callback_interface.name), | |
80 'v8_class': DartUtilities.v8_class_name(callback_interface), | |
81 'header_includes': set(CALLBACK_INTERFACE_H_INCLUDES), | |
82 'methods': methods, | |
83 } | |
84 return template_contents | |
85 | |
86 | |
87 def add_includes_for_operation(operation): | |
88 operation.idl_type.add_includes_for_type() | |
89 for argument in operation.arguments: | |
90 argument.idl_type.add_includes_for_type() | |
91 | |
92 | |
93 def generate_method(operation): | |
94 extended_attributes = operation.extended_attributes | |
95 idl_type = operation.idl_type | |
96 idl_type_str = str(idl_type) | |
97 if idl_type_str not in ['boolean', 'void']: | |
98 raise Exception('We only support callbacks that return boolean or void v
alues.') | |
99 is_custom = 'Custom' in extended_attributes | |
100 if not is_custom: | |
101 add_includes_for_operation(operation) | |
102 call_with = extended_attributes.get('CallWith') | |
103 call_with_this_handle = DartUtilities.extended_attribute_value_contains(call
_with, 'ThisValue') | |
104 contents = { | |
105 'call_with_this_handle': call_with_this_handle, | |
106 'cpp_type': idl_type.callback_cpp_type, | |
107 'custom': is_custom, | |
108 'idl_type': idl_type_str, | |
109 'name': operation.name, | |
110 } | |
111 contents.update(generate_arguments_contents(operation.arguments, call_with_t
his_handle)) | |
112 return contents | |
113 | |
114 | |
115 def generate_arguments_contents(arguments, call_with_this_handle): | |
116 def generate_argument(argument): | |
117 creation_context = '' | |
118 if argument.idl_type.native_array_element_type is not None: | |
119 creation_context = '<Dart%s>' % argument.idl_type.native_array_eleme
nt_type | |
120 return { | |
121 'handle': '%sHandle' % argument.name, | |
122 'cpp_value_to_dart_value': argument.idl_type.cpp_value_to_dart_value
(argument.name, | |
123
creation_context=creation_context), | |
124 } | |
125 | |
126 argument_declarations = [ | |
127 '%s %s' % (argument.idl_type.callback_cpp_type, argument.name) | |
128 for argument in arguments] | |
129 if call_with_this_handle: | |
130 argument_declarations.insert(0, 'ScriptValue thisValue') | |
131 return { | |
132 'argument_declarations': argument_declarations, | |
133 'arguments': [generate_argument(argument) for argument in arguments], | |
134 } | |
OLD | NEW |