Changes based on input from Michael Kahl.
[WebKit-https.git] / WebKitTools / Scripts / webkitdirs.pm
1 # Copyright (C) 2005 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 &passedConfiguration &setConfiguration &checkFrameworks);
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 $XcodeVersion;
50 my $sourceDir;
51
52 sub determineSourceDir
53 {
54     return if $sourceDir;
55     $sourceDir = $FindBin::Bin;
56     if ($sourceDir !~ s|/[^/]+/[^/]+$||) {
57         die "Could not find two levels above source directory using FindBin.\n";
58     }
59 }
60
61 sub determineXcodeVersion
62 {
63     return if defined $XcodeVersion;
64     # Could use "xcodebuild -version" instead.
65     open VERSION, "defaults read /Developer/Applications/Xcode.app/Contents/Info CFBundleShortVersionString 2> /dev/null |" or die;
66     $XcodeVersion = <VERSION>;
67     close VERSION;
68     chomp $XcodeVersion;
69 }
70
71 sub determineBaseProductDir
72 {
73     return if defined $baseProductDir;
74     determineSourceDir();
75     open PRODUCT, "defaults read com.apple.Xcode PBXProductDirectory 2> /dev/null |" or die;
76     $baseProductDir = <PRODUCT>;
77     close PRODUCT;
78     if ($baseProductDir) {
79         chomp $baseProductDir;
80         $baseProductDir =~ s|^\Q$(SRCROOT)/..\E$|$sourceDir|;
81         $baseProductDir =~ s|^\Q$(SRCROOT)/../|$sourceDir/|;
82         $baseProductDir =~ s|^~/|$ENV{HOME}/|;
83         die "Can't handle Xcode product directory with a ~ in it.\n" if $baseProductDir =~ /~/;
84         die "Can't handle Xcode product directory with a variable in it.\n" if $baseProductDir =~ /\$/;
85         @baseProductDirOption = ();
86     } else {
87         $baseProductDir = "$sourceDir/WebKitBuild";
88         @baseProductDirOption = ("SYMROOT=$baseProductDir");
89     }
90 }
91
92 sub determineConfiguration
93 {
94     return if defined $configuration;
95     determineBaseProductDir();
96     if (open CONFIGURATION, "$baseProductDir/Configuration") {
97         $configuration = <CONFIGURATION>;
98         close CONFIGURATION;
99     }
100     if ($configuration) {
101         chomp $configuration;
102     } else {
103         $configuration = "Deployment";
104     }
105 }
106
107 sub oldXcode
108 {
109     determineXcodeVersion();
110     return $XcodeVersion =~ /^1\./ || $XcodeVersion eq "2.0";
111 }
112
113 sub determineConfigurationProductDir
114 {
115     determineBaseProductDir();
116     determineConfiguration();
117     determineXcodeVersion();
118     if (oldXcode()) {
119         $configurationProductDir = $baseProductDir;
120     } else {
121         $configurationProductDir = "$baseProductDir/$configuration";
122     }
123 }
124
125 sub chdirWebKit
126 {
127     determineSourceDir();
128     chdir $sourceDir or die;
129 }
130
131 sub baseProductDir
132 {
133     determineBaseProductDir();
134     return $baseProductDir;
135 }
136
137 sub productDir
138 {
139     determineConfigurationProductDir();
140     return $configurationProductDir;
141 }
142
143 sub XcodeOptions
144 {
145     determineBaseProductDir();
146     determineConfiguration();
147     determineXcodeVersion();
148     return (@baseProductDirOption, "-buildstyle", $configuration) if oldXcode();
149     return (@baseProductDirOption, "-configuration", $configuration);
150 }
151
152 sub passedConfiguration
153 {
154     for my $opt (@ARGV) {
155         return "Development" if $opt =~ /^--devel/i;
156         return "Deployment" if $opt =~ /^--deploy/i;
157     }
158     return undef;
159 }
160
161 sub setConfiguration
162 {
163     my $passed = passedConfiguration();
164     $configuration = $passed if $passed;
165 }
166
167 # Check to see that all the frameworks are built.
168 sub checkFrameworks
169 {
170     determineConfigurationProductDir();
171     for my $framework ("JavaScriptCore", "WebCore", "WebKit") {
172         my $path = "$configurationProductDir/$framework.framework/Versions/A/$framework";
173         die "Can't find built framework at \"$path\".\n" unless -x $path;
174     }
175 }
176
177 1;