# Copyright (C) 2005, 2006, 2007 Apple 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 FindBin;

use File::Basename;

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 $baseProductDir;

my @baseProductDirOption;

my $configuration;

my $configurationForVisualStudio;

my $configurationProductDir;

my $sourceDir;

my $currentSVNRevision;

my $osXVersion;

my $isQt;

my $isGtk;

# Variables for Win32 support

my $vcBuildPath;

my $windowsTmpPath;

sub determineSourceDir

{

    return if $sourceDir;

    $sourceDir = $FindBin::Bin;

    # 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";

}

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

sub setSourceDir($)

{

    ($sourceDir) = @_;

}

sub determineBaseProductDir

{

    return if defined $baseProductDir;

    determineSourceDir();

    if (isOSX()) {

        open PRODUCT, "defaults read com.apple.Xcode PBXApplicationwideBuildSettings 2> /dev/null |" 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> /dev/null |" or die;

            $baseProductDir = <PRODUCT>;

            close PRODUCT;

            if ($baseProductDir) {

                chomp $baseProductDir;

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

            }

        }

    } else {

        $baseProductDir = $ENV{"WEBKITOUTPUTDIR"};

        if (isCygwin() && $baseProductDir) {

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

            chomp $unixBuildPath;

            $baseProductDir = $unixBuildPath;

        }

    }

    if ($baseProductDir && isOSX()) {

        $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 = ();

    }

    if (!defined($baseProductDir)) {

        $baseProductDir = "$sourceDir/WebKitBuild";

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

        if (isCygwin()) {

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

            chomp $dosBuildPath;

            $ENV{"WEBKITOUTPUTDIR"} = $dosBuildPath;

        }

    }

}

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 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();

    if(isCygwin()) {

        $configurationProductDir = "$baseProductDir/bin";

    } else {

        determineConfiguration();

        $configurationProductDir = "$baseProductDir/$configuration";

    }

}

sub setConfigurationProductDir($)

{

    ($configurationProductDir) = @_;

}

sub determineCurrentSVNRevision

{

    return if defined $currentSVNRevision;

    determineSourceDir();

    my $svnInfo = `LC_ALL=C svn info $sourceDir | grep Revision:`;

    ($currentSVNRevision) = ($svnInfo =~ m/Revision: (\d+).*/g);

    die "Unable to determine current SVN revision in $sourceDir" unless (defined $currentSVNRevision);

    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 configuration()

{

    determineConfiguration();

    return $configuration;

}

sub configurationForVisualStudio()

{

    determineConfigurationForVisualStudio();

    return $configurationForVisualStudio;

}

sub currentSVNRevision

{

    determineCurrentSVNRevision();

    return $currentSVNRevision;

}

sub XcodeOptions

{

    determineBaseProductDir();

    determineConfiguration();

    return (@baseProductDirOption, "-configuration", $configuration);

}

sub XcodeOptionString

{

    return join " ", XcodeOptions();

}

sub XcodeOptionStringNoConfig

{

    return join " ", @baseProductDirOption;

}

my $passedConfiguration;

my $searchedForPassedConfiguration;

sub determinePassedConfiguration

{

    return if $searchedForPassedConfiguration;

    $searchedForPassedConfiguration = 1;

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

        my $opt = $ARGV[$i];

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

            splice(@ARGV, $i, 1);

            $passedConfiguration = "Debug";

            return;

        }

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

            splice(@ARGV, $i, 1);

            $passedConfiguration = "Release";

            return;

        }

    }

    $passedConfiguration = undef;

}

sub passedConfiguration

{

    determinePassedConfiguration();

    return $passedConfiguration;

}

sub setConfiguration

{

    if (my $config = shift @_) {

        $configuration = $config;

        return;

    }

    determinePassedConfiguration();

    $configuration = $passedConfiguration if $passedConfiguration;

}

sub safariPathFromSafariBundle

{

    my ($safariBundle) = @_;

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

    return $safariBundle if isCygwin();

}

sub installedSafariPath

{

    my $safariBundle;

    if (isOSX()) {

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

    } elsif (isCygwin()) {

        $safariBundle = `"$configurationProductDir/FindSafari.exe"`;

        $safariBundle =~ s/[\r\n]+$//;

        $safariBundle = `cygpath -u '$safariBundle'`;

        $safariBundle =~ s/[\r\n]+$//;

        $safariBundle .= "Safari.exe";

    }

    return safariPathFromSafariBundle($safariBundle);

}

# Locate Safari.

sub safariPath

