/
generate-bindings.pl
executable file
·331 lines (285 loc) · 12.8 KB
/
generate-bindings.pl
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
#!/usr/bin/perl -w
#
# Copyright (C) 2005 Apple Inc.
# Copyright (C) 2006 Anders Carlsson <andersca@mac.com>
#
# This file is part of WebKit
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Library General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Library General Public License for more details.
#
# You should have received a copy of the GNU Library General Public License
# along with this library; see the file COPYING.LIB. If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
# Boston, MA 02110-1301, USA.
#
# This script is a temporary hack.
# Files are generated in the source directory, when they really should go
# to the DerivedSources directory.
# This should also eventually be a build rule driven off of .idl files
# however a build rule only solution is blocked by several radars:
# <rdar://problems/4251781&4251785>
use strict;
use FindBin;
use lib '.', $FindBin::Bin;
use File::Path;
use File::Basename;
use Getopt::Long;
use Text::ParseWords;
use Cwd;
use IDLParser;
use CodeGenerator;
my @idlDirectories;
my $outputDirectory;
my $outputHeadersDirectory;
my $generator;
my $defines;
my $filename;
my $prefix;
my $preprocessor;
my $writeDependencies;
my $verbose;
my $supplementalDependencyFile;
my $additionalIdlFiles;
my $idlAttributesFile;
GetOptions('include=s@' => \@idlDirectories,
'outputDir=s' => \$outputDirectory,
'outputHeadersDir=s' => \$outputHeadersDirectory,
'generator=s' => \$generator,
'defines=s' => \$defines,
'filename=s' => \$filename,
'prefix=s' => \$prefix,
'preprocessor=s' => \$preprocessor,
'verbose' => \$verbose,
'write-dependencies' => \$writeDependencies,
'supplementalDependencyFile=s' => \$supplementalDependencyFile,
'additionalIdlFiles=s' => \$additionalIdlFiles,
'idlAttributesFile=s' => \$idlAttributesFile);
my $targetIdlFile = $ARGV[0];
die('Must specify input file.') unless defined($targetIdlFile);
die('Must specify generator') unless defined($generator);
die('Must specify output directory.') unless defined($outputDirectory);
if (!$outputHeadersDirectory) {
$outputHeadersDirectory = $outputDirectory;
}
$targetIdlFile = Cwd::realpath($targetIdlFile);
if ($verbose) {
print "$generator: $targetIdlFile\n";
}
my $targetInterfaceName = fileparse(basename($targetIdlFile), ".idl");
my $idlFound = 0;
my @supplementedIdlFiles;
if ($supplementalDependencyFile) {
# The format of a supplemental dependency file:
#
# DOMWindow.idl P.idl Q.idl R.idl
# Document.idl S.idl
# Event.idl
# ...
#
# The above indicates that DOMWindow.idl is supplemented by P.idl, Q.idl and R.idl,
# Document.idl is supplemented by S.idl, and Event.idl is supplemented by no IDLs.
# The IDL that supplements another IDL (e.g. P.idl) never appears in the dependency file.
open FH, "< $supplementalDependencyFile" or die "Cannot open $supplementalDependencyFile\n";
while (my $line = <FH>) {
my ($idlFile, @followingIdlFiles) = split(/\s+/, $line);
if ($idlFile and basename($idlFile) eq basename($targetIdlFile)) {
$idlFound = 1;
@supplementedIdlFiles = sort @followingIdlFiles;
}
}
close FH;
# $additionalIdlFiles is list of IDL files which should not be included in
# DerivedSources*.cpp (i.e. they are not described in the supplemental
# dependency file) but should generate .h and .cpp files.
if (!$idlFound and $additionalIdlFiles) {
my @idlFiles = shellwords($additionalIdlFiles);
$idlFound = grep { $_ and basename($_) eq basename($targetIdlFile) } @idlFiles;
}
if (!$idlFound) {
my $codeGen = CodeGenerator->new(\@idlDirectories, $generator, $outputDirectory, $outputHeadersDirectory, $preprocessor, $writeDependencies, $verbose);
# We generate empty .h and .cpp files just to tell build scripts that .h and .cpp files are created.
generateEmptyHeaderAndCpp($codeGen->FileNamePrefix(), $targetInterfaceName, $outputHeadersDirectory, $outputDirectory);
exit 0;
}
}
# Parse the target IDL file.
my $targetParser = IDLParser->new(!$verbose);
my $targetDocument = $targetParser->Parse($targetIdlFile, $defines, $preprocessor);
if ($idlAttributesFile) {
my $idlAttributes = loadIDLAttributes($idlAttributesFile);
checkIDLAttributes($idlAttributes, $targetDocument, basename($targetIdlFile));
}
foreach my $idlFile (@supplementedIdlFiles) {
next if $idlFile eq $targetIdlFile;
my $interfaceName = fileparse(basename($idlFile), ".idl");
my $parser = IDLParser->new(!$verbose);
my $document = $parser->Parse($idlFile, $defines, $preprocessor);
foreach my $interface (@{$document->interfaces}) {
if (!$interface->isPartial || $interface->name eq $targetInterfaceName) {
my $targetDataNode;
my @targetGlobalContexts;
foreach my $interface (@{$targetDocument->interfaces}) {
if ($interface->name eq $targetInterfaceName) {
$targetDataNode = $interface;
my $exposedAttribute = $targetDataNode->extendedAttributes->{"Exposed"} || "Window";
$exposedAttribute = substr($exposedAttribute, 1, -1) if substr($exposedAttribute, 0, 1) eq "(";
@targetGlobalContexts = split(",", $exposedAttribute);
last;
}
}
die "Not found an interface ${targetInterfaceName} in ${targetInterfaceName}.idl." unless defined $targetDataNode;
# Support for attributes of partial interfaces.
foreach my $attribute (@{$interface->attributes}) {
next unless shouldPropertyBeExposed($attribute->signature, \@targetGlobalContexts);
# Record that this attribute is implemented by $interfaceName.
$attribute->signature->extendedAttributes->{"ImplementedBy"} = $interfaceName if $interface->isPartial;
# Add interface-wide extended attributes to each attribute.
foreach my $extendedAttributeName (keys %{$interface->extendedAttributes}) {
$attribute->signature->extendedAttributes->{$extendedAttributeName} = $interface->extendedAttributes->{$extendedAttributeName};
}
push(@{$targetDataNode->attributes}, $attribute);
}
# Support for methods of partial interfaces.
foreach my $function (@{$interface->functions}) {
next unless shouldPropertyBeExposed($function->signature, \@targetGlobalContexts);
# Record that this method is implemented by $interfaceName.
$function->signature->extendedAttributes->{"ImplementedBy"} = $interfaceName if $interface->isPartial;
# Add interface-wide extended attributes to each method.
foreach my $extendedAttributeName (keys %{$interface->extendedAttributes}) {
$function->signature->extendedAttributes->{$extendedAttributeName} = $interface->extendedAttributes->{$extendedAttributeName};
}
push(@{$targetDataNode->functions}, $function);
}
# Support for constants of partial interfaces.
foreach my $constant (@{$interface->constants}) {
next unless shouldPropertyBeExposed($constant, \@targetGlobalContexts);
# Record that this constant is implemented by $interfaceName.
$constant->extendedAttributes->{"ImplementedBy"} = $interfaceName if $interface->isPartial;
# Add interface-wide extended attributes to each constant.
foreach my $extendedAttributeName (keys %{$interface->extendedAttributes}) {
$constant->extendedAttributes->{$extendedAttributeName} = $interface->extendedAttributes->{$extendedAttributeName};
}
push(@{$targetDataNode->constants}, $constant);
}
} else {
die "$idlFile is not a supplemental dependency of $targetIdlFile. There maybe a bug in the the supplemental dependency generator (preprocess-idls.pl).\n";
}
}
}
# Generate desired output for the target IDL file.
my $codeGen = CodeGenerator->new(\@idlDirectories, $generator, $outputDirectory, $outputHeadersDirectory, $preprocessor, $writeDependencies, $verbose, $targetIdlFile);
$codeGen->ProcessDocument($targetDocument, $defines);
# Attributes / Operations / Constants of supplemental interfaces can have an [Exposed=XX] attribute which restricts
# on which global contexts they should be exposed.
sub shouldPropertyBeExposed
{
my ($signature, $targetGlobalContexts) = @_;
my $exposed = $signature->extendedAttributes->{Exposed};
return 1 unless $exposed;
$exposed = substr($exposed, 1, -1) if substr($exposed, 0, 1) eq "(";
my @sourceGlobalContexts = split(",", $exposed);
for my $targetGlobalContext (@$targetGlobalContexts) {
return 1 if grep(/^$targetGlobalContext$/, @sourceGlobalContexts);
}
return 0;
}
sub generateEmptyHeaderAndCpp
{
my ($prefix, $targetInterfaceName, $outputHeadersDirectory, $outputDirectory) = @_;
my $headerName = "${prefix}${targetInterfaceName}.h";
my $cppName = "${prefix}${targetInterfaceName}.cpp";
my $contents = "/*
This file is generated just to tell build scripts that $headerName and
$cppName are created for ${targetInterfaceName}.idl, and thus
prevent the build scripts from trying to generate $headerName and
$cppName at every build. This file must not be tried to compile.
*/
";
open FH, "> ${outputHeadersDirectory}/${headerName}" or die "Cannot open $headerName\n";
print FH $contents;
close FH;
open FH, "> ${outputDirectory}/${cppName}" or die "Cannot open $cppName\n";
print FH $contents;
close FH;
}
sub loadIDLAttributes
{
my $idlAttributesFile = shift;
my %idlAttributes;
open FH, "<", $idlAttributesFile or die "Couldn't open $idlAttributesFile: $!";
while (my $line = <FH>) {
chomp $line;
next if $line =~ /^\s*#/;
next if $line =~ /^\s*$/;
if ($line =~ /^\s*([^=\s]*)\s*=?\s*(.*)/) {
my $name = $1;
$idlAttributes{$name} = {};
if ($2) {
foreach my $rightValue (split /\|/, $2) {
$rightValue =~ s/^\s*|\s*$//g;
$rightValue = "VALUE_IS_MISSING" unless $rightValue;
$idlAttributes{$name}{$rightValue} = 1;
}
} else {
$idlAttributes{$name}{"VALUE_IS_MISSING"} = 1;
}
} else {
die "The format of " . basename($idlAttributesFile) . " is wrong: line $.\n";
}
}
close FH;
return \%idlAttributes;
}
sub checkIDLAttributes
{
my $idlAttributes = shift;
my $document = shift;
my $idlFile = shift;
foreach my $interface (@{$document->interfaces}) {
checkIfIDLAttributesExists($idlAttributes, $interface->extendedAttributes, $idlFile);
foreach my $attribute (@{$interface->attributes}) {
checkIfIDLAttributesExists($idlAttributes, $attribute->signature->extendedAttributes, $idlFile);
}
foreach my $function (@{$interface->functions}) {
checkIfIDLAttributesExists($idlAttributes, $function->signature->extendedAttributes, $idlFile);
foreach my $parameter (@{$function->parameters}) {
checkIfIDLAttributesExists($idlAttributes, $parameter->extendedAttributes, $idlFile);
}
}
}
}
sub checkIfIDLAttributesExists
{
my $idlAttributes = shift;
my $extendedAttributes = shift;
my $idlFile = shift;
my $error;
OUTER: for my $name (keys %$extendedAttributes) {
if (!exists $idlAttributes->{$name}) {
$error = "Unknown IDL attribute [$name] is found at $idlFile.";
last OUTER;
}
if ($idlAttributes->{$name}{"*"}) {
next;
}
for my $rightValue (split /\s*[|&]\s*/, $extendedAttributes->{$name}) {
if (!exists $idlAttributes->{$name}{$rightValue}) {
$error = "Unknown IDL attribute [$name=" . $extendedAttributes->{$name} . "] is found at $idlFile.";
last OUTER;
}
}
}
if ($error) {
die "IDL ATTRIBUTE CHECKER ERROR: $error
If you want to add a new IDL attribute, you need to add it to WebCore/bindings/scripts/IDLAttributes.txt and add explanations to the WebKit IDL document (https://trac.webkit.org/wiki/WebKitIDL).
";
}
}