Rename isIOSLikeWebKit to isEmbeddedWebKit.
[WebKit-https.git] / Tools / Scripts / webkitdirs.pm
1 # Copyright (C) 2005-2007, 2010-2016 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 Cwd qw(realpath);
37 use Digest::MD5 qw(md5_hex);
38 use FindBin;
39 use File::Basename;
40 use File::Find;
41 use File::Path qw(make_path mkpath rmtree);
42 use File::Spec;
43 use File::Temp qw(tempdir);
44 use File::stat;
45 use List::Util;
46 use POSIX;
47 use Time::HiRes qw(usleep);
48 use VCSUtils;
49
50 BEGIN {
51    use Exporter   ();
52    our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
53    $VERSION     = 1.00;
54    @ISA         = qw(Exporter);
55    @EXPORT      = qw(
56        &XcodeCoverageSupportOptions
57        &XcodeOptionString
58        &XcodeOptionStringNoConfig
59        &XcodeOptions
60        &XcodeStaticAnalyzerOption
61        &appDisplayNameFromBundle
62        &appendToEnvironmentVariableList
63        &archCommandLineArgumentsForRestrictedEnvironmentVariables
64        &baseProductDir
65        &chdirWebKit
66        &checkFrameworks
67        &cmakeBasedPortArguments
68        &currentSVNRevision
69        &debugSafari
70        &executableProductDir
71        &findOrCreateSimulatorForIOSDevice
72        &iosSimulatorDeviceByName
73        &nmPath
74        &passedConfiguration
75        &prependToEnvironmentVariableList
76        &printHelpAndExitForRunAndDebugWebKitAppIfNeeded
77        &productDir
78        &quitIOSSimulator
79        &relaunchIOSSimulator
80        &restartIOSSimulatorDevice
81        &runIOSWebKitApp
82        &runMacWebKitApp
83        &safariPath
84        &iosVersion
85        &setConfiguration
86        &setupMacWebKitEnvironment
87        &sharedCommandLineOptions
88        &sharedCommandLineOptionsUsage
89        &shutDownIOSSimulatorDevice
90        &willUseIOSDeviceSDK
91        &willUseIOSSimulatorSDK
92        SIMULATOR_DEVICE_SUFFIX_FOR_WEBKIT_DEVELOPMENT
93        USE_OPEN_COMMAND
94    );
95    %EXPORT_TAGS = ( );
96    @EXPORT_OK   = ();
97 }
98
99 # Ports
100 use constant {
101     AppleWin => "AppleWin",
102     GTK      => "GTK",
103     Efl      => "Efl",
104     iOS      => "iOS",
105     tvOS     => "tvOS",
106     watchOS  => "watchOS",
107     Mac      => "Mac",
108     JSCOnly  => "JSCOnly",
109     WinCairo => "WinCairo",
110     Unknown  => "Unknown"
111 };
112
113 use constant USE_OPEN_COMMAND => 1; # Used in runMacWebKitApp().
114 use constant SIMULATOR_DEVICE_STATE_SHUTDOWN => "1";
115 use constant SIMULATOR_DEVICE_STATE_BOOTED => "3";
116 use constant SIMULATOR_DEVICE_SUFFIX_FOR_WEBKIT_DEVELOPMENT  => "For WebKit Development";
117
118 # See table "Certificate types and names" on <https://developer.apple.com/library/ios/documentation/IDEs/Conceptual/AppDistributionGuide/MaintainingCertificates/MaintainingCertificates.html#//apple_ref/doc/uid/TP40012582-CH31-SW41>.
119 use constant IOS_DEVELOPMENT_CERTIFICATE_NAME_PREFIX => "iPhone Developer: ";
120
121 our @EXPORT_OK;
122
123 my $architecture;
124 my $asanIsEnabled;
125 my $numberOfCPUs;
126 my $maxCPULoad;
127 my $baseProductDir;
128 my @baseProductDirOption;
129 my $configuration;
130 my $xcodeSDK;
131 my $configurationForVisualStudio;
132 my $configurationProductDir;
133 my $sourceDir;
134 my $currentSVNRevision;
135 my $didLoadIPhoneSimulatorNotification;
136 my $nmPath;
137 my $osXVersion;
138 my $iosVersion;
139 my $generateDsym;
140 my $isCMakeBuild;
141 my $isWin64;
142 my $isInspectorFrontend;
143 my $portName;
144 my $shouldUseGuardMalloc;
145 my $shouldNotUseNinja;
146 my $xcodeVersion;
147
148 my $unknownPortProhibited = 0;
149
150 # Variables for Win32 support
151 my $programFilesPath;
152 my $vcBuildPath;
153 my $vsInstallDir;
154 my $msBuildInstallDir;
155 my $vsVersion;
156 my $windowsSourceDir;
157 my $winVersion;
158 my $willUseVCExpressWhenBuilding = 0;
159
160 # Defined in VCSUtils.
161 sub exitStatus($);
162
163 sub findMatchingArguments($$);
164 sub hasArgument($$);
165
166 sub determineSourceDir
167 {
168     return if $sourceDir;
169     $sourceDir = $FindBin::Bin;
170     $sourceDir =~ s|/+$||; # Remove trailing '/' as we would die later
171
172     # walks up path checking each directory to see if it is the main WebKit project dir, 
173     # defined by containing Sources, WebCore, and JavaScriptCore.
174     until ((-d File::Spec->catdir($sourceDir, "Source") && -d File::Spec->catdir($sourceDir, "Source", "WebCore") && -d File::Spec->catdir($sourceDir, "Source", "JavaScriptCore")) || (-d File::Spec->catdir($sourceDir, "Internal") && -d File::Spec->catdir($sourceDir, "OpenSource")))
175     {
176         if ($sourceDir !~ s|/[^/]+$||) {
177             die "Could not find top level webkit directory above source directory using FindBin.\n";
178         }
179     }
180
181     $sourceDir = File::Spec->catdir($sourceDir, "OpenSource") if -d File::Spec->catdir($sourceDir, "OpenSource");
182 }
183
184 sub currentPerlPath()
185 {
186     my $thisPerl = $^X;
187     if ($^O ne 'VMS') {
188         $thisPerl .= $Config{_exe} unless $thisPerl =~ m/$Config{_exe}$/i;
189     }
190     return $thisPerl;
191 }
192
193 # used for scripts which are stored in a non-standard location
194 sub setSourceDir($)
195 {
196     ($sourceDir) = @_;
197 }
198
199 sub determineNinjaVersion
200 {
201     chomp(my $ninjaVersion = `ninja --version`);
202     return $ninjaVersion;
203 }
204
205 sub determineXcodeVersion
206 {
207     return if defined $xcodeVersion;
208     my $xcodebuildVersionOutput = `xcodebuild -version`;
209     $xcodeVersion = ($xcodebuildVersionOutput =~ /Xcode ([0-9](\.[0-9]+)*)/) ? $1 : "3.0";
210 }
211
212 sub readXcodeUserDefault($)
213 {
214     my ($key) = @_;
215
216     my $devnull = File::Spec->devnull();
217
218     my $value = `defaults read com.apple.dt.Xcode ${key} 2> ${devnull}`;
219     return if $?;
220
221     chomp $value;
222     return $value;
223 }
224
225 sub determineBaseProductDir
226 {
227     return if defined $baseProductDir;
228     determineSourceDir();
229
230     my $setSharedPrecompsDir;
231     $baseProductDir = $ENV{"WEBKIT_OUTPUTDIR"};
232
233     if (!defined($baseProductDir) and isAppleCocoaWebKit()) {
234         # Silently remove ~/Library/Preferences/xcodebuild.plist which can
235         # cause build failure. The presence of
236         # ~/Library/Preferences/xcodebuild.plist can prevent xcodebuild from
237         # respecting global settings such as a custom build products directory
238         # (<rdar://problem/5585899>).
239         my $personalPlistFile = $ENV{HOME} . "/Library/Preferences/xcodebuild.plist";
240         if (-e $personalPlistFile) {
241             unlink($personalPlistFile) || die "Could not delete $personalPlistFile: $!";
242         }
243
244         my $buildLocationStyle = join '', readXcodeUserDefault("IDEBuildLocationStyle");
245         if ($buildLocationStyle eq "Custom") {
246             my $buildLocationType = join '', readXcodeUserDefault("IDECustomBuildLocationType");
247             # FIXME: Read CustomBuildIntermediatesPath and set OBJROOT accordingly.
248             $baseProductDir = readXcodeUserDefault("IDECustomBuildProductsPath") if $buildLocationType eq "Absolute";
249         }
250
251         # DeterminedByTargets corresponds to a setting of "Legacy" in Xcode.
252         # It is the only build location style for which SHARED_PRECOMPS_DIR is not
253         # overridden when building from within Xcode.
254         $setSharedPrecompsDir = 1 if $buildLocationStyle ne "DeterminedByTargets";
255
256         if (!defined($baseProductDir)) {
257             $baseProductDir = join '', readXcodeUserDefault("IDEApplicationwideBuildSettings");
258             $baseProductDir = $1 if $baseProductDir =~ /SYMROOT\s*=\s*\"(.*?)\";/s;
259         }
260
261         undef $baseProductDir unless $baseProductDir =~ /^\//;
262     }
263
264     if (!defined($baseProductDir)) { # Port-specific checks failed, use default
265         $baseProductDir = File::Spec->catdir($sourceDir, "WebKitBuild");
266     }
267
268     if (isGit() && isGitBranchBuild()) {
269         my $branch = gitBranch();
270         $baseProductDir = "$baseProductDir/$branch";
271     }
272
273     if (isAppleCocoaWebKit()) {
274         $baseProductDir =~ s|^\Q$(SRCROOT)/..\E$|$sourceDir|;
275         $baseProductDir =~ s|^\Q$(SRCROOT)/../|$sourceDir/|;
276         $baseProductDir =~ s|^~/|$ENV{HOME}/|;
277         die "Can't handle Xcode product directory with a ~ in it.\n" if $baseProductDir =~ /~/;
278         die "Can't handle Xcode product directory with a variable in it.\n" if $baseProductDir =~ /\$/;
279         @baseProductDirOption = ("SYMROOT=$baseProductDir", "OBJROOT=$baseProductDir");
280         push(@baseProductDirOption, "SHARED_PRECOMPS_DIR=${baseProductDir}/PrecompiledHeaders") if $setSharedPrecompsDir;
281     }
282
283     if (isCygwin()) {
284         my $dosBuildPath = `cygpath --windows \"$baseProductDir\"`;
285         chomp $dosBuildPath;
286         $ENV{"WEBKIT_OUTPUTDIR"} = $dosBuildPath;
287         my $unixBuildPath = `cygpath --unix \"$baseProductDir\"`;
288         chomp $unixBuildPath;
289         $baseProductDir = $dosBuildPath;
290     }
291 }
292
293 sub systemVerbose {
294     print "+ @_\n";
295     return system(@_);
296 }
297
298 sub setBaseProductDir($)
299 {
300     ($baseProductDir) = @_;
301 }
302
303 sub determineConfiguration
304 {
305     return if defined $configuration;
306     determineBaseProductDir();
307     if (open CONFIGURATION, "$baseProductDir/Configuration") {
308         $configuration = <CONFIGURATION>;
309         close CONFIGURATION;
310     }
311     if ($configuration) {
312         chomp $configuration;
313         # compatibility for people who have old Configuration files
314         $configuration = "Release" if $configuration eq "Deployment";
315         $configuration = "Debug" if $configuration eq "Development";
316     } else {
317         $configuration = "Release";
318     }
319 }
320
321 sub determineArchitecture
322 {
323     return if defined $architecture;
324     # make sure $architecture is defined in all cases
325     $architecture = "";
326
327     determineBaseProductDir();
328     determineXcodeSDK();
329
330     if (isAppleCocoaWebKit()) {
331         if (open ARCHITECTURE, "$baseProductDir/Architecture") {
332             $architecture = <ARCHITECTURE>;
333             close ARCHITECTURE;
334         }
335         if ($architecture) {
336             chomp $architecture;
337         } else {
338             if (not defined $xcodeSDK or $xcodeSDK =~ /^(\/$|macosx)/) {
339                 my $supports64Bit = `sysctl -n hw.optional.x86_64`;
340                 chomp $supports64Bit;
341                 $architecture = 'x86_64' if $supports64Bit;
342             } elsif ($xcodeSDK =~ /^iphonesimulator/) {
343                 $architecture = 'x86_64';
344             } elsif ($xcodeSDK =~ /^iphoneos/) {
345                 $architecture = 'arm64';
346             }
347         }
348     } elsif (isCMakeBuild()) {
349         if (isCrossCompilation()) {
350             my $compiler = "gcc";
351             $compiler = $ENV{'CC'} if (defined($ENV{'CC'}));
352             my @compiler_machine = split('-', `$compiler -dumpmachine`);
353             $architecture = $compiler_machine[0];
354         } elsif (open my $cmake_sysinfo, "cmake --system-information |") {
355             while (<$cmake_sysinfo>) {
356                 next unless index($_, 'CMAKE_SYSTEM_PROCESSOR') == 0;
357                 if (/^CMAKE_SYSTEM_PROCESSOR \"([^"]+)\"/) {
358                     $architecture = $1;
359                     last;
360                 }
361             }
362             close $cmake_sysinfo;
363         }
364     }
365
366     if (!isAnyWindows()) {
367         if (!$architecture) {
368             # Fall back to output of `uname -m', if it is present.
369             $architecture = `uname -m`;
370             chomp $architecture;
371         }
372     }
373
374     $architecture = 'x86_64' if $architecture =~ /amd64/i;
375     $architecture = 'arm64' if $architecture =~ /aarch64/i;
376 }
377
378 sub determineASanIsEnabled
379 {
380     return if defined $asanIsEnabled;
381     determineBaseProductDir();
382
383     $asanIsEnabled = 0;
384     my $asanConfigurationValue;
385
386     if (open ASAN, "$baseProductDir/ASan") {
387         $asanConfigurationValue = <ASAN>;
388         close ASAN;
389         chomp $asanConfigurationValue;
390         $asanIsEnabled = 1 if $asanConfigurationValue eq "YES";
391     }
392 }
393
394 sub determineNumberOfCPUs
395 {
396     return if defined $numberOfCPUs;
397     if (defined($ENV{NUMBER_OF_PROCESSORS})) {
398         $numberOfCPUs = $ENV{NUMBER_OF_PROCESSORS};
399     } elsif (isLinux()) {
400         # First try the nproc utility, if it exists. If we get no
401         # results fall back to just interpretting /proc directly.
402         chomp($numberOfCPUs = `nproc --all 2> /dev/null`);
403         if ($numberOfCPUs eq "") {
404             $numberOfCPUs = (grep /processor/, `cat /proc/cpuinfo`);
405         }
406     } elsif (isAnyWindows()) {
407         # Assumes cygwin
408         $numberOfCPUs = `ls /proc/registry/HKEY_LOCAL_MACHINE/HARDWARE/DESCRIPTION/System/CentralProcessor | wc -w`;
409     } elsif (isDarwin() || isBSD()) {
410         chomp($numberOfCPUs = `sysctl -n hw.ncpu`);
411     }
412 }
413
414 sub determineMaxCPULoad
415 {
416     return if defined $maxCPULoad;
417     if (defined($ENV{MAX_CPU_LOAD})) {
418         $maxCPULoad = $ENV{MAX_CPU_LOAD};
419     }
420 }
421
422 sub jscPath($)
423 {
424     my ($productDir) = @_;
425     my $jscName = "jsc";
426     $jscName .= "_debug"  if configuration() eq "Debug_All";
427     $jscName .= ".exe" if (isAnyWindows());
428     return "$productDir/$jscName" if -e "$productDir/$jscName";
429     return "$productDir/JavaScriptCore.framework/Resources/$jscName";
430 }
431
432 sub argumentsForConfiguration()
433 {
434     determineConfiguration();
435     determineArchitecture();
436     determineXcodeSDK();
437
438     my @args = ();
439     # FIXME: Is it necessary to pass --debug, --release, --32-bit or --64-bit?
440     # These are determined automatically from stored configuration.
441     push(@args, '--debug') if ($configuration =~ "^Debug");
442     push(@args, '--release') if ($configuration =~ "^Release");
443     push(@args, '--ios-device') if (defined $xcodeSDK && $xcodeSDK =~ /^iphoneos/);
444     push(@args, '--ios-simulator') if (defined $xcodeSDK && $xcodeSDK =~ /^iphonesimulator/);
445     push(@args, '--32-bit') if ($architecture ne "x86_64" and !isWin64());
446     push(@args, '--64-bit') if (isWin64());
447     push(@args, '--gtk') if isGtk();
448     push(@args, '--efl') if isEfl();
449     push(@args, '--jsc-only') if isJSCOnly();
450     push(@args, '--wincairo') if isWinCairo();
451     push(@args, '--inspector-frontend') if isInspectorFrontend();
452     return @args;
453 }
454
455 sub determineXcodeSDK
456 {
457     return if defined $xcodeSDK;
458     my $sdk;
459     if (checkForArgumentAndRemoveFromARGVGettingValue("--sdk", \$sdk)) {
460         $xcodeSDK = $sdk;
461     }
462     if (checkForArgumentAndRemoveFromARGV("--device") || checkForArgumentAndRemoveFromARGV("--ios-device")) {
463         my $hasInternalSDK = exitStatus(system("xcrun --sdk iphoneos.internal --show-sdk-version > /dev/null 2>&1")) == 0;
464         $xcodeSDK ||= $hasInternalSDK ? "iphoneos.internal" : "iphoneos";
465     }
466     if (checkForArgumentAndRemoveFromARGV("--simulator") || checkForArgumentAndRemoveFromARGV("--ios-simulator")) {
467         $xcodeSDK ||= 'iphonesimulator';
468     }
469     if (checkForArgumentAndRemoveFromARGV("--tvos-device")) {
470         my $hasInternalSDK = exitStatus(system("xcrun --sdk appletvos.internal --show-sdk-version > /dev/null 2>&1")) == 0;
471         $xcodeSDK ||=  $hasInternalSDK ? "appletvos.internal" : "appletvos";
472     }
473     if (checkForArgumentAndRemoveFromARGV("--tvos-simulator")) {
474         $xcodeSDK ||= "appletvsimulator";
475     }
476     if (checkForArgumentAndRemoveFromARGV("--watchos-device")) {
477         my $hasInternalSDK = exitStatus(system("xcrun --sdk watchos.internal --show-sdk-version > /dev/null 2>&1")) == 0;
478         $xcodeSDK ||=  $hasInternalSDK ? "watchos.internal" : "watchos";
479     }
480     if (checkForArgumentAndRemoveFromARGV("--watchos-simulator")) {
481         $xcodeSDK ||= "watchsimulator";
482     }
483 }
484
485 sub xcodeSDK
486 {
487     determineXcodeSDK();
488     return $xcodeSDK;
489 }
490
491 sub setXcodeSDK($)
492 {
493     ($xcodeSDK) = @_;
494 }
495
496
497 sub xcodeSDKPlatformName()
498 {
499     determineXcodeSDK();
500     return "" if !defined $xcodeSDK;
501     return "appletvos" if $xcodeSDK =~ /appletvos/i;
502     return "appletvsimulator" if $xcodeSDK =~ /appletvsimulator/i;
503     return "iphoneos" if $xcodeSDK =~ /iphoneos/i;
504     return "iphonesimulator" if $xcodeSDK =~ /iphonesimulator/i;
505     return "macosx" if $xcodeSDK =~ /macosx/i;
506     return "watchos" if $xcodeSDK =~ /watchos/i;
507     return "watchsimulator" if $xcodeSDK =~ /watchsimulator/i;
508     die "Couldn't determine platform name from Xcode SDK";
509 }
510
511 sub XcodeSDKPath
512 {
513     determineXcodeSDK();
514
515     die "Can't find the SDK path because no Xcode SDK was specified" if not $xcodeSDK;
516
517     my $sdkPath = `xcrun --sdk $xcodeSDK --show-sdk-path` if $xcodeSDK;
518     die 'Failed to get SDK path from xcrun' if $?;
519     chomp $sdkPath;
520
521     return $sdkPath;
522 }
523
524 sub xcodeSDKVersion
525 {
526     determineXcodeSDK();
527
528     die "Can't find the SDK version because no Xcode SDK was specified" if !$xcodeSDK;
529
530     chomp(my $sdkVersion = `xcrun --sdk $xcodeSDK --show-sdk-version`);
531     die "Failed to get SDK version from xcrun" if exitStatus($?);
532
533     return $sdkVersion;
534 }
535
536 sub programFilesPath
537 {
538     return $programFilesPath if defined $programFilesPath;
539
540     $programFilesPath = $ENV{'PROGRAMFILES(X86)'} || $ENV{'PROGRAMFILES'} || "C:\\Program Files";
541
542     return $programFilesPath;
543 }
544
545 sub visualStudioInstallDir
546 {
547     return $vsInstallDir if defined $vsInstallDir;
548
549     if ($ENV{'VSINSTALLDIR'}) {
550         $vsInstallDir = $ENV{'VSINSTALLDIR'};
551         $vsInstallDir =~ s|[\\/]$||;
552     } else {
553         $vsInstallDir = File::Spec->catdir(programFilesPath(), "Microsoft Visual Studio 14.0");
554     }
555     chomp($vsInstallDir = `cygpath "$vsInstallDir"`) if isCygwin();
556
557     print "Using Visual Studio: $vsInstallDir\n";
558     return $vsInstallDir;
559 }
560
561 sub msBuildInstallDir
562 {
563     return $msBuildInstallDir if defined $msBuildInstallDir;
564
565     $msBuildInstallDir = File::Spec->catdir(programFilesPath(), "MSBuild", "14.0", "Bin");
566    
567     chomp($msBuildInstallDir = `cygpath "$msBuildInstallDir"`) if isCygwin();
568
569     print "Using MSBuild: $msBuildInstallDir\n";
570     return $msBuildInstallDir;
571 }
572
573 sub visualStudioVersion
574 {
575     return $vsVersion if defined $vsVersion;
576
577     my $installDir = visualStudioInstallDir();
578
579     $vsVersion = ($installDir =~ /Microsoft Visual Studio ([0-9]+\.[0-9]*)/) ? $1 : "14";
580
581     print "Using Visual Studio $vsVersion\n";
582     return $vsVersion;
583 }
584
585 sub determineConfigurationForVisualStudio
586 {
587     return if defined $configurationForVisualStudio;
588     determineConfiguration();
589     # FIXME: We should detect when Debug_All or Production has been chosen.
590     $configurationForVisualStudio = "/p:Configuration=" . $configuration;
591 }
592
593 sub usesPerConfigurationBuildDirectory
594 {
595     # [Gtk] We don't have Release/Debug configurations in straight
596     # autotool builds (non build-webkit). In this case and if
597     # WEBKIT_OUTPUTDIR exist, use that as our configuration dir. This will
598     # allows us to run run-webkit-tests without using build-webkit.
599     return ($ENV{"WEBKIT_OUTPUTDIR"} && isGtk()) || isAppleWinWebKit();
600 }
601
602 sub determineConfigurationProductDir
603 {
604     return if defined $configurationProductDir;
605     determineBaseProductDir();
606     determineConfiguration();
607     if (isAppleWinWebKit() || isWinCairo()) {
608         $configurationProductDir = File::Spec->catdir($baseProductDir, $configuration);
609     } else {
610         if (usesPerConfigurationBuildDirectory()) {
611             $configurationProductDir = "$baseProductDir";
612         } else {
613             $configurationProductDir = "$baseProductDir/$configuration";
614             $configurationProductDir .= "-" . xcodeSDKPlatformName() if isIOSWebKit();
615         }
616     }
617 }
618
619 sub setConfigurationProductDir($)
620 {
621     ($configurationProductDir) = @_;
622 }
623
624 sub determineCurrentSVNRevision
625 {
626     # We always update the current SVN revision here, and leave the caching
627     # to currentSVNRevision(), so that changes to the SVN revision while the
628     # script is running can be picked up by calling this function again.
629     determineSourceDir();
630     $currentSVNRevision = svnRevisionForDirectory($sourceDir);
631     return $currentSVNRevision;
632 }
633
634
635 sub chdirWebKit
636 {
637     determineSourceDir();
638     chdir $sourceDir or die;
639 }
640
641 sub baseProductDir
642 {
643     determineBaseProductDir();
644     return $baseProductDir;
645 }
646
647 sub sourceDir
648 {
649     determineSourceDir();
650     return $sourceDir;
651 }
652
653 sub productDir
654 {
655     determineConfigurationProductDir();
656     return $configurationProductDir;
657 }
658
659 sub executableProductDir
660 {
661     my $productDirectory = productDir();
662
663     my $binaryDirectory;
664     if (isEfl() || isGtk() || isJSCOnly()) {
665         $binaryDirectory = "bin";
666     } elsif (isAnyWindows()) {
667         $binaryDirectory = isWin64() ? "bin64" : "bin32";
668     } else {
669         return $productDirectory;
670     }
671
672     return File::Spec->catdir($productDirectory, $binaryDirectory);
673 }
674
675 sub jscProductDir
676 {
677     return executableProductDir();
678 }
679
680 sub configuration()
681 {
682     determineConfiguration();
683     return $configuration;
684 }
685
686 sub asanIsEnabled()
687 {
688     determineASanIsEnabled();
689     return $asanIsEnabled;
690 }
691
692 sub configurationForVisualStudio()
693 {
694     determineConfigurationForVisualStudio();
695     return $configurationForVisualStudio;
696 }
697
698 sub currentSVNRevision
699 {
700     determineCurrentSVNRevision() if not defined $currentSVNRevision;
701     return $currentSVNRevision;
702 }
703
704 sub generateDsym()
705 {
706     determineGenerateDsym();
707     return $generateDsym;
708 }
709
710 sub determineGenerateDsym()
711 {
712     return if defined($generateDsym);
713     $generateDsym = checkForArgumentAndRemoveFromARGV("--dsym");
714 }
715
716 sub hasIOSDevelopmentCertificate()
717 {
718     return !exitStatus(system("security find-identity -p codesigning | grep '" . IOS_DEVELOPMENT_CERTIFICATE_NAME_PREFIX . "' > /dev/null 2>&1"));
719 }
720
721 sub argumentsForXcode()
722 {
723     my @args = ();
724     push @args, "DEBUG_INFORMATION_FORMAT=dwarf-with-dsym" if generateDsym();
725     return @args;
726 }
727
728 sub XcodeOptions
729 {
730     determineBaseProductDir();
731     determineConfiguration();
732     determineArchitecture();
733     determineASanIsEnabled();
734     determineXcodeSDK();
735
736     my @options;
737     push @options, "-UseSanitizedBuildSystemEnvironment=YES";
738     push @options, ("-configuration", $configuration);
739     push @options, ("-xcconfig", sourceDir() . "/Tools/asan/asan.xcconfig", "ASAN_IGNORE=" . sourceDir() . "/Tools/asan/webkit-asan-ignore.txt") if $asanIsEnabled;
740     push @options, @baseProductDirOption;
741     push @options, "ARCHS=$architecture" if $architecture;
742     push @options, "SDKROOT=$xcodeSDK" if $xcodeSDK;
743     if (willUseIOSDeviceSDK()) {
744         push @options, "ENABLE_BITCODE=NO";
745         if (hasIOSDevelopmentCertificate()) {
746             # FIXME: May match more than one installed development certificate.
747             push @options, "CODE_SIGN_IDENTITY=" . IOS_DEVELOPMENT_CERTIFICATE_NAME_PREFIX;
748         } else {
749             push @options, "CODE_SIGN_IDENTITY="; # No identity
750             push @options, "CODE_SIGNING_REQUIRED=NO";
751         }
752     }
753     push @options, argumentsForXcode();
754     return @options;
755 }
756
757 sub XcodeOptionString
758 {
759     return join " ", XcodeOptions();
760 }
761
762 sub XcodeOptionStringNoConfig
763 {
764     return join " ", @baseProductDirOption;
765 }
766
767 sub XcodeCoverageSupportOptions()
768 {
769     my @coverageSupportOptions = ();
770     push @coverageSupportOptions, "GCC_GENERATE_TEST_COVERAGE_FILES=YES";
771     push @coverageSupportOptions, "GCC_INSTRUMENT_PROGRAM_FLOW_ARCS=YES";
772     return @coverageSupportOptions;
773 }
774
775 sub XcodeStaticAnalyzerOption()
776 {
777     return "RUN_CLANG_STATIC_ANALYZER=YES";
778 }
779
780 my $passedConfiguration;
781 my $searchedForPassedConfiguration;
782 sub determinePassedConfiguration
783 {
784     return if $searchedForPassedConfiguration;
785     $searchedForPassedConfiguration = 1;
786     $passedConfiguration = undef;
787
788     if (checkForArgumentAndRemoveFromARGV("--debug")) {
789         $passedConfiguration = "Debug";
790     } elsif(checkForArgumentAndRemoveFromARGV("--release")) {
791         $passedConfiguration = "Release";
792     } elsif (checkForArgumentAndRemoveFromARGV("--profile") || checkForArgumentAndRemoveFromARGV("--profiling")) {
793         $passedConfiguration = "Profiling";
794     }
795 }
796
797 sub passedConfiguration
798 {
799     determinePassedConfiguration();
800     return $passedConfiguration;
801 }
802
803 sub setConfiguration
804 {
805     setArchitecture();
806
807     if (my $config = shift @_) {
808         $configuration = $config;
809         return;
810     }
811
812     determinePassedConfiguration();
813     $configuration = $passedConfiguration if $passedConfiguration;
814 }
815
816
817 my $passedArchitecture;
818 my $searchedForPassedArchitecture;
819 sub determinePassedArchitecture
820 {
821     return if $searchedForPassedArchitecture;
822     $searchedForPassedArchitecture = 1;
823
824     $passedArchitecture = undef;
825     if (checkForArgumentAndRemoveFromARGV("--32-bit")) {
826         if (isAppleCocoaWebKit()) {
827             # PLATFORM_IOS: Don't run `arch` command inside Simulator environment
828             local %ENV = %ENV;
829             delete $ENV{DYLD_ROOT_PATH};
830             delete $ENV{DYLD_FRAMEWORK_PATH};
831
832             $passedArchitecture = `arch`;
833             chomp $passedArchitecture;
834         }
835     }
836 }
837
838 sub passedArchitecture
839 {
840     determinePassedArchitecture();
841     return $passedArchitecture;
842 }
843
844 sub architecture()
845 {
846     determineArchitecture();
847     return $architecture;
848 }
849
850 sub numberOfCPUs()
851 {
852     determineNumberOfCPUs();
853     return $numberOfCPUs;
854 }
855
856 sub maxCPULoad()
857 {
858     determineMaxCPULoad();
859     return $maxCPULoad;
860 }
861
862 sub setArchitecture
863 {
864     if (my $arch = shift @_) {
865         $architecture = $arch;
866         return;
867     }
868
869     determinePassedArchitecture();
870     $architecture = $passedArchitecture if $passedArchitecture;
871 }
872
873 # Locate Safari.
874 sub safariPath
875 {
876     die "Safari path is only relevant on Apple Mac platform\n" unless isAppleCocoaWebKit();
877
878     my $safariPath;
879
880     # Use WEBKIT_SAFARI environment variable if present.
881     my $safariBundle = $ENV{WEBKIT_SAFARI};
882     if (!$safariBundle) {
883         determineConfigurationProductDir();
884         # Use Safari.app in product directory if present (good for Safari development team).
885         if (-d "$configurationProductDir/Safari.app") {
886             $safariBundle = "$configurationProductDir/Safari.app";
887         }
888     }
889
890     if ($safariBundle) {
891         $safariPath = "$safariBundle/Contents/MacOS/Safari";
892     } else {
893         $safariPath = "/Applications/Safari.app/Contents/MacOS/SafariForWebKitDevelopment";
894     }
895
896     die "Can't find executable at $safariPath.\n" if !-x $safariPath;
897     return $safariPath;
898 }
899
900 sub builtDylibPathForName
901 {
902     my $libraryName = shift;
903     determineConfigurationProductDir();
904
905     if (isGtk()) {
906         my $extension = isDarwin() ? ".dylib" : ".so";
907         return "$configurationProductDir/lib/libwebkit2gtk-4.0" . $extension;
908     }
909     if (isEfl()) {
910         return "$configurationProductDir/lib/libewebkit2.so";
911     }
912     if (isIOSWebKit()) {
913         return "$configurationProductDir/$libraryName.framework/$libraryName";
914     }
915     if (isAppleCocoaWebKit()) {
916         return "$configurationProductDir/$libraryName.framework/Versions/A/$libraryName";
917     }
918     if (isAppleWinWebKit()) {
919         if ($libraryName eq "JavaScriptCore") {
920             return "$baseProductDir/lib/$libraryName.lib";
921         } else {
922             return "$baseProductDir/$libraryName.intermediate/$configuration/$libraryName.intermediate/$libraryName.lib";
923         }
924     }
925
926     die "Unsupported platform, can't determine built library locations.\nTry `build-webkit --help` for more information.\n";
927 }
928
929 # Check to see that all the frameworks are built.
930 sub checkFrameworks # FIXME: This is a poor name since only the Mac calls built WebCore a Framework.
931 {
932     return if isAnyWindows();
933     my @frameworks = ("JavaScriptCore", "WebCore");
934     push(@frameworks, "WebKit") if isAppleCocoaWebKit(); # FIXME: This seems wrong, all ports should have a WebKit these days.
935     for my $framework (@frameworks) {
936         my $path = builtDylibPathForName($framework);
937         die "Can't find built framework at \"$path\".\n" unless -e $path;
938     }
939 }
940
941 sub isInspectorFrontend()
942 {
943     determineIsInspectorFrontend();
944     return $isInspectorFrontend;
945 }
946
947 sub determineIsInspectorFrontend()
948 {
949     return if defined($isInspectorFrontend);
950     $isInspectorFrontend = checkForArgumentAndRemoveFromARGV("--inspector-frontend");
951 }
952
953 sub commandExists($)
954 {
955     my $command = shift;
956     my $devnull = File::Spec->devnull();
957
958     if (isAnyWindows()) {
959         return exitStatus(system("where /q $command >$devnull 2>&1")) == 0;
960     }
961     return exitStatus(system("which $command >$devnull 2>&1")) == 0;
962 }
963
964 sub checkForArgumentAndRemoveFromARGV($)
965 {
966     my $argToCheck = shift;
967     return checkForArgumentAndRemoveFromArrayRef($argToCheck, \@ARGV);
968 }
969
970 sub checkForArgumentAndRemoveFromArrayRefGettingValue($$$)
971 {
972     my ($argToCheck, $valueRef, $arrayRef) = @_;
973     my $argumentStartRegEx = qr#^$argToCheck(?:=\S|$)#;
974     my $i = 0;
975     for (; $i < @$arrayRef; ++$i) {
976         last if $arrayRef->[$i] =~ $argumentStartRegEx;
977     }
978     if ($i >= @$arrayRef) {
979         return $$valueRef = undef;
980     }
981     my ($key, $value) = split("=", $arrayRef->[$i]);
982     splice(@$arrayRef, $i, 1);
983     if (defined($value)) {
984         # e.g. --sdk=iphonesimulator
985         return $$valueRef = $value;
986     }
987     return $$valueRef = splice(@$arrayRef, $i, 1); # e.g. --sdk iphonesimulator
988 }
989
990 sub checkForArgumentAndRemoveFromARGVGettingValue($$)
991 {
992     my ($argToCheck, $valueRef) = @_;
993     return checkForArgumentAndRemoveFromArrayRefGettingValue($argToCheck, $valueRef, \@ARGV);
994 }
995
996 sub findMatchingArguments($$)
997 {
998     my ($argToCheck, $arrayRef) = @_;
999     my @matchingIndices;
1000     foreach my $index (0 .. $#$arrayRef) {
1001         my $opt = $$arrayRef[$index];
1002         if ($opt =~ /^$argToCheck$/i ) {
1003             push(@matchingIndices, $index);
1004         }
1005     }
1006     return @matchingIndices; 
1007 }
1008
1009 sub hasArgument($$)
1010 {
1011     my ($argToCheck, $arrayRef) = @_;
1012     my @matchingIndices = findMatchingArguments($argToCheck, $arrayRef);
1013     return scalar @matchingIndices > 0;
1014 }
1015
1016 sub checkForArgumentAndRemoveFromArrayRef
1017 {
1018     my ($argToCheck, $arrayRef) = @_;
1019     my @indicesToRemove = findMatchingArguments($argToCheck, $arrayRef);
1020     my $removeOffset = 0;
1021     foreach my $index (@indicesToRemove) {
1022         splice(@$arrayRef, $index - $removeOffset++, 1);
1023     }
1024     return scalar @indicesToRemove > 0;
1025 }
1026
1027 sub prohibitUnknownPort()
1028 {
1029     $unknownPortProhibited = 1;
1030 }
1031
1032 sub determinePortName()
1033 {
1034     return if defined $portName;
1035
1036     my %argToPortName = (
1037         efl => Efl,
1038         gtk => GTK,
1039         'jsc-only' => JSCOnly,
1040         wincairo => WinCairo
1041     );
1042
1043     for my $arg (sort keys %argToPortName) {
1044         if (checkForArgumentAndRemoveFromARGV("--$arg")) {
1045             die "Argument '--$arg' conflicts with selected port '$portName'\n"
1046                 if defined $portName;
1047
1048             $portName = $argToPortName{$arg};
1049         }
1050     }
1051
1052     return if defined $portName;
1053
1054     # Port was not selected via command line, use appropriate default value
1055
1056     if (isAnyWindows()) {
1057         $portName = AppleWin;
1058     } elsif (isDarwin()) {
1059         determineXcodeSDK();
1060         if (willUseIOSDeviceSDK() || willUseIOSSimulatorSDK()) {
1061             $portName = iOS;
1062         } elsif (willUseAppleTVDeviceSDK() || willUseAppleTVSimulatorSDK()) {
1063             $portName = tvOS;
1064         } elsif (willUseWatchDeviceSDK() || willUseWatchSimulatorSDK()) {
1065             $portName = watchOS;
1066         } else {
1067             $portName = Mac;
1068         }
1069     } else {
1070         if ($unknownPortProhibited) {
1071             my $portsChoice = join "\n\t", qw(
1072                 --efl
1073                 --gtk
1074                 --jsc-only
1075             );
1076             die "Please specify which WebKit port to build using one of the following options:"
1077                 . "\n\t$portsChoice\n";
1078         }
1079
1080         # If script is run without arguments we cannot determine port
1081         # TODO: This state should be outlawed
1082         $portName = Unknown;
1083     }
1084 }
1085
1086 sub portName()
1087 {
1088     determinePortName();
1089     return $portName;
1090 }
1091
1092 sub isEfl()
1093 {
1094     return portName() eq Efl;
1095 }
1096
1097 sub isGtk()
1098 {
1099     return portName() eq GTK;
1100 }
1101
1102 sub isJSCOnly()
1103 {
1104     return portName() eq JSCOnly;
1105 }
1106
1107 # Determine if this is debian, ubuntu, linspire, or something similar.
1108 sub isDebianBased()
1109 {
1110     return -e "/etc/debian_version";
1111 }
1112
1113 sub isFedoraBased()
1114 {
1115     return -e "/etc/fedora-release";
1116 }
1117
1118 sub isWinCairo()
1119 {
1120     return portName() eq WinCairo;
1121 }
1122
1123 sub isWin64()
1124 {
1125     determineIsWin64();
1126     return $isWin64;
1127 }
1128
1129 sub determineIsWin64()
1130 {
1131     return if defined($isWin64);
1132     $isWin64 = checkForArgumentAndRemoveFromARGV("--64-bit");
1133 }
1134
1135 sub determineIsWin64FromArchitecture($)
1136 {
1137     my $arch = shift;
1138     $isWin64 = ($arch eq "x86_64");
1139     return $isWin64;
1140 }
1141
1142 sub isCygwin()
1143 {
1144     return ($^O eq "cygwin") || 0;
1145 }
1146
1147 sub isAnyWindows()
1148 {
1149     return isWindows() || isCygwin();
1150 }
1151
1152 sub determineWinVersion()
1153 {
1154     return if $winVersion;
1155
1156     if (!isAnyWindows()) {
1157         $winVersion = -1;
1158         return;
1159     }
1160
1161     my $versionString = `cmd /c ver`;
1162     $versionString =~ /(\d)\.(\d)\.(\d+)/;
1163
1164     $winVersion = {
1165         major => $1,
1166         minor => $2,
1167         build => $3,
1168     };
1169 }
1170
1171 sub winVersion()
1172 {
1173     determineWinVersion();
1174     return $winVersion;
1175 }
1176
1177 sub isWindows7SP0()
1178 {
1179     return isAnyWindows() && winVersion()->{major} == 6 && winVersion()->{minor} == 1 && winVersion()->{build} == 7600;
1180 }
1181
1182 sub isWindowsVista()
1183 {
1184     return isAnyWindows() && winVersion()->{major} == 6 && winVersion()->{minor} == 0;
1185 }
1186
1187 sub isWindowsXP()
1188 {
1189     return isAnyWindows() && winVersion()->{major} == 5 && winVersion()->{minor} == 1;
1190 }
1191
1192 sub isDarwin()
1193 {
1194     return ($^O eq "darwin") || 0;
1195 }
1196
1197 sub isWindows()
1198 {
1199     return ($^O eq "MSWin32") || 0;
1200 }
1201
1202 sub isLinux()
1203 {
1204     return ($^O eq "linux") || 0;
1205 }
1206
1207 sub isBSD()
1208 {
1209     return ($^O eq "freebsd") || ($^O eq "openbsd") || ($^O eq "netbsd") || 0;
1210 }
1211
1212 sub isX86_64()
1213 {
1214     return (architecture() eq "x86_64") || 0;
1215 }
1216
1217 sub isCrossCompilation()
1218 {
1219     my $compiler = "";
1220     $compiler = $ENV{'CC'} if (defined($ENV{'CC'}));
1221     if ($compiler =~ /gcc/) {
1222         my $compilerOptions = `$compiler -v 2>&1`;
1223         my @host = $compilerOptions =~ m/--host=(.*?)\s/;
1224         my @target = $compilerOptions =~ m/--target=(.*?)\s/;
1225         if ($target[0] ne "" && $host[0] ne "") {
1226                 return ($host[0] ne $target[0]);
1227         } else {
1228                 # $tempDir gets automatically deleted when goes out of scope
1229                 my $tempDir = File::Temp->newdir();
1230                 my $testProgramSourcePath = File::Spec->catfile($tempDir, "testcross.c");
1231                 my $testProgramBinaryPath = File::Spec->catfile($tempDir, "testcross");
1232                 open(my $testProgramSourceHandler, ">", $testProgramSourcePath);
1233                 print $testProgramSourceHandler "int main() { return 0; }\n";
1234                 system("$compiler $testProgramSourcePath -o $testProgramBinaryPath > /dev/null 2>&1") == 0 or return 0;
1235                 # Crosscompiling if the program fails to run (because it was built for other arch)
1236                 system("$testProgramBinaryPath > /dev/null 2>&1") == 0 or return 1;
1237                 return 0;
1238         }
1239     }
1240     return 0;
1241 }
1242
1243 sub isAppleWebKit()
1244 {
1245     return isAppleCocoaWebKit() || isAppleWinWebKit();
1246 }
1247
1248 sub isAppleCocoaWebKit()
1249 {
1250     return (portName() eq Mac) || isIOSWebKit() || isTVOSWebKit() || isWatchOSWebKit();
1251 }
1252
1253 sub isAppleWinWebKit()
1254 {
1255     return portName() eq AppleWin;
1256 }
1257
1258 sub iOSSimulatorDevicesPath
1259 {
1260     return "$ENV{HOME}/Library/Developer/CoreSimulator/Devices";
1261 }
1262
1263 sub iOSSimulatorDevices
1264 {
1265     eval "require Foundation";
1266     my $devicesPath = iOSSimulatorDevicesPath();
1267     opendir(DEVICES, $devicesPath);
1268     my @udids = grep {
1269         $_ =~ m/^[0-9A-F]{8}-([0-9A-F]{4}-){3}[0-9A-F]{12}$/;
1270     } readdir(DEVICES);
1271     close(DEVICES);
1272
1273     # FIXME: We should parse the device.plist file ourself and map the dictionary keys in it to known
1274     #        dictionary keys so as to decouple our representation of the plist from the actual structure
1275     #        of the plist, which may change.
1276     my @devices = map {
1277         Foundation::perlRefFromObjectRef(NSDictionary->dictionaryWithContentsOfFile_("$devicesPath/$_/device.plist"));
1278     } @udids;
1279
1280     return @devices;
1281 }
1282
1283 sub createiOSSimulatorDevice
1284 {
1285     my $name = shift;
1286     my $deviceTypeId = shift;
1287     my $runtimeId = shift;
1288
1289     my $created = system("xcrun", "--sdk", "iphonesimulator", "simctl", "create", $name, $deviceTypeId, $runtimeId) == 0;
1290     die "Couldn't create simulator device: $name $deviceTypeId $runtimeId" if not $created;
1291
1292     system("xcrun", "--sdk", "iphonesimulator", "simctl", "list");
1293
1294     print "Waiting for device to be created ...\n";
1295     sleep 5;
1296     for (my $tries = 0; $tries < 5; $tries++){
1297         my @devices = iOSSimulatorDevices();
1298         foreach my $device (@devices) {
1299             return $device if $device->{name} eq $name and $device->{deviceType} eq $deviceTypeId and $device->{runtime} eq $runtimeId;
1300         }
1301         sleep 5;
1302     }
1303     die "Device $name $deviceTypeId $runtimeId wasn't found in " . iOSSimulatorDevicesPath();
1304 }
1305
1306 sub willUseIOSDeviceSDK()
1307 {
1308     return xcodeSDKPlatformName() eq "iphoneos";
1309 }
1310
1311 sub willUseIOSSimulatorSDK()
1312 {
1313     return xcodeSDKPlatformName() eq "iphonesimulator";
1314 }
1315
1316 sub willUseAppleTVDeviceSDK()
1317 {
1318     return xcodeSDKPlatformName() eq "appletvos";
1319 }
1320
1321 sub willUseAppleTVSimulatorSDK()
1322 {
1323     return xcodeSDKPlatformName() eq "appletvsimulator";
1324 }
1325
1326 sub willUseWatchDeviceSDK()
1327 {
1328     return xcodeSDKPlatformName() eq "watchos";
1329 }
1330
1331 sub willUseWatchSimulatorSDK()
1332 {
1333     return xcodeSDKPlatformName() eq "watchsimulator";
1334 }
1335
1336 sub isIOSWebKit()
1337 {
1338     return portName() eq iOS;
1339 }
1340
1341 sub isTVOSWebKit()
1342 {
1343     return portName() eq tvOS;
1344 }
1345
1346 sub isWatchOSWebKit()
1347 {
1348     return portName() eq watchOS;
1349 }
1350
1351 sub isEmbeddedWebKit()
1352 {
1353     return  isIOSWebKit() || isTVOSWebKit() || isWatchOSWebKit();
1354 }
1355
1356 sub determineNmPath()
1357 {
1358     return if $nmPath;
1359
1360     if (isAppleCocoaWebKit()) {
1361         $nmPath = `xcrun -find nm`;
1362         chomp $nmPath;
1363     }
1364     $nmPath = "nm" if !$nmPath;
1365 }
1366
1367 sub nmPath()
1368 {
1369     determineNmPath();
1370     return $nmPath;
1371 }
1372
1373 sub splitVersionString
1374 {
1375     my $versionString = shift;
1376     my @splitVersion = split(/\./, $versionString);
1377     @splitVersion >= 2 or die "Invalid version $versionString";
1378     $osXVersion = {
1379             "major" => $splitVersion[0],
1380             "minor" => $splitVersion[1],
1381             "subminor" => (defined($splitVersion[2]) ? $splitVersion[2] : 0),
1382     };
1383 }
1384
1385 sub determineOSXVersion()
1386 {
1387     return if $osXVersion;
1388
1389     if (!isDarwin()) {
1390         $osXVersion = -1;
1391         return;
1392     }
1393
1394     my $versionString = `sw_vers -productVersion`;
1395     $osXVersion = splitVersionString($versionString);
1396 }
1397
1398 sub osXVersion()
1399 {
1400     determineOSXVersion();
1401     return $osXVersion;
1402 }
1403
1404 sub determineIOSVersion()
1405 {
1406     return if $iosVersion;
1407
1408     if (!isIOSWebKit()) {
1409         $iosVersion = -1;
1410         return;
1411     }
1412
1413     my $versionString = xcodeSDKVersion();
1414     $iosVersion = splitVersionString($versionString);
1415 }
1416
1417 sub iosVersion()
1418 {
1419     determineIOSVersion();
1420     return $iosVersion;
1421 }
1422
1423 sub isWindowsNT()
1424 {
1425     return $ENV{'OS'} eq 'Windows_NT';
1426 }
1427
1428 sub appendToEnvironmentVariableList($$)
1429 {
1430     my ($name, $value) = @_;
1431
1432     if (defined($ENV{$name})) {
1433         $ENV{$name} .= $Config{path_sep} . $value;
1434     } else {
1435         $ENV{$name} = $value;
1436     }
1437 }
1438
1439 sub prependToEnvironmentVariableList($$)
1440 {
1441     my ($name, $value) = @_;
1442
1443     if (defined($ENV{$name})) {
1444         $ENV{$name} = $value . $Config{path_sep} . $ENV{$name};
1445     } else {
1446         $ENV{$name} = $value;
1447     }
1448 }
1449
1450 sub sharedCommandLineOptions()
1451 {
1452     return (
1453         "g|guard-malloc" => \$shouldUseGuardMalloc,
1454     );
1455 }
1456
1457 sub sharedCommandLineOptionsUsage
1458 {
1459     my %opts = @_;
1460
1461     my %switches = (
1462         '-g|--guard-malloc' => 'Use guardmalloc when running executable',
1463     );
1464
1465     my $indent = " " x ($opts{indent} || 2);
1466     my $switchWidth = List::Util::max(int($opts{switchWidth}), List::Util::max(map { length($_) } keys %switches) + ($opts{brackets} ? 2 : 0));
1467
1468     my $result = "Common switches:\n";
1469
1470     for my $switch (keys %switches) {
1471         my $switchName = $opts{brackets} ? "[" . $switch . "]" : $switch;
1472         $result .= sprintf("%s%-" . $switchWidth . "s %s\n", $indent, $switchName, $switches{$switch});
1473     }
1474
1475     return $result;
1476 }
1477
1478 sub setUpGuardMallocIfNeeded
1479 {
1480     if (!isDarwin()) {
1481         return;
1482     }
1483
1484     if (!defined($shouldUseGuardMalloc)) {
1485         $shouldUseGuardMalloc = checkForArgumentAndRemoveFromARGV("-g") || checkForArgumentAndRemoveFromARGV("--guard-malloc");
1486     }
1487
1488     if ($shouldUseGuardMalloc) {
1489         appendToEnvironmentVariableList("DYLD_INSERT_LIBRARIES", "/usr/lib/libgmalloc.dylib");
1490         appendToEnvironmentVariableList("__XPC_DYLD_INSERT_LIBRARIES", "/usr/lib/libgmalloc.dylib");
1491     }
1492 }
1493
1494 sub relativeScriptsDir()
1495 {
1496     my $scriptDir = File::Spec->catpath("", File::Spec->abs2rel($FindBin::Bin, getcwd()), "");
1497     if ($scriptDir eq "") {
1498         $scriptDir = ".";
1499     }
1500     return $scriptDir;
1501 }
1502
1503 sub launcherPath()
1504 {
1505     my $relativeScriptsPath = relativeScriptsDir();
1506     if (isGtk() || isEfl()) {
1507         return "$relativeScriptsPath/run-minibrowser";
1508     } elsif (isAppleWebKit()) {
1509         return "$relativeScriptsPath/run-safari";
1510     }
1511 }
1512
1513 sub launcherName()
1514 {
1515     if (isGtk() || isEfl()) {
1516         return "MiniBrowser";
1517     } elsif (isAppleCocoaWebKit()) {
1518         return "Safari";
1519     } elsif (isAppleWinWebKit()) {
1520         return "MiniBrowser";
1521     }
1522 }
1523
1524 sub checkRequiredSystemConfig
1525 {
1526     if (isDarwin()) {
1527         chomp(my $productVersion = `sw_vers -productVersion`);
1528         if (eval "v$productVersion" lt v10.10.5) {
1529             print "*************************************************************\n";
1530             print "OS X Yosemite v10.10.5 or later is required to build WebKit.\n";
1531             print "You have " . $productVersion . ", thus the build will most likely fail.\n";
1532             print "*************************************************************\n";
1533         }
1534         determineXcodeVersion();
1535         if (eval "v$xcodeVersion" lt v7.0) {
1536             print "*************************************************************\n";
1537             print "Xcode 7.0 or later is required to build WebKit.\n";
1538             print "You have an earlier version of Xcode, thus the build will\n";
1539             print "most likely fail. The latest Xcode is available from the App Store.\n";
1540             print "*************************************************************\n";
1541         }
1542     }
1543 }
1544
1545 sub determineWindowsSourceDir()
1546 {
1547     return if $windowsSourceDir;
1548     $windowsSourceDir = sourceDir();
1549     chomp($windowsSourceDir = `cygpath -w '$windowsSourceDir'`) if isCygwin();
1550 }
1551
1552 sub windowsSourceDir()
1553 {
1554     determineWindowsSourceDir();
1555     return $windowsSourceDir;
1556 }
1557
1558 sub windowsSourceSourceDir()
1559 {
1560     return File::Spec->catdir(windowsSourceDir(), "Source");
1561 }
1562
1563 sub windowsLibrariesDir()
1564 {
1565     return File::Spec->catdir(windowsSourceDir(), "WebKitLibraries", "win");
1566 }
1567
1568 sub windowsOutputDir()
1569 {
1570     return File::Spec->catdir(windowsSourceDir(), "WebKitBuild");
1571 }
1572
1573 sub fontExists($)
1574 {
1575     my $font = shift;
1576     my $cmd = "reg query \"HKLM\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Fonts\" /v \"$font\" 2>&1";
1577     my $val = `$cmd`;
1578     return $? == 0;
1579 }
1580
1581 sub checkInstalledTools()
1582 {
1583     # environment variables. Avoid until this is corrected.
1584     my $pythonVer = `python --version 2>&1`;
1585     die "You must have Python installed to build WebKit.\n" if ($?);
1586
1587     # cURL 7.34.0 has a bug that prevents authentication with opensource.apple.com (and other things using SSL3).
1588     my $curlVer = `curl --version 2> NUL`;
1589     if (!$? and $curlVer =~ "(.*curl.*)") {
1590         $curlVer = $1;
1591         if ($curlVer =~ /libcurl\/7\.34\.0/) {
1592             print "cURL version 7.34.0 has a bug that prevents authentication with SSL v2 or v3.\n";
1593             print "cURL 7.33.0 is known to work. The cURL projects is preparing an update to\n";
1594             print "correct this problem.\n\n";
1595             die "Please install a working cURL and try again.\n";
1596         }
1597     }
1598
1599     # MathML requires fonts that may not ship with Windows.
1600     # Warn the user if they are missing.
1601     my @fonts = ('Cambria & Cambria Math (TrueType)', 'LatinModernMath-Regular (TrueType)', 'STIXMath-Regular (TrueType)');
1602     my @missing = ();
1603     foreach my $font (@fonts) {
1604         push @missing, $font if not fontExists($font);
1605     }
1606
1607     if (scalar @missing > 0) {
1608         print "*************************************************************\n";
1609         print "Mathematical fonts, such as Latin Modern Math are needed to\n";
1610         print "use the MathML feature.  You do not appear to have these fonts\n";
1611         print "on your system.\n\n";
1612         print "You can download a suitable set of fonts from the following URL:\n";
1613         print "https://trac.webkit.org/wiki/MathML/Fonts\n";
1614         print "*************************************************************\n";
1615     }
1616
1617     print "Installed tools are correct for the WebKit build.\n";
1618 }
1619
1620 sub setupAppleWinEnv()
1621 {
1622     return unless isAppleWinWebKit();
1623
1624     checkInstalledTools();
1625
1626     if (isWindowsNT()) {
1627         my $restartNeeded = 0;
1628         my %variablesToSet = ();
1629
1630         # FIXME: We should remove this explicit version check for cygwin once we stop supporting Cygwin 1.7.9 or older versions. 
1631         # https://bugs.webkit.org/show_bug.cgi?id=85791
1632         my $uname_version = (POSIX::uname())[2];
1633         $uname_version =~ s/\(.*\)//;  # Remove the trailing cygwin version, if any.
1634         $uname_version =~ s/\-.*$//; # Remove trailing dash-version content, if any
1635         if (version->parse($uname_version) < version->parse("1.7.10")) {
1636             # Setting the environment variable 'CYGWIN' to 'tty' makes cygwin enable extra support (i.e., termios)
1637             # for UNIX-like ttys in the Windows console
1638             $variablesToSet{CYGWIN} = "tty" unless $ENV{CYGWIN};
1639         }
1640         
1641         # Those environment variables must be set to be able to build inside Visual Studio.
1642         $variablesToSet{WEBKIT_LIBRARIES} = windowsLibrariesDir() unless $ENV{WEBKIT_LIBRARIES};
1643         $variablesToSet{WEBKIT_OUTPUTDIR} = windowsOutputDir() unless $ENV{WEBKIT_OUTPUTDIR};
1644         $variablesToSet{MSBUILDDISABLENODEREUSE} = "1" unless $ENV{MSBUILDDISABLENODEREUSE};
1645         $variablesToSet{_IsNativeEnvironment} = "true" unless $ENV{_IsNativeEnvironment};
1646         $variablesToSet{PreferredToolArchitecture} = "x64" unless $ENV{PreferredToolArchitecture};
1647
1648         foreach my $variable (keys %variablesToSet) {
1649             print "Setting the Environment Variable '" . $variable . "' to '" . $variablesToSet{$variable} . "'\n\n";
1650             my $ret = system "setx", $variable, $variablesToSet{$variable};
1651             if ($ret != 0) {
1652                 system qw(regtool -s set), '\\HKEY_CURRENT_USER\\Environment\\' . $variable, $variablesToSet{$variable};
1653             }
1654             $restartNeeded ||=  $variable eq "WEBKIT_LIBRARIES" || $variable eq "WEBKIT_OUTPUTDIR";
1655         }
1656
1657         if ($restartNeeded) {
1658             print "Please restart your computer before attempting to build inside Visual Studio.\n\n";
1659         }
1660     } else {
1661         if (!defined $ENV{'WEBKIT_LIBRARIES'} || !$ENV{'WEBKIT_LIBRARIES'}) {
1662             print "Warning: You must set the 'WebKit_Libraries' environment variable\n";
1663             print "         to be able build WebKit from within Visual Studio 2013 and newer.\n";
1664             print "         Make sure that 'WebKit_Libraries' points to the\n";
1665             print "         'WebKitLibraries/win' directory, not the 'WebKitLibraries/' directory.\n\n";
1666         }
1667         if (!defined $ENV{'WEBKIT_OUTPUTDIR'} || !$ENV{'WEBKIT_OUTPUTDIR'}) {
1668             print "Warning: You must set the 'WebKit_OutputDir' environment variable\n";
1669             print "         to be able build WebKit from within Visual Studio 2013 and newer.\n\n";
1670         }
1671         if (!defined $ENV{'MSBUILDDISABLENODEREUSE'} || !$ENV{'MSBUILDDISABLENODEREUSE'}) {
1672             print "Warning: You should set the 'MSBUILDDISABLENODEREUSE' environment variable to '1'\n";
1673             print "         to avoid periodic locked log files when building.\n\n";
1674         }
1675     }
1676     # FIXME (125180): Remove the following temporary 64-bit support once official support is available.
1677     if (isWin64() and !$ENV{'WEBKIT_64_SUPPORT'}) {
1678         print "Warning: You must set the 'WEBKIT_64_SUPPORT' environment variable\n";
1679         print "         to be able run WebKit or JavaScriptCore tests.\n\n";
1680     }
1681 }
1682
1683 sub setupCygwinEnv()
1684 {
1685     return if !isAnyWindows();
1686     return if $vcBuildPath;
1687
1688     my $programFilesPath = programFilesPath();
1689     my $visualStudioPath = File::Spec->catfile(visualStudioInstallDir(), qw(Common7 IDE devenv.com));
1690     if (-e $visualStudioPath) {
1691         # Visual Studio is installed;
1692         if (visualStudioVersion() eq "12") {
1693             $visualStudioPath = File::Spec->catfile(visualStudioInstallDir(), qw(Common7 IDE devenv.exe));
1694         }
1695     } else {
1696         # Visual Studio not found, try VC++ Express
1697         $visualStudioPath = File::Spec->catfile(visualStudioInstallDir(), qw(Common7 IDE WDExpress.exe));
1698         if (! -e $visualStudioPath) {
1699             print "*************************************************************\n";
1700             print "Cannot find '$visualStudioPath'\n";
1701             print "Please execute the file 'vcvars32.bat' from\n";
1702             print "'$programFilesPath\\Microsoft Visual Studio 14.0\\VC\\bin\\'\n";
1703             print "to setup the necessary environment variables.\n";
1704             print "*************************************************************\n";
1705             die;
1706         }
1707         $willUseVCExpressWhenBuilding = 1;
1708     }
1709
1710     print "Building results into: ", baseProductDir(), "\n";
1711     print "WEBKIT_OUTPUTDIR is set to: ", $ENV{"WEBKIT_OUTPUTDIR"}, "\n";
1712     print "WEBKIT_LIBRARIES is set to: ", $ENV{"WEBKIT_LIBRARIES"}, "\n";
1713     # FIXME (125180): Remove the following temporary 64-bit support once official support is available.
1714     print "WEBKIT_64_SUPPORT is set to: ", $ENV{"WEBKIT_64_SUPPORT"}, "\n" if isWin64();
1715
1716     # We will actually use MSBuild to build WebKit, but we need to find the Visual Studio install (above) to make
1717     # sure we use the right options.
1718     $vcBuildPath = File::Spec->catfile(msBuildInstallDir(), qw(MSBuild.exe));
1719     if (! -e $vcBuildPath) {
1720         print "*************************************************************\n";
1721         print "Cannot find '$vcBuildPath'\n";
1722         print "Please make sure execute that the Microsoft .NET Framework SDK\n";
1723         print "is installed on this machine.\n";
1724         print "*************************************************************\n";
1725         die;
1726     }
1727 }
1728
1729 sub dieIfWindowsPlatformSDKNotInstalled
1730 {
1731     my $registry32Path = "/proc/registry/";
1732     my $registry64Path = "/proc/registry64/";
1733     my @windowsPlatformSDKRegistryEntries = (
1734         "HKEY_LOCAL_MACHINE/SOFTWARE/Microsoft/Microsoft SDKs/Windows/v8.0A",
1735         "HKEY_LOCAL_MACHINE/SOFTWARE/Microsoft/Microsoft SDKs/Windows/v8.0",
1736         "HKEY_LOCAL_MACHINE/SOFTWARE/Microsoft/Microsoft SDKs/Windows/v7.1A",
1737         "HKEY_LOCAL_MACHINE/SOFTWARE/Microsoft/Microsoft SDKs/Windows/v7.0A",
1738         "HKEY_LOCAL_MACHINE/SOFTWARE/Microsoft/MicrosoftSDK/InstalledSDKs/D2FF9F89-8AA2-4373-8A31-C838BF4DBBE1",
1739     );
1740
1741     # FIXME: It would be better to detect whether we are using 32- or 64-bit Windows
1742     # and only check the appropriate entry. But for now we just blindly check both.
1743     my $recommendedPlatformSDK = $windowsPlatformSDKRegistryEntries[0];
1744
1745     while (@windowsPlatformSDKRegistryEntries) {
1746         my $windowsPlatformSDKRegistryEntry = shift @windowsPlatformSDKRegistryEntries;
1747         return if (-e $registry32Path . $windowsPlatformSDKRegistryEntry) || (-e $registry64Path . $windowsPlatformSDKRegistryEntry);
1748     }
1749
1750     print "*************************************************************\n";
1751     print "Cannot find registry entry '$recommendedPlatformSDK'.\n";
1752     print "Please download and install the Microsoft Windows SDK\n";
1753     print "from <http://www.microsoft.com/en-us/download/details.aspx?id=8279>.\n\n";
1754     print "Then follow step 2 in the Windows section of the \"Installing Developer\n";
1755     print "Tools\" instructions at <http://www.webkit.org/building/tools.html>.\n";
1756     print "*************************************************************\n";
1757     die;
1758 }
1759
1760 sub buildXCodeProject($$@)
1761 {
1762     my ($project, $clean, @extraOptions) = @_;
1763
1764     if ($clean) {
1765         push(@extraOptions, "-alltargets");
1766         push(@extraOptions, "clean");
1767     }
1768
1769     chomp($ENV{DSYMUTIL_NUM_THREADS} = `sysctl -n hw.activecpu`);
1770     return system "xcodebuild", "-project", "$project.xcodeproj", @extraOptions;
1771 }
1772
1773 sub usingVisualStudioExpress()
1774 {
1775     setupCygwinEnv();
1776     return $willUseVCExpressWhenBuilding;
1777 }
1778
1779 sub buildVisualStudioProject
1780 {
1781     my ($project, $clean) = @_;
1782     setupCygwinEnv();
1783
1784     my $config = configurationForVisualStudio();
1785
1786     dieIfWindowsPlatformSDKNotInstalled() if $willUseVCExpressWhenBuilding;
1787
1788     chomp($project = `cygpath -w "$project"`) if isCygwin();
1789
1790     my $action = "/t:build";
1791     if ($clean) {
1792         $action = "/t:clean";
1793     }
1794
1795     my $platform = "/p:Platform=" . (isWin64() ? "x64" : "Win32");
1796     my $logPath = File::Spec->catdir($baseProductDir, $configuration);
1797     make_path($logPath) unless -d $logPath or $logPath eq ".";
1798
1799     my $errorLogFile = File::Spec->catfile($logPath, "webkit_errors.log");
1800     chomp($errorLogFile = `cygpath -w "$errorLogFile"`) if isCygwin();
1801     my $errorLogging = "/flp:LogFile=" . $errorLogFile . ";ErrorsOnly";
1802
1803     my $warningLogFile = File::Spec->catfile($logPath, "webkit_warnings.log");
1804     chomp($warningLogFile = `cygpath -w "$warningLogFile"`) if isCygwin();
1805     my $warningLogging = "/flp1:LogFile=" . $warningLogFile . ";WarningsOnly";
1806
1807     my @command = ($vcBuildPath, "/verbosity:minimal", $project, $action, $config, $platform, "/fl", $errorLogging, "/fl1", $warningLogging);
1808     print join(" ", @command), "\n";
1809     return system @command;
1810 }
1811
1812 sub getJhbuildPath()
1813 {
1814     my @jhbuildPath = File::Spec->splitdir(baseProductDir());
1815     if (isGit() && isGitBranchBuild() && gitBranch()) {
1816         pop(@jhbuildPath);
1817     }
1818     if (isEfl()) {
1819         push(@jhbuildPath, "DependenciesEFL");
1820     } elsif (isGtk()) {
1821         push(@jhbuildPath, "DependenciesGTK");
1822     } else {
1823         die "Cannot get JHBuild path for platform that isn't GTK+ or EFL.\n";
1824     }
1825     return File::Spec->catdir(@jhbuildPath);
1826 }
1827
1828 sub isCachedArgumentfileOutOfDate($@)
1829 {
1830     my ($filename, $currentContents) = @_;
1831
1832     if (! -e $filename) {
1833         return 1;
1834     }
1835
1836     open(CONTENTS_FILE, $filename);
1837     chomp(my $previousContents = <CONTENTS_FILE>);
1838     close(CONTENTS_FILE);
1839
1840     if ($previousContents ne $currentContents) {
1841         print "Contents for file $filename have changed.\n";
1842         print "Previous contents were: $previousContents\n\n";
1843         print "New contents are: $currentContents\n";
1844         return 1;
1845     }
1846
1847     return 0;
1848 }
1849
1850 sub wrapperPrefixIfNeeded()
1851 {
1852     if (isAnyWindows() || isJSCOnly()) {
1853         return ();
1854     }
1855     if (isAppleCocoaWebKit()) {
1856         return ("xcrun");
1857     }
1858     if (-e getJhbuildPath()) {
1859         my @prefix = (File::Spec->catfile(sourceDir(), "Tools", "jhbuild", "jhbuild-wrapper"));
1860         if (isEfl()) {
1861             push(@prefix, "--efl");
1862         } elsif (isGtk()) {
1863             push(@prefix, "--gtk");
1864         }
1865         push(@prefix, "run");
1866
1867         return @prefix;
1868     }
1869
1870     return ();
1871 }
1872
1873 sub cmakeCachePath()
1874 {
1875     return File::Spec->catdir(baseProductDir(), configuration(), "CMakeCache.txt");
1876 }
1877
1878 sub cmakeFilesPath()
1879 {
1880     return File::Spec->catdir(baseProductDir(), configuration(), "CMakeFiles");
1881 }
1882
1883 sub shouldRemoveCMakeCache(@)
1884 {
1885     my ($cacheFilePath, @buildArgs) = @_;
1886
1887     # We check this first, because we always want to create this file for a fresh build.
1888     my $productDir = File::Spec->catdir(baseProductDir(), configuration());
1889     my $optionsCache = File::Spec->catdir($productDir, "build-webkit-options.txt");
1890     my $joinedBuildArgs = join(" ", @buildArgs);
1891     if (isCachedArgumentfileOutOfDate($optionsCache, $joinedBuildArgs)) {
1892         File::Path::mkpath($productDir) unless -d $productDir;
1893         open(CACHED_ARGUMENTS, ">", $optionsCache);
1894         print CACHED_ARGUMENTS $joinedBuildArgs;
1895         close(CACHED_ARGUMENTS);
1896
1897         return 1;
1898     }
1899
1900     my $cmakeCache = cmakeCachePath();
1901     unless (-e $cmakeCache) {
1902         return 0;
1903     }
1904
1905     my $cacheFileModifiedTime = stat($cmakeCache)->mtime;
1906     my $platformConfiguration = File::Spec->catdir(sourceDir(), "Source", "cmake", "Options" . cmakeBasedPortName() . ".cmake");
1907     if ($cacheFileModifiedTime < stat($platformConfiguration)->mtime) {
1908         return 1;
1909     }
1910
1911     my $globalConfiguration = File::Spec->catdir(sourceDir(), "Source", "cmake", "OptionsCommon.cmake");
1912     if ($cacheFileModifiedTime < stat($globalConfiguration)->mtime) {
1913         return 1;
1914     }
1915
1916     my $inspectorUserInterfaceDircetory = File::Spec->catdir(sourceDir(), "Source", "WebInspectorUI", "UserInterface");
1917     if ($cacheFileModifiedTime < stat($inspectorUserInterfaceDircetory)->mtime) {
1918         return 1;
1919     }
1920
1921     if(isAnyWindows()) {
1922         my $winConfiguration = File::Spec->catdir(sourceDir(), "Source", "cmake", "OptionsWin.cmake");
1923         if ($cacheFileModifiedTime < stat($winConfiguration)->mtime) {
1924             return 1;
1925         }
1926     }
1927
1928     return 0;
1929 }
1930
1931 sub removeCMakeCache(@)
1932 {
1933     my (@buildArgs) = @_;
1934     if (shouldRemoveCMakeCache(@buildArgs)) {
1935         my $cmakeCache = cmakeCachePath();
1936         my $cmakeFiles = cmakeFilesPath();
1937         unlink($cmakeCache) if -e $cmakeCache;
1938         rmtree($cmakeFiles) if -d $cmakeFiles;
1939     }
1940 }
1941
1942 sub canUseNinja(@)
1943 {
1944     if (!defined($shouldNotUseNinja)) {
1945         $shouldNotUseNinja = checkForArgumentAndRemoveFromARGV("--no-ninja");
1946     }
1947
1948     if ($shouldNotUseNinja) {
1949         return 0;
1950     }
1951
1952     # Test both ninja and ninja-build. Fedora uses ninja-build and has patched CMake to also call ninja-build.
1953     return commandExists("ninja") || commandExists("ninja-build");
1954 }
1955
1956 sub canUseNinjaGenerator(@)
1957 {
1958     # Check that a Ninja generator is installed
1959     my $devnull = File::Spec->devnull();
1960     return exitStatus(system("cmake -N -G Ninja >$devnull 2>&1")) == 0;
1961 }
1962
1963 sub canUseEclipseNinjaGenerator(@)
1964 {
1965     # Check that eclipse and eclipse Ninja generator is installed
1966     my $devnull = File::Spec->devnull();
1967     return commandExists("eclipse") && exitStatus(system("cmake -N -G 'Eclipse CDT4 - Ninja' >$devnull 2>&1")) == 0;
1968 }
1969
1970 sub cmakeGeneratedBuildfile(@)
1971 {
1972     my ($willUseNinja) = @_;
1973     if ($willUseNinja) {
1974         return File::Spec->catfile(baseProductDir(), configuration(), "build.ninja")
1975     } elsif (isAnyWindows()) {
1976         return File::Spec->catfile(baseProductDir(), configuration(), "WebKit.sln")
1977     } else {
1978         return File::Spec->catfile(baseProductDir(), configuration(), "Makefile")
1979     }
1980 }
1981
1982 sub generateBuildSystemFromCMakeProject
1983 {
1984     my ($prefixPath, @cmakeArgs) = @_;
1985     my $config = configuration();
1986     my $port = cmakeBasedPortName();
1987     my $buildPath = File::Spec->catdir(baseProductDir(), $config);
1988     File::Path::mkpath($buildPath) unless -d $buildPath;
1989     my $originalWorkingDirectory = getcwd();
1990     chdir($buildPath) or die;
1991
1992     # We try to be smart about when to rerun cmake, so that we can have faster incremental builds.
1993     my $willUseNinja = canUseNinja() && canUseNinjaGenerator();
1994     if (-e cmakeCachePath() && -e cmakeGeneratedBuildfile($willUseNinja)) {
1995         return 0;
1996     }
1997
1998     my @args;
1999     push @args, "-DPORT=\"$port\"";
2000     push @args, "-DCMAKE_INSTALL_PREFIX=\"$prefixPath\"" if $prefixPath;
2001     push @args, "-DCMAKE_EXPORT_COMPILE_COMMANDS=ON";
2002     if ($config =~ /release/i) {
2003         push @args, "-DCMAKE_BUILD_TYPE=Release";
2004     } elsif ($config =~ /debug/i) {
2005         push @args, "-DCMAKE_BUILD_TYPE=Debug";
2006     }
2007
2008     if ($willUseNinja) {
2009         push @args, "-G";
2010         if (canUseEclipseNinjaGenerator()) {
2011             push @args, "'Eclipse CDT4 - Ninja'";
2012         } else {
2013             push @args, "Ninja";
2014         }
2015     } elsif (isAnyWindows() && isWin64()) {
2016         push @args, '-G "Visual Studio 14 2015 Win64"';
2017     }
2018     # Do not show progress of generating bindings in interactive Ninja build not to leave noisy lines on tty
2019     push @args, '-DSHOW_BINDINGS_GENERATION_PROGRESS=1' unless ($willUseNinja && -t STDOUT);
2020
2021     # Some ports have production mode, but build-webkit should always use developer mode.
2022     push @args, "-DDEVELOPER_MODE=ON" if isEfl() || isGtk() || isJSCOnly();
2023
2024     # Don't warn variables which aren't used by cmake ports.
2025     push @args, "--no-warn-unused-cli";
2026     push @args, @cmakeArgs if @cmakeArgs;
2027
2028     my $cmakeSourceDir = isCygwin() ? windowsSourceDir() : sourceDir();
2029     push @args, '"' . $cmakeSourceDir . '"';
2030
2031     # Compiler options to keep floating point values consistent
2032     # between 32-bit and 64-bit architectures.
2033     determineArchitecture();
2034     if ($architecture eq "i686" && !isCrossCompilation() && !isAnyWindows()) {
2035         $ENV{'CXXFLAGS'} = "-march=pentium4 -msse2 -mfpmath=sse " . ($ENV{'CXXFLAGS'} || "");
2036     }
2037
2038     # We call system("cmake @args") instead of system("cmake", @args) so that @args is
2039     # parsed for shell metacharacters.
2040     my $wrapper = join(" ", wrapperPrefixIfNeeded()) . " ";
2041     my $returnCode = systemVerbose($wrapper . "cmake @args");
2042
2043     chdir($originalWorkingDirectory);
2044     return $returnCode;
2045 }
2046
2047 sub buildCMakeGeneratedProject($)
2048 {
2049     my ($makeArgs) = @_;
2050     my $config = configuration();
2051     my $buildPath = File::Spec->catdir(baseProductDir(), $config);
2052     if (! -d $buildPath) {
2053         die "Must call generateBuildSystemFromCMakeProject() before building CMake project.";
2054     }
2055
2056     my $command = "cmake";
2057     my @args = ("--build", $buildPath, "--config", $config);
2058     push @args, ("--", $makeArgs) if $makeArgs;
2059
2060     # GTK and JSCOnly can use a build script to preserve colors and pretty-printing.
2061     if ((isGtk() || isJSCOnly()) && -e "$buildPath/build.sh") {
2062         chdir "$buildPath" or die;
2063         $command = "$buildPath/build.sh";
2064         @args = ($makeArgs);
2065     }
2066
2067     if ($ENV{VERBOSE} && canUseNinja()) {
2068         push @args, "-v";
2069         push @args, "-d keeprsp" if (version->parse(determineNinjaVersion()) >= version->parse("1.4.0"));
2070     }
2071
2072     # We call system("cmake @args") instead of system("cmake", @args) so that @args is
2073     # parsed for shell metacharacters. In particular, $makeArgs may contain such metacharacters.
2074     my $wrapper = join(" ", wrapperPrefixIfNeeded()) . " ";
2075     return systemVerbose($wrapper . "$command @args");
2076 }
2077
2078 sub cleanCMakeGeneratedProject()
2079 {
2080     my $config = configuration();
2081     my $buildPath = File::Spec->catdir(baseProductDir(), $config);
2082     if (-d $buildPath) {
2083         return systemVerbose("cmake", "--build", $buildPath, "--config", $config, "--target", "clean");
2084     }
2085     return 0;
2086 }
2087
2088 sub buildCMakeProjectOrExit($$$@)
2089 {
2090     my ($clean, $prefixPath, $makeArgs, @cmakeArgs) = @_;
2091     my $returnCode;
2092
2093     exit(exitStatus(cleanCMakeGeneratedProject())) if $clean;
2094
2095     if (isEfl() && checkForArgumentAndRemoveFromARGV("--update-efl")) {
2096         system("perl", "$sourceDir/Tools/Scripts/update-webkitefl-libs") == 0 or die $!;
2097     }
2098
2099     if (isGtk() && checkForArgumentAndRemoveFromARGV("--update-gtk")) {
2100         system("perl", "$sourceDir/Tools/Scripts/update-webkitgtk-libs") == 0 or die $!;
2101     }
2102
2103     $returnCode = exitStatus(generateBuildSystemFromCMakeProject($prefixPath, @cmakeArgs));
2104     exit($returnCode) if $returnCode;
2105
2106     $returnCode = exitStatus(buildCMakeGeneratedProject($makeArgs));
2107     exit($returnCode) if $returnCode;
2108     return 0;
2109 }
2110
2111 sub cmakeBasedPortArguments()
2112 {
2113     return ();
2114 }
2115
2116 sub cmakeBasedPortName()
2117 {
2118     return ucfirst portName();
2119 }
2120
2121 sub determineIsCMakeBuild()
2122 {
2123     return if defined($isCMakeBuild);
2124     $isCMakeBuild = checkForArgumentAndRemoveFromARGV("--cmake");
2125 }
2126
2127 sub isCMakeBuild()
2128 {
2129     return 1 unless isAppleCocoaWebKit();
2130     determineIsCMakeBuild();
2131     return $isCMakeBuild;
2132 }
2133
2134 sub promptUser
2135 {
2136     my ($prompt, $default) = @_;
2137     my $defaultValue = $default ? "[$default]" : "";
2138     print "$prompt $defaultValue: ";
2139     chomp(my $input = <STDIN>);
2140     return $input ? $input : $default;
2141 }
2142
2143 sub appleApplicationSupportPath
2144 {
2145     open INSTALL_DIR, "</proc/registry/HKEY_LOCAL_MACHINE/SOFTWARE/Apple\ Inc./Apple\ Application\ Support/InstallDir";
2146     my $path = <INSTALL_DIR>;
2147     $path =~ s/[\r\n\x00].*//;
2148     close INSTALL_DIR;
2149
2150     my $unixPath = `cygpath -u '$path'`;
2151     chomp $unixPath;
2152     return $unixPath;
2153 }
2154
2155 sub setPathForRunningWebKitApp
2156 {
2157     my ($env) = @_;
2158
2159     if (isAnyWindows()) {
2160         my $productBinaryDir = executableProductDir();
2161         if (isAppleWinWebKit()) {
2162             $env->{PATH} = join(':', $productBinaryDir, appleApplicationSupportPath(), $env->{PATH} || "");
2163         } elsif (isWinCairo()) {
2164             my $winCairoBin = sourceDir() . "/WebKitLibraries/win/" . (isWin64() ? "bin64/" : "bin32/");
2165             my $gstreamerBin = isWin64() ? $ENV{"GSTREAMER_1_0_ROOT_X86_64"} . "bin" : $ENV{"GSTREAMER_1_0_ROOT_X86"} . "bin";
2166             $env->{PATH} = join(':', $productBinaryDir, $winCairoBin, $gstreamerBin, $env->{PATH} || "");
2167         }
2168     }
2169 }
2170
2171 sub printHelpAndExitForRunAndDebugWebKitAppIfNeeded
2172 {
2173     return unless checkForArgumentAndRemoveFromARGV("--help");
2174
2175     print STDERR <<EOF;
2176 Usage: @{[basename($0)]} [options] [args ...]
2177   --help                            Show this help message
2178   --no-saved-state                  Launch the application without state restoration
2179
2180 Options specific to macOS:
2181   -g|--guard-malloc                 Enable Guard Malloc
2182   --lang=LANGUAGE                   Use a specific language instead of system language.
2183                                     This accepts a language name (German) or a language code (de, ar, pt_BR, etc).
2184   --locale=LOCALE                   Use a specific locale instead of the system region.
2185 EOF
2186
2187     exit(1);
2188 }
2189
2190 sub argumentsForRunAndDebugMacWebKitApp()
2191 {
2192     my @args = ();
2193     if (checkForArgumentAndRemoveFromARGV("--no-saved-state")) {
2194         push @args, ("-ApplePersistenceIgnoreStateQuietly", "YES");
2195         # FIXME: Don't set ApplePersistenceIgnoreState once all supported OS versions respect ApplePersistenceIgnoreStateQuietly (rdar://15032886).
2196         push @args, ("-ApplePersistenceIgnoreState", "YES");
2197     }
2198
2199     my $lang;
2200     if (checkForArgumentAndRemoveFromARGVGettingValue("--lang", \$lang)) {
2201         push @args, ("-AppleLanguages", "(" . $lang . ")");
2202     }
2203
2204     my $locale;
2205     if (checkForArgumentAndRemoveFromARGVGettingValue("--locale", \$locale)) {
2206         push @args, ("-AppleLocale", $locale);
2207     }
2208
2209     unshift @args, @ARGV;
2210
2211     return @args;
2212 }
2213
2214 sub setupMacWebKitEnvironment($)
2215 {
2216     my ($dyldFrameworkPath) = @_;
2217
2218     $dyldFrameworkPath = File::Spec->rel2abs($dyldFrameworkPath);
2219
2220     prependToEnvironmentVariableList("DYLD_FRAMEWORK_PATH", $dyldFrameworkPath);
2221     prependToEnvironmentVariableList("__XPC_DYLD_FRAMEWORK_PATH", $dyldFrameworkPath);
2222     prependToEnvironmentVariableList("DYLD_LIBRARY_PATH", $dyldFrameworkPath);
2223     prependToEnvironmentVariableList("__XPC_DYLD_LIBRARY_PATH", $dyldFrameworkPath);
2224     $ENV{WEBKIT_UNSET_DYLD_FRAMEWORK_PATH} = "YES";
2225
2226     setUpGuardMallocIfNeeded();
2227 }
2228
2229 sub setupIOSWebKitEnvironment($)
2230 {
2231     my ($dyldFrameworkPath) = @_;
2232     $dyldFrameworkPath = File::Spec->rel2abs($dyldFrameworkPath);
2233
2234     prependToEnvironmentVariableList("DYLD_FRAMEWORK_PATH", $dyldFrameworkPath);
2235     prependToEnvironmentVariableList("DYLD_LIBRARY_PATH", $dyldFrameworkPath);
2236
2237     setUpGuardMallocIfNeeded();
2238 }
2239
2240 sub iosSimulatorApplicationsPath()
2241 {
2242     return File::Spec->catdir(XcodeSDKPath(), "Applications");
2243 }
2244
2245 sub installedMobileSafariBundle()
2246 {
2247     return File::Spec->catfile(iosSimulatorApplicationsPath(), "MobileSafari.app");
2248 }
2249
2250 sub mobileSafariBundle()
2251 {
2252     determineConfigurationProductDir();
2253
2254     # Use MobileSafari.app in product directory if present.
2255     if (isAppleCocoaWebKit() && -d "$configurationProductDir/MobileSafari.app") {
2256         return "$configurationProductDir/MobileSafari.app";
2257     }
2258     return installedMobileSafariBundle();
2259 }
2260
2261 sub plistPathFromBundle($)
2262 {
2263     my ($appBundle) = @_;
2264     return "$appBundle/Info.plist" if -f "$appBundle/Info.plist"; # iOS app bundle
2265     return "$appBundle/Contents/Info.plist" if -f "$appBundle/Contents/Info.plist"; # Mac app bundle
2266     return "";
2267 }
2268
2269 sub appIdentifierFromBundle($)
2270 {
2271     my ($appBundle) = @_;
2272     my $plistPath = File::Spec->rel2abs(plistPathFromBundle($appBundle)); # defaults(1) will complain if the specified path is not absolute.
2273     chomp(my $bundleIdentifier = `defaults read '$plistPath' CFBundleIdentifier 2> /dev/null`);
2274     return $bundleIdentifier;
2275 }
2276
2277 sub appDisplayNameFromBundle($)
2278 {
2279     my ($appBundle) = @_;
2280     my $plistPath = File::Spec->rel2abs(plistPathFromBundle($appBundle)); # defaults(1) will complain if the specified path is not absolute.
2281     chomp(my $bundleDisplayName = `defaults read '$plistPath' CFBundleDisplayName 2> /dev/null`);
2282     return $bundleDisplayName;
2283 }
2284
2285 sub waitUntilIOSSimulatorDeviceIsInState($$)
2286 {
2287     my ($deviceUDID, $waitUntilState) = @_;
2288     my $device = iosSimulatorDeviceByUDID($deviceUDID);
2289     # FIXME: We should add a maximum time limit to wait here.
2290     while ($device->{state} ne $waitUntilState) {
2291         usleep(500 * 1000); # Waiting 500ms between file system polls does not make script run-safari feel sluggish.
2292         $device = iosSimulatorDeviceByUDID($deviceUDID);
2293     }
2294 }
2295
2296 sub shutDownIOSSimulatorDevice($)
2297 {
2298     my ($simulatorDevice) = @_;
2299     system("xcrun --sdk iphonesimulator simctl shutdown $simulatorDevice->{UDID} > /dev/null 2>&1");
2300 }
2301
2302 sub restartIOSSimulatorDevice($)
2303 {
2304     my ($simulatorDevice) = @_;
2305     shutDownIOSSimulatorDevice($simulatorDevice);
2306
2307     exitStatus(system("xcrun", "--sdk", "iphonesimulator", "simctl", "boot", $simulatorDevice->{UDID})) == 0 or die "Failed to boot simulator device $simulatorDevice->{UDID}";
2308 }
2309
2310 sub relaunchIOSSimulator($)
2311 {
2312     my ($simulatedDevice) = @_;
2313     quitIOSSimulator($simulatedDevice->{UDID});
2314
2315     # FIXME: <rdar://problem/20916140> Switch to using CoreSimulator.framework for launching and quitting iOS Simulator
2316     chomp(my $developerDirectory = $ENV{DEVELOPER_DIR} || `xcode-select --print-path`); 
2317     my $iosSimulatorPath = File::Spec->catfile($developerDirectory, "Applications", "Simulator.app"); 
2318     system("open", "-a", $iosSimulatorPath, "--args", "-CurrentDeviceUDID", $simulatedDevice->{UDID}) == 0 or die "Failed to open $iosSimulatorPath: $!"; 
2319
2320     waitUntilIOSSimulatorDeviceIsInState($simulatedDevice->{UDID}, SIMULATOR_DEVICE_STATE_BOOTED);
2321 }
2322
2323 sub quitIOSSimulator(;$)
2324 {
2325     my ($waitForShutdownOfSimulatedDeviceUDID) = @_;
2326     # FIXME: <rdar://problem/20916140> Switch to using CoreSimulator.framework for launching and quitting iOS Simulator
2327     if (exitStatus(system {"osascript"} "osascript", "-e", 'tell application id "com.apple.iphonesimulator" to quit')) {
2328         # osascript returns a non-zero exit status if Simulator.app is not registered in LaunchServices.
2329         return;
2330     }
2331
2332     if (!defined($waitForShutdownOfSimulatedDeviceUDID)) {
2333         return;
2334     }
2335     # FIXME: We assume that $waitForShutdownOfSimulatedDeviceUDID was not booted using the simctl command line tool.
2336     #        Otherwise we will spin indefinitely since quiting the iOS Simulator will not shutdown this device. We
2337     #        should add a maximum time limit to wait for a device to shutdown and either return an error or die()
2338     #        on expiration of the time limit.
2339     waitUntilIOSSimulatorDeviceIsInState($waitForShutdownOfSimulatedDeviceUDID, SIMULATOR_DEVICE_STATE_SHUTDOWN);
2340 }
2341
2342 sub iosSimulatorDeviceByName($)
2343 {
2344     my ($simulatorName) = @_;
2345     my $simulatorRuntime = iosSimulatorRuntime();
2346     my @devices = iOSSimulatorDevices();
2347     for my $device (@devices) {
2348         if ($device->{name} eq $simulatorName && $device->{runtime} eq $simulatorRuntime) {
2349             return $device;
2350         }
2351     }
2352     return undef;
2353 }
2354
2355 sub iosSimulatorDeviceByUDID($)
2356 {
2357     my ($simulatedDeviceUDID) = @_;
2358     my $devicePlistPath = File::Spec->catfile(iOSSimulatorDevicesPath(), $simulatedDeviceUDID, "device.plist");
2359     if (!-f $devicePlistPath) {
2360         return;
2361     }
2362     # FIXME: We should parse the device.plist file ourself and map the dictionary keys in it to known
2363     #        dictionary keys so as to decouple our representation of the plist from the actual structure
2364     #        of the plist, which may change.
2365     eval "require Foundation";
2366     return Foundation::perlRefFromObjectRef(NSDictionary->dictionaryWithContentsOfFile_($devicePlistPath));
2367 }
2368
2369 sub iosSimulatorRuntime()
2370 {
2371     my $xcodeSDKVersion = xcodeSDKVersion();
2372     $xcodeSDKVersion =~ s/\./-/;
2373     return "com.apple.CoreSimulator.SimRuntime.iOS-$xcodeSDKVersion";
2374 }
2375
2376 sub findOrCreateSimulatorForIOSDevice($)
2377 {
2378     my ($simulatorNameSuffix) = @_;
2379     my $simulatorName;
2380     my $simulatorDeviceType;
2381     if (architecture() eq "x86_64") {
2382         $simulatorName = "iPhone 5s " . $simulatorNameSuffix;
2383         $simulatorDeviceType = "com.apple.CoreSimulator.SimDeviceType.iPhone-5s";
2384     } else {
2385         $simulatorName = "iPhone 5 " . $simulatorNameSuffix;
2386         $simulatorDeviceType = "com.apple.CoreSimulator.SimDeviceType.iPhone-5";
2387     }
2388     my $simulatedDevice = iosSimulatorDeviceByName($simulatorName);
2389     return $simulatedDevice if $simulatedDevice;
2390     return createiOSSimulatorDevice($simulatorName, $simulatorDeviceType, iosSimulatorRuntime());
2391 }
2392
2393 sub isIOSSimulatorSystemInstalledApp($)
2394 {
2395     my ($appBundle) = @_;
2396     my $simulatorApplicationsPath = realpath(iosSimulatorApplicationsPath());
2397     return substr(realpath($appBundle), 0, length($simulatorApplicationsPath)) eq $simulatorApplicationsPath;
2398 }
2399
2400 sub hasUserInstalledAppInSimulatorDevice($$)
2401 {
2402     my ($appIdentifier, $simulatedDeviceUDID) = @_;
2403     my $userInstalledAppPath = File::Spec->catfile($ENV{HOME}, "Library", "Developer", "CoreSimulator", "Devices", $simulatedDeviceUDID, "data", "Containers", "Bundle", "Application");
2404     if (!-d $userInstalledAppPath) {
2405         return 0; # No user installed apps.
2406     }
2407     local @::userInstalledAppBundles;
2408     my $wantedFunction = sub {
2409         my $file = $_;
2410
2411         # Ignore hidden files and directories.
2412         if ($file =~ /^\../) {
2413             $File::Find::prune = 1;
2414             return;
2415         }
2416
2417         return if !-d $file || $file !~ /\.app$/;
2418         push @::userInstalledAppBundles, $File::Find::name;
2419         $File::Find::prune = 1; # Do not traverse contents of app bundle.
2420     };
2421     find($wantedFunction, $userInstalledAppPath);
2422     for my $userInstalledAppBundle (@::userInstalledAppBundles) {
2423         if (appIdentifierFromBundle($userInstalledAppBundle) eq $appIdentifier) {
2424             return 1; # Has user installed app.
2425         }
2426     }
2427     return 0; # Does not have user installed app.
2428 }
2429
2430 sub isSimulatorDeviceBooted($)
2431 {
2432     my ($simulatedDeviceUDID) = @_;
2433     my $device = iosSimulatorDeviceByUDID($simulatedDeviceUDID);
2434     return $device && $device->{state} eq SIMULATOR_DEVICE_STATE_BOOTED;
2435 }
2436
2437 sub runIOSWebKitAppInSimulator($;$)
2438 {
2439     my ($appBundle, $simulatorOptions) = @_;
2440     my $productDir = productDir();
2441     my $appDisplayName = appDisplayNameFromBundle($appBundle);
2442     my $appIdentifier = appIdentifierFromBundle($appBundle);
2443     my $simulatedDevice = findOrCreateSimulatorForIOSDevice(SIMULATOR_DEVICE_SUFFIX_FOR_WEBKIT_DEVELOPMENT);
2444     my $simulatedDeviceUDID = $simulatedDevice->{UDID};
2445
2446     my $willUseSystemInstalledApp = isIOSSimulatorSystemInstalledApp($appBundle);
2447     if ($willUseSystemInstalledApp) {
2448         if (hasUserInstalledAppInSimulatorDevice($appIdentifier, $simulatedDeviceUDID)) {
2449             # Restore the system-installed app in the simulator device corresponding to $appBundle as it
2450             # was previously overwritten with a custom built version of the app.
2451             # FIXME: Only restore the system-installed version of the app instead of erasing all contents and settings.
2452             print "Quitting iOS Simulator...\n";
2453             quitIOSSimulator($simulatedDeviceUDID);
2454             print "Erasing contents and settings for simulator device \"$simulatedDevice->{name}\".\n";
2455             exitStatus(system("xcrun", "--sdk", "iphonesimulator", "simctl", "erase", $simulatedDeviceUDID)) == 0 or die;
2456         }
2457         # FIXME: We assume that if $simulatedDeviceUDID is not booted then iOS Simulator is not open. However
2458         #        $simulatedDeviceUDID may have been booted using the simctl command line tool. If $simulatedDeviceUDID
2459         #        was booted using simctl then we should shutdown the device and launch iOS Simulator to boot it again.
2460         if (!isSimulatorDeviceBooted($simulatedDeviceUDID)) {
2461             print "Launching iOS Simulator...\n";
2462             relaunchIOSSimulator($simulatedDevice);
2463         }
2464     } else {
2465         # FIXME: We should killall(1) any running instances of $appBundle before installing it to ensure
2466         #        that simctl launch opens the latest installed version of the app. For now we quit and
2467         #        launch the iOS Simulator again to ensure there are no running instances of $appBundle.
2468         print "Quitting and launching iOS Simulator...\n";
2469         relaunchIOSSimulator($simulatedDevice);
2470
2471         print "Installing $appBundle.\n";
2472         # Install custom built app, overwriting an app with the same app identifier if one exists.
2473         exitStatus(system("xcrun", "--sdk", "iphonesimulator", "simctl", "install", $simulatedDeviceUDID, $appBundle)) == 0 or die;
2474
2475     }
2476
2477     $simulatorOptions = {} unless $simulatorOptions;
2478
2479     my %simulatorENV;
2480     %simulatorENV = %{$simulatorOptions->{applicationEnvironment}} if $simulatorOptions->{applicationEnvironment};
2481     {
2482         local %ENV; # Shadow global-scope %ENV so that changes to it will not be seen outside of this scope.
2483         setupIOSWebKitEnvironment($productDir);
2484         %simulatorENV = %ENV;
2485     }
2486     my $applicationArguments = \@ARGV;
2487     $applicationArguments = $simulatorOptions->{applicationArguments} if $simulatorOptions && $simulatorOptions->{applicationArguments};
2488
2489     # Prefix the environment variables with SIMCTL_CHILD_ per `xcrun simctl help launch`.
2490     foreach my $key (keys %simulatorENV) {
2491         $ENV{"SIMCTL_CHILD_$key"} = $simulatorENV{$key};
2492     }
2493
2494     print "Starting $appDisplayName with DYLD_FRAMEWORK_PATH set to point to built WebKit in $productDir.\n";
2495     return exitStatus(system("xcrun", "--sdk", "iphonesimulator", "simctl", "launch", $simulatedDeviceUDID, $appIdentifier, @$applicationArguments));
2496 }
2497
2498 sub runIOSWebKitApp($)
2499 {
2500     my ($appBundle) = @_;
2501     if (willUseIOSDeviceSDK()) {
2502         die "Only running Safari in iOS Simulator is supported now.";
2503     }
2504     if (willUseIOSSimulatorSDK()) {
2505         return runIOSWebKitAppInSimulator($appBundle);
2506     }
2507     die "Not using an iOS SDK."
2508 }
2509
2510 sub archCommandLineArgumentsForRestrictedEnvironmentVariables()
2511 {
2512     my @arguments = ();
2513     foreach my $key (keys(%ENV)) {
2514         if ($key =~ /^DYLD_/) {
2515             push @arguments, "-e", "$key=$ENV{$key}";
2516         }
2517     }
2518     return @arguments;
2519 }
2520
2521 sub runMacWebKitApp($;$)
2522 {
2523     my ($appPath, $useOpenCommand) = @_;
2524     my $productDir = productDir();
2525     print "Starting @{[basename($appPath)]} with DYLD_FRAMEWORK_PATH set to point to built WebKit in $productDir.\n";
2526
2527     local %ENV = %ENV;
2528     setupMacWebKitEnvironment($productDir);
2529
2530     if (defined($useOpenCommand) && $useOpenCommand == USE_OPEN_COMMAND) {
2531         return system("open", "-W", "-a", $appPath, "--args", argumentsForRunAndDebugMacWebKitApp());
2532     }
2533     if (architecture()) {
2534         return system "arch", "-" . architecture(), archCommandLineArgumentsForRestrictedEnvironmentVariables(), $appPath, argumentsForRunAndDebugMacWebKitApp();
2535     }
2536     return system { $appPath } $appPath, argumentsForRunAndDebugMacWebKitApp();
2537 }
2538
2539 sub execMacWebKitAppForDebugging($)
2540 {
2541     my ($appPath) = @_;
2542     my $architectureSwitch = "--arch";
2543     my $argumentsSeparator = "--";
2544
2545     my $debuggerPath = `xcrun -find lldb`;
2546     chomp $debuggerPath;
2547     die "Can't find the lldb executable.\n" unless -x $debuggerPath;
2548
2549     my $productDir = productDir();
2550     setupMacWebKitEnvironment($productDir);
2551
2552     my @architectureFlags = ($architectureSwitch, architecture());
2553     print "Starting @{[basename($appPath)]} under lldb with DYLD_FRAMEWORK_PATH set to point to built WebKit in $productDir.\n";
2554     exec { $debuggerPath } $debuggerPath, @architectureFlags, $argumentsSeparator, $appPath, argumentsForRunAndDebugMacWebKitApp() or die;
2555 }
2556
2557 sub debugSafari
2558 {
2559     if (isAppleCocoaWebKit()) {
2560         checkFrameworks();
2561         execMacWebKitAppForDebugging(safariPath());
2562     }
2563
2564     return 1; # Unsupported platform; can't debug Safari on this platform.
2565 }
2566
2567 sub runSafari
2568 {
2569     if (isIOSWebKit()) {
2570         return runIOSWebKitApp(mobileSafariBundle());
2571     }
2572
2573     if (isAppleCocoaWebKit()) {
2574         return runMacWebKitApp(safariPath());
2575     }
2576
2577     if (isAppleWinWebKit()) {
2578         my $result;
2579         my $webKitLauncherPath = File::Spec->catfile(executableProductDir(), "MiniBrowser.exe");
2580         return system { $webKitLauncherPath } $webKitLauncherPath, @ARGV;
2581     }
2582
2583     return 1; # Unsupported platform; can't run Safari on this platform.
2584 }
2585
2586 sub runMiniBrowser
2587 {
2588     if (isAppleCocoaWebKit()) {
2589         return runMacWebKitApp(File::Spec->catfile(productDir(), "MiniBrowser.app", "Contents", "MacOS", "MiniBrowser"));
2590     } elsif (isAppleWinWebKit()) {
2591         my $result;
2592         my $webKitLauncherPath = File::Spec->catfile(executableProductDir(), "MiniBrowser.exe");
2593         return system { $webKitLauncherPath } $webKitLauncherPath, @ARGV;
2594     }
2595
2596     return 1;
2597 }
2598
2599 sub debugMiniBrowser
2600 {
2601     if (isAppleCocoaWebKit()) {
2602         execMacWebKitAppForDebugging(File::Spec->catfile(productDir(), "MiniBrowser.app", "Contents", "MacOS", "MiniBrowser"));
2603     }
2604     
2605     return 1;
2606 }
2607
2608 sub runWebKitTestRunner
2609 {
2610     if (isAppleCocoaWebKit()) {
2611         return runMacWebKitApp(File::Spec->catfile(productDir(), "WebKitTestRunner"));
2612     }
2613
2614     return 1;
2615 }
2616
2617 sub debugWebKitTestRunner
2618 {
2619     if (isAppleCocoaWebKit()) {
2620         execMacWebKitAppForDebugging(File::Spec->catfile(productDir(), "WebKitTestRunner"));
2621     }
2622
2623     return 1;
2624 }
2625
2626 sub readRegistryString
2627 {
2628     my ($valueName) = @_;
2629     chomp(my $string = `regtool --wow32 get "$valueName"`);
2630     return $string;
2631 }
2632
2633 sub writeRegistryString
2634 {
2635     my ($valueName, $string) = @_;
2636
2637     my $error = system "regtool", "--wow32", "set", "-s", $valueName, $string;
2638
2639     # On Windows Vista/7 with UAC enabled, regtool will fail to modify the registry, but will still
2640     # return a successful exit code. So we double-check here that the value we tried to write to the
2641     # registry was really written.
2642     return !$error && readRegistryString($valueName) eq $string;
2643 }
2644
2645 sub formatBuildTime($)
2646 {
2647     my ($buildTime) = @_;
2648
2649     my $buildHours = int($buildTime / 3600);
2650     my $buildMins = int(($buildTime - $buildHours * 3600) / 60);
2651     my $buildSecs = $buildTime - $buildHours * 3600 - $buildMins * 60;
2652
2653     if ($buildHours) {
2654         return sprintf("%dh:%02dm:%02ds", $buildHours, $buildMins, $buildSecs);
2655     }
2656     return sprintf("%02dm:%02ds", $buildMins, $buildSecs);
2657 }
2658
2659 sub runSvnUpdateAndResolveChangeLogs(@)
2660 {
2661     my @svnOptions = @_;
2662     my $openCommand = "svn update " . join(" ", @svnOptions);
2663     open my $update, "$openCommand |" or die "cannot execute command $openCommand";
2664     my @conflictedChangeLogs;
2665     while (my $line = <$update>) {
2666         print $line;
2667         $line =~ m/^C\s+(.+?)[\r\n]*$/;
2668         if ($1) {
2669           my $filename = normalizePath($1);
2670           push @conflictedChangeLogs, $filename if basename($filename) eq "ChangeLog";
2671         }
2672     }
2673     close $update or die;
2674
2675     if (@conflictedChangeLogs) {
2676         print "Attempting to merge conflicted ChangeLogs.\n";
2677         my $resolveChangeLogsPath = File::Spec->catfile(sourceDir(), "Tools", "Scripts", "resolve-ChangeLogs");
2678         (system($resolveChangeLogsPath, "--no-warnings", @conflictedChangeLogs) == 0)
2679             or die "Could not open resolve-ChangeLogs script: $!.\n";
2680     }
2681 }
2682
2683 sub runGitUpdate()
2684 {
2685     # Doing a git fetch first allows setups with svn-remote.svn.fetch = trunk:refs/remotes/origin/master
2686     # to perform the rebase much much faster.
2687     system("git", "fetch");
2688     if (isGitSVNDirectory(".")) {
2689         system("git", "svn", "rebase") == 0 or die;
2690     } else {
2691         # This will die if branch.$BRANCHNAME.merge isn't set, which is
2692         # almost certainly what we want.
2693         system("git", "pull") == 0 or die;
2694     }
2695 }
2696
2697 1;