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