17381f19d42e63b7afc8ff758eed680cee43b882
[WebKit-https.git] / Tools / Scripts / webkitdirs.pm
1 # Copyright (C) 2005, 2006, 2007, 2010, 2011, 2012, 2013 Apple Inc. All rights reserved.
2 # Copyright (C) 2009 Google Inc. All rights reserved.
3 # Copyright (C) 2011 Research In Motion Limited. All rights reserved.
4 # Copyright (C) 2013 Nokia Corporation and/or its subsidiary(-ies).
5 #
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
8 # are met:
9 #
10 # 1.  Redistributions of source code must retain the above copyright
11 #     notice, this list of conditions and the following disclaimer. 
12 # 2.  Redistributions in binary form must reproduce the above copyright
13 #     notice, this list of conditions and the following disclaimer in the
14 #     documentation and/or other materials provided with the distribution. 
15 # 3.  Neither the name of Apple Inc. ("Apple") nor the names of
16 #     its contributors may be used to endorse or promote products derived
17 #     from this software without specific prior written permission. 
18 #
19 # THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 # DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 # Module to share code to get to WebKit directories.
31
32 use strict;
33 use version;
34 use warnings;
35 use Config;
36 use Digest::MD5 qw(md5_hex);
37 use FindBin;
38 use File::Basename;
39 use File::Path qw(mkpath rmtree);
40 use File::Spec;
41 use File::stat;
42 use POSIX;
43 use VCSUtils;
44
45 BEGIN {
46    use Exporter   ();
47    our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
48    $VERSION     = 1.00;
49    @ISA         = qw(Exporter);
50    @EXPORT      = qw(
51        &XcodeOptionString
52        &XcodeOptionStringNoConfig
53        &XcodeOptions
54        &baseProductDir
55        &chdirWebKit
56        &checkFrameworks
57        &cmakeBasedPortArguments
58        &cmakeBasedPortName
59        &currentSVNRevision
60        &debugSafari
61        &nmPath
62        &passedConfiguration
63        &printHelpAndExitForRunAndDebugWebKitAppIfNeeded
64        &productDir
65        &runMacWebKitApp
66        &safariPath
67        &setConfiguration
68        USE_OPEN_COMMAND
69    );
70    %EXPORT_TAGS = ( );
71    @EXPORT_OK   = ();
72 }
73
74 use constant USE_OPEN_COMMAND => 1; # Used in runMacWebKitApp().
75 use constant INCLUDE_OPTIONS_FOR_DEBUGGING => 1;
76
77 our @EXPORT_OK;
78
79 my $architecture;
80 my $numberOfCPUs;
81 my $maxCPULoad;
82 my $baseProductDir;
83 my @baseProductDirOption;
84 my $configuration;
85 my $xcodeSDK;
86 my $configurationForVisualStudio;
87 my $configurationProductDir;
88 my $sourceDir;
89 my $currentSVNRevision;
90 my $debugger;
91 my $iPhoneSimulatorVersion;
92 my $nmPath;
93 my $osXVersion;
94 my $generateDsym;
95 my $isGtk;
96 my $isWinCE;
97 my $isWinCairo;
98 my $isWin64;
99 my $isEfl;
100 my $isInspectorFrontend;
101 my $isWK2;
102 my $shouldTargetWebProcess;
103 my $shouldUseXPCServiceForWebProcess;
104 my $shouldUseGuardMalloc;
105 my $xcodeVersion;
106
107 # Variables for Win32 support
108 my $programFilesPath;
109 my $vcBuildPath;
110 my $vsInstallDir;
111 my $vsVersion;
112 my $windowsSourceDir;
113 my $winVersion;
114 my $willUseVCExpressWhenBuilding = 0;
115
116 # Defined in VCSUtils.
117 sub exitStatus($);
118
119 sub findMatchingArguments($$);
120 sub hasArgument($$);
121
122 sub determineSourceDir
123 {
124     return if $sourceDir;
125     $sourceDir = $FindBin::Bin;
126     $sourceDir =~ s|/+$||; # Remove trailing '/' as we would die later
127
128     # walks up path checking each directory to see if it is the main WebKit project dir, 
129     # defined by containing Sources, WebCore, and WebKit
130     until ((-d "$sourceDir/Source" && -d "$sourceDir/Source/WebCore" && -d "$sourceDir/Source/WebKit") || (-d "$sourceDir/Internal" && -d "$sourceDir/OpenSource"))
131     {
132         if ($sourceDir !~ s|/[^/]+$||) {
133             die "Could not find top level webkit directory above source directory using FindBin.\n";
134         }
135     }
136
137     $sourceDir = "$sourceDir/OpenSource" if -d "$sourceDir/OpenSource";
138 }
139
140 sub currentPerlPath()
141 {
142     my $thisPerl = $^X;
143     if ($^O ne 'VMS') {
144         $thisPerl .= $Config{_exe} unless $thisPerl =~ m/$Config{_exe}$/i;
145     }
146     return $thisPerl;
147 }
148
149 # used for scripts which are stored in a non-standard location
150 sub setSourceDir($)
151 {
152     ($sourceDir) = @_;
153 }
154
155 sub determineXcodeVersion
156 {
157     return if defined $xcodeVersion;
158     my $xcodebuildVersionOutput = `xcodebuild -version`;
159     $xcodeVersion = ($xcodebuildVersionOutput =~ /Xcode ([0-9](\.[0-9]+)*)/) ? $1 : "3.0";
160 }
161
162 sub readXcodeUserDefault($)
163 {
164     my ($unprefixedKey) = @_;
165
166     determineXcodeVersion();
167
168     my $xcodeDefaultsDomain = (eval "v$xcodeVersion" lt v4) ? "com.apple.Xcode" : "com.apple.dt.Xcode";
169     my $xcodeDefaultsPrefix = (eval "v$xcodeVersion" lt v4) ? "PBX" : "IDE";
170     my $devnull = File::Spec->devnull();
171
172     my $value = `defaults read $xcodeDefaultsDomain ${xcodeDefaultsPrefix}${unprefixedKey} 2> ${devnull}`;
173     return if $?;
174
175     chomp $value;
176     return $value;
177 }
178
179 sub determineBaseProductDir
180 {
181     return if defined $baseProductDir;
182     determineSourceDir();
183
184     my $setSharedPrecompsDir;
185     $baseProductDir = $ENV{"WEBKIT_OUTPUTDIR"};
186
187     if (!defined($baseProductDir) and isAppleMacWebKit()) {
188         # Silently remove ~/Library/Preferences/xcodebuild.plist which can
189         # cause build failure. The presence of
190         # ~/Library/Preferences/xcodebuild.plist can prevent xcodebuild from
191         # respecting global settings such as a custom build products directory
192         # (<rdar://problem/5585899>).
193         my $personalPlistFile = $ENV{HOME} . "/Library/Preferences/xcodebuild.plist";
194         if (-e $personalPlistFile) {
195             unlink($personalPlistFile) || die "Could not delete $personalPlistFile: $!";
196         }
197
198         determineXcodeVersion();
199
200         if (eval "v$xcodeVersion" ge v4) {
201             my $buildLocationStyle = join '', readXcodeUserDefault("BuildLocationStyle");
202             if ($buildLocationStyle eq "Custom") {
203                 my $buildLocationType = join '', readXcodeUserDefault("CustomBuildLocationType");
204                 # FIXME: Read CustomBuildIntermediatesPath and set OBJROOT accordingly.
205                 $baseProductDir = readXcodeUserDefault("CustomBuildProductsPath") if $buildLocationType eq "Absolute";
206             }
207
208             # DeterminedByTargets corresponds to a setting of "Legacy" in Xcode.
209             # It is the only build location style for which SHARED_PRECOMPS_DIR is not
210             # overridden when building from within Xcode.
211             $setSharedPrecompsDir = 1 if $buildLocationStyle ne "DeterminedByTargets";
212         }
213
214         if (!defined($baseProductDir)) {
215             $baseProductDir = join '', readXcodeUserDefault("ApplicationwideBuildSettings");
216             $baseProductDir = $1 if $baseProductDir =~ /SYMROOT\s*=\s*\"(.*?)\";/s;
217         }
218
219         undef $baseProductDir unless $baseProductDir =~ /^\//;
220     }
221
222     if (!defined($baseProductDir)) { # Port-specific checks failed, use default
223         $baseProductDir = "$sourceDir/WebKitBuild";
224     }
225
226     if (isGit() && isGitBranchBuild()) {
227         my $branch = gitBranch();
228         $baseProductDir = "$baseProductDir/$branch";
229     }
230
231     if (isAppleMacWebKit()) {
232         $baseProductDir =~ s|^\Q$(SRCROOT)/..\E$|$sourceDir|;
233         $baseProductDir =~ s|^\Q$(SRCROOT)/../|$sourceDir/|;
234         $baseProductDir =~ s|^~/|$ENV{HOME}/|;
235         die "Can't handle Xcode product directory with a ~ in it.\n" if $baseProductDir =~ /~/;
236         die "Can't handle Xcode product directory with a variable in it.\n" if $baseProductDir =~ /\$/;
237         @baseProductDirOption = ("SYMROOT=$baseProductDir", "OBJROOT=$baseProductDir");
238         push(@baseProductDirOption, "SHARED_PRECOMPS_DIR=${baseProductDir}/PrecompiledHeaders") if $setSharedPrecompsDir;
239     }
240
241     if (isCygwin()) {
242         my $dosBuildPath = `cygpath --windows \"$baseProductDir\"`;
243         chomp $dosBuildPath;
244         $ENV{"WEBKIT_OUTPUTDIR"} = $dosBuildPath;
245         my $unixBuildPath = `cygpath --unix \"$baseProductDir\"`;
246         chomp $unixBuildPath;
247         $baseProductDir = $unixBuildPath;
248     }
249 }
250
251 sub setBaseProductDir($)
252 {
253     ($baseProductDir) = @_;
254 }
255
256 sub determineConfiguration
257 {
258     return if defined $configuration;
259     determineBaseProductDir();
260     if (open CONFIGURATION, "$baseProductDir/Configuration") {
261         $configuration = <CONFIGURATION>;
262         close CONFIGURATION;
263     }
264     if ($configuration) {
265         chomp $configuration;
266         # compatibility for people who have old Configuration files
267         $configuration = "Release" if $configuration eq "Deployment";
268         $configuration = "Debug" if $configuration eq "Development";
269     } else {
270         $configuration = "Release";
271     }
272
273     if ($configuration && isWinCairo()) {
274         unless ($configuration =~ /_WinCairo$/) {
275             $configuration .= "_WinCairo";
276         }
277     }
278 }
279
280 sub determineArchitecture
281 {
282     return if defined $architecture;
283     # make sure $architecture is defined in all cases
284     $architecture = "";
285
286     determineBaseProductDir();
287     determineXcodeSDK();
288
289     if (isAppleMacWebKit()) {
290         if (open ARCHITECTURE, "$baseProductDir/Architecture") {
291             $architecture = <ARCHITECTURE>;
292             close ARCHITECTURE;
293         }
294         if ($architecture) {
295             chomp $architecture;
296         } else {
297             if (not defined $xcodeSDK or $xcodeSDK =~ /^(\/$|macosx)/) {
298                 my $supports64Bit = `sysctl -n hw.optional.x86_64`;
299                 chomp $supports64Bit;
300                 $architecture = 'x86_64' if $supports64Bit;
301             } elsif ($xcodeSDK =~ /^iphonesimulator/) {
302                 $architecture = 'x86_64';
303             } elsif ($xcodeSDK =~ /^iphoneos/) {
304                 $architecture = 'armv7';
305             }
306         }
307     } elsif (isEfl() || isGtk()) {
308         my $host_processor = "";
309         $host_processor = `cmake --system-information | grep CMAKE_SYSTEM_PROCESSOR`;
310         if ($host_processor =~ m/^CMAKE_SYSTEM_PROCESSOR \"([^"]+)\"/) {
311             # We have a configured build tree; use it.
312             $architecture = $1;
313             $architecture = 'x86_64' if $architecture eq 'amd64';
314         }
315     }
316
317     if (!$architecture && (isGtk() || isAppleMacWebKit() || isEfl())) {
318         # Fall back to output of `arch', if it is present.
319         $architecture = `arch`;
320         chomp $architecture;
321     }
322
323     if (!$architecture && (isGtk() || isAppleMacWebKit() || isEfl())) {
324         # Fall back to output of `uname -m', if it is present.
325         $architecture = `uname -m`;
326         chomp $architecture;
327     }
328
329     $architecture = 'x86_64' if ($architecture =~ /amd64/ && isBSD());
330 }
331
332 sub determineNumberOfCPUs
333 {
334     return if defined $numberOfCPUs;
335     if (defined($ENV{NUMBER_OF_PROCESSORS})) {
336         $numberOfCPUs = $ENV{NUMBER_OF_PROCESSORS};
337     } elsif (isLinux()) {
338         # First try the nproc utility, if it exists. If we get no
339         # results fall back to just interpretting /proc directly.
340         chomp($numberOfCPUs = `nproc --all 2> /dev/null`);
341         if ($numberOfCPUs eq "") {
342             $numberOfCPUs = (grep /processor/, `cat /proc/cpuinfo`);
343         }
344     } elsif (isWindows() || isCygwin()) {
345         # Assumes cygwin
346         $numberOfCPUs = `ls /proc/registry/HKEY_LOCAL_MACHINE/HARDWARE/DESCRIPTION/System/CentralProcessor | wc -w`;
347     } elsif (isDarwin() || isBSD()) {
348         chomp($numberOfCPUs = `sysctl -n hw.ncpu`);
349     }
350 }
351
352 sub determineMaxCPULoad
353 {
354     return if defined $maxCPULoad;
355     if (defined($ENV{MAX_CPU_LOAD})) {
356         $maxCPULoad = $ENV{MAX_CPU_LOAD};
357     }
358 }
359
360 sub jscPath($)
361 {
362     my ($productDir) = @_;
363     my $jscName = "jsc";
364     $jscName .= "_debug"  if configuration() eq "Debug_All";
365     $jscName .= ".exe" if (isWindows() || isCygwin());
366     return "$productDir/$jscName" if -e "$productDir/$jscName";
367     return "$productDir/JavaScriptCore.framework/Resources/$jscName";
368 }
369
370 sub argumentsForConfiguration()
371 {
372     determineConfiguration();
373     determineArchitecture();
374
375     my @args = ();
376     push(@args, '--debug') if ($configuration =~ "^Debug");
377     push(@args, '--release') if ($configuration =~ "^Release");
378     push(@args, '--32-bit') if ($architecture ne "x86_64" and !isWin64());
379     push(@args, '--64-bit') if (isWin64());
380     push(@args, '--gtk') if isGtk();
381     push(@args, '--efl') if isEfl();
382     push(@args, '--wincairo') if isWinCairo();
383     push(@args, '--wince') if isWinCE();
384     push(@args, '--inspector-frontend') if isInspectorFrontend();
385     return @args;
386 }
387
388 sub determineXcodeSDK
389 {
390     return if defined $xcodeSDK;
391     my $sdk;
392     if (checkForArgumentAndRemoveFromARGVGettingValue("--sdk", \$sdk)) {
393         $xcodeSDK = $sdk;
394     } elsif (checkForArgumentAndRemoveFromARGV("--device")) {
395         $xcodeSDK = 'iphoneos.internal';
396     } elsif (checkForArgumentAndRemoveFromARGV("--sim") ||
397         checkForArgumentAndRemoveFromARGV("--simulator")) {
398         $xcodeSDK = 'iphonesimulator';
399     }
400 }
401
402 sub xcodeSDK
403 {
404     determineXcodeSDK();
405     return $xcodeSDK;
406 }
407
408 sub xcodeSDKPlatformName()
409 {
410     determineXcodeSDK();
411     return "" if !defined $xcodeSDK;
412     return "iphoneos" if $xcodeSDK =~ /iphoneos/i;
413     return "iphonesimulator" if $xcodeSDK =~ /iphonesimulator/i;
414     return "macosx" if $xcodeSDK =~ /macosx/i;
415     die "Couldn't determine platform name from Xcode SDK";
416 }
417
418 sub XcodeSDKPath
419 {
420     determineXcodeSDK();
421
422     die "Can't find the SDK path because no Xcode SDK was specified" if not $xcodeSDK;
423
424     my $sdkPath = `xcrun --sdk $xcodeSDK --show-sdk-path` if $xcodeSDK;
425     die 'Failed to get SDK path from xcrun' if $?;
426     chomp $sdkPath;
427
428     return $sdkPath;
429 }
430
431
432 sub programFilesPath
433 {
434     return $programFilesPath if defined $programFilesPath;
435
436     $programFilesPath = $ENV{'PROGRAMFILES(X86)'} || $ENV{'PROGRAMFILES'} || "C:\\Program Files";
437
438     return $programFilesPath;
439 }
440
441 sub visualStudioInstallDir
442 {
443     return $vsInstallDir if defined $vsInstallDir;
444
445     if ($ENV{'VSINSTALLDIR'}) {
446         $vsInstallDir = $ENV{'VSINSTALLDIR'};
447         $vsInstallDir =~ s|[\\/]$||;
448     } else {
449         $vsInstallDir = File::Spec->catdir(programFilesPath(), "Microsoft Visual Studio 12.0");
450     }
451     chomp($vsInstallDir = `cygpath "$vsInstallDir"`) if isCygwin();
452
453     return $vsInstallDir;
454 }
455
456 sub visualStudioVersion
457 {
458     return $vsVersion if defined $vsVersion;
459
460     my $installDir = visualStudioInstallDir();
461
462     $vsVersion = ($installDir =~ /Microsoft Visual Studio ([0-9]+\.[0-9]*)/) ? $1 : "12";
463
464     return $vsVersion;
465 }
466
467 sub determineConfigurationForVisualStudio
468 {
469     return if defined $configurationForVisualStudio;
470     determineConfiguration();
471     # FIXME: We should detect when Debug_All or Production has been chosen.
472     $configurationForVisualStudio = $configuration . (isWin64() ? "|x64" : "|Win32");
473 }
474
475 sub usesPerConfigurationBuildDirectory
476 {
477     # [Gtk] We don't have Release/Debug configurations in straight
478     # autotool builds (non build-webkit). In this case and if
479     # WEBKIT_OUTPUTDIR exist, use that as our configuration dir. This will
480     # allows us to run run-webkit-tests without using build-webkit.
481     return ($ENV{"WEBKIT_OUTPUTDIR"} && isGtk()) || isAppleWinWebKit();
482 }
483
484 sub determineConfigurationProductDir
485 {
486     return if defined $configurationProductDir;
487     determineBaseProductDir();
488     determineConfiguration();
489     if (isAppleWinWebKit() || isWinCairo()) {
490         my $binDir = isWin64() ? "bin64" : "bin32";
491         $configurationProductDir = File::Spec->catdir($baseProductDir, $configuration, $binDir);
492     } else {
493         if (usesPerConfigurationBuildDirectory()) {
494             $configurationProductDir = "$baseProductDir";
495         } else {
496             $configurationProductDir = "$baseProductDir/$configuration";
497             $configurationProductDir .= "-" . xcodeSDKPlatformName() if isIOSWebKit();
498         }
499     }
500 }
501
502 sub setConfigurationProductDir($)
503 {
504     ($configurationProductDir) = @_;
505 }
506
507 sub determineCurrentSVNRevision
508 {
509     # We always update the current SVN revision here, and leave the caching
510     # to currentSVNRevision(), so that changes to the SVN revision while the
511     # script is running can be picked up by calling this function again.
512     determineSourceDir();
513     $currentSVNRevision = svnRevisionForDirectory($sourceDir);
514     return $currentSVNRevision;
515 }
516
517
518 sub chdirWebKit
519 {
520     determineSourceDir();
521     chdir $sourceDir or die;
522 }
523
524 sub baseProductDir
525 {
526     determineBaseProductDir();
527     return $baseProductDir;
528 }
529
530 sub sourceDir
531 {
532     determineSourceDir();
533     return $sourceDir;
534 }
535
536 sub productDir
537 {
538     determineConfigurationProductDir();
539     return $configurationProductDir;
540 }
541
542 sub jscProductDir
543 {
544     my $productDir = productDir();
545     $productDir .= "/bin" if (isEfl() || isGtk());
546
547     return $productDir;
548 }
549
550 sub configuration()
551 {
552     determineConfiguration();
553     return $configuration;
554 }
555
556 sub configurationForVisualStudio()
557 {
558     determineConfigurationForVisualStudio();
559     return $configurationForVisualStudio;
560 }
561
562 sub currentSVNRevision
563 {
564     determineCurrentSVNRevision() if not defined $currentSVNRevision;
565     return $currentSVNRevision;
566 }
567
568 sub generateDsym()
569 {
570     determineGenerateDsym();
571     return $generateDsym;
572 }
573
574 sub determineGenerateDsym()
575 {
576     return if defined($generateDsym);
577     $generateDsym = checkForArgumentAndRemoveFromARGV("--dsym");
578 }
579
580 sub argumentsForXcode()
581 {
582     my @args = ();
583     push @args, "DEBUG_INFORMATION_FORMAT=dwarf-with-dsym" if generateDsym();
584     return @args;
585 }
586
587 sub XcodeOptions
588 {
589     determineBaseProductDir();
590     determineConfiguration();
591     determineArchitecture();
592     determineXcodeSDK();
593
594     my @sdkOption = ($xcodeSDK ? "SDKROOT=$xcodeSDK" : ());
595     my @architectureOption = ($architecture ? "ARCHS=$architecture" : ());
596
597     return (@baseProductDirOption, "-configuration", $configuration, @architectureOption, @sdkOption, argumentsForXcode());
598 }
599
600 sub XcodeOptionString
601 {
602     return join " ", XcodeOptions();
603 }
604
605 sub XcodeOptionStringNoConfig
606 {
607     return join " ", @baseProductDirOption;
608 }
609
610 sub XcodeCoverageSupportOptions()
611 {
612     my @coverageSupportOptions = ();
613     push @coverageSupportOptions, "GCC_GENERATE_TEST_COVERAGE_FILES=YES";
614     push @coverageSupportOptions, "GCC_INSTRUMENT_PROGRAM_FLOW_ARCS=YES";
615     return @coverageSupportOptions;
616 }
617
618 my $passedConfiguration;
619 my $searchedForPassedConfiguration;
620 sub determinePassedConfiguration
621 {
622     return if $searchedForPassedConfiguration;
623     $searchedForPassedConfiguration = 1;
624     $passedConfiguration = undef;
625
626     if (checkForArgumentAndRemoveFromARGV("--debug")) {
627         $passedConfiguration = "Debug";
628     } elsif(checkForArgumentAndRemoveFromARGV("--release")) {
629         $passedConfiguration = "Release";
630     } elsif (checkForArgumentAndRemoveFromARGV("--profile") || checkForArgumentAndRemoveFromARGV("--profiling")) {
631         $passedConfiguration = "Profiling";
632     }
633
634     $passedConfiguration .= "_WinCairo" if (defined($passedConfiguration) && isWinCairo() && isCygwin());
635 }
636
637 sub passedConfiguration
638 {
639     determinePassedConfiguration();
640     return $passedConfiguration;
641 }
642
643 sub setConfiguration
644 {
645     setArchitecture();
646
647     if (my $config = shift @_) {
648         $configuration = $config;
649         return;
650     }
651
652     determinePassedConfiguration();
653     $configuration = $passedConfiguration if $passedConfiguration;
654 }
655
656
657 my $passedArchitecture;
658 my $searchedForPassedArchitecture;
659 sub determinePassedArchitecture
660 {
661     return if $searchedForPassedArchitecture;
662     $searchedForPassedArchitecture = 1;
663
664     $passedArchitecture = undef;
665     if (checkForArgumentAndRemoveFromARGV("--32-bit")) {
666         if (isAppleMacWebKit()) {
667             # PLATFORM_IOS: Don't run `arch` command inside Simulator environment
668             local %ENV = %ENV;
669             delete $ENV{DYLD_ROOT_PATH};
670             delete $ENV{DYLD_FRAMEWORK_PATH};
671
672             $passedArchitecture = `arch`;
673             chomp $passedArchitecture;
674         }
675     }
676 }
677
678 sub passedArchitecture
679 {
680     determinePassedArchitecture();
681     return $passedArchitecture;
682 }
683
684 sub architecture()
685 {
686     determineArchitecture();
687     return $architecture;
688 }
689
690 sub numberOfCPUs()
691 {
692     determineNumberOfCPUs();
693     return $numberOfCPUs;
694 }
695
696 sub maxCPULoad()
697 {
698     determineMaxCPULoad();
699     return $maxCPULoad;
700 }
701
702 sub setArchitecture
703 {
704     if (my $arch = shift @_) {
705         $architecture = $arch;
706         return;
707     }
708
709     determinePassedArchitecture();
710     $architecture = $passedArchitecture if $passedArchitecture;
711 }
712
713 sub skipSafariExecutableEntitlementChecks
714 {
715     return `defaults read /Library/Preferences/org.webkit.BuildConfiguration SkipSafariExecutableEntitlementChecks 2>/dev/null` eq "1\n";
716 }
717
718 sub executableHasEntitlements
719 {
720     my $executablePath = shift;
721     return (`codesign -d --entitlements - $executablePath 2>&1` =~ /<key>/);
722 }
723
724 sub safariPathFromSafariBundle
725 {
726     my ($safariBundle) = @_;
727
728     if (isAppleMacWebKit()) {
729         my $safariPath = "$safariBundle/Contents/MacOS/Safari";
730         return $safariPath if skipSafariExecutableEntitlementChecks();
731
732         my $safariForWebKitDevelopmentPath = "$safariBundle/Contents/MacOS/SafariForWebKitDevelopment";
733         return $safariForWebKitDevelopmentPath if -f $safariForWebKitDevelopmentPath && executableHasEntitlements($safariPath);
734
735         return $safariPath;
736     }
737     return $safariBundle if isAppleWinWebKit();
738 }
739
740 sub installedSafariPath
741 {
742     my $safariBundle;
743
744     if (isAppleMacWebKit()) {
745         $safariBundle = "/Applications/Safari.app";
746     } elsif (isAppleWinWebKit()) {
747         $safariBundle = readRegistryString("/HKLM/SOFTWARE/Apple Inc./Safari/InstallDir");
748         $safariBundle =~ s/[\r\n]+$//;
749         $safariBundle = `cygpath -u '$safariBundle'` if isCygwin();
750         $safariBundle =~ s/[\r\n]+$//;
751         $safariBundle .= "Safari.exe";
752     }
753
754     return safariPathFromSafariBundle($safariBundle);
755 }
756
757 # Locate Safari.
758 sub safariPath
759 {
760     # Use WEBKIT_SAFARI environment variable if present.
761     my $safariBundle = $ENV{WEBKIT_SAFARI};
762     if (!$safariBundle) {
763         determineConfigurationProductDir();
764         # Use Safari.app in product directory if present (good for Safari development team).
765         if (isAppleMacWebKit() && -d "$configurationProductDir/Safari.app") {
766             $safariBundle = "$configurationProductDir/Safari.app";
767         } elsif (isAppleWinWebKit()) {
768             my $path = "$configurationProductDir/Safari.exe";
769             my $debugPath = "$configurationProductDir/Safari_debug.exe";
770
771             if (configuration() eq "Debug_All" && -x $debugPath) {
772                 $safariBundle = $debugPath;
773             } elsif (-x $path) {
774                 $safariBundle = $path;
775             }
776         }
777         if (!$safariBundle) {
778             return installedSafariPath();
779         }
780     }
781     my $safariPath = safariPathFromSafariBundle($safariBundle);
782     die "Can't find executable at $safariPath.\n" if isAppleMacWebKit() && !-x $safariPath;
783     return $safariPath;
784 }
785
786 sub builtDylibPathForName
787 {
788     my $libraryName = shift;
789     determineConfigurationProductDir();
790
791     if (isGtk()) {
792         # WebKitGTK+ for GTK2, WebKitGTK+ for GTK3, and WebKit2 respectively.
793         my @libraries = ("libwebkitgtk-1.0", "libwebkitgtk-3.0", "libwebkit2gtk-3.0");
794         my $extension = isDarwin() ? ".dylib" : ".so";
795         my $builtLibraryPath = "$configurationProductDir/lib/";
796
797         foreach $libraryName (@libraries) {
798             my $libraryPath = "$builtLibraryPath" . $libraryName . $extension;
799             return $libraryPath if -e $libraryPath;
800         }
801         return "NotFound";
802     }
803     if (isEfl()) {
804         if (isWK2()) {
805             return "$configurationProductDir/lib/libewebkit2.so";
806         }
807         return "$configurationProductDir/lib/libewebkit.so";
808     }
809     if (isWinCE()) {
810         return "$configurationProductDir/$libraryName";
811     }
812     if (isIOSWebKit()) {
813         return "$configurationProductDir/$libraryName.framework/$libraryName";
814     }
815     if (isAppleMacWebKit()) {
816         return "$configurationProductDir/$libraryName.framework/Versions/A/$libraryName";
817     }
818     if (isAppleWinWebKit()) {
819         if ($libraryName eq "JavaScriptCore") {
820             return "$baseProductDir/lib/$libraryName.lib";
821         } else {
822             return "$baseProductDir/$libraryName.intermediate/$configuration/$libraryName.intermediate/$libraryName.lib";
823         }
824     }
825
826     die "Unsupported platform, can't determine built library locations.\nTry `build-webkit --help` for more information.\n";
827 }
828
829 # Check to see that all the frameworks are built.
830 sub checkFrameworks # FIXME: This is a poor name since only the Mac calls built WebCore a Framework.
831 {
832     return if isCygwin() || isWindows();
833     my @frameworks = ("JavaScriptCore", "WebCore");
834     push(@frameworks, "WebKit") if isAppleMacWebKit(); # FIXME: This seems wrong, all ports should have a WebKit these days.
835     for my $framework (@frameworks) {
836         my $path = builtDylibPathForName($framework);
837         die "Can't find built framework at \"$path\".\n" unless -e $path;
838     }
839 }
840
841 sub isInspectorFrontend()
842 {
843     determineIsInspectorFrontend();
844     return $isInspectorFrontend;
845 }
846
847 sub determineIsInspectorFrontend()
848 {
849     return if defined($isInspectorFrontend);
850     $isInspectorFrontend = checkForArgumentAndRemoveFromARGV("--inspector-frontend");
851 }
852
853 sub commandExists($)
854 {
855     my $command = shift;
856     my $devnull = File::Spec->devnull();
857     return `$command --version 2> $devnull`;
858 }
859
860 sub checkForArgumentAndRemoveFromARGV($)
861 {
862     my $argToCheck = shift;
863     return checkForArgumentAndRemoveFromArrayRef($argToCheck, \@ARGV);
864 }
865
866 sub checkForArgumentAndRemoveFromArrayRefGettingValue($$$)
867 {
868     my ($argToCheck, $valueRef, $arrayRef) = @_;
869     my $argumentStartRegEx = qr#^$argToCheck(?:=\S|$)#;
870     my $i = 0;
871     for (; $i < @$arrayRef; ++$i) {
872         last if $arrayRef->[$i] =~ $argumentStartRegEx;
873     }
874     if ($i >= @$arrayRef) {
875         return $$valueRef = undef;
876     }
877     my ($key, $value) = split("=", $arrayRef->[$i]);
878     splice(@$arrayRef, $i, 1);
879     if (defined($value)) {
880         # e.g. --sdk=iphonesimulator
881         return $$valueRef = $value;
882     }
883     return $$valueRef = splice(@$arrayRef, $i, 1); # e.g. --sdk iphonesimulator
884 }
885
886 sub checkForArgumentAndRemoveFromARGVGettingValue($$)
887 {
888     my ($argToCheck, $valueRef) = @_;
889     return checkForArgumentAndRemoveFromArrayRefGettingValue($argToCheck, $valueRef, \@ARGV);
890 }
891
892 sub findMatchingArguments($$)
893 {
894     my ($argToCheck, $arrayRef) = @_;
895     my @matchingIndices;
896     foreach my $index (0 .. $#$arrayRef) {
897         my $opt = $$arrayRef[$index];
898         if ($opt =~ /^$argToCheck$/i ) {
899             push(@matchingIndices, $index);
900         }
901     }
902     return @matchingIndices; 
903 }
904
905 sub hasArgument($$)
906 {
907     my ($argToCheck, $arrayRef) = @_;
908     my @matchingIndices = findMatchingArguments($argToCheck, $arrayRef);
909     return scalar @matchingIndices > 0;
910 }
911
912 sub checkForArgumentAndRemoveFromArrayRef
913 {
914     my ($argToCheck, $arrayRef) = @_;
915     my @indicesToRemove = findMatchingArguments($argToCheck, $arrayRef);
916     my $removeOffset = 0;
917     foreach my $index (@indicesToRemove) {
918         splice(@$arrayRef, $index - $removeOffset++, 1);
919     }
920     return scalar @indicesToRemove > 0;
921 }
922
923 sub isWK2()
924 {
925     if (defined($isWK2)) {
926         return $isWK2;
927     }
928     if (checkForArgumentAndRemoveFromARGV("-2")) {
929         $isWK2 = 1;
930     } else {
931         $isWK2 = 0;
932     }
933     return $isWK2;
934 }
935
936 sub determineIsEfl()
937 {
938     return if defined($isEfl);
939     $isEfl = checkForArgumentAndRemoveFromARGV("--efl");
940 }
941
942 sub isEfl()
943 {
944     determineIsEfl();
945     return $isEfl;
946 }
947
948 sub determineIsGtk()
949 {
950     return if defined($isGtk);
951     $isGtk = checkForArgumentAndRemoveFromARGV("--gtk");
952 }
953
954 sub isGtk()
955 {
956     determineIsGtk();
957     return $isGtk;
958 }
959
960 sub isWinCE()
961 {
962     determineIsWinCE();
963     return $isWinCE;
964 }
965
966 sub determineIsWinCE()
967 {
968     return if defined($isWinCE);
969     $isWinCE = checkForArgumentAndRemoveFromARGV("--wince");
970 }
971
972 # Determine if this is debian, ubuntu, linspire, or something similar.
973 sub isDebianBased()
974 {
975     return -e "/etc/debian_version";
976 }
977
978 sub isFedoraBased()
979 {
980     return -e "/etc/fedora-release";
981 }
982
983 sub isWinCairo()
984 {
985     determineIsWinCairo();
986     return $isWinCairo;
987 }
988
989 sub determineIsWinCairo()
990 {
991     return if defined($isWinCairo);
992     $isWinCairo = checkForArgumentAndRemoveFromARGV("--wincairo");
993 }
994
995 sub isWin64()
996 {
997     determineIsWin64();
998     return $isWin64;
999 }
1000
1001 sub determineIsWin64()
1002 {
1003     return if defined($isWin64);
1004     $isWin64 = checkForArgumentAndRemoveFromARGV("--64-bit");
1005 }
1006
1007 sub isCygwin()
1008 {
1009     return ($^O eq "cygwin") || 0;
1010 }
1011
1012 sub isAnyWindows()
1013 {
1014     return isWindows() || isCygwin();
1015 }
1016
1017 sub determineWinVersion()
1018 {
1019     return if $winVersion;
1020
1021     if (!isAnyWindows()) {
1022         $winVersion = -1;
1023         return;
1024     }
1025
1026     my $versionString = `cmd /c ver`;
1027     $versionString =~ /(\d)\.(\d)\.(\d+)/;
1028
1029     $winVersion = {
1030         major => $1,
1031         minor => $2,
1032         build => $3,
1033     };
1034 }
1035
1036 sub winVersion()
1037 {
1038     determineWinVersion();
1039     return $winVersion;
1040 }
1041
1042 sub isWindows7SP0()
1043 {
1044     return isAnyWindows() && winVersion()->{major} == 6 && winVersion()->{minor} == 1 && winVersion()->{build} == 7600;
1045 }
1046
1047 sub isWindowsVista()
1048 {
1049     return isAnyWindows() && winVersion()->{major} == 6 && winVersion()->{minor} == 0;
1050 }
1051
1052 sub isWindowsXP()
1053 {
1054     return isAnyWindows() && winVersion()->{major} == 5 && winVersion()->{minor} == 1;
1055 }
1056
1057 sub isDarwin()
1058 {
1059     return ($^O eq "darwin") || 0;
1060 }
1061
1062 sub isWindows()
1063 {
1064     return ($^O eq "MSWin32") || 0;
1065 }
1066
1067 sub isLinux()
1068 {
1069     return ($^O eq "linux") || 0;
1070 }
1071
1072 sub isBSD()
1073 {
1074     return ($^O eq "freebsd") || ($^O eq "openbsd") || ($^O eq "netbsd") || 0;
1075 }
1076
1077 sub isARM()
1078 {
1079     return ($Config{archname} =~ /^arm[v\-]/) || ($Config{archname} =~ /^aarch64[v\-]/);
1080 }
1081
1082 sub isCrossCompilation()
1083 {
1084   my $compiler = "";
1085   $compiler = $ENV{'CC'} if (defined($ENV{'CC'}));
1086   if ($compiler =~ /gcc/) {
1087       my $compiler_options = `$compiler -v 2>&1`;
1088       my @host = $compiler_options =~ m/--host=(.*?)\s/;
1089       my @target = $compiler_options =~ m/--target=(.*?)\s/;
1090
1091       return ($host[0] ne "" && $target[0] ne "" && $host[0] ne $target[0]);
1092   }
1093   return 0;
1094 }
1095
1096 sub isAppleWebKit()
1097 {
1098     return isAppleMacWebKit() || isAppleWinWebKit();
1099 }
1100
1101 sub isAppleMacWebKit()
1102 {
1103     return isDarwin() && !isGtk();
1104 }
1105
1106 sub isAppleWinWebKit()
1107 {
1108     return (isCygwin() || isWindows()) && !isWinCairo() && !isGtk() && !isWinCE();
1109 }
1110
1111 sub willUseIOSDeviceSDKWhenBuilding()
1112 {
1113     return xcodeSDKPlatformName() eq "iphoneos";
1114 }
1115
1116 sub willUseIOSSimulatorSDKWhenBuilding()
1117 {
1118     return xcodeSDKPlatformName() eq "iphonesimulator";
1119 }
1120
1121 sub isIOSWebKit()
1122 {
1123     determineXcodeSDK();
1124     return isAppleMacWebKit() && (willUseIOSDeviceSDKWhenBuilding() || willUseIOSSimulatorSDKWhenBuilding());
1125 }
1126
1127 sub isPerianInstalled()
1128 {
1129     if (!isAppleWebKit()) {
1130         return 0;
1131     }
1132
1133     if (-d "/Library/QuickTime/Perian.component") {
1134         return 1;
1135     }
1136
1137     if (-d "$ENV{HOME}/Library/QuickTime/Perian.component") {
1138         return 1;
1139     }
1140
1141     return 0;
1142 }
1143
1144 sub determineIPhoneSimulatorVersion()
1145 {
1146     return if $iPhoneSimulatorVersion;
1147
1148     if (!isIOSWebKit()) {
1149         $iPhoneSimulatorVersion = -1;
1150         return;
1151     }
1152
1153     my $version = `/usr/local/bin/psw_vers -productVersion`;
1154     my @splitVersion = split(/\./, $version);
1155     @splitVersion >= 2 or die "Invalid version $version";
1156     $iPhoneSimulatorVersion = {
1157             "major" => $splitVersion[0],
1158             "minor" => $splitVersion[1],
1159             "subminor" => defined($splitVersion[2] ? $splitVersion[2] : 0),
1160     };
1161 }
1162
1163 sub iPhoneSimulatorVersion()
1164 {
1165     determineIPhoneSimulatorVersion();
1166     return $iPhoneSimulatorVersion;
1167 }
1168
1169 sub determineNmPath()
1170 {
1171     return if $nmPath;
1172
1173     if (isAppleMacWebKit()) {
1174         $nmPath = `xcrun -find nm`;
1175         chomp $nmPath;
1176     }
1177     $nmPath = "nm" if !$nmPath;
1178 }
1179
1180 sub nmPath()
1181 {
1182     determineNmPath();
1183     return $nmPath;
1184 }
1185
1186 sub determineOSXVersion()
1187 {
1188     return if $osXVersion;
1189
1190     if (!isDarwin()) {
1191         $osXVersion = -1;
1192         return;
1193     }
1194
1195     my $version = `sw_vers -productVersion`;
1196     my @splitVersion = split(/\./, $version);
1197     @splitVersion >= 2 or die "Invalid version $version";
1198     $osXVersion = {
1199             "major" => $splitVersion[0],
1200             "minor" => $splitVersion[1],
1201             "subminor" => (defined($splitVersion[2]) ? $splitVersion[2] : 0),
1202     };
1203 }
1204
1205 sub osXVersion()
1206 {
1207     determineOSXVersion();
1208     return $osXVersion;
1209 }
1210
1211 sub isSnowLeopard()
1212 {
1213     return isDarwin() && osXVersion()->{"minor"} == 6;
1214 }
1215
1216 sub isLion()
1217 {
1218     return isDarwin() && osXVersion()->{"minor"} == 7;
1219 }
1220
1221 sub isWindowsNT()
1222 {
1223     return $ENV{'OS'} eq 'Windows_NT';
1224 }
1225
1226 sub shouldTargetWebProcess
1227 {
1228     determineShouldTargetWebProcess();
1229     return $shouldTargetWebProcess;
1230 }
1231
1232 sub determineShouldTargetWebProcess
1233 {
1234     return if defined($shouldTargetWebProcess);
1235     $shouldTargetWebProcess = checkForArgumentAndRemoveFromARGV("--target-web-process");
1236 }
1237
1238 sub shouldUseXPCServiceForWebProcess
1239 {
1240     determineShouldUseXPCServiceForWebProcess();
1241     return $shouldUseXPCServiceForWebProcess;
1242 }
1243
1244 sub determineShouldUseXPCServiceForWebProcess
1245 {
1246     return if defined($shouldUseXPCServiceForWebProcess);
1247     $shouldUseXPCServiceForWebProcess = checkForArgumentAndRemoveFromARGV("--use-web-process-xpc-service");
1248 }
1249
1250 sub debugger
1251 {
1252     determineDebugger();
1253     return $debugger;
1254 }
1255
1256 sub determineDebugger
1257 {
1258     return if defined($debugger);
1259
1260     determineXcodeVersion();
1261     if (eval "v$xcodeVersion" ge v4.5) {
1262         $debugger = "lldb";
1263     } else {
1264         $debugger = "gdb";
1265     }
1266
1267     if (checkForArgumentAndRemoveFromARGV("--use-lldb")) {
1268         $debugger = "lldb";
1269     }
1270
1271     if (checkForArgumentAndRemoveFromARGV("--use-gdb")) {
1272         $debugger = "gdb";
1273     }
1274 }
1275
1276 sub appendToEnvironmentVariableList
1277 {
1278     my ($environmentVariableName, $value) = @_;
1279
1280     if (defined($ENV{$environmentVariableName})) {
1281         $ENV{$environmentVariableName} .= ":" . $value;
1282     } else {
1283         $ENV{$environmentVariableName} = $value;
1284     }
1285 }
1286
1287 sub setUpGuardMallocIfNeeded
1288 {
1289     if (!isDarwin()) {
1290         return;
1291     }
1292
1293     if (!defined($shouldUseGuardMalloc)) {
1294         $shouldUseGuardMalloc = checkForArgumentAndRemoveFromARGV("--guard-malloc");
1295     }
1296
1297     if ($shouldUseGuardMalloc) {
1298         appendToEnvironmentVariableList("DYLD_INSERT_LIBRARIES", "/usr/lib/libgmalloc.dylib");
1299     }
1300 }
1301
1302 sub relativeScriptsDir()
1303 {
1304     my $scriptDir = File::Spec->catpath("", File::Spec->abs2rel($FindBin::Bin, getcwd()), "");
1305     if ($scriptDir eq "") {
1306         $scriptDir = ".";
1307     }
1308     return $scriptDir;
1309 }
1310
1311 sub launcherPath()
1312 {
1313     my $relativeScriptsPath = relativeScriptsDir();
1314     if (isGtk() || isEfl() || isWinCE()) {
1315         return "$relativeScriptsPath/run-launcher";
1316     } elsif (isAppleWebKit()) {
1317         return "$relativeScriptsPath/run-safari";
1318     }
1319 }
1320
1321 sub launcherName()
1322 {
1323     if (isGtk()) {
1324         return "MiniBrowser";
1325     } elsif (isAppleMacWebKit()) {
1326         return "Safari";
1327     } elsif (isAppleWinWebKit()) {
1328         return "WinLauncher";
1329     } elsif (isEfl()) {
1330         return "EWebLauncher/MiniBrowser";
1331     } elsif (isWinCE()) {
1332         return "WinCELauncher";
1333     }
1334 }
1335
1336 sub checkRequiredSystemConfig
1337 {
1338     if (isDarwin()) {
1339         chomp(my $productVersion = `sw_vers -productVersion`);
1340         if (eval "v$productVersion" lt v10.7.5) {
1341             print "*************************************************************\n";
1342             print "Mac OS X Version 10.7.5 or later is required to build WebKit.\n";
1343             print "You have " . $productVersion . ", thus the build will most likely fail.\n";
1344             print "*************************************************************\n";
1345         }
1346         my $xcodebuildVersionOutput = `xcodebuild -version`;
1347         my $xcodeVersion = ($xcodebuildVersionOutput =~ /Xcode ([0-9](\.[0-9]+)*)/) ? $1 : undef;
1348         if (!$xcodeVersion || $xcodeVersion && eval "v$xcodeVersion" lt v4.6) {
1349             print "*************************************************************\n";
1350             print "Xcode Version 4.6 or later is required to build WebKit.\n";
1351             print "You have an earlier version of Xcode, thus the build will\n";
1352             print "most likely fail. The latest Xcode is available from the App Store.\n";
1353             print "*************************************************************\n";
1354         }
1355     } elsif (isGtk() or isEfl() or isWindows()) {
1356         my @cmds = qw(bison gperf flex);
1357         my @missing = ();
1358         my $oldPath = $ENV{PATH};
1359         foreach my $cmd (@cmds) {
1360             push @missing, $cmd if not commandExists($cmd);
1361         }
1362
1363         if (@missing) {
1364             my $list = join ", ", @missing;
1365             die "ERROR: $list missing but required to build WebKit.\n";
1366         }
1367     }
1368     # Win32 and other platforms may want to check for minimum config
1369 }
1370
1371 sub determineWindowsSourceDir()
1372 {
1373     return if $windowsSourceDir;
1374     $windowsSourceDir = sourceDir();
1375     chomp($windowsSourceDir = `cygpath -w '$windowsSourceDir'`) if isCygwin();
1376 }
1377
1378 sub windowsSourceDir()
1379 {
1380     determineWindowsSourceDir();
1381     return $windowsSourceDir;
1382 }
1383
1384 sub windowsSourceSourceDir()
1385 {
1386     return windowsSourceDir() . "\\Source";
1387 }
1388
1389 sub windowsLibrariesDir()
1390 {
1391     return windowsSourceDir() . "\\WebKitLibraries\\win";
1392 }
1393
1394 sub windowsOutputDir()
1395 {
1396     return windowsSourceDir() . "\\WebKitBuild";
1397 }
1398
1399 sub fontExists($)
1400 {
1401     my $font = shift;
1402     my $val = system qw(regtool get), '\\HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Fonts\\' . $font . ' (TrueType)';
1403     return 0 == $val;
1404 }
1405
1406 sub checkInstalledTools()
1407 {
1408     # SVN 1.7.10 is known to be compatible with current servers. SVN 1.8.x seems to be missing some authentication
1409     # protocols we use for svn.webkit.org:
1410     my $svnVersion = `svn --version | grep "\\sversion"`;
1411     chomp($svnVersion);
1412     if (!$? and $svnVersion =~ /1\.8\./) {
1413         print "svn 1.7.10 is known to be compatible with our servers. You are running $svnVersion,\nwhich may not work properly.\n"
1414     }
1415
1416     # environment variables. Avoid until this is corrected.
1417     my $pythonVer = `python --version 2>&1`;
1418     die "You must have Python installed to build WebKit.\n" if ($?);
1419
1420     # cURL 7.34.0 has a bug that prevents authentication with opensource.apple.com (and other things using SSL3).
1421     my $curlVer = `curl --version | grep "curl"`;
1422     chomp($curlVer);
1423     if (!$? and $curlVer =~ /libcurl\/7\.34\.0/) {
1424         print "cURL version 7.34.0 has a bug that prevents authentication with SSL v2 or v3.\n";
1425         print "cURL 7.33.0 is known to work. The cURL projects is preparing an update to\n";
1426         print "correct this problem.\n\n";
1427         die "Please install a working cURL and try again.\n";
1428     }
1429
1430     # MathML requires fonts that do not ship with Windows (at least through Windows 8). Warn the user if they are missing
1431     my @fonts = qw(STIXGeneral-Regular MathJax_Main-Regular);
1432     my @missing = ();
1433     foreach my $font (@fonts) {
1434         push @missing, $font if not fontExists($font);
1435     }
1436
1437     if (scalar @missing > 0) {
1438         print "*************************************************************\n";
1439         print "Mathematical fonts, such as STIX and MathJax, are needed to\n";
1440         print "use the MathML feature.  You do not appear to have these fonts\n";
1441         print "on your system.\n\n";
1442         print "You can download a suitable set of fonts from the following URL:\n";
1443         print "https://developer.mozilla.org/Mozilla/MathML_Projects/Fonts\n";
1444         print "*************************************************************\n";
1445     }
1446
1447     print "Installed tools are correct for the WebKit build.\n";
1448 }
1449
1450 sub setupAppleWinEnv()
1451 {
1452     return unless isAppleWinWebKit();
1453
1454     checkInstalledTools();
1455
1456     if (isWindowsNT()) {
1457         my $restartNeeded = 0;
1458         my %variablesToSet = ();
1459
1460         # FIXME: We should remove this explicit version check for cygwin once we stop supporting Cygwin 1.7.9 or older versions. 
1461         # https://bugs.webkit.org/show_bug.cgi?id=85791
1462         my $uname_version = (POSIX::uname())[2];
1463         $uname_version =~ s/\(.*\)//;  # Remove the trailing cygwin version, if any.
1464         if (version->parse($uname_version) < version->parse("1.7.10")) {
1465             # Setting the environment variable 'CYGWIN' to 'tty' makes cygwin enable extra support (i.e., termios)
1466             # for UNIX-like ttys in the Windows console
1467             $variablesToSet{CYGWIN} = "tty" unless $ENV{CYGWIN};
1468         }
1469         
1470         # Those environment variables must be set to be able to build inside Visual Studio.
1471         $variablesToSet{WEBKIT_LIBRARIES} = windowsLibrariesDir() unless $ENV{WEBKIT_LIBRARIES};
1472         $variablesToSet{WEBKIT_OUTPUTDIR} = windowsOutputDir() unless $ENV{WEBKIT_OUTPUTDIR};
1473         $variablesToSet{MSBUILDDISABLENODEREUSE} = "1" unless $ENV{MSBUILDDISABLENODEREUSE};
1474
1475         foreach my $variable (keys %variablesToSet) {
1476             print "Setting the Environment Variable '" . $variable . "' to '" . $variablesToSet{$variable} . "'\n\n";
1477             system qw(regtool -s set), '\\HKEY_CURRENT_USER\\Environment\\' . $variable, $variablesToSet{$variable};
1478             $restartNeeded ||=  $variable eq "WEBKIT_LIBRARIES" || $variable eq "WEBKIT_OUTPUTDIR";
1479         }
1480
1481         if ($restartNeeded) {
1482             print "Please restart your computer before attempting to build inside Visual Studio.\n\n";
1483         }
1484     } else {
1485         if (!defined $ENV{'WEBKIT_LIBRARIES'} || !$ENV{'WEBKIT_LIBRARIES'}) {
1486             print "Warning: You must set the 'WebKit_Libraries' environment variable\n";
1487             print "         to be able build WebKit from within Visual Studio 2013 and newer.\n";
1488             print "         Make sure that 'WebKit_Libraries' points to the\n";
1489             print "         'WebKitLibraries/win' directory, not the 'WebKitLibraries/' directory.\n\n";
1490         }
1491         if (!defined $ENV{'WEBKIT_OUTPUTDIR'} || !$ENV{'WEBKIT_OUTPUTDIR'}) {
1492             print "Warning: You must set the 'WebKit_OutputDir' environment variable\n";
1493             print "         to be able build WebKit from within Visual Studio 2013 and newer.\n\n";
1494         }
1495         if (!defined $ENV{'MSBUILDDISABLENODEREUSE'} || !$ENV{'MSBUILDDISABLENODEREUSE'}) {
1496             print "Warning: You should set the 'MSBUILDDISABLENODEREUSE' environment variable to '1'\n";
1497             print "         to avoid periodic locked log files when building.\n\n";
1498         }
1499     }
1500     # FIXME (125180): Remove the following temporary 64-bit support once official support is available.
1501     if (isWin64() and !$ENV{'WEBKIT_64_SUPPORT'}) {
1502         print "Warning: You must set the 'WEBKIT_64_SUPPORT' environment variable\n";
1503         print "         to be able run WebKit or JavaScriptCore tests.\n\n";
1504     }
1505 }
1506
1507 sub setupCygwinEnv()
1508 {
1509     return if !isCygwin() && !isWindows();
1510     return if $vcBuildPath;
1511
1512     my $programFilesPath = programFilesPath();
1513     $vcBuildPath = File::Spec->catfile(visualStudioInstallDir(), qw(Common7 IDE devenv.com));
1514     if (-e $vcBuildPath) {
1515         # Visual Studio is installed;
1516         if (visualStudioVersion() eq "12") {
1517             $vcBuildPath = File::Spec->catfile(visualStudioInstallDir(), qw(Common7 IDE devenv.exe));
1518         }
1519     } else {
1520         # Visual Studio not found, try VC++ Express
1521         $vcBuildPath = File::Spec->catfile(visualStudioInstallDir(), qw(Common7 IDE WDExpress.exe));
1522         if (! -e $vcBuildPath) {
1523             print "*************************************************************\n";
1524             print "Cannot find '$vcBuildPath'\n";
1525             print "Please execute the file 'vcvars32.bat' from\n";
1526             print "'$programFilesPath\\Microsoft Visual Studio 12.0\\VC\\bin\\'\n";
1527             print "to setup the necessary environment variables.\n";
1528             print "*************************************************************\n";
1529             die;
1530         }
1531         $willUseVCExpressWhenBuilding = 1;
1532     }
1533
1534     print "Building results into: ", baseProductDir(), "\n";
1535     print "WEBKIT_OUTPUTDIR is set to: ", $ENV{"WEBKIT_OUTPUTDIR"}, "\n";
1536     print "WEBKIT_LIBRARIES is set to: ", $ENV{"WEBKIT_LIBRARIES"}, "\n";
1537     # FIXME (125180): Remove the following temporary 64-bit support once official support is available.
1538     print "WEBKIT_64_SUPPORT is set to: ", $ENV{"WEBKIT_64_SUPPORT"}, "\n" if isWin64();
1539 }
1540
1541 sub dieIfWindowsPlatformSDKNotInstalled
1542 {
1543     my $registry32Path = "/proc/registry/";
1544     my $registry64Path = "/proc/registry64/";
1545     my @windowsPlatformSDKRegistryEntries = (
1546         "HKEY_LOCAL_MACHINE/SOFTWARE/Microsoft/Microsoft SDKs/Windows/v8.0A",
1547         "HKEY_LOCAL_MACHINE/SOFTWARE/Microsoft/Microsoft SDKs/Windows/v8.0",
1548         "HKEY_LOCAL_MACHINE/SOFTWARE/Microsoft/Microsoft SDKs/Windows/v7.1A",
1549         "HKEY_LOCAL_MACHINE/SOFTWARE/Microsoft/Microsoft SDKs/Windows/v7.0A",
1550         "HKEY_LOCAL_MACHINE/SOFTWARE/Microsoft/MicrosoftSDK/InstalledSDKs/D2FF9F89-8AA2-4373-8A31-C838BF4DBBE1",
1551     );
1552
1553     # FIXME: It would be better to detect whether we are using 32- or 64-bit Windows
1554     # and only check the appropriate entry. But for now we just blindly check both.
1555     my $recommendedPlatformSDK = $windowsPlatformSDKRegistryEntries[0];
1556
1557     while (@windowsPlatformSDKRegistryEntries) {
1558         my $windowsPlatformSDKRegistryEntry = shift @windowsPlatformSDKRegistryEntries;
1559         return if (-e $registry32Path . $windowsPlatformSDKRegistryEntry) || (-e $registry64Path . $windowsPlatformSDKRegistryEntry);
1560     }
1561
1562     print "*************************************************************\n";
1563     print "Cannot find registry entry '$recommendedPlatformSDK'.\n";
1564     print "Please download and install the Microsoft Windows SDK\n";
1565     print "from <http://www.microsoft.com/en-us/download/details.aspx?id=8279>.\n\n";
1566     print "Then follow step 2 in the Windows section of the \"Installing Developer\n";
1567     print "Tools\" instructions at <http://www.webkit.org/building/tools.html>.\n";
1568     print "*************************************************************\n";
1569     die;
1570 }
1571
1572 sub copyInspectorFrontendFiles
1573 {
1574     my $productDir = productDir();
1575     my $sourceInspectorPath = sourceDir() . "/Source/WebCore/inspector/front-end/";
1576     my $inspectorResourcesDirPath = $ENV{"WEBKITINSPECTORRESOURCESDIR"};
1577
1578     if (!defined($inspectorResourcesDirPath)) {
1579         $inspectorResourcesDirPath = "";
1580     }
1581
1582     if (isAppleMacWebKit()) {
1583         if (isIOSWebKit()) {
1584             $inspectorResourcesDirPath = $productDir . "/WebCore.framework/inspector";
1585         } else {
1586             $inspectorResourcesDirPath = $productDir . "/WebCore.framework/Resources/inspector";
1587         }
1588     } elsif (isAppleWinWebKit() || isWinCairo()) {
1589         $inspectorResourcesDirPath = $productDir . "/WebKit.resources/inspector";
1590     } elsif (isGtk()) {
1591         my $prefix = $ENV{"WebKitInstallationPrefix"};
1592         $inspectorResourcesDirPath = (defined($prefix) ? $prefix : "/usr/share") . "/webkit-1.0/webinspector";
1593     } elsif (isEfl()) {
1594         my $prefix = $ENV{"WebKitInstallationPrefix"};
1595         $inspectorResourcesDirPath = (defined($prefix) ? $prefix : "/usr/share") . "/ewebkit/webinspector";
1596     }
1597
1598     if (! -d $inspectorResourcesDirPath) {
1599         print "*************************************************************\n";
1600         print "Cannot find '$inspectorResourcesDirPath'.\n" if (defined($inspectorResourcesDirPath));
1601         print "Make sure that you have built WebKit first.\n" if (! -d $productDir || defined($inspectorResourcesDirPath));
1602         print "Optionally, set the environment variable 'WebKitInspectorResourcesDir'\n";
1603         print "to point to the directory that contains the WebKit Inspector front-end\n";
1604         print "files for the built WebCore framework.\n";
1605         print "*************************************************************\n";
1606         die;
1607     }
1608
1609     if (isAppleMacWebKit()) {
1610         my $sourceLocalizedStrings = sourceDir() . "/Source/WebCore/English.lproj/localizedStrings.js";
1611         my $destinationLocalizedStrings;
1612         if (isIOSWebKit()) {
1613             $destinationLocalizedStrings = $productDir . "/WebCore.framework/English.lproj/localizedStrings.js";
1614         } else {
1615             $destinationLocalizedStrings = $productDir . "/WebCore.framework/Resources/English.lproj/localizedStrings.js";
1616         }
1617         system "ditto", $sourceLocalizedStrings, $destinationLocalizedStrings;
1618     }
1619
1620     my $exitStatus = system "rsync", "-aut", "--exclude=/.DS_Store", "--exclude=*.re2js", "--exclude=.svn/", $sourceInspectorPath, $inspectorResourcesDirPath;
1621     return $exitStatus if $exitStatus;
1622
1623     if (isIOSWebKit()) {
1624         chdir($productDir . "/WebCore.framework");
1625         return system "zip", "--quiet", "--exclude=*.qrc", "-r", "inspector-remote.zip", "inspector";
1626     }
1627
1628     return 0; # Success; did copy files.
1629 }
1630
1631 sub buildXCodeProject($$@)
1632 {
1633     my ($project, $clean, @extraOptions) = @_;
1634
1635     if ($clean) {
1636         push(@extraOptions, "-alltargets");
1637         push(@extraOptions, "clean");
1638     }
1639
1640     return system "xcodebuild", "-project", "$project.xcodeproj", @extraOptions;
1641 }
1642
1643 sub usingVisualStudioExpress()
1644 {
1645     setupCygwinEnv();
1646     return $willUseVCExpressWhenBuilding;
1647 }
1648
1649 sub buildVisualStudioProject
1650 {
1651     my ($project, $clean) = @_;
1652     setupCygwinEnv();
1653
1654     my $config = configurationForVisualStudio();
1655
1656     dieIfWindowsPlatformSDKNotInstalled() if $willUseVCExpressWhenBuilding;
1657
1658     chomp($project = `cygpath -w "$project"`) if isCygwin();
1659     
1660     my $action = "/build";
1661     if ($clean) {
1662         $action = "/clean";
1663     }
1664
1665     my @command = ($vcBuildPath, $project, $action, $config);
1666
1667     print join(" ", @command), "\n";
1668     return system @command;
1669 }
1670
1671 sub getJhbuildPath()
1672 {
1673     my @jhbuildPath = File::Spec->splitdir(baseProductDir());
1674     if (isGit() && isGitBranchBuild() && gitBranch()) {
1675         pop(@jhbuildPath);
1676     }
1677     push(@jhbuildPath, "Dependencies");
1678     return File::Spec->catdir(@jhbuildPath);
1679 }
1680
1681 sub isCachedArgumentfileOutOfDate($@)
1682 {
1683     my ($filename, $currentContents) = @_;
1684
1685     if (! -e $filename) {
1686         return 1;
1687     }
1688
1689     open(CONTENTS_FILE, $filename);
1690     chomp(my $previousContents = <CONTENTS_FILE>);
1691     close(CONTENTS_FILE);
1692
1693     if ($previousContents ne $currentContents) {
1694         print "Contents for file $filename have changed.\n";
1695         print "Previous contents were: $previousContents\n\n";
1696         print "New contents are: $currentContents\n";
1697         return 1;
1698     }
1699
1700     return 0;
1701 }
1702
1703 sub jhbuildWrapperPrefixIfNeeded()
1704 {
1705     if (-e getJhbuildPath()) {
1706         my @prefix = (File::Spec->catfile(sourceDir(), "Tools", "jhbuild", "jhbuild-wrapper"));
1707         if (isEfl()) {
1708             push(@prefix, "--efl");
1709         } elsif (isGtk()) {
1710             push(@prefix, "--gtk");
1711         }
1712         push(@prefix, "run");
1713
1714         return @prefix;
1715     }
1716
1717     return ();
1718 }
1719
1720 sub cmakeCachePath()
1721 {
1722     return File::Spec->catdir(baseProductDir(), configuration(), "CMakeCache.txt");
1723 }
1724
1725 sub shouldRemoveCMakeCache(@)
1726 {
1727     my ($cacheFilePath, @buildArgs) = @_;
1728     if (isWinCE()) {
1729         return 0;
1730     }
1731
1732     if (!isGtk()) {
1733         return 1;
1734     }
1735
1736     # We check this first, because we always want to create this file for a fresh build.
1737     my $productDir = File::Spec->catdir(baseProductDir(), configuration());
1738     my $optionsCache = File::Spec->catdir($productDir, "build-webkit-options.txt");
1739     my $joinedBuildArgs = join(" ", @buildArgs);
1740     if (isCachedArgumentfileOutOfDate($optionsCache, $joinedBuildArgs)) {
1741         File::Path::mkpath($productDir) unless -d $productDir;
1742         open(CACHED_ARGUMENTS, ">", $optionsCache);
1743         print CACHED_ARGUMENTS $joinedBuildArgs;
1744         close(CACHED_ARGUMENTS);
1745
1746         return 1;
1747     }
1748
1749     my $cmakeCache = cmakeCachePath();
1750     unless (-e $cmakeCache) {
1751         return 0;
1752     }
1753
1754     my $cacheFileModifiedTime = stat($cmakeCache)->mtime;
1755     my $platformConfiguration = File::Spec->catdir(sourceDir(), "Source", "cmake", "Options" . cmakeBasedPortName() . ".cmake");
1756     if ($cacheFileModifiedTime < stat($platformConfiguration)->mtime) {
1757         return 1;
1758     }
1759
1760     my $globalConfiguration = File::Spec->catdir(sourceDir(), "Source", "cmake", "OptionsCommon.cmake");
1761     if ($cacheFileModifiedTime < stat($globalConfiguration)->mtime) {
1762         return 1;
1763     }
1764
1765     return 0;
1766 }
1767
1768 sub removeCMakeCache(@)
1769 {
1770     my (@buildArgs) = @_;
1771     if (shouldRemoveCMakeCache(@buildArgs)) {
1772         my $cmakeCache = cmakeCachePath();
1773         unlink($cmakeCache) if -e $cmakeCache;
1774     }
1775 }
1776
1777 sub canUseNinja(@)
1778 {
1779     # Test both ninja and ninja-build. Fedora uses ninja-build and has patched CMake to also call ninja-build.
1780     system('which ninja > /dev/null || which ninja-build > /dev/null');
1781     return $? == 0;
1782 }
1783
1784 sub canUseEclipse(@)
1785 {
1786     system('which eclipse > /dev/null');
1787     return $? == 0;
1788 }
1789
1790 sub cmakeGeneratedBuildfile(@)
1791 {
1792     my ($willUseNinja) = @_;
1793     if ($willUseNinja) {
1794         return File::Spec->catfile(baseProductDir(), configuration(), "build.ninja")
1795     } else {
1796         return File::Spec->catfile(baseProductDir(), configuration(), "Makefile")
1797     }
1798 }
1799
1800 sub generateBuildSystemFromCMakeProject
1801 {
1802     my ($port, $prefixPath, @cmakeArgs, $additionalCMakeArgs) = @_;
1803     my $config = configuration();
1804     my $buildPath = File::Spec->catdir(baseProductDir(), $config);
1805     File::Path::mkpath($buildPath) unless -d $buildPath;
1806     my $originalWorkingDirectory = getcwd();
1807     chdir($buildPath) or die;
1808
1809     # For GTK+ we try to be smart about when to rerun cmake, so that we can have faster incremental builds.
1810     my $willUseNinja = isGtk() && canUseNinja();
1811     if (isGtk() && -e cmakeCachePath() && -e cmakeGeneratedBuildfile($willUseNinja)) {
1812         return 0;
1813     }
1814
1815     my @args;
1816     push @args, "-DPORT=\"$port\"";
1817     push @args, "-DCMAKE_INSTALL_PREFIX=\"$prefixPath\"" if $prefixPath;
1818     push @args, "-DCMAKE_EXPORT_COMPILE_COMMANDS=ON" if isGtk();
1819     push @args, "-DSHARED_CORE=ON" if isEfl() && $ENV{"ENABLE_DRT"};
1820     if ($config =~ /release/i) {
1821         push @args, "-DCMAKE_BUILD_TYPE=Release";
1822     } elsif ($config =~ /debug/i) {
1823         push @args, "-DCMAKE_BUILD_TYPE=Debug";
1824     }
1825
1826     if ($willUseNinja) {
1827         push @args, "-G";
1828         if (canUseEclipse()) {
1829             push @args, "'Eclipse CDT4 - Ninja'";
1830         } else {
1831             push @args, "Ninja";
1832         }
1833     }
1834
1835     # GTK+ has a production mode, but build-webkit should always use developer mode.
1836     push @args, "-DDEVELOPER_MODE=ON" if isGtk();
1837
1838     # Don't warn variables which aren't used by cmake ports.
1839     push @args, "--no-warn-unused-cli";
1840     push @args, @cmakeArgs if @cmakeArgs;
1841     push @args, $additionalCMakeArgs if $additionalCMakeArgs;
1842
1843     push @args, '"' . sourceDir() . '"';
1844
1845     # Compiler options to keep floating point values consistent
1846     # between 32-bit and 64-bit architectures.
1847     determineArchitecture();
1848     if ($architecture ne "x86_64" && !isARM() && !isCrossCompilation()) {
1849         $ENV{'CXXFLAGS'} = "-march=pentium4 -msse2 -mfpmath=sse " . ($ENV{'CXXFLAGS'} || "");
1850     }
1851
1852     # We call system("cmake @args") instead of system("cmake", @args) so that @args is
1853     # parsed for shell metacharacters.
1854     my $wrapper = join(" ", jhbuildWrapperPrefixIfNeeded()) . " ";
1855     my $returnCode = system($wrapper . "cmake @args");
1856
1857     chdir($originalWorkingDirectory);
1858     return $returnCode;
1859 }
1860
1861 sub buildCMakeGeneratedProject($)
1862 {
1863     my ($makeArgs) = @_;
1864     my $config = configuration();
1865     my $buildPath = File::Spec->catdir(baseProductDir(), $config);
1866     if (! -d $buildPath) {
1867         die "Must call generateBuildSystemFromCMakeProject() before building CMake project.";
1868     }
1869
1870     my $command = "cmake";
1871     my @args = ("--build", $buildPath, "--config", $config);
1872     push @args, ("--", $makeArgs) if $makeArgs;
1873
1874     # GTK uses a build script to preserve colors and pretty-printing.
1875     if (isGtk()) {
1876         chdir "$buildPath" or die;
1877         $command = "$buildPath/build.sh";
1878         @args = ($makeArgs);
1879     }
1880
1881     # We call system("cmake @args") instead of system("cmake", @args) so that @args is
1882     # parsed for shell metacharacters. In particular, $makeArgs may contain such metacharacters.
1883     my $wrapper = join(" ", jhbuildWrapperPrefixIfNeeded()) . " ";
1884     return system($wrapper . "$command @args");
1885
1886 }
1887
1888 sub cleanCMakeGeneratedProject()
1889 {
1890     my $config = configuration();
1891     my $buildPath = File::Spec->catdir(baseProductDir(), $config);
1892     if (-d $buildPath) {
1893         return system("cmake", "--build", $buildPath, "--config", $config, "--target", "clean");
1894     }
1895     return 0;
1896 }
1897
1898 sub buildCMakeProjectOrExit($$$$@)
1899 {
1900     my ($clean, $port, $prefixPath, $makeArgs, @cmakeArgs) = @_;
1901     my $returnCode;
1902
1903     exit(exitStatus(cleanCMakeGeneratedProject())) if $clean;
1904
1905     if (isEfl() && checkForArgumentAndRemoveFromARGV("--update-efl")) {
1906         system("perl", "$sourceDir/Tools/Scripts/update-webkitefl-libs") == 0 or die $!;
1907     }
1908
1909     if (isGtk() && checkForArgumentAndRemoveFromARGV("--update-gtk")) {
1910         system("perl", "$sourceDir/Tools/Scripts/update-webkitgtk-libs") == 0 or die $!;
1911     }
1912
1913     $returnCode = exitStatus(generateBuildSystemFromCMakeProject($port, $prefixPath, @cmakeArgs));
1914     exit($returnCode) if $returnCode;
1915
1916     $returnCode = exitStatus(buildCMakeGeneratedProject($makeArgs));
1917     exit($returnCode) if $returnCode;
1918     return 0;
1919 }
1920
1921 sub cmakeBasedPortArguments()
1922 {
1923     return ('-G "Visual Studio 8 2005 STANDARDSDK_500 (ARMV4I)"') if isWinCE();
1924     return ();
1925 }
1926
1927 sub cmakeBasedPortName()
1928 {
1929     return "Efl" if isEfl();
1930     return "WinCE" if isWinCE();
1931     return "GTK" if isGtk();
1932     return "";
1933 }
1934
1935 sub isCMakeBuild()
1936 {
1937     return isEfl() || isWinCE() || isGtk();
1938 }
1939
1940 sub promptUser
1941 {
1942     my ($prompt, $default) = @_;
1943     my $defaultValue = $default ? "[$default]" : "";
1944     print "$prompt $defaultValue: ";
1945     chomp(my $input = <STDIN>);
1946     return $input ? $input : $default;
1947 }
1948
1949 sub appleApplicationSupportPath
1950 {
1951     if (isWin64()) {
1952         # FIXME (125180): Remove the following once official 64-bit Windows support is available.
1953         return $ENV{"WEBKIT_64_SUPPORT"}, "\n" if isWin64();
1954     }
1955
1956     open INSTALL_DIR, "</proc/registry/HKEY_LOCAL_MACHINE/SOFTWARE/Apple\ Inc./Apple\ Application\ Support/InstallDir";
1957     my $path = <INSTALL_DIR>;
1958     $path =~ s/[\r\n\x00].*//;
1959     close INSTALL_DIR;
1960
1961     my $unixPath = `cygpath -u '$path'`;
1962     chomp $unixPath;
1963     return $unixPath;
1964 }
1965
1966 sub setPathForRunningWebKitApp
1967 {
1968     my ($env) = @_;
1969
1970     if (isAppleWinWebKit()) {
1971         $env->{PATH} = join(':', productDir(), dirname(installedSafariPath()), appleApplicationSupportPath(), $env->{PATH} || "");
1972     } elsif (isWinCairo()) {
1973         my $winCairoBin = sourceDir() . "/WebKitLibraries/win/" . (isWin64() ? "bin64/" : "bin32/");
1974         my $gstreamerBin = isWin64() ? $ENV{"GSTREAMER_1_0_ROOT_X86_64"} . "bin" : $ENV{"GSTREAMER_1_0_ROOT_X86"} . "bin";
1975         $env->{PATH} = join(':', productDir(), $winCairoBin, $gstreamerBin, $env->{PATH} || "");
1976     }
1977 }
1978
1979 sub printHelpAndExitForRunAndDebugWebKitAppIfNeeded
1980 {
1981     return unless checkForArgumentAndRemoveFromARGV("--help");
1982
1983     my ($includeOptionsForDebugging) = @_;
1984
1985     print STDERR <<EOF;
1986 Usage: @{[basename($0)]} [options] [args ...]
1987   --help                            Show this help message
1988   --no-saved-state                  Launch the application without state restoration (OS X 10.7 and later)
1989   --guard-malloc                    Enable Guard Malloc (OS X only)
1990   --use-web-process-xpc-service     Launch the Web Process as an XPC Service (OS X only)
1991 EOF
1992
1993     if ($includeOptionsForDebugging) {
1994         print STDERR <<EOF;
1995   --target-web-process              Debug the web process
1996   --use-gdb                         Use GDB (this is the default when using Xcode 4.4 or earlier)
1997   --use-lldb                        Use LLDB (this is the default when using Xcode 4.5 or later)
1998 EOF
1999     }
2000
2001     exit(1);
2002 }
2003
2004 sub argumentsForRunAndDebugMacWebKitApp()
2005 {
2006     my @args = ();
2007     if (checkForArgumentAndRemoveFromARGV("--no-saved-state")) {
2008         push @args, ("-ApplePersistenceIgnoreStateQuietly", "YES");
2009         # FIXME: Don't set ApplePersistenceIgnoreState once all supported OS versions respect ApplePersistenceIgnoreStateQuietly (rdar://15032886).
2010         push @args, ("-ApplePersistenceIgnoreState", "YES");
2011     }
2012     push @args, ("-WebKit2UseXPCServiceForWebProcess", "YES") if shouldUseXPCServiceForWebProcess();
2013     unshift @args, @ARGV;
2014
2015     return @args;
2016 }
2017
2018 sub runMacWebKitApp($;$)
2019 {
2020     my ($appPath, $useOpenCommand) = @_;
2021     my $productDir = productDir();
2022     print "Starting @{[basename($appPath)]} with DYLD_FRAMEWORK_PATH set to point to built WebKit in $productDir.\n";
2023     $ENV{DYLD_FRAMEWORK_PATH} = $productDir;
2024     $ENV{__XPC_DYLD_FRAMEWORK_PATH} = File::Spec->rel2abs($productDir);
2025     $ENV{WEBKIT_UNSET_DYLD_FRAMEWORK_PATH} = "YES";
2026
2027     setUpGuardMallocIfNeeded();
2028
2029     if (defined($useOpenCommand) && $useOpenCommand == USE_OPEN_COMMAND) {
2030         return system("open", "-W", "-a", $appPath, "--args", argumentsForRunAndDebugMacWebKitApp());
2031     }
2032     if (architecture()) {
2033         return system "arch", "-" . architecture(), $appPath, argumentsForRunAndDebugMacWebKitApp();
2034     }
2035     return system { $appPath } $appPath, argumentsForRunAndDebugMacWebKitApp();
2036 }
2037
2038 sub execMacWebKitAppForDebugging($)
2039 {
2040     my ($appPath) = @_;
2041     my $architectureSwitch;
2042     my $argumentsSeparator;
2043
2044     if (debugger() eq "lldb") {
2045         $architectureSwitch = "--arch";
2046         $argumentsSeparator = "--";
2047     } elsif (debugger() eq "gdb") {
2048         $architectureSwitch = "-arch";
2049         $argumentsSeparator = "--args";
2050     } else {
2051         die "Unknown debugger $debugger.\n";
2052     }
2053
2054     my $debuggerPath = `xcrun -find $debugger`;
2055     chomp $debuggerPath;
2056     die "Can't find the $debugger executable.\n" unless -x $debuggerPath;
2057
2058     my $productDir = productDir();
2059     $ENV{DYLD_FRAMEWORK_PATH} = $productDir;
2060     $ENV{__XPC_DYLD_FRAMEWORK_PATH} = File::Spec->rel2abs($productDir);
2061     $ENV{WEBKIT_UNSET_DYLD_FRAMEWORK_PATH} = "YES";
2062
2063     setUpGuardMallocIfNeeded();
2064
2065     my @architectureFlags = ($architectureSwitch, architecture());
2066     if (!shouldTargetWebProcess()) {
2067         print "Starting @{[basename($appPath)]} under $debugger with DYLD_FRAMEWORK_PATH set to point to built WebKit in $productDir.\n";
2068         exec { $debuggerPath } $debuggerPath, @architectureFlags, $argumentsSeparator, $appPath, argumentsForRunAndDebugMacWebKitApp() or die;
2069     } else {
2070         if (shouldUseXPCServiceForWebProcess()) {
2071             die "Targetting the Web Process is not compatible with using an XPC Service for the Web Process at this time.";
2072         }
2073         
2074         my $webProcessShimPath = File::Spec->catfile($productDir, "SecItemShim.dylib");
2075         my $webProcessPath = File::Spec->catdir($productDir, "WebProcess.app");
2076         my $webKit2ExecutablePath = File::Spec->catfile($productDir, "WebKit2.framework", "WebKit2");
2077
2078         appendToEnvironmentVariableList("DYLD_INSERT_LIBRARIES", $webProcessShimPath);
2079
2080         print "Starting WebProcess under $debugger with DYLD_FRAMEWORK_PATH set to point to built WebKit in $productDir.\n";
2081         exec { $debuggerPath } $debuggerPath, @architectureFlags, $argumentsSeparator, $webProcessPath, $webKit2ExecutablePath, "-type", "webprocess", "-client-executable", $appPath or die;
2082     }
2083 }
2084
2085 sub debugSafari
2086 {
2087     if (isAppleMacWebKit()) {
2088         checkFrameworks();
2089         execMacWebKitAppForDebugging(safariPath());
2090     }
2091
2092     return 1; # Unsupported platform; can't debug Safari on this platform.
2093 }
2094
2095 sub runSafari
2096 {
2097
2098     if (isAppleMacWebKit()) {
2099         return runMacWebKitApp(safariPath());
2100     }
2101
2102     if (isAppleWinWebKit()) {
2103         my $result;
2104         my $productDir = productDir();
2105         my $webKitLauncherPath = File::Spec->catfile(productDir(), "WinLauncher.exe");
2106         return system { $webKitLauncherPath } $webKitLauncherPath, @ARGV;
2107     }
2108
2109     return 1; # Unsupported platform; can't run Safari on this platform.
2110 }
2111
2112 sub runMiniBrowser
2113 {
2114     if (isAppleMacWebKit()) {
2115         return runMacWebKitApp(File::Spec->catfile(productDir(), "MiniBrowser.app", "Contents", "MacOS", "MiniBrowser"));
2116     }
2117
2118     return 1;
2119 }
2120
2121 sub debugMiniBrowser
2122 {
2123     if (isAppleMacWebKit()) {
2124         execMacWebKitAppForDebugging(File::Spec->catfile(productDir(), "MiniBrowser.app", "Contents", "MacOS", "MiniBrowser"));
2125     }
2126     
2127     return 1;
2128 }
2129
2130 sub runWebKitTestRunner
2131 {
2132     if (isAppleMacWebKit()) {
2133         return runMacWebKitApp(File::Spec->catfile(productDir(), "WebKitTestRunner"));
2134     }
2135
2136     return 1;
2137 }
2138
2139 sub debugWebKitTestRunner
2140 {
2141     if (isAppleMacWebKit()) {
2142         execMacWebKitAppForDebugging(File::Spec->catfile(productDir(), "WebKitTestRunner"));
2143     }
2144
2145     return 1;
2146 }
2147
2148 sub readRegistryString
2149 {
2150     my ($valueName) = @_;
2151     chomp(my $string = `regtool --wow32 get "$valueName"`);
2152     return $string;
2153 }
2154
2155 sub writeRegistryString
2156 {
2157     my ($valueName, $string) = @_;
2158
2159     my $error = system "regtool", "--wow32", "set", "-s", $valueName, $string;
2160
2161     # On Windows Vista/7 with UAC enabled, regtool will fail to modify the registry, but will still
2162     # return a successful exit code. So we double-check here that the value we tried to write to the
2163     # registry was really written.
2164     return !$error && readRegistryString($valueName) eq $string;
2165 }
2166
2167 1;