# Copyright (C) 2005, 2006, 2007, 2010 Apple Inc. All rights reserved.

# Copyright (C) 2009 Google Inc. All rights reserved.

#

# Redistribution and use in source and binary forms, with or without

# modification, are permitted provided that the following conditions

# are met:

#

# 1.  Redistributions of source code must retain the above copyright

#     notice, this list of conditions and the following disclaimer. 

# 2.  Redistributions in binary form must reproduce the above copyright

#     notice, this list of conditions and the following disclaimer in the

#     documentation and/or other materials provided with the distribution. 

# 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of

#     its contributors may be used to endorse or promote products derived

#     from this software without specific prior written permission. 

#

# THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY

# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

# DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY

# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF

# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# Module to share code to get to WebKit directories.

use strict;

use warnings;

use Config;

use FindBin;

use File::Basename;

use File::Path;

use File::Spec;

use POSIX;

use VCSUtils;

BEGIN {

   use Exporter   ();

   our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);

   $VERSION     = 1.00;

   @ISA         = qw(Exporter);

   @EXPORT      = qw(&chdirWebKit &baseProductDir &productDir &XcodeOptions &XcodeOptionString &XcodeOptionStringNoConfig &passedConfiguration &setConfiguration &safariPath &checkFrameworks &currentSVNRevision);

   %EXPORT_TAGS = ( );

   @EXPORT_OK   = ();

}

our @EXPORT_OK;

my $architecture;

my $numberOfCPUs;

my $baseProductDir;

my @baseProductDirOption;

my $configuration;

my $configurationForVisualStudio;

my $configurationProductDir;

my $sourceDir;

my $currentSVNRevision;

my $osXVersion;

my $isQt;

my $isSymbian;

my %qtFeatureDefaults;

my $isGtk;

my $isWx;

my $isEfl;

my @wxArgs;

my $isChromium;

my $isInspectorFrontend;

# Variables for Win32 support

my $vcBuildPath;

my $windowsTmpPath;

my $windowsSourceDir;

my $winVersion;

my $willUseVCExpressWhenBuilding = 0;

# Defined in VCSUtils.

sub exitStatus($);

sub determineSourceDir

{

    return if $sourceDir;

    $sourceDir = $FindBin::Bin;

    $sourceDir =~ s|/+$||; # Remove trailing '/' as we would die later

    # walks up path checking each directory to see if it is the main WebKit project dir, 

    # defined by containing JavaScriptCore, WebCore, and WebKit

    until ((-d "$sourceDir/JavaScriptCore" && -d "$sourceDir/WebCore" && -d "$sourceDir/WebKit") || (-d "$sourceDir/Internal" && -d "$sourceDir/OpenSource"))

    {

        if ($sourceDir !~ s|/[^/]+$||) {

            die "Could not find top level webkit directory above source directory using FindBin.\n";

        }

    }

    $sourceDir = "$sourceDir/OpenSource" if -d "$sourceDir/OpenSource";

}

sub currentPerlPath()

{

    my $thisPerl = $^X;

    if ($^O ne 'VMS') {

        $thisPerl .= $Config{_exe} unless $thisPerl =~ m/$Config{_exe}$/i;

    }

    return $thisPerl;

}

# used for scripts which are stored in a non-standard location

sub setSourceDir($)

{

    ($sourceDir) = @_;

}

sub determineBaseProductDir

