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