Update build-webkit to handle a new version of WebKitSystemInterface.
[WebKit-https.git] / WebKitTools / Scripts / build-webkit
1 #!/usr/bin/perl -w
2
3 # Copyright (C) 2005, 2006 Apple Computer, Inc.  All rights reserved.
4 #
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions
7 # are met:
8 #
9 # 1.  Redistributions of source code must retain the above copyright
10 #     notice, this list of conditions and the following disclaimer. 
11 # 2.  Redistributions in binary form must reproduce the above copyright
12 #     notice, this list of conditions and the following disclaimer in the
13 #     documentation and/or other materials provided with the distribution. 
14 # 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15 #     its contributors may be used to endorse or promote products derived
16 #     from this software without specific prior written permission. 
17 #
18 # THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 # DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29 # Build script wrapper for the WebKit Open Source Project.
30
31 use strict;
32 use File::Basename;
33 use File::Spec;
34 use FindBin;
35 use Getopt::Long qw(:config pass_through);
36 use lib $FindBin::Bin;
37 use webkitdirs;
38 use POSIX;
39
40 my $originalWorkingDirectory = getcwd();
41
42 my $showHelp = 0;
43 my $clean = 0;
44 my $coverageSupport = 0;
45
46 my $channelMessagingSupport = 0;
47 my $databaseSupport = 1;
48 my $domStorageSupport = 1;
49 my $geolocationSupport = 0;
50 my $gnomeKeyringSupport = 0;
51 my $iconDatabaseSupport = 1;
52 my $javaScriptDebuggerSupport = 1;
53 my $offlineWebApplicationSupport = 1;
54 my $svgSupport = 1;
55 my $svgAnimationSupport = 1;
56 my $svgAsImageSupport = 1;
57 my $svgDOMObjCBindingsSupport = isAppleMacWebKit();
58 my $svgFiltersSupport = 0;
59 my $svgFontsSupport = 1;
60 my $svgForeignObjectSupport = 1;
61 my $svgUseSupport = 1;
62 my $threeDRenderingSupport = 0;
63 my $videoSupport = (isAppleWebKit() || isGtk()); # Enable by default for Apple's builds and Gtk+
64 my $wmlSupport = 0;
65 my $workersSupport = (isAppleWebKit() || isGtk()); # Enable by default for Apple's builds (mac/win) and Gtk+
66 my $xpathSupport = 1;
67 my $xsltSupport = 1;
68 my $makeArgs = "";
69
70 my $programName = basename($0);
71 my $usage = <<EOF;
72 Usage: $programName [options] [options to pass to build system]
73   --help                            Show this help message
74   --cairo-win32                     Build using Cairo (rather than CoreGraphics) on Windows
75   --chromium                        Build the Chromium port on Mac/Win/Linux
76   --clean                           Cleanup the build directory
77   --[no-]coverage                   Toggle code coverage support (default: $coverageSupport)
78   --gtk                             Build the GTK+ port
79   --qt                              Build the Qt port
80
81   --makeargs=<arguments>            Optional Makefile flags
82   --[no-]3d-rendering               Toggle 3D rendering support (default: $threeDRenderingSupport)
83   --[no-]channel-messaging          Toggle MessageChannel and MessagePort support (default: $channelMessagingSupport)
84   --[no-]database                   Toggle Database Support (default: $databaseSupport)
85   --[no-]dom-storage                Toggle DOM Storage Support (default: $domStorageSupport)
86   --[no-]geolocation                Toggle Geolocation support (default: $geolocationSupport)
87   --[no-]gnomekeyring               Toggle GNOME Keyring Support (GTK+ port only) (default: $gnomeKeyringSupport)
88   --[no-]icon-database              Toggle Icon database support (default: $iconDatabaseSupport)
89   --[no-]javascript-debugger        Toggle JavaScript Debugger/Profiler support (default: $javaScriptDebuggerSupport)
90   --[no-]offline-web-applications   Toggle Offline Web Application Support (default: $offlineWebApplicationSupport)
91   --[no-]svg                        Toggle SVG support (default: $svgSupport)
92   --[no-]svg-animation              Toggle SVG animation support (default: $svgAnimationSupport, implies SVG Support)
93   --[no-]svg-as-image               Toggle SVG as Image support (default: $svgAsImageSupport, implies SVG Support)
94   --[no-]svg-dom-objc-bindings      Toggle SVG DOM Objective-C bindings support (default: $svgDOMObjCBindingsSupport, implies SVG Support)
95   --[no-]svg-filters                Toggle SVG filters support (default: $svgFiltersSupport, implies SVG Support)
96   --[no-]svg-fonts                  Toggle SVG fonts support (default: $svgFontsSupport, implies SVG Support)
97   --[no-]svg-foreign-object         Toggle SVG foreign object support (default: $svgForeignObjectSupport, implies SVG Support)
98   --[no-]svg-use                    Toggle SVG use element support (default: $svgUseSupport, implies SVG Support)
99   --[no-]video                      Toggle Video support (default: $videoSupport)
100   --[no-]wml                        Toggle WML support (default: $wmlSupport)
101   --[no-]workers                    Toggle Web Workers support (default: $workersSupport)
102   --[no-]xpath                      Toggle XPath support (default: $xpathSupport)
103   --[no-]xslt                       Toggle XSLT support (default: $xsltSupport)
104 EOF
105
106 GetOptions(
107            'help' => \$showHelp,
108            'clean' => \$clean,
109            'coverage!' => \$coverageSupport,
110            '3d-rendering!' => \$threeDRenderingSupport,
111            'channel-messaging!' => \$channelMessagingSupport,
112            'database!' => \$databaseSupport,
113            'dom-storage!' => \$domStorageSupport,
114            'geolocation!' => \$geolocationSupport,
115            'gnomekeyring!' => \$gnomeKeyringSupport,
116            'icon-database!' => \$iconDatabaseSupport,
117            'javascript-debugger!' => \$javaScriptDebuggerSupport,
118            'offline-web-applications!' => \$offlineWebApplicationSupport,
119            'svg!' => \$svgSupport,
120            'svg-animation!' => \$svgAnimationSupport,
121            'svg-as-image!' => \$svgAsImageSupport,
122            'svg-dom-objc-bindings!' => \$svgDOMObjCBindingsSupport,
123            'svg-filters!' => \$svgFiltersSupport,
124            'svg-fonts!' => \$svgFontsSupport,
125            'svg-foreign-object!' => \$svgForeignObjectSupport,
126            'svg-use!' => \$svgUseSupport,
127            'video!' => \$videoSupport,
128            'wml!' => \$wmlSupport,
129            'workers!' => \$workersSupport,
130            'xpath!' => \$xpathSupport,
131            'xslt!' => \$xsltSupport,
132            'makeargs=s' => \$makeArgs,
133 );
134
135 $svgSupport = $svgSupport || $svgAnimationSupport || $svgAsImageSupport
136     || $svgDOMObjCBindingsSupport || $svgFiltersSupport || $svgFontsSupport
137     || $svgForeignObjectSupport || $svgUseSupport;
138
139 if ($showHelp) {
140    print STDERR $usage;
141    exit 1;
142 }
143
144 checkRequiredSystemConfig();
145 setConfiguration();
146 chdirWebKit();
147
148 if (isWx()) {
149     $ENV{"WEBKITOUTPUTDIR"} = productDir();
150
151     my @opts = getWxArgs();
152
153     if ($clean) {
154         push(@opts, "clean");
155     }
156     system "WebKitTools/wx/build-wxwebkit @opts";
157     exit exitStatus($?);
158 }
159
160 my $productDir = productDir();
161
162 # Check that all the project directories are there.
163 my @projects = ("JavaScriptCore", "WebCore", "WebKit");
164 # Only Apple builds JavaScriptGlue, and only on the Mac
165 splice @projects, 1, 0, "JavaScriptGlue" if isAppleMacWebKit();
166
167 my @otherDirs = ("WebKitLibraries");
168 for my $dir (@projects, @otherDirs) {
169     if (! -d $dir) {
170         die "Error: No $dir directory found. Please do a fresh checkout.\n";
171     }
172 }
173
174 my @options = ();
175
176 # enable autotool options accordingly
177 if (isGtk()) {
178     push @options, autotoolsFlag($coverageSupport, "coverage");
179     push @options, autotoolsFlag($threeDRenderingSupport, "3D-rendering");
180     push @options, autotoolsFlag($channelMessagingSupport, "channel-messaging");
181     push @options, autotoolsFlag($databaseSupport, "database");
182     push @options, autotoolsFlag($domStorageSupport, "dom-storage");
183     push @options, autotoolsFlag($geolocationSupport, "geolocation");
184     push @options, autotoolsFlag($gnomeKeyringSupport, "gnomekeyring");
185     push @options, autotoolsFlag($iconDatabaseSupport, "icon-database");
186     push @options, autotoolsFlag($javaScriptDebuggerSupport, "javascript-debugger");
187     push @options, autotoolsFlag($offlineWebApplicationSupport, "offline-web-applications");
188     push @options, autotoolsFlag($svgSupport, "svg");
189     push @options, autotoolsFlag($svgAnimationSupport, "svg-animation");
190     push @options, autotoolsFlag($svgAsImageSupport, "svg-as-image");
191     push @options, autotoolsFlag($svgFiltersSupport, "svg-filters");
192     push @options, autotoolsFlag($svgFontsSupport, "svg-fonts");
193     push @options, autotoolsFlag($svgForeignObjectSupport, "svg-foreign-object");
194     push @options, autotoolsFlag($svgUseSupport, "svg-use-element");
195     push @options, autotoolsFlag($videoSupport, "video");
196     push @options, autotoolsFlag($wmlSupport, "wml");
197     push @options, autotoolsFlag($workersSupport, "web-workers");
198     push @options, autotoolsFlag($xpathSupport, "xpath");
199     push @options, autotoolsFlag($xsltSupport, "xslt");
200     push @options, "--makeargs=" . $makeArgs;
201 }
202
203 if (isAppleMacWebKit()) {
204     push @options, XcodeOptions();
205
206     sub option($$)
207     {
208         my ($feature, $isEnabled) = @_;
209         return $feature . "=" . ($isEnabled ? $feature : " ");
210     }
211
212     push @options, option("ENABLE_3D_RENDERING", $threeDRenderingSupport);
213     push @options, option("ENABLE_CHANNEL_MESSAGING", $channelMessagingSupport);
214     push @options, option("ENABLE_DATABASE", $databaseSupport);
215     push @options, option("ENABLE_DOM_STORAGE", $domStorageSupport);
216     push @options, option("ENABLE_GEOLOCATION", $geolocationSupport);
217     push @options, option("ENABLE_ICONDATABASE", $iconDatabaseSupport);
218     push @options, option("ENABLE_JAVASCRIPT_DEBUGGER", $javaScriptDebuggerSupport);
219     push @options, option("ENABLE_OFFLINE_WEB_APPLICATIONS", $offlineWebApplicationSupport);
220     push @options, option("ENABLE_SVG", $svgSupport);
221     push @options, option("ENABLE_SVG_ANIMATION", $svgAnimationSupport);
222     push @options, option("ENABLE_SVG_AS_IMAGE", $svgAsImageSupport);
223     push @options, option("ENABLE_SVG_DOM_OBJC_BINDINGS", $svgDOMObjCBindingsSupport);
224     push @options, option("ENABLE_SVG_FILTERS", $svgFiltersSupport);
225     push @options, option("ENABLE_SVG_FONTS", $svgFontsSupport);
226     push @options, option("ENABLE_SVG_FOREIGN_OBJECT", $svgForeignObjectSupport);
227     push @options, option("ENABLE_SVG_USE", $svgUseSupport);
228     push @options, option("ENABLE_VIDEO", $videoSupport);
229     push @options, option("ENABLE_WML", $wmlSupport);
230     push @options, option("ENABLE_WORKERS", $workersSupport);
231     push @options, option("ENABLE_XPATH", $xpathSupport);
232     push @options, option("ENABLE_XSLT", $xsltSupport);
233
234     push @options, XcodeCoverageSupportOptions() if $coverageSupport;
235
236     # Copy library and header from WebKitLibraries to a findable place in the product directory.
237     my $srcLib = "WebKitLibraries/libWebKitSystemInterfaceTiger.a";
238     my $lib = "$productDir/libWebKitSystemInterfaceTiger.a";
239     if (!-e $lib || -M $lib > -M $srcLib) {
240         print "Updating $lib\n";
241         system "ditto", $srcLib, $lib;
242         system "ranlib", $lib;
243     }
244
245     $srcLib = "WebKitLibraries/libWebKitSystemInterfaceLeopard.a";
246     $lib = "$productDir/libWebKitSystemInterfaceLeopard.a";
247     if (!-e $lib || -M $lib > -M $srcLib) {
248         print "Updating $lib\n";
249         system "ditto", $srcLib, $lib;
250         system "ranlib", $lib;
251     }
252
253     $srcLib = "WebKitLibraries/libWebKitSystemInterfaceSnowLeopard.a";
254     $lib = "$productDir/libWebKitSystemInterfaceSnowLeopard.a";
255     if (!-e $lib || -M $lib > -M $srcLib) {
256         print "Updating $lib\n";
257         system "ditto", $srcLib, $lib;
258         system "ranlib", $lib;
259     }
260
261     my $srcHeader = "WebKitLibraries/WebKitSystemInterface.h";
262     my $header = "$productDir/usr/local/include/WebKitSystemInterface.h";
263     if (!-e $header || -M $header > -M $srcHeader) {
264         print "Updating $header\n";
265         system "mkdir", "-p", "$productDir/usr/local/include";
266         system "ditto", $srcHeader, $header;
267     }
268
269     $srcLib = "WebKitLibraries/libWebCoreSQLite3.a";
270     $lib = "$productDir/libWebCoreSQLite3.a";
271     if (!-e $lib || -M $lib > -M $srcLib) {
272         print "Updating $lib\n";
273         system "ditto", $srcLib, $lib;
274         system "ranlib", $lib;
275     }
276
277     my $srcHeaderDir = "WebKitLibraries/WebCoreSQLite3";
278     my $headerDir = "$productDir/WebCoreSQLite3";
279     if (!-e $headerDir || -M $headerDir > -M $srcHeaderDir) {
280         print "Updating $headerDir\n";
281         system "ditto", $srcHeaderDir, $headerDir;
282     }
283 }
284
285 if (isAppleWinWebKit()) {
286     # Copy WebKitSupportLibrary to the correct location in WebKitLibraries so it can be found.
287     # Will fail if WebKitSupportLibrary.zip is not in source root.
288     (system("perl WebKitTools/Scripts/update-webkit-support-libs") == 0) or die;
289 }
290
291 # Force re-link of existing libraries if different than expected
292 removeLibraryDependingOnSVG("WebCore", $svgSupport);
293
294 # Build, and abort if the build fails.
295 for my $dir (@projects) {
296     chdir $dir or die;
297     my $result = 0;
298
299     # For Gtk and Qt the WebKit project builds all others
300     if ((isGtk() || isQt()) && $dir ne "WebKit") {
301         chdir ".." or die;
302         next;
303     }
304
305     if (isGtk()) {
306         $result = buildGtkProject($dir, $clean,  @options);
307     } elsif (isQt()) {
308         my @options = @ARGV;
309         push @options, "--makeargs=" . $makeArgs;
310         $result = buildQMakeQtProject($dir, $clean, @options);
311     } elsif (isAppleMacWebKit()) {
312         $result = buildXCodeProject($dir, $clean, @options, @ARGV);
313     } elsif (isAppleWinWebKit()) {
314         if ($dir eq "WebKit") {
315             $result = buildVisualStudioProject("win/WebKit.vcproj/WebKit.sln", $clean);
316         }
317     } elsif (isChromium()) {
318         $result = buildSconsProject($dir, $clean);
319     }
320
321     if (exitStatus($result)) {
322         if (isAppleWinWebKit()) {
323             print "\n\n===== BUILD FAILED ======\n\n";
324             my $scriptDir = relativeScriptsDir();
325             print "Please ensure you have run $scriptDir/update-webkit to install depenedencies.\n\n";
326             my $baseProductDir = baseProductDir();
327             print "You can view build errors by checking the BuildLog.htm files located at:\n$baseProductDir/obj/<project>/<config>.\n";
328         }
329         exit exitStatus($result);
330     }
331     chdir ".." or die;
332 }
333
334 # Don't report the "WebKit is now built" message after a clean operation.
335 exit if $clean;
336
337 # Write out congratulations message.
338
339 my $launcherPath = launcherPath();
340 my $launcherName = launcherName();
341
342 print "\n";
343 print "===========================================================\n";
344 print " WebKit is now built. To run $launcherName with this newly-built\n";
345 print " code, use the \"$launcherPath\" script.\n";
346 if ($svgSupport) {
347     print "\n NOTE: WebKit has been built with SVG support enabled.\n";
348     print " $launcherName will have SVG viewing capabilities.\n";
349 }
350 if ($svgAnimationSupport or $svgAsImageSupport or $svgDOMObjCBindingsSupport or $svgFiltersSupport or $svgFontsSupport or $svgForeignObjectSupport or $svgUseSupport) {
351     print " Your build supports the following (optional) SVG features: \n";
352     print "  * Basic SVG animation.\n" if $svgAnimationSupport;
353     print "  * SVG as image.\n" if $svgAsImageSupport;
354     print "  * SVG DOM Objective-C bindings.\n" if $svgDOMObjCBindingsSupport;
355     print "  * SVG filters.\n" if $svgFiltersSupport;
356     print "  * SVG fonts.\n" if $svgFontsSupport;
357     print "  * SVG foreign object.\n" if $svgForeignObjectSupport;
358     print "  * SVG <use> support.\n" if $svgUseSupport;
359 }
360 print "===========================================================\n";
361
362 exit 0;