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