Tools/Scripts/webkitdirs.pm

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