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