{

    return if defined $baseProductDir;

    determineSourceDir();

    $baseProductDir = $ENV{"WEBKITOUTPUTDIR"};

    if (!defined($baseProductDir) and isAppleMacWebKit()) {

        # Silently remove ~/Library/Preferences/xcodebuild.plist which can

        # cause build failure. The presence of

        # ~/Library/Preferences/xcodebuild.plist can prevent xcodebuild from

        # respecting global settings such as a custom build products directory

        # (<rdar://problem/5585899>).

        my $personalPlistFile = $ENV{HOME} . "/Library/Preferences/xcodebuild.plist";

        if (-e $personalPlistFile) {

            unlink($personalPlistFile) || die "Could not delete $personalPlistFile: $!";

        }

        open PRODUCT, "defaults read com.apple.Xcode PBXApplicationwideBuildSettings 2> " . File::Spec->devnull() . " |" or die;

        $baseProductDir = join '', <PRODUCT>;

        close PRODUCT;

        $baseProductDir = $1 if $baseProductDir =~ /SYMROOT\s*=\s*\"(.*?)\";/s;

        undef $baseProductDir unless $baseProductDir =~ /^\//;

        if (!defined($baseProductDir)) {

            open PRODUCT, "defaults read com.apple.Xcode PBXProductDirectory 2> " . File::Spec->devnull() . " |" or die;

            $baseProductDir = <PRODUCT>;

            close PRODUCT;

            if ($baseProductDir) {

                chomp $baseProductDir;

                undef $baseProductDir unless $baseProductDir =~ /^\//;

            }

        }

    } elsif (isSymbian()) {

        # Shadow builds are not supported on Symbian

        $baseProductDir = $sourceDir;

    }

    if (!defined($baseProductDir)) { # Port-spesific checks failed, use default

        $baseProductDir = "$sourceDir/WebKitBuild";

    }

    if (isGit() && isGitBranchBuild()) {

        my $branch = gitBranch();

        $baseProductDir = "$baseProductDir/$branch";

    }

    if (isAppleMacWebKit()) {

        $baseProductDir =~ s|^\Q$(SRCROOT)/..\E$|$sourceDir|;

        $baseProductDir =~ s|^\Q$(SRCROOT)/../|$sourceDir/|;

        $baseProductDir =~ s|^~/|$ENV{HOME}/|;

        die "Can't handle Xcode product directory with a ~ in it.\n" if $baseProductDir =~ /~/;

        die "Can't handle Xcode product directory with a variable in it.\n" if $baseProductDir =~ /\$/;

        @baseProductDirOption = ("SYMROOT=$baseProductDir", "OBJROOT=$baseProductDir");

    }

    if (isCygwin()) {

        my $dosBuildPath = `cygpath --windows \"$baseProductDir\"`;

        chomp $dosBuildPath;

        $ENV{"WEBKITOUTPUTDIR"} = $dosBuildPath;

    }

    if (isAppleWinWebKit()) {

        my $unixBuildPath = `cygpath --unix \"$baseProductDir\"`;

        chomp $unixBuildPath;

        $baseProductDir = $unixBuildPath;

    }

}

sub setBaseProductDir($)

{

    ($baseProductDir) = @_;

}

sub determineConfiguration

{

    return if defined $configuration;

    determineBaseProductDir();

    if (open CONFIGURATION, "$baseProductDir/Configuration") {

        $configuration = <CONFIGURATION>;

        close CONFIGURATION;

    }

    if ($configuration) {

        chomp $configuration;

        # compatibility for people who have old Configuration files

        $configuration = "Release" if $configuration eq "Deployment";

        $configuration = "Debug" if $configuration eq "Development";

    } else {

        $configuration = "Release";

    }

}

sub determineArchitecture

{

    return if defined $architecture;

    # make sure $architecture is defined for non-apple-mac builds

    $architecture = "";

    return unless isAppleMacWebKit();

    determineBaseProductDir();

    if (open ARCHITECTURE, "$baseProductDir/Architecture") {

        $architecture = <ARCHITECTURE>;

        close ARCHITECTURE;

    }

    if ($architecture) {

        chomp $architecture;

    } else {

        if (isTiger() or isLeopard()) {

            $architecture = `arch`;

        } else {

            my $supports64Bit = `sysctl -n hw.optional.x86_64`;

            chomp $supports64Bit;

            $architecture = $supports64Bit ? 'x86_64' : `arch`;

        }

        chomp $architecture;

    }

}

sub determineNumberOfCPUs

