9fc81ee3870f17d024bc7dc5ed8c3430b4bb61fb
[WebKit-https.git] / WebKitTools / Scripts / webkitdirs.pm
1 # Copyright (C) 2005, 2006 Apple Computer, Inc.  All rights reserved.
2 #
3 # Redistribution and use in source and binary forms, with or without
4 # modification, are permitted provided that the following conditions
5 # are met:
6 #
7 # 1.  Redistributions of source code must retain the above copyright
8 #     notice, this list of conditions and the following disclaimer. 
9 # 2.  Redistributions in binary form must reproduce the above copyright
10 #     notice, this list of conditions and the following disclaimer in the
11 #     documentation and/or other materials provided with the distribution. 
12 # 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
13 #     its contributors may be used to endorse or promote products derived
14 #     from this software without specific prior written permission. 
15 #
16 # THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
17 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 # DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
20 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26
27 # Module to share code to get to WebKit directories.
28
29 use strict;
30 use warnings;
31 use FindBin;
32
33 BEGIN {
34    use Exporter   ();
35    our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
36    $VERSION     = 1.00;
37    @ISA         = qw(Exporter);
38    @EXPORT      = qw(&chdirWebKit &baseProductDir &productDir &XcodeOptions &XcodeOptionString &XcodeOptionStringNoConfig &passedConfiguration &setConfiguration &safariPath &checkFrameworks &currentSVNRevision);
39    %EXPORT_TAGS = ( );
40    @EXPORT_OK   = ();
41 }
42
43 our @EXPORT_OK;
44
45 my $baseProductDir;
46 my @baseProductDirOption;
47 my $configuration;
48 my $configurationProductDir;
49 my $sourceDir;
50 my $currentSVNRevision;
51
52 # Variables for Win32 support
53 my $vcBuildPath;
54 my $windowsTmpPath;
55
56 sub determineSourceDir
57 {
58     return if $sourceDir;
59     $sourceDir = $FindBin::Bin;
60     
61     # walks up path checking each directory to see if it is the main WebKit project dir, 
62     # defined by containing JavaScriptCore, WebCore, and WebKit
63     until ((-d "$sourceDir/JavaScriptCore" && -d "$sourceDir/WebCore" && -d "$sourceDir/WebKit") || (-d "$sourceDir/Internal" && -d "$sourceDir/OpenSource"))
64     {
65         if ($sourceDir !~ s|/[^/]+$||) {
66             die "Could not find top level webkit directory above source directory using FindBin.\n";
67         }
68     }
69
70     $sourceDir = "$sourceDir/OpenSource" if -d "$sourceDir/OpenSource";
71 }
72
73 # used for scripts which are stored in a non-standard location
74 sub setSourceDir($)
75 {
76     ($sourceDir) = @_;
77 }
78
79 sub determineBaseProductDir
80 {
81     return if defined $baseProductDir;
82     determineSourceDir();
83     if (isOSX()) {
84         open PRODUCT, "defaults read com.apple.Xcode PBXProductDirectory 2> /dev/null |" or die;
85         $baseProductDir = <PRODUCT>;
86         close PRODUCT;
87         if ($baseProductDir) {
88             chomp $baseProductDir;
89             undef $baseProductDir unless $baseProductDir =~ /^\//;
90         }
91     } else {
92         $baseProductDir = $ENV{"WEBKITOUTPUTDIR"};
93         if (isCygwin() && $baseProductDir) {
94             my $unixBuildPath = `cygpath --unix \"$baseProductDir\"`;
95             chomp $unixBuildPath;
96             $baseProductDir = $unixBuildPath;
97         }
98     }
99
100     if ($baseProductDir && isOSX()) {
101         $baseProductDir =~ s|^\Q$(SRCROOT)/..\E$|$sourceDir|;
102         $baseProductDir =~ s|^\Q$(SRCROOT)/../|$sourceDir/|;
103         $baseProductDir =~ s|^~/|$ENV{HOME}/|;
104         die "Can't handle Xcode product directory with a ~ in it.\n" if $baseProductDir =~ /~/;
105         die "Can't handle Xcode product directory with a variable in it.\n" if $baseProductDir =~ /\$/;
106         @baseProductDirOption = ();
107     }
108
109     if (!defined($baseProductDir)) {
110         $baseProductDir = "$sourceDir/WebKitBuild";
111         @baseProductDirOption = ("SYMROOT=$baseProductDir") if (isOSX());
112         if (isCygwin()) {
113             my $dosBuildPath = `cygpath --windows \"$baseProductDir\"`;
114             chomp $dosBuildPath;
115             $ENV{"WEBKITOUTPUTDIR"} = $dosBuildPath;
116         }
117     }
118 }
119
120 sub determineConfiguration
121 {
122     return if defined $configuration;
123     determineBaseProductDir();
124     if (open CONFIGURATION, "$baseProductDir/Configuration") {
125         $configuration = <CONFIGURATION>;
126         close CONFIGURATION;
127     }
128     if ($configuration) {
129         chomp $configuration;
130         # compatibility for people who have old Configuration files
131         $configuration = "Release" if $configuration eq "Deployment";
132         $configuration = "Debug" if $configuration eq "Development";
133     } else {
134         $configuration = "Release";
135     }
136 }
137
138 sub determineConfigurationProductDir
139 {
140     return if defined $configurationProductDir;
141     determineBaseProductDir();
142     if(isCygwin()) {
143         $configurationProductDir = "$baseProductDir/bin";
144     } else {
145         determineConfiguration();
146         $configurationProductDir = "$baseProductDir/$configuration";
147     }
148 }
149
150 sub determineCurrentSVNRevision
151 {
152     return if defined $currentSVNRevision;
153     determineSourceDir();
154     my $svnInfo = `svn info $sourceDir | grep Revision:`;
155     ($currentSVNRevision) = ($svnInfo =~ m/Revision: (\d+).*/g);
156     die "Unable to determine current SVN revision in $sourceDir" unless (defined $currentSVNRevision);
157     return $currentSVNRevision;
158 }
159
160
161 sub chdirWebKit
162 {
163     determineSourceDir();
164     chdir $sourceDir or die;
165 }
166
167 sub baseProductDir
168 {
169     determineBaseProductDir();
170     return $baseProductDir;
171 }
172
173 sub sourceDir
174 {
175     determineSourceDir();
176     return $sourceDir;
177 }
178
179 sub productDir
180 {
181     determineConfigurationProductDir();
182     return $configurationProductDir;
183 }
184
185 sub configuration()
186 {
187     determineConfiguration();
188     return $configuration;
189 }
190
191 sub currentSVNRevision
192 {
193     determineCurrentSVNRevision();
194     return $currentSVNRevision;
195 }
196
197 sub XcodeOptions
198 {
199     determineBaseProductDir();
200     determineConfiguration();
201     return (@baseProductDirOption, "-configuration", $configuration);
202 }
203
204 sub XcodeOptionString
205 {
206     return join " ", XcodeOptions();
207 }
208
209 sub XcodeOptionStringNoConfig
210 {
211     return join " ", @baseProductDirOption;
212 }
213
214 my $passedConfiguration;
215 my $searchedForPassedConfiguration;
216 sub determinePassedConfiguration
217 {
218     return if $searchedForPassedConfiguration;
219     $searchedForPassedConfiguration = 1;
220     for my $i (0 .. $#ARGV) {
221         my $opt = $ARGV[$i];
222         if ($opt =~ /^--debug$/i || $opt =~ /^--devel/i) {
223             splice(@ARGV, $i, 1);
224             $passedConfiguration = "Debug";
225             return;
226         }
227         if ($opt =~ /^--release$/i || $opt =~ /^--deploy/i) {
228             splice(@ARGV, $i, 1);
229             $passedConfiguration = "Release";
230             return;
231         }
232     }
233     $passedConfiguration = undef;
234 }
235
236 sub passedConfiguration
237 {
238     determinePassedConfiguration();
239     return $passedConfiguration;
240 }
241
242 sub setConfiguration
243 {
244     if (my $config = shift @_) {
245         $configuration = $config;
246         return;
247     }
248
249     determinePassedConfiguration();
250     $configuration = $passedConfiguration if $passedConfiguration;
251 }
252
253 # Locate Safari.
254 sub safariPath
255 {
256     # Use WEBKIT_SAFARI environment variable if present.
257     my $safariBundle = $ENV{WEBKIT_SAFARI};
258     if (!$safariBundle) {
259         determineConfigurationProductDir();
260         # Use Safari.app in product directory if present (good for Safari development team).
261         if (-d "$configurationProductDir/Safari.app") {
262             $safariBundle = "$configurationProductDir/Safari.app";
263         } else {
264             # Otherwise use Safari.app in Applications directory.
265             $safariBundle = "/Applications/Safari.app";
266         }
267     }
268     my $safariPath = "$safariBundle/Contents/MacOS/Safari";
269     die "Can't find executable at $safariPath.\n" unless -x $safariPath;
270     return $safariPath;
271 }
272
273 sub builtDylibPathForName
274 {
275     my $framework = shift;
276     determineConfigurationProductDir();
277     if (isQt()) {
278         return "$configurationProductDir/$framework";
279     }
280     if (isOSX()) {
281         return "$configurationProductDir/$framework.framework/Versions/A/$framework";
282     }
283     if (isCygwin()) {
284         if ($framework eq "JavaScriptCore") {
285                 return "$baseProductDir/lib/$framework.lib";
286         } else {
287             return "$baseProductDir/$framework.intermediate/$configuration/$framework.intermediate/$framework.lib";
288         }
289     }
290
291     die "Unsupported platform, can't determine built library locations.";
292 }
293
294 # Check to see that all the frameworks are built.
295 sub checkFrameworks
296 {
297     my @frameworks = ("JavaScriptCore", "WebCore");
298     push(@frameworks, "WebKit") if isOSX();
299     for my $framework (@frameworks) {
300         my $path = builtDylibPathForName($framework);
301         die "Can't find built framework at \"$path\".\n" unless -x $path;
302     }
303 }
304
305 sub hasSVGSupport
306 {
307     return 0 if isCygwin();
308
309     my $path = shift;
310
311     if ((isQt()) and ($path =~ /WebCore/)) {
312         $path .= "/../lib/libWebKitQt.so";
313     }
314
315     open NM, "-|", "nm", $path or die;
316     my $hasSVGSupport = 0;
317     while (<NM>) {
318         $hasSVGSupport = 1 if /SVGElement/;
319     }
320     close NM;
321     return $hasSVGSupport;
322 }
323
324 sub removeLibraryDependingOnSVG
325 {
326     my $frameworkName = shift;
327     my $shouldHaveSVG = shift;
328
329     my $path = builtDylibPathForName($frameworkName);
330     return unless -x $path;
331
332     my $hasSVG = hasSVGSupport($path);
333     system "rm -f $path" if ($shouldHaveSVG xor $hasSVG);
334 }
335
336 sub checkWebCoreSVGSupport
337 {
338     my $required = shift;
339     my $framework = "WebCore";
340     my $path = builtDylibPathForName($framework);
341     my $hasSVG = hasSVGSupport($path);
342     if ($required && !$hasSVG) {
343         die "$framework at \"$path\" does not include SVG Support, please run build-webkit --svg\n";
344     }
345     return $hasSVG;
346 }
347
348 sub isQt()
349 {
350     return defined($ENV{'QTDIR'})
351 }
352
353 sub isQtWithQMake()
354 {
355     our @cmakeBuild;
356     return (isQt() and (@cmakeBuild eq 0))
357 }
358
359 sub isCygwin()
360 {
361     return ($^O eq "cygwin");
362 }
363
364 sub isOSX()
365 {
366     return ($^O eq "darwin");
367 }
368
369 sub checkRequiredSystemConfig
370 {
371     if (isOSX()) {
372         chomp(my $productVersion = `sw_vers -productVersion`);
373         if ($productVersion lt "10.4") {
374             print "*************************************************************\n";
375             print "Mac OS X Version 10.4.0 or later is required to build WebKit.\n";
376             print "You have " . $productVersion . ", thus the build will most likely fail.\n";
377             print "*************************************************************\n";
378         }
379         my $xcodeVersion = `xcodebuild -version`;
380         if ($xcodeVersion !~ /DevToolsCore-(\d+)/ || $1 < 747) {
381             print "*************************************************************\n";
382             print "Xcode Version 2.3 or later is required to build WebKit.\n";
383             print "You have an earlier version of Xcode, thus the build will\n";
384             print "most likely fail.  The latest Xcode is available from the web:\n";
385             print "http://developer.apple.com/tools/xcode\n";
386             print "*************************************************************\n";
387         }
388     }
389     # Win32 and other platforms may want to check for minimum config
390 }
391
392 sub setupCygwinEnv()
393 {
394     return if !isCygwin();
395     return if $vcBuildPath;
396
397     my $programFilesPath = `cygpath "$ENV{'PROGRAMFILES'}"`;
398     chomp $programFilesPath;
399     $vcBuildPath = "$programFilesPath/Microsoft Visual Studio 8/Common7/IDE/devenv.com";
400     if (! -e $vcBuildPath) {
401         # VC++ not found, try VC++ Express
402         my $vsInstallDir;
403         if ($ENV{'VSINSTALLDIR'}) {
404             $vsInstallDir = $ENV{'VSINSTALLDIR'};
405         } else {
406             $programFilesPath = $ENV{'PROGRAMFILES'} || "C:\\Program Files";
407             $vsInstallDir = "$programFilesPath/Microsoft Visual Studio 8";
408         }
409         $vsInstallDir = `cygpath "$vsInstallDir"`;
410         chomp $vsInstallDir;
411         $vcBuildPath = "$vsInstallDir/Common7/IDE/VCExpress.exe";
412         if (! -e $vcBuildPath) {
413             print "*************************************************************\n";
414             print "Cannot find '$vcBuildPath'\n";
415             print "Please execute the file 'vcvars32.bat' from\n";
416             print "'$programFilesPath\\Microsoft Visual Studio 8\\VC\\bin\\'\n";
417             print "to setup the necessary environment variables.\n";
418             print "*************************************************************\n";
419             die;
420         }
421     }
422
423     $windowsTmpPath = `cygpath -w /tmp`;
424     chomp $windowsTmpPath;
425     print "Building results into: ", baseProductDir(), "\n";
426     print "WEBKITOUTPUTDIR is set to: ", $ENV{"WEBKITOUTPUTDIR"}, "\n";
427 }
428
429 sub buildVisualStudioProject($)
430 {
431     my ($project) = @_;
432     setupCygwinEnv();
433
434     chdir "$project.vcproj" or die "Failed to cd into $project.vcproj\n";
435     my $config = configuration();
436
437     print "$vcBuildPath $project.sln /build $config";
438     my $result = system $vcBuildPath, "$project.sln", "/build", $config;
439     chdir ".." or die;
440     return $result;
441 }
442
443 sub buildCMakeProject($$)
444 {
445     my ($project, $colorize) = @_;
446
447     if ($project ne "WebKit") { 
448         die "Qt/Linux builds JavaScriptCore/WebCore/WebKitQt in one shot! Only call it for 'WebKit'.\n";
449     }
450
451     my $config = configuration();
452     my $prefix = $ENV{"WebKitInstallationPrefix"};
453  
454     my @buildArgs = ("-DCMAKE_BUILD_TYPE=$config");
455     push @buildArgs, "-DCMAKE_INSTALL_PREFIX=" . $prefix if(defined($prefix));
456     push @buildArgs, "-DWEBKIT_DO_NOT_USE_COLORFUL_OUTPUT=" . ($colorize ? "OFF" : "ON");
457     push @buildArgs, "../../";
458
459     print "Calling 'cmake @buildArgs' in " . baseProductDir() . "/$config ...\n\n";
460     print "Installation directory: $prefix\n" if(defined($prefix));
461
462     system "mkdir -p " . baseProductDir() . "/$config";
463     chdir baseProductDir() . "/$config" or die "Failed to cd into " . baseProductDir() . "/$config \n";
464
465     my $result = system "cmake", @buildArgs;
466     if($result ne 0) {
467        die "Failed to setup build environment using cmake!\n";
468     }
469
470     $result = system "make";
471     chdir ".." or die;
472     return $result;
473 }
474
475 sub buildQMakeProject($$)
476 {
477     my ($project, $colorize) = @_;
478
479     if ($project ne "WebKit") {
480         die "Qt/Linux builds JavaScriptCore/WebCore/WebKitQt in one shot! Only call it for 'WebKit'.\n";
481     }
482
483     my $config = configuration();
484     my $prefix = $ENV{"WebKitInstallationPrefix"};
485
486     my @buildArgs = ("-r");
487     push @buildArgs, "OUTPUT_DIR=" . baseProductDir() . "/$config";
488     push @buildArgs, sourceDir() . "/WebKit.pro";
489
490     print "Calling 'qmake @buildArgs' in " . baseProductDir() . "/$config ...\n\n";
491     print "Installation directory: $prefix\n" if(defined($prefix));
492
493     system "mkdir -p " . baseProductDir() . "/$config";
494     chdir baseProductDir() . "/$config" or die "Failed to cd into " . baseProductDir() . "/$config \n";
495
496     my $result = system "qmake", @buildArgs;
497     if($result ne 0) {
498        die "Failed to setup build environment using qmake!\n";
499     }
500
501     my $clean = $ENV{"WEBKIT_FULLBUILD"};
502
503     if(defined $clean) {
504       system "make clean";
505     }
506
507     $result = system "make";
508     chdir ".." or die;
509     return $result;
510 }
511
512 1;