Repository navigation
Expand file tree
/
Copy pathgenerate_cpp_backend_dispatcher_header.py
More file actions
executable file
·249 lines (206 loc) · 11.9 KB
/
Copy pathgenerate_cpp_backend_dispatcher_header.py
File metadata and controls
executable file
·249 lines (206 loc) · 11.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
#!/usr/bin/env python3
#
# Copyright (c) 2014-2016 Apple Inc. All rights reserved.
# Copyright (c) 2014 University of Washington. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
# THE POSSIBILITY OF SUCH DAMAGE.
import logging
import re
import string
from string import Template
try:
from .cpp_generator import CppGenerator
from .cpp_generator_templates import CppGeneratorTemplates as CppTemplates
from .generator import Generator, ucfirst
from .models import EnumType
except ImportError:
from cpp_generator import CppGenerator
from cpp_generator_templates import CppGeneratorTemplates as CppTemplates
from generator import Generator, ucfirst
from models import EnumType
log = logging.getLogger('global')
class CppBackendDispatcherHeaderGenerator(CppGenerator):
def __init__(self, *args, **kwargs):
CppGenerator.__init__(self, *args, **kwargs)
def output_filename(self):
return "%sBackendDispatchers.h" % self.protocol_name()
def domains_to_generate(self):
return [domain for domain in Generator.domains_to_generate(self) if len(self.commands_for_domain(domain)) > 0]
def generate_output(self):
header_args = {
'includes': self._generate_secondary_header_includes(),
'typedefs': '',
}
domains = self.domains_to_generate()
sections = []
sections.append(self.generate_license())
sections.append(Template(CppTemplates.HeaderPrelude).substitute(None, **header_args))
if self.model().framework.setting('alternate_dispatchers', False):
sections.append(self._generate_alternate_handler_forward_declarations_for_domains(domains))
sections.extend(list(map(self._generate_handler_declarations_for_domain, domains)))
sections.extend(list(map(self._generate_dispatcher_declarations_for_domain, domains)))
sections.append(Template(CppTemplates.HeaderPostlude).substitute(None, **header_args))
return "\n\n".join(sections)
# Private methods.
def _generate_secondary_header_includes(self):
header_includes = [
(["JavaScriptCore", "WebKit", "WebDriverBidi"], (self.model().framework.name, "%sProtocolObjects.h" % self.protocol_name(), True)),
(["JavaScriptCore", "WebKit", "WebDriverBidi"], ("JavaScriptCore", "inspector/InspectorBackendDispatcher.h", True)),
(["JavaScriptCore", "WebKit", "WebDriverBidi"], ("std", "expected")),
(["JavaScriptCore", "WebKit", "WebDriverBidi"], ("WTF", "wtf/text/MakeString.h")),
(["JavaScriptCore", "WebKit", "WebDriverBidi"], ("WTF", "wtf/text/WTFString.h")),
(["JavaScriptCore", "WebKit", "WebDriverBidi"], ("std", "tuple")),
]
return '\n'.join(self.generate_includes_from_entries(header_includes))
def _generate_alternate_handler_forward_declarations_for_domains(self, domains):
if not domains:
return ''
lines = []
lines.append('#if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)')
for domain in domains:
lines.append(self.wrap_with_guard_for_condition(domain.condition, 'class Alternate%sBackendDispatcher;' % domain.domain_name))
lines.append('#endif // ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)')
return '\n'.join(lines)
def _generate_handler_declarations_for_domain(self, domain):
classComponents = ['class']
exportMacro = self.model().framework.setting('export_macro', None)
if exportMacro is not None:
classComponents.append(exportMacro)
use_legacy_async_callbacks = self.model().framework.setting('legacy_async_callbacks', False)
command_declarations = []
for command in self.commands_for_domain(domain):
if command.is_async and use_legacy_async_callbacks:
command_declarations.append(self._generate_legacy_async_response_thunk_declaration_for_command(command))
command_declarations.append(self._generate_handler_declaration_for_command(command))
handler_args = {
'classAndExportMacro': " ".join(classComponents),
'domainName': domain.domain_name,
'commandDeclarations': "\n".join(command_declarations)
}
return self.wrap_with_guard_for_condition(domain.condition, Template(CppTemplates.BackendDispatcherHeaderDomainHandlerDeclaration).substitute(None, **handler_args))
def _generate_handler_declaration_for_command(self, command):
if command.is_async:
return self._generate_async_handler_declaration_for_command(command)
lines = []
parameters = []
for parameter in command.call_parameters:
parameter_name = parameter.parameter_name
if parameter.is_optional:
parameter_name = 'opt_' + parameter_name
parameters.append("%s %s" % (CppGenerator.cpp_type_for_command_parameter(parameter.type, parameter.is_optional), parameter_name))
returns = []
for parameter in command.return_parameters:
parameter_name = parameter.parameter_name
if parameter.is_optional:
parameter_name = 'opt_' + parameter_name
returns.append('%s /* %s */' % (CppGenerator.cpp_type_for_command_return_declaration(parameter.type, parameter.is_optional), parameter_name))
command_args = {
'commandName': command.command_name,
'parameters': ", ".join(parameters),
'returns': ", ".join(returns),
}
if len(returns) == 1:
lines.append(' virtual Inspector::CommandResult<%(returns)s> %(commandName)s(%(parameters)s) = 0;' % command_args)
elif len(returns):
lines.append(' virtual Inspector::CommandResultOf<%(returns)s> %(commandName)s(%(parameters)s) = 0;' % command_args)
else:
lines.append(' virtual Inspector::CommandResult<void> %(commandName)s(%(parameters)s) = 0;' % command_args)
return self.wrap_with_guard_for_condition(command.condition, '\n'.join(lines))
def _generate_legacy_async_response_thunk_declaration_for_command(self, command):
callbackName = "%sCallback" % ucfirst(command.command_name)
parameters = []
for parameter in command.call_parameters:
parameter_name = parameter.parameter_name
if parameter.is_optional:
parameter_name = 'opt_' + parameter_name
parameters.append("%s %s" % (CppGenerator.cpp_type_for_command_parameter(parameter.type, parameter.is_optional), parameter_name))
parameters.append("Ref<%s>&&" % callbackName)
returns = []
for parameter in command.return_parameters:
parameter_name = parameter.parameter_name
if parameter.is_optional:
parameter_name = 'opt_' + parameter_name
returns.append("%s %s" % (CppGenerator.cpp_type_for_command_return_argument(parameter.type, parameter.is_optional), parameter_name))
class_components = ['class']
export_macro = self.model().framework.setting('export_macro', None)
if export_macro:
class_components.append(export_macro)
command_args = {
'classAndExportMacro': ' '.join(class_components),
'callbackName': callbackName,
'commandName': command.command_name,
'parameters': ", ".join(parameters),
'returns': ", ".join(returns),
}
return self.wrap_with_guard_for_condition(command.condition, Template(CppTemplates.BackendDispatcherHeaderAsyncCommandReplyThunkDeclaration).substitute(None, **command_args))
def _generate_async_handler_declaration_for_command(self, command):
parameters = []
for parameter in command.call_parameters:
parameter_name = parameter.parameter_name
if parameter.is_optional:
parameter_name = 'opt_' + parameter_name
parameters.append("%s %s" % (CppGenerator.cpp_type_for_command_parameter(parameter.type, parameter.is_optional), parameter_name))
returns = []
for parameter in command.return_parameters:
parameter_name = parameter.parameter_name
if parameter.is_optional:
parameter_name = 'opt_' + parameter_name
returns.append(CppGenerator.cpp_type_for_command_return_declaration(parameter.type, parameter.is_optional))
# FIXME: Remove legacy_async_callbacks when IndexedDBAgent moves off of it. <rdar://143782962>
use_legacy_async_callbacks = self.model().framework.setting('legacy_async_callbacks', False)
if use_legacy_async_callbacks:
parameters.append("Ref<%sCallback>&&" % ucfirst(command.command_name))
elif len(returns) > 1:
parameters.append("CommandCallbackOf<%s>&&" % ", ".join(returns))
elif len(returns):
parameters.append("CommandCallback<%s>&&" % returns[0])
else:
parameters.append("CommandCallback<void>&&")
command_args = {
'commandName': command.command_name,
'parameters': ", ".join(parameters),
}
return self.wrap_with_guard_for_condition(command.condition, Template(CppTemplates.BackendDispatcherHeaderAsyncCommandDeclaration).substitute(None, **command_args))
def _generate_dispatcher_declarations_for_domain(self, domain):
classComponents = ['class']
exportMacro = self.model().framework.setting('export_macro', None)
if exportMacro is not None:
classComponents.append(exportMacro)
declarations = []
commands = self.commands_for_domain(domain)
if len(commands) > 0:
declarations.append('private:')
declarations.extend(list(map(self._generate_dispatcher_declaration_for_command, commands)))
declaration_args = {
'domainName': domain.domain_name,
}
# Add in a few more declarations at the end if needed.
if self.model().framework.setting('alternate_dispatchers', False):
declarations.append(Template(CppTemplates.BackendDispatcherHeaderDomainDispatcherAlternatesDeclaration).substitute(None, **declaration_args))
handler_args = {
'classAndExportMacro': " ".join(classComponents),
'domainName': domain.domain_name,
'commandDeclarations': "\n".join(declarations)
}
return self.wrap_with_guard_for_condition(domain.condition, Template(CppTemplates.BackendDispatcherHeaderDomainDispatcherDeclaration).substitute(None, **handler_args))
def _generate_dispatcher_declaration_for_command(self, command):
return self.wrap_with_guard_for_condition(command.condition, " void %s(long protocol_requestId, RefPtr<JSON::Object>&& protocol_parameters);" % command.command_name)