{

    return if defined $numberOfCPUs;

    if (isLinux()) {

        # First try the nproc utility, if it exists. If we get no

        # results fall back to just interpretting /proc directly.

        chomp($numberOfCPUs = `nproc 2> /dev/null`);

        if ($numberOfCPUs eq "") {

            $numberOfCPUs = (grep /processor/, `cat /proc/cpuinfo`);

        }

    } elsif (isWindows() || isCygwin()) {

        if (defined($ENV{NUMBER_OF_PROCESSORS})) {

            $numberOfCPUs = $ENV{NUMBER_OF_PROCESSORS};

        } else {

            # Assumes cygwin

            $numberOfCPUs = `ls /proc/registry/HKEY_LOCAL_MACHINE/HARDWARE/DESCRIPTION/System/CentralProcessor | wc -w`;

        }

    } elsif (isDarwin()) {

        $numberOfCPUs = `sysctl -n hw.ncpu`;

    }

}

sub jscPath($)

{

    my ($productDir) = @_;

    my $jscName = "jsc";

    $jscName .= "_debug"  if (isCygwin() && ($configuration eq "Debug"));

    return "$productDir/$jscName" if -e "$productDir/$jscName";

    return "$productDir/JavaScriptCore.framework/Resources/$jscName";

}

sub argumentsForConfiguration()

{

    determineConfiguration();

    determineArchitecture();

    my @args = ();

    push(@args, '--debug') if $configuration eq "Debug";

    push(@args, '--release') if $configuration eq "Release";

    push(@args, '--32-bit') if $architecture ne "x86_64";

    push(@args, '--qt') if isQt();

    push(@args, '--symbian') if isSymbian();

    push(@args, '--gtk') if isGtk();

    push(@args, '--efl') if isEfl();

    push(@args, '--wx') if isWx();

    push(@args, '--chromium') if isChromium();

    push(@args, '--inspector-frontend') if isInspectorFrontend();

    return @args;

}

sub determineConfigurationForVisualStudio

{

    return if defined $configurationForVisualStudio;

    determineConfiguration();

    $configurationForVisualStudio = $configuration;

    return unless $configuration eq "Debug";

    setupCygwinEnv();

    chomp(my $dir = `cygpath -ua '$ENV{WEBKITLIBRARIESDIR}'`);

    $configurationForVisualStudio = "Debug_Internal" if -f "$dir/bin/CoreFoundation_debug.dll";

}

sub determineConfigurationProductDir

{

    return if defined $configurationProductDir;

    determineBaseProductDir();

    determineConfiguration();

    if (isAppleWinWebKit() && !isWx()) {

        $configurationProductDir = "$baseProductDir/bin";

    } else {

        # [Gtk][Efl] We don't have Release/Debug configurations in straight

        # autotool builds (non build-webkit). In this case and if

        # WEBKITOUTPUTDIR exist, use that as our configuration dir. This will

        # allows us to run run-webkit-tests without using build-webkit.

        if ($ENV{"WEBKITOUTPUTDIR"} && (isGtk() || isEfl())) {

            $configurationProductDir = "$baseProductDir";

        } else {

            $configurationProductDir = "$baseProductDir/$configuration";

        }

    }

}

sub setConfigurationProductDir($)

{

    ($configurationProductDir) = @_;

}

sub determineCurrentSVNRevision

{

    return if defined $currentSVNRevision;

    determineSourceDir();

    $currentSVNRevision = svnRevisionForDirectory($sourceDir);

    return $currentSVNRevision;

}

sub chdirWebKit

{

    determineSourceDir();

    chdir $sourceDir or die;

}

sub baseProductDir

{

    determineBaseProductDir();

    return $baseProductDir;

}

sub sourceDir

{

    determineSourceDir();

    return $sourceDir;

}

sub productDir

{

    determineConfigurationProductDir();

    return $configurationProductDir;

}

sub jscProductDir

{

    my $productDir = productDir();

    $productDir .= "/JavaScriptCore" if isQt();

    $productDir .= "/$configuration" if (isQt() && isWindows());

    $productDir .= "/Programs" if (isGtk() || isEfl());

    return $productDir;

}

sub configuration()

{

    determineConfiguration();

    return $configuration;

}

sub configurationForVisualStudio()

{

    determineConfigurationForVisualStudio();

    return $configurationForVisualStudio;

}

sub currentSVNRevision

{

    determineCurrentSVNRevision();

    return $currentSVNRevision;

}

sub XcodeOptions

