2009-02-12 Simon Fraser <simon.fraser@apple.com>
[WebKit-https.git] / WebKitTools / Scripts / webkitdirs.pm
1 # Copyright (C) 2005, 2006, 2007 Apple Inc. All rights reserved.
2 #
3 # Redistribution and use in source and binary forms, with or without
4 # modification, are permitted provided that the following conditions
5 # are met:
6 #
7 # 1.  Redistributions of source code must retain the above copyright
8 #     notice, this list of conditions and the following disclaimer. 
9 # 2.  Redistributions in binary form must reproduce the above copyright
10 #     notice, this list of conditions and the following disclaimer in the
11 #     documentation and/or other materials provided with the distribution. 
12 # 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
13 #     its contributors may be used to endorse or promote products derived
14 #     from this software without specific prior written permission. 
15 #
16 # THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
17 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 # DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
20 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
27 # Module to share code to get to WebKit directories.
28
29 use strict;
30 use warnings;
31 use FindBin;
32 use File::Basename;
33 use POSIX;
34 use VCSUtils;
35
36 BEGIN {
37    use Exporter   ();
38    our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
39    $VERSION     = 1.00;
40    @ISA         = qw(Exporter);
41    @EXPORT      = qw(&chdirWebKit &baseProductDir &productDir &XcodeOptions &XcodeOptionString &XcodeOptionStringNoConfig &passedConfiguration &setConfiguration &safariPath &checkFrameworks &currentSVNRevision);
42    %EXPORT_TAGS = ( );
43    @EXPORT_OK   = ();
44 }
45
46 our @EXPORT_OK;
47
48 my $baseProductDir;
49 my @baseProductDirOption;
50 my $configuration;
51 my $configurationForVisualStudio;
52 my $configurationProductDir;
53 my $sourceDir;
54 my $currentSVNRevision;
55 my $osXVersion;
56 my $isQt;
57 my $isGtk;
58 my $isWx;
59 my @wxArgs;
60 my $isChromium;
61 my $forceRun64Bit;
62
63 # Variables for Win32 support
64 my $vcBuildPath;
65 my $windowsTmpPath;
66
67 sub determineSourceDir
68 {
69     return if $sourceDir;
70     $sourceDir = $FindBin::Bin;
71     $sourceDir =~ s|/+$||; # Remove trailing '/' as we would die later
72
73     # walks up path checking each directory to see if it is the main WebKit project dir, 
74     # defined by containing JavaScriptCore, WebCore, and WebKit
75     until ((-d "$sourceDir/JavaScriptCore" && -d "$sourceDir/WebCore" && -d "$sourceDir/WebKit") || (-d "$sourceDir/Internal" && -d "$sourceDir/OpenSource"))
76     {
77         if ($sourceDir !~ s|/[^/]+$||) {
78             die "Could not find top level webkit directory above source directory using FindBin.\n";
79         }
80     }
81
82     $sourceDir = "$sourceDir/OpenSource" if -d "$sourceDir/OpenSource";
83 }
84
85 # used for scripts which are stored in a non-standard location
86 sub setSourceDir($)
87 {
88     ($sourceDir) = @_;
89 }
90
91 sub determineBaseProductDir
92 {
93     return if defined $baseProductDir;
94     determineSourceDir();
95     if (isAppleMacWebKit()) {
96         open PRODUCT, "defaults read com.apple.Xcode PBXApplicationwideBuildSettings 2> /dev/null |" or die;
97         $baseProductDir = join '', <PRODUCT>;
98         close PRODUCT;
99
100         $baseProductDir = $1 if $baseProductDir =~ /SYMROOT\s*=\s*\"(.*?)\";/s;
101         undef $baseProductDir unless $baseProductDir =~ /^\//;
102
103         if (!defined($baseProductDir)) {
104             open PRODUCT, "defaults read com.apple.Xcode PBXProductDirectory 2> /dev/null |" or die;
105             $baseProductDir = <PRODUCT>;
106             close PRODUCT;
107             if ($baseProductDir) {
108                 chomp $baseProductDir;
109                 undef $baseProductDir unless $baseProductDir =~ /^\//;
110             }
111         }
112     } else {
113         $baseProductDir = $ENV{"WEBKITOUTPUTDIR"};
114         if (isAppleWinWebKit() && $baseProductDir) {
115             my $unixBuildPath = `cygpath --unix \"$baseProductDir\"`;
116             chomp $unixBuildPath;
117             $baseProductDir = $unixBuildPath;
118         }
119     }
120
121     if ($baseProductDir && isAppleMacWebKit()) {
122         $baseProductDir =~ s|^\Q$(SRCROOT)/..\E$|$sourceDir|;
123         $baseProductDir =~ s|^\Q$(SRCROOT)/../|$sourceDir/|;
124         $baseProductDir =~ s|^~/|$ENV{HOME}/|;
125         die "Can't handle Xcode product directory with a ~ in it.\n" if $baseProductDir =~ /~/;
126         die "Can't handle Xcode product directory with a variable in it.\n" if $baseProductDir =~ /\$/;
127         @baseProductDirOption = ();
128     }
129
130     if (!defined($baseProductDir)) {
131         $baseProductDir = "$sourceDir/WebKitBuild";
132
133         if (isGit() && isGitBranchBuild()) {
134             my $branch = gitBranch();
135             $baseProductDir = "$baseProductDir/$branch";
136         }
137
138         @baseProductDirOption = ("SYMROOT=$baseProductDir", "OBJROOT=$baseProductDir") if (isAppleMacWebKit());
139         if (isCygwin()) {
140             my $dosBuildPath = `cygpath --windows \"$baseProductDir\"`;
141             chomp $dosBuildPath;
142             $ENV{"WEBKITOUTPUTDIR"} = $dosBuildPath;
143         }
144     }
145 }
146
147 sub setBaseProductDir($)
148 {
149     ($baseProductDir) = @_;
150 }
151
152 sub determineConfiguration
153 {
154     return if defined $configuration;
155     determineBaseProductDir();
156     if (open CONFIGURATION, "$baseProductDir/Configuration") {
157         $configuration = <CONFIGURATION>;
158         close CONFIGURATION;
159     }
160     if ($configuration) {
161         chomp $configuration;
162         # compatibility for people who have old Configuration files
163         $configuration = "Release" if $configuration eq "Deployment";
164         $configuration = "Debug" if $configuration eq "Development";
165     } else {
166         $configuration = "Release";
167     }
168 }
169
170 sub argumentsForConfiguration()
171 {
172     determineConfiguration();
173
174     my @args = ();
175     push(@args, '--debug') if $configuration eq "Debug";
176     push(@args, '--release') if $configuration eq "Release";
177     push(@args, '--qt') if isQt();
178     push(@args, '--gtk') if isGtk();
179     push(@args, '--wx') if isWx();
180     push(@args, '--chromium') if isChromium();
181     return @args;
182 }
183
184 sub determineConfigurationForVisualStudio
185 {
186     return if defined $configurationForVisualStudio;
187     determineConfiguration();
188     $configurationForVisualStudio = $configuration;
189     return unless $configuration eq "Debug";
190     setupCygwinEnv();
191     chomp(my $dir = `cygpath -ua '$ENV{WEBKITLIBRARIESDIR}'`);
192     $configurationForVisualStudio = "Debug_Internal" if -f "$dir/bin/CoreFoundation_debug.dll";
193 }
194
195 sub determineConfigurationProductDir
196 {
197     return if defined $configurationProductDir;
198     determineBaseProductDir();
199     determineConfiguration();
200     if (isAppleWinWebKit() && !isWx()) {
201         $configurationProductDir = "$baseProductDir/bin";
202     } else {
203         $configurationProductDir = "$baseProductDir/$configuration";
204     }
205 }
206
207 sub setConfigurationProductDir($)
208 {
209     ($configurationProductDir) = @_;
210 }
211
212 sub determineCurrentSVNRevision
213 {
214     return if defined $currentSVNRevision;
215     determineSourceDir();
216     $currentSVNRevision = svnRevisionForDirectory($sourceDir);
217     return $currentSVNRevision;
218 }
219
220
221 sub chdirWebKit
222 {
223     determineSourceDir();
224     chdir $sourceDir or die;
225 }
226
227 sub baseProductDir
228 {
229     determineBaseProductDir();
230     return $baseProductDir;
231 }
232
233 sub sourceDir
234 {
235     determineSourceDir();
236     return $sourceDir;
237 }
238
239 sub productDir
240 {
241     determineConfigurationProductDir();
242     return $configurationProductDir;
243 }
244
245 sub configuration()
246 {
247     determineConfiguration();
248     return $configuration;
249 }
250
251 sub configurationForVisualStudio()
252 {
253     determineConfigurationForVisualStudio();
254     return $configurationForVisualStudio;
255 }
256
257 sub currentSVNRevision
258 {
259     determineCurrentSVNRevision();
260     return $currentSVNRevision;
261 }
262
263 sub XcodeOptions
264 {
265     determineBaseProductDir();
266     determineConfiguration();
267     return (@baseProductDirOption, "-configuration", $configuration);
268 }
269
270 sub XcodeOptionString
271 {
272     return join " ", XcodeOptions();
273 }
274
275 sub XcodeOptionStringNoConfig
276 {
277     return join " ", @baseProductDirOption;
278 }
279
280 sub XcodeCoverageSupportOptions()
281 {
282     my @coverageSupportOptions = ();
283     push @coverageSupportOptions, "GCC_GENERATE_TEST_COVERAGE_FILES=YES";
284     push @coverageSupportOptions, "GCC_INSTRUMENT_PROGRAM_FLOW_ARCS=YES";
285     push @coverageSupportOptions, "EXTRA_LINK= -ftest-coverage -fprofile-arcs";
286     push @coverageSupportOptions, "OTHER_CFLAGS= -MD";
287     push @coverageSupportOptions, "OTHER_LDFLAGS=\$(OTHER_LDFLAGS) -ftest-coverage -fprofile-arcs -framework AppKit";
288     return @coverageSupportOptions;
289 }
290
291 my $passedConfiguration;
292 my $searchedForPassedConfiguration;
293 sub determinePassedConfiguration
294 {
295     return if $searchedForPassedConfiguration;
296     $searchedForPassedConfiguration = 1;
297
298     my $isWinCairo = checkForArgumentAndRemoveFromARGV("--cairo-win32");
299
300     for my $i (0 .. $#ARGV) {
301         my $opt = $ARGV[$i];
302         if ($opt =~ /^--debug$/i || $opt =~ /^--devel/i) {
303             splice(@ARGV, $i, 1);
304             $passedConfiguration = "Debug";
305             $passedConfiguration .= "_Cairo" if ($isWinCairo && isCygwin());
306             return;
307         }
308         if ($opt =~ /^--release$/i || $opt =~ /^--deploy/i) {
309             splice(@ARGV, $i, 1);
310             $passedConfiguration = "Release";
311             $passedConfiguration .= "_Cairo" if ($isWinCairo && isCygwin());
312             return;
313         }
314         if ($opt =~ /^--profil(e|ing)$/i) {
315             splice(@ARGV, $i, 1);
316             $passedConfiguration = "Profiling";
317             $passedConfiguration .= "_Cairo" if ($isWinCairo && isCygwin());
318             return;
319         }
320     }
321     $passedConfiguration = undef;
322 }
323
324 sub passedConfiguration
325 {
326     determinePassedConfiguration();
327     return $passedConfiguration;
328 }
329
330 sub setConfiguration
331 {
332     if (my $config = shift @_) {
333         $configuration = $config;
334         return;
335     }
336
337     determinePassedConfiguration();
338     $configuration = $passedConfiguration if $passedConfiguration;
339 }
340
341 sub safariPathFromSafariBundle
342 {
343     my ($safariBundle) = @_;
344
345     return "$safariBundle/Contents/MacOS/Safari" if isAppleMacWebKit();
346     return $safariBundle if isAppleWinWebKit();
347 }
348
349 sub installedSafariPath
350 {
351     my $safariBundle;
352
353     if (isAppleMacWebKit()) {
354         $safariBundle = "/Applications/Safari.app";
355     } elsif (isAppleWinWebKit()) {
356         $safariBundle = `"$configurationProductDir/FindSafari.exe"`;
357         $safariBundle =~ s/[\r\n]+$//;
358         $safariBundle = `cygpath -u '$safariBundle'`;
359         $safariBundle =~ s/[\r\n]+$//;
360         $safariBundle .= "Safari.exe";
361     }
362
363     return safariPathFromSafariBundle($safariBundle);
364 }
365
366 # Locate Safari.
367 sub safariPath
368 {
369     # Use WEBKIT_SAFARI environment variable if present.
370     my $safariBundle = $ENV{WEBKIT_SAFARI};
371     if (!$safariBundle) {
372         determineConfigurationProductDir();
373         # Use Safari.app in product directory if present (good for Safari development team).
374         if (isAppleMacWebKit() && -d "$configurationProductDir/Safari.app") {
375             $safariBundle = "$configurationProductDir/Safari.app";
376         } elsif (isAppleWinWebKit() && -x "$configurationProductDir/bin/Safari.exe") {
377             $safariBundle = "$configurationProductDir/bin/Safari.exe";
378         } else {
379             return installedSafariPath();
380         }
381     }
382     my $safariPath = safariPathFromSafariBundle($safariBundle);
383     die "Can't find executable at $safariPath.\n" if isAppleMacWebKit() && !-x $safariPath;
384     return $safariPath;
385 }
386
387 sub builtDylibPathForName
388 {
389     my $libraryName = shift;
390     determineConfigurationProductDir();
391     if (isQt() or isGtk() or isChromium()) {
392         return "$configurationProductDir/$libraryName";
393     }
394     if (isAppleMacWebKit()) {
395         return "$configurationProductDir/$libraryName.framework/Versions/A/$libraryName";
396     }
397     if (isAppleWinWebKit()) {
398         if ($libraryName eq "JavaScriptCore") {
399             return "$baseProductDir/lib/$libraryName.lib";
400         } else {
401             return "$baseProductDir/$libraryName.intermediate/$configuration/$libraryName.intermediate/$libraryName.lib";
402         }
403     }
404
405     die "Unsupported platform, can't determine built library locations.";
406 }
407
408 # Check to see that all the frameworks are built.
409 sub checkFrameworks
410 {
411     return if isCygwin();
412     my @frameworks = ("JavaScriptCore", "WebCore");
413     push(@frameworks, "WebKit") if isAppleMacWebKit();
414     for my $framework (@frameworks) {
415         my $path = builtDylibPathForName($framework);
416         die "Can't find built framework at \"$path\".\n" unless -x $path;
417     }
418 }
419
420 sub hasSVGSupport
421 {
422     return 0 if isCygwin();
423
424     my $path = shift;
425
426     if (isQt()) {
427         return 1;
428     }
429
430     if (isGtk() and $path =~ /WebCore/) {
431         $path .= "/../.libs/libwebkit-1.0.so";
432     }
433
434     my $hasSVGSupport = 0;
435     if (-e $path) {
436         open NM, "-|", "nm", $path or die;
437         while (<NM>) {
438             $hasSVGSupport = 1 if /SVGElement/;
439         }
440         close NM;
441     }
442     return $hasSVGSupport;
443 }
444
445 sub removeLibraryDependingOnSVG
446 {
447     my $frameworkName = shift;
448     my $shouldHaveSVG = shift;
449
450     my $path = builtDylibPathForName($frameworkName);
451     return unless -x $path;
452
453     my $hasSVG = hasSVGSupport($path);
454     system "rm -f $path" if ($shouldHaveSVG xor $hasSVG);
455 }
456
457 sub checkWebCoreSVGSupport
458 {
459     my $required = shift;
460     my $framework = "WebCore";
461     my $path = builtDylibPathForName($framework);
462     my $hasSVG = hasSVGSupport($path);
463     if ($required && !$hasSVG) {
464         die "$framework at \"$path\" does not include SVG Support, please run build-webkit --svg\n";
465     }
466     return $hasSVG;
467 }
468
469 sub hasAcceleratedCompositingSupport
470 {
471     return 0 if isCygwin();
472     
473     my $path = shift;
474
475     my $useAcceleratedCompositing = 0;
476     if (-e $path) {
477         open NM, "-|", "nm", $path or die;
478         while (<NM>) {
479             $useAcceleratedCompositing = 1 if /GraphicsLayer/;
480         }
481         close NM;
482     }
483     return $useAcceleratedCompositing;
484 }
485
486 sub checkWebCoreAcceleratedCompositingSupport
487 {
488     my $required = shift;
489     my $framework = "WebCore";
490     my $path = builtDylibPathForName($framework);
491     my $hasAcceleratedCompositing = hasAcceleratedCompositingSupport($path);
492     if ($required && !$hasAcceleratedCompositing) {
493         die "$framework at \"$path\" does not use accelerated compositing\n";
494     }
495     return $hasAcceleratedCompositing;
496 }
497
498 sub has3DTransformsSupport
499 {
500     return 0 if isCygwin();
501     
502     my $path = shift;
503
504     my $has3DTransformsSupport = 0;
505     if (-e $path) {
506         open NM, "-|", "nm", $path or die;
507         while (<NM>) {
508             $has3DTransformsSupport = 1 if /WebCoreHas3DTransforms/;
509         }
510         close NM;
511     }
512     return $has3DTransformsSupport;
513 }
514
515 sub checkWebCore3DTransformsSupport
516 {
517     my $required = shift;
518     my $framework = "WebCore";
519     my $path = builtDylibPathForName($framework);
520     my $has3DTransforms = has3DTransformsSupport($path);
521     if ($required && !$has3DTransforms) {
522         die "$framework at \"$path\" does not include 3D Transforms Support, please run build-webkit --3d-transforms\n";
523     }
524     return $has3DTransforms;
525 }
526
527 sub hasWMLSupport
528 {
529     return 0 if isCygwin();
530
531     my $path = shift;
532
533     if (isQt()) {
534         # FIXME: Check built library for WML support, just like Gtk does it below.
535         return 0;
536     }
537
538     if (isGtk() and $path =~ /WebCore/) {
539         $path .= "/../.libs/webkit-1.0.so";
540     }
541
542     my $hasWMLSupport = 0;
543     if (-e $path) {
544         open NM, "-|", "nm", $path or die;
545         while (<NM>) {
546             $hasWMLSupport = 1 if /WMLElement/;
547         }
548         close NM;
549     }
550     return $hasWMLSupport;
551 }
552
553 sub removeLibraryDependingOnWML
554 {
555     my $frameworkName = shift;
556     my $shouldHaveWML = shift;
557
558     my $path = builtDylibPathForName($frameworkName);
559     return unless -x $path;
560
561     my $hasWML = hasWMLSupport($path);
562     system "rm -f $path" if ($shouldHaveWML xor $hasWML);
563 }
564
565 sub checkWebCoreWMLSupport
566 {
567     my $required = shift;
568     my $framework = "WebCore";
569     my $path = builtDylibPathForName($framework);
570     my $hasWML = hasWMLSupport($path);
571     if ($required && !$hasWML) {
572         die "$framework at \"$path\" does not include WML Support, please run build-webkit --wml\n";
573     }
574     return $hasWML;
575 }
576
577 sub isQt()
578 {
579     determineIsQt();
580     return $isQt;
581 }
582
583 sub checkForArgumentAndRemoveFromARGV
584 {
585     my $argToCheck = shift;
586     foreach my $opt (@ARGV) {
587         if ($opt =~ /^$argToCheck$/i ) {
588             @ARGV = grep(!/^$argToCheck$/i, @ARGV);
589             return 1;
590         }
591     }
592     return 0;
593 }
594
595 sub determineIsQt()
596 {
597     return if defined($isQt);
598
599     # Allow override in case QTDIR is not set.
600     if (checkForArgumentAndRemoveFromARGV("--qt")) {
601         $isQt = 1;
602         return;
603     }
604
605     # The presence of QTDIR only means Qt if --gtk is not on the command-line
606     if (isGtk()) {
607         $isQt = 0;
608         return;
609     }
610     
611     $isQt = defined($ENV{'QTDIR'});
612 }
613
614 sub isGtk()
615 {
616     determineIsGtk();
617     return $isGtk;
618 }
619
620 sub determineIsGtk()
621 {
622     return if defined($isGtk);
623     $isGtk = checkForArgumentAndRemoveFromARGV("--gtk");
624 }
625
626 sub isWx()
627 {
628     determineIsWx();
629     return $isWx;
630 }
631
632 sub determineIsWx()
633 {
634     return if defined($isWx);
635     $isWx = checkForArgumentAndRemoveFromARGV("--wx");
636 }
637
638 sub getWxArgs()
639 {
640     if (!@wxArgs) {
641         @wxArgs = ("");
642         my $rawWxArgs = "";
643         foreach my $opt (@ARGV) {
644             if ($opt =~ /^--wx-args/i ) {
645                 @ARGV = grep(!/^--wx-args/i, @ARGV);
646                 $rawWxArgs = $opt;
647                 $rawWxArgs =~ s/--wx-args=//i;
648             }
649         }
650         @wxArgs = split(/,/, $rawWxArgs);
651     }
652     return @wxArgs;
653 }
654
655 # Determine if this is debian, ubuntu, linspire, or something similar.
656 sub isDebianBased()
657 {
658     return -e "/etc/debian_version";
659 }
660
661 sub isChromium()
662 {
663     determineIsChromium();
664     return $isChromium;
665 }
666
667 sub determineIsChromium()
668 {
669     return if defined($isChromium);
670     $isChromium = checkForArgumentAndRemoveFromARGV("--chromium");
671 }
672
673 sub isCygwin()
674 {
675     return ($^O eq "cygwin") || 0;
676 }
677
678 sub isDarwin()
679 {
680     return ($^O eq "darwin") || 0;
681 }
682
683 sub isAppleWebKit()
684 {
685     return !(isQt() or isGtk() or isWx() or isChromium());
686 }
687
688 sub isAppleMacWebKit()
689 {
690     return isAppleWebKit() && isDarwin();
691 }
692
693 sub isAppleWinWebKit()
694 {
695     return isAppleWebKit() && isCygwin();
696 }
697
698 sub isPerianInstalled()
699 {
700     if (!isAppleWebKit()) {
701         return 0;
702     }
703
704     if (-d "/Library/QuickTime/Perian.component") {
705         return 1;
706     }
707
708     if (-d "$ENV{HOME}/Library/QuickTime/Perian.component") {
709         return 1;
710     }
711
712     return 0;
713 }
714
715 sub determineOSXVersion()
716 {
717     return if $osXVersion;
718
719     if (!isDarwin()) {
720         $osXVersion = -1;
721         return;
722     }
723
724     my $version = `sw_vers -productVersion`;
725     my @splitVersion = split(/\./, $version);
726     @splitVersion >= 2 or die "Invalid version $version";
727     $osXVersion = {
728             "major" => $splitVersion[0],
729             "minor" => $splitVersion[1],
730             "subminor" => (defined($splitVersion[2]) ? $splitVersion[2] : 0),
731     };
732 }
733
734 sub osXVersion()
735 {
736     determineOSXVersion();
737     return $osXVersion;
738 }
739
740 sub isTiger()
741 {
742     return isDarwin() && osXVersion()->{"minor"} == 4;
743 }
744
745 sub isLeopard()
746 {
747     return isDarwin() && osXVersion()->{"minor"} == 5;
748 }
749
750 sub isSnowLeopard()
751 {
752     return isDarwin() && osXVersion()->{"minor"} == 6;
753 }
754
755 sub relativeScriptsDir()
756 {
757     my $scriptDir = File::Spec->catpath("", File::Spec->abs2rel(dirname($0), getcwd()), "");
758     if ($scriptDir eq "") {
759         $scriptDir = ".";
760     }
761     return $scriptDir;
762 }
763
764 sub launcherPath()
765 {
766     my $relativeScriptsPath = relativeScriptsDir();
767     if (isGtk() || isQt()) {
768         return "$relativeScriptsPath/run-launcher";
769     } elsif (isAppleWebKit()) {
770         return "$relativeScriptsPath/run-safari";
771     }
772 }
773
774 sub launcherName()
775 {
776     if (isGtk()) {
777         return "GtkLauncher";
778     } elsif (isQt()) {
779         return "QtLauncher";
780     } elsif (isAppleWebKit()) {
781         return "Safari";
782     }
783 }
784
785 sub checkRequiredSystemConfig
786 {
787     if (isDarwin()) {
788         chomp(my $productVersion = `sw_vers -productVersion`);
789         if ($productVersion lt "10.4") {
790             print "*************************************************************\n";
791             print "Mac OS X Version 10.4.0 or later is required to build WebKit.\n";
792             print "You have " . $productVersion . ", thus the build will most likely fail.\n";
793             print "*************************************************************\n";
794         }
795         my $xcodeVersion = `xcodebuild -version`;
796         if ($xcodeVersion !~ /DevToolsCore-(\d+)/ || $1 < 747) {
797             print "*************************************************************\n";
798             print "Xcode Version 2.3 or later is required to build WebKit.\n";
799             print "You have an earlier version of Xcode, thus the build will\n";
800             print "most likely fail.  The latest Xcode is available from the web:\n";
801             print "http://developer.apple.com/tools/xcode\n";
802             print "*************************************************************\n";
803         }
804     } elsif (isGtk() or isQt() or isWx()) {
805         my @cmds = qw(flex bison gperf);
806         my @missing = ();
807         foreach my $cmd (@cmds) {
808             if (not `$cmd --version`) {
809                 push @missing, $cmd;
810             }
811         }
812         if (@missing) {
813             my $list = join ", ", @missing;
814             die "ERROR: $list missing but required to build WebKit.\n";
815         }
816     }
817     # Win32 and other platforms may want to check for minimum config
818 }
819
820 sub setupCygwinEnv()
821 {
822     return if !isCygwin();
823     return if $vcBuildPath;
824
825     my $programFilesPath = `cygpath "$ENV{'PROGRAMFILES'}"`;
826     chomp $programFilesPath;
827     $vcBuildPath = "$programFilesPath/Microsoft Visual Studio 8/Common7/IDE/devenv.com";
828     if (! -e $vcBuildPath) {
829         # VC++ not found, try VC++ Express
830         my $vsInstallDir;
831         if ($ENV{'VSINSTALLDIR'}) {
832             $vsInstallDir = $ENV{'VSINSTALLDIR'};
833         } else {
834             $programFilesPath = $ENV{'PROGRAMFILES'} || "C:\\Program Files";
835             $vsInstallDir = "$programFilesPath/Microsoft Visual Studio 8";
836         }
837         $vsInstallDir = `cygpath "$vsInstallDir"`;
838         chomp $vsInstallDir;
839         $vcBuildPath = "$vsInstallDir/Common7/IDE/VCExpress.exe";
840         if (! -e $vcBuildPath) {
841             print "*************************************************************\n";
842             print "Cannot find '$vcBuildPath'\n";
843             print "Please execute the file 'vcvars32.bat' from\n";
844             print "'$programFilesPath\\Microsoft Visual Studio 8\\VC\\bin\\'\n";
845             print "to setup the necessary environment variables.\n";
846             print "*************************************************************\n";
847             die;
848         }
849     }
850
851     my $qtSDKPath = "$programFilesPath/QuickTime SDK";
852     if (0 && ! -e $qtSDKPath) {
853         print "*************************************************************\n";
854         print "Cannot find '$qtSDKPath'\n";
855         print "Please download the QuickTime SDK for Windows from\n";
856         print "http://developer.apple.com/quicktime/download/\n";
857         print "*************************************************************\n";
858         die;
859     }
860     
861     chomp($ENV{'WEBKITLIBRARIESDIR'} = `cygpath -wa "$sourceDir/WebKitLibraries/win"`) unless $ENV{'WEBKITLIBRARIESDIR'};
862
863     $windowsTmpPath = `cygpath -w /tmp`;
864     chomp $windowsTmpPath;
865     print "Building results into: ", baseProductDir(), "\n";
866     print "WEBKITOUTPUTDIR is set to: ", $ENV{"WEBKITOUTPUTDIR"}, "\n";
867     print "WEBKITLIBRARIESDIR is set to: ", $ENV{"WEBKITLIBRARIESDIR"}, "\n";
868 }
869
870 sub buildXCodeProject($$@)
871 {
872     my ($project, $clean, @extraOptions) = @_;
873
874     if ($clean) {
875         push(@extraOptions, "-alltargets");
876         push(@extraOptions, "clean");
877     }
878
879     return system "xcodebuild", "-project", "$project.xcodeproj", @extraOptions;
880 }
881
882 sub buildVisualStudioProject
883 {
884     my ($project, $clean) = @_;
885     setupCygwinEnv();
886
887     my $config = configurationForVisualStudio();
888
889     chomp(my $winProjectPath = `cygpath -w "$project"`);
890     
891     my $command = "/build";
892     if ($clean) {
893         $command = "/clean";
894     }
895
896     print "$vcBuildPath $winProjectPath /build $config\n";
897     return system $vcBuildPath, $winProjectPath, $command, $config;
898 }
899
900 sub buildSconsProject
901 {
902     my ($project, $shouldClean) = @_;
903     print "Building from $project/$project.scons\n";
904
905     my $sconsCommand = "scons";
906     if (isCygwin()) {
907         # HACK: Launch scons with Win32 python instead of CYGWIN python
908         # Scons + MSVC only works under Win32 python
909         # http://scons.tigris.org/issues/show_bug.cgi?id=2266
910         $sconsCommand = "cmd /c 'C:\\Python26\\Scripts\\scons'";
911     }
912     if ($shouldClean) {
913         return system $sconsCommand, "--clean";
914     }
915     return system $sconsCommand;
916 }
917
918 sub retrieveQMakespecVar
919 {
920     my $mkspec = $_[0];
921     my $varname = $_[1];
922
923     my $compiler = "unknown";
924     #print "retrieveMakespecVar " . $mkspec . ", " . $varname . "\n";
925
926     local *SPEC;
927     open SPEC, "<$mkspec" or return "make";
928     while (<SPEC>) {
929         if ($_ =~ /\s*include\((.+)\)/) {
930             # open the included mkspec
931             my $oldcwd = getcwd();
932             (my $volume, my $directories, my $file) = File::Spec->splitpath($mkspec);
933             chdir "$volume$directories";
934             $compiler = retrieveQMakespecVar($1, $varname);
935             chdir $oldcwd;
936         } elsif ($_ =~ /$varname\s*=\s*([^\s]+)/) {
937             $compiler = $1;
938             last;
939         }
940     }
941     close SPEC;
942     return $compiler;
943 }
944
945 sub qtMakeCommand($)
946 {
947     my ($qmakebin) = @_;
948     chomp(my $mkspec = `$qmakebin -query QMAKE_MKSPECS`);
949     $mkspec .= "/default";
950     my $compiler = retrieveQMakespecVar("$mkspec/qmake.conf", "QMAKE_CC");
951
952     #print "default spec: " . $mkspec . "\n";
953     #print "compiler found: " . $compiler . "\n";
954
955     if ($compiler eq "cl") {
956         return "nmake";
957     }
958
959     return "make";
960 }
961
962 sub autotoolsFlag($$)
963 {
964     my ($flag, $feature) = @_;
965     my $prefix = $flag ? "--enable" : "--disable";
966
967     return $prefix . '-' . $feature;
968 }
969
970 sub buildAutotoolsProject($@)
971 {
972     my ($clean, @buildArgs) = @_;
973
974     my $make = 'make';
975     my $dir = productDir();
976     my $config = passedConfiguration() || configuration();
977     my $prefix = $ENV{"WebKitInstallationPrefix"};
978
979     # check if configuration is Debug
980     if ($config =~ m/debug/i) {
981         push @buildArgs, "--enable-debug";
982     } else {
983         push @buildArgs, "--disable-debug";
984     }
985
986     # Use rm to clean the build directory since distclean may miss files
987     if ($clean && -d $dir) {
988         system "rm", "-rf", "$dir";
989     }
990
991     if (! -d $dir) {
992         system "mkdir", "-p", "$dir";
993         if (! -d $dir) {
994             die "Failed to create build directory " . $dir;
995         }
996     }
997
998     chdir $dir or die "Failed to cd into " . $dir . "\n";
999
1000     my $result;
1001     if ($clean) {
1002         #$result = system $make, "distclean";
1003         return 0;
1004     }
1005
1006     print "Calling configure in " . $dir . "\n\n";
1007     print "Installation directory: $prefix\n" if(defined($prefix));
1008
1009     # Make the path relative since it will appear in all -I compiler flags.
1010     # Long argument lists cause bizarre slowdowns in libtool.
1011     my $relSourceDir = File::Spec->abs2rel($sourceDir);
1012     $relSourceDir = "." if !$relSourceDir;
1013
1014     $result = system "$relSourceDir/autogen.sh", @buildArgs;
1015     if ($result ne 0) {
1016         die "Failed to setup build environment using 'autotools'!\n";
1017     }
1018
1019     $result = system $make;
1020     if ($result ne 0) {
1021         die "\nFailed to build WebKit using '$make'!\n";
1022     }
1023
1024     chdir ".." or die;
1025     return $result;
1026 }
1027
1028 sub buildQMakeProject($@)
1029 {
1030     my ($clean, @buildParams) = @_;
1031
1032     my @buildArgs = ("-r");
1033
1034     my $qmakebin = "qmake"; # Allow override of the qmake binary from $PATH
1035     my $makeargs = "";
1036     for my $i (0 .. $#buildParams) {
1037         my $opt = $buildParams[$i];
1038         if ($opt =~ /^--qmake=(.*)/i ) {
1039             $qmakebin = $1;
1040         } elsif ($opt =~ /^--qmakearg=(.*)/i ) {
1041             push @buildArgs, $1;
1042         } elsif ($opt =~ /^--makeargs=(.*)/i ) {
1043             $makeargs = $1;
1044         } else {
1045             push @buildArgs, $opt;
1046         }
1047     }
1048
1049     my $make = qtMakeCommand($qmakebin);
1050     my $config = configuration();
1051     my $prefix = $ENV{"WebKitInstallationPrefix"};
1052
1053     push @buildArgs, "OUTPUT_DIR=" . baseProductDir() . "/$config";
1054     push @buildArgs, sourceDir() . "/WebKit.pro";
1055     if ($config =~ m/debug/i) {
1056         push @buildArgs, "CONFIG-=release";
1057         push @buildArgs, "CONFIG+=debug";
1058     } else {
1059         push @buildArgs, "CONFIG+=release";
1060         push @buildArgs, "CONFIG-=debug";
1061     }
1062
1063     my $dir = baseProductDir();
1064     if (! -d $dir) {
1065         system "mkdir", "-p", "$dir";
1066         if (! -d $dir) {
1067             die "Failed to create product directory " . $dir;
1068         }
1069     }
1070     $dir = $dir . "/$config";
1071     if (! -d $dir) {
1072         system "mkdir", "-p", "$dir";
1073         if (! -d $dir) {
1074             die "Failed to create build directory " . $dir;
1075         }
1076     }
1077
1078     chdir $dir or die "Failed to cd into " . $dir . "\n";
1079
1080     print "Calling '$qmakebin @buildArgs' in " . $dir . "\n\n";
1081     print "Installation directory: $prefix\n" if(defined($prefix));
1082
1083     my $result = system $qmakebin, @buildArgs;
1084     if ($result ne 0) {
1085        die "Failed to setup build environment using $qmakebin!\n";
1086     }
1087
1088     if ($clean) {
1089       $result = system "$make $makeargs distclean";
1090     } else {
1091       $result = system "$make $makeargs";
1092     }
1093
1094     chdir ".." or die;
1095     return $result;
1096 }
1097
1098 sub buildQMakeQtProject($$@)
1099 {
1100     my ($project, $clean, @buildArgs) = @_;
1101
1102     push @buildArgs, "CONFIG+=qt-port";
1103
1104     return buildQMakeProject($clean, @buildArgs);
1105 }
1106
1107 sub buildGtkProject($$@)
1108 {
1109     my ($project, $clean, @buildArgs) = @_;
1110
1111     if ($project ne "WebKit") {
1112         die "The Gtk port builds JavaScriptCore, WebCore and WebKit in one shot! Only call it for 'WebKit'.\n";
1113     }
1114
1115     return buildAutotoolsProject($clean, @buildArgs);
1116 }
1117
1118 sub setPathForRunningWebKitApp
1119 {
1120     my ($env) = @_;
1121
1122     return unless isAppleWinWebKit();
1123
1124     $env->{PATH} = join(':', productDir(), dirname(installedSafariPath()), $env->{PATH} || "");
1125 }
1126
1127 sub exitStatus($)
1128 {
1129     my ($returnvalue) = @_;
1130     if ($^O eq "MSWin32") {
1131         return $returnvalue >> 8;
1132     }
1133     return WEXITSTATUS($returnvalue);
1134 }
1135
1136 sub runSafari
1137 {
1138     my ($debugger) = @_;
1139
1140     if (isAppleMacWebKit()) {
1141         return system "$FindBin::Bin/gdb-safari", @ARGV if $debugger;
1142
1143         my $productDir = productDir();
1144         print "Starting Safari with DYLD_FRAMEWORK_PATH set to point to built WebKit in $productDir.\n";
1145         $ENV{DYLD_FRAMEWORK_PATH} = $productDir;
1146         $ENV{WEBKIT_UNSET_DYLD_FRAMEWORK_PATH} = "YES";
1147         exportArchPreference();
1148         if (!isTiger()) {
1149             return system "arch", safariPath(), @ARGV;
1150         } else {
1151             return system safariPath(), @ARGV;
1152         }
1153     }
1154
1155     if (isAppleWinWebKit()) {
1156         my $script = "run-webkit-nightly.cmd";
1157         my $result = system "cp", "$FindBin::Bin/$script", productDir();
1158         return $result if $result;
1159
1160         my $cwd = getcwd();
1161         chdir productDir();
1162
1163         my $debuggerFlag = $debugger ? "/debugger" : "";
1164         $result = system "cmd", "/c", "call $script $debuggerFlag";
1165         chdir $cwd;
1166         return $result;
1167     }
1168
1169     return 1;
1170 }
1171
1172 sub setRun64Bit($)
1173 {
1174     ($forceRun64Bit) = @_;
1175 }
1176
1177 sub preferredArchitecture
1178 {
1179     return unless isAppleMacWebKit();
1180     
1181     my $framework = shift;
1182     $framework = "WebKit" if !defined($framework);
1183
1184     my $currentArchitecture = `arch`;
1185     chomp($currentArchitecture);
1186
1187     my $run64Bit = 0;
1188     if (!defined($forceRun64Bit)) {
1189         my $frameworkPath = builtDylibPathForName($framework);
1190         die "Couldn't find path for $framework" if !defined($frameworkPath);
1191         # The binary is 64-bit if one of the architectures it contains has "64" in the name
1192         $run64Bit = `lipo -info "$frameworkPath"` =~ /(are|architecture):.*64/;
1193     }
1194
1195     if ($forceRun64Bit or $run64Bit) {
1196         return ($currentArchitecture eq "i386") ? "x86_64" : "ppc64";
1197     }
1198     return $currentArchitecture;
1199 }
1200
1201 sub exportArchPreference
1202 {
1203     $ENV{ARCHPREFERENCE} = preferredArchitecture() if isAppleMacWebKit();
1204 }
1205
1206 1;