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