#

# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

# All rights reserved.

# This component and the accompanying materials are made available

# under the terms of "Eclipse Public License v1.0"

# which accompanies this distribution, and is available

# at the URL "http://www.eclipse.org/legal/epl-v10.html".

#

# Initial Contributors:

# Nokia Corporation - initial contribution.

#

# Contributors:

#

# Description: 

#

package ifsheets;

############################################

# 13.6.2005: 

#  - Added support for the Removed column in the black list.

#  - Added support for "For Adaptation" And "Extended SDK" columns

#    in the readInfo*2 functions (just to read the data into the hash).

#  - currently there is NO support to get extended SDK /for adaptation API lists

#    based on some release.

############################################

##########################################

# Libraries used

##########################################

use strict;

use Win32::OLE qw(in with);

use Win32::OLE::Const 'Microsoft Excel';

use Exporter ();     # Needed to make constants available to caller.

use excel_support;    # opening/closing workbook, etc.. functions.

##########################################

# Defining all the "global" variables, that we are using.

##########################################

use vars qw(

            @ISA

            @EXPORT

            );

@ISA = qw(Exporter); # Inherit from Exporter module (import method needed).

# Define all the functions defined by this module

use subs qw(

	    isSupported

	    addToHash

	    isRowWanted

	    setRowValue

	    getError

	    checkRel

	    checkApiRelRoadMap

	    checkFileRelRoadMap

	    readInfo

	    checkConflicts

	    readInfo2

	    readCRepInfo2

	    readBlackList

	    );

##########################################

# Define the exports from this module that can be used

# Outside

##########################################

@EXPORT = qw(

             &getExcelApp

	     &quitExcelApp

	     &isSupported

	     &openWorkbook

	     &getWorkSheet

	     &readInfo

	     &checkConflicts

	     &readInfo2

	     &readCRepInfo2

	     &readBlackList

             );

##########################################

# Global variables inside this module (constants

##########################################

# For 2.0 template version there are 32 columns

my $globalMaxColCount = 32;

# How many empty lines we are allowed to encounter before we 

# stop handling specific sheet. 

my $globalMaxEmptyRowCount = 10;

my $currFileName = "";

##########################################

# Error constants

##########################################

my $TEMPLATE_SYNTAX_ERROR = 0;

my $API_DESC_MISSING_ERROR = 10;

my $API_REL_MISSING_ERROR = 11;

my $API_REL_SYNTAX_ERROR = 12;

my $API_REL_LOGICAL_ERROR = 13;

my $API_HEADERS_IN_ROW_ERROR = 14;

my $API_ADAPTATION_ERROR = 15;

my $DLL_SYNTAX_ERROR = 20;

my $LIB_SYNTAX_ERROR = 30;

my $FILE_MORE_THAN_ONE_FILE_ERROR = 40;

my $FILE_COLUMN_SYNTAX_ERROR = 41;

my $FILE_REL_SYNTAX_ERROR = 42;

my $FILE_REL_LOGICAL_ERROR = 43;

###########################################################################

# Functions checks if the template version is supported or not.

#

# We only support template version 1.5,1.5.1 and 1.6

# From 1.5 onwards the template version is located in the "Instructions"-sheet

#

# Params: refToWorkbook,refToTemplateVersion

#

# Return: 0 not supported

#         1 is supported

#

#         Also the found template version is stored to the refToTemplateVersion

###########################################################################

sub isSupported

{

    my $refToWb = shift;

    my $refToTemplateVersion = shift;

    # Get the instructions sheet, since it contains the template version.

    my $refToWorksheet = getWorkSheet $refToWb,"Instructions";

    # The instructions sheet => then try the main page. In 1.8 the instructions

    # page was removed.

    if(! defined($refToWorksheet))

    {

	$refToWorksheet = getWorkSheet $refToWb,"Main";

    }

    # No main or instructions sheet => not supported.

    if(! defined($refToWorksheet))

    {

	return 0;

    }

    # the template version in in cell C2. (both tabs the place is same)

    my $templVersion  = $$refToWorksheet->Cells( 2, 3  )->{ 'Value' };

    if(defined($refToTemplateVersion))

    {

	$$refToTemplateVersion = $templVersion;

    }

    # Support version 1.5 and 1.5.1

    if( defined($templVersion) && $templVersion =~ /^\s*1\.5(\.1)*$/)

    {

	return 1;

    }

    # Support version 1.6

    if( defined($templVersion) && $templVersion =~ /^\s*1\.6$/)

    {

	return 1;

    }

    # Support version 1.7 and 1.7.*

    if( defined($templVersion) && $templVersion =~ /^\s*1\.7(\.[0-9]+)*$/)

    {

	return 1;

    }

    # Support version 1.8 and 1.8.*

    if( defined($templVersion) && $templVersion =~ /^\s*1\.8(\.[0-9]+)*$/)

    {

	return 1;

    }

    # Support version 1.9 and 1.9.*

    if( defined($templVersion) && $templVersion =~ /^\s*1\.9(\.[0-9]+)*$/)

    {

	return 1;

    }

    # Support version 2.0 and 2.0.*

    if( defined($templVersion) && $templVersion =~ /^\s*2\.0(\.[0-9]+)*$/)

    {

	return 1;

    }

    return 0;

}

