DOMMatrix and DOMMatrixReadOnly should be available in workers
[WebKit-https.git] / Source / WebCore / bindings / scripts / CodeGeneratorJS.pm
1 #
2 # Copyright (C) 2005, 2006, 2007, 2008 Nikolas Zimmermann <zimmermann@kde.org>
3 # Copyright (C) 2006 Anders Carlsson <andersca@mac.com>
4 # Copyright (C) 2006, 2007 Samuel Weinig <sam@webkit.org>
5 # Copyright (C) 2006 Alexey Proskuryakov <ap@webkit.org>
6 # Copyright (C) 2006-2017 Apple Inc. All rights reserved.
7 # Copyright (C) 2009 Cameron McCormack <cam@mcc.id.au>
8 # Copyright (C) Research In Motion Limited 2010. All rights reserved.
9 # Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
10 # Copyright (C) 2011 Patrick Gansterer <paroga@webkit.org>
11 # Copyright (C) 2012 Ericsson AB. All rights reserved.
12 # Copyright (C) 2007, 2008, 2009, 2012 Google Inc.
13 # Copyright (C) 2013 Samsung Electronics. All rights reserved.
14 # Copyright (C) 2015, 2016 Canon Inc. All rights reserved.
15 #
16 # This library is free software; you can redistribute it and/or
17 # modify it under the terms of the GNU Library General Public
18 # License as published by the Free Software Foundation; either
19 # version 2 of the License, or (at your option) any later version.
20 #
21 # This library is distributed in the hope that it will be useful,
22 # but WITHOUT ANY WARRANTY; without even the implied warranty of
23 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24 # Library General Public License for more details.
25 #
26 # You should have received a copy of the GNU Library General Public License
27 # along with this library; see the file COPYING.LIB.  If not, write to
28 # the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
29 # Boston, MA 02110-1301, USA.
30
31
32 package CodeGeneratorJS;
33
34 use strict;
35 use constant FileNamePrefix => "JS";
36 use Carp qw<longmess>;
37 use Data::Dumper;
38 use Hasher;
39
40 my $codeGenerator;
41 my $writeDependencies;
42
43 my @headerContentHeader = ();
44 my @headerContent = ();
45 my %headerIncludes = ();
46 my %headerTrailingIncludes = ();
47
48 my @implContentHeader = ();
49 my @implContent = ();
50 my %implIncludes = ();
51 my @depsContent = ();
52 my $numCachedAttributes = 0;
53
54 my $beginAppleCopyrightForHeaderFiles = <<END;
55 // ------- Begin Apple Copyright -------
56 /*
57  * Copyright (C) 2008 Apple Inc. All rights reserved.
58  *
59  * Permission is granted by Apple to use this file to the extent
60  * necessary to relink with LGPL WebKit files.
61  *
62  * No license or rights are granted by Apple expressly or by
63  * implication, estoppel, or otherwise, to Apple patents and
64  * trademarks. For the sake of clarity, no license or rights are
65  * granted by Apple expressly or by implication, estoppel, or otherwise,
66  * under any Apple patents, copyrights and trademarks to underlying
67  * implementations of any application programming interfaces (APIs)
68  * or to any functionality that is invoked by calling any API.
69  */
70
71 END
72 my $beginAppleCopyrightForSourceFiles = <<END;
73 // ------- Begin Apple Copyright -------
74 /*
75  * Copyright (C) 2008 Apple Inc. All rights reserved.
76  *
77  * No license or rights are granted by Apple expressly or by implication,
78  * estoppel, or otherwise, to Apple copyrights, patents, trademarks, trade
79  * secrets or other rights.
80  */
81
82 END
83 my $endAppleCopyright   = <<END;
84 // ------- End Apple Copyright   -------
85
86 END
87
88 # Default .h template
89 my $headerTemplate = << "EOF";
90 /*
91     This file is part of the WebKit open source project.
92     This file has been generated by generate-bindings.pl. DO NOT MODIFY!
93
94     This library is free software; you can redistribute it and/or
95     modify it under the terms of the GNU Library General Public
96     License as published by the Free Software Foundation; either
97     version 2 of the License, or (at your option) any later version.
98
99     This library is distributed in the hope that it will be useful,
100     but WITHOUT ANY WARRANTY; without even the implied warranty of
101     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
102     Library General Public License for more details.
103
104     You should have received a copy of the GNU Library General Public License
105     along with this library; see the file COPYING.LIB.  If not, write to
106     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
107     Boston, MA 02110-1301, USA.
108 */
109 EOF
110
111 sub assert
112 {
113     my $message = shift;
114
115     my $mess = longmess();
116     print Dumper($mess);
117
118     die $message;
119 }
120
121 # Default constructor
122 sub new
123 {
124     my $object = shift;
125     my $reference = { };
126
127     $codeGenerator = shift;
128     $writeDependencies = shift;
129
130     bless($reference, $object);
131     return $reference;
132 }
133
134 sub GenerateEnumeration
135 {
136     my ($object, $enumeration) = @_;
137
138     my $className = GetEnumerationClassName($enumeration->type);
139     $object->GenerateEnumerationHeader($enumeration, $className);
140     $object->GenerateEnumerationImplementation($enumeration, $className);
141 }
142
143 sub GenerateDictionary
144 {
145     my ($object, $dictionary, $enumerations, $otherDictionaries) = @_;
146
147     my $className = GetDictionaryClassName($dictionary->type);
148     $object->GenerateDictionaryHeader($dictionary, $className, $enumerations, $otherDictionaries);
149     $object->GenerateDictionaryImplementation($dictionary, $className, $enumerations, $otherDictionaries);
150 }
151
152 sub GenerateCallbackFunction
153 {
154     my ($object, $callbackFunction, $enumerations, $dictionaries) = @_;
155
156     $object->GenerateCallbackFunctionHeader($callbackFunction, $enumerations, $dictionaries);
157     $object->GenerateCallbackFunctionImplementation($callbackFunction, $enumerations, $dictionaries);
158 }
159
160 sub GenerateInterface
161 {
162     my ($object, $interface, $defines, $enumerations, $dictionaries) = @_;
163
164     $codeGenerator->LinkOverloadedOperations($interface);
165
166     AddStringifierOperationIfNeeded($interface);
167     AddLegacyCallerOperationIfNeeded($interface);
168
169     if ($interface->isCallback) {
170         $object->GenerateCallbackInterfaceHeader($interface, $enumerations, $dictionaries);
171         $object->GenerateCallbackInterfaceImplementation($interface, $enumerations, $dictionaries);
172     } else {
173         $object->GenerateHeader($interface, $enumerations, $dictionaries);
174         $object->GenerateImplementation($interface, $enumerations, $dictionaries);
175     }
176 }
177
178 sub AddStringifierOperationIfNeeded
179 {
180     my $interface = shift;
181
182     foreach my $property (@{$interface->attributes}, @{$interface->operations}, @{$interface->anonymousOperations}) {
183         next unless $property->isStringifier;
184
185         if (ref($property) eq "IDLAttribute") {
186             assert("stringifier can only be used on attributes with type DOMString or USVString") unless $property->type->name eq "DOMString" || $property->type->name eq "USVString";
187         }
188
189         if (ref($property) eq "IDLOperation") {
190             assert("stringifier can only be used on operations with a return type of DOMString") unless $property->type->name eq "DOMString";
191             assert("stringifier can only be used on operations with zero arguments") unless scalar(@{$property->arguments}) == 0;
192
193             # Don't duplicate the operation if it was declared with the name 'toString'.
194             return if $property->name eq "toString";
195         }
196
197         my $stringifier = IDLOperation->new();
198         $stringifier->name("toString");
199         $stringifier->type(IDLParser::cloneType($property->type));
200         $stringifier->isStringifier(1);
201
202         IDLParser::copyExtendedAttributes($stringifier->extendedAttributes, $property->extendedAttributes);
203
204         if ($property->name && !$stringifier->extendedAttributes->{ImplementedAs}) {
205             $stringifier->extendedAttributes->{ImplementedAs} = $property->name;
206         }
207
208         # If the stringifier was declared as read-write attribute and had [CEReactions], we need to remove
209         # it from the operation, as the operation should act like attribute getter, which doesn't respect
210         # [CEReactions].
211         if (ref($property) eq "IDLAttribute" && !$property->isReadOnly && $stringifier->extendedAttributes->{CEReactions}) {
212              delete $stringifier->extendedAttributes->{CEReactions};
213         }
214
215         push(@{$interface->operations}, $stringifier);
216         return;
217     }
218 }
219
220 sub AddLegacyCallerOperationIfNeeded
221 {
222     my $interface = shift;
223
224     foreach my $operation (@{$interface->operations}, @{$interface->anonymousOperations}) {
225         my $isLegacyCaller = grep { $_ eq "legacycaller" } @{$operation->specials};
226         if ($isLegacyCaller) {
227             $interface->{LegacyCallers} = [] if !exists $interface->{LegacyCallers};
228
229             my $clonedOperation = IDLParser::cloneOperation($operation);
230             push(@{$interface->{LegacyCallers}}, $clonedOperation);
231     
232             $clonedOperation->{overloads} = $interface->{LegacyCallers};
233             $clonedOperation->{overloadIndex} = @{$interface->{LegacyCallers}};
234         }
235     }
236 }
237
238 sub EventHandlerAttributeEventName
239 {
240     my $attribute = shift;
241     my $eventType = $attribute->extendedAttributes->{ImplementedAs} || $attribute->name;
242
243     # Remove the "on" prefix.
244     $eventType = substr($eventType, 2);
245
246     return "eventNames().${eventType}Event";
247 }
248
249 sub GetParentClassName
250 {
251     my $interface = shift;
252
253     return $interface->extendedAttributes->{JSLegacyParent} if $interface->extendedAttributes->{JSLegacyParent};
254     return "JSDOMObject" unless NeedsImplementationClass($interface);
255     return "JSDOMWrapper<" . GetImplClassName($interface) . ">" unless $interface->parentType;
256     return "JS" . $interface->parentType->name;
257 }
258
259 sub GetCallbackClassName
260 {
261     my $className = shift;
262
263     return "JS$className";
264 }
265
266 sub GetExportMacroForJSClass
267 {
268     my $interface = shift;
269
270     return $interface->extendedAttributes->{ExportMacro} . " " if $interface->extendedAttributes->{ExportMacro};
271     return "";
272 }
273
274 sub AddIncludesForImplementationTypeInImpl
275 {
276     my $implementationType = shift;
277     
278     AddIncludesForImplementationType($implementationType, \%implIncludes);
279 }
280
281 sub AddIncludesForImplementationTypeInHeader
282 {
283     my $implementationType = shift;
284     
285     AddIncludesForImplementationType($implementationType, \%headerIncludes);
286 }
287
288 sub AddIncludesForImplementationType
289 {
290     my ($implementationType, $includesRef) = @_;
291
292     $includesRef->{"${implementationType}.h"} = 1;
293 }
294
295 sub AddToImplIncludesForIDLType
296 {
297     my ($type, $conditional) = @_;
298
299     return AddToIncludesForIDLType($type, \%implIncludes, $conditional)
300 }
301
302 sub AddToIncludesForIDLType
303 {
304     my ($type, $includesRef, $conditional) = @_;
305
306     if ($type->isNullable) {
307         AddToIncludes("JSDOMConvertNullable.h", $includesRef, $conditional);
308     }
309
310     if ($type->extendedAttributes->{OverrideIDLType}) {
311         my $overrideTypeName = $type->extendedAttributes->{OverrideIDLType};
312         if ($overrideTypeName eq "IDLIDBKey") {
313             AddToIncludes("JSDOMConvertIndexedDB.h", $includesRef, $conditional);
314             return;
315         }
316
317         if ($overrideTypeName eq "IDLWebGLAny" || $overrideTypeName eq "IDLWebGLExtension") {
318             AddToIncludes("JSDOMConvertWebGL.h", $includesRef, $conditional);
319             return;
320         }
321     }
322
323     if ($type->name eq "any") {
324         AddToIncludes("JSDOMConvertAny.h", $includesRef, $conditional);
325         return;
326     }
327
328     if ($type->name eq "boolean") {
329         AddToIncludes("JSDOMConvertBoolean.h", $includesRef, $conditional);
330         return;
331     }
332
333     if ($codeGenerator->IsBufferSourceType($type)) {
334         AddToIncludes("JSDOMConvertBufferSource.h", $includesRef, $conditional);
335         return;
336     }
337
338     if ($codeGenerator->IsCallbackFunction($type) || $codeGenerator->IsCallbackInterface($type)) {
339         AddToIncludes("JS" . $type->name . ".h", $includesRef, $conditional);
340         AddToIncludes("JSDOMConvertCallbacks.h", $includesRef, $conditional);
341         return;
342     }
343
344     if ($type->name eq "Date") {
345         AddToIncludes("JSDOMConvertDate.h", $includesRef, $conditional);
346         return;
347     }
348
349     if ($codeGenerator->IsExternalDictionaryType($type)) {
350         AddToIncludes("JS" . $type->name . ".h", $includesRef, $conditional);
351         AddToIncludes("JSDOMConvertDictionary.h", $includesRef, $conditional);
352         return;
353     }
354
355     if ($codeGenerator->IsExternalEnumType($type)) {
356         AddToIncludes("JS" . $type->name . ".h", $includesRef, $conditional);
357         AddToIncludes("JSDOMConvertEnumeration.h", $includesRef, $conditional);
358         return;
359     }
360
361     if ($type->name eq "EventListener") {
362         AddToIncludes("JSEventListener.h", $includesRef, $conditional);
363         AddToIncludes("JSDOMConvertEventListener.h", $includesRef, $conditional);
364         return;
365     }
366
367     if ($codeGenerator->IsInterfaceType($type)) {
368         AddToIncludes("JS" . $type->name . ".h", $includesRef, $conditional);
369         AddToIncludes("JSDOMConvertInterface.h", $includesRef, $conditional);
370         return;
371     }
372
373     if ($type->name eq "JSON") {
374         AddToIncludes("JSDOMConvertJSON.h", $includesRef, $conditional);
375         return;
376     }
377
378     if ($codeGenerator->IsNumericType($type)) {
379         AddToIncludes("JSDOMConvertNumbers.h", $includesRef, $conditional);
380         return;
381     }
382
383     if ($type->name eq "object") {
384         AddToIncludes("JSDOMConvertObject.h", $includesRef, $conditional);
385         return;
386     }
387
388     if ($codeGenerator->IsPromiseType($type)) {
389         AddToIncludes("DOMPromiseProxy.h", $includesRef, $conditional);
390         AddToIncludes("JSDOMConvertPromise.h", $includesRef, $conditional);
391
392         AddToIncludesForIDLType(@{$type->subtypes}[0], $includesRef, $conditional);
393         return;
394     }
395
396     if ($codeGenerator->IsRecordType($type)) {
397         AddToIncludes("<wtf/Vector.h>", $includesRef, $conditional);
398         AddToIncludes("JSDOMConvertRecord.h", $includesRef, $conditional);
399
400         AddToIncludesForIDLType(@{$type->subtypes}[0], $includesRef, $conditional);
401         AddToIncludesForIDLType(@{$type->subtypes}[1], $includesRef, $conditional);
402         return;
403     }
404
405     if ($codeGenerator->IsSequenceOrFrozenArrayType($type)) {
406         AddToIncludes("<runtime/JSArray.h>", $includesRef, $conditional);
407         AddToIncludes("JSDOMConvertSequences.h", $includesRef, $conditional);
408
409         AddToIncludesForIDLType(@{$type->subtypes}[0], $includesRef, $conditional);
410         return;
411     }
412
413     if ($type->name eq "ScheduledAction") {
414         AddToIncludes("JSDOMConvertScheduledAction.h", $includesRef, $conditional);
415         return;
416     }
417
418     if ($type->name eq "SerializedScriptValue") {
419         AddToIncludes("SerializedScriptValue.h", $includesRef, $conditional);
420         AddToIncludes("JSDOMConvertSerializedScriptValue.h", $includesRef, $conditional);
421         return;
422     }
423
424     if ($codeGenerator->IsStringType($type)) {
425         AddToIncludes("JSDOMConvertStrings.h", $includesRef, $conditional);
426         return;
427     }
428
429     if ($type->isUnion) {
430         AddToIncludes("<wtf/Variant.h>", $includesRef, $conditional);
431         AddToIncludes("JSDOMConvertUnion.h", $includesRef, $conditional);
432
433         foreach my $memberType (@{$type->subtypes}) {
434             AddToIncludesForIDLType($memberType, $includesRef, $conditional);
435         }
436
437         return;
438     }
439
440     if ($type->name eq "XPathNSResolver") {
441         AddToIncludes("JSXPathNSResolver.h", $includesRef, $conditional);
442         AddToIncludes("JSDOMConvertXPathNSResolver.h", $includesRef, $conditional);
443         return;
444     }
445 }
446
447 sub AddToImplIncludes
448 {
449     my ($header, $conditional) = @_;
450
451     AddToIncludes($header, \%implIncludes, $conditional);
452 }
453
454 sub AddToIncludes
455 {
456     my ($header, $includesRef, $conditional) = @_;
457
458     if (not $conditional) {
459         $includesRef->{$header} = 1;
460     } elsif (not exists($includesRef->{$header})) {
461         $includesRef->{$header} = $conditional;
462     } else {
463         my $oldValue = $includesRef->{$header};
464         $includesRef->{$header} = "$oldValue|$conditional" if $oldValue ne 1;
465     }
466 }
467
468 sub IsReadonly
469 {
470     my $attribute = shift;
471     return $attribute->isReadOnly && !$attribute->extendedAttributes->{Replaceable} && !$attribute->extendedAttributes->{PutForwards};
472 }
473
474 sub AddClassForwardIfNeeded
475 {
476     my $type = shift;
477
478     # SVGAnimatedLength/Number/etc. are not classes so they can't be forward declared as classes.
479     return if $codeGenerator->IsSVGAnimatedType($type);
480     return if $codeGenerator->IsBufferSourceType($type);
481
482     push(@headerContent, "class " . $type->name . ";\n\n");
483 }
484
485 sub GetGenerateIsReachable
486 {
487     my $interface = shift;
488     return $interface->extendedAttributes->{GenerateIsReachable};
489 }
490
491 sub GetCustomIsReachable
492 {
493     my $interface = shift;
494     return $interface->extendedAttributes->{CustomIsReachable};
495 }
496
497 sub IsDOMGlobalObject
498 {
499     my $interface = shift;
500     return $interface->type->name eq "DOMWindow" || $codeGenerator->InheritsInterface($interface, "WorkerGlobalScope") || $interface->type->name eq "TestGlobalObject";
501 }
502
503 sub ShouldUseGlobalObjectPrototype
504 {
505     my $interface = shift;
506
507     # For workers, the global object is a DedicatedWorkerGlobalScope.
508     return 0 if $interface->type->name eq "WorkerGlobalScope";
509
510     return IsDOMGlobalObject($interface);
511 }
512
513 sub GenerateIndexedGetter
514 {
515     my ($interface, $indexedGetterOperation, $indexExpression) = @_;
516     
517     # NOTE: This abstractly implements steps 1.2.1 - 1.2.8 of the LegacyPlatformObjectGetOwnProperty
518     #       algorithm. Returing the conversion expression and attributes expression for use
519     #       by the caller.
520     
521     # 1.2.1 Let operation be the operation used to declare the indexed property getter.
522     # 1.2.2 Let value be an uninitialized variable.
523     # 1.2.3 If operation was defined without an identifier, then set value to the result
524     #       of performing the steps listed in the interface description to determine the
525     #       value of an indexed property with index as the index.
526     # 1.2.4 Otherwise, operation was defined with an identifier. Set value to the result
527     #       of performing the steps listed in the description of operation with index as
528     #       the only argument value.
529     # 1.2.5 Let desc be a newly created Property Descriptor with no fields.
530     # 1.2.6 Set desc.[[Value]] to the result of converting value to an ECMAScript value.
531     # 1.2.7 If O implements an interface with an indexed property setter, then set
532     #       desc.[[Writable]] to true, otherwise set it to false.
533     # 1.2.8 Return desc.
534     
535     my @attributes = ();
536     push(@attributes, "ReadOnly") if !GetIndexedSetterOperation($interface) && !$interface->extendedAttributes->{Plugin};
537     
538     my $attributeString = ((@attributes > 0) ? join(" | ", @attributes) : "0");
539
540     my $indexedGetterFunctionName = $indexedGetterOperation->extendedAttributes->{ImplementedAs} || $indexedGetterOperation->name || "item";
541     my $nativeToJSConversion = NativeToJSValueUsingPointers($indexedGetterOperation, $interface, "thisObject->wrapped().${indexedGetterFunctionName}(${indexExpression})", "*thisObject->globalObject()");
542     
543     return ($nativeToJSConversion, $attributeString);
544 }
545
546 sub GenerateNamedGetter
547 {
548     my ($interface, $namedGetterOperation, $namedPropertyExpression) = @_;
549     
550     # NOTE: This abstractly implements steps 2.1 - 2.10 of the LegacyPlatformObjectGetOwnProperty
551     #       algorithm. Returing the conversion expression and attributes expression for use
552     #       by the caller.
553     
554     # 2.1  Let operation be the operation used to declare the named property getter.
555     # 2.2  Let value be an uninitialized variable.
556     # 2.3  If operation was defined without an identifier, then set value to the result
557     #      of performing the steps listed in the interface description to determine the
558     #      value of a named property with P as the name.
559     # 2.4  Otherwise, operation was defined with an identifier. Set value to the result
560     #      of performing the steps listed in the description of operation with P as the
561     #      only argument value..
562     # 2.5  Let desc be a newly created Property Descriptor with no fields.
563     # 2.6  Set desc.[[Value]] to the result of converting value to an ECMAScript value.
564     # 2.7  If O implements an interface with a named property setter, then set desc.[[Writable]]
565     #      to true, otherwise set it to false.
566     # 2.8  If O implements an interface with the [LegacyUnenumerableNamedProperties]
567     #      extended attribute, then set desc.[[Enumerable]] to false, otherwise set it
568     #      to true.
569     # 2.9  Set desc.[[Configurable]] to true.
570     # 2.10 Return desc.
571     
572     my @attributes = ();
573     push(@attributes, "ReadOnly") if !GetNamedSetterOperation($interface) && !$interface->extendedAttributes->{Plugin};
574     push(@attributes, "DontEnum") if $interface->extendedAttributes->{LegacyUnenumerableNamedProperties};
575     
576     my $attributeString = ((@attributes > 0) ? join(" | ", @attributes) : "0");
577     my $nativeToJSConversion = NativeToJSValueUsingPointers($namedGetterOperation, $interface, $namedPropertyExpression, "*thisObject->globalObject()");
578     
579     return ($nativeToJSConversion, $attributeString);
580 }
581
582 sub GenerateNamedGetterLambda
583 {
584     my ($outputArray, $interface, $namedGetterOperation, $namedGetterFunctionName, $IDLType) = @_;
585     
586     # NOTE: Named getters are little odd. To avoid doing duplicate lookups (once when checking if
587     #       the property name is a 'supported property name' and once to get the value) we signal
588     #       that a property is supported by whether or not it is 'null' (where what null means is
589     #       dependant on the IDL type). This is based on the assumption that no named getter will
590     #       ever actually want to return null as an actual return value, which seems like an ok
591     #       assumption to make (should it turn out this doesn't hold in the future, we have lots
592     #       of options; do two lookups, add an extra layer of std::optional, etc.).
593     
594     my $resultType = "typename ${IDLType}::ImplementationType";
595     $resultType = "ExceptionOr<" . $resultType . ">" if $namedGetterOperation->extendedAttributes->{MayThrowException};
596     my $returnType = "std::optional<" . $resultType . ">";
597
598     push(@$outputArray, "    auto getterFunctor = [] (auto& thisObject, auto propertyName) -> ${returnType} {\n");
599
600     my @arguments = GenerateCallWithUsingReferences($namedGetterOperation->extendedAttributes->{CallWith}, $outputArray, "std::nullopt", "thisObject", "        ");
601     push(@arguments, "propertyNameToAtomicString(propertyName)");
602
603     push(@$outputArray, "        auto result = thisObject.wrapped().${namedGetterFunctionName}(" . join(", ", @arguments) . ");\n");
604     
605     if ($namedGetterOperation->extendedAttributes->{MayThrowException}) {
606         push(@$outputArray, "        if (result.hasException())\n");
607         push(@$outputArray, "            return ${resultType} { result.releaseException() };\n");
608         push(@$outputArray, "        if (!${IDLType}::isNullValue(result.returnValue()))\n");
609         push(@$outputArray, "            return ${resultType} { ${IDLType}::extractValueFromNullable(result.releaseReturnValue()) };\n");
610         push(@$outputArray, "        return std::nullopt;\n");
611     } else {
612         push(@$outputArray, "        if (!${IDLType}::isNullValue(result))\n");
613         push(@$outputArray, "            return ${resultType} { ${IDLType}::extractValueFromNullable(result) };\n");
614         push(@$outputArray, "        return std::nullopt;\n");
615     }
616     push(@$outputArray, "    };\n");
617 }
618
619 # https://heycam.github.io/webidl/#legacy-platform-object-getownproperty
620 sub GenerateGetOwnPropertySlot
621 {
622     my ($outputArray, $interface, $className) = @_;
623     
624     return if $interface->extendedAttributes->{CustomGetOwnPropertySlot};
625     
626     push(@$outputArray, "bool ${className}::getOwnPropertySlot(JSObject* object, ExecState* state, PropertyName propertyName, PropertySlot& slot)\n");
627     push(@$outputArray, "{\n");
628     push(@$outputArray, "    auto* thisObject = jsCast<${className}*>(object);\n");
629     push(@$outputArray, "    ASSERT_GC_OBJECT_INHERITS(thisObject, info());\n");
630     
631     my $namedGetterOperation = GetNamedGetterOperation($interface);
632     my $indexedGetterOperation = GetIndexedGetterOperation($interface);
633     
634     if (($namedGetterOperation && $namedGetterOperation->extendedAttributes->{MayThrowException}) || ($indexedGetterOperation && $indexedGetterOperation->extendedAttributes->{MayThrowException})) {
635         push(@$outputArray, "    auto throwScope = DECLARE_THROW_SCOPE(state->vm());\n");
636     }
637     
638     # NOTE: The alogithm for [[GetOwnProperty]] contains only the following step:
639     # 1. Return LegacyPlatformObjectGetOwnProperty(O, P, false).
640     
641     # Therefore, the following steps are from the LegacyPlatformObjectGetOwnProperty algorithm
642     # https://heycam.github.io/webidl/#LegacyPlatformObjectGetOwnProperty
643     
644     # 1. If O supports indexed properties and P is an array index property name, then:
645     if ($indexedGetterOperation) {
646         # 1.1. Let index be the result of calling ToUint32(P).
647         push(@$outputArray, "    if (auto index = parseIndex(propertyName)) {\n");
648         
649         # 1.2. If index is a supported property index, then:
650         # FIXME: This should support non-contiguous indices.
651         push(@$outputArray, "        if (index.value() < thisObject->wrapped().length()) {\n");
652         
653         # NOTE: GenerateIndexedGetter implements steps 1.2.1 - 1.2.8.
654         
655         my ($nativeToJSConversion, $attributeString) = GenerateIndexedGetter($interface, $indexedGetterOperation, "index.value()");
656         
657         push(@$outputArray, "            auto value = ${nativeToJSConversion};\n");
658         push(@$outputArray, "            RETURN_IF_EXCEPTION(throwScope, false);\n") if $indexedGetterOperation->extendedAttributes->{MayThrowException};
659         
660         push(@$outputArray, "            slot.setValue(thisObject, ${attributeString}, value);\n");
661         push(@$outputArray, "            return true;\n");
662         
663         push(@$outputArray, "        }\n");
664         
665         # 1.3. Set ignoreNamedProps to true.
666         # NOTE: Setting ignoreNamedProps has the effect of skipping step 2, so we can early return here
667         #       rather than going through the paces of having an actual ignoreNamedProps update.
668         if ($namedGetterOperation || $interface->extendedAttributes->{Plugin}) {
669             push(@$outputArray, "        return JSObject::getOwnPropertySlot(object, state, propertyName, slot);\n");
670         }
671         push(@$outputArray, "    }\n");
672     }
673     
674     # 2. If O supports named properties, the result of running the named property visibility
675     #    algorithm with property name P and object O is true, and ignoreNamedProps is false, then:
676     if ($namedGetterOperation) {
677         # NOTE: ignoreNamedProps is guarenteed to be false here, as it is initially false, and never set
678         #       to true, due to the early return in step 1.3
679         AddToImplIncludes("JSDOMAbstractOperations.h");
680                 
681         my $namedGetterFunctionName = $namedGetterOperation->extendedAttributes->{ImplementedAs} || $namedGetterOperation->name || "namedItem";
682         my $IDLType = GetIDLTypeExcludingNullability($interface, $namedGetterOperation->type);
683         
684         push(@$outputArray, "    using GetterIDLType = ${IDLType};\n");
685         
686         GenerateNamedGetterLambda($outputArray, $interface, $namedGetterOperation, $namedGetterFunctionName, "GetterIDLType");
687         
688         my $overrideBuiltin = $codeGenerator->InheritsExtendedAttribute($interface, "OverrideBuiltins") ? "OverrideBuiltins::Yes" : "OverrideBuiltins::No";
689         push(@$outputArray, "    if (auto namedProperty = accessVisibleNamedProperty<${overrideBuiltin}>(*state, *thisObject, propertyName, getterFunctor)) {\n");
690         
691         # NOTE: GenerateNamedGetter implements steps 2.1 - 2.10.
692         
693         my ($nativeToJSConversion, $attributeString) = GenerateNamedGetter($interface, $namedGetterOperation, "WTFMove(namedProperty.value())");
694         
695         push(@$outputArray, "        auto value = ${nativeToJSConversion};\n");
696         push(@$outputArray, "        RETURN_IF_EXCEPTION(throwScope, false);\n") if $namedGetterOperation->extendedAttributes->{MayThrowException};
697         
698         push(@$outputArray, "        slot.setValue(thisObject, ${attributeString}, value);\n");
699         push(@$outputArray, "        return true;\n");
700         push(@$outputArray, "    }\n");
701     }
702
703     if ($interface->extendedAttributes->{Plugin}) {
704         AddToImplIncludes("JSPluginElementFunctions.h");
705         push(@$outputArray, "    if (pluginElementCustomGetOwnPropertySlot(thisObject, state, propertyName, slot))\n");
706         push(@$outputArray, "        return true;\n");
707     }
708
709     # 3. Return OrdinaryGetOwnProperty(O, P).
710     push(@$outputArray, "    return JSObject::getOwnPropertySlot(object, state, propertyName, slot);\n");
711     
712     push(@$outputArray, "}\n\n");
713 }
714
715 # https://heycam.github.io/webidl/#legacy-platform-object-getownproperty
716 sub GenerateGetOwnPropertySlotByIndex
717 {
718     my ($outputArray, $interface, $className) = @_;
719     
720     return if $interface->extendedAttributes->{CustomGetOwnPropertySlot};
721
722     # Sink the int-to-string conversion that happens when we create a PropertyName
723     # to the point where we actually need it.
724     my $didGeneratePropertyName = 0;
725     my $propertyNameGeneration = sub {
726         return if $didGeneratePropertyName;
727         
728         push(@$outputArray, "    auto propertyName = Identifier::from(state, index);\n");
729         $didGeneratePropertyName = 1;
730     };
731     
732     push(@$outputArray, "bool ${className}::getOwnPropertySlotByIndex(JSObject* object, ExecState* state, unsigned index, PropertySlot& slot)\n");
733     push(@$outputArray, "{\n");
734     push(@$outputArray, "    auto* thisObject = jsCast<${className}*>(object);\n");
735     push(@$outputArray, "    ASSERT_GC_OBJECT_INHERITS(thisObject, info());\n");
736     
737     my $namedGetterOperation = GetNamedGetterOperation($interface);
738     my $indexedGetterOperation = GetIndexedGetterOperation($interface);
739     
740     if (($namedGetterOperation && $namedGetterOperation->extendedAttributes->{MayThrowException}) || ($indexedGetterOperation && $indexedGetterOperation->extendedAttributes->{MayThrowException})) {
741         push(@$outputArray, "    auto throwScope = DECLARE_THROW_SCOPE(state->vm());\n");
742     }
743     
744     # NOTE: The alogithm for [[GetOwnProperty]] contains only the following step:
745     # 1. Return LegacyPlatformObjectGetOwnProperty(O, P, false).
746     
747     # Therefore, the following steps are from the LegacyPlatformObjectGetOwnProperty algorithm
748     # https://heycam.github.io/webidl/#LegacyPlatformObjectGetOwnProperty
749     
750     # 1. If O supports indexed properties and P is an array index property name, then:
751     if ($indexedGetterOperation) {
752         # 1.1. Let index be the result of calling ToUint32(P).
753         push(@$outputArray, "    if (LIKELY(index <= MAX_ARRAY_INDEX)) {\n");
754         
755         # 1.2. If index is a supported property index, then:
756         # FIXME: This should support non-contiguous indices.
757         push(@$outputArray, "        if (index < thisObject->wrapped().length()) {\n");
758         
759         # NOTE: GenerateIndexedGetter implements steps 1.2.1 - 1.2.8.
760         
761         my ($nativeToJSConversion, $attributeString) = GenerateIndexedGetter($interface, $indexedGetterOperation, "index");
762         
763         push(@$outputArray, "            auto value = ${nativeToJSConversion};\n");
764         push(@$outputArray, "            RETURN_IF_EXCEPTION(throwScope, false);\n") if $indexedGetterOperation->extendedAttributes->{MayThrowException};
765         
766         push(@$outputArray, "            slot.setValue(thisObject, ${attributeString}, value);\n");
767         push(@$outputArray, "            return true;\n");
768         
769         push(@$outputArray, "        }\n");
770         
771         # 1.3. Set ignoreNamedProps to true.
772         # NOTE: Setting ignoreNamedProps has the effect of skipping step 2, so we can early return here
773         #       rather than going through the paces of having an actual ignoreNamedProps update.
774         if ($namedGetterOperation || $interface->extendedAttributes->{Plugin}) {
775             push(@$outputArray, "        return JSObject::getOwnPropertySlotByIndex(object, state, index, slot);\n");
776         }
777         push(@$outputArray, "    }\n");
778     }
779     
780     # 2. If O supports named properties, the result of running the named property visibility
781     #    algorithm with property name P and object O is true, and ignoreNamedProps is false, then:
782     if ($namedGetterOperation) {
783         # NOTE: ignoreNamedProps is guarenteed to be false here, as it is initially false, and never set
784         #       to true, due to the early return in step 1.3
785         AddToImplIncludes("JSDOMAbstractOperations.h");
786                 
787         &$propertyNameGeneration();
788         
789         my $namedGetterFunctionName = $namedGetterOperation->extendedAttributes->{ImplementedAs} || $namedGetterOperation->name || "namedItem";
790         my $IDLType = GetIDLTypeExcludingNullability($interface, $namedGetterOperation->type);
791         
792         push(@$outputArray, "    using GetterIDLType = ${IDLType};\n");
793         
794         GenerateNamedGetterLambda($outputArray, $interface, $namedGetterOperation, $namedGetterFunctionName, "GetterIDLType");
795         
796         my $overrideBuiltin = $codeGenerator->InheritsExtendedAttribute($interface, "OverrideBuiltins") ? "OverrideBuiltins::Yes" : "OverrideBuiltins::No";
797         push(@$outputArray, "    if (auto namedProperty = accessVisibleNamedProperty<${overrideBuiltin}>(*state, *thisObject, propertyName, getterFunctor)) {\n");
798         
799         # NOTE: GenerateNamedGetter implements steps 2.1 - 2.10.
800         
801         my ($nativeToJSConversion, $attributeString) = GenerateNamedGetter($interface, $namedGetterOperation, "WTFMove(namedProperty.value())");
802
803         push(@$outputArray, "        auto value = ${nativeToJSConversion};\n");
804         push(@$outputArray, "        RETURN_IF_EXCEPTION(throwScope, false);\n") if $namedGetterOperation->extendedAttributes->{MayThrowException};
805         
806         push(@$outputArray, "        slot.setValue(thisObject, ${attributeString}, value);\n");
807         push(@$outputArray, "        return true;\n");
808         push(@$outputArray, "    }\n");
809     }
810     
811     if ($interface->extendedAttributes->{Plugin}) {
812         &$propertyNameGeneration();
813
814         AddToImplIncludes("JSPluginElementFunctions.h");
815         push(@$outputArray, "    if (pluginElementCustomGetOwnPropertySlot(thisObject, state, propertyName, slot))\n");
816         push(@$outputArray, "        return true;\n");
817     }
818
819     # 3. Return OrdinaryGetOwnProperty(O, P).
820     push(@$outputArray, "    return JSObject::getOwnPropertySlotByIndex(object, state, index, slot);\n");
821     
822     push(@$outputArray, "}\n\n");
823 }
824
825 # https://heycam.github.io/webidl/#legacy-platform-object-property-enumeration
826 sub GenerateGetOwnPropertyNames
827 {
828     my ($outputArray, $interface, $className) = @_;
829     
830     return if $interface->extendedAttributes->{CustomGetOwnPropertyNames};
831     
832     my $namedGetterOperation = GetNamedGetterOperation($interface);
833     my $indexedGetterOperation = GetIndexedGetterOperation($interface);
834     
835     push(@$outputArray, "void ${className}::getOwnPropertyNames(JSObject* object, ExecState* state, PropertyNameArray& propertyNames, EnumerationMode mode)\n");
836     push(@$outputArray, "{\n");
837     push(@$outputArray, "    auto* thisObject = jsCast<${className}*>(object);\n");
838     push(@$outputArray, "    ASSERT_GC_OBJECT_INHERITS(object, info());\n");
839     
840     # 1. If the object supports indexed properties, then the object’s supported
841     #    property indices are enumerated first, in numerical order.
842     # FIXME: This should support non-contiguous indices.
843     if ($indexedGetterOperation) {
844         push(@$outputArray, "    for (unsigned i = 0, count = thisObject->wrapped().length(); i < count; ++i)\n");
845         push(@$outputArray, "        propertyNames.add(Identifier::from(state, i));\n");
846     }
847
848     # 2. If the object supports named properties and doesn’t implement an interface
849     #    with the [LegacyUnenumerableNamedProperties] extended attribute, then the
850     #    object’s supported property names that are visible according to the named
851     #    property visibility algorithm are enumerated next, in the order given in
852     #    the definition of the set of supported property names.
853     if ($namedGetterOperation) {
854         if (!$interface->extendedAttributes->{LegacyUnenumerableNamedProperties}) {
855             push(@$outputArray, "    for (auto& propertyName : thisObject->wrapped().supportedPropertyNames())\n");
856             push(@$outputArray, "        propertyNames.add(Identifier::fromString(state, propertyName));\n");
857         } else {
858             push(@$outputArray, "    if (mode.includeDontEnumProperties()) {\n");
859             push(@$outputArray, "        for (auto& propertyName : thisObject->wrapped().supportedPropertyNames())\n");
860             push(@$outputArray, "            propertyNames.add(Identifier::fromString(state, propertyName));\n");
861             push(@$outputArray, "    }\n");
862         }
863     }
864     
865     # 3. Finally, any enumerable own properties or properties from the object’s
866     #    prototype chain are then enumerated, in no defined order.
867     push(@$outputArray, "    JSObject::getOwnPropertyNames(object, state, propertyNames, mode);\n");
868     push(@$outputArray, "}\n\n");
869 }
870
871 # https://heycam.github.io/webidl/#invoke-indexed-setter
872 sub GenerateInvokeIndexedPropertySetter
873 {
874     my ($outputArray, $indent, $interface, $indexedSetterOperation, $indexExpression, $value) = @_;
875     
876     # The second argument of the indexed setter operation is the argument being converted.
877     my $argument = @{$indexedSetterOperation->arguments}[1];
878     my $nativeValue = JSValueToNative($interface, $argument, $value, $indexedSetterOperation->extendedAttributes->{Conditional}, "state", "*state", "thisObject", "", "");
879     
880     push(@$outputArray, $indent . "auto throwScope = DECLARE_THROW_SCOPE(state->vm());\n");
881     push(@$outputArray, $indent . "auto nativeValue = ${nativeValue};\n");
882     push(@$outputArray, $indent . "RETURN_IF_EXCEPTION(throwScope, true);\n");
883     
884     my $indexedSetterFunctionName = $indexedSetterOperation->name || "setItem";
885     my $nativeValuePassExpression = PassArgumentExpression("nativeValue", $argument);
886     my $functionString = "thisObject->wrapped().${indexedSetterFunctionName}(${indexExpression}, ${nativeValuePassExpression})";
887     $functionString = "propagateException(*state, throwScope, ${functionString})" if NeedsExplicitPropagateExceptionCall($indexedSetterOperation);
888     
889     push(@$outputArray, $indent . $functionString . ";\n");
890 }
891
892 # https://heycam.github.io/webidl/#invoke-named-setter
893 sub GenerateInvokeNamedPropertySetter
894 {
895     my ($outputArray, $indent, $interface, $namedSetterOperation, $value) = @_;
896     
897     my $argument = @{$namedSetterOperation->arguments}[1];
898     my $nativeValue = JSValueToNative($interface, $argument, $value, $namedSetterOperation->extendedAttributes->{Conditional}, "state", "*state", "thisObject", "", "");
899     
900     push(@$outputArray, $indent . "auto throwScope = DECLARE_THROW_SCOPE(state->vm());\n");
901     push(@$outputArray, $indent . "auto nativeValue = ${nativeValue};\n");
902     push(@$outputArray, $indent . "RETURN_IF_EXCEPTION(throwScope, true);\n");
903
904     push(@$outputArray, $indent . "bool isPropertySupported = true;\n") if $namedSetterOperation->extendedAttributes->{CallNamedSetterOnlyForSupportedProperties};
905
906     my $namedSetterFunctionName = $namedSetterOperation->name || "setNamedItem";
907     my $nativeValuePassExpression = PassArgumentExpression("nativeValue", $argument);
908
909     my @arguments = ();
910     push(@arguments, "propertyNameToString(propertyName)");
911     push(@arguments, $nativeValuePassExpression);
912     push(@arguments, "isPropertySupported") if $namedSetterOperation->extendedAttributes->{CallNamedSetterOnlyForSupportedProperties};
913
914     my $functionString = "thisObject->wrapped().${namedSetterFunctionName}(" . join(", ", @arguments) . ")";
915     $functionString = "propagateException(*state, throwScope, ${functionString})" if NeedsExplicitPropagateExceptionCall($namedSetterOperation);
916
917     push(@$outputArray, $indent . $functionString . ";\n");
918 }
919
920 sub GeneratePut
921 {
922     my ($outputArray, $interface, $className) = @_;
923     
924     return if $interface->extendedAttributes->{CustomPut};
925     
926     my $namedSetterOperation = GetNamedSetterOperation($interface);
927     my $indexedSetterOperation = GetIndexedSetterOperation($interface);
928     
929     push(@$outputArray, "bool ${className}::put(JSCell* cell, ExecState* state, PropertyName propertyName, JSValue value, PutPropertySlot& putPropertySlot)\n");
930     push(@$outputArray, "{\n");
931     push(@$outputArray, "    auto* thisObject = jsCast<${className}*>(cell);\n");
932     push(@$outputArray, "    ASSERT_GC_OBJECT_INHERITS(thisObject, info());\n\n");
933     
934     if (($namedSetterOperation && $namedSetterOperation->extendedAttributes->{CEReactions}) || ($indexedSetterOperation && $indexedSetterOperation->extendedAttributes->{CEReactions})) {
935         push(@$outputArray, "    CustomElementReactionStack customElementReactionStack;\n\n");
936         AddToImplIncludes("CustomElementReactionQueue.h");
937     }
938     
939     if ($indexedSetterOperation) {
940         push(@$outputArray, "    if (auto index = parseIndex(propertyName)) {\n");
941         
942         GenerateInvokeIndexedPropertySetter($outputArray, "        ", $interface, $indexedSetterOperation, "index.value()", "value");
943         
944         push(@$outputArray, "        return true;\n");
945         push(@$outputArray, "    }\n\n");
946     }
947     
948     if ($namedSetterOperation) {
949         # FIMXE: We need a more comprehensive story for Symbols.
950         push(@$outputArray, "    if (!propertyName.isSymbol()) {\n");
951         
952         my $additionalIndent = "";
953         
954         my $overrideBuiltins = $codeGenerator->InheritsExtendedAttribute($interface, "OverrideBuiltins");
955         if (!$overrideBuiltins) {
956             push(@$outputArray, "        PropertySlot slot { thisObject, PropertySlot::InternalMethodType::VMInquiry };\n");
957             push(@$outputArray, "        JSValue prototype = thisObject->getPrototypeDirect();\n");
958             push(@$outputArray, "        if (!(prototype.isObject() && asObject(prototype)->getPropertySlot(state, propertyName, slot))) {\n");
959             $additionalIndent .= "    ";
960         }
961
962         GenerateInvokeNamedPropertySetter($outputArray, $additionalIndent . "        ", $interface, $namedSetterOperation, "value");
963         if ($namedSetterOperation->extendedAttributes->{CallNamedSetterOnlyForSupportedProperties}) {
964             push(@$outputArray, $additionalIndent . "        if (!isPropertySupported)\n");
965             push(@$outputArray, $additionalIndent . "            return JSObject::put(thisObject, state, propertyName, value, putPropertySlot);\n");
966         }
967         push(@$outputArray, $additionalIndent . "        return true;\n");
968
969         if (!$overrideBuiltins) {
970             push(@$outputArray, "        }\n");
971         }
972         
973         push(@$outputArray, "    }\n\n");
974     }
975     
976     assert("Using both a named property setter and [Plugin] together is not supported.") if $namedSetterOperation && $interface->extendedAttributes->{Plugin};
977     if ($interface->extendedAttributes->{Plugin}) {
978         AddToImplIncludes("JSPluginElementFunctions.h");
979
980         push(@$outputArray, "    bool putResult = false;\n");
981         push(@$outputArray, "    if (pluginElementCustomPut(thisObject, state, propertyName, value, putPropertySlot, putResult))\n");
982         push(@$outputArray, "        return putResult;\n\n");
983     }
984
985     push(@$outputArray, "    return JSObject::put(thisObject, state, propertyName, value, putPropertySlot);\n");
986     push(@$outputArray, "}\n\n");
987 }
988
989 sub GeneratePutByIndex
990 {
991     my ($outputArray, $interface, $className) = @_;
992     
993     return if $interface->extendedAttributes->{CustomPut};
994
995     my $namedSetterOperation = GetNamedSetterOperation($interface);
996     my $indexedSetterOperation = GetIndexedSetterOperation($interface);
997     
998     my $overrideBuiltins = $codeGenerator->InheritsExtendedAttribute($interface, "OverrideBuiltins");
999     my $ellidesCallsToBase = ($namedSetterOperation && $overrideBuiltins) && !$interface->extendedAttributes->{Plugin} && !$namedSetterOperation->extendedAttributes->{CallNamedSetterOnlyForSupportedProperties};
1000     
1001     push(@$outputArray, "bool ${className}::putByIndex(JSCell* cell, ExecState* state, unsigned index, JSValue value, bool" . (!$ellidesCallsToBase ? " shouldThrow" : "") . ")\n");
1002     push(@$outputArray, "{\n");
1003     push(@$outputArray, "    auto* thisObject = jsCast<${className}*>(cell);\n");
1004     push(@$outputArray, "    ASSERT_GC_OBJECT_INHERITS(thisObject, info());\n\n");
1005     
1006     if (($namedSetterOperation && $namedSetterOperation->extendedAttributes->{CEReactions}) || ($indexedSetterOperation && $indexedSetterOperation->extendedAttributes->{CEReactions})) {
1007         push(@$outputArray, "    CustomElementReactionStack customElementReactionStack;\n\n");
1008         AddToImplIncludes("CustomElementReactionQueue.h");
1009     }
1010     
1011     if ($indexedSetterOperation ) {
1012         push(@$outputArray, "    if (LIKELY(index <= MAX_ARRAY_INDEX)) {\n");
1013         
1014         GenerateInvokeIndexedPropertySetter($outputArray, "        ", $interface, $indexedSetterOperation, "index", "value");
1015         
1016         push(@$outputArray, "        return true;\n");
1017         push(@$outputArray, "    }\n\n");
1018     }
1019     
1020     if ($namedSetterOperation) {
1021         push(@$outputArray, "    auto propertyName = Identifier::from(state, index);\n");
1022                 
1023         my $additionalIndent = "";
1024         if (!$overrideBuiltins) {
1025             push(@$outputArray, "    PropertySlot slot { thisObject, PropertySlot::InternalMethodType::VMInquiry };\n");
1026             push(@$outputArray, "    JSValue prototype = thisObject->getPrototypeDirect();\n");
1027             push(@$outputArray, "    if (!(prototype.isObject() && asObject(prototype)->getPropertySlot(state, propertyName, slot))) {\n");
1028             $additionalIndent .= "    ";
1029         }
1030         
1031         GenerateInvokeNamedPropertySetter($outputArray, $additionalIndent . "    ", $interface, $namedSetterOperation, "value");
1032         if ($namedSetterOperation->extendedAttributes->{CallNamedSetterOnlyForSupportedProperties}) {
1033             push(@$outputArray, $additionalIndent . "    if (!isPropertySupported)\n");
1034             push(@$outputArray, $additionalIndent . "        return JSObject::putByIndex(cell, state, index, value, shouldThrow);\n");
1035         }
1036         push(@$outputArray, $additionalIndent . "    return true;\n");
1037         
1038         if (!$overrideBuiltins) {
1039             push(@$outputArray, "    }\n\n");
1040         }
1041     }
1042
1043     assert("Using both a named property setter and [Plugin] together is not supported.") if $namedSetterOperation && $interface->extendedAttributes->{Plugin};
1044     if ($interface->extendedAttributes->{Plugin}) {
1045         AddToImplIncludes("JSPluginElementFunctions.h");
1046         push(@$outputArray, "    auto propertyName = Identifier::from(state, index);\n");
1047         push(@$outputArray, "    PutPropertySlot putPropertySlot(thisObject, shouldThrow);\n");
1048         push(@$outputArray, "    bool putResult = false;\n");
1049         push(@$outputArray, "    if (pluginElementCustomPut(thisObject, state, propertyName, value, putPropertySlot, putResult))\n");
1050         push(@$outputArray, "        return putResult;\n\n");
1051     }
1052
1053     if (!$ellidesCallsToBase) {
1054         push(@$outputArray, "    return JSObject::putByIndex(cell, state, index, value, shouldThrow);\n");
1055     }
1056     
1057     push(@$outputArray, "}\n\n");
1058 }
1059
1060 sub GenerateIsUnforgeablePropertyName
1061 {
1062     my ($outputArray, $interface) = @_;
1063     
1064     my @unforgeablePropertyNames = ();
1065     foreach my $property (@{$interface->attributes}, @{$interface->operations}) {
1066         next if $property->isStatic;
1067         
1068         if (IsUnforgeable($interface, $property)) {
1069             push(@unforgeablePropertyNames, $property->name);
1070         }
1071     }
1072     
1073     return 0 if (scalar(@unforgeablePropertyNames) == 0);
1074     
1075     my $condition = join(" || ", map { "propertyName == \"" . $_ . "\"" } @unforgeablePropertyNames);
1076     
1077     push(@$outputArray, "static bool isUnforgeablePropertyName(PropertyName propertyName)\n");
1078     push(@$outputArray, "{\n");
1079     push(@$outputArray, "    return ${condition};\n");
1080     push(@$outputArray, "}\n\n");
1081     
1082     return 1;
1083 }
1084
1085 # https://heycam.github.io/webidl/#legacy-platform-object-defineownproperty
1086 sub GenerateDefineOwnProperty
1087 {
1088     my ($outputArray, $interface, $className) = @_;
1089     
1090     return if $interface->extendedAttributes->{CustomDefineOwnProperty};
1091     
1092     my $namedSetterOperation = GetNamedSetterOperation($interface);
1093     my $indexedSetterOperation = GetIndexedSetterOperation($interface);
1094     
1095     return if !$namedSetterOperation && !$indexedSetterOperation;
1096     
1097     push(@$outputArray, "bool ${className}::defineOwnProperty(JSObject* object, ExecState* state, PropertyName propertyName, const PropertyDescriptor& propertyDescriptor, bool shouldThrow)\n");
1098     push(@$outputArray, "{\n");
1099     push(@$outputArray, "    auto* thisObject = jsCast<${className}*>(object);\n");
1100     push(@$outputArray, "    ASSERT_GC_OBJECT_INHERITS(thisObject, info());\n\n");
1101     
1102     if (($namedSetterOperation && $namedSetterOperation->extendedAttributes->{CEReactions}) || ($indexedSetterOperation && $indexedSetterOperation->extendedAttributes->{CEReactions})) {
1103         push(@$outputArray, "    CustomElementReactionStack customElementReactionStack;\n\n");
1104         AddToImplIncludes("CustomElementReactionQueue.h");
1105     }
1106     
1107     # 1. If O supports indexed properties and P is an array index property name, then:
1108     if (GetIndexedGetterOperation($interface)) {
1109         # NOTE: The numbers are out of order because there is no reason doing steps 1, 3, and 4 if there
1110         # is no indexed property setter.
1111
1112         if (!$indexedSetterOperation) {
1113             # 2. If O does not implement an interface with an indexed property setter, then return false.
1114             push(@$outputArray, "    if (parseIndex(propertyName))\n");
1115             push(@$outputArray, "        return false;\n\n");
1116         } else {
1117             push(@$outputArray, "    if (auto index = parseIndex(propertyName)) {\n");
1118
1119             # 1. If the result of calling IsDataDescriptor(Desc) is false, then return false.
1120             push(@$outputArray, "        if (!propertyDescriptor.isDataDescriptor())\n");
1121             push(@$outputArray, "            return false;\n");
1122             
1123             # 3. Invoke the indexed property setter with P and Desc.[[Value]].
1124             GenerateInvokeIndexedPropertySetter($outputArray, "        ", $interface, $indexedSetterOperation, "index.value()", "propertyDescriptor.value()");
1125             
1126             # 4. Return true.
1127             push(@$outputArray, "        return true;\n");
1128             push(@$outputArray, "    }\n\n");
1129         }
1130     }
1131     
1132     # 2. If O supports named properties, O does not implement an interface with the [Global] or [PrimaryGlobal]
1133     #    extended attribute and P is not an unforgeable property name of O, then:
1134     if (GetNamedGetterOperation($interface) && !IsGlobalOrPrimaryGlobalInterface($interface)) {
1135         # FIMXE: We need a more comprehensive story for Symbols.
1136         push(@$outputArray, "    if (!propertyName.isSymbol()) {\n");
1137         
1138         my $additionalIndent = "";
1139         
1140         my $hasUnforgableProperties = GenerateIsUnforgeablePropertyName($outputArray, $interface);
1141         if ($hasUnforgableProperties) {
1142             push(@$outputArray, "        if (!isUnforgeablePropertyName(propertyName)) {\n");
1143             $additionalIndent .= "    ";
1144         }
1145         
1146         # 1. Let creating be true if P is not a supported property name, and false otherwise.
1147         # NOTE: This step is strength reduced into the only use of 'creating' in step 2.2.1
1148         
1149         # 2. If O implements an interface with the [OverrideBuiltins] extended attribute or O
1150         #    does not have an own property named P, then:
1151         my $overrideBuiltins = $codeGenerator->InheritsExtendedAttribute($interface, "OverrideBuiltins");
1152         if (!$overrideBuiltins) {
1153             # FIXME: Is JSObject::getOwnPropertySlot the right function to call? Is there a function that will
1154             #        only look at the actual properties, and not call into our implementation of the
1155             #        [[GetOwnProperty]] hook?
1156             push(@$outputArray, $additionalIndent. "        PropertySlot slot { thisObject, PropertySlot::InternalMethodType::VMInquiry };\n");
1157             push(@$outputArray, $additionalIndent. "        if (!JSObject::getOwnPropertySlot(thisObject, state, propertyName, slot)) {\n");
1158             $additionalIndent .= "    ";
1159         }
1160         if (!$namedSetterOperation) {
1161             # 2.1. If creating is false and O does not implement an interface with a named property setter, then return false.
1162             push(@$outputArray, $additionalIndent . "        if (thisObject->wrapped().isSupportedPropertyName(propertyNameToString(propertyName)))\n");
1163             push(@$outputArray, $additionalIndent . "            return false;\n");
1164         } else {
1165             # 2.2. If O implements an interface with a named property setter, then:
1166             
1167             # 2.2.1. If the result of calling IsDataDescriptor(Desc) is false, then return false.
1168             push(@$outputArray, $additionalIndent . "        if (!propertyDescriptor.isDataDescriptor())\n");
1169             push(@$outputArray, $additionalIndent . "            return false;\n");
1170             
1171             # 2.2.2. Invoke the named property setter with P and Desc.[[Value]].
1172             GenerateInvokeNamedPropertySetter($outputArray, $additionalIndent . "        ", $interface, $namedSetterOperation, "propertyDescriptor.value()");
1173             if ($namedSetterOperation->extendedAttributes->{CallNamedSetterOnlyForSupportedProperties}) {
1174                 push(@$outputArray, $additionalIndent . "    if (!isPropertySupported)\n");
1175                 push(@$outputArray, $additionalIndent . "        return JSObject::defineOwnProperty(object, state, propertyName, propertyDescriptor, shouldThrow);\n");
1176             }
1177             # 2.2.3. Return true.
1178             push(@$outputArray, $additionalIndent . "        return true;\n");
1179         }
1180         
1181         if (!$overrideBuiltins) {
1182             push(@$outputArray, $additionalIndent . "    }\n");
1183         }
1184         
1185         if ($hasUnforgableProperties) {
1186             push(@$outputArray, "        }\n");
1187         }
1188         
1189         # Close the !propertyName.isSymbol() condition.
1190         push(@$outputArray, "    }\n\n");
1191     }
1192     
1193     push(@$outputArray, "    PropertyDescriptor newPropertyDescriptor = propertyDescriptor;\n");
1194         
1195     # 3. If O does not implement an interface with the [Global] or [PrimaryGlobal] extended attribute,
1196     #    then set Desc.[[Configurable]] to true.
1197     if (!IsGlobalOrPrimaryGlobalInterface($interface)) {
1198         push(@$outputArray, "    newPropertyDescriptor.setConfigurable(true);\n");
1199     }
1200     
1201     # 4. Return OrdinaryDefineOwnProperty(O, P, Desc).
1202     # FIXME: Does this do the same thing?
1203     push(@$outputArray, "    return JSObject::defineOwnProperty(object, state, propertyName, newPropertyDescriptor, shouldThrow);\n");
1204     
1205     push(@$outputArray, "}\n\n");
1206 }
1207
1208 sub GenerateDeletePropertyCommon
1209 {
1210     my ($outputArray, $interface, $className, $operation, $conditional) = @_;
1211     
1212     # This implements step 2 of https://heycam.github.io/webidl/#legacy-platform-object-delete
1213     # so it can be shared between the generation of deleteProperty and deletePropertyByIndex.
1214
1215     # 2. If O supports named properties, O does not implement an interface with the
1216     #    [Global] or [PrimaryGlobal] extended attribute and the result of calling the
1217     #    named property visibility algorithm with property name P and object O is true,
1218     #    then:
1219     assert("Named property deleters are not allowed without a corresponding named property getter.") if !GetNamedGetterOperation($interface);
1220     assert("Named property deleters are not allowed on global object interfaces.") if IsGlobalOrPrimaryGlobalInterface($interface);
1221
1222     AddToImplIncludes("JSDOMAbstractOperations.h", $conditional);
1223     my $overrideBuiltin = $codeGenerator->InheritsExtendedAttribute($interface, "OverrideBuiltins") ? "OverrideBuiltins::Yes" : "OverrideBuiltins::No";
1224     push(@$outputArray, "    if (isVisibleNamedProperty<${overrideBuiltin}>(*state, thisObject, propertyName)) {\n");
1225
1226     if ($operation->extendedAttributes->{CEReactions}) {
1227         push(@$outputArray, "        CustomElementReactionStack customElementReactionStack;\n");
1228         AddToImplIncludes("CustomElementReactionQueue.h", $conditional);
1229     }
1230
1231     # 2.1. If O does not implement an interface with a named property deleter, then return false.
1232     # 2.2. Let operation be the operation used to declare the named property deleter.
1233     # NOTE: We only add a deleteProperty implementation of we have a named property deleter.
1234
1235     # 2.3. If operation was defined without an identifier, then:
1236     #      1. Perform the steps listed in the interface description to delete an existing named
1237     #         property with P as the name.
1238     #      2. If the steps indicated that the deletion failed, then return false.
1239     # 2.4. Otherwise, operation was defined with an identifier:
1240     #      1. Perform the steps listed in the description of operation with P as the only argument
1241     #         value.
1242     #      2. If operation was declared with a return type of boolean and the steps returned false,
1243     #         then return false.
1244
1245     my $functionImplementationName = $operation->extendedAttributes->{ImplementedAs} || $codeGenerator->WK_lcfirst($operation->name) || "deleteNamedProperty";
1246     my $functionCall = "impl." . $functionImplementationName . "(propertyNameToString(propertyName))";
1247
1248     # NOTE: We expect the implementation function of named deleters without an identifier to
1249     #       return either bool or ExceptionOr<bool>. the implementation function of named deleters
1250     #       with an identifier have no restriction, but if the return value of the operation is
1251     #       boolean, we return that value, otherwise it is ignored (as per section 4.2).
1252
1253     if ($operation->extendedAttributes->{MayThrowException}) {
1254         push(@$outputArray, "        auto result = ${functionCall};\n");
1255         push(@$outputArray, "        if (result.hasException()) {\n");
1256         push(@$outputArray, "            auto throwScope = DECLARE_THROW_SCOPE(state->vm());\n");
1257         push(@$outputArray, "            propagateException(*state, throwScope, result.releaseException());\n");
1258         push(@$outputArray, "            return true;\n");
1259         push(@$outputArray, "        }\n\n");
1260
1261         if (!$operation->name || $operation->name && $operation->type->name eq "boolean") {
1262             push(@$outputArray, "        return result.releaseReturnValue();\n");
1263         } else {
1264             push(@$outputArray, "        return true;\n");
1265         }
1266     } else {
1267         if (!$operation->name || $operation->name && $operation->type->name eq "boolean") {
1268             push(@$outputArray, "        return ${functionCall};\n");
1269         } else {
1270             push(@$outputArray, "        ${functionCall};\n");
1271             push(@$outputArray, "        return true;\n");
1272         }
1273     }
1274
1275     push(@$outputArray, "    }\n");
1276 }
1277
1278 sub GenerateDeleteProperty
1279 {
1280     my ($outputArray, $interface, $className, $operation, $conditional) = @_;
1281
1282     # This implements https://heycam.github.io/webidl/#legacy-platform-object-delete for the
1283     # for the deleteProperty override hook.
1284
1285     push(@$outputArray, "bool ${className}::deleteProperty(JSCell* cell, ExecState* state, PropertyName propertyName)\n");
1286     push(@$outputArray, "{\n");
1287
1288     push(@$outputArray, "    auto& thisObject = *jsCast<${className}*>(cell);\n");
1289     push(@$outputArray, "    auto& impl = thisObject.wrapped();\n");
1290
1291     # 1. If O supports indexed properties and P is an array index property name, then:
1292     #    1. Let index be the result of calling ToUint32(P).
1293     #    2. If index is not a supported property index, then return true.
1294     #    3. Return false.
1295     if (GetIndexedGetterOperation($interface)) {
1296         push(@$outputArray, "    if (auto index = parseIndex(propertyName))\n");
1297         push(@$outputArray, "        return !impl.isSupportedPropertyIndex(index.value());\n");
1298     }
1299
1300     # GenerateDeletePropertyCommon implements step 2.
1301     GenerateDeletePropertyCommon($outputArray, $interface, $className, $operation, $conditional);
1302
1303     # FIXME: Instead of calling down JSObject::deleteProperty, perhaps we should implement
1304     # the remained of the algorithm ourselves.
1305     push(@$outputArray, "    return JSObject::deleteProperty(cell, state, propertyName);\n");
1306     push(@$outputArray, "}\n\n");
1307 }
1308
1309 sub GenerateDeletePropertyByIndex
1310 {
1311     my ($outputArray, $interface, $className, $operation, $conditional) = @_;
1312
1313     # This implements https://heycam.github.io/webidl/#legacy-platform-object-delete for the
1314     # for the deletePropertyByIndex override hook.
1315
1316     push(@$outputArray, "bool ${className}::deletePropertyByIndex(JSCell* cell, ExecState* state, unsigned index)\n");
1317     push(@$outputArray, "{\n");
1318
1319     push(@$outputArray, "    auto& thisObject = *jsCast<${className}*>(cell);\n");
1320     push(@$outputArray, "    auto& impl = thisObject.wrapped();\n");
1321
1322     # 1. If O supports indexed properties and P is an array index property name, then:
1323     #    1. Let index be the result of calling ToUint32(P).
1324     #    2. If index is not a supported property index, then return true.
1325     #    3. Return false.
1326
1327     # NOTE: For deletePropertyByIndex, if there is an indexed getter, checking isSupportedPropertyIndex()
1328     #       is all that needs to be done, no need to generate the .
1329
1330     if (GetIndexedGetterOperation($interface)) {
1331         push(@$outputArray, "    return !impl.isSupportedPropertyIndex(index);\n");
1332     } else {
1333         push(@$outputArray, "    auto propertyName = Identifier::from(state, index);\n");
1334
1335         # GenerateDeletePropertyCommon implements step 2.
1336         GenerateDeletePropertyCommon($outputArray, $interface, $className, $operation, $conditional);
1337
1338         # FIXME: Instead of calling down JSObject::deletePropertyByIndex, perhaps we should implement
1339         # the remaineder of the algoritm (steps 3 and 4) ourselves.
1340         
1341         # 3. If O has an own property with name P, then:
1342         #    1. If the property is not configurable, then return false.
1343         #    2. Otherwise, remove the property from O.
1344         # 3. Return true.
1345         
1346         push(@$outputArray, "    return JSObject::deletePropertyByIndex(cell, state, index);\n");
1347     }
1348
1349     push(@$outputArray, "}\n\n");
1350 }
1351
1352
1353 sub GenerateNamedDeleterDefinition
1354 {
1355     my ($outputArray, $interface, $className) = @_;
1356     
1357     return if $interface->extendedAttributes->{CustomDeleteProperty};
1358
1359     my $namedDeleterOperation = GetNamedDeleterOperation($interface);
1360     
1361     # This implements https://heycam.github.io/webidl/#legacy-platform-object-delete using
1362     # the deleteProperty and deletePropertyByIndex override hooks.
1363
1364     assert("Named property deleters are not allowed without a corresponding named property getter.") if !GetNamedGetterOperation($interface);
1365     assert("Named property deleters are not allowed on global object interfaces.") if IsGlobalOrPrimaryGlobalInterface($interface);
1366
1367     my $conditional = $namedDeleterOperation->extendedAttributes->{Conditional};
1368     if ($conditional) {
1369         my $conditionalString = $codeGenerator->GenerateConditionalStringFromAttributeValue($conditional);
1370         push(@$outputArray, "#if ${conditionalString}\n\n");;
1371     }
1372
1373     GenerateDeleteProperty($outputArray, $interface, $className, $namedDeleterOperation, $conditional);
1374     GenerateDeletePropertyByIndex($outputArray, $interface, $className, $namedDeleterOperation, $conditional);
1375
1376     push(@implContent, "#endif\n\n") if $conditional;
1377 }
1378
1379 sub GenerateHeaderContentHeader
1380 {
1381     my $interface = shift;
1382     my $className = "JS" . $interface->type->name;
1383
1384     my @headerContentHeader;
1385     if ($interface->extendedAttributes->{AppleCopyright}) {
1386         @headerContentHeader = split("\r", $beginAppleCopyrightForHeaderFiles);
1387     } else {
1388         @headerContentHeader = split("\r", $headerTemplate);
1389     }
1390
1391     push(@headerContentHeader, "\n#pragma once\n\n");
1392
1393     my $conditionalString = $codeGenerator->GenerateConditionalString($interface);
1394     push(@headerContentHeader, "#if ${conditionalString}\n\n") if $conditionalString;
1395     return @headerContentHeader;
1396 }
1397
1398 sub GenerateImplementationContentHeader
1399 {
1400     my $interface = shift;
1401     my $className = "JS" . $interface->type->name;
1402
1403     my @implContentHeader;
1404     if ($interface->extendedAttributes->{AppleCopyright}) {
1405         @implContentHeader = split("\r", $beginAppleCopyrightForSourceFiles);
1406     } else {
1407         @implContentHeader = split("\r", $headerTemplate);
1408     }
1409
1410     push(@implContentHeader, "\n#include \"config.h\"\n");
1411     my $conditionalString = $codeGenerator->GenerateConditionalString($interface);
1412     push(@implContentHeader, "\n#if ${conditionalString}\n\n") if $conditionalString;
1413     push(@implContentHeader, "#include \"$className.h\"\n\n");
1414     return @implContentHeader;
1415 }
1416
1417 sub NeedsImplementationClass
1418 {
1419     my ($interface) = @_;
1420
1421     return 0 if $interface->extendedAttributes->{JSBuiltin};
1422     return 1;
1423 }
1424
1425 sub ShouldGenerateToWrapped
1426 {
1427     my ($hasParent, $interface) = @_;
1428
1429     return 0 if not NeedsImplementationClass($interface);
1430     return 1 if !$hasParent or $interface->extendedAttributes->{JSGenerateToNativeObject};
1431     return 1 if $interface->parentType && $interface->parentType->name eq "EventTarget";
1432     return 0;
1433 }
1434
1435 sub ShouldGenerateWrapperOwnerCode
1436 {
1437     my ($hasParent, $interface) = @_;
1438
1439     return 0 if not NeedsImplementationClass($interface);
1440     return 1 if !$hasParent;
1441     return 1 if GetGenerateIsReachable($interface);
1442     return 1 if GetCustomIsReachable($interface);
1443     return 1 if $interface->extendedAttributes->{JSCustomFinalize};
1444     return 1 if $codeGenerator->InheritsExtendedAttribute($interface, "ActiveDOMObject");
1445     return 0;
1446 }
1447
1448 sub ShouldGenerateToJSDeclaration
1449 {
1450     my ($hasParent, $interface) = @_;
1451
1452     return 0 if ($interface->extendedAttributes->{SuppressToJSObject});
1453     return 0 if not NeedsImplementationClass($interface);
1454     return 0 if $interface->extendedAttributes->{CustomProxyToJSObject};
1455     return 1 if (!$hasParent or $interface->extendedAttributes->{JSGenerateToJSObject} or $interface->extendedAttributes->{CustomToJSObject});
1456     return 1 if $interface->parentType && $interface->parentType->name eq "EventTarget";
1457     return 1 if $interface->extendedAttributes->{Constructor} or $interface->extendedAttributes->{NamedConstructor};
1458     return 0;
1459 }
1460
1461 sub ShouldGenerateToJSImplementation
1462 {
1463     my ($hasParent, $interface) = @_;
1464
1465     return 0 if not ShouldGenerateToJSDeclaration($hasParent, $interface);
1466     return 1 if not $interface->extendedAttributes->{CustomToJSObject};
1467     return 0;
1468 }
1469
1470 sub GetTypeNameForDisplayInException
1471 {
1472     my ($type) = @_;
1473
1474     # FIXME: Add more type specializations.
1475     return "(" . join(" or ", map { $_->name } GetFlattenedMemberTypes($type)) . ")" if $type->isUnion;
1476     return $type->name;
1477 }
1478
1479 sub GetArgumentExceptionFunction
1480 {
1481     my ($interface, $argument, $argumentIndex, $quotedFunctionName) = @_;
1482
1483     my $name = $argument->name;
1484     my $visibleInterfaceName = $codeGenerator->GetVisibleInterfaceName($interface);
1485     my $typeName = GetTypeNameForDisplayInException($argument->type);
1486
1487     if ($codeGenerator->IsCallbackInterface($argument->type) || $codeGenerator->IsCallbackFunction($argument->type)) {
1488         # FIXME: We should have specialized messages for callback interfaces vs. callback functions.
1489         return "throwArgumentMustBeFunctionError(state, scope, ${argumentIndex}, \"${name}\", \"${visibleInterfaceName}\", ${quotedFunctionName});";
1490     }
1491
1492     if ($codeGenerator->IsWrapperType($argument->type) || $codeGenerator->IsBufferSourceType($argument->type)) {
1493         return "throwArgumentTypeError(state, scope, ${argumentIndex}, \"${name}\", \"${visibleInterfaceName}\", ${quotedFunctionName}, \"${typeName}\");";
1494     }
1495
1496     if ($codeGenerator->IsEnumType($argument->type)) {
1497         my $className = GetEnumerationClassName($argument->type, $interface);
1498         return "throwArgumentMustBeEnumError(state, scope, ${argumentIndex}, \"${name}\", \"${visibleInterfaceName}\", ${quotedFunctionName}, expectedEnumerationValues<${className}>());";
1499     }
1500
1501     return undef;
1502 }
1503
1504 sub GetArgumentExceptionThrower
1505 {
1506     my ($interface, $argument, $argumentIndex, $quotedFunctionName) = @_;
1507
1508     my $functionCall = GetArgumentExceptionFunction($interface, $argument, $argumentIndex, $quotedFunctionName);
1509     return "[](JSC::ExecState& state, JSC::ThrowScope& scope) { " . $functionCall . " }" if $functionCall;
1510 }
1511
1512 sub GetAttributeExceptionFunction
1513 {
1514     my ($interface, $attribute) = @_;
1515     
1516     my $name = $attribute->name;
1517     my $visibleInterfaceName = $codeGenerator->GetVisibleInterfaceName($interface);
1518     my $typeName = GetTypeNameForDisplayInException($attribute->type);
1519
1520     if ($codeGenerator->IsWrapperType($attribute->type) || $codeGenerator->IsBufferSourceType($attribute->type)) {
1521         return "throwAttributeTypeError(state, scope, \"${visibleInterfaceName}\", \"${name}\", \"${typeName}\");";
1522     }
1523 }
1524
1525 sub GetAttributeExceptionThrower
1526 {
1527     my ($interface, $attribute) = @_;
1528
1529     my $functionCall = GetAttributeExceptionFunction($interface, $attribute);
1530     return "[](JSC::ExecState& state, JSC::ThrowScope& scope) { " . $functionCall . " }" if $functionCall;
1531
1532 }
1533
1534 sub PassArgumentExpression
1535 {
1536     my ($name, $context) = @_;
1537
1538     my $type = $context->type;
1539
1540     return "WTFMove(${name})" if $type->isNullable;
1541     
1542     if ($codeGenerator->IsBufferSourceType($type)) {
1543         return "*${name}" if $type->name eq "ArrayBuffer";
1544         return "${name}.releaseNonNull()";
1545     }
1546
1547     return "${name}.releaseNonNull()" if $codeGenerator->IsCallbackInterface($type) || $codeGenerator->IsCallbackFunction($type);
1548     return "*${name}" if $codeGenerator->IsWrapperType($type);
1549     return "WTFMove(${name})";
1550 }
1551
1552 sub GetAttributeGetterName
1553 {
1554     my ($interface, $className, $attribute) = @_;
1555
1556     return $codeGenerator->WK_lcfirst($className) . "Constructor" . $codeGenerator->WK_ucfirst($attribute->name) if $attribute->isStatic;
1557     return GetJSBuiltinFunctionName($className, $attribute) if IsJSBuiltin($interface, $attribute);
1558     return "js" . $interface->type->name . $codeGenerator->WK_ucfirst($attribute->name) . ($codeGenerator->IsConstructorType($attribute->type) ? "Constructor" : "");
1559 }
1560
1561 sub GetAttributeSetterName
1562 {
1563     my ($interface, $className, $attribute) = @_;
1564
1565     return "set" . $codeGenerator->WK_ucfirst($className) . "Constructor" . $codeGenerator->WK_ucfirst($attribute->name) if $attribute->isStatic;
1566     return "set" . $codeGenerator->WK_ucfirst(GetJSBuiltinFunctionName($className, $attribute)) if IsJSBuiltin($interface, $attribute);
1567     return "setJS" . $interface->type->name . $codeGenerator->WK_ucfirst($attribute->name) . ($codeGenerator->IsConstructorType($attribute->type) ? "Constructor" : "");
1568 }
1569
1570 sub GetFunctionName
1571 {
1572     my ($interface, $className, $operation) = @_;
1573
1574     return GetJSBuiltinFunctionName($className, $operation) if IsJSBuiltin($interface, $operation);
1575
1576     my $functionName = $operation->name;
1577     $functionName = "SymbolIterator" if $functionName eq "[Symbol.Iterator]";
1578
1579     my $kind = $operation->isStatic ? "Constructor" : (OperationShouldBeOnInstance($interface, $operation) ? "Instance" : "Prototype");
1580     return $codeGenerator->WK_lcfirst($className) . $kind . "Function" . $codeGenerator->WK_ucfirst($functionName);
1581 }
1582
1583 sub GetFullyQualifiedImplementationCallName
1584 {
1585     my ($interface, $property, $implementationName, $implExpression, $conditional) = @_;
1586     
1587     my $implementedBy = $property->extendedAttributes->{ImplementedBy};
1588     if ($implementedBy) {
1589         AddToImplIncludes("${implementedBy}.h", $conditional);
1590         return "WebCore::${implementedBy}::${implementationName}";
1591     }
1592     
1593     if ($property->isStatic || $property->extendedAttributes->{Constructor} || $property->extendedAttributes->{NamedConstructor}) {
1594         return $interface->type->name . "::${implementationName}";
1595     }
1596     
1597     if ($property->isMapLike) {
1598         return "forward" . $codeGenerator->WK_ucfirst($property->name) . "ToMapLike";
1599     }
1600     
1601     return "${implExpression}.${implementationName}";
1602 }
1603
1604 sub AddAdditionalArgumentsForImplementationCall
1605 {
1606     my ($arguments, $interface, $property, $implExpression, $stateExpression, $thisObjectExpression) = @_;
1607     
1608     if ($property->extendedAttributes->{ImplementedBy} && !$property->isStatic) {
1609         unshift(@$arguments, $implExpression);
1610     }
1611     
1612     if ($property->isMapLike) {
1613         push(@$arguments, $stateExpression);
1614         push(@$arguments, $thisObjectExpression);
1615     }
1616 }
1617
1618 sub GetSpecialAccessorOperationForType
1619 {
1620     my ($interface, $special, $firstParameterType, $numberOfParameters) = @_;
1621
1622     foreach my $operation (@{$interface->operations}, @{$interface->anonymousOperations}) {
1623         my $specials = $operation->specials;
1624         my $specialExists = grep { $_ eq $special } @$specials;
1625         my $arguments = $operation->arguments;
1626         if ($specialExists and scalar(@$arguments) == $numberOfParameters and $arguments->[0]->type->name eq $firstParameterType) {
1627             return $operation;
1628         }
1629     }
1630
1631     return 0;
1632 }
1633
1634 sub IsGlobalOrPrimaryGlobalInterface
1635 {
1636     my $interface = shift;
1637
1638     return $interface->extendedAttributes->{Global} || $interface->extendedAttributes->{PrimaryGlobal};
1639 }
1640
1641 sub AttributeShouldBeOnInstance
1642 {
1643     my $interface = shift;
1644     my $attribute = shift;
1645
1646     return 1 if IsGlobalOrPrimaryGlobalInterface($interface);
1647     return 1 if $codeGenerator->IsConstructorType($attribute->type);
1648
1649     # [Unforgeable] attributes should be on the instance.
1650     # https://heycam.github.io/webidl/#Unforgeable
1651     return 1 if IsUnforgeable($interface, $attribute);
1652
1653     if ($interface->extendedAttributes->{CheckSecurity}) {
1654         return 0 if $attribute->extendedAttributes->{DoNotCheckSecurity};
1655         return 0 if $attribute->extendedAttributes->{DoNotCheckSecurityOnGetter};
1656         return 1;
1657     }
1658
1659     return 0;
1660 }
1661
1662 sub IsAlwaysExposedOnInterface
1663 {
1664     my ($interfaceExposures, $contextExposures) = @_;
1665
1666     my %contextExposureSet = ();
1667
1668     if (ref($contextExposures) eq "ARRAY") {
1669         foreach my $contextExposure (@$contextExposures) {
1670             $contextExposureSet{$contextExposure} = 1;
1671         }
1672     } else {
1673         $contextExposureSet{$contextExposures} = 1;
1674     }
1675
1676     if (ref($interfaceExposures) ne "ARRAY") {
1677         $interfaceExposures = [$interfaceExposures];
1678     }
1679
1680     foreach my $interfaceExposure (@$interfaceExposures) {
1681         return 0 unless exists $contextExposureSet{$interfaceExposure};
1682     }
1683
1684     return 1;
1685 }
1686
1687 sub NeedsRuntimeCheck
1688 {
1689     my ($interface, $context) = @_;
1690
1691     if ($context->extendedAttributes->{Exposed}) {
1692         my $interfaceExposures = $interface->extendedAttributes->{Exposed} || "Window";
1693         return 1 if !IsAlwaysExposedOnInterface($interfaceExposures, $context->extendedAttributes->{Exposed});
1694     }
1695
1696     return $context->extendedAttributes->{EnabledAtRuntime}
1697         || $context->extendedAttributes->{EnabledForWorld}
1698         || $context->extendedAttributes->{SecureContext};
1699 }
1700
1701 # https://heycam.github.io/webidl/#es-operations
1702 sub OperationShouldBeOnInstance
1703 {
1704     my ($interface, $operation) = @_;
1705
1706     return 1 if IsGlobalOrPrimaryGlobalInterface($interface);
1707
1708     # FIXME: The bindings generator does not support putting runtime-enabled operations on the instance yet (except for global objects).
1709     return 0 if NeedsRuntimeCheck($interface, $operation);
1710
1711     # [Unforgeable] operations should be on the instance. https://heycam.github.io/webidl/#Unforgeable
1712     return 1 if IsUnforgeable($interface, $operation);
1713
1714     return 0;
1715 }
1716
1717 sub OperationHasForcedReturnValue
1718 {
1719     my ($operation) = @_;
1720
1721     foreach my $argument (@{$operation->arguments}) {
1722         return 1 if $argument->extendedAttributes->{ReturnValue};
1723     }
1724     return 0;
1725 }
1726
1727 sub IsAcceleratedDOMAttribute
1728 {
1729     my ($interface, $attribute) = @_;
1730
1731     # If we use CustomGetterSetter in IDL code generator we cannot skip type check.
1732     return 0 if NeedsRuntimeCheck($interface, $attribute) and AttributeShouldBeOnInstance($interface, $attribute);
1733     return 0 if $attribute->extendedAttributes->{PrivateIdentifier} and AttributeShouldBeOnInstance($interface, $attribute);
1734
1735     # If the interface has special logic for casting we cannot hoist type check to JSC.
1736     return 0 if $interface->extendedAttributes->{ImplicitThis};
1737     return 0 if $interface->extendedAttributes->{CustomProxyToJSObject};
1738
1739     return 0 if $attribute->isStatic;
1740     return 0 if $attribute->isMapLike;
1741     return 0 if $codeGenerator->IsConstructorType($attribute->type);
1742     return 0 if IsJSBuiltin($interface, $attribute);
1743     return 0 if $attribute->extendedAttributes->{LenientThis};
1744     return 0 if $codeGenerator->IsPromiseType($attribute->type);
1745     return 0 if $attribute->extendedAttributes->{DOMJIT};
1746     return 1;
1747 }
1748
1749 sub GetJSCAttributesForAttribute
1750 {
1751     my $interface = shift;
1752     my $attribute = shift;
1753
1754     my @specials = ();
1755     push(@specials, "DontDelete") if IsUnforgeable($interface, $attribute);
1756
1757     # As per Web IDL specification, constructor properties on the ECMAScript global object should not be enumerable.
1758     my $isGlobalConstructor = $codeGenerator->IsConstructorType($attribute->type);
1759     push(@specials, "DontEnum") if ($attribute->extendedAttributes->{NotEnumerable} || $isGlobalConstructor);
1760     push(@specials, "ReadOnly") if IsReadonly($attribute);
1761     push(@specials, "CustomAccessor") unless $isGlobalConstructor or IsJSBuiltin($interface, $attribute);
1762     push(@specials, "DOMAttribute") if IsAcceleratedDOMAttribute($interface, $attribute);
1763     push(@specials, "DOMJITAttribute") if $attribute->extendedAttributes->{DOMJIT};
1764     push(@specials, "Accessor | Builtin") if  IsJSBuiltin($interface, $attribute);
1765     return (@specials > 0) ? join(" | ", @specials) : "0";
1766 }
1767
1768 sub GetIndexedGetterOperation
1769 {
1770     my $interface = shift;
1771     return GetSpecialAccessorOperationForType($interface, "getter", "unsigned long", 1);
1772 }
1773
1774 sub GetIndexedSetterOperation
1775 {
1776     my $interface = shift;
1777     return GetSpecialAccessorOperationForType($interface, "setter", "unsigned long", 2);
1778 }
1779
1780 sub GetNamedGetterOperation
1781 {
1782     my $interface = shift;
1783     return GetSpecialAccessorOperationForType($interface, "getter", "DOMString", 1);
1784 }
1785
1786 sub GetNamedSetterOperation
1787 {
1788     my $interface = shift;
1789     return GetSpecialAccessorOperationForType($interface, "setter", "DOMString", 2);
1790 }
1791
1792 sub GetNamedDeleterOperation
1793 {
1794     my $interface = shift;
1795     return GetSpecialAccessorOperationForType($interface, "deleter", "DOMString", 1);
1796 }
1797
1798 sub InstanceOperationCount
1799 {
1800     my $interface = shift;
1801     my $count = 0;
1802
1803     foreach my $operation (@{$interface->operations}) {
1804         $count++ if OperationShouldBeOnInstance($interface, $operation);
1805     }
1806
1807     return $count;
1808 }
1809
1810 sub PrototypeOperationCount
1811 {
1812     my $interface = shift;
1813     my $count = 0;
1814
1815     foreach my $operation (@{$interface->operations}) {
1816         $count++ if !$operation->isStatic && !OperationShouldBeOnInstance($interface, $operation);
1817     }
1818
1819     $count += scalar @{$interface->iterable->operations} if $interface->iterable;
1820     $count += scalar @{$interface->mapLike->operations} if $interface->mapLike;
1821     $count += scalar @{$interface->serializable->operations} if $interface->serializable;
1822
1823     return $count;
1824 }
1825
1826 sub InstancePropertyCount
1827 {
1828     my $interface = shift;
1829     my $count = 0;
1830     foreach my $attribute (@{$interface->attributes}) {
1831         $count++ if AttributeShouldBeOnInstance($interface, $attribute);
1832     }
1833     $count += InstanceOperationCount($interface);
1834     return $count;
1835 }
1836
1837 sub PrototypePropertyCount
1838 {
1839     my $interface = shift;
1840     my $count = 0;
1841     foreach my $attribute (@{$interface->attributes}) {
1842         $count++ if !AttributeShouldBeOnInstance($interface, $attribute);
1843     }
1844     $count += PrototypeOperationCount($interface);
1845     $count++ if NeedsConstructorProperty($interface);
1846     return $count;
1847 }
1848
1849 sub InstanceOverridesGetOwnPropertySlot
1850 {
1851     my $interface = shift;
1852     return $interface->extendedAttributes->{CustomGetOwnPropertySlot}
1853         || $interface->extendedAttributes->{Plugin}
1854         || GetIndexedGetterOperation($interface)
1855         || GetNamedGetterOperation($interface);
1856 }
1857
1858 sub InstanceOverridesGetOwnPropertyNames
1859 {
1860     my $interface = shift;
1861     return $interface->extendedAttributes->{CustomGetOwnPropertyNames}
1862         || GetIndexedGetterOperation($interface)
1863         || GetNamedGetterOperation($interface);
1864 }
1865
1866 sub InstanceOverridesPut
1867 {
1868     my $interface = shift;
1869     return $interface->extendedAttributes->{CustomPut}
1870         || $interface->extendedAttributes->{Plugin}
1871         || GetIndexedSetterOperation($interface)
1872         || GetNamedSetterOperation($interface);
1873 }
1874
1875 sub InstanceOverridesDefineOwnProperty
1876 {
1877     my $interface = shift;
1878
1879     return 0 if $interface->extendedAttributes->{DefaultDefineOwnProperty};
1880
1881     return $interface->extendedAttributes->{CustomDefineOwnProperty}
1882         || GetIndexedSetterOperation($interface)
1883         || GetNamedSetterOperation($interface);
1884 }
1885
1886 sub InstanceOverridesDeleteProperty
1887 {
1888     my $interface = shift;
1889     return $interface->extendedAttributes->{CustomDeleteProperty}
1890         || GetNamedDeleterOperation($interface);
1891 }
1892
1893 sub PrototypeHasStaticPropertyTable
1894 {
1895     my $interface = shift;
1896     my $numConstants = @{$interface->constants};
1897     return $numConstants > 0 || PrototypePropertyCount($interface) > 0;
1898 }
1899
1900 sub InstanceNeedsVisitChildren
1901 {
1902     my $interface = shift;
1903     
1904     foreach my $attribute (@{$interface->attributes}) {
1905         return 1 if $attribute->extendedAttributes->{CachedAttribute};
1906     }
1907
1908     return 1 if $interface->extendedAttributes->{JSCustomMarkFunction};
1909     return 1 if $interface->extendedAttributes->{ReportExtraMemoryCost};
1910     return 0;
1911 }
1912
1913 sub InstanceNeedsEstimatedSize
1914 {
1915     my $interface = shift;
1916     return $interface->extendedAttributes->{ReportExtraMemoryCost};
1917 }
1918
1919 sub GetImplClassName
1920 {
1921     my $interface = shift;
1922
1923     return $interface->type->name;
1924 }
1925
1926 sub IsClassNameWordBoundary
1927 {
1928     my ($name, $i) = @_;
1929
1930     # Interpret negative numbers as distance from end of string, just as the substr function does.
1931     $i += length($name) if $i < 0;
1932
1933     return 0 if $i < 0;
1934     return 1 if $i == 0;
1935     return 1 if $i == length($name);
1936     return 0 if $i > length($name);
1937
1938     my $checkString = substr($name, $i - 1);
1939     return $checkString =~ /^[^A-Z][A-Z]/ || $checkString =~ /^[A-Z][A-Z][^A-Z]/;
1940 }
1941
1942 sub IsPrefixRemovable
1943 {
1944     my ($class, $name, $i) = @_;
1945
1946     return IsClassNameWordBoundary($name, $i)
1947         && (IsClassNameWordBoundary($class, $i) && substr($class, 0, $i) eq substr($name, 0, $i)
1948             || IsClassNameWordBoundary($class, -$i) && substr($class, -$i) eq substr($name, 0, $i));
1949 }
1950
1951 sub GetNestedClassName
1952 {
1953     my ($interface, $name) = @_;
1954
1955     my $class = GetImplClassName($interface);
1956     my $member = $codeGenerator->WK_ucfirst($name);
1957
1958     # Since the enumeration name will be nested in the class name's namespace, remove any words
1959     # that happen to match the start or end of the class name. If an enumeration is named TrackType or
1960     # TextTrackType, and the class is named TextTrack, then we will get a name like TextTrack::Type.
1961     my $memberLength = length($member);
1962     my $longestPrefixLength = 0;
1963     if ($member =~ /^[A-Z]./) {
1964         for (my $i = 2; $i < $memberLength - 1; $i++) {
1965             $longestPrefixLength = $i if IsPrefixRemovable($class, $member, $i);
1966         }
1967     }
1968     $member = substr($member, $longestPrefixLength);
1969
1970     return "${class}::$member";
1971 }
1972
1973 sub GetEnumerationClassName
1974 {
1975     my ($type, $interface) = @_;
1976
1977     assert("Not a type") if ref($type) ne "IDLType";
1978
1979     if ($codeGenerator->HasEnumImplementationNameOverride($type)) {
1980         return $codeGenerator->GetEnumImplementationNameOverride($type);
1981     }
1982
1983     my $name = $type->name;
1984
1985     return $name if $codeGenerator->IsExternalEnumType($type);
1986     return $name unless defined($interface);
1987
1988     return GetNestedClassName($interface, $name);
1989 }
1990
1991 sub GetEnumerationValueName
1992 {
1993     my ($name) = @_;
1994
1995     return "EmptyString" if $name eq "";
1996     $name = join("", map { $codeGenerator->WK_ucfirst($_) } split("-", $name));
1997     $name = "_$name" if $name =~ /^\d/;
1998     return $name;
1999 }
2000
2001 sub GenerateEnumerationHeader
2002 {
2003     my ($object, $enumeration, $className) = @_;
2004  
2005     # - Add default header template and header protection.
2006     push(@headerContentHeader, GenerateHeaderContentHeader($enumeration));
2007
2008     $headerIncludes{"${className}.h"} = 1;
2009
2010     push(@headerContent, "\nnamespace WebCore {\n\n");
2011     push(@headerContent, GenerateEnumerationHeaderContent($enumeration, $className));
2012     push(@headerContent, "} // namespace WebCore\n");
2013      
2014     my $conditionalString = $codeGenerator->GenerateConditionalString($enumeration);
2015     push(@headerContent, "\n#endif // ${conditionalString}\n") if $conditionalString;
2016 }
2017  
2018 sub GenerateEnumerationImplementation
2019 {
2020     my ($object, $enumeration, $className) = @_;
2021  
2022     # - Add default header template
2023     push(@implContentHeader, GenerateImplementationContentHeader($enumeration));
2024
2025     push(@implContent, "\nusing namespace JSC;\n\n");
2026     push(@implContent, "namespace WebCore {\n\n");
2027     push(@implContent, GenerateEnumerationImplementationContent($enumeration, $className));
2028     push(@implContent, "} // namespace WebCore\n");
2029      
2030     my $conditionalString = $codeGenerator->GenerateConditionalString($enumeration);
2031     push(@implContent, "\n#endif // ${conditionalString}\n") if $conditionalString;
2032 }
2033
2034 sub GenerateEnumerationImplementationContent
2035 {
2036     my ($enumeration, $className, $interface, $conditionalString) = @_;
2037
2038     # FIXME: A little ugly to have this be a side effect instead of a return value.
2039     AddToImplIncludes("<runtime/JSString.h>");
2040     AddToImplIncludes("<runtime/JSCInlines.h>");
2041     AddToImplIncludes("JSDOMConvertEnumeration.h");
2042
2043     my $result = "";
2044     $result .= "#if ${conditionalString}\n\n" if $conditionalString;
2045
2046     # FIXME: Change to take VM& instead of ExecState*.
2047     $result .= "template<> JSString* convertEnumerationToJS(ExecState& state, $className enumerationValue)\n";
2048     $result .= "{\n";
2049     AddToImplIncludes("<wtf/NeverDestroyed.h>");
2050     $result .= "    static const NeverDestroyed<String> values[] = {\n";
2051     foreach my $value (@{$enumeration->values}) {
2052         if ($value eq "") {
2053             $result .= "        emptyString(),\n";
2054         } else {
2055             $result .= "        MAKE_STATIC_STRING_IMPL(\"$value\"),\n";
2056         }
2057     }
2058     $result .= "    };\n";
2059     my $index = 0;
2060     foreach my $value (@{$enumeration->values}) {
2061         my $enumerationValueName = GetEnumerationValueName($value);
2062         $result .= "    static_assert(static_cast<size_t>(${className}::$enumerationValueName) == $index, \"${className}::$enumerationValueName is not $index as expected\");\n";
2063         $index++;
2064     }
2065     $result .= "    ASSERT(static_cast<size_t>(enumerationValue) < WTF_ARRAY_LENGTH(values));\n";
2066     $result .= "    return jsStringWithCache(&state, values[static_cast<size_t>(enumerationValue)]);\n";
2067     $result .= "}\n\n";
2068
2069     # FIXME: Change to take VM& instead of ExecState&.
2070     # FIXME: Consider using toStringOrNull to make exception checking faster.
2071     # FIXME: Consider finding a more efficient way to match against all the strings quickly.
2072     $result .= "template<> std::optional<$className> parseEnumeration<$className>(ExecState& state, JSValue value)\n";
2073     $result .= "{\n";
2074     $result .= "    auto stringValue = value.toWTFString(&state);\n";
2075     foreach my $value (@{$enumeration->values}) {
2076         my $enumerationValueName = GetEnumerationValueName($value);
2077         if ($value eq "") {
2078             $result .= "    if (stringValue.isEmpty())\n";
2079         } else {
2080             $result .= "    if (stringValue == \"$value\")\n";
2081         }
2082         $result .= "        return ${className}::${enumerationValueName};\n";
2083     }
2084     $result .= "    return std::nullopt;\n";
2085     $result .= "}\n\n";
2086
2087     $result .= "template<> const char* expectedEnumerationValues<$className>()\n";
2088     $result .= "{\n";
2089     $result .= "    return \"\\\"" . join ("\\\", \\\"", @{$enumeration->values}) . "\\\"\";\n";
2090     $result .= "}\n\n";
2091
2092     $result .= "#endif\n\n" if $conditionalString;
2093
2094     return $result;
2095 }
2096
2097 sub GenerateEnumerationsImplementationContent
2098 {
2099     my ($interface, $enumerations) = @_;
2100
2101     return "" unless @$enumerations;
2102
2103     my $result = "";
2104     foreach my $enumeration (@$enumerations) {
2105         my $className = GetEnumerationClassName($enumeration->type, $interface);
2106         my $conditionalString = $codeGenerator->GenerateConditionalString($enumeration);
2107         $result .= GenerateEnumerationImplementationContent($enumeration, $className, $interface, $conditionalString);
2108     }
2109     return $result;
2110 }
2111
2112 sub GenerateEnumerationHeaderContent
2113 {
2114     my ($enumeration, $className, $conditionalString) = @_;
2115
2116     $headerIncludes{"JSDOMConvertEnumeration.h"} = 1;
2117
2118     my $result = "";
2119     $result .= "#if ${conditionalString}\n\n" if $conditionalString;
2120
2121     my $exportMacro = GetExportMacroForJSClass($enumeration);
2122
2123     $result .= "template<> ${exportMacro}JSC::JSString* convertEnumerationToJS(JSC::ExecState&, $className);\n\n";
2124     $result .= "template<> ${exportMacro}std::optional<$className> parseEnumeration<$className>(JSC::ExecState&, JSC::JSValue);\n";
2125     $result .= "template<> ${exportMacro}const char* expectedEnumerationValues<$className>();\n\n";
2126     $result .= "#endif\n\n" if $conditionalString;
2127     
2128     return $result;
2129 }
2130
2131 sub GenerateEnumerationsHeaderContent
2132 {
2133     my ($interface, $enumerations) = @_;
2134
2135     return "" unless @$enumerations;
2136
2137     # FIXME: Could optimize this to only generate the parts of each enumeration that are actually
2138     # used, which would require iterating over everything in the interface.
2139
2140     my $result = "";
2141     foreach my $enumeration (@$enumerations) {
2142         my $className = GetEnumerationClassName($enumeration->type, $interface);
2143         my $conditionalString = $codeGenerator->GenerateConditionalString($enumeration);
2144         $result .= GenerateEnumerationHeaderContent($enumeration, $className, $conditionalString);
2145     }
2146     return $result;
2147 }
2148
2149 sub GetDictionaryClassName
2150 {
2151     my ($type, $interface) = @_;
2152
2153     if ($codeGenerator->HasDictionaryImplementationNameOverride($type)) {
2154         return $codeGenerator->GetDictionaryImplementationNameOverride($type);
2155     }
2156
2157     my $name = $type->name;
2158     return $name if $codeGenerator->IsExternalDictionaryType($type);
2159     return $name unless defined($interface);
2160     return GetNestedClassName($interface, $name);
2161 }
2162
2163 sub GenerateDefaultValue
2164 {
2165     my ($typeScope, $context, $type, $defaultValue) = @_;
2166
2167     if ($codeGenerator->IsStringType($type)) {
2168         my $useAtomicString = $type->extendedAttributes->{AtomicString};
2169         if ($defaultValue eq "null") {
2170             return $useAtomicString ? "nullAtom()" : "String()";
2171         } elsif ($defaultValue eq "\"\"") {
2172             return $useAtomicString ? "emptyAtom()" : "emptyString()";
2173         } else {
2174             return $useAtomicString ? "AtomicString(${defaultValue}, AtomicString::ConstructFromLiteral)" : "ASCIILiteral(${defaultValue})";
2175         }
2176     }
2177
2178     if ($codeGenerator->IsEnumType($type)) {
2179         # FIXME: Would be nice to report an error if the value does not have quote marks around it.
2180         # FIXME: Would be nice to report an error if the value is not one of the enumeration values.
2181         my $className = GetEnumerationClassName($type, $typeScope);
2182         my $enumerationValueName = GetEnumerationValueName(substr($defaultValue, 1, -1));
2183         return $className . "::" . $enumerationValueName;
2184     }
2185     if ($defaultValue eq "null") {
2186         if ($type->isUnion) {
2187             return "std::nullopt" if $type->isNullable;
2188
2189             my $IDLType = GetIDLType($typeScope, $type);
2190             return "convert<${IDLType}>(state, jsNull());";
2191         }
2192
2193         return "jsNull()" if $type->name eq "any";
2194         return "nullptr" if $codeGenerator->IsWrapperType($type) || $codeGenerator->IsBufferSourceType($type);
2195         return "String()" if $codeGenerator->IsStringType($type);
2196         return "std::nullopt";
2197     }
2198
2199     if ($defaultValue eq "[]") {
2200         my $IDLType = GetIDLType($typeScope, $type);
2201         return "Converter<${IDLType}>::ReturnType{ }";
2202     }
2203
2204     return "jsUndefined()" if $defaultValue eq "undefined";
2205     return "PNaN" if $defaultValue eq "NaN";
2206
2207     return $defaultValue;
2208 }
2209
2210 sub GenerateDictionaryHeaderContent
2211 {
2212     my ($dictionary, $className, $conditionalString) = @_;
2213
2214     $headerIncludes{"JSDOMConvertDictionary.h"} = 1;
2215
2216     my $result = "";
2217     $result .= "#if ${conditionalString}\n\n" if $conditionalString;
2218     $result .= "template<> ${className} convertDictionary<${className}>(JSC::ExecState&, JSC::JSValue);\n\n";
2219
2220     if ($dictionary->extendedAttributes->{JSGenerateToJSObject}) {
2221         $result .= "JSC::JSObject* convertDictionaryToJS(JSC::ExecState&, JSDOMGlobalObject&, const ${className}&);\n\n";
2222     }
2223
2224     $result .= "#endif\n\n" if $conditionalString;
2225     return $result;
2226 }
2227
2228 sub GenerateDictionariesHeaderContent
2229 {
2230     my ($typeScope, $allDictionaries) = @_;
2231
2232     return "" unless @$allDictionaries;
2233
2234     my $result = "";
2235     foreach my $dictionary (@$allDictionaries) {
2236         $headerIncludes{$typeScope->type->name . ".h"} = 1 if $typeScope;
2237         my $className = GetDictionaryClassName($dictionary->type, $typeScope);
2238         my $conditionalString = $codeGenerator->GenerateConditionalString($dictionary);
2239         $result .= GenerateDictionaryHeaderContent($dictionary, $className, $conditionalString);
2240     }
2241     return $result;
2242 }
2243
2244 sub GenerateDictionaryImplementationContent
2245 {
2246     my ($dictionary, $className, $interface) = @_;
2247
2248     my $result = "";
2249
2250     my $name = $dictionary->type->name;
2251     my $typeScope = $interface || $dictionary;
2252
2253     my $conditional = $dictionary->extendedAttributes->{Conditional};
2254     if ($conditional) {
2255         my $conditionalString = $codeGenerator->GenerateConditionalStringFromAttributeValue($conditional);
2256         $result .= "#if ${conditionalString}\n\n";
2257     }
2258
2259     # FIXME: A little ugly to have this be a side effect instead of a return value.
2260     AddToImplIncludes("<runtime/JSCInlines.h>");
2261     AddToImplIncludes("JSDOMConvertDictionary.h");
2262
2263     # https://heycam.github.io/webidl/#es-dictionary
2264     $result .= "template<> $className convertDictionary<$className>(ExecState& state, JSValue value)\n";
2265     $result .= "{\n";
2266     $result .= "    VM& vm = state.vm();\n";
2267     $result .= "    auto throwScope = DECLARE_THROW_SCOPE(vm);\n";
2268     $result .= "    bool isNullOrUndefined = value.isUndefinedOrNull();\n";
2269     $result .= "    auto* object = isNullOrUndefined ? nullptr : value.getObject();\n";
2270
2271     # 1. If Type(V) is not Undefined, Null or Object, then throw a TypeError.
2272     $result .= "    if (UNLIKELY(!isNullOrUndefined && !object)) {\n";
2273     $result .= "        throwTypeError(&state, throwScope);\n";
2274     $result .= "        return { };\n";
2275     $result .= "    }\n";
2276
2277     # 2. Let dict be an empty dictionary value of type D; every dictionary member is initially considered to be not present.
2278
2279     # 3. Let dictionaries be a list consisting of D and all of D’s inherited dictionaries, in order from least to most derived.
2280     my @dictionaries;
2281     push(@dictionaries, $dictionary);
2282     my $parentType = $dictionary->parentType;
2283     while (defined($parentType)) {
2284         my $parentDictionary = $codeGenerator->GetDictionaryByType($parentType);
2285         assert("Unable to find definition for dictionary named '" . $parentType->name . "'!") unless defined($parentDictionary);
2286         unshift(@dictionaries, $parentDictionary);
2287         $parentType = $parentDictionary->parentType;
2288     }
2289
2290     my $arguments = "";
2291     my $comma = "";
2292
2293     $result .= "    $className result;\n";
2294
2295     # 4. For each dictionary dictionary in dictionaries, in order:
2296     foreach my $dictionary (@dictionaries) {
2297         # For each dictionary member member declared on dictionary, in lexicographical order:
2298         my @sortedMembers = sort { $a->name cmp $b->name } @{$dictionary->members};
2299         foreach my $member (@sortedMembers) {
2300             $member->default("undefined") if $member->type->name eq "any" and !defined($member->default); # Use undefined as default value for member of type 'any' unless specified otherwise.
2301
2302             my $type = $member->type;
2303             AddToImplIncludesForIDLType($type);
2304
2305             # 4.1. Let key be the identifier of member.
2306             my $key = $member->name;
2307             my $implementedAsKey = $member->extendedAttributes->{ImplementedAs} || $key;
2308
2309             # 4.2. Let value be an ECMAScript value, depending on Type(V):
2310             $result .= "    JSValue ${key}Value = isNullOrUndefined ? jsUndefined() : object->get(&state, Identifier::fromString(&state, \"${key}\"));\n";
2311
2312             my $IDLType = GetIDLType($typeScope, $type);
2313
2314             # 4.3. If value is not undefined, then:
2315             $result .= "    if (!${key}Value.isUndefined()) {\n";
2316
2317             my $nativeValue = JSValueToNative($typeScope, $member, "${key}Value", $member->extendedAttributes->{Conditional}, "&state", "state");
2318             $result .= "        result.$implementedAsKey = $nativeValue;\n";
2319             $result .= "        RETURN_IF_EXCEPTION(throwScope, { });\n";
2320
2321             # Value is undefined.
2322             # 4.4. Otherwise, if value is undefined but the dictionary member has a default value, then:
2323             if (!$member->isRequired && defined $member->default) {
2324                 $result .= "    } else\n";
2325                 $result .= "        result.$implementedAsKey = " . GenerateDefaultValue($typeScope, $member, $member->type, $member->default) . ";\n";
2326             } elsif ($member->isRequired) {
2327                 # 4.5. Otherwise, if value is undefined and the dictionary member is a required dictionary member, then throw a TypeError.
2328                 $result .= "    } else {\n";
2329                 $result .= "        throwRequiredMemberTypeError(state, throwScope, \"". $member->name ."\", \"$name\", \"". GetTypeNameForDisplayInException($type) ."\");\n";
2330                 $result .= "        return { };\n";
2331                 $result .= "    }\n";
2332             } else {
2333                 $result .= "    }\n";
2334             }
2335         }
2336     }
2337
2338     # 5. Return dict.
2339     $result .= "    return result;\n";
2340     $result .= "}\n\n";
2341
2342     if ($dictionary->extendedAttributes->{JSGenerateToJSObject}) {
2343         AddToImplIncludes("JSDOMGlobalObject.h");
2344         AddToImplIncludes("<runtime/ObjectConstructor.h>");
2345
2346         $result .= "JSC::JSObject* convertDictionaryToJS(JSC::ExecState& state, JSDOMGlobalObject& globalObject, const ${className}& dictionary)\n";
2347         $result .= "{\n";
2348         $result .= "    auto& vm = state.vm();\n\n";
2349
2350         # 1. Let O be ! ObjectCreate(%ObjectPrototype%).
2351         $result .= "    auto result = constructEmptyObject(&state, globalObject.objectPrototype());\n\n";
2352
2353         # 2. Let dictionaries be a list consisting of D and all of D’s inherited dictionaries,
2354         #    in order from least to most derived.
2355         #    NOTE: This was done above.
2356
2357         # 3. For each dictionary dictionary in dictionaries, in order:
2358         foreach my $dictionary (@dictionaries) {
2359             # 3.1. For each dictionary member member declared on dictionary, in lexicographical order:
2360             my @sortedMembers = sort { $a->name cmp $b->name } @{$dictionary->members};
2361             foreach my $member (@sortedMembers) {
2362                 my $key = $member->name;
2363                 my $implementedAsKey = $member->extendedAttributes->{ImplementedAs} || $key;
2364                 my $valueExpression = "dictionary.${implementedAsKey}";
2365
2366                 # 1. Let key be the identifier of member.
2367                 # 2. If the dictionary member named key is present in V, then:
2368                     # 1. Let idlValue be the value of member on V.
2369                     # 2. Let value be the result of converting idlValue to an ECMAScript value.
2370                     # 3. Perform ! CreateDataProperty(O, key, value).
2371
2372                 if (!$member->isRequired && not defined $member->default) {
2373                     my $IDLType = GetIDLType($typeScope, $member->type);
2374                     my $conversionExpression = NativeToJSValueUsingReferences($member, $typeScope, "${IDLType}::extractValueFromNullable(${valueExpression})", "globalObject");
2375
2376                     $result .= "    if (!${IDLType}::isNullValue(${valueExpression})) {\n";
2377                     $result .= "        auto ${key}Value = ${conversionExpression};\n";
2378                     $result .= "        result->putDirect(vm, JSC::Identifier::fromString(&vm, \"${key}\"), ${key}Value);\n";
2379                     $result .= "    }\n";
2380                 } else {
2381                     my $conversionExpression = NativeToJSValueUsingReferences($member, $typeScope, $valueExpression, "globalObject");
2382
2383                     $result .= "    auto ${key}Value = ${conversionExpression};\n";
2384                     $result .= "    result->putDirect(vm, JSC::Identifier::fromString(&vm, \"${key}\"), ${key}Value);\n";
2385                 }
2386             }
2387         }
2388
2389         $result .= "    return result;\n";
2390         $result .= "}\n\n";
2391     }
2392
2393     $result .= "#endif\n\n" if $conditional;
2394
2395     return $result;
2396 }
2397
2398 sub GenerateDictionariesImplementationContent
2399 {
2400     my ($typeScope, $allDictionaries) = @_;
2401
2402     my $result = "";
2403     foreach my $dictionary (@$allDictionaries) {
2404         my $className = GetDictionaryClassName($dictionary->type, $typeScope);
2405         $result .= GenerateDictionaryImplementationContent($dictionary, $className, $typeScope);
2406     }
2407     return $result;
2408 }
2409
2410 sub GetJSTypeForNode
2411 {
2412     my ($interface) = @_;
2413
2414     if ($codeGenerator->InheritsInterface($interface, "Document")) {
2415         return "JSDocumentWrapperType";
2416     }
2417     if ($codeGenerator->InheritsInterface($interface, "DocumentFragment")) {
2418         return "JSDocumentFragmentNodeType";
2419     }
2420     if ($codeGenerator->InheritsInterface($interface, "DocumentType")) {
2421         return "JSDocumentTypeNodeType";
2422     }
2423     if ($codeGenerator->InheritsInterface($interface, "ProcessingInstruction")) {
2424         return "JSProcessingInstructionNodeType";
2425     }
2426     if ($codeGenerator->InheritsInterface($interface, "CDATASection")) {
2427         return "JSCDATASectionNodeType";
2428     }
2429     if ($codeGenerator->InheritsInterface($interface, "Attr")) {
2430         return "JSAttrNodeType";
2431     }
2432     if ($codeGenerator->InheritsInterface($interface, "Comment")) {
2433         return "JSCommentNodeType";
2434     }
2435     if ($codeGenerator->InheritsInterface($interface, "Text")) {
2436         return "JSTextNodeType";
2437     }
2438     if ($codeGenerator->InheritsInterface($interface, "Element")) {
2439         return "JSElementType";
2440     }
2441     return "JSNodeType";
2442 }
2443
2444 sub GenerateHeader
2445 {
2446     my ($object, $interface, $enumerations, $dictionaries) = @_;
2447
2448     my $interfaceName = $interface->type->name;
2449     my $className = "JS$interfaceName";
2450     my %structureFlags = ();
2451
2452     my $hasParent = $interface->parentType || $interface->extendedAttributes->{JSLegacyParent};
2453     my $parentClassName = GetParentClassName($interface);
2454     my $needsVisitChildren = InstanceNeedsVisitChildren($interface);
2455
2456     # - Add default header template and header protection
2457     push(@headerContentHeader, GenerateHeaderContentHeader($interface));
2458
2459     if ($hasParent) {
2460         $headerIncludes{"$parentClassName.h"} = 1;
2461     } else {
2462         $headerIncludes{"JSDOMWrapper.h"} = 1;
2463         if ($interface->isException) {
2464             $headerIncludes{"<runtime/ErrorPrototype.h>"} = 1;
2465         }
2466     }
2467
2468     $headerIncludes{"$interfaceName.h"} = 1 if $hasParent && $interface->extendedAttributes->{JSGenerateToNativeObject};
2469
2470     $headerIncludes{"SVGElement.h"} = 1 if $className =~ /^JSSVG/;
2471
2472     my $implType = GetImplClassName($interface);
2473
2474     my $numConstants = @{$interface->constants};
2475     my $numAttributes = @{$interface->attributes};
2476     my $numOperations = @{$interface->operations};
2477
2478     push(@headerContent, "\nnamespace WebCore {\n\n");
2479
2480     if ($codeGenerator->IsSVGAnimatedType($interface->type)) {
2481         $headerIncludes{"$interfaceName.h"} = 1;
2482     } else {
2483         # Implementation class forward declaration
2484         if (IsDOMGlobalObject($interface)) {
2485             AddClassForwardIfNeeded($interface->type);
2486         }
2487     }
2488
2489     push(@headerContent, "class JSDOMWindowProxy;\n\n") if $interfaceName eq "DOMWindow";
2490
2491     my $exportMacro = GetExportMacroForJSClass($interface);
2492
2493     # Class declaration
2494     push(@headerContent, "class $exportMacro$className : public $parentClassName {\n");
2495
2496     # Static create methods
2497     push(@headerContent, "public:\n");
2498     push(@headerContent, "    using Base = $parentClassName;\n");
2499     push(@headerContent, "    using DOMWrapped = $implType;\n") if $hasParent;
2500
2501     if ($interfaceName eq "DOMWindow") {
2502         push(@headerContent, "    static $className* create(JSC::VM& vm, JSC::Structure* structure, Ref<$implType>&& impl, JSDOMWindowProxy* proxy)\n");
2503         push(@headerContent, "    {\n");
2504         push(@headerContent, "        $className* ptr = new (NotNull, JSC::allocateCell<$className>(vm.heap)) ${className}(vm, structure, WTFMove(impl), proxy);\n");
2505         push(@headerContent, "        ptr->finishCreation(vm, proxy);\n");
2506         push(@headerContent, "        return ptr;\n");
2507         push(@headerContent, "    }\n\n");
2508     } elsif ($codeGenerator->InheritsInterface($interface, "WorkerGlobalScope")) {
2509         push(@headerContent, "    static $className* create(JSC::VM& vm, JSC::Structure* structure, Ref<$implType>&& impl, JSC::JSProxy* proxy)\n");
2510         push(@headerContent, "    {\n");
2511         push(@headerContent, "        $className* ptr = new (NotNull, JSC::allocateCell<$className>(vm.heap)) ${className}(vm, structure, WTFMove(impl));\n");
2512         push(@headerContent, "        ptr->finishCreation(vm, proxy);\n");
2513         push(@headerContent, "        return ptr;\n");
2514         push(@headerContent, "    }\n\n");
2515     } elsif ($interface->extendedAttributes->{MasqueradesAsUndefined}) {
2516         AddIncludesForImplementationTypeInHeader($implType);
2517         push(@headerContent, "    static $className* create(JSC::Structure* structure, JSDOMGlobalObject* globalObject, Ref<$implType>&& impl)\n");
2518         push(@headerContent, "    {\n");
2519         push(@headerContent, "        globalObject->masqueradesAsUndefinedWatchpoint()->fireAll(globalObject->vm(), \"Allocated masquerading object\");\n");
2520         push(@headerContent, "        $className* ptr = new (NotNull, JSC::allocateCell<$className>(globalObject->vm().heap)) $className(structure, *globalObject, WTFMove(impl));\n");
2521         push(@headerContent, "        ptr->finishCreation(globalObject->vm());\n");
2522         push(@headerContent, "        return ptr;\n");
2523         push(@headerContent, "    }\n\n");
2524     } elsif (!NeedsImplementationClass($interface)) {
2525         push(@headerContent, "    static $className* create(JSC::Structure* structure, JSDOMGlobalObject* globalObject)\n");
2526         push(@headerContent, "    {\n");
2527         push(@headerContent, "        $className* ptr = new (NotNull, JSC::allocateCell<$className>(globalObject->vm().heap)) $className(structure, *globalObject);\n");
2528         push(@headerContent, "        ptr->finishCreation(globalObject->vm());\n");
2529         push(@headerContent, "        return ptr;\n");
2530         push(@headerContent, "    }\n\n");  
2531     } else {
2532         AddIncludesForImplementationTypeInHeader($implType);
2533         push(@headerContent, "    static $className* create(JSC::Structure* structure, JSDOMGlobalObject* globalObject, Ref<$implType>&& impl)\n");
2534         push(@headerContent, "    {\n");
2535         push(@headerContent, "        $className* ptr = new (NotNull, JSC::allocateCell<$className>(globalObject->vm().heap)) $className(structure, *globalObject, WTFMove(impl));\n");
2536         push(@headerContent, "        ptr->finishCreation(globalObject->vm());\n");
2537         push(@headerContent, "        return ptr;\n");
2538         push(@headerContent, "    }\n\n");
2539     }
2540
2541     push(@headerContent, "    static const bool needsDestruction = false;\n\n") if IsDOMGlobalObject($interface);
2542
2543     $structureFlags{"JSC::HasStaticPropertyTable"} = 1 if InstancePropertyCount($interface) > 0;
2544     $structureFlags{"JSC::NewImpurePropertyFiresWatchpoints"} = 1 if $interface->extendedAttributes->{NewImpurePropertyFiresWatchpoints};
2545     $structureFlags{"JSC::IsImmutablePrototypeExoticObject"} = 1 if $interface->extendedAttributes->{IsImmutablePrototypeExoticObject};
2546     $structureFlags{"JSC::MasqueradesAsUndefined"} = 1 if $interface->extendedAttributes->{MasqueradesAsUndefined};
2547     $structureFlags{"JSC::ImplementsHasInstance | JSC::ImplementsDefaultHasInstance"} = 1 if $interfaceName eq "DOMWindow";
2548         
2549     # Prototype
2550     unless (ShouldUseGlobalObjectPrototype($interface)) {
2551         push(@headerContent, "    static JSC::JSObject* createPrototype(JSC::VM&, JSDOMGlobalObject&);\n");
2552         push(@headerContent, "    static JSC::JSObject* prototype(JSC::VM&, JSDOMGlobalObject&);\n");
2553     }
2554
2555     # JSValue to implementation type
2556     if (ShouldGenerateToWrapped($hasParent, $interface)) {
2557         # FIXME: Add extended attribute for this.
2558         my @toWrappedArguments = ();
2559         push(@toWrappedArguments, "JSC::VM&");
2560         push(@toWrappedArguments, "JSC::ExecState&") if $interface->type->name eq "XPathNSResolver";
2561         push(@toWrappedArguments, "JSC::JSValue");
2562
2563         my $toWrappedType = $interface->type->name eq "XPathNSResolver" ? "RefPtr<${implType}>" : "${implType}*";
2564
2565         my $export = "";
2566         $export = "WEBCORE_EXPORT " if $interface->extendedAttributes->{ExportToWrappedFunction};
2567         push(@headerContent, "    static ${export}${toWrappedType} toWrapped(" . join(", ", @toWrappedArguments) . ");\n");
2568     }
2569
2570     $headerTrailingIncludes{"${className}Custom.h"} = 1 if $interface->extendedAttributes->{JSCustomHeader};
2571
2572     my $namedGetterOperation = GetNamedGetterOperation($interface);
2573     my $indexedGetterOperation = GetIndexedGetterOperation($interface);
2574
2575     # FIXME: Why doesn't this also include Indexed Getters and [CustomGetOwnPropertySlot]
2576     if ($namedGetterOperation) {
2577         if ($codeGenerator->InheritsExtendedAttribute($interface, "OverrideBuiltins")) {
2578             $structureFlags{"JSC::GetOwnPropertySlotIsImpure"} = 1;
2579         } else {
2580             $structureFlags{"JSC::GetOwnPropertySlotIsImpureForPropertyAbsence"} = 1;
2581         }
2582     }
2583     
2584     # ClassInfo MethodTable declarations.
2585     
2586     if (InstanceOverridesGetOwnPropertySlot($interface)) {
2587         push(@headerContent, "    static bool getOwnPropertySlot(JSC::JSObject*, JSC::ExecState*, JSC::PropertyName, JSC::PropertySlot&);\n");
2588         $structureFlags{"JSC::OverridesGetOwnPropertySlot"} = 1;
2589         push(@headerContent, "    static bool getOwnPropertySlotByIndex(JSC::JSObject*, JSC::ExecState*, unsigned propertyName, JSC::PropertySlot&);\n");
2590         $structureFlags{"JSC::InterceptsGetOwnPropertySlotByIndexEvenWhenLengthIsNotZero"} = 1;
2591     }
2592     
2593     if (InstanceOverridesGetOwnPropertyNames($interface)) {
2594         push(@headerContent, "    static void getOwnPropertyNames(JSC::JSObject*, JSC::ExecState*, JSC::PropertyNameArray&, JSC::EnumerationMode = JSC::EnumerationMode());\n");
2595         $structureFlags{"JSC::OverridesGetPropertyNames"} = 1;
2596     }
2597     
2598     if (InstanceOverridesPut($interface)) {
2599         push(@headerContent, "    static bool put(JSC::JSCell*, JSC::ExecState*, JSC::PropertyName, JSC::JSValue, JSC::PutPropertySlot&);\n");
2600         push(@headerContent, "    static bool putByIndex(JSC::JSCell*, JSC::ExecState*, unsigned propertyName, JSC::JSValue, bool shouldThrow);\n");
2601     }
2602     
2603     if (InstanceOverridesDefineOwnProperty($interface)) {
2604         push(@headerContent, "    static bool defineOwnProperty(JSC::JSObject*, JSC::ExecState*, JSC::PropertyName, const JSC::PropertyDescriptor&, bool shouldThrow);\n");
2605     }
2606
2607     if (InstanceOverridesDeleteProperty($interface)) {
2608         push(@headerContent, "    static bool deleteProperty(JSC::JSCell*, JSC::ExecState*, JSC::PropertyName);\n");
2609         push(@headerContent, "    static bool deletePropertyByIndex(JSC::JSCell*, JSC::ExecState*, unsigned);\n");
2610     }
2611
2612     if (InstanceOverridesGetCallData($interface)) {
2613         push(@headerContent, "    static JSC::CallType getCallData(JSC::JSCell*, JSC::CallData&);\n\n");
2614         $headerIncludes{"<runtime/CallData.h>"} = 1;
2615         $structureFlags{"JSC::TypeOfShouldCallGetCallData"} = 1;
2616     }
2617     
2618     if ($interface->extendedAttributes->{CustomGetPrototype}) {
2619         push(@headerContent, "    static JSC::JSValue getPrototype(JSC::JSObject*, JSC::ExecState*);\n");
2620     }
2621     
2622     if ($interface->extendedAttributes->{CustomToStringName}) {
2623         push(@headerContent, "    static String toStringName(const JSC::JSObject*, JSC::ExecState*);\n");
2624     }
2625     
2626     if ($interface->extendedAttributes->{CustomPreventExtensions}) {
2627         push(@headerContent, "    static bool preventExtensions(JSC::JSObject*, JSC::ExecState*);\n");
2628     }
2629     
2630     if (InstanceNeedsEstimatedSize($interface)) {
2631         push(@headerContent, "    static size_t estimatedSize(JSCell*);\n");
2632     }
2633     
2634     if (!$hasParent) {
2635         push(@headerContent, "    static void destroy(JSC::JSCell*);\n");
2636     }
2637
2638     # Class info
2639     if ($interfaceName eq "Node") {
2640         push(@headerContent, "\n");
2641         push(@headerContent, "protected:\n");
2642         push(@headerContent, "    static const JSC::ClassInfo s_info;\n");
2643         push(@headerContent, "public:\n");
2644         push(@headerContent, "    static constexpr const JSC::ClassInfo* info() { return &s_info; }\n\n");
2645     } else {
2646         push(@headerContent, "\n");
2647         push(@headerContent, "    DECLARE_INFO;\n\n");
2648     }
2649
2650     # Structure ID
2651     push(@headerContent, "    static JSC::Structure* createStructure(JSC::VM& vm, JSC::JSGlobalObject* globalObject, JSC::JSValue prototype)\n");
2652     push(@headerContent, "    {\n");
2653     if (IsDOMGlobalObject($interface)) {
2654         push(@headerContent, "        return JSC::Structure::create(vm, globalObject, prototype, JSC::TypeInfo(JSC::GlobalObjectType, StructureFlags), info());\n");
2655     } elsif ($codeGenerator->InheritsInterface($interface, "Node")) {
2656         my $type = GetJSTypeForNode($interface);
2657         push(@headerContent, "        return JSC::Structure::create(vm, globalObject, prototype, JSC::TypeInfo(JSC::JSType($type), StructureFlags), info());\n");
2658     } elsif ($codeGenerator->InheritsInterface($interface, "Event")) {
2659         push(@headerContent, "        return JSC::Structure::create(vm, globalObject, prototype, JSC::TypeInfo(JSC::JSType(JSEventType), StructureFlags), info());\n");
2660     } else {
2661         push(@headerContent, "        return JSC::Structure::create(vm, globalObject, prototype, JSC::TypeInfo(JSC::ObjectType, StructureFlags), info());\n");
2662     }
2663     push(@headerContent, "    }\n\n");
2664
2665     # Custom pushEventHandlerScope function
2666     if ($interface->extendedAttributes->{CustomPushEventHandlerScope}) {
2667         push(@headerContent, "    JSC::JSScope* pushEventHandlerScope(JSC::ExecState*, JSC::JSScope*) const;\n\n");
2668     }
2669     
2670     # Constructor object getter
2671     unless ($interface->extendedAttributes->{NoInterfaceObject}) {
2672         push(@headerContent, "    static JSC::JSValue getConstructor(JSC::VM&, const JSC::JSGlobalObject*);\n");
2673         push(@headerContent, "    static JSC::JSValue getNamedConstructor(JSC::VM&, JSC::JSGlobalObject*);\n") if $interface->extendedAttributes->{NamedConstructor};
2674     }
2675
2676     # Serializer function.
2677     if ($interface->serializable) {
2678         push(@headerContent, "    static JSC::JSObject* serialize(JSC::ExecState&, ${className}& thisObject, JSDOMGlobalObject&, JSC::ThrowScope&);\n");
2679     }
2680     
2681     my $numCustomOperations = 0;
2682     my $numCustomAttributes = 0;
2683
2684     my $hasForwardDeclaringOperations = 0;
2685     my $hasForwardDeclaringAttributes = 0;
2686
2687     my $hasDOMJITAttributes = 0;
2688
2689     # Attribute and function enums
2690     if ($numAttributes > 0) {
2691         foreach my $attribute (@{$interface->attributes}) {
2692             $numCustomAttributes++ if HasCustomGetter($attribute);
2693             $numCustomAttributes++ if HasCustomSetter($attribute);
2694             if ($attribute->extendedAttributes->{CachedAttribute}) {
2695                 my $conditionalString = $codeGenerator->GenerateConditionalString($attribute);
2696                 push(@headerContent, "#if ${conditionalString}\n") if $conditionalString;
2697                 push(@headerContent, "    mutable JSC::WriteBarrier<JSC::Unknown> m_" . $attribute->name . ";\n");
2698                 $numCachedAttributes++;
2699                 push(@headerContent, "#endif\n") if $conditionalString;
2700             }
2701             $hasDOMJITAttributes = 1 if $attribute->extendedAttributes->{DOMJIT};
2702
2703             $hasForwardDeclaringAttributes = 1 if $attribute->extendedAttributes->{ForwardDeclareInHeader};
2704         }
2705     }
2706
2707     # visit function
2708     if ($needsVisitChildren) {
2709         push(@headerContent, "    static void visitChildren(JSCell*, JSC::SlotVisitor&);\n");
2710         push(@headerContent, "    void visitAdditionalChildren(JSC::SlotVisitor&);\n") if $interface->extendedAttributes->{JSCustomMarkFunction};
2711         push(@headerContent, "\n");
2712
2713         if ($interface->extendedAttributes->{JSCustomMarkFunction}) {
2714             # We assume that the logic in visitAdditionalChildren is highly volatile, and during a
2715             # concurrent GC or in between eden GCs something may happen that would lead to this
2716             # logic behaving differently. Since this could mark objects or add opaque roots, this
2717             # means that after any increment of mutator resumption in a concurrent GC and at least
2718             # once during any eden GC we need to re-execute visitAdditionalChildren on any objects
2719             # that we had executed it on before. We do this using the DOM's own MarkingConstraint,
2720             # which will call visitOutputConstraints on all objects in the DOM's own
2721             # outputConstraintSubspace. visitOutputConstraints is the name JSC uses for the method
2722             # that the GC calls to ask an object is it would like to mark anything else after the
2723             # program resumed since the last call to visitChildren or visitOutputConstraints. Since
2724             # this just calls visitAdditionalChildren, you usually don't have to worry about this.
2725             push(@headerContent, "    static void visitOutputConstraints(JSCell*, JSC::SlotVisitor&);\n");
2726             my $subspaceFunc = IsDOMGlobalObject($interface) ? "globalObjectOutputConstraintSubspaceFor" : "outputConstraintSubspaceFor";
2727             push(@headerContent, "    template<typename> static JSC::Subspace* subspaceFor(JSC::VM& vm) { return $subspaceFunc(vm); }\n");
2728         }
2729     }
2730     
2731     if ($numCustomAttributes > 0) {
2732         push(@headerContent, "\n    // Custom attributes\n");
2733
2734         foreach my $attribute (@{$interface->attributes}) {
2735             my $conditionalString = $codeGenerator->GenerateConditionalString($attribute);
2736             if (HasCustomGetter($attribute)) {
2737                 push(@headerContent, "#if ${conditionalString}\n") if $conditionalString;
2738                 my $methodName = $codeGenerator->WK_lcfirst($attribute->name);
2739                 push(@headerContent, "    JSC::JSValue " . $methodName . "(JSC::ExecState&) const;\n");
2740                 push(@headerContent, "#endif\n") if $conditionalString;
2741             }
2742             if (HasCustomSetter($attribute) && !IsReadonly($attribute)) {
2743                 push(@headerContent, "#if ${conditionalString}\n") if $conditionalString;
2744                 push(@headerContent, "    void set" . $codeGenerator->WK_ucfirst($attribute->name) . "(JSC::ExecState&, JSC::JSValue);\n");
2745                 push(@headerContent, "#endif\n") if $conditionalString;
2746             }
2747         }
2748     }
2749
2750     foreach my $operation (@{$interface->operations}) {
2751         $numCustomOperations++ if HasCustomMethod($operation);
2752         $hasForwardDeclaringOperations = 1 if $operation->extendedAttributes->{ForwardDeclareInHeader};
2753     }
2754
2755     if ($numCustomOperations > 0) {
2756         my $inAppleCopyright = 0;
2757         push(@headerContent, "\n    // Custom functions\n");
2758         foreach my $operation (@{$interface->operations}) {
2759             next unless HasCustomMethod($operation);
2760             next if $operation->{overloads} && $operation->{overloadIndex} != 1;
2761
2762             if ($operation->extendedAttributes->{AppleCopyright}) {
2763                 if (!$inAppleCopyright) {
2764                     push(@headerContent, $beginAppleCopyrightForHeaderFiles);
2765                     $inAppleCopyright = 1;
2766                 }
2767             } elsif ($inAppleCopyright) {
2768                 push(@headerContent, $endAppleCopyright);
2769                 $inAppleCopyright = 0;
2770             }
2771
2772             my $conditionalString = $codeGenerator->GenerateConditionalString($operation);
2773             push(@headerContent, "#if ${conditionalString}\n") if $conditionalString;
2774
2775             my $functionImplementationName = $operation->extendedAttributes->{ImplementedAs} || $codeGenerator->WK_lcfirst($operation->name);
2776
2777             my @functionArguments = ();
2778             push(@functionArguments, "JSC::ExecState&");
2779             push(@functionArguments, "Ref<DeferredPromise>&&") if $codeGenerator->IsPromiseType($operation->type) && !$operation->extendedAttributes->{ReturnsOwnPromise};
2780
2781             push(@headerContent, "    " . ($operation->isStatic ? "static " : "") . "JSC::JSValue " . $functionImplementationName . "(" . join(", ", @functionArguments) . ");\n");
2782
2783             push(@headerContent, "#endif\n") if $conditionalString;
2784         }
2785         push(@headerContent, $endAppleCopyright) if $inAppleCopyright;
2786     }
2787
2788     if (NeedsImplementationClass($interface)) {
2789         if ($hasParent) {
2790             push(@headerContent, "    $interfaceName& wrapped() const\n");
2791             push(@headerContent, "    {\n");
2792             push(@headerContent, "        return static_cast<$interfaceName&>(Base::wrapped());\n");
2793             push(@headerContent, "    }\n");
2794         }
2795     }
2796
2797     # structure flags
2798     if (%structureFlags) {
2799         push(@headerContent, "public:\n");
2800         push(@headerContent, "    static const unsigned StructureFlags = ");
2801         foreach my $structureFlag (sort (keys %structureFlags)) {
2802             push(@headerContent, $structureFlag . " | ");
2803         }
2804         push(@headerContent, "Base::StructureFlags;\n");
2805     }
2806
2807     push(@headerContent, "protected:\n");
2808
2809     # Constructor
2810     if ($interfaceName eq "DOMWindow") {
2811         push(@headerContent, "    $className(JSC::VM&, JSC::Structure*, Ref<$implType>&&, JSDOMWindowProxy*);\n");
2812     } elsif ($codeGenerator->InheritsInterface($interface, "WorkerGlobalScope")) {
2813         push(@headerContent, "    $className(JSC::VM&, JSC::Structure*, Ref<$implType>&&);\n");
2814     } elsif (!NeedsImplementationClass($interface)) {
2815         push(@headerContent, "    $className(JSC::Structure*, JSDOMGlobalObject&);\n\n");
2816      } else {
2817         push(@headerContent, "    $className(JSC::Structure*, JSDOMGlobalObject&, Ref<$implType>&&);\n\n");
2818     }
2819
2820     if ($interfaceName eq "DOMWindow") {
2821         push(@headerContent, "    void finishCreation(JSC::VM&, JSDOMWindowProxy*);\n");
2822     } elsif ($codeGenerator->InheritsInterface($interface, "WorkerGlobalScope")) {
2823         push(@headerContent, "    void finishCreation(JSC::VM&, JSC::JSProxy*);\n");
2824     } else {
2825         push(@headerContent, "    void finishCreation(JSC::VM&);\n");
2826     }
2827
2828     push(@headerContent, "};\n\n");
2829
2830     if (ShouldGenerateWrapperOwnerCode($hasParent, $interface)) {
2831         if ($interfaceName ne "Node" && $codeGenerator->InheritsInterface($interface, "Node")) {
2832             $headerIncludes{"JSNode.h"} = 1;
2833             push(@headerContent, "class JS${interfaceName}Owner : public JSNodeOwner {\n");
2834         } else {
2835             push(@headerContent, "class JS${interfaceName}Owner : public JSC::WeakHandleOwner {\n");
2836         }
2837         $headerIncludes{"<wtf/NeverDestroyed.h>"} = 1;
2838         push(@headerContent, "public:\n");
2839         push(@headerContent, "    virtual bool isReachableFromOpaqueRoots(JSC::Handle<JSC::Unknown>, void* context, JSC::SlotVisitor&);\n");
2840         push(@headerContent, "    virtual void finalize(JSC::Handle<JSC::Unknown>, void* context);\n");
2841         push(@headerContent, "};\n");
2842         push(@headerContent, "\n");
2843         push(@headerContent, "inline JSC::WeakHandleOwner* wrapperOwner(DOMWrapperWorld&, $implType*)\n");
2844         push(@headerContent, "{\n");
2845         push(@headerContent, "    static NeverDestroyed<JS${interfaceName}Owner> owner;\n");
2846         push(@headerContent, "    return &owner.get();\n");
2847         push(@headerContent, "}\n");
2848         push(@headerContent, "\n");
2849         push(@headerContent, "inline void* wrapperKey($implType* wrappableObject)\n");
2850         push(@headerContent, "{\n");
2851         push(@headerContent, "    return wrappableObject;\n");
2852         push(@headerContent, "}\n");
2853         push(@headerContent, "\n");
2854     }
2855     if (ShouldGenerateToJSDeclaration($hasParent, $interface)) {
2856         # Node and NodeList have custom inline implementations which thus cannot be exported.
2857         # FIXME: The special case for Node and NodeList should probably be implemented via an IDL attribute.
2858         if ($implType eq "Node" or $implType eq "NodeList") {
2859             push(@headerContent, "JSC::JSValue toJS(JSC::ExecState*, JSDOMGlobalObject*, $implType&);\n");
2860         } else {
2861             push(@headerContent, $exportMacro."JSC::JSValue toJS(JSC::ExecState*, JSDOMGlobalObject*, $implType&);\n");
2862         }
2863         push(@headerContent, "inline JSC::JSValue toJS(JSC::ExecState* state, JSDOMGlobalObject* globalObject, $implType* impl) { return impl ? toJS(state, globalObject, *impl) : JSC::jsNull(); }\n");
2864
2865         push(@headerContent, "JSC::JSValue toJSNewlyCreated(JSC::ExecState*, JSDOMGlobalObject*, Ref<$implType>&&);\n");
2866         push(@headerContent, "inline JSC::JSValue toJSNewlyCreated(JSC::ExecState* state, JSDOMGlobalObject* globalObject, RefPtr<$implType>&& impl) { return impl ? toJSNewlyCreated(state, globalObject, impl.releaseNonNull()) : JSC::jsNull(); }\n");
2867    }
2868
2869     push(@headerContent, "\n");
2870
2871     GeneratePrototypeDeclaration(\@headerContent, $className, $interface) if HeaderNeedsPrototypeDeclaration($interface);
2872
2873     if ($hasForwardDeclaringOperations) {
2874         my $inAppleCopyright = 0;
2875         push(@headerContent,"// Functions\n\n");
2876         foreach my $operation (@{$interface->operations}) {
2877             next if $operation->{overloadIndex} && $operation->{overloadIndex} > 1;
2878             next unless $operation->extendedAttributes->{ForwardDeclareInHeader};
2879
2880             if ($operation->extendedAttributes->{AppleCopyright}) {
2881                 if (!$inAppleCopyright) {
2882                     push(@headerContent, $beginAppleCopyrightForHeaderFiles);
2883                     $inAppleCopyright = 1;
2884                 }
2885             } elsif ($inAppleCopyright) {
2886                 push(@headerContent, $endAppleCopyright);
2887                 $inAppleCopyright = 0;
2888             }
2889
2890             my $conditionalAttribute = GetConditionalForOperationConsideringOverloads($operation);
2891             my $conditionalString = $conditionalAttribute ? $codeGenerator->GenerateConditionalStringFromAttributeValue($conditionalAttribute) : undef;
2892             push(@headerContent, "#if ${conditionalString}\n") if $conditionalString;
2893             my $functionName = GetFunctionName($interface, $className, $operation);
2894             push(@headerContent, "JSC::EncodedJSValue JSC_HOST_CALL ${functionName}(JSC::ExecState*);\n");
2895             push(@headerContent, "#endif\n") if $conditionalString;
2896         }
2897
2898         push(@headerContent, $endAppleCopyright) if $inAppleCopyright;
2899         push(@headerContent,"\n");
2900     }
2901
2902     if ($hasForwardDeclaringAttributes) {
2903         push(@headerContent,"// Attributes\n\n");
2904         foreach my $attribute (@{$interface->attributes}) {
2905             next unless $attribute->extendedAttributes->{ForwardDeclareInHeader};
2906
2907             my $conditionalString = $codeGenerator->GenerateConditionalString($attribute);
2908             push(@headerContent, "#if ${conditionalString}\n") if $conditionalString;
2909             my $getter = GetAttributeGetterName($interface, $className, $attribute);
2910             push(@headerContent, "JSC::EncodedJSValue ${getter}(JSC::ExecState*, JSC::EncodedJSValue, JSC::PropertyName);\n");
2911             if (!IsReadonly($attribute)) {
2912                 my $setter = GetAttributeSetterName($interface, $className, $attribute);
2913                 push(@headerContent, "bool ${setter}(JSC::ExecState*, JSC::EncodedJSValue, JSC::EncodedJSValue);\n");
2914             }
2915             push(@headerContent, "#endif\n") if $conditionalString;
2916         }
2917     }
2918
2919     # CheckSubClass Snippet function.
2920     if ($interface->extendedAttributes->{DOMJIT}) {
2921         $headerIncludes{"<jit/Snippet.h>"} = 1;
2922         push(@headerContent, "#if ENABLE(JIT)\n");
2923         push(@headerContent, "Ref<JSC::Snippet> checkSubClassSnippetFor${className}();\n");
2924         push(@headerContent, "#endif\n");
2925     }
2926
2927     if ($hasDOMJITAttributes) {
2928         $headerIncludes{"<domjit/DOMJITGetterSetter.h>"} = 1;
2929         push(@headerContent,"// DOM JIT Attributes\n\n");
2930         foreach my $attribute (@{$interface->attributes}) {
2931             next unless $attribute->extendedAttributes->{DOMJIT};
2932             assert("Only DOMJIT=Getter is supported for attributes") unless $codeGenerator->ExtendedAttributeContains($attribute->extendedAttributes->{DOMJIT}, "Getter");
2933
2934             my $interfaceName = $interface->type->name;
2935             my $className = $interfaceName . $codeGenerator->WK_ucfirst($attribute->name);
2936             my $domJITClassName = $className . "Attribute";
2937
2938             push(@headerContent, "#if ENABLE(JIT)\n");
2939             push(@headerContent, "Ref<JSC::DOMJIT::CallDOMGetterSnippet> compile${domJITClassName}();\n");
2940             push(@headerContent, "#endif\n\n");
2941         }
2942     }
2943
2944     if (HasCustomConstructor($interface)) {
2945         push(@headerContent, "// Custom constructor\n");
2946         push(@headerContent, "JSC::EncodedJSValue JSC_HOST_CALL construct${className}(JSC::ExecState&);\n\n");
2947     }
2948
2949     if (NeedsImplementationClass($interface)) {
2950         my $toWrappedType = $interface->type->name eq "XPathNSResolver" ? "RefPtr<${implType}>" : "${implType}*";
2951     
2952         push(@headerContent, "template<> struct JSDOMWrapperConverterTraits<${implType}> {\n");
2953         push(@headerContent, "    using WrapperClass = ${className};\n");
2954         push(@headerContent, "    using ToWrappedReturnType = ${toWrappedType};\n");
2955         push(@headerContent, "};\n");
2956     }
2957
2958     push(@headerContent, GenerateEnumerationsHeaderContent($interface, $enumerations));
2959     push(@headerContent, GenerateDictionariesHeaderContent($interface, $dictionaries));
2960
2961     my $conditionalString = $codeGenerator->GenerateConditionalString($interface);
2962     push(@headerContent, "\n} // namespace WebCore\n");
2963     push(@headerContent, "\n#endif // ${conditionalString}\n") if $conditionalString;
2964
2965     if ($interface->extendedAttributes->{AppleCopyright}) {
2966         push(@headerContent, "\n");
2967         push(@headerContent, split("\r", $endAppleCopyright));
2968     }
2969
2970     # - Generate dependencies.
2971     if ($writeDependencies) {
2972         my @ancestors;
2973         $codeGenerator->ForAllParents($interface, sub {
2974             my $currentInterface = shift;
2975             push(@ancestors, $currentInterface->type->name);
2976         }, 0);
2977         for my $dictionary (@$dictionaries) {
2978             my $parentType = $dictionary->parentType;
2979             while (defined($parentType)) {
2980                 push(@ancestors, $parentType->name) if $codeGenerator->IsExternalDictionaryType($parentType);
2981                 my $parentDictionary = $codeGenerator->GetDictionaryByType($parentType);
2982                 assert("Unable to find definition for dictionary named '" . $parentType->name . "'!") unless defined($parentDictionary);
2983                 $parentType = $parentDictionary->parentType;
2984             }
2985         }
2986         push(@depsContent, "$className.h : ", join(" ", map { "$_.idl" } @ancestors), "\n");
2987         push(@depsContent, map { "$_.idl :\n" } @ancestors);
2988     }
2989 }
2990
2991 sub GeneratePropertiesHashTable
2992 {
2993     my ($object, $interface, $isInstance, $hashKeys, $hashSpecials, $hashValue1, $hashValue2, $conditionals, $readWriteConditionals, $runtimeEnabledOperations, $runtimeEnabledAttributes, $settingsEnabledOperations, $settingsEnabledAttributes) = @_;
2994
2995     # FIXME: These should be functions on $interface.
2996     my $interfaceName = $interface->type->name;
2997     my $className = "JS$interfaceName";
2998     
2999     # - Add all properties in a hashtable definition
3000     my $propertyCount = $isInstance ? InstancePropertyCount($interface) : PrototypePropertyCount($interface);
3001
3002     if (!$isInstance && NeedsConstructorProperty($interface)) {
3003         die if !$propertyCount;
3004         push(@$hashKeys, "constructor");
3005         my $getter = "js" . $interfaceName . "Constructor";
3006         push(@$hashValue1, $getter);
3007
3008         my $setter = "setJS" . $interfaceName . "Constructor";
3009         push(@$hashValue2, $setter);
3010         push(@$hashSpecials, "DontEnum");
3011     }
3012
3013     return 0 if !$propertyCount;
3014
3015     my @attributes = @{$interface->attributes};
3016     push(@attributes, @{$interface->mapLike->attributes}) if $interface->mapLike;
3017
3018     foreach my $attribute (@attributes) {
3019         next if ($attribute->isStatic);
3020         next if AttributeShouldBeOnInstance($interface, $attribute) != $isInstance;
3021
3022         # Global objects add RuntimeEnabled attributes after creation so do not add them to the static table.
3023         if ($isInstance && NeedsRuntimeCheck($interface, $attribute)) {
3024             $propertyCount -= 1;
3025             next;
3026         }
3027
3028         my $name = $attribute->name;
3029         push(@$hashKeys, $name);
3030
3031         my $special = GetJSCAttributesForAttribute($interface, $attribute);
3032         push(@$hashSpecials, $special);
3033
3034         if ($attribute->extendedAttributes->{DOMJIT}) {
3035             push(@$hashValue1, "&DOMJITAttributeFor" . $interface->type->name . $codeGenerator->WK_ucfirst($attribute->name));
3036         } else {
3037             my $getter = GetAttributeGetterName($interface, $className, $attribute);
3038             push(@$hashValue1, $getter);
3039         }
3040
3041         if (IsReadonly($attribute)) {
3042             push(@$hashValue2, "0");
3043         } else {
3044             my $setter = GetAttributeSetterName($interface, $className, $attribute);
3045             push(@$hashValue2, $setter);
3046         }
3047
3048         my $conditional = $attribute->extendedAttributes->{Conditional};
3049         $conditionals->{$name} = $conditional if $conditional;
3050         my $readWriteConditional = $attribute->extendedAttributes->{ConditionallyReadWrite};
3051         $readWriteConditionals->{$name} = $readWriteConditional if $readWriteConditional;
3052
3053         if (NeedsRuntimeCheck($interface, $attribute)) {
3054             push(@$runtimeEnabledAttributes, $attribute);
3055         }
3056
3057         if ($attribute->extendedAttributes->{EnabledBySetting}) {
3058             push(@$settingsEnabledAttributes, $attribute);
3059         }
3060     }
3061
3062     my @operations = @{$interface->operations};
3063     push(@operations, @{$interface->iterable->operations}) if IsKeyValueIterableInterface($interface);
3064     push(@operations, @{$interface->mapLike->operations}) if $interface->mapLike;
3065     push(@operations, @{$interface->serializable->operations}) if $interface->serializable;
3066     foreach my $operation (@operations) {
3067         next if ($operation->extendedAttributes->{PrivateIdentifier} and not $operation->extendedAttributes->{PublicIdentifier});
3068         next if ($operation->isStatic);
3069         next if $operation->{overloadIndex} && $operation->{overloadIndex} > 1;
3070         next if OperationShouldBeOnInstance($interface, $operation) != $isInstance;
3071         next if $operation->name eq "[Symbol.Iterator]";
3072
3073         # Global objects add RuntimeEnabled operations after creation so do not add them to the static table.
3074         if ($isInstance && NeedsRuntimeCheck($interface, $operation)) {
3075             $propertyCount -= 1;
3076             next;
3077         }
3078
3079         my $name = $operation->name;
3080         push(@$hashKeys, $name);
3081
3082         my $functionName = GetFunctionName($interface, $className, $operation);
3083         push(@$hashValue1, $functionName);
3084
3085         my $functionLength = GetFunctionLength($operation);
3086
3087         if ($operation->extendedAttributes->{DOMJIT}) {
3088             push(@$hashValue2, "&DOMJITSignatureFor" . $interface->type->name . $codeGenerator->WK_ucfirst($operation->name));
3089         } else {
3090             push(@$hashValue2, $functionLength);
3091         }
3092
3093         push(@$hashSpecials, ComputeFunctionSpecial($interface, $operation));
3094
3095         my $conditional = GetConditionalForOperationConsideringOverloads($operation);
3096         $conditionals->{$name} = $conditional if $conditional;
3097
3098         if (NeedsRuntimeCheck($interface, $operation)) {
3099             push(@$runtimeEnabledOperations, $operation);
3100         }
3101
3102         if ($operation->extendedAttributes->{EnabledBySetting}) {
3103             push(@$settingsEnabledOperations, $operation);
3104         }
3105     }
3106
3107     return $propertyCount;
3108 }
3109
3110 # This computes an effective overload set for a given operation / constructor,
3111 # which represents the allowable invocations.This set is used as input for
3112 # the Web IDL overload resolution algorithm.
3113 # http://heycam.github.io/webidl/#dfn-effective-overload-set
3114 sub ComputeEffectiveOverloadSet
3115 {
3116     my ($overloads) = @_;
3117
3118     my %allSets;
3119     my $addTuple = sub {
3120         my $tuple = shift;
3121         # The Web IDL specification uses a flat set of tuples but we use a hash where the key is the
3122         # number of parameters and the value is the set of tuples for the given number of parameters.
3123         my $length = scalar(@{@$tuple[1]});
3124         if (!exists($allSets{$length})) {
3125             $allSets{$length} = [ $tuple ];
3126         } else {
3127             push(@{$allSets{$length}}, $tuple);
3128         }
3129     };
3130
3131     my $m = LengthOfLongestOperationParameterList($overloads);
3132     foreach my $overload (@{$overloads}) {
3133         my $n = @{$overload->arguments};
3134         my @t;
3135         my @o;
3136         my $isVariadic = 0;
3137         foreach my $argument (@{$overload->arguments}) {
3138             push(@t, $argument->type);
3139             if ($argument->isOptional) {
3140                 push(@o, "optional");
3141             } elsif ($argument->isVariadic) {
3142                 push(@o, "variadic");
3143                 $isVariadic = 1;
3144             } else {
3145                 push(@o, "required");
3146             }
3147         }
3148         &$addTuple([$overload, [@t], [@o]]);
3149         if ($isVariadic) {
3150             my @newT = @t;
3151             my @newO = @o;
3152             for (my $i = $n; $i < $m; $i++) {
3153                 push(@newT, $t[-1]);
3154                 push(@newO, "variadic");
3155                 &$addTuple([$overload, [@newT], [@newO]]);
3156             }
3157         }
3158         for (my $i = $n - 1; $i >= 0; $i--) {
3159   &n