Update tools and configurations after renaming Source/WebKit to Source/WebKitLegacy.
[WebKit-https.git] / Tools / Scripts / build-webkit
1 #!/usr/bin/perl -w
2
3 # Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 Apple Inc. All rights reserved.
4 # Copyright (C) 2009 Google Inc. All rights reserved.
5 # Copyright (C) 2010 moiji-mobile.com All rights reserved.
6 # Copyright (C) 2011 Research In Motion Limited. All rights reserved.
7 # Copyright (C) 2013 Nokia Corporation and/or its subsidiary(-ies).
8 #
9 # Redistribution and use in source and binary forms, with or without
10 # modification, are permitted provided that the following conditions
11 # are met:
12 #
13 # 1.  Redistributions of source code must retain the above copyright
14 #     notice, this list of conditions and the following disclaimer. 
15 # 2.  Redistributions in binary form must reproduce the above copyright
16 #     notice, this list of conditions and the following disclaimer in the
17 #     documentation and/or other materials provided with the distribution. 
18 # 3.  Neither the name of Apple Inc. ("Apple") nor the names of
19 #     its contributors may be used to endorse or promote products derived
20 #     from this software without specific prior written permission. 
21 #
22 # THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
23 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25 # DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
26 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
29 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32
33 # Build script wrapper for the WebKit Open Source Project.
34
35 use strict;
36 use File::Basename;
37 use File::Find;
38 use File::Spec;
39 use FindBin;
40 use Getopt::Long qw(:config pass_through no_auto_abbrev);
41 use lib $FindBin::Bin;
42 use webkitdirs;
43 use List::Util qw(first);
44 use webkitperl::FeatureList qw(getFeatureOptionList);
45 use POSIX;
46
47 sub cMakeArgsFromFeatures();
48 sub writeCongrats();
49
50 my $originalWorkingDirectory = getcwd();
51 chdirWebKit();
52
53 my $showHelp = 0;
54 my $clean = 0;
55 my $defaultCMakeFeatures = 0;
56 my $minimal = 0;
57 my $installHeaders;
58 my $installLibs;
59 my $prefixPath;
60 my $makeArgs = "";
61 my @cmakeArgs;
62 my $onlyWebKitProject = 0;
63 my $coverageSupport = 0;
64 my $shouldRunStaticAnalyzer = 0;
65 my $startTime = time();
66 my $archs32bit = 0;
67
68 my @features = getFeatureOptionList();
69
70 # Additional environment parameters
71 push @ARGV, split(/ /, $ENV{'BUILD_WEBKIT_ARGS'}) if ($ENV{'BUILD_WEBKIT_ARGS'});
72
73 # Initialize values from defaults
74 foreach (@ARGV) {
75     if ($_ eq '--minimal') {
76         $minimal = 1;
77     } elsif ($_ eq 'ARCHS=i386' or $_ eq 'ARCHS=armv7' or $_ eq 'ARCHS=armv7s') {
78         $archs32bit = 1;
79     }
80 }
81
82 # Initialize values from defaults
83 foreach (@features) {
84     ${$_->{value}} = ($minimal ? 0 : $_->{default});
85 }
86
87 my $programName = basename($0);
88 my $usage = <<EOF;
89 Usage: $programName [options] [options to pass to build system]
90   --help                            Show this help message
91   --clean                           Cleanup the build directory
92   --debug                           Compile with Debug configuration
93   --release                         Compile with Release configuration
94   --sdk=<sdk>                       Use a specific Xcode SDK (iOS and Mac only)
95   --ios-device                      Use "iphoneos.internal" SDK if installed, else "iphoneos" SDK (iOS only)
96   --device                          DEPRECATED alias of --ios-device
97   --ios-simulator                   Use the current iphonesimulator SDK (iOS only)
98   --simulator                       DEPRECATED alias of --ios-simulator
99   --coverage                        Enable code coverage support (Mac only)
100   --analyze                         Enable static anaylsis (iOS and Mac only)
101
102   --gtk                             Build the GTK+ port
103   --wpe                             Build the WPE port
104   --wincairo                        Build using Cairo (rather than CoreGraphics) on Windows
105
106   --inspector-frontend              Copy Web Inspector user interface resources to the build directory
107
108   --prefix=<path>                   Set installation prefix to the given path (Gtk/Efl only)
109   --makeargs=<arguments>            Optional Makefile flags
110   --cmakeargs=<arguments>           One or more optional CMake flags (e.g. --cmakeargs="-DFOO=bar -DCMAKE_PREFIX_PATH=/usr/local")
111
112   --minimal                         No optional features, unless explicitly enabled
113   --default-cmake-features          Use the default CMake features enabled for the port (CMake based ports)
114
115   --only-webkit                     Build only the WebKit project
116
117 EOF
118
119 my %options = (
120     'help' => \$showHelp,
121     'clean' => \$clean,
122     'install-headers=s' => \$installHeaders,
123     'install-libs=s' => \$installLibs,
124     'prefix=s' => \$prefixPath,
125     'makeargs=s' => \$makeArgs,
126     'cmakeargs=s' => \@cmakeArgs,
127     'minimal' => \$minimal,
128     'only-webkit' => \$onlyWebKitProject,
129     'coverage' => \$coverageSupport,
130     'analyze' => \$shouldRunStaticAnalyzer,
131     'default-cmake-features' => \$defaultCMakeFeatures,
132 );
133
134 # Build usage text and options list from features
135 foreach (@features) {
136     my $opt = sprintf("%-35s", "  --[no-]$_->{option}");
137     $usage .= "$opt $_->{desc} (default: $_->{default})\n";
138     $options{"$_->{option}!"} = $_->{value};
139 }
140
141 GetOptions(%options);
142
143 if ($showHelp) {
144    print STDERR $usage;
145    exit 1;
146 }
147
148 checkRequiredSystemConfig();
149 setConfiguration();
150
151 my $productDir = productDir();
152
153 # Check that all the project directories are there.
154 my @projects = ("Source/JavaScriptCore", "Source/WebCore", "Source/WebKitLegacy");
155
156 # Build WTF as a separate static library on ports which support it.
157 splice @projects, 0, 0, "Source/WTF" if isAppleWebKit() or isWinCairo();
158
159 splice @projects, 0, 0, "Source/bmalloc" if isAppleCocoaWebKit();
160
161 # Ports using CMake will check if directories exist in the CMake configuration.
162 if (!isCMakeBuild()) {
163     for my $dir (@projects) {
164         if (! -d $dir) {
165             die "Error: No $dir directory found. Please do a fresh checkout.\n";
166         }
167     }
168 }
169
170 if ((isAppleWebKit() || isWinCairo()) && !-d "WebKitLibraries") {
171     die "Error: No WebKitLibraries directory found. Please do a fresh checkout.\n";
172 }
173
174 my @options = ();
175
176 if (isAppleCocoaWebKit()) {
177     push @options, XcodeOptions();
178     sub option($$$)
179     {
180         my ($feature, $isEnabled, $defaultValue) = @_;
181         return "" if $defaultValue == $isEnabled;
182         return $feature . "=" . ($isEnabled ? $feature : "");
183     }
184
185     foreach (@features) {
186         my $option = option($_->{define}, ${$_->{value}}, $_->{default});
187         push @options, $option unless $option eq "";
188     }
189
190     # ANGLE and libwebrtc must come before WebCore
191     splice @projects, 0, 0, ("Source/ThirdParty/ANGLE");
192     if (not $archs32bit and ((portName() eq Mac and not architecture() eq "i386") or 
193         (portName() eq iOS and (architecture() eq "arm64" or architecture() eq "x86_64")))) {
194         splice @projects, 0, 0, ("Source/ThirdParty/libwebrtc");
195     }
196
197     push @projects, ("Source/WebKit2");
198
199     if (!isIOSWebKit()) {
200         push @projects, ("Tools/MiniBrowser");
201
202         # WebInspectorUI must come after JavaScriptCore and WebCore but before WebKit and WebKit2
203         my $webKitIndex = first { $projects[$_] eq "Source/WebKitLegacy" } 0..$#projects;
204         splice(@projects, $webKitIndex, 0, "Source/WebInspectorUI");
205
206         # Copy library and header from WebKitLibraries to a findable place in the product directory.
207         my @copyLibrariesArgs = ("perl", "Tools/Scripts/copy-webkitlibraries-to-product-directory", "--wksi",  productDir());
208         print(join(" ", @copyLibrariesArgs) . "\n");
209         (system(@copyLibrariesArgs) == 0) or die;
210     } else {
211         my @copyLibrariesArgs = ("perl", "Tools/Scripts/copy-webkitlibraries-to-product-directory", "--sdk", xcodeSDK(), "--wksi");
212         push @copyLibrariesArgs, productDir();
213         print(join(" ", @copyLibrariesArgs) . "\n");
214         (system(@copyLibrariesArgs) == 0) or die;
215     }
216
217     # Build Tools needed for Apple ports
218     push @projects, ("Tools/DumpRenderTree", "Tools/WebKitTestRunner", "Source/ThirdParty/gtest", "Tools/TestWebKitAPI");
219
220 } elsif (isWinCairo()) {
221     (system("perl Tools/Scripts/update-webkit-wincairo-libs") == 0) or die;
222 } elsif (isAppleWinWebKit()) {
223     # Copy WebKitSupportLibrary to the correct location in WebKitLibraries so it can be found.
224     # Will fail if WebKitSupportLibrary.zip is not in source root.
225     (system("perl Tools/Scripts/update-webkit-support-libs") == 0) or die;
226 }
227
228 # If asked to build just the WebKit project, overwrite the projects
229 # list after all of the port specific tweaks have been made to
230 # build options, etc.
231 @projects = ("Source/WebKitLegacy") if $onlyWebKitProject;
232
233 my $result = 0;
234
235 if (isInspectorFrontend()) {
236     die "The --inspector-frontend option is not supported for CMake-based builds." if isCMakeBuild();
237     @projects = ("Source/WebInspectorUI");
238 }
239
240 if (isCMakeBuild() && !isAnyWindows()) {
241
242     # By default we build using all of the available CPUs.
243     $makeArgs .= ($makeArgs ? " " : "") . "-j" . numberOfCPUs() if $makeArgs !~ /-j\s*\d+/;
244     my $maxCPULoad = maxCPULoad() if $makeArgs !~ /-l\s*\d+\.?\d*/;
245     $makeArgs .= " -l" . maxCPULoad() if defined $maxCPULoad;
246
247     # We remove CMakeCache to avoid the bots to reuse cached flags when
248     # we enable new features. This forces a reconfiguration.
249     my @featureArgs = cMakeArgsFromFeatures();
250     removeCMakeCache(@featureArgs);
251
252     buildCMakeProjectOrExit($clean, $prefixPath, $makeArgs, (cmakeBasedPortArguments(), @featureArgs), @cmakeArgs);
253 }
254
255 my $baseProductDir = baseProductDir();
256 if (isAppleWinWebKit() || isWinCairo()) {
257     my @featureArgs = cMakeArgsFromFeatures();
258     removeCMakeCache(@featureArgs);
259
260     chdirWebKit();
261     if (exitStatus(generateBuildSystemFromCMakeProject($prefixPath, @cmakeArgs))) {
262         die "Run \"C:/Program Files (x86)/Microsoft Visual Studio 14.0/VC/vcvarsall.bat\" before build-webkit when using ninja";
263     }
264     chdirWebKit();
265     if (canUseNinja()) {
266         chdir File::Spec->catdir($baseProductDir, configuration());
267         $result = system("ninja");
268     } else {
269         $result = buildVisualStudioProject(File::Spec->catfile($baseProductDir, configuration(), "WebKit.sln"), $clean);
270     }
271     if (exitStatus($result)) {
272         my $scriptDir = relativeScriptsDir();
273         if (isAppleWinWebKit() || isWinCairo()) {
274             print "\n\n===== BUILD FAILED ======\n\n";
275             print "Please ensure you have run $scriptDir/update-webkit to install dependencies.\n\n";
276             print "You can view build errors by checking the BuildLog.htm files located at:\n$baseProductDir/obj/<project>/<config>.\n";
277         }
278         exit exitStatus($result);
279     }
280 } elsif (isAppleCocoaWebKit() && !isCMakeBuild()) {
281     # Build, and abort if the build fails.
282     for my $dir (@projects) {
283         chdir $dir or die;
284         $result = 0;
285
286         my $project = basename($dir);
287         
288         my @local_options = @options;
289         push @local_options, XcodeCoverageSupportOptions() if $coverageSupport;
290         push @local_options, XcodeStaticAnalyzerOption() if $shouldRunStaticAnalyzer;
291         my $projectPath = $project =~ /gtest/ ? "xcode/gtest" : $project;
292         $result = buildXCodeProject($projectPath, $clean, @local_options, @ARGV);
293
294         # Various build* calls above may change the CWD.
295         chdirWebKit();
296
297         if (exitStatus($result)) {
298             exit exitStatus($result);
299         }
300
301         # Build ImageDiff for host
302         my @command = File::Spec->catfile(getcwd(), "/Tools/Scripts/build-imagediff");
303         chdirWebKit();
304         if (!-e $command[0]) {
305           die "build-imagediff script not found";
306         }
307
308         if ($clean) {
309           push @command, " --clean";
310         }
311         push @command, argumentsForConfiguration();
312         push @command, @ARGV;
313         @command = extractNonMacOSHostConfiguration(\@command);
314         $result = system(@command);
315         if (exitStatus($result)) {
316             exit exitStatus($result);
317         }
318     }
319 }
320
321 # Don't report the "WebKit is now built" message after a clean operation.
322 exit if $clean;
323
324 # Don't report congrats message if build was interrupted by the user.
325 exit if ($result & 127) == SIGINT;
326
327 # Explicitly chdir back to where exit will take us anyway, since the following "launcher"
328 # message is relative to that directory.
329 chdir $originalWorkingDirectory;
330
331 # Write out congratulations message.
332 writeCongrats();
333
334 exit 0;
335
336 sub cMakeArgsFromFeatures()
337 {
338     my @args;
339     if (!$defaultCMakeFeatures) {
340         foreach (@features) {
341             my $featureName = $_->{define};
342             if ($featureName) {
343                 my $featureEnabled = ${$_->{value}} ? "ON" : "OFF";
344                 push @args, "-D$featureName=$featureEnabled";
345             }
346         }
347     }
348     return @args;
349 }
350
351 sub writeCongrats()
352 {
353     my $launcherPath = launcherPath();
354     my $launcherName = launcherName();
355     my $endTime = time();
356     my $buildTime = formatBuildTime($endTime - $startTime);
357
358     print "\n";
359     print "====================================================================\n";
360     print " WebKit is now built ($buildTime). \n";
361     if ($launcherPath && $launcherName) {
362         print " To run $launcherName with this newly-built code, use the\n";
363         print " \"$launcherPath\" script.\n";
364     }
365     print "====================================================================\n";
366 }