###########################################################################

# Function defines what is the next api ordinal to be used in the 

# hash return by readInfo2 and readCRepInfo2 methods.

# there.

#

# Params: refToHash

#

# Return: next ordinal

##########################################################################

sub sortNumerically

{

    $a <=> $b;

}

sub getNextOrdinal

{

    my $refToHash = shift;

    my @ordinalsInOrder =  sort sortNumerically ( keys(%$refToHash));

    my $highestValue = pop @ordinalsInOrder;

    $highestValue++;

    return $highestValue;

}

###########################################################################

# Function adds the information in the str into the has, if the information is not

# there.

# It also separates command separated items before adding them

#

# Params: refToHash, text added.

#

# Return: -

###########################################################################

sub addToHash

{

    my $refToHash = shift;

    my $str = shift;

    # No need to do anything, if there is nothing to do.

    if(! defined($str) || $str =~ /^\s*$/)

    {

	return;

    } 

    # The items can be separated by "," and there could be additional

    # space before of after the separator.

    my @items = split /\s*[,\n ]+\s*/,$str;

    my $item;

    # Add each item to the hash. This is only done, if the item does not

    # exist there before.

    foreach $item (@items)

    {

	# all spaces and newlines taken away before addition

	$item =~ s/\s*//g;

	chomp($item);

	# Add if not added earlier (avoiding duplicate entries)

	if( !defined( $$refToHash{$item}) && $item !~ /^\s*N\/A\s*$/i && $item !~ /^\s*\-\s*$/)

	{

	    # It does not matter what is the value, since we are only interested in the

	    # key.

	    $$refToHash{$item} = 1; 

	}

    }

}

###########################################################################

# Function expects to find the fromStr and obsoletedStr in format "Sx0 <rel>, Sx0 <rel>", where x is 6 0r 9.

# It tries to determinate, if the range matches to the given release for the given platform

# Possible combinations "", "S60 <rel>","S90 <rel>","S60 <rel>, S90 <Rel>"

#

# Params: plat, rel, isAPIrow,fromStr, obsoletedStr

#

# Return:

#   1 is part of wanted platform

#   2 has been removed in this/prev releases

#   3 is coming in future releases

#   4 no release for the API in given str

# Note: 0 is used outside of this function.

###########################################################################

sub isRowWanted

{

    my $plat = shift;

    my $rel = shift;

    my $isApiRow = shift;

    my $fromStr = shift;

    my $obsoletedStr = shift;

    #######################################################

    # First check the obsoleted field. If that matches, it really does not matter

    # what is the from string.

    #######################################################

    if(defined($obsoletedStr) && $obsoletedStr =~ /$plat/i)

    {

	# the value was defined and contains the platform wanted.

	# Now extract the release for the wanted platform.

	if($obsoletedStr =~ /$plat\s+([0-9.]+)/i)

	{

	    my $obsoletedRelInSheet = $1;

	    # check, if the line has been obsoleted, if yes then return false.

	    if($rel >= $obsoletedRelInSheet)

	    {

		return 2;

	    }

	}

    }

    #######################################################

    # If the row was not obsoleted, then check the from-value.

    #######################################################

    # If there is no value in the field the item is handled differently depending

    # if the row is API row or header row.

    if( ! defined($fromStr) || $fromStr =~ /^\s*$/ ||  $fromStr !~ /$plat/i)

    {

	return 4;

    }

    # The platform was specified in the field. Now find out the number

    if($fromStr =~ /$plat\s+([0-9.]+)/i)

    {

	my $platRelInSheet = $1;

	if( $rel >= $platRelInSheet)

	{

	    # belongs to the release

	    return 1;

	}

	else

	{

	    # does not belong to the release

	    return 3;

	}

    }

    # We should only come here, if the information was somehow wrongly specified.

    # (for instance numbers in the release was not a number, but something else)

    return 4;

}

###########################################################################

# function sets the given rel value, if the value was defined

#

# Params: referenceToVariable, value

#

###########################################################################

sub setRelValue

{

    my $refToVar = shift;

    my $value = shift;

    if(defined($value) && $value !~ /^\s*$/)

    {

	$$refToVar = $value;

    }

}

###########################################################################

# Function generates an error item

#

# Params: errNbr, ... <other information>

#

# Return: reference to an error item list

###########################################################################

sub getError

{

    my $errNbr = shift;

    my $refToDetailsList = \@_;

    my @errItem;

    push(@errItem,$errNbr);

    push(@errItem,$currFileName);

    push(@errItem,@$refToDetailsList);

    return \@errItem;

}

