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