{

    # Use WEBKIT_SAFARI environment variable if present.

    my $safariBundle = $ENV{WEBKIT_SAFARI};

    if (!$safariBundle) {

        determineConfigurationProductDir();

        # Use Safari.app in product directory if present (good for Safari development team).

        if (isOSX() && -d "$configurationProductDir/Safari.app") {

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

        } elsif (isCygwin() && -x "$configurationProductDir/bin/Safari.exe") {

            $safariBundle = "$configurationProductDir/bin/Safari.exe";

        } else {

            return installedSafariPath();

        }

    }

    my $safariPath = safariPathFromSafariBundle($safariBundle);

    die "Can't find executable at $safariPath.\n" if isOSX() && !-x $safariPath;

    return $safariPath;

}

sub builtDylibPathForName

{

    my $framework = shift;

    determineConfigurationProductDir();

    if (isQt() or isGtk()) {

        return "$configurationProductDir/$framework";

    }

    if (isOSX()) {

        return "$configurationProductDir/$framework.framework/Versions/A/$framework";

    }

    if (isCygwin()) {

        if ($framework eq "JavaScriptCore") {

                return "$baseProductDir/lib/$framework.lib";

        } else {

            return "$baseProductDir/$framework.intermediate/$configuration/$framework.intermediate/$framework.lib";

        }

    }

    die "Unsupported platform, can't determine built library locations.";

}

# Check to see that all the frameworks are built.

sub checkFrameworks

{

    return if isCygwin();

    my @frameworks = ("JavaScriptCore", "WebCore");

    push(@frameworks, "WebKit") if isOSX() and not isGtk() and not isQt();

    for my $framework (@frameworks) {

        my $path = builtDylibPathForName($framework);

        die "Can't find built framework at \"$path\".\n" unless -x $path;

    }

}

sub hasSVGSupport

{

    return 0 if isCygwin();

    my $path = shift;

    if (isQt()) {

        return 1;

    }

    if (isGtk() and $path =~ /WebCore/) {

        $path .= "/../lib/libWebKitGtk.so";

    }

    open NM, "-|", "nm", $path or die;

    my $hasSVGSupport = 0;

    while (<NM>) {

        $hasSVGSupport = 1 if /SVGElement/;

    }

    close NM;

    return $hasSVGSupport;

}

sub removeLibraryDependingOnSVG

{

    my $frameworkName = shift;

    my $shouldHaveSVG = shift;

    my $path = builtDylibPathForName($frameworkName);

    return unless -x $path;

    my $hasSVG = hasSVGSupport($path);

    system "rm -f $path" if ($shouldHaveSVG xor $hasSVG);

}

sub checkWebCoreSVGSupport

{

    my $required = shift;

    my $framework = "WebCore";

    my $path = builtDylibPathForName($framework);

    my $hasSVG = hasSVGSupport($path);

    if ($required && !$hasSVG) {

        die "$framework at \"$path\" does not include SVG Support, please run build-webkit --svg\n";

    }

    return $hasSVG;

}

sub isQt()

{

    determineIsQt();

    return $isQt;

}

sub determineIsQt()

{

    return if defined($isQt);

    # Allow override in case QTDIR is not set.

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

        my $opt = $ARGV[$i];

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

            $isQt = 1;

            return;

        }

    }

    # The presence of QTDIR only means Qt if --gtk is not on the command-line

    if (isGtk()) {

        $isQt = 0;

        return;

    }

    $isQt = defined($ENV{'QTDIR'});

}

sub isGtk()

{

    determineIsGtk();

    return $isGtk;

}

sub determineIsGtk()

{

    return if defined($isGtk);

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

        my $opt = $ARGV[$i];

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

            $isGtk = 1;

            return;

        }

    }

    $isGtk = 0;

}

sub isCygwin()

{

    return ($^O eq "cygwin");

}

sub isOSX()

{

    return ($^O eq "darwin");

}

sub determineOSXVersion()

{

    return if $osXVersion;

    if (!isOSX()) {

        $osXVersion = -1;

        return;

    }

    my $version = `sw_vers -productVersion`;

    my @splitVersion = split(/\./, $version);

    @splitVersion >= 2 or die "Invalid version $version";

    $osXVersion = {

            "major" => $splitVersion[0],

            "minor" => $splitVersion[1],

            "subminor" => (defined($splitVersion[2]) ? $splitVersion[2] : 0),

    };

}

sub osXVersion()

{

    determineOSXVersion();

    return $osXVersion;

}

sub isTiger()

{

    return isOSX() && osXVersion()->{"minor"} == 4;

}

sub isLeopard()

{

    return isOSX() && osXVersion()->{"minor"} == 5;

}

sub launcherPath()

{

    my $relativeScriptsPath = File::Spec->catpath("", File::Spec->abs2rel(dirname($0), getcwd()), "");

    if (isGtk() || isQt()) {

        return "$relativeScriptsPath/run-launcher";

    } elsif (isOSX() || isCygwin()) {

        return "$relativeScriptsPath/run-safari";

    }

}

sub launcherName()

{

    if (isGtk()) {

        return "GtkLauncher";

    } elsif (isQt()) {

        return "QtLauncher";