[iOS] Upstream WebCore and Tools miscellaneous changes
[WebKit-https.git] / Source / WebCore / bindings / scripts / CodeGeneratorObjC.pm
1
2 # Copyright (C) 2005, 2006 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, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
7 # Copyright (C) 2009 Cameron McCormack <cam@mcc.id.au>
8 # Copyright (C) 2010 Google Inc.
9 # Copyright (C) Research In Motion Limited 2010. All rights reserved.
10 #
11 # This library is free software; you can redistribute it and/or
12 # modify it under the terms of the GNU Library General Public
13 # License as published by the Free Software Foundation; either
14 # version 2 of the License, or (at your option) any later version.
15
16 # This library is distributed in the hope that it will be useful,
17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19 # Library General Public License for more details.
20
21 # You should have received a copy of the GNU Library General Public License
22 # along with this library; see the file COPYING.LIB.  If not, write to
23 # the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 # Boston, MA 02110-1301, USA.
25 #
26
27 package CodeGeneratorObjC;
28
29 use constant FileNamePrefix => "DOM";
30
31 # Global Variables
32 my $writeDependencies = 0;
33 my %publicInterfaces = ();
34 my $newPublicClass = 0;
35 my $interfaceAvailabilityVersion = "";
36 my $isProtocol = 0;
37 my $noImpl = 0;
38
39 my @headerContentHeader = ();
40 my @headerContent = ();
41 my %headerForwardDeclarations = ();
42 my %headerForwardDeclarationsForProtocols = ();
43
44 my @privateHeaderContentHeader = ();
45 my @privateHeaderContent = ();
46 my %privateHeaderForwardDeclarations = ();
47 my %privateHeaderForwardDeclarationsForProtocols = ();
48
49 my @internalHeaderContent = ();
50
51 my @implConditionalIncludes = ();
52 my @implContentHeader = ();
53 my @implContent = ();
54 my %implIncludes = ();
55 my @depsContent = ();
56
57 my $beginAppleCopyrightForHeaderFiles = <<END;
58 // ------- Begin Apple Copyright -------
59 /*
60  * Copyright (C) 2008, Apple Inc. All rights reserved.
61  *
62  * Permission is granted by Apple to use this file to the extent
63  * necessary to relink with LGPL WebKit files.
64  *
65  * No license or rights are granted by Apple expressly or by
66  * implication, estoppel, or otherwise, to Apple patents and
67  * trademarks. For the sake of clarity, no license or rights are
68  * granted by Apple expressly or by implication, estoppel, or otherwise,
69  * under any Apple patents, copyrights and trademarks to underlying
70  * implementations of any application programming interfaces (APIs)
71  * or to any functionality that is invoked by calling any API.
72  */
73
74 END
75 my $beginAppleCopyrightForSourceFiles = <<END;
76 // ------- Begin Apple Copyright -------
77 /*
78  * Copyright (C) 2008, Apple Inc. All rights reserved.
79  *
80  * No license or rights are granted by Apple expressly or by implication,
81  * estoppel, or otherwise, to Apple copyrights, patents, trademarks, trade
82  * secrets or other rights.
83  */
84
85 END
86 my $endAppleCopyright   = <<END;
87 // ------- End Apple Copyright   -------
88
89 END
90
91 # Hashes
92 my %protocolTypeHash = ("XPathNSResolver" => 1, "EventListener" => 1, "EventTarget" => 1, "NodeFilter" => 1,
93                         "SVGFilterPrimitiveStandardAttributes" => 1, 
94                         "SVGTests" => 1, "SVGLangSpace" => 1, "SVGExternalResourcesRequired" => 1, "SVGURIReference" => 1,
95                         "SVGZoomAndPan" => 1, "SVGFitToViewBox" => 1, "SVGAnimatedPathData" => 1);
96 my %nativeObjCTypeHash = ("URL" => 1, "Color" => 1);
97
98 # FIXME: this should be replaced with a function that recurses up the tree
99 # to find the actual base type.
100 my %baseTypeHash = ("Object" => 1, "Node" => 1, "NodeList" => 1, "NamedNodeMap" => 1, "DOMImplementation" => 1,
101                     "Event" => 1, "CSSRule" => 1, "CSSValue" => 1, "StyleSheet" => 1, "MediaList" => 1,
102                     "Counter" => 1, "Rect" => 1, "RGBColor" => 1, "XPathExpression" => 1, "XPathResult" => 1,
103                     "NodeIterator" => 1, "TreeWalker" => 1, "AbstractView" => 1, "Blob" => 1,
104                     "SVGAngle" => 1, "SVGAnimatedAngle" => 1, "SVGAnimatedBoolean" => 1, "SVGAnimatedEnumeration" => 1,
105                     "SVGAnimatedInteger" => 1, "SVGAnimatedLength" => 1, "SVGAnimatedLengthList" => 1,
106                     "SVGAnimatedNumber" => 1, "SVGAnimatedNumberList" => 1,
107                     "SVGAnimatedPreserveAspectRatio" => 1, "SVGAnimatedRect" => 1, "SVGAnimatedString" => 1,
108                     "SVGAnimatedTransformList" => 1, "SVGLength" => 1, "SVGLengthList" => 1, "SVGMatrix" => 1,
109                     "SVGNumber" => 1, "SVGNumberList" => 1, "SVGPathSeg" => 1, "SVGPathSegList" => 1, "SVGPoint" => 1,
110                     "SVGPointList" => 1, "SVGPreserveAspectRatio" => 1, "SVGRect" => 1, "SVGRenderingIntent" => 1,
111                     "SVGStringList" => 1, "SVGTransform" => 1, "SVGTransformList" => 1, "SVGUnitTypes" => 1);
112
113 # Constants
114 my $buildingForIPhone = ($ENV{PLATFORM_NAME} eq "iphoneos" or $ENV{PLATFORM_NAME} eq "iphonesimulator");
115 my $nullableInit = "bool isNull = false;";
116 my $exceptionInit = "WebCore::ExceptionCode ec = 0;";
117 my $jsContextSetter = "WebCore::JSMainThreadNullState state;";
118 my $exceptionRaiseOnError = "WebCore::raiseOnDOMError(ec);";
119 my $assertMainThread = "{ DOM_ASSERT_MAIN_THREAD(); WebCoreThreadViolationCheckRoundOne(); }";
120
121 my %conflictMethod = (
122     # FIXME: Add C language keywords?
123     # FIXME: Add other predefined types like "id"?
124
125     "callWebScriptMethod:withArguments:" => "WebScriptObject",
126     "evaluateWebScript:" => "WebScriptObject",
127     "removeWebScriptKey:" => "WebScriptObject",
128     "setException:" => "WebScriptObject",
129     "setWebScriptValueAtIndex:value:" => "WebScriptObject",
130     "stringRepresentation" => "WebScriptObject",
131     "webScriptValueAtIndex:" => "WebScriptObject",
132
133     "autorelease" => "NSObject",
134     "awakeAfterUsingCoder:" => "NSObject",
135     "class" => "NSObject",
136     "classForCoder" => "NSObject",
137     "conformsToProtocol:" => "NSObject",
138     "copy" => "NSObject",
139     "copyWithZone:" => "NSObject",
140     "dealloc" => "NSObject",
141     "description" => "NSObject",
142     "doesNotRecognizeSelector:" => "NSObject",
143     "encodeWithCoder:" => "NSObject",
144     "finalize" => "NSObject",
145     "forwardInvocation:" => "NSObject",
146     "hash" => "NSObject",
147     "init" => "NSObject",
148     "initWithCoder:" => "NSObject",
149     "isEqual:" => "NSObject",
150     "isKindOfClass:" => "NSObject",
151     "isMemberOfClass:" => "NSObject",
152     "isProxy" => "NSObject",
153     "methodForSelector:" => "NSObject",
154     "methodSignatureForSelector:" => "NSObject",
155     "mutableCopy" => "NSObject",
156     "mutableCopyWithZone:" => "NSObject",
157     "performSelector:" => "NSObject",
158     "release" => "NSObject",
159     "replacementObjectForCoder:" => "NSObject",
160     "respondsToSelector:" => "NSObject",
161     "retain" => "NSObject",
162     "retainCount" => "NSObject",
163     "self" => "NSObject",
164     "superclass" => "NSObject",
165     "zone" => "NSObject",
166 );
167
168 my $fatalError = 0;
169
170 # Default License Templates
171 my $headerLicenseTemplate = << "EOF";
172 /*
173  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
174  * Copyright (C) 2006 Samuel Weinig <sam.weinig\@gmail.com>
175  *
176  * Redistribution and use in source and binary forms, with or without
177  * modification, are permitted provided that the following conditions
178  * are met:
179  * 1. Redistributions of source code must retain the above copyright
180  *    notice, this list of conditions and the following disclaimer.
181  * 2. Redistributions in binary form must reproduce the above copyright
182  *    notice, this list of conditions and the following disclaimer in the
183  *    documentation and/or other materials provided with the distribution.
184  *
185  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
186  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
187  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
188  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
189  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
190  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
191  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
192  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
193  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
194  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
195  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
196  */
197 EOF
198
199 my $implementationLicenseTemplate = << "EOF";
200 /*
201  * This file is part of the WebKit open source project.
202  * This file has been generated by generate-bindings.pl. DO NOT MODIFY!
203  *
204  * Redistribution and use in source and binary forms, with or without
205  * modification, are permitted provided that the following conditions
206  * are met:
207  * 1. Redistributions of source code must retain the above copyright
208  *    notice, this list of conditions and the following disclaimer.
209  * 2. Redistributions in binary form must reproduce the above copyright
210  *    notice, this list of conditions and the following disclaimer in the
211  *    documentation and/or other materials provided with the distribution.
212  *
213  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
214  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
215  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
216  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
217  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
218  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
219  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
220  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
221  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
222  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
223  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
224  */
225 EOF
226
227 # Default constructor
228 sub new
229 {
230     my $object = shift;
231     my $reference = { };
232
233     $codeGenerator = shift;
234     shift; # $useLayerOnTop
235     shift; # $preprocessor
236     $writeDependencies = shift;
237
238     bless($reference, $object);
239     return $reference;
240 }
241
242 sub ReadPublicInterfaces
243 {
244     my $class = shift;
245     my $superClass = shift;
246     my $defines = shift;
247     my $isProtocol = shift;
248
249     my $found = 0;
250     my $actualSuperClass;
251     %publicInterfaces = ();
252
253     my @args = qw(-E -P -x objective-c);
254     # Set include path to find <wtf/Platform.h>.  We search BUILT_PRODUCTS_DIR
255     # first for local developer builds, then the installation path for B&I
256     # builds.
257     push(@args, "-I" . $ENV{BUILT_PRODUCTS_DIR} . "/usr/local/include") if $ENV{BUILT_PRODUCTS_DIR};
258     push(@args, "-I" . $ENV{BUILT_PRODUCTS_DIR} . $ENV{SDKROOT} . "/usr/local/include") if $ENV{BUILT_PRODUCTS_DIR};
259
260     # Xcode 3.1 is required for SDKROOT to be set.
261     if ($ENV{SDKROOT} && $ENV{SYSTEM_LIBRARY_DIR}) {
262         push(@args, "-I" . $ENV{BUILT_PRODUCTS_DIR} . $ENV{SDKROOT} . "/usr/local/include") if $ENV{BUILT_PRODUCTS_DIR};
263         push(@args, "-I" . $ENV{SDKROOT} . "/usr/local/include");
264     }
265     my $fileName = "WebCore/bindings/objc/PublicDOMInterfaces.h";
266     my $gccLocation = "";
267     if ($ENV{CC}) {
268         $gccLocation = $ENV{CC};
269     } elsif (($Config::Config{'osname'}) =~ /solaris/i) {
270         $gccLocation = "/usr/sfw/bin/gcc";
271     } elsif (-x "/usr/bin/clang") {
272         $gccLocation = "/usr/bin/clang";
273     } else {
274         $gccLocation = "/usr/bin/gcc";
275     }
276
277     if ($ENV{SDKROOT}) {
278         # PLATFORM(IOS)
279         push(@args, "-isysroot", $ENV{SDKROOT});
280     }
281
282     open FILE, "-|", $gccLocation, @args,
283         (map { "-D$_" } split(/ +/, $defines)), "-DOBJC_CODE_GENERATION", $fileName or die "Could not open $fileName";
284     my @documentContent = <FILE>;
285     close FILE;
286
287     foreach $line (@documentContent) {
288         if (!$isProtocol && $line =~ /^\s*\@interface\s*$class\s*:\s*(\w+)\s*([A-Z0-9_]*)/) {
289             if ($superClass ne $1) {
290                 warn "Public API change. Superclass for \"$class\" differs ($1 != $superClass)";
291                 $fatalError = 1;
292             }
293
294             $interfaceAvailabilityVersion = $2 if defined $2;
295             $found = 1;
296             next;
297         } elsif ($isProtocol && $line =~ /^\s*\@protocol $class\s*<[^>]+>\s*([A-Z0-9_()]*)/) {
298             $interfaceAvailabilityVersion = $1 if defined $1;
299             $found = 1;
300             next;
301         }
302
303         last if $found and $line =~ /^\s?\@end\s?$/;
304
305         if ($found) {
306             # trim whitspace
307             $line =~ s/^\s+//;
308             $line =~ s/\s+$//;
309
310             my $availabilityMacro = "";
311             $line =~ s/\s([A-Z0-9_(), ]+)\s*;$/;/;
312             $availabilityMacro = $1 if defined $1;
313
314             $publicInterfaces{$line} = $availabilityMacro if length $line;
315         }
316     }
317
318     # If this class was not found in PublicDOMInterfaces.h then it should be considered as an entirely new public class.
319     $newPublicClass = !$found;
320     $interfaceAvailabilityVersion = "TBD" if $newPublicClass;
321 }
322
323 sub AddMethodsConstantsAndAttributesFromParentInterfaces
324 {
325     # Add to $interface all of its inherited interface members, except for those
326     # inherited through $interface's first listed parent.  If an array reference
327     # is passed in as $parents, the names of all ancestor interfaces visited
328     # will be appended to the array.  If $collectDirectParents is true, then
329     # even the names of $interface's first listed parent and its ancestors will
330     # be appended to $parents.
331
332     my $interface = shift;
333     my $parents = shift;
334     my $collectDirectParents = shift;
335
336     my $first = 1;
337
338     $codeGenerator->ForAllParents($interface, sub {
339         my $currentInterface = shift;
340
341         if ($first) {
342             # Ignore first parent class, already handled by the generation itself.
343             $first = 0;
344
345             if ($collectDirectParents) {
346                 # Just collect the names of the direct ancestor interfaces,
347                 # if necessary.
348                 push(@$parents, $currentInterface->name);
349                 $codeGenerator->ForAllParents($currentInterface, sub {
350                     my $currentInterface = shift;
351                     push(@$parents, $currentInterface->name);
352                 }, undef);
353             }
354
355             # Prune the recursion here.
356             return 'prune';
357         }
358
359         # Collect the name of this additional parent.
360         push(@$parents, $currentInterface->name) if $parents;
361
362         print "  |  |>  -> Inheriting "
363             . @{$currentInterface->constants} . " constants, "
364             . @{$currentInterface->functions} . " functions, "
365             . @{$currentInterface->attributes} . " attributes...\n  |  |>\n" if $verbose;
366
367         # Add this parent's members to $interface.
368         push(@{$interface->constants}, @{$currentInterface->constants});
369         push(@{$interface->functions}, @{$currentInterface->functions});
370         push(@{$interface->attributes}, @{$currentInterface->attributes});
371     });
372 }
373
374 sub GenerateInterface
375 {
376     my $object = shift;
377     my $interface = shift;
378     my $defines = shift;
379
380     $fatalError = 0;
381
382     my $name = $interface->name;
383     my $className = GetClassName($name);
384     my $parentClassName = "DOM" . GetParentImplClassName($interface);
385     $isProtocol = $interface->extendedAttributes->{ObjCProtocol};
386     $noImpl = $interface->extendedAttributes->{ObjCCustomImplementation} || $isProtocol;
387
388     ReadPublicInterfaces($className, $parentClassName, $defines, $isProtocol);
389
390     # Start actual generation..
391     $object->GenerateHeader($interface);
392     $object->GenerateImplementation($interface) unless $noImpl;
393
394     # Check for missing public API
395     if (keys %publicInterfaces > 0) {
396         my $missing = join("\n", keys %publicInterfaces);
397         warn "Public API change. There are missing public properties and/or methods from the \"$className\" class.\n$missing\n";
398         $fatalError = 1;
399     }
400
401     die if $fatalError;
402 }
403
404 sub GetClassName
405 {
406     my $name = shift;
407
408     # special cases
409     return "NSString" if $codeGenerator->IsStringType($name) or $name eq "SerializedScriptValue";
410     return "CGColorRef" if $name eq "Color" and $buildingForIPhone;
411     return "NS$name" if IsNativeObjCType($name);
412     return "BOOL" if $name eq "boolean";
413     return "unsigned char" if $name eq "octet";
414     return "char" if $name eq "byte";
415     return "unsigned" if $name eq "unsigned long";
416     return "int" if $name eq "long";
417     return "NSTimeInterval" if $name eq "Date";
418     return "DOMAbstractView" if $name eq "DOMWindow";
419     return $name if $codeGenerator->IsPrimitiveType($name) or $name eq "DOMImplementation" or $name eq "DOMTimeStamp";
420
421     # Default, assume Objective-C type has the same type name as
422     # idl type prefixed with "DOM".
423     return "DOM$name";
424 }
425
426 sub GetClassHeaderName
427 {
428     my $name = shift;
429
430     return "DOMDOMImplementation" if $name eq "DOMImplementation";
431     return $name;
432 }
433
434 sub GetImplClassName
435 {
436     my $name = shift;
437
438     return "DOMImplementationFront" if $name eq "DOMImplementation";
439     return "DOMWindow" if $name eq "AbstractView";
440     return $name;
441 }
442
443 sub GetParentImplClassName
444 {
445     my $interface = shift;
446
447     return "Object" if @{$interface->parents} eq 0;
448
449     my $parent = $interface->parents(0);
450
451     # special cases
452     return "Object" if $parent eq "HTMLCollection";
453
454     return $parent;
455 }
456
457 sub GetParentAndProtocols
458 {
459     my $interface = shift;
460     my $numParents = @{$interface->parents};
461
462     my $parent = "";
463     my @protocols = ();
464     if ($numParents eq 0) {
465         if ($isProtocol) {
466             push(@protocols, "NSObject");
467             push(@protocols, "NSCopying") if $interface->name eq "EventTarget";
468         } else {
469             $parent = "DOMObject";
470         }
471     } elsif ($numParents eq 1) {
472         my $parentName = $interface->parents(0);
473         if ($isProtocol) {
474             die "Parents of protocols must also be protocols." unless IsProtocolType($parentName);
475             push(@protocols, "DOM" . $parentName);
476         } else {
477             if (IsProtocolType($parentName)) {
478                 push(@protocols, "DOM" . $parentName);
479             } elsif ($parentName eq "HTMLCollection") {
480                 $parent = "DOMObject";
481             } else {
482                 $parent = "DOM" . $parentName;
483             }
484         }
485     } else {
486         my @parents = @{$interface->parents};
487         my $firstParent = shift(@parents);
488         if (IsProtocolType($firstParent)) {
489             push(@protocols, "DOM" . $firstParent);
490             if (!$isProtocol) {
491                 $parent = "DOMObject";
492             }
493         } else {
494             $parent = "DOM" . $firstParent;
495         }
496
497         foreach my $parentName (@parents) {
498             die "Everything past the first class should be a protocol!" unless IsProtocolType($parentName);
499
500             push(@protocols, "DOM" . $parentName);
501         }
502     }
503
504     return ($parent, @protocols);
505 }
506
507 sub GetBaseClass
508 {
509     $parent = shift;
510
511     return $parent if $parent eq "Object" or IsBaseType($parent);
512     return "Event" if $parent eq "UIEvent" or $parent eq "MouseEvent";
513     return "CSSValue" if $parent eq "SVGColor" or $parent eq "CSSValueList";
514     return "Node";
515 }
516
517 sub IsBaseType
518 {
519     my $type = shift;
520
521     return 1 if $baseTypeHash{$type};
522     return 0;
523 }
524
525 sub IsProtocolType
526 {
527     my $type = shift;
528
529     return 1 if $protocolTypeHash{$type};
530     return 0;
531 }
532
533 sub IsNativeObjCType
534 {
535     my $type = shift;
536
537     return 1 if $nativeObjCTypeHash{$type};
538     return 0;
539 }
540
541 sub IsCoreFoundationType
542 {
543     my $type = shift;
544
545     return 1 if $type =~ /^(CF|CG)[A-Za-z]+Ref$/;
546     return 0;
547 }
548
549 sub SkipFunction
550 {
551     my $function = shift;
552
553     return 1 if $codeGenerator->GetSequenceType($function->signature->type);
554     return 1 if $codeGenerator->GetArrayType($function->signature->type);
555
556     foreach my $param (@{$function->parameters}) {
557         return 1 if $codeGenerator->GetSequenceType($param->type);
558         return 1 if $codeGenerator->GetArrayType($param->type);
559         return 1 if $param->extendedAttributes->{"Clamp"};
560     }
561
562     return 0;
563 }
564
565 sub SkipAttribute
566 {
567     my $attribute = shift;
568     my $type = $attribute->signature->type;
569
570     $codeGenerator->AssertNotSequenceType($type);
571     return 1 if $codeGenerator->GetArrayType($type);
572     return 1 if $codeGenerator->IsTypedArrayType($type);
573     return 1 if $codeGenerator->IsEnumType($type);
574     return 1 if $attribute->isStatic;
575
576     # This is for DynamicsCompressorNode.idl
577     if ($attribute->signature->name eq "release") {
578         return 1;
579     }
580
581     return 0;
582 }
583
584 sub GetObjCType
585 {
586     my $type = shift;
587     my $name = GetClassName($type);
588
589     return "id <$name>" if IsProtocolType($type);
590     return $name if $codeGenerator->IsPrimitiveType($type) or $type eq "DOMTimeStamp";
591     return "unsigned short" if $type eq "CompareHow";
592     return $name if IsCoreFoundationType($name);
593     return "$name *";
594 }
595
596 sub GetPropertyAttributes
597 {
598     my $type = shift;
599     my $readOnly = shift;
600
601     my @attributes = ();
602
603     push(@attributes, "readonly") if $readOnly;
604
605     # FIXME: <rdar://problem/5049934> Consider using 'nonatomic' on the DOM @property declarations.
606     if ($codeGenerator->IsStringType($type) || IsNativeObjCType($type)) {
607         push(@attributes, "copy");
608     } elsif ($codeGenerator->IsSVGAnimatedType($type)) {
609         push(@attributes, "strong");
610     } elsif (!$codeGenerator->IsStringType($type) && !$codeGenerator->IsPrimitiveType($type) && $type ne "DOMTimeStamp" && $type ne "CompareHow") {
611         push(@attributes, "strong");
612     }
613
614     return "" unless @attributes > 0;
615     return " (" . join(", ", @attributes) . ")";
616 }
617
618 sub ConversionNeeded
619 {
620     my $type = shift;
621
622     return !$codeGenerator->IsNonPointerType($type) && !$codeGenerator->IsStringType($type) && !IsNativeObjCType($type);
623 }
624
625 sub GetObjCTypeGetter
626 {
627     my $argName = shift;
628     my $type = shift;
629
630     return $argName if $codeGenerator->IsPrimitiveType($type) or $codeGenerator->IsStringType($type) or IsNativeObjCType($type);
631     return $argName . "Node" if $type eq "EventTarget";
632     return "static_cast<WebCore::Range::CompareHow>($argName)" if $type eq "CompareHow";
633     return "WTF::getPtr(nativeEventListener)" if $type eq "EventListener";
634     return "WTF::getPtr(nativeNodeFilter)" if $type eq "NodeFilter";
635     return "WTF::getPtr(nativeResolver)" if $type eq "XPathNSResolver";
636     
637     if ($type eq "SerializedScriptValue") {
638         $implIncludes{"SerializedScriptValue.h"} = 1;
639         return "WebCore::SerializedScriptValue::create(WTF::String($argName))";
640     }
641     return "core($argName)";
642 }
643
644 sub AddForwardDeclarationsForType
645 {
646     my $type = shift;
647     my $public = shift;
648
649     return if $codeGenerator->IsNonPointerType($type);
650     return if $codeGenerator->GetSequenceType($type);
651     return if $codeGenerator->GetArrayType($type);
652
653     my $class = GetClassName($type);
654
655     if (IsProtocolType($type)) {
656         $headerForwardDeclarationsForProtocols{$class} = 1 if $public;
657         $privateHeaderForwardDeclarationsForProtocols{$class} = 1 if !$public and !$headerForwardDeclarationsForProtocols{$class};
658         return;
659     }
660
661     $headerForwardDeclarations{$class} = 1 if $public;
662
663     # Private headers include the public header, so only add a forward declaration to the private header
664     # if the public header does not already have the same forward declaration.
665     $privateHeaderForwardDeclarations{$class} = 1 if !$public and !$headerForwardDeclarations{$class};
666 }
667
668 sub AddIncludesForType
669 {
670     my $type = shift;
671
672     return if $codeGenerator->IsNonPointerType($type);
673     return if $codeGenerator->GetSequenceType($type);
674     return if $codeGenerator->GetArrayType($type);
675
676     if (IsNativeObjCType($type)) {
677         if ($type eq "Color") {
678             if ($buildingForIPhone) {
679                 $implIncludes{"ColorSpace.h"} = 1;
680             } else {
681                 $implIncludes{"ColorMac.h"} = 1;
682             }
683         }
684         return;
685     }
686
687     if ($codeGenerator->IsStringType($type)) {
688         $implIncludes{"URL.h"} = 1;
689         return;
690     }
691
692     if ($type eq "DOMWindow") {
693         $implIncludes{"DOMAbstractViewInternal.h"} = 1;
694         $implIncludes{"DOMWindow.h"} = 1;
695         return;
696     }
697
698     if ($type eq "DOMImplementation") {
699         $implIncludes{"DOMDOMImplementationInternal.h"} = 1;
700         $implIncludes{"DOMImplementationFront.h"} = 1;
701         return;
702     }
703
704     if ($type eq "EventTarget") {
705         $implIncludes{"Node.h"} = 1;
706         $implIncludes{"DOMEventTarget.h"} = 1;
707         return;
708     }
709
710     if ($codeGenerator->IsSVGAnimatedType($type)) {
711         $implIncludes{"${type}.h"} = 1;
712         $implIncludes{"DOM${type}Internal.h"} = 1;
713         return;
714     }
715
716     if ($type =~ /(\w+)(Abs|Rel)$/) {
717         $implIncludes{"$1.h"} = 1;
718         $implIncludes{"DOM${type}Internal.h"} = 1;
719         return;
720     }
721
722     if ($type eq "NodeFilter") {
723         $implIncludes{"NodeFilter.h"} = 1;
724         $implIncludes{"ObjCNodeFilterCondition.h"} = 1;
725         return;
726     }
727
728     if ($type eq "EventListener") {
729         $implIncludes{"EventListener.h"} = 1;
730         $implIncludes{"ObjCEventListener.h"} = 1;
731         return;
732     }
733
734     if ($type eq "XPathNSResolver") {
735         $implIncludes{"DOMCustomXPathNSResolver.h"} = 1;
736         $implIncludes{"XPathNSResolver.h"} = 1;
737         return;
738     }
739
740     if ($type eq "SerializedScriptValue") {
741         $implIncludes{"SerializedScriptValue.h"} = 1;
742         return;
743     }
744
745     # FIXME: won't compile without these
746     $implIncludes{"CSSImportRule.h"} = 1 if $type eq "CSSRule";
747     $implIncludes{"StyleProperties.h"} = 1 if $type eq "CSSStyleDeclaration";
748     $implIncludes{"NameNodeList.h"} = 1 if $type eq "NodeList";
749
750     # Default, include the same named file (the implementation) and the same name prefixed with "DOM". 
751     $implIncludes{"$type.h"} = 1 if not $codeGenerator->SkipIncludeHeader($type);
752     $implIncludes{"DOM${type}Internal.h"} = 1;
753 }
754
755 sub GetSVGTypeWithNamespace
756 {
757     my $type = shift;
758     my $typeWithNamespace = "WebCore::" . $codeGenerator->GetSVGTypeNeedingTearOff($type);
759
760     # Special case for DOMSVGNumber
761     $typeWithNamespace =~ s/</\<WebCore::/ unless $type eq "SVGNumber";
762     return $typeWithNamespace;
763 }
764
765 sub GetSVGPropertyTypes
766 {
767     my $implType = shift;
768
769     my $svgPropertyType;
770     my $svgListPropertyType;
771     my $svgNativeType;
772
773     return ($svgPropertyType, $svgListPropertyType, $svgNativeType) if not $implType =~ /SVG/;
774
775     $svgNativeType = $codeGenerator->GetSVGTypeNeedingTearOff($implType);
776     return ($svgPropertyType, $svgListPropertyType, $svgNativeType) if not $svgNativeType;
777
778     # Append space to avoid compilation errors when using  PassRefPtr<$svgNativeType>
779     $svgNativeType = "WebCore::$svgNativeType ";
780     $svgNativeType =~ s/</\<WebCore::/ if not $svgNativeType =~ /float/;
781
782     my $svgWrappedNativeType = $codeGenerator->GetSVGWrappedTypeNeedingTearOff($implType);
783     if ($svgNativeType =~ /SVGPropertyTearOff/) {
784         if ($svgWrappedNativeType eq "float") {
785             # Special case for DOMSVGNumber
786             $svgPropertyType = $svgWrappedNativeType;
787         } else {
788             $svgPropertyType = "WebCore::$svgWrappedNativeType";
789             $svgPropertyType =~ s/</\<WebCore::/;
790         }
791     } elsif ($svgNativeType =~ /SVGListPropertyTearOff/ or $svgNativeType =~ /SVGStaticListPropertyTearOff/) {
792         $svgListPropertyType = "WebCore::$svgWrappedNativeType";
793         $svgListPropertyType =~ s/</\<WebCore::/;
794     } elsif ($svgNativeType =~ /SVGTransformListPropertyTearOff/) {
795         $svgListPropertyType = "WebCore::$svgWrappedNativeType";
796         $svgListPropertyType =~ s/</\<WebCore::/;
797     } elsif ($svgNativeType =~ /SVGPathSegListPropertyTearOff/) {
798         $svgListPropertyType = "WebCore::$svgWrappedNativeType";
799         $svgListPropertyType =~ s/</\<WebCore::/;
800     }
801
802     return ($svgPropertyType, $svgListPropertyType, $svgNativeType);
803 }
804
805 sub GenerateHeader
806 {
807     my $object = shift;
808     my $interface = shift;
809
810     my $interfaceName = $interface->name;
811     my $className = GetClassName($interfaceName);
812
813     my $parentName = "";
814     my @protocolsToImplement = ();
815     ($parentName, @protocolsToImplement) = GetParentAndProtocols($interface);
816
817     my $numConstants = @{$interface->constants};
818     my $numAttributes = @{$interface->attributes};
819     my $numFunctions = @{$interface->functions};
820
821     # - Add default header template
822     if ($interface->extendedAttributes->{"AppleCopyright"}) {
823         @headerContentHeader = split("\r", $beginAppleCopyrightForHeaderFiles);
824     } else {
825         @headerContentHeader = split("\r", $headerLicenseTemplate);
826     }
827     push(@headerContentHeader, "\n");
828
829     # - INCLUDES -
830     my $includedWebKitAvailabilityHeader = 0;
831     unless ($isProtocol) {
832         my $parentHeaderName = GetClassHeaderName($parentName);
833         push(@headerContentHeader, "#import <WebCore/$parentHeaderName.h>\n");
834         $includedWebKitAvailabilityHeader = 1;
835     }
836
837     foreach my $parentProtocol (@protocolsToImplement) {
838         next if $parentProtocol =~ /^NS/; 
839         $parentProtocol = GetClassHeaderName($parentProtocol);
840         push(@headerContentHeader, "#import <WebCore/$parentProtocol.h>\n");
841         $includedWebKitAvailabilityHeader = 1;
842     }
843
844     # Special case needed for legacy support of DOMRange
845     if ($interfaceName eq "Range") {
846         push(@headerContentHeader, "#import <WebCore/DOMCore.h>\n");
847         push(@headerContentHeader, "#import <WebCore/DOMDocument.h>\n");
848         push(@headerContentHeader, "#import <WebCore/DOMRangeException.h>\n");
849         $includedWebKitAvailabilityHeader = 1;
850     }
851
852     push(@headerContentHeader, "#import <WebCore/WebKitAvailability.h>\n") unless $includedWebKitAvailabilityHeader;
853
854     push(@headerContentHeader, "\n");
855
856     # - Add constants.
857     if ($numConstants > 0) {
858         my @headerConstants = ();
859         my @constants = @{$interface->constants};
860         my $combinedConstants = "";
861
862         # FIXME: we need a way to include multiple enums.
863         foreach my $constant (@constants) {
864             my $constantName = $constant->name;
865             my $constantValue = $constant->value;
866             my $conditional = $constant->extendedAttributes->{"Conditional"};
867             my $notLast = $constant ne $constants[-1];
868
869             if ($conditional) {
870                 my $conditionalString = $codeGenerator->GenerateConditionalStringFromAttributeValue($conditional);
871                 $combinedConstants .= "#if ${conditionalString}\n";
872             }
873             $combinedConstants .= "    DOM_$constantName = $constantValue";
874             $combinedConstants .= "," if $notLast;
875             if ($conditional) {
876                 $combinedConstants .= "\n#endif\n";
877             } elsif ($notLast) {
878                 $combinedConstants .= "\n";
879             }
880         }
881
882         # FIXME: the formatting of the enums should line up the equal signs.
883         # FIXME: enums are unconditionally placed in the public header.
884         push(@headerContent, "enum {\n");
885         push(@headerContent, $combinedConstants);
886         push(@headerContent, "\n}");
887         push(@headerContent, " WEBKIT_ENUM_AVAILABLE_MAC($interfaceAvailabilityVersion)") if length $interfaceAvailabilityVersion;
888         push(@headerContent, ";\n\n");
889     }
890
891     # - Begin @interface or @protocol
892     my $interfaceDeclaration = ($isProtocol ? "\@protocol $className" : "\@interface $className : $parentName");
893     $interfaceDeclaration .= " <" . join(", ", @protocolsToImplement) . ">" if @protocolsToImplement > 0;
894     $interfaceDeclaration .= "\n";
895
896     push(@headerContent, "WEBKIT_CLASS_AVAILABLE_MAC($interfaceAvailabilityVersion)\n") if length $interfaceAvailabilityVersion;
897     push(@headerContent, $interfaceDeclaration);
898
899     my @headerAttributes = ();
900     my @privateHeaderAttributes = ();
901
902     # - Add attribute getters/setters.
903     if ($numAttributes > 0) {
904         foreach my $attribute (@{$interface->attributes}) {
905             next if SkipAttribute($attribute);
906             my $attributeName = $attribute->signature->name;
907
908             if ($attributeName eq "id" or $attributeName eq "hash" or $attributeName eq "description") {
909                 # Special case some attributes (like id and hash) to have a "Name" suffix to avoid ObjC naming conflicts.
910                 $attributeName .= "Name";
911             } elsif ($attributeName eq "frame") {
912                 # Special case attribute frame to be frameBorders.
913                 $attributeName .= "Borders";
914             }
915
916             my $attributeType = GetObjCType($attribute->signature->type);
917             my $property = "\@property" . GetPropertyAttributes($attribute->signature->type, $attribute->isReadOnly);
918             $property .= " " . $attributeType . ($attributeType =~ /\*$/ ? "" : " ") . $attributeName;
919
920             my $publicInterfaceKey = $property . ";";
921
922             # FIXME: This only works for the getter, but not the setter.  Need to refactor this code.
923             if ($buildingForTigerOrEarlier && !$buildingForIPhone || IsCoreFoundationType($attributeType)) {
924                 $publicInterfaceKey = "- (" . $attributeType . ")" . $attributeName . ";";
925             }
926
927             my $availabilityMacro = "";
928             if (defined $publicInterfaces{$publicInterfaceKey} and length $publicInterfaces{$publicInterfaceKey}) {
929                 $availabilityMacro = $publicInterfaces{$publicInterfaceKey};
930             }
931
932             my $declarationSuffix = ";\n";
933             $declarationSuffix = " $availabilityMacro;\n" if length $availabilityMacro;
934
935             my $public = (defined $publicInterfaces{$publicInterfaceKey} or $newPublicClass);
936             delete $publicInterfaces{$publicInterfaceKey};
937
938             AddForwardDeclarationsForType($attribute->signature->type, $public);
939
940             my $setterName = "set" . ucfirst($attributeName) . ":";
941
942             my $conflict = $conflictMethod{$attributeName};
943             if ($conflict) {
944                 warn "$className conflicts with $conflict method $attributeName\n";
945                 $fatalError = 1;
946             }
947
948             $conflict = $conflictMethod{$setterName};
949             if ($conflict) {
950                 warn "$className conflicts with $conflict method $setterName\n";
951                 $fatalError = 1;
952             }
953
954             if (!IsCoreFoundationType($attributeType)) {
955                 $property .= $declarationSuffix;
956                 push(@headerAttributes, $property) if $public;
957                 push(@privateHeaderAttributes, $property) unless $public;
958             } else {
959                 my $attributeConditionalString = $codeGenerator->GenerateConditionalString($attribute->signature);
960                 if ($attributeConditionalString) {
961                     push(@headerAttributes, "#if ${attributeConditionalString}\n") if $public;
962                     push(@privateHeaderAttributes, "#if ${attributeConditionalString}\n") unless $public;
963                 }
964  
965                 # - GETTER
966                 my $getter = "- (" . $attributeType . ")" . $attributeName . $declarationSuffix;
967                 push(@headerAttributes, $getter) if $public;
968                 push(@privateHeaderAttributes, $getter) unless $public;
969  
970                 # - SETTER
971                 if (!$attribute->isReadOnly) {
972                     my $setter = "- (void)$setterName(" . $attributeType . ")new" . ucfirst($attributeName) . $declarationSuffix;
973                     push(@headerAttributes, $setter) if $public;
974                     push(@privateHeaderAttributes, $setter) unless $public;
975                 }
976  
977                 if ($attributeConditionalString) {
978                     push(@headerAttributes, "#endif\n") if $public;
979                     push(@privateHeaderAttributes, "#endif\n") unless $public;
980                 }
981             }
982         }
983
984         push(@headerContent, @headerAttributes) if @headerAttributes > 0;
985     }
986
987     my @headerFunctions = ();
988     my @privateHeaderFunctions = ();
989     my @deprecatedHeaderFunctions = ();
990
991     # - Add functions.
992     if ($numFunctions > 0) {
993         my %inAppleCopyright = (public => 0, private => 0);
994         foreach my $function (@{$interface->functions}) {
995             next if SkipFunction($function);
996             next if ($function->signature->name eq "set" and $interface->extendedAttributes->{"TypedArray"});
997             my $functionName = $function->signature->name;
998
999             my $returnType = GetObjCType($function->signature->type);
1000             my $needsDeprecatedVersion = (@{$function->parameters} > 1 and $function->signature->extendedAttributes->{"ObjCLegacyUnnamedParameters"});
1001             my $needsAppleCopyright = $function->signature->extendedAttributes->{"AppleCopyright"};
1002             my $numberOfParameters = @{$function->parameters};
1003             my %typesToForwardDeclare = ($function->signature->type => 1);
1004
1005             my $parameterIndex = 0;
1006             my $functionSig = "- ($returnType)$functionName";
1007             my $methodName = $functionName;
1008             foreach my $param (@{$function->parameters}) {
1009                 my $paramName = $param->name;
1010                 my $paramType = GetObjCType($param->type);
1011
1012                 $typesToForwardDeclare{$param->type} = 1;
1013
1014                 if ($parameterIndex >= 1) {
1015                     $functionSig .= " $paramName";
1016                     $methodName .= $paramName;
1017                 }
1018
1019                 $functionSig .= ":($paramType)$paramName";
1020                 $methodName .= ":";
1021
1022                 $parameterIndex++;
1023             }
1024
1025             my $publicInterfaceKey = $functionSig . ";";
1026
1027             my $conflict = $conflictMethod{$methodName};
1028             if ($conflict) {
1029                 warn "$className conflicts with $conflict method $methodName\n";
1030                 $fatalError = 1;
1031             }
1032
1033             if ($isProtocol && !$newPublicClass && !defined $publicInterfaces{$publicInterfaceKey}) {
1034                 warn "Protocol method $publicInterfaceKey is not in PublicDOMInterfaces.h. Protocols require all methods to be public";
1035                 $fatalError = 1;
1036             }
1037
1038             my $availabilityMacro = "";
1039             if (defined $publicInterfaces{$publicInterfaceKey} and length $publicInterfaces{$publicInterfaceKey}) {
1040                 $availabilityMacro = $publicInterfaces{$publicInterfaceKey};
1041             }
1042
1043             my $functionDeclaration = $functionSig;
1044             $functionDeclaration .= " " . $availabilityMacro if length $availabilityMacro;
1045             $functionDeclaration .= ";\n";
1046
1047             my $public = (defined $publicInterfaces{$publicInterfaceKey} or $newPublicClass);
1048             delete $publicInterfaces{$publicInterfaceKey};
1049
1050             foreach my $type (keys %typesToForwardDeclare) {
1051                 # add any forward declarations to the public header if a deprecated version will be generated
1052                 AddForwardDeclarationsForType($type, 1) if $needsDeprecatedVersion;
1053                 AddForwardDeclarationsForType($type, $public) unless $public and $needsDeprecatedVersion;
1054             }
1055
1056             if ($needsAppleCopyright) {
1057                 if (!$inAppleCopyright{$public ? "public" : "private"}) {
1058                     push(@headerFunctions, $beginAppleCopyrightForHeaderFiles) if $public;
1059                     push(@privateHeaderFunctions, $beginAppleCopyrightForHeaderFiles) unless $public;
1060                     $inAppleCopyright{$public ? "public" : "private"} = 1;
1061                 }
1062             } elsif ($inAppleCopyright{$public ? "public" : "private"}) {
1063                 push(@headerFunctions, $endAppleCopyright) if $public;
1064                 push(@privateHeaderFunctions, $endAppleCopyright) unless $public;
1065                 $inAppleCopyright{$public ? "public" : "private"} = 0;
1066             }
1067
1068             my $functionConditionalString = $codeGenerator->GenerateConditionalString($function->signature);
1069             if ($functionConditionalString) {
1070                 push(@headerFunctions, "#if ${functionConditionalString}\n") if $public;
1071                 push(@privateHeaderFunctions, "#if ${functionConditionalString}\n") unless $public;
1072                 push(@deprecatedHeaderFunctions, "#if ${functionConditionalString}\n") if $needsDeprecatedVersion;
1073             }
1074
1075             push(@headerFunctions, $functionDeclaration) if $public;
1076             push(@privateHeaderFunctions, $functionDeclaration) unless $public;
1077
1078             # generate the old style method names with un-named parameters, these methods are deprecated
1079             if ($needsDeprecatedVersion) {
1080                 my $deprecatedFunctionSig = $functionSig;
1081                 $deprecatedFunctionSig =~ s/\s\w+:/ :/g; # remove parameter names
1082
1083                 $publicInterfaceKey = $deprecatedFunctionSig . ";";
1084
1085                 my $availabilityMacro = "WEBKIT_DEPRECATED_MAC(10_4, 10_5)";
1086                 if (defined $publicInterfaces{$publicInterfaceKey} and length $publicInterfaces{$publicInterfaceKey}) {
1087                     $availabilityMacro = $publicInterfaces{$publicInterfaceKey};
1088                 }
1089
1090                 $functionDeclaration = "$deprecatedFunctionSig $availabilityMacro;\n";
1091
1092                 push(@deprecatedHeaderFunctions, $functionDeclaration);
1093
1094                 unless (defined $publicInterfaces{$publicInterfaceKey}) {
1095                     warn "Deprecated method $publicInterfaceKey is not in PublicDOMInterfaces.h. All deprecated methods need to be public, or should have the ObjCLegacyUnnamedParameters IDL attribute removed";
1096                     $fatalError = 1;
1097                 }
1098
1099                 delete $publicInterfaces{$publicInterfaceKey};
1100             }
1101
1102             if ($functionConditionalString) {
1103                 push(@headerFunctions, "#endif\n") if $public;
1104                 push(@privateHeaderFunctions, "#endif\n") unless $public;
1105                 push(@deprecatedHeaderFunctions, "#endif\n") if $needsDeprecatedVersion;
1106             }
1107         }
1108
1109         push(@headerFunctions, $endAppleCopyright) if $inAppleCopyright{"public"};
1110         push(@privateHeaderFunctions, $endAppleCopyright) if $inAppleCopyright{"private"};
1111
1112         if (@headerFunctions > 0) {
1113             push(@headerContent, "\n") if @headerAttributes > 0;
1114             push(@headerContent, @headerFunctions);
1115         }
1116     }
1117
1118     if (@deprecatedHeaderFunctions > 0 && $isProtocol) {
1119         push(@headerContent, @deprecatedHeaderFunctions);
1120     }
1121
1122     # - End @interface or @protocol
1123     push(@headerContent, "\@end\n");
1124
1125     if (@deprecatedHeaderFunctions > 0 && !$isProtocol) {
1126         # - Deprecated category @interface 
1127         push(@headerContent, "\n\@interface $className (" . $className . "Deprecated)\n");
1128         push(@headerContent, @deprecatedHeaderFunctions);
1129         push(@headerContent, "\@end\n");
1130     }
1131
1132     if ($interface->extendedAttributes->{"AppleCopyright"}) {
1133         push(@headerContent, split("\r", $endAppleCopyright));
1134     }
1135
1136     my %alwaysGenerateForNoSVGBuild = map { $_ => 1 } qw(DOMHTMLEmbedElement DOMHTMLObjectElement);
1137
1138     if (@privateHeaderAttributes > 0 or @privateHeaderFunctions > 0 or exists $alwaysGenerateForNoSVGBuild{$className}) {
1139         # - Private category @interface
1140         if ($interface->extendedAttributes->{"AppleCopyright"}) {
1141             @privateHeaderContentHeader = split("\r", $beginAppleCopyrightForHeaderFiles);
1142         } else {
1143             @privateHeaderContentHeader = split("\r", $headerLicenseTemplate);
1144         }
1145         push(@privateHeaderContentHeader, "\n");
1146
1147         my $classHeaderName = GetClassHeaderName($className);
1148         push(@privateHeaderContentHeader, "#import <WebCore/$classHeaderName.h>\n\n");
1149
1150         @privateHeaderContent = ();
1151         push(@privateHeaderContent, "\@interface $className (" . $className . "Private)\n");
1152         push(@privateHeaderContent, @privateHeaderAttributes) if @privateHeaderAttributes > 0;
1153         push(@privateHeaderContent, "\n") if @privateHeaderAttributes > 0 and @privateHeaderFunctions > 0;
1154         push(@privateHeaderContent, @privateHeaderFunctions) if @privateHeaderFunctions > 0;
1155         push(@privateHeaderContent, "\@end\n");
1156
1157         if ($interface->extendedAttributes->{"AppleCopyright"}) {
1158             push(@privateHeaderContent, split("\r", $endAppleCopyright));
1159         }
1160     }
1161
1162     unless ($isProtocol) {
1163         # Generate internal interfaces
1164         my $implClassName = GetImplClassName($interfaceName);
1165         my $implClassNameWithNamespace = "WebCore::" . $implClassName;
1166
1167         my $implType = $implClassNameWithNamespace;
1168         my ($svgPropertyType, $svgListPropertyType, $svgNativeType) = GetSVGPropertyTypes($implClassName);
1169         $implType = $svgNativeType if $svgNativeType;
1170
1171         # Generate interface definitions. 
1172         if ($interface->extendedAttributes->{"AppleCopyright"}) {
1173             @internalHeaderContent = split("\r", $beginAppleCopyrightForHeaderFiles);
1174         } else {
1175             @internalHeaderContent = split("\r", $implementationLicenseTemplate);
1176         }
1177
1178         push(@internalHeaderContent, "\n#import <WebCore/$className.h>\n\n");
1179         push(@internalHeaderContent, "#import <WebCore/SVGAnimatedPropertyTearOff.h>\n\n") if $svgPropertyType;
1180         if ($svgListPropertyType) {
1181             push(@internalHeaderContent, "#import <WebCore/SVGAnimatedListPropertyTearOff.h>\n\n");
1182             push(@internalHeaderContent, "#import <WebCore/SVGTransformListPropertyTearOff.h>\n\n") if $svgListPropertyType =~ /SVGTransformList/;
1183             push(@internalHeaderContent, "#import <WebCore/SVGPathSegListPropertyTearOff.h>\n\n") if $svgListPropertyType =~ /SVGPathSegList/;
1184         }
1185
1186         if ($interfaceName eq "Node") {
1187             push(@internalHeaderContent, "\@protocol DOMEventTarget;\n\n");
1188         }
1189
1190         my $startedNamespace = 0;
1191
1192         if ($codeGenerator->IsSVGAnimatedType($interfaceName)) {
1193             push(@internalHeaderContent, "#import <WebCore/$implClassName.h>\n\n");
1194         } else {
1195             push(@internalHeaderContent, "namespace WebCore {\n");
1196             $startedNamespace = 1;
1197             if ($interfaceName eq "Node") {
1198                 push(@internalHeaderContent, "class EventTarget;\n    class Node;\n");
1199             } else {
1200                 push(@internalHeaderContent, "class $implClassName;\n");
1201             }
1202             push(@internalHeaderContent, "}\n\n");
1203         }
1204
1205         push(@internalHeaderContent, "$implType* core($className *);\n");
1206         push(@internalHeaderContent, "$className *kit($implType*);\n");
1207
1208         if ($interface->extendedAttributes->{"ObjCPolymorphic"}) {
1209             push(@internalHeaderContent, "Class kitClass($implType*);\n");
1210         }
1211
1212         if ($interfaceName eq "Node") {
1213             push(@internalHeaderContent, "id <DOMEventTarget> kit(WebCore::EventTarget*);\n");
1214         }
1215     }
1216 }
1217
1218 sub GenerateImplementation
1219 {
1220     my $object = shift;
1221     my $interface = shift;
1222
1223     my @ancestorInterfaceNames = ();
1224
1225     if (@{$interface->parents} > 1) {
1226         AddMethodsConstantsAndAttributesFromParentInterfaces($interface, \@ancestorInterfaceNames);
1227     }
1228
1229     my $interfaceName = $interface->name;
1230     my $className = GetClassName($interfaceName);
1231     my $implClassName = GetImplClassName($interfaceName);
1232     my $parentImplClassName = GetParentImplClassName($interface);
1233     my $implClassNameWithNamespace = "WebCore::" . $implClassName;
1234     my $baseClass = GetBaseClass($parentImplClassName);
1235     my $classHeaderName = GetClassHeaderName($className);
1236
1237     my $numAttributes = @{$interface->attributes};
1238     my $numFunctions = @{$interface->functions};
1239     my $implType = $implClassNameWithNamespace;
1240
1241     my ($svgPropertyType, $svgListPropertyType, $svgNativeType) = GetSVGPropertyTypes($implClassName);
1242     $implType = $svgNativeType if $svgNativeType;
1243
1244     # - Add default header template.
1245     if ($interface->extendedAttributes->{"AppleCopyright"}) {
1246         @implContentHeader = split("\r", $beginAppleCopyrightForSourceFiles);
1247     } else {
1248         @implContentHeader = split("\r", $implementationLicenseTemplate);
1249     }
1250
1251     # - INCLUDES -
1252     push(@implContentHeader, "\n#import \"config.h\"\n");
1253
1254     my $conditionalString = $codeGenerator->GenerateConditionalString($interface);
1255     push(@implContentHeader, "\n#if ${conditionalString}\n\n") if $conditionalString;
1256
1257     push(@implContentHeader, "#import \"DOMInternal.h\"\n\n");
1258     push(@implContentHeader, "#import \"$classHeaderName.h\"\n\n");
1259
1260     $implIncludes{"ExceptionHandlers.h"} = 1;
1261     $implIncludes{"ThreadCheck.h"} = 1;
1262     $implIncludes{"JSMainThreadExecState.h"} = 1;
1263     $implIncludes{"WebScriptObjectPrivate.h"} = 1;
1264     $implIncludes{$classHeaderName . "Internal.h"} = 1;
1265     $implIncludes{"DOMNodeInternal.h"} = 1;
1266
1267     $implIncludes{"DOMBlobInternal.h"} = 1 if $interfaceName eq "File";
1268     $implIncludes{"DOMCSSRuleInternal.h"} = 1 if $interfaceName =~ /.*CSS.*Rule/;
1269     $implIncludes{"DOMCSSValueInternal.h"} = 1 if $interfaceName =~ /.*CSS.*Value/;
1270     $implIncludes{"DOMEventInternal.h"} = 1 if $interfaceName =~ /.*Event/;
1271     $implIncludes{"DOMStyleSheetInternal.h"} = 1 if $interfaceName eq "CSSStyleSheet";
1272     $implIncludes{"DOMSVGPathSegInternal.h"} = 1 if $interfaceName =~ /^SVGPathSeg.+/;
1273
1274     if ($interfaceName =~ /(\w+)(Abs|Rel)$/) {
1275         $implIncludes{"$1.h"} = 1;
1276     } else {
1277         if (!$codeGenerator->SkipIncludeHeader($implClassName)) {
1278             $implIncludes{"$implClassName.h"} = 1 ;
1279         } elsif ($codeGenerator->IsSVGTypeNeedingTearOff($implClassName)) {
1280             my $includeType = $codeGenerator->GetSVGWrappedTypeNeedingTearOff($implClassName);
1281             $implIncludes{"${includeType}.h"} = 1;
1282         }
1283     } 
1284
1285     @implContent = ();
1286
1287     push(@implContent, "#import <wtf/GetPtr.h>\n\n");
1288
1289     # add implementation accessor
1290     if ($parentImplClassName eq "Object") {
1291         push(@implContent, "#define IMPL reinterpret_cast<$implType*>(_internal)\n\n");
1292     } else {
1293         my $baseClassWithNamespace = "WebCore::$baseClass";
1294         push(@implContent, "#define IMPL static_cast<$implClassNameWithNamespace*>(reinterpret_cast<$baseClassWithNamespace*>(_internal))\n\n");
1295     }
1296
1297     # START implementation
1298     push(@implContent, "\@implementation $className\n\n");
1299
1300     # Only generate 'dealloc' and 'finalize' methods for direct subclasses of DOMObject.
1301     if ($parentImplClassName eq "Object") {
1302         $implIncludes{"WebCoreObjCExtras.h"} = 1;
1303         push(@implContent, "- (void)dealloc\n");
1304         push(@implContent, "{\n");
1305         push(@implContent, "    if (WebCoreObjCScheduleDeallocateOnMainThread([$className class], self))\n");
1306         push(@implContent, "        return;\n");
1307         push(@implContent, "\n");
1308         if ($interfaceName eq "NodeIterator") {
1309             push(@implContent, "    if (_internal) {\n");
1310             push(@implContent, "        [self detach];\n");
1311             push(@implContent, "        IMPL->deref();\n");
1312             push(@implContent, "    };\n");
1313         } else {
1314             push(@implContent, "    if (_internal)\n");
1315             push(@implContent, "        IMPL->deref();\n");
1316         }
1317         push(@implContent, "    [super dealloc];\n");
1318         push(@implContent, "}\n\n");
1319
1320         push(@implContent, "- (void)finalize\n");
1321         push(@implContent, "{\n");
1322         if ($interfaceName eq "NodeIterator") {
1323             push(@implContent, "    if (_internal) {\n");
1324             push(@implContent, "        [self detach];\n");
1325             push(@implContent, "        IMPL->deref();\n");
1326             push(@implContent, "    };\n");
1327         } else {
1328             push(@implContent, "    if (_internal)\n");
1329             push(@implContent, "        IMPL->deref();\n");
1330         }
1331         push(@implContent, "    [super finalize];\n");
1332         push(@implContent, "}\n\n");
1333         
1334     }
1335
1336     %attributeNames = ();
1337
1338     # - Attributes
1339     if ($numAttributes > 0) {
1340         foreach my $attribute (@{$interface->attributes}) {
1341             next if SkipAttribute($attribute);
1342             AddIncludesForType($attribute->signature->type);
1343
1344             my $idlType = $attribute->signature->type;
1345
1346             my $attributeName = $attribute->signature->name;
1347             my $attributeType = GetObjCType($attribute->signature->type);
1348             my $attributeClassName = GetClassName($attribute->signature->type);
1349
1350             my $attributeInterfaceName = $attributeName;
1351             if ($attributeName eq "id" or $attributeName eq "hash" or $attributeName eq "description") {
1352                 # Special case some attributes (like id and hash) to have a "Name" suffix to avoid ObjC naming conflicts.
1353                 $attributeInterfaceName .= "Name";
1354             } elsif ($attributeName eq "frame") {
1355                 # Special case attribute frame to be frameBorders.
1356                 $attributeInterfaceName .= "Borders";
1357             }
1358
1359             $attributeNames{$attributeInterfaceName} = 1;
1360
1361             # - GETTER
1362             my $getterSig = "- ($attributeType)$attributeInterfaceName\n";
1363
1364             my ($functionName, @arguments) = $codeGenerator->GetterExpression(\%implIncludes, $interfaceName, $attribute);
1365
1366             # To avoid bloating Obj-C bindings, we use getAttribute() instead of fastGetAttribute().
1367             if ($functionName eq "fastGetAttribute") {
1368                 $functionName = "getAttribute";
1369             }
1370
1371             my $getterExpressionPrefix = "$functionName(" . join(", ", @arguments);
1372
1373             # FIXME: Special case attribute ownerDocument to call document. This makes it return the
1374             # document when called on the document itself. Legacy behavior, see <https://bugs.webkit.org/show_bug.cgi?id=10889>.
1375             $getterExpressionPrefix =~ s/\bownerDocument\b/document/;
1376
1377             my $hasGetterException = $attribute->signature->extendedAttributes->{"GetterRaisesException"};
1378             my $getterContentHead;
1379             if ($attribute->signature->extendedAttributes->{"ImplementedBy"}) {
1380                 my $implementedBy = $attribute->signature->extendedAttributes->{"ImplementedBy"};
1381                 $implIncludes{"${implementedBy}.h"} = 1;
1382                 $getterContentHead = "${implementedBy}::${getterExpressionPrefix}IMPL";
1383             } else {
1384                 $getterContentHead = "IMPL->$getterExpressionPrefix";
1385             }
1386
1387             my $getterContentTail = ")";
1388
1389             if ($svgPropertyType) {
1390                 $getterContentHead = "$getterExpressionPrefix";
1391
1392                 # TODO: Handle special case for DOMSVGLength. We do need Custom code support for this.
1393                 if ($svgPropertyType eq "WebCore::SVGLength" and $attributeName eq "value") {
1394                     $getterContentHead = "value(WebCore::SVGLengthContext(IMPL->contextElement()), ";
1395                 }
1396             }
1397
1398             my $attributeTypeSansPtr = $attributeType;
1399             $attributeTypeSansPtr =~ s/ \*$//; # Remove trailing " *" from pointer types.
1400
1401             # special case for EventTarget protocol
1402             $attributeTypeSansPtr = "DOMNode" if $idlType eq "EventTarget";
1403
1404             # Special cases
1405             my @customGetterContent = (); 
1406             if ($attributeTypeSansPtr eq "DOMImplementation") {
1407                 # FIXME: We have to special case DOMImplementation until DOMImplementationFront is removed
1408                 $getterContentHead = "kit(implementationFront(IMPL";
1409                 $getterContentTail .= ")";
1410             } elsif ($attributeName =~ /(\w+)DisplayString$/) {
1411                 my $attributeToDisplay = $1;
1412                 $getterContentHead = "WebCore::displayString(IMPL->$attributeToDisplay(), core(self)";
1413                 $implIncludes{"HitTestResult.h"} = 1;
1414             } elsif ($attributeName =~ /^absolute(\w+)URL$/) {
1415                 my $typeOfURL = $1;
1416                 $getterContentHead = "[self _getURLAttribute:";
1417                 if ($typeOfURL eq "Link") {
1418                     $getterContentTail = "\@\"href\"]";
1419                 } elsif ($typeOfURL eq "Image") {
1420                     if ($interfaceName eq "HTMLObjectElement") {
1421                         $getterContentTail = "\@\"data\"]";
1422                     } else {
1423                         $getterContentTail = "\@\"src\"]";
1424                     }
1425                     unless ($interfaceName eq "HTMLImageElement") {
1426                         push(@customGetterContent, "    if (!IMPL->renderer() || !IMPL->renderer()->isImage())\n");
1427                         push(@customGetterContent, "        return nil;\n");
1428                         $implIncludes{"RenderElement.h"} = 1;
1429                     }
1430                 }
1431                 $implIncludes{"DOMPrivate.h"} = 1;
1432             } elsif ($attribute->signature->extendedAttributes->{"ObjCImplementedAsUnsignedLong"}) {
1433                 $getterContentHead = "WTF::String::number(" . $getterContentHead;
1434                 $getterContentTail .= ")";
1435             } elsif ($idlType eq "Date") {
1436                 $getterContentHead = "kit($getterContentHead";
1437                 $getterContentTail .= ")";
1438             } elsif ($svgPropertyType) {
1439                 # Special case for DOMSVGNumber
1440                 if ($svgPropertyType eq "float") {
1441                     # Intentional leave out closing brace, it's already contained in getterContentTail
1442                     $getterContentHead = "IMPL->propertyReference(";
1443                 } else {    
1444                     $getterContentHead = "IMPL->propertyReference().$getterContentHead";
1445                 }
1446
1447                 if ($codeGenerator->IsSVGTypeWithWritablePropertiesNeedingTearOff($idlType) and not defined $attribute->signature->extendedAttributes->{"Immutable"}) {
1448                     my $getter = $getterContentHead;
1449                     $getter =~ s/\(\)//;
1450                     
1451                     my $tearOffType = GetSVGTypeWithNamespace($idlType);
1452                     my $selfIsTearOffType = $codeGenerator->IsSVGTypeNeedingTearOff($implClassName);
1453                     if ($selfIsTearOffType) {
1454                         $implIncludes{"SVGStaticPropertyWithParentTearOff.h"} = 1;
1455                         $tearOffType =~ s/SVGPropertyTearOff</SVGStaticPropertyWithParentTearOff<$implClassNameWithNamespace, /;
1456
1457                         my $getter = $getterExpressionPrefix;
1458                         $getter =~ s/IMPL->//;
1459                         $getter =~ s/\(//;
1460                         my $updateMethod = "&${implClassNameWithNamespace}::update" . $codeGenerator->WK_ucfirst($getter);
1461
1462                         $getterContentHead = "${tearOffType}::create(IMPL, $getterContentHead$getterContentTail, $updateMethod)";
1463
1464                         $getterContentHead = "kit(WTF::getPtr($getterContentHead";
1465                         $getterContentTail = "))";
1466                     }
1467                 }
1468             } elsif (($codeGenerator->IsSVGAnimatedType($implClassName) or $implClassName eq "SVGViewSpec") and $codeGenerator->IsSVGTypeNeedingTearOff($idlType)) {
1469                 my $idlTypeWithNamespace = GetSVGTypeWithNamespace($idlType);
1470                 $getterContentHead = "kit(static_cast<$idlTypeWithNamespace*>($getterContentHead)";
1471                 $getterContentTail .= ")";
1472             } elsif (IsProtocolType($idlType) and $idlType ne "EventTarget") {
1473                 $getterContentHead = "kit($getterContentHead";
1474                 $getterContentTail .= ")";
1475             } elsif ($idlType eq "Color") {
1476                 if ($buildingForIPhone) {
1477                     $getterContentHead = "WebCore::cachedCGColor($getterContentHead";
1478                     $getterContentTail .= ", WebCore::ColorSpaceDeviceRGB)";
1479                 } else {
1480                     $getterContentHead = "WebCore::nsColor($getterContentHead";
1481                     $getterContentTail .= ")";
1482                 }
1483             } elsif ($attribute->signature->type eq "SerializedScriptValue") {
1484                 $getterContentHead = "$getterContentHead";
1485                 $getterContentTail .= "->toString()";                
1486             } elsif (ConversionNeeded($attribute->signature->type)) {
1487                 my $type = $attribute->signature->type;
1488                 if ($codeGenerator->IsSVGTypeNeedingTearOff($type) and not $implClassName =~ /List$/) {
1489                     my $idlTypeWithNamespace = GetSVGTypeWithNamespace($type);
1490                     $implIncludes{"$type.h"} = 1 if not $codeGenerator->SkipIncludeHeader($type);
1491                     if ($codeGenerator->IsSVGTypeWithWritablePropertiesNeedingTearOff($type) and not defined $attribute->signature->extendedAttributes->{"Immutable"}) {
1492                         $idlTypeWithNamespace =~ s/SVGPropertyTearOff</SVGStaticPropertyTearOff<$implClassNameWithNamespace, /;
1493                         $implIncludes{"SVGStaticPropertyTearOff.h"} = 1;
1494
1495                         my $getter = $getterContentHead;
1496                         $getter =~ s/IMPL->//;
1497                         $getter =~ s/\(//;
1498                         my $updateMethod = "&${implClassNameWithNamespace}::update" . $codeGenerator->WK_ucfirst($getter);
1499                         $getterContentHead = "kit(WTF::getPtr(${idlTypeWithNamespace}::create(IMPL, $getterContentHead$getterContentTail, $updateMethod";
1500                         $getterContentTail .= "))";
1501                     } elsif ($idlTypeWithNamespace =~ /SVG(Point|PathSeg)List/) {
1502                         $getterContentHead = "kit(WTF::getPtr($getterContentHead";
1503                         $getterContentTail .= "))";
1504                     } elsif ($idlTypeWithNamespace =~ /SVGStaticListPropertyTearOff/) {
1505                         $getterContentHead = "kit(WTF::getPtr(${idlTypeWithNamespace}::create(IMPL, $getterContentHead";
1506                         $getterContentTail .= ")))";
1507                     } else {
1508                         $getterContentHead = "kit(WTF::getPtr(${idlTypeWithNamespace}::create($getterContentHead";
1509                         $getterContentTail .= ")))";
1510                     }
1511                 } else {
1512                     $getterContentHead = "kit(WTF::getPtr($getterContentHead";
1513                     $getterContentTail .= "))";
1514                 }
1515             }
1516
1517             my $getterContent;
1518             if ($hasGetterException || $attribute->signature->isNullable) {
1519                 $getterContent = $getterContentHead;
1520                 my $getterWithoutAttributes = $getterContentHead =~ /\($|, $/ ? "ec" : ", ec";
1521                 if ($attribute->signature->isNullable) {
1522                     $getterContent .= $getterWithoutAttributes ? "isNull" : ", isNull";
1523                     $getterWithoutAttributes = 0;
1524                 }
1525                 if ($hasGetterException) {
1526                     $getterContent .= $getterWithoutAttributes ? "ec" : ", ec";
1527                 }
1528                 $getterContent .= $getterContentTail;
1529             } else {
1530                 $getterContent = $getterContentHead . $getterContentTail;
1531             }
1532
1533             my $attributeConditionalString = $codeGenerator->GenerateConditionalString($attribute->signature);
1534             push(@implContent, "#if ${attributeConditionalString}\n") if $attributeConditionalString;
1535             push(@implContent, $getterSig);
1536             push(@implContent, "{\n");
1537             push(@implContent, "    $jsContextSetter\n");
1538             push(@implContent, @customGetterContent);
1539
1540             # FIXME: Should we return a default value when isNull == true?
1541             if ($attribute->signature->isNullable) {
1542                 push(@implContents, "    $nullableInit\n");
1543             }
1544
1545             if ($hasGetterException) {
1546                 # Differentiated between when the return type is a pointer and
1547                 # not for white space issue (ie. Foo *result vs. int result).
1548                 if ($attributeType =~ /\*$/) {
1549                     $getterContent = $attributeType . "result = " . $getterContent;
1550                 } else {
1551                     $getterContent = $attributeType . " result = " . $getterContent;
1552                 }
1553
1554                 push(@implContent, "    $exceptionInit\n");
1555                 push(@implContent, "    $getterContent;\n");
1556                 push(@implContent, "    $exceptionRaiseOnError\n");
1557                 push(@implContent, "    return result;\n");
1558             } else {
1559                 push(@implContent, "    return $getterContent;\n");
1560             }
1561             push(@implContent, "}\n");
1562
1563             # - SETTER
1564             if (!$attribute->isReadOnly) {
1565                 # Exception handling
1566                 my $hasSetterException = $attribute->signature->extendedAttributes->{"SetterRaisesException"};
1567
1568                 my $coreSetterName = "set" . $codeGenerator->WK_ucfirst($attributeName);
1569                 my $setterName = "set" . ucfirst($attributeInterfaceName);
1570                 my $argName = "new" . ucfirst($attributeInterfaceName);
1571                 my $arg = GetObjCTypeGetter($argName, $idlType);
1572
1573                 # The definition of ObjCImplementedAsUnsignedLong is flipped for the setter
1574                 if ($attribute->signature->extendedAttributes->{"ObjCImplementedAsUnsignedLong"}) {
1575                     $arg = "WTF::String($arg).toInt()";
1576                 }
1577
1578                 my $setterSig = "- (void)$setterName:($attributeType)$argName\n";
1579
1580                 push(@implContent, "\n");
1581                 push(@implContent, $setterSig);
1582                 push(@implContent, "{\n");
1583                 push(@implContent, "    $jsContextSetter\n");
1584
1585                 unless ($codeGenerator->IsPrimitiveType($idlType) or $codeGenerator->IsStringType($idlType)) {
1586                     push(@implContent, "    ASSERT($argName);\n\n");
1587                 }
1588
1589                 if ($idlType eq "Date") {
1590                     $arg = "core(" . $arg . ")";
1591                 }
1592
1593                 if ($svgPropertyType) {
1594                     $implIncludes{"ExceptionCode.h"} = 1;
1595                     $getterContentHead = "$getterExpressionPrefix";
1596                     push(@implContent, "    if (IMPL->isReadOnly()) {\n");
1597                     push(@implContent, "        WebCore::raiseOnDOMError(WebCore::NO_MODIFICATION_ALLOWED_ERR);\n");
1598                     push(@implContent, "        return;\n");
1599                     push(@implContent, "    }\n");
1600                     push(@implContent, "    $svgPropertyType& podImpl = IMPL->propertyReference();\n");
1601                     my $ec = $hasSetterException ? ", ec" : "";
1602                     push(@implContent, "    $exceptionInit\n") if $hasSetterException;
1603
1604                     # Special case for DOMSVGNumber
1605                     if ($svgPropertyType eq "float") {
1606                         push(@implContent, "    podImpl = $arg;\n");
1607                     } else {
1608                         # FIXME: Special case for DOMSVGLength. We do need Custom code support for this.
1609                         if ($svgPropertyType eq "WebCore::SVGLength" and $attributeName eq "value") {
1610                             push(@implContent, "    podImpl.$coreSetterName($arg, WebCore::SVGLengthContext(IMPL->contextElement())$ec);\n");
1611                         } else {
1612                             push(@implContent, "    podImpl.$coreSetterName($arg$ec);\n");
1613                         }
1614                     }
1615
1616                     if ($hasSetterException) {
1617                         push(@implContent, "    if (!ec)\n");
1618                         push(@implContent, "        IMPL->commitChange();\n");
1619                         push(@implContent, "    $exceptionRaiseOnError\n");
1620                     } else {
1621                         push(@implContent, "    IMPL->commitChange();\n");
1622                     }
1623                 } elsif ($svgListPropertyType) {
1624                     $getterContentHead = "$getterExpressionPrefix";
1625                     push(@implContent, "    IMPL->$coreSetterName($arg);\n");
1626                 } else {
1627                     my ($functionName, @arguments) = $codeGenerator->SetterExpression(\%implIncludes, $interfaceName, $attribute);
1628                     push(@arguments, $arg);
1629                     push(@arguments, "ec") if $hasSetterException;
1630                     push(@implContent, "    $exceptionInit\n") if $hasSetterException;
1631                     if ($attribute->signature->extendedAttributes->{"ImplementedBy"}) {
1632                         my $implementedBy = $attribute->signature->extendedAttributes->{"ImplementedBy"};
1633                         $implIncludes{"${implementedBy}.h"} = 1;
1634                         unshift(@arguments, "IMPL");
1635                         $functionName = "${implementedBy}::${functionName}";
1636                     } else {
1637                         $functionName = "IMPL->${functionName}";
1638                     }
1639                     push(@implContent, "    ${functionName}(" . join(", ", @arguments) . ");\n");
1640                     push(@implContent, "    $exceptionRaiseOnError\n") if $hasSetterException;
1641                 }
1642
1643                 push(@implContent, "}\n");
1644             }
1645
1646             push(@implContent, "#endif\n") if $attributeConditionalString;
1647             push(@implContent, "\n");
1648         }
1649     }
1650
1651     # - Functions
1652     if ($numFunctions > 0) {
1653         my $inAppleCopyright = 0;
1654         foreach my $function (@{$interface->functions}) {
1655             next if SkipFunction($function);
1656             next if ($function->signature->name eq "set" and $interface->extendedAttributes->{"TypedArray"});
1657             AddIncludesForType($function->signature->type);
1658
1659             my $functionName = $function->signature->name;
1660             my $returnType = GetObjCType($function->signature->type);
1661             my $needsAppleCopyright = $function->signature->extendedAttributes->{"AppleCopyright"};
1662             my $hasParameters = @{$function->parameters};
1663             my $raisesExceptions = $function->signature->extendedAttributes->{"RaisesException"};
1664
1665             my @parameterNames = ();
1666             my @needsAssert = ();
1667             my %needsCustom = ();
1668
1669             my $parameterIndex = 0;
1670             my $functionSig = "- ($returnType)$functionName";
1671             foreach my $param (@{$function->parameters}) {
1672                 my $paramName = $param->name;
1673                 my $paramType = GetObjCType($param->type);
1674
1675                 # make a new parameter name if the original conflicts with a property name
1676                 $paramName = "in" . ucfirst($paramName) if $attributeNames{$paramName};
1677
1678                 AddIncludesForType($param->type);
1679
1680                 my $idlType = $param->type;
1681                 my $implGetter = GetObjCTypeGetter($paramName, $idlType);
1682
1683                 push(@parameterNames, $implGetter);
1684                 $needsCustom{"XPathNSResolver"} = $paramName if $idlType eq "XPathNSResolver";
1685                 $needsCustom{"NodeFilter"} = $paramName if $idlType eq "NodeFilter";
1686                 $needsCustom{"EventListener"} = $paramName if $idlType eq "EventListener";
1687                 $needsCustom{"EventTarget"} = $paramName if $idlType eq "EventTarget";
1688                 $needsCustom{"NodeToReturn"} = $paramName if $param->extendedAttributes->{"CustomReturn"};
1689
1690                 unless ($codeGenerator->IsPrimitiveType($idlType) or $codeGenerator->IsStringType($idlType)) {
1691                     push(@needsAssert, "    ASSERT($paramName);\n");
1692                 }
1693
1694                 if ($parameterIndex >= 1) {
1695                     $functionSig .= " " . $param->name;
1696                 }
1697
1698                 $functionSig .= ":($paramType)$paramName";
1699
1700                 $parameterIndex++;
1701             }
1702
1703             my @functionContent = ();
1704             my $caller = "IMPL";
1705
1706             # special case the XPathNSResolver
1707             if (defined $needsCustom{"XPathNSResolver"}) {
1708                 my $paramName = $needsCustom{"XPathNSResolver"};
1709                 push(@functionContent, "    WebCore::XPathNSResolver* nativeResolver = 0;\n");
1710                 push(@functionContent, "    RefPtr<WebCore::XPathNSResolver> customResolver;\n");
1711                 push(@functionContent, "    if ($paramName) {\n");
1712                 push(@functionContent, "        if ([$paramName isMemberOfClass:[DOMNativeXPathNSResolver class]])\n");
1713                 push(@functionContent, "            nativeResolver = core(static_cast<DOMNativeXPathNSResolver *>($paramName));\n");
1714                 push(@functionContent, "        else {\n");
1715                 push(@functionContent, "            customResolver = WebCore::DOMCustomXPathNSResolver::create($paramName);\n");
1716                 push(@functionContent, "            nativeResolver = WTF::getPtr(customResolver);\n");
1717                 push(@functionContent, "        }\n");
1718                 push(@functionContent, "    }\n");
1719             }
1720
1721             # special case the EventTarget
1722             if (defined $needsCustom{"EventTarget"}) {
1723                 my $paramName = $needsCustom{"EventTarget"};
1724                 push(@functionContent, "    DOMNode* ${paramName}ObjC = $paramName;\n");
1725                 push(@functionContent, "    WebCore::Node* ${paramName}Node = core(${paramName}ObjC);\n");
1726                 $implIncludes{"DOMNode.h"} = 1;
1727                 $implIncludes{"Node.h"} = 1;
1728             }
1729
1730             if ($function->signature->extendedAttributes->{"ObjCUseDefaultView"}) {
1731                 push(@functionContent, "    WebCore::DOMWindow* dv = $caller->defaultView();\n");
1732                 push(@functionContent, "    if (!dv)\n");
1733                 push(@functionContent, "        return nil;\n");
1734                 $implIncludes{"DOMWindow.h"} = 1;
1735                 $caller = "dv";
1736             }
1737
1738             # special case the EventListener
1739             if (defined $needsCustom{"EventListener"}) {
1740                 my $paramName = $needsCustom{"EventListener"};
1741                 push(@functionContent, "    RefPtr<WebCore::EventListener> nativeEventListener = WebCore::ObjCEventListener::wrap($paramName);\n");
1742             }
1743
1744             # special case the NodeFilter
1745             if (defined $needsCustom{"NodeFilter"}) {
1746                 my $paramName = $needsCustom{"NodeFilter"};
1747                 push(@functionContent, "    RefPtr<WebCore::NodeFilter> nativeNodeFilter;\n");
1748                 push(@functionContent, "    if ($paramName)\n");
1749                 push(@functionContent, "        nativeNodeFilter = WebCore::NodeFilter::create(WebCore::ObjCNodeFilterCondition::create($paramName));\n");
1750             }
1751
1752             # FIXME! We need [Custom] support for ObjC, to move these hacks into DOMSVGLength/MatrixCustom.mm
1753             my $svgLengthConvertToSpecifiedUnits = ($svgPropertyType and $svgPropertyType eq "WebCore::SVGLength" and $functionName eq "convertToSpecifiedUnits");
1754
1755             push(@parameterNames, "WebCore::SVGLengthContext(IMPL->contextElement())") if $svgLengthConvertToSpecifiedUnits; 
1756             push(@parameterNames, "ec") if $raisesExceptions;
1757
1758             # Handle arguments that are 'SVGProperty' based (SVGAngle/SVGLength). We need to convert from SVGPropertyTearOff<Type>* to Type,
1759             # to be able to call the desired WebCore function. If the conversion fails, we can't extract Type and need to raise an exception.
1760             my $currentParameter = -1;
1761             foreach my $param (@{$function->parameters}) {
1762                 $currentParameter++;
1763
1764                 my $paramName = $param->name;
1765
1766                 # make a new parameter name if the original conflicts with a property name
1767                 $paramName = "in" . ucfirst($paramName) if $attributeNames{$paramName};
1768
1769                 my $idlType = $param->type;
1770                 next if not $codeGenerator->IsSVGTypeNeedingTearOff($idlType) or $implClassName =~ /List$/;
1771
1772                 my $implGetter = GetObjCTypeGetter($paramName, $idlType);
1773                 my $idlTypeWithNamespace = GetSVGTypeWithNamespace($idlType);
1774
1775                 $implIncludes{"ExceptionCode.h"} = 1;
1776                 push(@functionContent, "    $idlTypeWithNamespace* ${paramName}Core = $implGetter;\n");
1777                 push(@functionContent, "    if (!${paramName}Core) {\n");
1778                 push(@functionContent, "        WebCore::ExceptionCode ec = WebCore::TYPE_MISMATCH_ERR;\n");
1779                 push(@functionContent, "        $exceptionRaiseOnError\n");
1780                 if ($returnType eq "void") { 
1781                     push(@functionContent, "        return;\n");
1782                 } else {
1783                     push(@functionContent, "        return nil;\n");
1784                 }
1785                 push(@functionContent, "    }\n");
1786
1787                 # Replace the paramter core() getter, by the cached variable.
1788                 splice(@parameterNames, $currentParameter, 1, "${paramName}Core->propertyReference()");
1789             }
1790
1791             my $content;
1792             if ($function->signature->extendedAttributes->{"ImplementedBy"}) {
1793                 my $implementedBy = $function->signature->extendedAttributes->{"ImplementedBy"};
1794                 $implIncludes{"${implementedBy}.h"} = 1;
1795                 unshift(@parameterNames, $caller);
1796                 $content = "${implementedBy}::" . $codeGenerator->WK_lcfirst($functionName) . "(" . join(", ", @parameterNames) . ")";
1797             } elsif ($svgPropertyType) {
1798                 $implIncludes{"ExceptionCode.h"} = 1;
1799                 push(@functionContent, "    if (IMPL->isReadOnly()) {\n");
1800                 push(@functionContent, "        WebCore::raiseOnDOMError(WebCore::NO_MODIFICATION_ALLOWED_ERR);\n");
1801                 if ($returnType eq "void") {
1802                     push(@functionContent, "        return;\n");
1803                 } else {
1804                     push(@functionContent, "        return nil;\n");
1805                 }
1806                 push(@functionContent, "    }\n");
1807                 push(@functionContent, "    $svgPropertyType& podImpl = IMPL->propertyReference();\n");
1808                 $content = "podImpl." . $codeGenerator->WK_lcfirst($functionName) . "(" . join(", ", @parameterNames) . ")";
1809             } else {
1810                 $content = "$caller->" . $codeGenerator->WK_lcfirst($functionName) . "(" . join(", ", @parameterNames) . ")";
1811             }
1812
1813             if ($returnType eq "void") {
1814                 # Special case 'void' return type.
1815                 if ($raisesExceptions) {
1816                     push(@functionContent, "    $exceptionInit\n");
1817                     push(@functionContent, "    $content;\n");
1818                     if ($svgPropertyType) {
1819                         push(@functionContent, "    if (!ec)\n");
1820                         push(@functionContent, "        IMPL->commitChange();\n");
1821                     }
1822                     push(@functionContent, "    $exceptionRaiseOnError\n");
1823                 } else {
1824                     push(@functionContent, "    $content;\n");
1825                     push(@functionContent, "    IMPL->commitChange();\n") if $svgPropertyType;
1826                 }
1827             } elsif (defined $needsCustom{"NodeToReturn"}) {
1828                 # Special case the insertBefore, replaceChild, removeChild 
1829                 # and appendChild functions from DOMNode 
1830                 my $toReturn = $needsCustom{"NodeToReturn"};
1831                 if ($raisesExceptions) {
1832                     push(@functionContent, "    $exceptionInit\n");
1833                     push(@functionContent, "    if ($content)\n");
1834                     push(@functionContent, "        return $toReturn;\n");
1835                     push(@functionContent, "    $exceptionRaiseOnError\n");
1836                     push(@functionContent, "    return nil;\n");
1837                 } else {
1838                     push(@functionContent, "    if ($content)\n");
1839                     push(@functionContent, "        return $toReturn;\n");
1840                     push(@functionContent, "    return nil;\n");
1841                 }
1842             } elsif ($returnType eq "SerializedScriptValue") {
1843                 $content = "foo";
1844             } else {
1845                 if (ConversionNeeded($function->signature->type)) {
1846                     if ($codeGenerator->IsSVGTypeNeedingTearOff($function->signature->type) and not $implClassName =~ /List$/) {
1847                         my $idlTypeWithNamespace = GetSVGTypeWithNamespace($function->signature->type);
1848                         $content = "kit(WTF::getPtr(${idlTypeWithNamespace}::create($content)))";
1849                     } else {
1850                         $content = "kit(WTF::getPtr($content))";
1851                     }
1852                 }
1853
1854                 if ($raisesExceptions) {
1855                     # Differentiated between when the return type is a pointer and
1856                     # not for white space issue (ie. Foo *result vs. int result).
1857                     if ($returnType =~ /\*$/) {
1858                         $content = $returnType . "result = " . $content;
1859                     } else {
1860                         $content = $returnType . " result = " . $content;
1861                     }
1862
1863                     push(@functionContent, "    $exceptionInit\n");
1864                     push(@functionContent, "    $content;\n");
1865                     push(@functionContent, "    $exceptionRaiseOnError\n");
1866                     push(@functionContent, "    return result;\n");
1867                 } else {
1868                     push(@functionContent, "    return $content;\n");
1869                 }
1870             }
1871
1872             if ($needsAppleCopyright) {
1873                 if (!$inAppleCopyright) {
1874                     push(@implContent, $beginAppleCopyrightForSourceFiles);
1875                     $inAppleCopyright = 1;
1876                 }
1877             } elsif ($inAppleCopyright) {
1878                 push(@implContent, $endAppleCopyright);
1879                 $inAppleCopyright = 0;
1880             }
1881
1882             my $conditionalString = $codeGenerator->GenerateConditionalString($function->signature);
1883             push(@implContent, "\n#if ${conditionalString}\n") if $conditionalString;
1884
1885             push(@implContent, "$functionSig\n");
1886             push(@implContent, "{\n");
1887             push(@implContent, "    $jsContextSetter\n");
1888             push(@implContent, @functionContent);
1889             push(@implContent, "}\n\n");
1890
1891             push(@implContent, "#endif\n\n") if $conditionalString;
1892
1893             # generate the old style method names with un-named parameters, these methods are deprecated
1894             if (@{$function->parameters} > 1 and $function->signature->extendedAttributes->{"ObjCLegacyUnnamedParameters"}) {
1895                 my $deprecatedFunctionSig = $functionSig;
1896                 $deprecatedFunctionSig =~ s/\s\w+:/ :/g; # remove parameter names
1897
1898                 push(@implContent, "$deprecatedFunctionSig\n");
1899                 push(@implContent, "{\n");
1900                 push(@implContent, "    $jsContextSetter\n");
1901                 push(@implContent, @functionContent);
1902                 push(@implContent, "}\n\n");
1903             }
1904
1905             # Clear the hash
1906             %needsCustom = ();
1907         }
1908         push(@implContent, $endAppleCopyright) if $inAppleCopyright;
1909     }
1910
1911     # END implementation
1912     push(@implContent, "\@end\n");
1913
1914     if ($interface->extendedAttributes->{"AppleCopyright"}) {
1915         push(@implContent, split("\r", $endAppleCopyright));
1916     }
1917
1918     # Generate internal interfaces
1919     push(@implContent, "\n$implType* core($className *wrapper)\n");
1920     push(@implContent, "{\n");
1921     push(@implContent, "    return wrapper ? reinterpret_cast<$implType*>(wrapper->_internal) : 0;\n");
1922     push(@implContent, "}\n\n");
1923
1924     if ($parentImplClassName eq "Object") {        
1925         push(@implContent, "$className *kit($implType* value)\n");
1926         push(@implContent, "{\n");
1927         push(@implContent, "    $assertMainThread;\n");
1928         push(@implContent, "    if (!value)\n");
1929         push(@implContent, "        return nil;\n");
1930         push(@implContent, "    if ($className *wrapper = getDOMWrapper(value))\n");
1931         push(@implContent, "        return [[wrapper retain] autorelease];\n");
1932         if ($interface->extendedAttributes->{"ObjCPolymorphic"}) {
1933             push(@implContent, "    $className *wrapper = [[kitClass(value) alloc] _init];\n");
1934             push(@implContent, "    if (!wrapper)\n");
1935             push(@implContent, "        return nil;\n");
1936         } else {
1937             push(@implContent, "    $className *wrapper = [[$className alloc] _init];\n");
1938         }
1939         push(@implContent, "    wrapper->_internal = reinterpret_cast<DOMObjectInternal*>(value);\n");
1940         push(@implContent, "    value->ref();\n");
1941         push(@implContent, "    addDOMWrapper(wrapper, value);\n");
1942         push(@implContent, "    return [wrapper autorelease];\n");
1943         push(@implContent, "}\n");
1944     } else {
1945         push(@implContent, "$className *kit($implType* value)\n");
1946         push(@implContent, "{\n");
1947         push(@implContent, "    $assertMainThread;\n");
1948         push(@implContent, "    return static_cast<$className*>(kit(static_cast<WebCore::$baseClass*>(value)));\n");
1949         push(@implContent, "}\n");
1950     }
1951
1952     # - End the ifdef conditional if necessary
1953     push(@implContent, "\n#endif // ${conditionalString}\n") if $conditionalString;
1954
1955     if ($interface->extendedAttributes->{"AppleCopyright"}) {
1956         push(@implContent, split("\r", $endAppleCopyright));
1957     }
1958
1959     # - Generate dependencies.
1960     if ($writeDependencies && @ancestorInterfaceNames) {
1961         push(@depsContent, "$className.h : ", join(" ", map { "$_.idl" } @ancestorInterfaceNames), "\n");
1962         push(@depsContent, map { "$_.idl :\n" } @ancestorInterfaceNames); 
1963     }
1964 }
1965
1966 # Internal helper
1967 sub WriteData
1968 {
1969     my $object = shift;
1970     my $interface = shift;
1971     my $outputDir = shift;
1972
1973     # Open files for writing...
1974     my $name = $interface->name;
1975     my $prefix = FileNamePrefix;
1976     my $headerFileName = "$outputDir/$prefix$name.h";
1977     my $privateHeaderFileName = "$outputDir/$prefix${name}Private.h";
1978     my $implFileName = "$outputDir/$prefix$name.mm";
1979     my $internalHeaderFileName = "$outputDir/$prefix${name}Internal.h";
1980     my $depsFileName = "$outputDir/$prefix$name.dep";
1981
1982     # Write public header.
1983     my $contents = join "", @headerContentHeader;
1984     map { $contents .= (IsCoreFoundationType($_) ? "typedef struct " . substr($_, 0, -3) . "* $_;\n" : "\@class $_;\n") } sort keys(%headerForwardDeclarations);
1985     map { $contents .= "\@protocol $_;\n" } sort keys(%headerForwardDeclarationsForProtocols);
1986
1987     my $hasForwardDeclarations = keys(%headerForwardDeclarations) + keys(%headerForwardDeclarationsForProtocols);
1988     $contents .= "\n" if $hasForwardDeclarations;
1989     $contents .= join "", @headerContent;
1990     $codeGenerator->UpdateFile($headerFileName, $contents);
1991
1992     @headerContentHeader = ();
1993     @headerContent = ();
1994     %headerForwardDeclarations = ();
1995     %headerForwardDeclarationsForProtocols = ();
1996
1997     if (@privateHeaderContent > 0) {
1998         $contents = join "", @privateHeaderContentHeader;
1999         map { $contents .= "\@class $_;\n" } sort keys(%privateHeaderForwardDeclarations);
2000         map { $contents .= "\@protocol $_;\n" } sort keys(%privateHeaderForwardDeclarationsForProtocols);
2001
2002         $hasForwardDeclarations = keys(%privateHeaderForwardDeclarations) + keys(%privateHeaderForwardDeclarationsForProtocols);
2003         $contents .= "\n" if $hasForwardDeclarations;
2004         $contents .= join "", @privateHeaderContent;
2005         $codeGenerator->UpdateFile($privateHeaderFileName, $contents);
2006
2007         @privateHeaderContentHeader = ();
2008         @privateHeaderContent = ();
2009         %privateHeaderForwardDeclarations = ();
2010         %privateHeaderForwardDeclarationsForProtocols = ();
2011     }
2012
2013     # Write implementation file.
2014     unless ($noImpl) {
2015         $contents = join "", @implContentHeader;
2016         map { $contents .= "#import \"$_\"\n" } sort keys(%implIncludes);
2017         $contents .= join "", @implContent;
2018         $codeGenerator->UpdateFile($implFileName, $contents);
2019
2020         @implContentHeader = ();
2021         @implContent = ();
2022         %implIncludes = ();
2023     }
2024
2025     if (@internalHeaderContent > 0) {
2026         $contents = join "", @internalHeaderContent;
2027         $codeGenerator->UpdateFile($internalHeaderFileName, $contents);
2028
2029         @internalHeaderContent = ();
2030     }
2031
2032     # Write dependency file.
2033     if (@depsContent) {
2034         $contents = join "", @depsContent;
2035         $codeGenerator->UpdateFile($depsFileName, $contents);
2036
2037         @depsContent = ();
2038     }
2039 }
2040
2041 1;