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