Add possibility of passing parameters to build-webkit by environment variable,
[WebKit-https.git] / WebKitTools / Scripts / build-webkit
1 #!/usr/bin/perl -w
2
3 # Copyright (C) 2005, 2006 Apple Inc. All rights reserved.
4 # Copyright (C) 2009 Google Inc. All rights reserved.
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 Computer, 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 # Build script wrapper for the WebKit Open Source Project.
31
32 use strict;
33 use File::Basename;
34 use File::Spec;
35 use FindBin;
36 use Getopt::Long qw(:config pass_through);
37 use lib $FindBin::Bin;
38 use webkitdirs;
39 use POSIX;
40
41 sub formatBuildTime($);
42 sub writeCongrats();
43
44 my $originalWorkingDirectory = getcwd();
45 chdirWebKit();
46
47 my $showHelp = 0;
48 my $clean = 0;
49 my $minimal = 0;
50 my $makeArgs;
51 my $startTime = time();
52
53 my ($threeDCanvasSupport, $threeDRenderingSupport, $channelMessagingSupport, $clientBasedGeolocationSupport, $databaseSupport, $datagridSupport, $datalistSupport,
54     $domStorageSupport, $eventsourceSupport, $filtersSupport, $geolocationSupport, $iconDatabaseSupport, $indexedDatabaseSupport,
55     $javaScriptDebuggerSupport, $mathmlSupport, $offlineWebApplicationSupport, $sharedWorkersSupport,
56     $svgSupport, $svgAnimationSupport, $svgAsImageSupport, $svgDOMObjCBindingsSupport, $svgFontsSupport,
57     $svgForeignObjectSupport, $svgUseSupport, $videoSupport, $webSocketsSupport, $wmlSupport, $wcssSupport, $xhtmlmpSupport, $workersSupport,
58     $xpathSupport, $xsltSupport, $coverageSupport, $notificationsSupport);
59
60 my @features = (
61     { option => "3d-canvas", desc => "Toggle 3D canvas support",
62       define => "ENABLE_3D_CANVAS", default => (isAppleMacWebKit() && !isTiger()), value => \$threeDCanvasSupport },
63
64     { option => "3d-rendering", desc => "Toggle 3D rendering support",
65       define => "ENABLE_3D_RENDERING", default => (isAppleMacWebKit() && !isTiger()), value => \$threeDRenderingSupport },
66
67     { option => "channel-messaging", desc => "Toggle MessageChannel and MessagePort support",
68       define => "ENABLE_CHANNEL_MESSAGING", default => 1, value => \$channelMessagingSupport },
69
70     { option => "client-based-geolocation", desc => "Toggle client-based Geolocation support",
71       define => "ENABLE_CLIENT_BASED_GEOLOCATION", default => isAppleWebKit(), value => \$clientBasedGeolocationSupport },
72
73     { option => "coverage", desc => "Toggle code coverage support",
74       define => "", default => 0, value => \$coverageSupport },
75
76     { option => "database", desc => "Toggle Database Support",
77       define => "ENABLE_DATABASE", default => 1, value => \$databaseSupport },
78
79     { option => "datagrid", desc => "Toggle Datagrid Support",
80       define => "ENABLE_DATAGRID", default => 0, value => \$datagridSupport },
81       
82     { option => "datalist", desc => "Toggle HTML5 datalist support",
83       define => "ENABLE_DATALIST", default => 1, value => \$datalistSupport },
84           
85     { option => "dom-storage", desc => "Toggle DOM Storage Support",
86       define => "ENABLE_DOM_STORAGE", default => 1, value => \$domStorageSupport },
87
88     { option => "eventsource", desc => "Toggle server-sent events support",
89       define => "ENABLE_EVENTSOURCE", default => 1, value => \$eventsourceSupport },
90
91     { option => "filters", desc => "Toggle Filters support",
92       define => "ENABLE_FILTERS", default => (isAppleWebKit() || isGtk() || isQt()), value => \$filtersSupport },
93
94     { option => "geolocation", desc => "Toggle Geolocation support",
95       define => "ENABLE_GEOLOCATION", default => (isAppleWebKit() || isGtk()), value => \$geolocationSupport },
96
97     { option => "icon-database", desc => "Toggle Icon database support",
98       define => "ENABLE_ICONDATABASE", default => 1, value => \$iconDatabaseSupport },
99
100     { option => "indexed-database", desc => "Toggle Indexed Database API support",
101       define => "ENABLE_INDEXED_DATABASE", default => 0, value => \$indexedDatabaseSupport },
102
103     { option => "javascript-debugger", desc => "Toggle JavaScript Debugger/Profiler support",
104       define => "ENABLE_JAVASCRIPT_DEBUGGER", default => 1, value => \$javaScriptDebuggerSupport },
105
106     { option => "mathml", desc => "Toggle MathML support",
107       define => "ENABLE_MATHML", default => 0, value => \$mathmlSupport },
108
109     { option => "notifications", desc => "Toggle Desktop Notifications Support",
110       define => "ENABLE_NOTIFICATIONS", default => 0, value => \$notificationsSupport },
111
112     { option => "offline-web-applications", desc => "Toggle Offline Web Application Support",
113       define => "ENABLE_OFFLINE_WEB_APPLICATIONS", default => 1, value => \$offlineWebApplicationSupport },
114
115     { option => "shared-workers", desc => "Toggle SharedWorkers support",
116       define => "ENABLE_SHARED_WORKERS", default => (isAppleWebKit() || isGtk()), value => \$sharedWorkersSupport },
117
118     { option => "svg", desc => "Toggle SVG support",
119       define => "ENABLE_SVG", default => 1, value => \$svgSupport },
120
121     { option => "svg-animation", desc => "Toggle SVG animation support (implies SVG support)",
122       define => "ENABLE_SVG_ANIMATION", default => 1, value => \$svgAnimationSupport },
123
124     { option => "svg-as-image", desc => "Toggle SVG as Image support (implies SVG support)",
125       define => "ENABLE_SVG_AS_IMAGE", default => 1, value => \$svgAsImageSupport },
126
127     { option => "svg-dom-objc-bindings", desc => "Toggle SVG DOM Objective-C bindings support (implies SVG support)",
128       define => "ENABLE_SVG_DOM_OBJC_BINDINGS", default => isAppleMacWebKit(), value => \$svgDOMObjCBindingsSupport },
129
130     { option => "svg-fonts", desc => "Toggle SVG fonts support (imples SVG support)",
131       define => "ENABLE_SVG_FONTS", default => 1, value => \$svgFontsSupport },
132
133     { option => "svg-foreign-object", desc => "Toggle SVG foreign object support (implies SVG support)",
134       define => "ENABLE_SVG_FOREIGN_OBJECT", default => 1, value => \$svgForeignObjectSupport },
135
136     { option => "svg-use", desc => "Toggle SVG use element support (implies SVG support)",
137       define => "ENABLE_SVG_USE", default => 1, value => \$svgUseSupport },
138
139     { option => "video", desc => "Toggle Video support",
140       define => "ENABLE_VIDEO", default => (isAppleWebKit() || isGtk()), value => \$videoSupport },
141
142     { option => "web-sockets", desc => "Toggle Web Sockets support",
143       define => "ENABLE_WEB_SOCKETS", default => 1, value=> \$webSocketsSupport },
144
145     { option => "wml", desc => "Toggle WML support",
146       define => "ENABLE_WML", default => 0, value => \$wmlSupport },
147
148     { option => "xhtmlmp", desc => "Toggle XHTML-MP support",
149       define => "ENABLE_XHTMLMP", default => 0, value => \$xhtmlmpSupport },
150
151     { option => "wcss", desc => "Toggle WCSS support",
152       define => "ENABLE_WCSS", default => 0, value => \$wcssSupport },
153
154     { option => "workers", desc => "Toggle Web Workers support",
155       define => "ENABLE_WORKERS", default => (isAppleWebKit() || isGtk()), value => \$workersSupport },
156
157     { option => "xpath", desc => "Toggle XPath support",
158       define => "ENABLE_XPATH", default => 1, value => \$xpathSupport },
159
160     { option => "xslt", desc => "Toggle XSLT support",
161       define => "ENABLE_XSLT", default => 1, value => \$xsltSupport },
162 );
163
164 # Update defaults from Qt's project file
165 if (isQt()) {
166     my %qtDefaults = qtFeatureDefaults();
167     foreach (@features) {
168         $_->{default} = $qtDefaults{$_->{define}} || 0;
169     }
170 }
171
172 # Additional environment parameters
173 push @ARGV, split(/ /, $ENV{'BUILD_WEBKIT_ARGS'});
174
175 # Initialize values from defaults
176 foreach (@ARGV) {
177     if ($_ eq '--minimal') {
178         $minimal = 1;
179         last;
180     }
181 }
182
183 # Initialize values from defaults
184 foreach (@features) {
185     ${$_->{value}} = ($_->{default} && !$minimal) || 0;
186 }
187
188 $svgSupport = $svgSupport || $svgAnimationSupport || $svgAsImageSupport
189     || $svgDOMObjCBindingsSupport || $svgFontsSupport
190     || $svgForeignObjectSupport || $svgUseSupport;
191
192
193 my $programName = basename($0);
194 my $usage = <<EOF;
195 Usage: $programName [options] [options to pass to build system]
196   --help                            Show this help message
197   --clean                           Cleanup the build directory
198   --debug                           Compile in debug mode
199   --cairo-win32                     Build using Cairo (rather than CoreGraphics) on Windows
200   --chromium                        Build the Chromium port on Mac/Win/Linux
201   --gtk                             Build the GTK+ port
202   --qt                              Build the Qt port
203   --inspector-frontend              Copy changes to the inspector front-end files to the build directory
204
205   --makeargs=<arguments>            Optional Makefile flags
206
207   --minimal                         No optional features, unless explicitly enabled.
208
209 EOF
210
211 my %options = (
212     'help' => \$showHelp,
213     'clean' => \$clean,
214     'makeargs=s' => \$makeArgs,
215     'minimal' => \$minimal,
216 );
217
218 # Build usage text and options list from features
219 foreach (@features) {
220     my $opt = sprintf("%-35s", "  --[no-]$_->{option}");
221     $usage .= "$opt $_->{desc} (default: $_->{default})\n";
222     $options{"$_->{option}!"} = $_->{value};
223 }
224
225 GetOptions(%options);
226
227 if ($showHelp) {
228    print STDERR $usage;
229    exit 1;
230 }
231
232 checkRequiredSystemConfig();
233 setConfiguration();
234
235 my $productDir = productDir();
236
237 # Check that all the project directories are there.
238 my @projects = ("JavaScriptCore", "WebCore", "WebKit");
239 # Only Apple builds JavaScriptGlue, and only on the Mac
240 splice @projects, 1, 0, "JavaScriptGlue" if isAppleMacWebKit();
241
242 my @otherDirs = ("WebKitLibraries");
243 for my $dir (@projects, @otherDirs) {
244     if (! -d $dir) {
245         die "Error: No $dir directory found. Please do a fresh checkout.\n";
246     }
247 }
248
249 my @options = ();
250
251 # enable autotool options accordingly
252 if (isGtk()) {
253     foreach (@features) {
254         push @options, autotoolsFlag(${$_->{value}}, $_->{option});
255     }
256
257     push @options, "--makeargs=" . $makeArgs if defined($makeArgs);
258 } elsif (isAppleMacWebKit()) {
259     push @options, XcodeOptions();
260
261     sub option($$)
262     {
263         my ($feature, $isEnabled) = @_;
264         return $feature . "=" . ($isEnabled ? $feature : " ");
265     }
266
267     foreach (@features) {
268         if ($_->{option} eq "coverage") {
269             push @options, XcodeCoverageSupportOptions() if $coverageSupport;
270         } else {
271             push @options, option($_->{define}, ${$_->{value}});
272         }
273     }
274
275     # Copy library and header from WebKitLibraries to a findable place in the product directory.
276
277     my @librariesToCopy = (
278         "libWebKitSystemInterfaceTiger.a",
279         "libWebKitSystemInterfaceLeopard.a",
280         "libWebKitSystemInterfaceSnowLeopard.a",
281         "libWebCoreSQLite3.a",
282     );
283     foreach my $libName (@librariesToCopy) {
284         my $srcLib = "WebKitLibraries/" . $libName;
285         my $lib = "$productDir/" . $libName;
286         if (!-e $lib || -M $lib > -M $srcLib) {
287             print "Updating $lib\n";
288             system "ditto", $srcLib, $lib;
289             system "ranlib", $lib;
290         }
291     }
292
293     # FIXME: This code should be abstracted to not be copy/paste.
294     my $srcHeader = "WebKitLibraries/WebKitSystemInterface.h";
295     my $header = "$productDir/usr/local/include/WebKitSystemInterface.h";
296     if (!-e $header || -M $header > -M $srcHeader) {
297         print "Updating $header\n";
298         system "mkdir", "-p", "$productDir/usr/local/include";
299         system "ditto", $srcHeader, $header;
300     }
301
302     my $srcHeaderDir = "WebKitLibraries/WebCoreSQLite3";
303     my $headerDir = "$productDir/WebCoreSQLite3";
304     if (!-e $headerDir || -M $headerDir > -M $srcHeaderDir) {
305         print "Updating $headerDir\n";
306         system "ditto", $srcHeaderDir, $headerDir;
307     }
308 } elsif (isAppleWinWebKit()) {
309     # Copy WebKitSupportLibrary to the correct location in WebKitLibraries so it can be found.
310     # Will fail if WebKitSupportLibrary.zip is not in source root.
311     (system("perl WebKitTools/Scripts/update-webkit-support-libs") == 0) or die;
312 } elsif (isQt()) {
313     @options = @ARGV;
314     push @options, "--makeargs=" . $makeArgs if defined($makeArgs);
315
316     foreach (@features) {
317         push @options, "DEFINES+=$_->{define}=${$_->{value}}" if ${$_->{value}} != $_->{default};
318     }
319 }
320
321 # Force re-link of existing libraries if different than expected
322 removeLibraryDependingOnSVG("WebCore", $svgSupport);
323
324 if (isInspectorFrontend()) {
325     exit exitStatus(copyInspectorFrontendFiles());
326 }
327
328 if (isWx()) {
329     downloadWafIfNeeded();
330     push @projects, 'WebKitTools/DumpRenderTree';
331     push @projects, 'WebKitTools/wx/browser';
332     push @projects, 'WebKit/wx/bindings/python';
333 }
334
335 if (isChromium()) {
336     # Chromium doesn't build by project directories.
337     @projects = ();
338     my $result = buildChromium($clean, @options);
339     exit exitStatus($result) if exitStatus($result);
340 }
341
342 # Build, and abort if the build fails.
343 for my $dir (@projects) {
344     chdir $dir or die;
345     my $result = 0;
346
347     # For Gtk and Qt the WebKit project builds all others
348     if ((isGtk() || isQt()) && $dir ne "WebKit") {
349         chdir ".." or die;
350         next;
351     }
352
353     if (isGtk()) {
354         $result = buildGtkProject($dir, $clean,  @options);
355     } elsif (isQt()) {
356         $result = buildQMakeQtProject($dir, $clean, @options);
357     } elsif (isAppleMacWebKit()) {
358         $result = buildXCodeProject($dir, $clean, @options, @ARGV);
359     } elsif (isAppleWinWebKit()) {
360         if ($dir eq "WebKit") {
361             $result = buildVisualStudioProject("win/WebKit.vcproj/WebKit.sln", $clean);
362         }
363     } elsif (isWx()) {
364         @options = ();
365         if (defined($makeArgs)) {
366             @options = split(/ /, $makeArgs);
367         }
368         if ($dir eq "WebKit" && isWx()) {
369             chdir 'wx' or die;
370         }
371             
372         $result = buildWafProject($dir, $clean, @options);
373     }
374
375     if (exitStatus($result)) {
376         if (isAppleWinWebKit()) {
377             print "\n\n===== BUILD FAILED ======\n\n";
378             my $scriptDir = relativeScriptsDir();
379             print "Please ensure you have run $scriptDir/update-webkit to install dependencies.\n\n";
380             my $baseProductDir = baseProductDir();
381             print "You can view build errors by checking the BuildLog.htm files located at:\n$baseProductDir/obj/<project>/<config>.\n";
382         }
383         exit exitStatus($result);
384     }
385     chdirWebKit();
386 }
387
388 # Don't report the "WebKit is now built" message after a clean operation.
389 exit if $clean;
390
391 # Write out congratulations message.
392 writeCongrats();
393
394 exit 0;
395
396 sub formatBuildTime($)
397 {
398     my ($buildTime) = @_;
399
400     my $buildHours = int($buildTime / 3600);
401     my $buildMins = int(($buildTime - $buildHours * 3600) / 60);
402     my $buildSecs = $buildTime - $buildHours * 3600 - $buildMins * 60;
403
404     if ($buildHours) {
405         return sprintf("%dh:%02dm:%02ds", $buildHours, $buildMins, $buildSecs);
406     }
407     return sprintf("%02dm:%02ds", $buildMins, $buildSecs);
408 }
409
410 sub writeCongrats()
411 {
412     my $launcherPath = launcherPath();
413     my $launcherName = launcherName();
414     my $endTime = time();
415     my $buildTime = formatBuildTime($endTime - $startTime);
416
417     print "\n";
418     print "===========================================================\n";
419     print " WebKit is now built ($buildTime). \n";
420     if (!isChromium()) {
421         print " To run $launcherName with this newly-built code, use the\n";
422         print " \"$launcherPath\" script.\n";
423     }
424     print "===========================================================\n";
425 }