f447e742c9d3e1d4f000f5d9f42b11224fbed7a8
[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 Samuel Weinig <sam.weinig@gmail.com>
5 # Copyright (C) 2006 Alexey Proskuryakov <ap@webkit.org>
6 # Copyright (C) 2006, 2007 Apple Inc.
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., 59 Temple Place - Suite 330,
21 # Boston, MA 02111-1307, 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 $sawConflict = 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
222     my $found = 0;
223     my $actualSuperClass;
224     %publicInterfaces = ();
225
226     my $fileName = "WebCore/bindings/objc/PublicDOMInterfaces.h";
227     open FILE, "-|", "/usr/bin/gcc", "-E", "-P", "-x", "objective-c", 
228         (map { "-D$_" } split(/ /, $defines)), "-DOBJC_CODE_GENERATION", $fileName or die "Could not open $fileName";
229     my @documentContent = <FILE>;
230     close FILE;
231
232     foreach $line (@documentContent) {
233         if ($line =~ /^\s?\@interface $class\s?:\s?(\w+)\s?$/) {
234             die "error: Public API change. Superclass for \"$class\" differs ($1 != $superClass)" if $superClass ne $1;
235             $found = 1;
236             next;
237         }
238
239         last if $found and $line =~ /^\s?\@end\s?$/;
240
241         if ($found) {
242             # trim whitspace
243             $line =~ s/^\s+//;
244             $line =~ s/\s+$//;
245             $publicInterfaces{$line} = 1 if length($line);
246         }
247     }
248
249     # If this class was not found in PublicDOMInterfaces.h then it should be considered as an entirely new public class.
250     $newPublicClass = ! $found;
251 }
252
253 # Params: 'domClass' struct
254 sub GenerateInterface
255 {
256     my $object = shift;
257     my $dataNode = shift;
258     my $defines = shift;
259
260     $sawConflict = 0;
261
262     my $name = $dataNode->name;
263     my $className = GetClassName($name);
264     my $parentClassName = "DOM" . GetParentImplClassName($dataNode);
265     $isProtocol = $dataNode->extendedAttributes->{ObjCProtocol};
266     $noImpl = $dataNode->extendedAttributes->{ObjCCustomImplementation} || $isProtocol;
267
268     ReadPublicInterfaces($className, $parentClassName, $defines);
269
270     # Start actual generation..
271     $object->GenerateHeader($dataNode);
272     $object->GenerateImplementation($dataNode) unless $noImpl;
273
274     # Write changes.
275     $object->WriteData("DOM" . $name);
276
277     # Check for missing public API
278     if (keys %publicInterfaces > 0) {
279         my $missing = join("\n", keys %publicInterfaces);
280         die "error: Public API change. There are missing public properties and/or methods from the \"$className\" class.\n$missing\n";
281     }
282
283     die if $sawConflict;
284 }
285
286 # Params: 'idlDocument' struct
287 sub GenerateModule
288 {
289     my $object = shift;
290     my $dataNode = shift;
291
292     $module = $dataNode->module;
293 }
294
295 sub GetClassName
296 {
297     my $name = $codeGenerator->StripModule(shift);
298
299     # special cases
300     return "NSString" if $codeGenerator->IsStringType($name);
301     return "NS$name" if IsNativeObjCType($name);
302     return "BOOL" if $name eq "boolean";
303     return "unsigned" if $name eq "unsigned long";
304     return "int" if $name eq "long";
305     return "DOMAbstractView" if $name eq "DOMWindow";
306     return $name if $codeGenerator->IsPrimitiveType($name) or $name eq "DOMImplementation" or $name eq "DOMTimeStamp";
307
308     # Default, assume Objective-C type has the same type name as
309     # idl type prefixed with "DOM".
310     return "DOM$name";
311 }
312
313 sub GetClassHeaderName
314 {
315     my $name = shift;
316
317     return "DOMDOMImplementation" if $name eq "DOMImplementation";
318     return $name;
319 }
320
321 sub GetImplClassName
322 {
323     my $name = $codeGenerator->StripModule(shift);
324
325     # special cases
326     return "DOMImplementationFront" if $name eq "DOMImplementation";
327     return "RectImpl" if $name eq "Rect";
328     return "DOMWindow" if $name eq "AbstractView";
329
330     return $name;
331 }
332
333 sub GetParentImplClassName
334 {
335     my $dataNode = shift;
336
337     return "Object" if @{$dataNode->parents} eq 0;
338
339     my $parent = $codeGenerator->StripModule($dataNode->parents(0));
340
341     # special cases
342     return "Node" if $parent eq "EventTargetNode";
343     return "Object" if $parent eq "HTMLCollection";
344
345     return $parent;
346 }
347
348 sub GetParentAndProtocols
349 {
350     my $dataNode = shift;
351     my $numParents = @{$dataNode->parents};
352
353     my $parent = "";
354     my @protocols = ();
355     if ($numParents eq 0) {
356         if ($isProtocol) {
357             push(@protocols, "NSObject");
358             push(@protocols, "NSCopying") if $dataNode->name eq "EventTarget";
359         } else {
360             $parent = "DOMObject";
361         }
362     } elsif ($numParents eq 1) {
363         my $parentName = $codeGenerator->StripModule($dataNode->parents(0));
364         if ($isProtocol) {
365             die "Parents of protocols must also be protocols." unless IsProtocolType($parentName);
366             push(@protocols, "DOM" . $parentName);
367         } else {
368             if (IsProtocolType($parentName)) {
369                 push(@protocols, "DOM" . $parentName);
370             } elsif ($parentName eq "EventTargetNode") {
371                 $parent = "DOMNode";
372             } elsif ($parentName eq "HTMLCollection") {
373                 $parent = "DOMObject";
374             } else {
375                 $parent = "DOM" . $parentName;
376             }
377         }
378     } else {
379         my @parents = @{$dataNode->parents};
380         my $firstParent = $codeGenerator->StripModule(shift(@parents));
381         if (IsProtocolType($firstParent)) {
382             push(@protocols, "DOM" . $firstParent);
383         } else {
384             $parent = "DOM" . $firstParent;
385         }
386
387         foreach my $parentName (@parents) {
388             $parentName = $codeGenerator->StripModule($parentName);
389             die "Everything past the first class should be a protocol!" unless IsProtocolType($parentName);
390
391             push(@protocols, "DOM" . $parentName);
392         }
393     }
394
395     return ($parent, @protocols);
396 }
397
398 sub GetBaseClass
399 {
400     $parent = shift;
401
402     return $parent if $parent eq "Object" or IsBaseType($parent);
403     return "Event" if $parent eq "UIEvent";
404     return "CSSValue" if $parent eq "SVGColor";
405     return "Node";
406 }
407
408 sub IsBaseType
409 {
410     my $type = shift;
411
412     return 1 if $baseTypeHash{$type};
413     return 0;
414 }
415
416 sub IsProtocolType
417 {
418     my $type = shift;
419
420     return 1 if $protocolTypeHash{$type};
421     return 0;
422 }
423
424 sub IsNativeObjCType
425 {
426     my $type = shift;
427
428     return 1 if $nativeObjCTypeHash{$type};
429     return 0;
430 }
431
432 sub GetObjCType
433 {
434     my $type = shift;
435     my $name = GetClassName($type);
436
437     return "id <$name>" if IsProtocolType($type);
438     return $name if $codeGenerator->IsPrimitiveType($type) or $type eq "DOMTimeStamp";
439     return "unsigned short" if $type eq "CompareHow" or $type eq "SVGPaintType";
440     return "$name *";
441 }
442
443 sub GetPropertyAttributes
444 {
445     my $type = $codeGenerator->StripModule(shift);
446     my $readOnly = shift;
447
448     my @attributes = ();
449
450     push(@attributes, "readonly") if $readOnly;
451
452 #    FIXME: uncomment these lines once <rdar://problem/4996504> is fixed.
453 #    unless ($readOnly) {
454         if ($codeGenerator->IsStringType($type) || IsNativeObjCType($type)) {
455             push(@attributes, "copy");
456         } elsif ($codeGenerator->IsPodType($type) || $codeGenerator->IsSVGAnimatedType($type)) {
457             push(@attributes, "retain");
458         } elsif (!$codeGenerator->IsStringType($type) && !$codeGenerator->IsPrimitiveType($type) && $type ne "DOMTimeStamp" && $type ne "CompareHow" && $type ne "SVGPaintType") {
459             push(@attributes, "retain");
460         }
461 #    }
462
463     return "" unless @attributes > 0;
464     return "(" . join(", ", @attributes) . ")";
465 }
466
467 sub GetObjCTypeMaker
468 {
469     my $type = $codeGenerator->StripModule(shift);
470
471     return "" if $codeGenerator->IsNonPointerType($type) or $codeGenerator->IsStringType($type) or IsNativeObjCType($type);
472     return "_RGBColorWithRGB" if $type eq "RGBColor";
473
474     my $typeMaker = "";
475     if ($type =~ /^(HTML|CSS|SVG)/ or $type eq "DOMImplementation" or $type eq "CDATASection") {
476         $typeMaker = $type;
477     } elsif ($type =~ /^XPath(.+)/) {
478         $typeMaker = "xpath" . $1;
479     } elsif ($type eq "DOMWindow") {
480         $typeMaker = "abstractView";
481     } else {
482         $typeMaker = lcfirst($type);
483     }
484
485     # put into the form "_fooBarWith" for type FooBar.
486     $typeMaker = "_" . $typeMaker . "With";
487     return $typeMaker;
488 }
489
490 sub GetObjCTypeGetterName
491 {
492     my $type = $codeGenerator->StripModule(shift);
493
494     my $typeGetter = "";
495     if ($type =~ /^(HTML|CSS|SVG)/ or $type eq "DOMImplementation" or $type eq "CDATASection") {
496         $typeGetter = $type;
497     } elsif ($type =~ /^XPath(.+)/) {
498         $typeGetter = "xpath" . $1;
499     } elsif ($type eq "DOMWindow") {
500         $typeGetter = "abstractView";
501     } else {
502         $typeGetter = lcfirst($type);
503     }
504
505     # put into the form "_fooBar" for type FooBar.
506     return "_" . $typeGetter;
507 }
508
509 sub GetObjCTypeGetter
510 {
511     my $argName = shift;
512     my $type = $codeGenerator->StripModule(shift);
513
514     return $argName if $codeGenerator->IsPrimitiveType($type) or $codeGenerator->IsStringType($type) or IsNativeObjCType($type);
515     return $argName . "EventTarget" if $type eq "EventTarget";
516     return "static_cast<WebCore::Range::CompareHow>($argName)" if $type eq "CompareHow";
517     return "static_cast<WebCore::SVGPaint::SVGPaintType>($argName)" if $type eq "SVGPaintType";
518
519     my $typeGetterMethodName = GetObjCTypeGetterName($type);
520
521     return "nativeResolver" if $type eq "XPathNSResolver";
522     return "[$argName $typeGetterMethodName]";
523 }
524
525 sub AddForwardDeclarationsForType
526 {
527     my $type = $codeGenerator->StripModule(shift);
528     my $public = shift;
529
530     return if $codeGenerator->IsNonPointerType($type) ;
531
532     my $class = GetClassName($type);
533
534     if (IsProtocolType($type)) {
535         $headerForwardDeclarationsForProtocols{$class} = 1 if $public;
536         $privateHeaderForwardDeclarationsForProtocols{$class} = 1 if !$public and !$headerForwardDeclarationsForProtocols{$class};
537         return;
538     }
539
540     $headerForwardDeclarations{$class} = 1 if $public;
541
542     # Private headers include the public header, so only add a forward declaration to the private header
543     # if the public header does not already have the same forward declaration.
544     $privateHeaderForwardDeclarations{$class} = 1 if !$public and !$headerForwardDeclarations{$class};
545 }
546
547 sub AddIncludesForType
548 {
549     my $type = $codeGenerator->StripModule(shift);
550
551     return if $codeGenerator->IsNonPointerType($type) or IsNativeObjCType($type);
552
553     if ($codeGenerator->IsStringType($type)) {
554         $implIncludes{"PlatformString.h"} = 1;
555         return;
556     }
557
558     if ($type eq "Rect") {
559         $implIncludes{"RectImpl.h"} = 1;
560         $implIncludes{"DOM$type.h"} = 1;
561         return;
562     }
563
564     if ($type eq "RGBColor") {
565         $implIncludes{"Color.h"} = 1;
566         $implIncludes{"DOM$type.h"} = 1;
567         return;
568     }
569
570     if ($type eq "DOMWindow") {
571         $implIncludes{"DOMAbstractView.h"} = 1;
572         $implIncludes{"$type.h"} = 1;
573         return;
574     }
575
576     if ($type eq "DOMImplementation") {
577         $implIncludes{"DOMImplementationFront.h"} = 1;
578         $implIncludes{"DOM$type.h"} = 1;
579         return;
580     }
581
582     if ($type eq "EventTarget") {
583         $implIncludes{"EventTargetNode.h"} = 1;
584         $implIncludes{"DOM$type.h"} = 1;
585         return;
586     }
587
588     if ($codeGenerator->IsSVGAnimatedType($type)) {
589         $implIncludes{"SVGAnimatedTemplate.h"} = 1;
590         $implIncludes{"DOM$type.h"} = 1;
591         return;
592     }
593
594     if ($type eq "SVGRect") {
595         $implIncludes{"FloatRect.h"} = 1;
596         $implIncludes{"DOM$type.h"} = 1;
597         return;
598     }
599
600     if ($type eq "SVGPoint") {
601         $implIncludes{"FloatPoint.h"} = 1;
602         $implIncludes{"DOM$type.h"} = 1;
603         return;
604     }
605
606     if ($type eq "SVGMatrix") {
607         $implIncludes{"AffineTransform.h"} = 1;
608         $implIncludes{"DOM$type.h"} = 1;
609         $implIncludes{"SVGException.h"} = 1;
610         return;
611     }
612
613     if ($type eq "SVGNumber") {
614         $implIncludes{"DOM$type.h"} = 1;
615         return;
616     }
617
618     if ($type =~ /(\w+)(Abs|Rel)$/) {
619         $implIncludes{"$1.h"} = 1;
620         $implIncludes{"DOM$type.h"} = 1;
621         return;
622     }
623
624     if ($type eq "XPathNSResolver") {
625         $implIncludes{"DOMCustomXPathNSResolver.h"} = 1;
626     }
627
628     # FIXME: won't compile without these
629     $implIncludes{"CSSMutableStyleDeclaration.h"} = 1 if $type eq "CSSStyleDeclaration";
630     $implIncludes{"NamedAttrMap.h"} = 1 if $type eq "NamedNodeMap";
631     $implIncludes{"NameNodeList.h"} = 1 if $type eq "NodeList";
632
633     # Default, include the same named file (the implementation) and the same name prefixed with "DOM". 
634     $implIncludes{"$type.h"} = 1;
635     $implIncludes{"DOM$type.h"} = 1;
636 }
637
638 sub GenerateHeader
639 {
640     my $object = shift;
641     my $dataNode = shift;
642
643     # We only support multiple parents with SVG (for now).
644     if (@{$dataNode->parents} > 1) {
645         die "A class can't have more than one parent" unless $module eq "svg";
646     }
647
648     my $interfaceName = $dataNode->name;
649     my $className = GetClassName($interfaceName);
650
651     my $parentName = "";
652     my @protocolsToImplement = ();
653     ($parentName, @protocolsToImplement) = GetParentAndProtocols($dataNode);
654
655     my $numConstants = @{$dataNode->constants};
656     my $numAttributes = @{$dataNode->attributes};
657     my $numFunctions = @{$dataNode->functions};
658
659     # - Add default header template
660     @headerContentHeader = split("\r", $headerLicenceTemplate);
661     push(@headerContentHeader, "\n");
662
663     # - INCLUDES -
664     unless ($isProtocol) {
665         my $parentHeaderName = GetClassHeaderName($parentName);
666         push(@headerContentHeader, "#import <WebCore/$parentHeaderName.h>\n");
667     }
668     foreach my $parentProtocol (@protocolsToImplement) {
669         next if $parentProtocol =~ /^NS/; 
670         $parentProtocol = GetClassHeaderName($parentProtocol);
671         push(@headerContentHeader, "#import <WebCore/$parentProtocol.h>\n");
672     }
673
674     # Special case needed for legacy support of DOMRange
675     if ($interfaceName eq "Range") {
676         push(@headerContentHeader, "#import <WebCore/DOMCore.h>\n");
677         push(@headerContentHeader, "#import <WebCore/DOMDocument.h>\n");
678         push(@headerContentHeader, "#import <WebCore/DOMRangeException.h>\n");
679     }
680
681     push(@headerContentHeader, "\n");
682
683     # - Add constants.
684     if ($numConstants > 0) {
685         my @headerConstants = ();
686
687         # FIXME: we need a way to include multiple enums.
688         foreach my $constant (@{$dataNode->constants}) {
689             my $constantName = $constant->name;
690             my $constantValue = $constant->value;
691
692             my $output = "    DOM_" . $constantName . " = " . $constantValue;
693             push(@headerConstants, $output);
694         }
695
696         my $combinedConstants = join(",\n", @headerConstants);
697
698         # FIXME: the formatting of the enums should line up the equal signs.
699         # FIXME: enums are unconditionally placed in the public header.
700         push(@headerContent, "enum {\n");
701         push(@headerContent, $combinedConstants);
702         push(@headerContent, "\n};\n\n");        
703     }
704
705     # - Begin @interface or @protocol
706     if ($isProtocol) {
707         my $parentProtocols = join(", ", @protocolsToImplement);
708         push(@headerContent, "\@protocol $className <$parentProtocols>\n");
709     } else {
710         if (@protocolsToImplement eq 0) {
711             push(@headerContent, "\@interface $className : $parentName\n");
712         } else {
713              my $parentProtocols = join(", ", @protocolsToImplement);
714              push(@headerContent, "\@interface $className : $parentName <$parentProtocols>\n");
715         }
716     }
717
718     my @headerAttributes = ();
719     my @privateHeaderAttributes = ();
720
721     my @headerAttributesOldStyle = ();
722     my @privateHeaderAttributesOldStyle = ();
723
724     # - Add attribute getters/setters.
725     if ($numAttributes > 0) {
726         # Add ivars, if any, first
727         @ivars = ();
728         foreach my $attribute (@{$dataNode->attributes}) {
729             push(@ivars, $attribute) if $attribute->signature->extendedAttributes->{"ObjCIvar"};
730         }
731
732         if (@ivars > 0) {
733             push(@headerContent, "{\n");
734             foreach my $attribute (@ivars) {
735                 my $type = GetObjCType($attribute->signature->type);;
736                 my $name = "m_" . $attribute->signature->name;
737                 my $ivarDeclaration = "$type $name";
738                 push(@headerContent, "    $ivarDeclaration;\n");
739             }
740             push(@headerContent, "}\n");
741         }
742
743         foreach my $attribute (@{$dataNode->attributes}) {
744             my $attributeName = $attribute->signature->name;
745
746             if ($attributeName eq "id" or $attributeName eq "hash") {
747                 # Special case attributes id and hash to be idName and hashName to avoid ObjC naming conflict.
748                 $attributeName .= "Name";
749             } elsif ($attributeName eq "frame") {
750                 # Special case attribute frame to be frameBorders.
751                 $attributeName .= "Borders";
752             }
753
754             my $attributeType = GetObjCType($attribute->signature->type);
755             my $attributeIsReadonly = ($attribute->type =~ /^readonly/);
756
757             my $property = "\@property" . GetPropertyAttributes($attribute->signature->type, $attributeIsReadonly);
758             $property .= " " . $attributeType . ($attributeType =~ /\*$/ ? "" : " ") . $attributeName . ";";
759
760             my $public = ($publicInterfaces{$property} or $newPublicClass);
761             delete $publicInterfaces{$property};
762
763             AddForwardDeclarationsForType($attribute->signature->type, $public);
764
765             my $setterName = "set" . ucfirst($attributeName) . ":";
766
767             my $conflict = $conflictMethod{$attributeName};
768             if ($conflict) {
769                 warn "$className conflicts with $conflict method $attributeName\n";
770                 $sawConflict = 1;
771             }
772
773             $conflict = $conflictMethod{$setterName};
774             if ($conflict) {
775                 warn "$className conflicts with $conflict method $setterName\n";
776                 $sawConflict = 1;
777             }
778
779             if ($buildingForLeopardOrLater) {
780                 $property .= "\n";
781                 push(@headerAttributes, $property) if $public;
782                 push(@privateHeaderAttributes, $property) unless $public;
783
784                 my $oldStyleProperty = "\@property" . ($attributeIsReadonly ? "(readonly)" : "");
785                 $oldStyleProperty .= " " . $attributeType . ($attributeType =~ /\*$/ ? "" : " ") . $attributeName . ";\n";
786
787                 push(@headerAttributesOldStyle, $oldStyleProperty) if $public;
788                 push(@privateHeaderAttributesOldStyle, $oldStyleProperty) unless $public;
789             } else {
790                 # - GETTER
791                 my $getter = "- (" . $attributeType . ")" . $attributeName . ";\n";
792                 push(@headerAttributes, $getter) if $public;
793                 push(@privateHeaderAttributes, $getter) unless $public;
794
795                 # - SETTER
796                 if (!$attributeIsReadonly) {
797                     my $setter = "- (void)$setterName(" . $attributeType . ")new" . ucfirst($attributeName) . ";\n";
798                     push(@headerAttributes, $setter) if $public;
799                     push(@privateHeaderAttributes, $setter) unless $public;
800                 }
801             }
802         }
803
804         push(@headerContent, "#ifdef OBJC_NEW_PROPERTIES\n") if $buildingForLeopardOrLater;
805         push(@headerContent, @headerAttributes) if @headerAttributes > 0;
806         push(@headerContent, "#else\n") if $buildingForLeopardOrLater;
807         push(@headerContent, @headerAttributesOldStyle) if @headerAttributesOldStyle > 0 and $buildingForLeopardOrLater;
808         push(@headerContent, "#endif\n") if $buildingForLeopardOrLater;
809     }
810
811     my @headerFunctions = ();
812     my @privateHeaderFunctions = ();
813     my @deprecatedHeaderFunctions = ();
814
815     # - Add functions.
816     if ($numFunctions > 0) {
817         foreach my $function (@{$dataNode->functions}) {
818             my $functionName = $function->signature->name;
819
820             my $returnType = GetObjCType($function->signature->type);
821             my $needsDeprecatedVersion = (@{$function->parameters} > 1 and $function->signature->extendedAttributes->{"OldStyleObjC"});
822             my $numberOfParameters = @{$function->parameters};
823             my %typesToForwardDeclare = ($function->signature->type => 1);
824
825             my $parameterIndex = 0;
826             my $functionSig = "- ($returnType)$functionName";
827             my $methodName = $functionName;
828             foreach my $param (@{$function->parameters}) {
829                 my $paramName = $param->name;
830                 my $paramType = GetObjCType($param->type);
831
832                 $typesToForwardDeclare{$param->type} = 1;
833
834                 if ($parameterIndex >= 1) {
835                     my $paramPrefix = $param->extendedAttributes->{"ObjCPrefix"};
836                     $paramPrefix = $paramName unless defined($paramPrefix);
837                     $functionSig .= " $paramPrefix";
838                     $methodName .= $paramPrefix;
839                 }
840
841                 $functionSig .= ":($paramType)$paramName";
842                 $methodName .= ":";
843
844                 $parameterIndex++;
845             }
846
847             $functionSig .= ";";
848
849             my $conflict = $conflictMethod{$methodName};
850             if ($conflict) {
851                 warn "$className conflicts with $conflict method $methodName\n";
852                 $sawConflict = 1;
853             }
854
855             my $public = ($publicInterfaces{$functionSig} or $newPublicClass);
856             delete $publicInterfaces{$functionSig};
857
858             $functionSig .= "\n";
859
860             foreach my $type (keys %typesToForwardDeclare) {
861                 # add any forward declarations to the public header if a deprecated version will be generated
862                 AddForwardDeclarationsForType($type, 1) if $needsDeprecatedVersion;
863                 AddForwardDeclarationsForType($type, $public) unless $public and $needsDeprecatedVersion;
864             }
865
866             push(@headerFunctions, $functionSig) if $public;
867             push(@privateHeaderFunctions, $functionSig) unless $public;
868
869             # generate the old style method names with un-named parameters, these methods are deprecated
870             if ($needsDeprecatedVersion) {
871                 my $deprecatedFunctionSig = $functionSig;
872                 $deprecatedFunctionSig =~ s/\s\w+:/ :/g; # remove parameter names
873                 my $deprecatedFunctionKey = $deprecatedFunctionSig;
874
875                 $deprecatedFunctionSig =~ s/;\n$/ DEPRECATED_IN_MAC_OS_X_VERSION_10_5_AND_LATER;\n/ if $buildingForLeopardOrLater;
876                 push(@deprecatedHeaderFunctions, $deprecatedFunctionSig);
877
878                 $deprecatedFunctionKey =~ s/\n$//; # remove the newline
879                 delete $publicInterfaces{$deprecatedFunctionKey};
880             }
881         }
882
883         if (@headerFunctions > 0) {
884             push(@headerContent, "\n") if $buildingForLeopardOrLater and @headerAttributes > 0;
885             push(@headerContent, @headerFunctions);
886         }
887     }
888
889     # - End @interface or @protocol
890     push(@headerContent, "\@end\n");
891
892     if (@deprecatedHeaderFunctions > 0) {
893         # - Deprecated category @interface 
894         push(@headerContent, "\n\@interface $className (" . $className . "Deprecated)\n");
895         push(@headerContent, @deprecatedHeaderFunctions);
896         push(@headerContent, "\@end\n");
897     }
898
899     if (@privateHeaderAttributes > 0 or @privateHeaderFunctions > 0) {
900         # - Private category @interface
901         @privateHeaderContentHeader = split("\r", $headerLicenceTemplate);
902         push(@headerContentHeader, "\n");
903
904         my $classHeaderName = GetClassHeaderName($className);
905         push(@privateHeaderContentHeader, "#import <WebCore/$classHeaderName.h>\n\n");
906
907         @privateHeaderContent = ();
908         push(@privateHeaderContent, "\@interface $className (" . $className . "Private)\n");
909         push(@privateHeaderContent, "#ifdef OBJC_NEW_PROPERTIES\n") if $buildingForLeopardOrLater;
910         push(@privateHeaderContent, @privateHeaderAttributes) if @privateHeaderAttributes > 0;
911         push(@privateHeaderContent, "#else\n") if $buildingForLeopardOrLater;
912         push(@privateHeaderContent, @privateHeaderAttributesOldStyle) if @privateHeaderAttributesOldStyle > 0 and $buildingForLeopardOrLater;
913         push(@privateHeaderContent, "#endif\n") if $buildingForLeopardOrLater;
914         push(@privateHeaderContent, "\n") if $buildingForLeopardOrLater and @privateHeaderAttributes > 0 and @privateHeaderFunctions > 0;
915         push(@privateHeaderContent, @privateHeaderFunctions) if @privateHeaderFunctions > 0;
916         push(@privateHeaderContent, "\@end\n");
917     }
918 }
919
920 sub GenerateImplementation
921 {
922     my $object = shift;
923     my $dataNode = shift;
924
925     # We only support multiple parents with SVG (for now).
926     if (@{$dataNode->parents} > 1) {
927         die "A class can't have more than one parent" unless $module eq "svg";
928         $codeGenerator->AddMethodsConstantsAndAttributesFromParentClasses($dataNode);
929     }
930
931     my $interfaceName = $dataNode->name;
932     my $className = GetClassName($interfaceName);
933     my $implClassName = GetImplClassName($interfaceName);
934     my $parentImplClassName = GetParentImplClassName($dataNode);
935     my $implClassNameWithNamespace = "WebCore::" . $implClassName;
936     my $baseClass = GetBaseClass($parentImplClassName);
937     my $classHeaderName = GetClassHeaderName($className);
938     my $conditional = $dataNode->extendedAttributes->{"Conditional"};
939
940     my $numAttributes = @{$dataNode->attributes};
941     my $numFunctions = @{$dataNode->functions};
942
943     my $podType = $dataNode->extendedAttributes->{"PODType"};
944     my $podTypeWithNamespace;
945
946     if ($podType) {
947         $podTypeWithNamespace = ($podType eq "double") ? "$podType" : "WebCore::$podType";
948     }
949
950     # - Add default header template.
951     @implContentHeader = split("\r", $implementationLicenceTemplate);
952
953     # - INCLUDES -
954     push(@implContentHeader, "\n#import \"config.h\"\n");
955     push(@implContentHeader, "\n#import \"logging.h\"\n");
956     push(@implContentHeader, "\n#ifdef ${conditional}_SUPPORT\n\n") if $conditional;
957     push(@implContentHeader, "#import \"$classHeaderName.h\"\n\n");
958     push(@implContentHeader, "#import <wtf/GetPtr.h>\n\n");
959
960     if ($codeGenerator->IsSVGAnimatedType($interfaceName)) {
961         $implIncludes{"SVGAnimatedTemplate.h"} = 1;
962     } elsif ($interfaceName =~ /(\w+)(Abs|Rel)$/) {
963         $implIncludes{"$1.h"} = 1;
964     } else {
965         if (!$podType) {
966             $implIncludes{"$implClassName.h"} = 1;
967         } else {
968             $implIncludes{"$podType.h"} = 1 unless $podType eq "double";
969         }
970     } 
971
972     $implIncludes{"DOMInternal.h"} = 1;
973     $implIncludes{"ExceptionHandlers.h"} = 1;
974
975     @implContent = ();
976
977     # add implementation accessor
978     if ($podType) {
979         push(@implContent, "#define IMPL reinterpret_cast<$podTypeWithNamespace*>(_internal)\n\n");
980     } elsif ($parentImplClassName eq "Object") {
981         push(@implContent, "#define IMPL reinterpret_cast<$implClassNameWithNamespace*>(_internal)\n\n");
982     } else {
983         my $baseClassWithNamespace = "WebCore::$baseClass";
984         push(@implContent, "#define IMPL static_cast<$implClassNameWithNamespace*>(reinterpret_cast<$baseClassWithNamespace*>(_internal))\n\n");
985     }
986
987     # START implementation
988     push(@implContent, "\@implementation $className\n\n");
989
990     # Only generate 'dealloc' and 'finalize' methods for direct subclasses of DOMObject.
991     if ($parentImplClassName eq "Object") {
992         my @ivarsToRelease = ();
993         if (@ivars > 0) {
994             foreach $attribute (@ivars) {
995                 my $name = "m_" . $attribute->signature->name;
996                 push(@ivarsToRelease, "    [$name release];\n");
997             }
998         }
999
1000         push(@implContent, "- (void)dealloc\n");
1001         push(@implContent, "{\n");
1002         push(@implContent, "    $assertMainThread\n");
1003         push(@implContent, @ivarsToRelease);
1004         if ($interfaceName eq "NodeIterator") {
1005             push(@implContent, "    if (_internal) {\n");
1006             push(@implContent, "        [self detach];\n");
1007             push(@implContent, "        IMPL->deref();\n");
1008             push(@implContent, "    };\n");
1009         } elsif ($podType) {
1010             push(@implContent, "    delete IMPL;\n");
1011         } else {
1012             push(@implContent, "    if (_internal)\n");
1013             push(@implContent, "        IMPL->deref();\n");
1014         }
1015         push(@implContent, "    [super dealloc];\n");
1016         push(@implContent, "}\n\n");
1017
1018         push(@implContent, "- (void)finalize\n");
1019         push(@implContent, "{\n");
1020         if ($interfaceName eq "NodeIterator") {
1021             push(@implContent, "    if (_internal) {\n");
1022             push(@implContent, "        [self detach];\n");
1023             push(@implContent, "        IMPL->deref();\n");
1024             push(@implContent, "    };\n");
1025         } elsif ($podType) {
1026             push(@implContent, "    delete IMPL;\n");
1027         } else {
1028             push(@implContent, "    if (_internal)\n");
1029             push(@implContent, "        IMPL->deref();\n");
1030         }
1031         push(@implContent, "    [super finalize];\n");
1032         push(@implContent, "}\n\n");
1033         
1034     }
1035
1036     %attributeNames = ();
1037
1038     # - Attributes
1039     if ($numAttributes > 0) {
1040         foreach my $attribute (@{$dataNode->attributes}) {
1041             AddIncludesForType($attribute->signature->type);
1042
1043             my $idlType = $codeGenerator->StripModule($attribute->signature->type);
1044
1045             my $attributeName = $attribute->signature->name;
1046             my $attributeType = GetObjCType($attribute->signature->type);
1047             my $attributeIsReadonly = ($attribute->type =~ /^readonly/);
1048             my $attributeClassName = GetClassName($attribute->signature->type);
1049
1050             my $attributeInterfaceName = $attributeName;
1051             if ($attributeName eq "id" or $attributeName eq "hash") {
1052                 # Special case attributes id and hash to be idName and hashName to avoid ObjC naming conflict.
1053                 $attributeInterfaceName .= "Name";
1054             } elsif ($attributeName eq "frame") {
1055                 # Special case attribute frame to be frameBorders.
1056                 $attributeInterfaceName .= "Borders";
1057             } elsif ($attributeName eq "ownerDocument") {
1058                 # FIXME: for now special case attribute ownerDocument to call document, this is incorrect
1059                 # legacy behavior. (see http://bugs.webkit.org/show_bug.cgi?id=10889)
1060                 $attributeName = "document";
1061             } elsif ($codeGenerator->IsSVGAnimatedType($idlType)) {
1062                 # Special case for animated types.
1063                 $attributeName .= "Animated";
1064             }
1065
1066             $attributeNames{$attributeInterfaceName} = 1;
1067
1068             # - GETTER
1069             my $getterSig = "- ($attributeType)$attributeInterfaceName\n";
1070             my $hasGetterException = @{$attribute->getterExceptions};
1071             my $getterContentHead = "IMPL->$attributeName(";
1072             my $getterContentTail = ")";
1073
1074             # Special case for DOMSVGNumber
1075             if ($podType and $podType eq "double") {
1076                 $getterContentHead = "*IMPL";
1077                 $getterContentTail = "";
1078             }
1079
1080             my $attributeTypeSansPtr = $attributeType;
1081             $attributeTypeSansPtr =~ s/ \*$//; # Remove trailing " *" from pointer types.
1082
1083             # special case for EventTarget protocol
1084             $attributeTypeSansPtr = "DOMNode" if $idlType eq "EventTarget";
1085
1086             my $typeMaker = GetObjCTypeMaker($attribute->signature->type);
1087
1088             # Special cases
1089             my @customGetterContent = (); 
1090             if ($attributeTypeSansPtr eq "DOMImplementation") {
1091                 # FIXME: We have to special case DOMImplementation until DOMImplementationFront is removed
1092                 $getterContentHead = "[$attributeTypeSansPtr $typeMaker:implementationFront(IMPL";
1093                 $getterContentTail .= "]";
1094             } elsif ($attributeName =~ /(\w+)DisplayString$/) {
1095                 my $attributeToDisplay = $1;
1096                 $getterContentHead = "WebCore::displayString(IMPL->$attributeToDisplay(), [self _element]";
1097             } elsif ($attributeName =~ /^absolute(\w+)URL$/) {
1098                 my $typeOfURL = $1;
1099                 $getterContentHead = "[self _getURLAttribute:";
1100                 if ($typeOfURL eq "Link") {
1101                     $getterContentTail = "\@\"href\"]";
1102                 } elsif ($typeOfURL eq "Image") {
1103                     if ($interfaceName eq "HTMLObjectElement") {
1104                         $getterContentTail = "\@\"data\"]";
1105                     } else {
1106                         $getterContentTail = "\@\"src\"]";
1107                     }
1108                     unless ($interfaceName eq "HTMLImageElement") {
1109                         push(@customGetterContent, "    if (!IMPL->renderer() || !IMPL->renderer()->isImage())\n");
1110                         push(@customGetterContent, "        return nil;\n");
1111                         $implIncludes{"RenderObject.h"} = 1;
1112                     }
1113                 }
1114                 $implIncludes{"DOMPrivate.h"} = 1;
1115             } elsif ($idlType eq "NodeFilter") {
1116                 push(@customGetterContent, "    if (m_filter)\n");
1117                 push(@customGetterContent, "        // This node iterator was created from the Objective-C side.\n");
1118                 push(@customGetterContent, "        return [[m_filter retain] autorelease];\n\n");
1119                 push(@customGetterContent, "    // This node iterator was created from the C++ side.\n");
1120                 $getterContentHead = "[$attributeClassName $typeMaker:WTF::getPtr(" . $getterContentHead;
1121                 $getterContentTail .= ")]";
1122             } elsif ($attribute->signature->extendedAttributes->{"ConvertFromString"}) {
1123                 $getterContentTail .= ".toInt()";
1124             } elsif ($codeGenerator->IsPodType($idlType)) {
1125                 $getterContentHead = "[$attributeTypeSansPtr $typeMaker:" . $getterContentHead;
1126                 $getterContentTail .= "]";
1127             } elsif ($typeMaker ne "") {
1128                 # Surround getter with TypeMaker
1129                 $getterContentHead = "[$attributeTypeSansPtr $typeMaker:WTF::getPtr(" . $getterContentHead;
1130                 $getterContentTail .= ")]";
1131             }
1132
1133             my $getterContent;
1134             if ($hasGetterException) {
1135                 $getterContent = $getterContentHead . "ec" . $getterContentTail;
1136             } else {
1137                 $getterContent = $getterContentHead . $getterContentTail;
1138             }
1139
1140             push(@implContent, $getterSig);
1141             push(@implContent, "{\n");
1142             push(@implContent, @customGetterContent);
1143             if ($hasGetterException) {
1144                 # Differentiated between when the return type is a pointer and
1145                 # not for white space issue (ie. Foo *result vs. int result).
1146                 if ($attributeType =~ /\*$/) {
1147                     $getterContent = $attributeType . "result = " . $getterContent;
1148                 } else {
1149                     $getterContent = $attributeType . " result = " . $getterContent;
1150                 }
1151
1152                 push(@implContent, "    $exceptionInit\n");
1153                 push(@implContent, "    $getterContent;\n");
1154                 push(@implContent, "    $exceptionRaiseOnError\n");
1155                 push(@implContent, "    return result;\n");
1156             } else {
1157                 push(@implContent, "    return $getterContent;\n");
1158             }
1159             push(@implContent, "}\n\n");
1160
1161             # - SETTER
1162             if (!$attributeIsReadonly) {
1163                 # Exception handling
1164                 my $hasSetterException = @{$attribute->setterExceptions};
1165
1166                 $attributeName = "set" . WK_ucfirst($attributeName);
1167                 my $setterName = "set" . ucfirst($attributeInterfaceName);
1168                 my $argName = "new" . ucfirst($attributeInterfaceName);
1169                 my $arg = GetObjCTypeGetter($argName, $idlType);
1170
1171                 if ($attribute->signature->extendedAttributes->{"ConvertFromString"}) {
1172                     $arg = "WebCore::String::number($arg)";
1173                 }
1174
1175                 my $setterSig = "- (void)$setterName:($attributeType)$argName\n";
1176
1177                 push(@implContent, $setterSig);
1178                 push(@implContent, "{\n");
1179
1180                 unless ($codeGenerator->IsPrimitiveType($idlType) or $codeGenerator->IsStringType($idlType)) {
1181                     push(@implContent, "    ASSERT($argName);\n\n");
1182                 }
1183
1184                 if ($podType) {
1185                     # Special case for DOMSVGNumber
1186                     if ($podType eq "double") {
1187                         push(@implContent, "    *IMPL = $arg;\n");
1188                     } else {
1189                         push(@implContent, "    IMPL->$attributeName($arg);\n");
1190                     }
1191                 } elsif ($hasSetterException) {
1192                     push(@implContent, "    $exceptionInit\n");
1193                     push(@implContent, "    IMPL->$attributeName($arg, ec);\n");
1194                     push(@implContent, "    $exceptionRaiseOnError\n");
1195                 } else {
1196                     push(@implContent, "    IMPL->$attributeName($arg);\n");
1197                 }
1198
1199                 push(@implContent, "}\n\n");
1200             }
1201         }
1202     }
1203
1204     my @deprecatedFunctions = ();
1205
1206     # - Functions
1207     if ($numFunctions > 0) {
1208         foreach my $function (@{$dataNode->functions}) {
1209             AddIncludesForType($function->signature->type);
1210
1211             my $functionName = $function->signature->name;
1212             my $returnType = GetObjCType($function->signature->type);
1213             my $hasParameters = @{$function->parameters};
1214             my $raisesExceptions = @{$function->raisesExceptions};
1215
1216             my @parameterNames = ();
1217             my @needsAssert = ();
1218             my %needsCustom = ();
1219
1220             my $parameterIndex = 0;
1221             my $functionSig = "- ($returnType)$functionName";
1222             foreach my $param (@{$function->parameters}) {
1223                 my $paramName = $param->name;
1224                 my $paramType = GetObjCType($param->type);
1225
1226                 # make a new parameter name if the original conflicts with a property name
1227                 $paramName = "in" . ucfirst($paramName) if $attributeNames{$paramName};
1228
1229                 AddIncludesForType($param->type);
1230
1231                 my $idlType = $codeGenerator->StripModule($param->type);
1232                 my $implGetter = GetObjCTypeGetter($paramName, $idlType);
1233
1234                 push(@parameterNames, $implGetter);
1235                 $needsCustom{"XPathNSResolver"} = $paramName if $idlType eq "XPathNSResolver";
1236                 $needsCustom{"EventTarget"} = $paramName if $idlType eq "EventTarget";
1237                 $needsCustom{"NodeToReturn"} = $paramName if $param->extendedAttributes->{"Return"};
1238
1239                 unless ($codeGenerator->IsPrimitiveType($idlType) or $codeGenerator->IsStringType($idlType)) {
1240                     push(@needsAssert, "    ASSERT($paramName);\n");
1241                 }
1242
1243                 if ($parameterIndex >= 1) {
1244                     my $paramPrefix = $param->extendedAttributes->{"ObjCPrefix"};
1245                     $paramPrefix = $param->name unless defined($paramPrefix);
1246                     $functionSig .= " $paramPrefix";
1247                 }
1248
1249                 $functionSig .= ":($paramType)$paramName";
1250
1251                 $parameterIndex++;
1252             }
1253
1254             my @functionContent = ();
1255             my $caller = "IMPL";
1256
1257             # special case the XPathNSResolver
1258             if (defined $needsCustom{"XPathNSResolver"}) {
1259                 my $paramName = $needsCustom{"XPathNSResolver"};
1260                 push(@functionContent, "    WebCore::XPathNSResolver* nativeResolver = 0;\n");
1261                 push(@functionContent, "    RefPtr<WebCore::XPathNSResolver> customResolver;\n");
1262                 push(@functionContent, "    if ($paramName) {\n");
1263                 push(@functionContent, "        if ([$paramName isMemberOfClass:[DOMNativeXPathNSResolver class]])\n");
1264                 push(@functionContent, "            nativeResolver = [(DOMNativeXPathNSResolver *)$paramName _xpathNSResolver];\n");
1265                 push(@functionContent, "        else {\n");
1266                 push(@functionContent, "            customResolver = new WebCore::DOMCustomXPathNSResolver($paramName);\n");
1267                 push(@functionContent, "            nativeResolver = customResolver.get();\n");
1268                 push(@functionContent, "        }\n");
1269                 push(@functionContent, "    }\n");
1270             }
1271
1272             # special case the EventTarget
1273             if (defined $needsCustom{"EventTarget"}) {
1274                 my $paramName = $needsCustom{"EventTarget"};
1275                 push(@functionContent, "    DOMNode* ${paramName}ObjC = $paramName;\n");
1276                 push(@functionContent, "    WebCore::Node* ${paramName}Node = [${paramName}ObjC _node];\n");
1277                 push(@functionContent, "    WebCore::EventTargetNode* ${paramName}EventTarget = (${paramName}Node && ${paramName}Node->isEventTargetNode()) ? static_cast<WebCore::EventTargetNode*>(${paramName}Node) : 0;\n\n");
1278                 $implIncludes{"DOMNode.h"} = 1;
1279                 $implIncludes{"Node.h"} = 1;
1280             }
1281
1282             if ($function->signature->extendedAttributes->{"UsesView"}) {
1283                 push(@functionContent, "    WebCore::DOMWindow* dv = $caller->defaultView();\n");
1284                 push(@functionContent, "    if (!dv)\n");
1285                 push(@functionContent, "        return nil;\n");
1286                 $implIncludes{"DOMWindow.h"} = 1;
1287                 $caller = "dv";
1288             }
1289
1290             # FIXME! We need [Custom] support for ObjC, to move these hacks into DOMSVGMatrixCustom.mm
1291             my $svgMatrixRotateFromVector = ($podType and $podType eq "AffineTransform" and $functionName eq "rotateFromVector");
1292             my $svgMatrixInverse = ($podType and $podType eq "AffineTransform" and $functionName eq "inverse");
1293
1294             push(@parameterNames, "ec") if $raisesExceptions and !($svgMatrixRotateFromVector || $svgMatrixInverse);
1295             my $content = $caller . "->" . $functionName . "(" . join(", ", @parameterNames) . ")"; 
1296
1297             if ($svgMatrixRotateFromVector) {
1298                 # Special case with rotateFromVector & SVGMatrix        
1299                 push(@functionContent, "    $exceptionInit\n");
1300                 push(@functionContent, "    if (x == 0.0 || y == 0.0)\n");
1301                 push(@functionContent, "        ec = WebCore::SVG_INVALID_VALUE_ERR;\n");
1302                 push(@functionContent, "    $exceptionRaiseOnError\n");
1303                 push(@functionContent, "    return [DOMSVGMatrix _SVGMatrixWith:$content];\n");
1304             } elsif ($svgMatrixInverse) {
1305                 # Special case with inverse & SVGMatrix
1306                 push(@functionContent, "    $exceptionInit\n");
1307                 push(@functionContent, "    if (!$caller->isInvertible())\n");
1308                 push(@functionContent, "        ec = WebCore::SVG_MATRIX_NOT_INVERTABLE;\n");
1309                 push(@functionContent, "    $exceptionRaiseOnError\n");
1310                 push(@functionContent, "    return [DOMSVGMatrix _SVGMatrixWith:$content];\n");
1311             } elsif ($returnType eq "void") {
1312                 # Special case 'void' return type.
1313                 if ($raisesExceptions) {
1314                     push(@functionContent, "    $exceptionInit\n");
1315                     push(@functionContent, "    $content;\n");
1316                     push(@functionContent, "    $exceptionRaiseOnError\n");
1317                 } else {
1318                     push(@functionContent, "    $content;\n");
1319                 }
1320             } elsif (defined $needsCustom{"NodeToReturn"}) {
1321                 # Special case the insertBefore, replaceChild, removeChild 
1322                 # and appendChild functions from DOMNode 
1323                 my $toReturn = $needsCustom{"NodeToReturn"};
1324                 if ($raisesExceptions) {
1325                     push(@functionContent, "    $exceptionInit\n");
1326                     push(@functionContent, "    if ($content)\n");
1327                     push(@functionContent, "        return $toReturn;\n");
1328                     push(@functionContent, "    $exceptionRaiseOnError\n");
1329                     push(@functionContent, "    return nil;\n");
1330                 } else {
1331                     push(@functionContent, "    if ($content)\n");
1332                     push(@functionContent, "        return $toReturn;\n");
1333                     push(@functionContent, "    return nil;\n");
1334                 }
1335             } else {
1336                 my $typeMaker = GetObjCTypeMaker($function->signature->type);
1337                 unless ($typeMaker eq "") {
1338                     my $returnTypeClass = "";
1339                     if ($function->signature->type eq "XPathNSResolver") {
1340                         # Special case XPathNSResolver
1341                         $returnTypeClass = "DOMNativeXPathNSResolver";
1342                     } else {
1343                         # Remove trailing " *" from pointer types.
1344                         $returnTypeClass = $returnType;
1345                         $returnTypeClass =~ s/ \*$//;
1346                     }
1347
1348                     # Surround getter with TypeMaker
1349                     my $idlType = $returnTypeClass;
1350                     $idlType =~ s/^DOM//;
1351
1352                     if ($codeGenerator->IsPodType($idlType)) {
1353                         $content = "[$returnTypeClass $typeMaker:" . $content . "]";
1354                     } else {
1355                         $content = "[$returnTypeClass $typeMaker:WTF::getPtr(" . $content . ")]";
1356                     }
1357                 }
1358
1359                 if ($raisesExceptions) {
1360                     # Differentiated between when the return type is a pointer and
1361                     # not for white space issue (ie. Foo *result vs. int result).
1362                     if ($returnType =~ /\*$/) {
1363                         $content = $returnType . "result = " . $content;
1364                     } else {
1365                         $content = $returnType . " result = " . $content;
1366                     }
1367
1368                     push(@functionContent, "    $exceptionInit\n");
1369                     push(@functionContent, "    $content;\n");
1370                     push(@functionContent, "    $exceptionRaiseOnError\n");
1371                     push(@functionContent, "    return result;\n");
1372                 } else {
1373                     push(@functionContent, "    return $content;\n");
1374                 }
1375             }
1376
1377             push(@implContent, "$functionSig\n");
1378             push(@implContent, "{\n");
1379             push(@implContent, @functionContent);
1380             push(@implContent, "}\n\n");
1381
1382             # generate the old style method names with un-named parameters, these methods are deprecated
1383             if (@{$function->parameters} > 1 and $function->signature->extendedAttributes->{"OldStyleObjC"}) {
1384                 my $deprecatedFunctionSig = $functionSig;
1385                 $deprecatedFunctionSig =~ s/\s\w+:/ :/g; # remove parameter names
1386
1387                 push(@deprecatedFunctions, "$deprecatedFunctionSig\n");
1388                 push(@deprecatedFunctions, "{\n");
1389                 push(@deprecatedFunctions, @functionContent);
1390                 push(@deprecatedFunctions, "}\n\n");
1391             }
1392
1393             # Clear the hash
1394             %needsCustom = ();
1395         }
1396     }
1397
1398     # END implementation
1399     push(@implContent, "\@end\n");
1400
1401     if (@deprecatedFunctions > 0) {
1402         # - Deprecated category @implementation
1403         push(@implContent, "\n\@implementation $className (" . $className . "Deprecated)\n\n");
1404         push(@implContent, @deprecatedFunctions);
1405         push(@implContent, "\@end\n");
1406     }
1407
1408
1409     # Generate internal interfaces
1410
1411     # - Type-Getter
1412     # - (WebCore::FooBar *)_fooBar for implementation class FooBar
1413     my $typeGetterName = GetObjCTypeGetterName($interfaceName);
1414     my $typeGetterSig = "- " . ($podType ? "($podTypeWithNamespace)" : "($implClassNameWithNamespace *)") . $typeGetterName;
1415
1416     my @ivarsToRetain = ();
1417     my $ivarsToInit = "";
1418     my $typeMakerSigAddition = "";
1419     if (@ivars > 0) {
1420         my @ivarsInitSig = ();
1421         my @ivarsInitCall = ();
1422         foreach $attribute (@ivars) {
1423             my $name = $attribute->signature->name;
1424             my $memberName = "m_" . $name;
1425             my $varName = "in" . $name;
1426             my $type = GetObjCType($attribute->signature->type);
1427             push(@ivarsInitSig, "$name:($type)$varName");
1428             push(@ivarsInitCall, "$name:$varName");
1429             push(@ivarsToRetain, "    $memberName = [$varName retain];\n");
1430         }
1431         $ivarsToInit = " " . join(" ", @ivarsInitCall);
1432         $typeMakerSigAddition = " " . join(" ", @ivarsInitSig);
1433     }
1434
1435     # - Type-Maker
1436     my $typeMakerName = GetObjCTypeMaker($interfaceName);
1437     my $typeMakerSig = "+ ($className *)$typeMakerName:($implClassNameWithNamespace *)impl" . $typeMakerSigAddition;
1438     $typeMakerSig = "+ ($className *)$typeMakerName:($podTypeWithNamespace)impl" . $typeMakerSigAddition if $podType;
1439
1440     # Generate interface definitions. 
1441     @internalHeaderContent = split("\r", $implementationLicenceTemplate);
1442     push(@internalHeaderContent, "\n#import <WebCore/$className.h>\n");
1443     if ($interfaceName eq "Node") {
1444         push(@internalHeaderContent, "\n\@protocol DOMEventTarget;\n");
1445     }
1446     if ($codeGenerator->IsSVGAnimatedType($interfaceName)) {
1447         push(@internalHeaderContent, "#import <WebCore/SVGAnimatedTemplate.h>\n\n");
1448     } else {
1449         if ($podType and $podType ne "double") {
1450             push(@internalHeaderContent, "\nnamespace WebCore { class $podType; }\n\n");
1451         } elsif ($interfaceName eq "Node") {
1452             push(@internalHeaderContent, "\nnamespace WebCore { class Node; class EventTarget; }\n\n");
1453         } else { 
1454             push(@internalHeaderContent, "\nnamespace WebCore { class $implClassName; }\n\n");
1455         }
1456     }
1457
1458     push(@internalHeaderContent, "\@interface $className (WebCoreInternal)\n");
1459     push(@internalHeaderContent, $typeGetterSig . ";\n");
1460     push(@internalHeaderContent, $typeMakerSig . ";\n");
1461     if ($interfaceName eq "Node") {
1462         push(@internalHeaderContent, "+ (id <DOMEventTarget>)_eventTargetWith:(WebCore::EventTarget *)eventTarget;\n");
1463     }
1464     push(@internalHeaderContent, "\@end\n");
1465
1466     unless ($dataNode->extendedAttributes->{ObjCCustomInternalImpl}) {
1467         # - BEGIN WebCoreInternal category @implementation
1468         push(@implContent, "\n\@implementation $className (WebCoreInternal)\n\n");
1469
1470         push(@implContent, "$typeGetterSig\n");
1471         push(@implContent, "{\n");
1472
1473         if ($podType) {
1474             push(@implContent, "    return *IMPL;\n");
1475         } else {
1476             push(@implContent, "    return IMPL;\n");
1477         }
1478
1479         push(@implContent, "}\n\n");
1480
1481         if ($podType) {
1482             # - (id)_initWithFooBar:(WebCore::FooBar)impl for implementation class FooBar
1483             my $initWithImplName = "_initWith" . $implClassName;
1484             my $initWithSig = "- (id)$initWithImplName:($podTypeWithNamespace)impl" . $typeMakerSigAddition;
1485
1486             # FIXME: Implement Caching
1487             push(@implContent, "$initWithSig\n");
1488             push(@implContent, "{\n");
1489             push(@implContent, "    $assertMainThread;\n");
1490             push(@implContent, "    [super _init];\n");
1491             push(@implContent, "    $podTypeWithNamespace* _impl = new $podTypeWithNamespace(impl);\n");
1492             push(@implContent, "    _internal = reinterpret_cast<DOMObjectInternal*>(_impl);\n");
1493             push(@implContent, "    return self;\n");
1494             push(@implContent, "}\n\n");
1495
1496             # - (DOMFooBar)_FooBarWith:(WebCore::FooBar)impl for implementation class FooBar
1497             push(@implContent, "$typeMakerSig\n");
1498             push(@implContent, "{\n");
1499             push(@implContent, "    $assertMainThread;\n");
1500             push(@implContent, "    return [[[self alloc] $initWithImplName:impl] autorelease];\n");
1501             push(@implContent, "}\n\n");
1502         } elsif ($parentImplClassName eq "Object") {        
1503             # - (id)_initWithFooBar:(WebCore::FooBar *)impl for implementation class FooBar
1504             my $initWithImplName = "_initWith" . $implClassName;
1505             my $initWithSig = "- (id)$initWithImplName:($implClassNameWithNamespace *)impl" . $typeMakerSigAddition;
1506
1507             push(@implContent, "$initWithSig\n");
1508             push(@implContent, "{\n");
1509             push(@implContent, "    $assertMainThread;\n");
1510             push(@implContent, "    [super _init];\n");
1511             push(@implContent, "    _internal = reinterpret_cast<DOMObjectInternal*>(impl);\n");
1512             push(@implContent, "    impl->ref();\n");
1513             push(@implContent, "    WebCore::addDOMWrapper(self, impl);\n");
1514             push(@implContent, @ivarsToRetain);
1515             push(@implContent, "    return self;\n");
1516             push(@implContent, "}\n\n");
1517
1518             # - (DOMFooBar)_FooBarWith:(WebCore::FooBar *)impl for implementation class FooBar
1519             push(@implContent, "$typeMakerSig\n");
1520             push(@implContent, "{\n");
1521             push(@implContent, "    $assertMainThread;\n");
1522             push(@implContent, "    if (!impl)\n");
1523             push(@implContent, "        return nil;\n");
1524             push(@implContent, "    id cachedInstance;\n");
1525             push(@implContent, "    cachedInstance = WebCore::getDOMWrapper(impl);\n");
1526             push(@implContent, "    if (cachedInstance)\n");
1527             push(@implContent, "        return [[cachedInstance retain] autorelease];\n");
1528             push(@implContent, "    return [[[self alloc] $initWithImplName:impl" . $ivarsToInit . "] autorelease];\n");
1529             push(@implContent, "}\n\n");
1530         } else {
1531             my $internalBaseType = "DOM$baseClass";
1532             my $internalBaseTypeMaker = GetObjCTypeMaker($baseClass);
1533
1534             # - (DOMFooBar)_FooBarWith:(WebCore::FooBar *)impl for implementation class FooBar
1535             push(@implContent, "$typeMakerSig\n");
1536             push(@implContent, "{\n");
1537             push(@implContent, "    $assertMainThread;\n");
1538             push(@implContent, "    return static_cast<$className*>([$internalBaseType $internalBaseTypeMaker:impl]);\n");
1539             push(@implContent, "}\n\n");
1540         }
1541
1542         # END WebCoreInternal category
1543         push(@implContent, "\@end\n");
1544     }
1545
1546     # - End the ifdef conditional if necessary
1547     push(@implContent, "\n#endif // ${conditional}_SUPPORT\n") if $conditional;
1548 }
1549
1550 # Internal helper
1551 sub WriteData
1552 {
1553     my $object = shift;
1554     my $name = shift;
1555
1556     # Open files for writing...
1557     my $headerFileName = "$outputDir/" . $name . ".h";
1558     my $privateHeaderFileName = "$outputDir/" . $name . "Private.h";
1559     my $implFileName = "$outputDir/" . $name . ".mm";
1560     my $internalHeaderFileName = "$outputDir/" . $name . "Internal.h";
1561
1562     # Remove old files.
1563     unlink($headerFileName);
1564     unlink($privateHeaderFileName);
1565     unlink($implFileName);
1566     unlink($internalHeaderFileName);
1567
1568     # Write public header.
1569     open(HEADER, ">$headerFileName") or die "Couldn't open file $headerFileName";
1570     
1571     print HEADER @headerContentHeader;
1572     print HEADER map { "\@class $_;\n" } sort keys(%headerForwardDeclarations);
1573     print HEADER map { "\@protocol $_;\n" } sort keys(%headerForwardDeclarationsForProtocols);
1574
1575     my $hasForwardDeclarations = keys(%headerForwardDeclarations) + keys(%headerForwardDeclarationsForProtocols);
1576     print HEADER "\n" if $hasForwardDeclarations;
1577     print HEADER @headerContent;
1578
1579     close(HEADER);
1580
1581     @headerContentHeader = ();
1582     @headerContent = ();
1583     %headerForwardDeclarations = ();
1584     %headerForwardDeclarationsForProtocols = ();
1585
1586     if (@privateHeaderContent > 0) {
1587         open(PRIVATE_HEADER, ">$privateHeaderFileName") or die "Couldn't open file $privateHeaderFileName";
1588
1589         print PRIVATE_HEADER @privateHeaderContentHeader;
1590         print PRIVATE_HEADER map { "\@class $_;\n" } sort keys(%privateHeaderForwardDeclarations);
1591         print PRIVATE_HEADER map { "\@protocol $_;\n" } sort keys(%privateHeaderForwardDeclarationsForProtocols);
1592
1593         $hasForwardDeclarations = keys(%privateHeaderForwardDeclarations) + keys(%privateHeaderForwardDeclarationsForProtocols);
1594         print PRIVATE_HEADER "\n" if $hasForwardDeclarations;
1595         print PRIVATE_HEADER @privateHeaderContent;
1596
1597         close(PRIVATE_HEADER);
1598
1599         @privateHeaderContentHeader = ();
1600         @privateHeaderContent = ();
1601         %privateHeaderForwardDeclarations = ();
1602         %privateHeaderForwardDeclarationsForProtocols = ();
1603     }
1604
1605     # Write implementation file.
1606     unless ($noImpl) {
1607         open(IMPL, ">$implFileName") or die "Couldn't open file $implFileName";
1608
1609         print IMPL @implContentHeader;
1610         print IMPL map { "#import \"$_\"\n" } sort keys(%implIncludes);
1611
1612         print IMPL "\n" if keys(%implIncludes);
1613         print IMPL @implContent;
1614
1615         close(IMPL);
1616
1617         @implContentHeader = ();
1618         @implContent = ();
1619         %implIncludes = ();
1620     }
1621     
1622     if (@internalHeaderContent > 0) {
1623        open(INTERNAL_HEADER, ">$internalHeaderFileName") or die "Couldn't open file $internalHeaderFileName";
1624
1625        print INTERNAL_HEADER @internalHeaderContent;
1626
1627        close(INTERNAL_HEADER);
1628
1629        @internalHeaderContent = ();
1630     }
1631 }
1632
1633 1;