2009-02-28 Gustavo Noronha Silva <gns@gnome.org>
[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 $channelMessagingSupport = 0;
43 my $databaseSupport = 1;
44 my $domStorageSupport = 1;
45 my $gnomeKeyringSupport = 0;
46 my $iconDatabaseSupport = 1;
47 my $offlineWebApplicationSupport = 1;
48 my $svgSupport = 1;
49 my $svgAnimationSupport = 1;
50 my $svgFiltersSupport = 0;
51 my $svgForeignObjectSupport = 1;
52 my $svgUseSupport = 1;
53 my $svgFontsSupport = 1;
54 my $svgAsImageSupport = 1;
55 my $xpathSupport = 1;
56 my $xsltSupport = 1;
57 my $wmlSupport = 0;
58 my $coverageSupport = 0;
59 my $videoSupport = isAppleWebKit(); # Enable by default for Apple's builds
60 my $workersSupport = (isAppleWebKit() || isGtk()); # Enable by default for Apple's builds (mac/win) and Gtk+
61 my $showHelp = 0;
62 my $clean = 0;
63 my $buildUniversal = 0;
64 my $buildSixtyFourBit = 0;
65 my $threeDTransformsSupport = 0;
66
67 my $programName = basename($0);
68 my $usage = <<EOF;
69 Usage: $programName [options] [options to pass to build system]
70   --help                        Show this help message
71   --cairo-win32                 Build using Cairo (rather than CoreGraphics) on Windows
72   --chromium                    Build the Chromium port on Mac/Win/Linux
73   --clean                       Cleanup the build directory
74   --gtk                         Build the GTK+ port
75   --universal                   Build 2-way universal (PPC and Intel 32-bit)
76   --64-bit                      Build 64-bit, combine with --universal to build 4-way universal
77   --[no-]3d-transforms          Toggle 3D Transforms support (default: $threeDTransformsSupport)
78   --[no-]channel-messaging          Toggle MessageChannel and MessagePort support (default: $channelMessagingSupport)
79   --[no-]offline-web-applications   Toggle Offline Web Application Support (default : $offlineWebApplicationSupport)
80   --[no-]database               Toggle Database Support (default: $databaseSupport)
81   --[no-]dom-storage            Toggle DOM Storage Support (default: $domStorageSupport)
82   --[no-]gnomekeyring           Toggle GNOME Keyring Support (GTK+ port only) (default: $gnomeKeyringSupport)
83   --[no-]icon-database          Toggle Icon database support (default: $iconDatabaseSupport)
84   --[no-]svg                    Toggle SVG support (default: $svgSupport)
85   --[no-]svg-animation          Toggle SVG animation support (default: $svgAnimationSupport, implies SVG Support)
86   --[no-]svg-filters            Toggle SVG filters support (default: $svgFiltersSupport, implies SVG Support)
87   --[no-]svg-foreign-object     Toggle SVG foreign object support (default: $svgForeignObjectSupport, implies SVG Support)
88   --[no-]svg-fonts              Toggle SVG fonts support (default: $svgFontsSupport, implies SVG Support)
89   --[no-]svg-as-image           Toggle SVG as Image support (default: $svgAsImageSupport, implies SVG Support)
90   --[no-]svg-use                Toggle SVG use element support (default: $svgUseSupport, implies SVG Support)
91   --[no-]xpath                  Toggle XPath support (default: $xpathSupport)
92   --[no-]xslt                   Toggle XSLT support (default: $xsltSupport)
93   --[no-]wml                    Toggle WML support (default: $wmlSupport)
94   --[no-]video                  Toggle Video support (default: $videoSupport)
95   --[no-]workers                Toggle Web Workers support (default: $workersSupport)
96   --[no-]coverage               Toggle code coverage support (default: $coverageSupport)
97 EOF
98
99 GetOptions(
100            '3d-transforms!' => \$threeDTransformsSupport,
101            'channel-messaging!' => \$channelMessagingSupport,
102            'database!' => \$databaseSupport,
103            'dom-storage!' => \$domStorageSupport,
104            'gnomekeyring!' => \$gnomeKeyringSupport,
105            'icon-database!' => \$iconDatabaseSupport,
106            'offline-web-applications!' => \$offlineWebApplicationSupport,
107            'svg!' => \$svgSupport,
108            'svg-animation!' => \$svgAnimationSupport,
109            'svg-filters!' => \$svgFiltersSupport,
110            'svg-foreign-object!' => \$svgForeignObjectSupport,
111            'svg-fonts!' => \$svgFontsSupport,
112            'svg-as-image!' => \$svgAsImageSupport,
113            'svg-use!' => \$svgUseSupport,
114            'xpath!' => \$xpathSupport,
115            'xslt!' => \$xsltSupport,
116            'wml!' => \$wmlSupport,
117            'video!' => \$videoSupport,
118            'workers!' => \$workersSupport,
119            'coverage!' => \$coverageSupport,
120            'help' => \$showHelp,
121            'universal' => \$buildUniversal,
122            '64-bit' => \$buildSixtyFourBit,
123            'clean' => \$clean);
124
125 if ($showHelp) {
126    print STDERR $usage;
127    exit 1;
128 }
129
130 checkRequiredSystemConfig();
131 setConfiguration();
132 chdirWebKit();
133
134 if (isWx()) {
135     $ENV{"WEBKITOUTPUTDIR"} = productDir();
136
137     my @opts = getWxArgs();
138
139     if ($clean) {
140         push(@opts, "clean");
141     }
142     system "WebKitTools/wx/build-wxwebkit @opts";
143     exit exitStatus($?);
144 }
145
146
147 my $productDir = productDir();
148 my @overrideFeatureDefinesOption = ();
149
150 push @overrideFeatureDefinesOption, "ENABLE_3D_TRANSFORMS" if $threeDTransformsSupport;
151 push @overrideFeatureDefinesOption, "ENABLE_CHANNEL_MESSAGING" if $channelMessagingSupport;
152 push @overrideFeatureDefinesOption, "ENABLE_DATABASE" if $databaseSupport;
153 push @overrideFeatureDefinesOption, "ENABLE_DOM_STORAGE" if $domStorageSupport;
154 push @overrideFeatureDefinesOption, "ENABLE_ICONDATABASE" if $iconDatabaseSupport;
155 push @overrideFeatureDefinesOption, "ENABLE_OFFLINE_WEB_APPLICATIONS" if $offlineWebApplicationSupport;
156 push @overrideFeatureDefinesOption, "ENABLE_SVG" if $svgSupport;
157 push @overrideFeatureDefinesOption, "ENABLE_SVG_ANIMATION" if $svgAnimationSupport;
158 push @overrideFeatureDefinesOption, "ENABLE_SVG_AS_IMAGE" if $svgAsImageSupport;
159 push @overrideFeatureDefinesOption, "ENABLE_SVG_FILTERS" if $svgFiltersSupport;
160 push @overrideFeatureDefinesOption, "ENABLE_SVG_FONTS" if $svgFontsSupport;
161 push @overrideFeatureDefinesOption, "ENABLE_SVG_FOREIGN_OBJECT" if $svgForeignObjectSupport;
162 push @overrideFeatureDefinesOption, "ENABLE_SVG_USE" if $svgUseSupport;
163 push @overrideFeatureDefinesOption, "ENABLE_VIDEO" if $videoSupport;
164 push @overrideFeatureDefinesOption, "ENABLE_WORKERS" if $workersSupport;
165 push @overrideFeatureDefinesOption, "ENABLE_XPATH" if $xpathSupport;
166 push @overrideFeatureDefinesOption, "ENABLE_XSLT" if $xsltSupport;
167 push @overrideFeatureDefinesOption, "ENABLE_WML" if $wmlSupport;
168 my $overrideFeatureDefinesString = "FEATURE_DEFINES=" . join(" ", @overrideFeatureDefinesOption);
169
170 my @coverageSupportOption = ($coverageSupport) ? XcodeCoverageSupportOptions() : ();
171
172 # Check that all the project directories are there.
173 my @projects = ("JavaScriptCore", "WebCore", "WebKit");
174 # Only Apple builds JavaScriptGlue, and only on the Mac
175 push @projects, "JavaScriptGlue" if isAppleMacWebKit();
176
177 my @otherDirs = ("WebKitLibraries");
178 for my $dir (@projects, @otherDirs) {
179     if (! -d $dir) {
180         die "Error: No $dir directory found. Please do a fresh checkout.\n";
181     }
182 }
183
184 my @options = ();
185
186 if ($buildSixtyFourBit && isAppleMacWebKit()) {
187     my $cpuVendor = `sysctl -n machdep.cpu.vendor`;
188     chomp $cpuVendor;
189
190     if ($buildUniversal) {
191         push(@options, "ARCHS=ppc ppc64 i386 x86_64");
192     } elsif ($cpuVendor eq "GenuineIntel") {
193         push(@options, "ARCHS=i386 x86_64");
194     } else {
195         push(@options, "ARCHS=ppc ppc64");
196     }
197 } elsif ($buildUniversal && isAppleMacWebKit()) {
198     push(@options, "ARCHS=ppc i386");
199 }
200
201 # enable autotool options accordingly
202 if (isGtk()) {
203     push @options, autotoolsFlag($databaseSupport, "database");
204     push @options, autotoolsFlag($domStorageSupport, "dom-storage");
205     push @options, autotoolsFlag($gnomeKeyringSupport, "gnomekeyring");
206     push @options, autotoolsFlag($iconDatabaseSupport, "icon-database");
207     push @options, autotoolsFlag($offlineWebApplicationSupport, "offline-web-applications");
208     push @options, autotoolsFlag($threeDTransformsSupport, "3D-transforms");
209     push @options, autotoolsFlag($channelMessagingSupport, "channel-messaging");
210     push @options, autotoolsFlag($svgSupport, "svg");
211     push @options, autotoolsFlag($svgAnimationSupport, "svg-animation");
212     push @options, autotoolsFlag($svgFiltersSupport, "svg-filters");
213     push @options, autotoolsFlag($svgForeignObjectSupport, "svg-foreign-object");
214     push @options, autotoolsFlag($svgFontsSupport, "svg-fonts");
215     push @options, autotoolsFlag($svgAsImageSupport, "svg-as-image");
216     push @options, autotoolsFlag($svgUseSupport, "svg-use-element");
217     push @options, autotoolsFlag($xpathSupport, "xpath");
218     push @options, autotoolsFlag($xsltSupport, "xslt");
219     push @options, autotoolsFlag($wmlSupport, "wml");
220     push @options, autotoolsFlag($videoSupport, "video");
221     push @options, autotoolsFlag($workersSupport, "web-workers");
222     push @options, autotoolsFlag($coverageSupport, "coverage");
223 }
224
225 if (isAppleMacWebKit()) {
226
227     push(@options, XcodeOptions());
228
229     # Copy library and header from WebKitLibraries to a findable place in the product directory.
230     my $srcLib = "WebKitLibraries/libWebKitSystemInterfaceTiger.a";
231     my $lib = "$productDir/libWebKitSystemInterfaceTiger.a";
232     if (!-e $lib || -M $lib > -M $srcLib) {
233         print "Updating $lib\n";
234         system "ditto", $srcLib, $lib;
235         system "ranlib", $lib;
236     }
237
238     $srcLib = "WebKitLibraries/libWebKitSystemInterfaceLeopard.a";
239     $lib = "$productDir/libWebKitSystemInterfaceLeopard.a";
240     if (!-e $lib || -M $lib > -M $srcLib) {
241         print "Updating $lib\n";
242         system "ditto", $srcLib, $lib;
243         system "ranlib", $lib;
244     }
245
246     my $srcHeader = "WebKitLibraries/WebKitSystemInterface.h";
247     my $header = "$productDir/usr/local/include/WebKitSystemInterface.h";
248     if (!-e $header || -M $header > -M $srcHeader) {
249         print "Updating $header\n";
250         system "mkdir", "-p", "$productDir/usr/local/include";
251         system "ditto", $srcHeader, $header;
252     }
253
254     $srcLib = "WebKitLibraries/libWebCoreSQLite3.a";
255     $lib = "$productDir/libWebCoreSQLite3.a";
256     if (!-e $lib || -M $lib > -M $srcLib) {
257         print "Updating $lib\n";
258         system "ditto", $srcLib, $lib;
259         system "ranlib", $lib;
260     }
261
262     my $srcHeaderDir = "WebKitLibraries/WebCoreSQLite3";
263     my $headerDir = "$productDir/WebCoreSQLite3";
264     if (!-e $headerDir || -M $headerDir > -M $srcHeaderDir) {
265         print "Updating $headerDir\n";
266         system "ditto", $srcHeaderDir, $headerDir;
267     }
268 }
269
270 if (isAppleWinWebKit()) {
271     # Copy WebKitSupportLibrary to the correct location in WebKitLibraries so it can be found.
272     # Will fail if WebKitSupportLibrary.zip is not in source root.
273     (system("perl WebKitTools/Scripts/update-webkit-support-libs") == 0) or die;
274 }
275
276 # Force re-link of existing libraries if different than expected
277 removeLibraryDependingOnSVG("WebCore", $svgSupport);
278
279 # Build, and abort if the build fails.
280 for my $dir (@projects) {
281     chdir $dir or die;
282     my $result = 0;
283
284     # For Gtk and Qt the WebKit project builds all others
285     if ((isGtk() || isQt()) && $dir ne "WebKit") {
286         chdir ".." or die;
287         next;
288     }
289
290     if (isGtk()) {
291         $result = buildGtkProject($dir, $clean,  @options);
292     } elsif (isQt()) {
293         $result = buildQMakeQtProject($dir, $clean, @ARGV);
294     } elsif (isAppleMacWebKit()) {
295         my @xcodeOptions = ();
296         push(@xcodeOptions, @options);
297         push(@xcodeOptions, $overrideFeatureDefinesString);
298         push(@xcodeOptions, @coverageSupportOption);
299         push(@xcodeOptions, @ARGV);
300         $result = buildXCodeProject($dir, $clean, @xcodeOptions);
301     } elsif (isAppleWinWebKit()) {
302         if ($dir eq "WebKit") {
303             $result = buildVisualStudioProject("win/WebKit.vcproj/WebKit.sln", $clean);
304         }
305     } elsif (isChromium()) {
306         $result = buildSconsProject($dir, $clean);
307     }
308
309     if (exitStatus($result)) {
310         if (isAppleWinWebKit()) {
311             print "\n\n===== BUILD FAILED ======\n\n";
312             my $scriptDir = relativeScriptsDir();
313             print "Please ensure you have run $scriptDir/update-webkit to install depenedencies.\n\n";
314             my $baseProductDir = baseProductDir();
315             print "You can view build errors by checking the BuildLog.htm files located at:\n$baseProductDir/obj/<project>/<config>.\n";
316         }
317         exit exitStatus($result);
318     }
319     chdir ".." or die;
320 }
321
322 # Don't report the "WebKit is now built" message after a clean operation.
323 exit if $clean;
324
325 # Write out congratulations message.
326
327 my $launcherPath = launcherPath();
328 my $launcherName = launcherName();
329
330 print "\n";
331 print "===========================================================\n";
332 print " WebKit is now built. To run $launcherName with this newly-built\n";
333 print " code, use the \"$launcherPath\" script.\n";
334 if ($svgSupport) {
335     print "\n NOTE: WebKit has been built with SVG support enabled.\n";
336     print " $launcherName will have SVG viewing capabilities.\n";
337 }
338 if ($svgAnimationSupport or $svgFiltersSupport or $svgForeignObjectSupport or $svgFontsSupport or $svgAsImageSupport or $svgUseSupport) {
339     print " Your build supports the following (optional) SVG features: \n";
340     print "  * Basic SVG animation.\n" if $svgAnimationSupport;
341     print "  * SVG filters.\n" if $svgFiltersSupport;
342     print "  * SVG foreign object.\n" if $svgForeignObjectSupport;
343     print "  * SVG fonts.\n" if $svgFontsSupport;
344     print "  * SVG as image.\n" if $svgAsImageSupport;
345     print "  * SVG <use> support.\n" if $svgUseSupport;
346 }
347 print "===========================================================\n";