{

    determineBaseProductDir();

    determineConfiguration();

    determineArchitecture();

    return (@baseProductDirOption, "-configuration", $configuration, "ARCHS=$architecture");

}

sub XcodeOptionString

{

    return join " ", XcodeOptions();

}

sub XcodeOptionStringNoConfig

{

    return join " ", @baseProductDirOption;

}

sub XcodeCoverageSupportOptions()

{

    my @coverageSupportOptions = ();

    push @coverageSupportOptions, "GCC_GENERATE_TEST_COVERAGE_FILES=YES";

    push @coverageSupportOptions, "GCC_INSTRUMENT_PROGRAM_FLOW_ARCS=YES";

    push @coverageSupportOptions, "EXTRA_LINK= \$(EXTRA_LINK) -ftest-coverage -fprofile-arcs";

    push @coverageSupportOptions, "OTHER_CFLAGS= \$(OTHER_CFLAGS) -DCOVERAGE -MD";

    push @coverageSupportOptions, "OTHER_LDFLAGS=\$(OTHER_LDFLAGS) -ftest-coverage -fprofile-arcs -framework AppKit";

    return @coverageSupportOptions;

}

my $passedConfiguration;

my $searchedForPassedConfiguration;

sub determinePassedConfiguration

{

    return if $searchedForPassedConfiguration;

    $searchedForPassedConfiguration = 1;

    my $isWinCairo = checkForArgumentAndRemoveFromARGV("--cairo-win32");

    for my $i (0 .. $#ARGV) {

        my $opt = $ARGV[$i];

        if ($opt =~ /^--debug$/i || $opt =~ /^--devel/i) {

            splice(@ARGV, $i, 1);

            $passedConfiguration = "Debug";

            $passedConfiguration .= "_Cairo" if ($isWinCairo && isCygwin());

            return;

        }

        if ($opt =~ /^--release$/i || $opt =~ /^--deploy/i) {

            splice(@ARGV, $i, 1);

            $passedConfiguration = "Release";

            $passedConfiguration .= "_Cairo" if ($isWinCairo && isCygwin());

            return;

        }

        if ($opt =~ /^--profil(e|ing)$/i) {

            splice(@ARGV, $i, 1);

            $passedConfiguration = "Profiling";

            $passedConfiguration .= "_Cairo" if ($isWinCairo && isCygwin());

            return;

        }

    }

    $passedConfiguration = undef;

}

sub passedConfiguration

{

    determinePassedConfiguration();

    return $passedConfiguration;

}

sub setConfiguration

{

    setArchitecture();

    if (my $config = shift @_) {

        $configuration = $config;

        return;

    }

    determinePassedConfiguration();

    $configuration = $passedConfiguration if $passedConfiguration;

}

my $passedArchitecture;

my $searchedForPassedArchitecture;

sub determinePassedArchitecture

{

    return if $searchedForPassedArchitecture;

    $searchedForPassedArchitecture = 1;

    for my $i (0 .. $#ARGV) {

        my $opt = $ARGV[$i];

        if ($opt =~ /^--32-bit$/i) {

            splice(@ARGV, $i, 1);

            if (isAppleMacWebKit()) {

                $passedArchitecture = `arch`;

                chomp $passedArchitecture;

            }

            return;

        }

    }

    $passedArchitecture = undef;

}

sub passedArchitecture

{

    determinePassedArchitecture();

    return $passedArchitecture;

}

sub architecture()

{

    determineArchitecture();

    return $architecture;

}

sub numberOfCPUs()

{

    determineNumberOfCPUs();

    return $numberOfCPUs;

}

sub setArchitecture

{

    if (my $arch = shift @_) {

        $architecture = $arch;

        return;

    }

    determinePassedArchitecture();

    $architecture = $passedArchitecture if $passedArchitecture;

}

sub safariPathFromSafariBundle

{

    my ($safariBundle) = @_;

    return "$safariBundle/Contents/MacOS/Safari" if isAppleMacWebKit();

    return $safariBundle if isAppleWinWebKit();

}

sub installedSafariPath

{

    my $safariBundle;

    if (isAppleMacWebKit()) {

        $safariBundle = "/Applications/Safari.app";

    } elsif (isAppleWinWebKit()) {