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