###########################################################################

# Checks the syntax of the given release field

#

# Params: checked rel value

#

# Return:  0 OK

#         >0 NOK

###########################################################################

sub checkRel

{

    my $checkedRel = shift;

    # No value defined => return OK

    if($checkedRel == -1)

    {

	return 0;

    }

    # Only S60 or S90 release specified

    if($checkedRel =~ /^\s*S[69]0 [0-9]+\.[0-9]+\s*$/i)

    {

	return 0;

    }

    # Both S60 or S90 release specified

    if($checkedRel =~ /^\s*S[69]0 [0-9]+\.[0-9]+\s*\,\s*S[69]0 [0-9]+\.[0-9]+\s*$/i)

    {

	return 0;

    }

    # Otherwise error

    return 1;

}

###########################################################################

# Function checks that the information in the files for given release are OK.

#

# Params: refToErrList, checkedPlatform, apiName, sdkRel,oemRel,internalRel,privateRel

#

# Return:  0 no errors found

#          > 0 amount of  errors found

###########################################################################

sub checkApiRelRoadMap

{

    my $refToErrorList = shift;

    my $checkedPlatform = shift;

    my $apiName = shift;

    my $apiSdkRel = shift;

    my $apiOemRel = shift;

    my $apiInternalRel = shift;

    my $apiPrivateRel = shift;

    my $apiDeprecatedRel = shift;

    my $apiObsoletedRel = shift;

    my $sdk = -1;

    my $oem = -1;

    my $int = -1;

    my $priv = -1;

    my $dep = -1;

    my $obs = -1;

    my $errorsBeforeCheck = scalar(@$refToErrorList);

    if($apiSdkRel =~ /$checkedPlatform\s+([0-9]+\.[0-9]+)/)

    {

	$sdk = $1;

    }

    if($apiOemRel =~ /$checkedPlatform\s+([0-9]+\.[0-9]+)/)

    {

	$oem = $1;

    }

    if($apiInternalRel =~ /$checkedPlatform\s+([0-9]+\.[0-9]+)/)

    {

	$int = $1;

    }

    if($apiPrivateRel =~ /$checkedPlatform\s+([0-9]+\.[0-9]+)/)

    {

	$priv = $1;

    }

    if($apiDeprecatedRel =~ /$checkedPlatform\s+([0-9]+\.[0-9]+)/)

    {

	$dep = $1;

    }

    if($apiObsoletedRel =~ /$checkedPlatform\s+([0-9]+\.[0-9]+)/)

    {

	$obs = $1;

    }

    if($sdk != -1)

    {

	if($sdk < $oem || $sdk < $int || $sdk <  $priv)

	{

	    push(@$refToErrorList,getError($API_REL_LOGICAL_ERROR,

					   $apiName, "SDK release"));

	}

    }

    if($oem != -1)

    {

	if($oem < $int || $oem <  $priv)

	{

	    push(@$refToErrorList,getError($API_REL_LOGICAL_ERROR,

					   $apiName, "Oem release"));

	}

    }

    if($int != -1)

    {

	if($int <  $priv)

	{

	    push(@$refToErrorList,getError($API_REL_LOGICAL_ERROR,

					   $apiName, "Internal release"));

	}

    }

    if($dep != -1)

    {

	if($dep < $sdk || $dep < $oem || $dep < $int || $dep <  $priv)

	{

	    push(@$refToErrorList,getError($API_REL_LOGICAL_ERROR,

					   $apiName, "Deprecated release value."));

	}

    }

    if($obs != -1)

    {

	if($obs < $sdk || $obs < $oem || $obs < $int || $obs <  $priv || $obs < $dep)

	{

	    push(@$refToErrorList,getError($API_REL_LOGICAL_ERROR,

					   $apiName, "Obsoleted release value."));

	}

    }

    return  scalar(@$refToErrorList) - $errorsBeforeCheck;

}

###########################################################################

# Function checks that the information in the files for given release are OK.

#

# Params: refToErrList, checkedPlatform, apiName, fileName,apiSdkRel,apiOemRel,apiInternalRel,apiPrivateRel, 

#         apiDeprecatedRel,apiObsoletedeRel,fileSdkRel,fileOemRel,fileInternalRel,filePrivateRel, 

#         fileDeprecatedRel,fileObsoletedeRel

#

# Return:  0 no errors found

#          > 0 amount of  errors found

###########################################################################

sub checkFileRelRoadMap

{

    my $refToErrorList = shift;

    my $checkedPlatform = shift;

    my $apiName = shift;

    my $fileName = shift;

    my $apiSdkRel = shift;

    my $apiOemRel = shift;

    my $apiInternalRel = shift;

    my $apiPrivateRel = shift;

    my $apiDeprecatedRel = shift;

    my $apiObsoletedRel = shift;

    my $fileSdkRel = shift;

    my $fileOemRel = shift;

    my $fileInternalRel = shift;