# Copyright (c) 1997-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:

# Module providing platform details for platforms supported

# by Symbian OS

# all data is uppercase

# 

#

package E32Plat;

require Exporter;

@ISA=qw(Exporter);

@EXPORT=qw(

	Plat_SetVerbose

	Plat_Init

	Plat_GetL

	Plat_List

	Plat_AssocIDE

	Plat_Customizations

	Plat_Customizes

	Plat_Root

	Plat_SupportsFeatureVariants

);

use Winutl;

use RVCT_plat2set;

use BPABIutl;

use E32Variant;

my $variantABIV2Keyword = &Variant_GetMacro();

my %Mode=(

	Verbose=>0

);

my $ModulePath;

sub Plat_SetVerbose () {

	$Mode{Verbose}=1;

}

my %BldLists=(

	EPOC32=>['UREL','UDEB'],

	WINS=>['UDEB','UREL'],

	TOOLS=>['DEB','REL'],

	TOOLS2=>['DEB','REL'],

);

my %BldMacros=(

	DEB=>['_DEBUG'],

	REL=>['NDEBUG'],

	UDEB=>['_DEBUG','_UNICODE'],

	UREL=>['NDEBUG','_UNICODE']

);

my @EpocMacros=('__SYMBIAN32__');

my @BPABIPlats = &BPABIutl_Plat_List;

my %Plat=(

	ARM4=>{

		ABI=>'ARM4',

		ASSP=>'MARM',

		ASSPABI=>'',

		Generic=>1,

	},

	ARM4SMP=>{

		ABI=>'ARM4',

		ASSP=>'MARM',

		ASSPABI=>'',

		Generic=>1,

		SMP=>1,

		StatLink=>'ARM4SMP',

	},

	ARM4T=>{

		ABI=>'ARM4T',

		ASSP=>'MARM',

		ASSPABI=>'',

		Generic=>1,

	},

	ARMI=>{

		ASSP=>'MARM',

		Generic=>1,

		ASSPABI=>'',

	},

	SARM4=>{

		ABI=>'ARM4',

		ASSP=>'MARM',

		ASSPABI=>'',

		Generic=>1,

		Single=>1,

	},

	SARMI=>{

		ASSP=>'MARM',

		ASSPABI=>'',

		Generic=>1,

		Single=>1,

	},

	STHUMB=>{

		ABI=>'THUMB',

		ASSP=>'MARM',

		ASSPABI=>'',

		Generic=>1,

		Single=>1,

	},

	THUMB=>{

		ABI=>'THUMB',

		ASSP=>'MARM',

		ASSPABI=>'',

		Generic=>1,

	},

	TOOLS=>{

		ABI=>'TOOLS',

		ASSPABI=>'',

		Compiler=>'VC32',

		CPU=>'TOOLS',

		OS=>'TOOLS',

		MakeMod=>'Cl_win',

		MakeCmd=>'nmake',

	},

	TOOLS2=>{

		ABI=>'TOOLS2',

		ASSPABI=>'',

		Compiler=>'GCC32',

		CPU=>'TOOLS2',

		OS=>'TOOLS2',

		MakeMod=>'Cl_mingw',

		MakeCmd=>'make',

	},

	CWTOOLS=>{

		ABI=>'TOOLS',

		ASSPABI=>'',

		Compiler=>'CW32',

		CPU=>'TOOLS',

		OS=>'TOOLS',

		MakeMod=>'Cl_tools',

		MakeCmd=>'make',

	},

	VC6TOOLS=>{

		ABI=>'TOOLS',

		ASSPABI=>'',

		Compiler=>'VC32',

		CPU=>'TOOLS',

		Ext=>'.DSP',

		MakeMod=>'Ide_vc6',

		MakeCmd=>'nmake',

		OS=>'TOOLS',

		Real=>'TOOLS',

		UsrHdrsOnly=>1,

	},

	WINS=>{

		ABI=>'WINS',

		ASSPABI=>'',

		Compiler=>'VC32',

		CPU=>'WINS',

		MakeMod=>'Cl_win',

		MakeCmd=>'nmake',

		OS=>'WINS',

	},

	VC6=>{

		ABI=>'WINS',

		ASSPABI=>'',

		Compiler=>'VC32',

		CPU=>'WINS',

		Ext=>'.DSP',

		MakeMod=>'Ide_vc6',

		MakeCmd=>'nmake',

		OS=>'WINS',

		Real=>'WINS',

		UsrHdrsOnly=>1,

	},

	WINSCW=>{

		ABI=>'WINSCW',

		ASSPABI=>'',

		Compiler=>'CW32',

		CPU=>'WINS',

		MakeMod=>'Cl_codewarrior',

		OS=>'WINS',

		DefFile=>'WINS',	# use the MSVC def files

	},

	CW_IDE=>{

		ABI=>'WINSCW',

		ASSPABI=>'',

		Compiler=>'CW32',

		CPU=>'WINS',

		Ext=>'.xml',

		MakeMod=>'Ide_cw',

		MakeCmd=>'make',

		OS=>'WINS',

		Real=>'WINSCW',

		DefFile=>'WINS',	# use the MSVC def files

		UsrHdrsOnly=>1,

		SupportsMultiplePlatforms=>1,	# supports more than one real platform

	},

	X86=>{

		ABI=>'X86',

		ASSPABI=>'',

		Compiler=>'VC32',

		CPU=>'X86',

		MakeMod=>'Cl_x86',

		MakeCmd=>'nmake',

		OS=>'EPOC32',

		DefFile=>'X86',

		Generic=>1,

	},

	X86SMP=>{

		ABI=>'X86',

		ASSPABI=>'',

		Compiler=>'VC32',

		CPU=>'X86',

		MakeMod=>'Cl_x86',

		MakeCmd=>'nmake',

		OS=>'EPOC32',

		DefFile=>'X86',

		Generic=>1,

		SMP=>1,

		StatLink=>'X86SMP',

	},

	X86GCC=>{

		ABI=>'X86gcc',

		ASSPABI=>'',

		Compiler=>'X86GCC',

		CPU=>'X86',

		MakeMod=>'Cl_x86gcc',

		OS=>'EPOC32',

		DefFile=>'x86gcc',

		Generic=>1,

	},	

	X86GMP=>{

		ABI=>'X86gcc',

		ASSPABI=>'',

		Compiler=>'X86GCC',

		CPU=>'X86',

		MakeMod=>'Cl_x86gcc',

		OS=>'EPOC32',

		DefFile=>'x86gcc',

		Generic=>1,

		SMP=>1,

		StatLink=>'X86GMP',

	},	

	ARMV4=>{

		ABI=>'ARMV4',

		ASSP=>'MARM',

		ASSPABI=>'',

		Generic=>1,

		MakeMod=>'Cl_arm',

		Compiler=>'ARMCC',

		DefFile=>'EABI',

		EABI=>1,

	},

	ARMV4SMP=>{

		ABI=>'ARMV4',

		ASSP=>'MARM',

		ASSPABI=>'',

		Generic=>1,

		MakeMod=>'Cl_arm',

		Compiler=>'ARMCC',

		DefFile=>'EABI',

		EABI=>1,

		SMP=>1,

		StatLink=>'ARMV4SMP',

	},

	ARMV5_ABIV1=>{

		ABI=>'ARMV5',

		ASSP=>'MARM',

		ASSPABI=>'',

		Generic=>1,

		MakeMod=>'Cl_arm',

		Compiler=>'ARMCC',

		DefFile=>'EABI',

		EABI=>1,

		SupportsFeatureVariants=>1,

	},

	ABIV2=>{

		ABI=>'ARMV5',

		ASSP=>'MARM',

		ASSPABI=>'',

		Generic=>1,

		MakeMod=>'Cl_bpabi',

		DefFile=>'EABI',

		EABI=>1,

		SupportsFeatureVariants=>1,

	},

	GCCXML=>{

		ABI=>'ARM4',

		ASSP=>'MARM',

		ASSPABI=>'',

		Generic=>1,

		MakeMod=>'cl_gccxml',

	},

	VS6=>{

		ABI=>'WINSCW',

		ASSPABI=>'',

		Compiler=>'CW32',

		CPU=>'WINS',

		MakeMod=>'Cl_vscw',

		OS=>'WINS',

		Real=>'WINSCW',

		DefFile=>'WINS',	# use the MSVC def files

		Ext=>'.mak'		

	},

	VS2003=>{

		ABI=>'WINSCW',

		ASSPABI=>'',

		Compiler=>'CW32',

		CPU=>'WINS',

		MakeMod=>'Cl_vscw',

		OS=>'WINS',

		Real=>'WINSCW',

		DefFile=>'WINS',	# use the MSVC def files

		Ext=>'.mak'

	},

	EDG=>{

		ABI=>'ARMV5',

		ASSP=>'MARM',

		ASSPABI=>'',

		Generic=>1,

		MakeMod=>'cl_edg',

	},

	# ASSP platforms should be described using .ASSP files

	# Do not add additional ASSP platforms to this file.

);

sub Set_Plat() 

{

	@BPABIPlats = &BPABIutl_Plat_List;

	foreach my $Candidate (@BPABIPlats)

	{

# All BPABI platforms inherit from ABIV2 properties as listed in the platlist

# and Platlist is updated to include the BPABI platforms.

		my ( $key, $value);

		while (($key, $value) = each %{$Plat{ABIV2}}) {

			$Plat{$Candidate}{$key}=$value;

		}

	}

}

sub Plat_SupportsFeatureVariants($)

	{

	my ($plat) = @_;

	# In a non-ABIV2 world, ARMV5 means ARMV5_ABIV1 within e32plat content

	if (!$variantABIV2Keyword && $plat =~ /^ARMV5$/i)

		{

		$plat .= "_ABIV1";

		}

	return ($plat && defined $Plat{$plat}{SupportsFeatureVariants}) ? $Plat{$plat}{SupportsFeatureVariants} : 0;

	}

sub Plat_Customizations($) {

        my ($plat) = @_;

	my @empty = ();

	return @{$Plat{$plat}{'CUSTOMIZATIONS'}} if $Plat{$plat}{'CUSTOMIZATIONS'};

	return @empty;

      }

sub Plat_Customizes($) {

	my ($plat) = @_;

	return $Plat{$plat}{'CUSTOMIZES'} ? $Plat{$plat}{'CUSTOMIZES'} : "";

}

sub Plat_Root($) {

	my ($plat) = @_;

	my $RootName = $Plat{$plat}{'ROOTPLATNAME'};

	if ($RootName) {

		return $RootName;

	}

	else {

		# A non-BSF platform is its own root.

		return $plat;

	}

}

sub Init_BSFs($) {

	my ($Path)=@_;  

#	get a list of modules

	opendir DIR, $Path;

	my @BSFs=grep s/^([^\.].*)\.BSF$/$1/, map { uc $_ } sort readdir DIR;

	closedir DIR;

	my $BSF;

	foreach $BSF (@BSFs) {

		my $File=$Path.$BSF.'.bsf';

#		check whether the assp is already defined

		if (defined %{$Plat{$BSF}}) {

			warn(

				"$File : warning: Platform \"$BSF\" already defined\n",

				" ... skipping this spec\n"

			);

			delete $Plat{$BSF};

			next;

		}

#		open the module

		unless (open FILE, $File) {

			delete $Plat{$BSF};

			warn "warning: Can't open BSF specification \"$File\"\n";

			next;

		}

		my $line1 = <FILE>;

		$line1 = uc($line1);

		unless ($line1 =~ /^\#\<BSF\>\#/) {

			warn "warning: \"$File\" Invalid BSF specification - missing #<bsf>#\n";

			delete $Plat{$BSF};

			close FILE;

                  next;

            }

            my $custom;

            while ($custom = <FILE>) {

					#skip blank lines and comments

			delete $Plat{$BSF};

					last unless ($custom =~ /^$|^\#/);

            }

            $custom = uc $custom;

            unless ($custom =~ /^\s*CUSTOMIZES\s+(\S+)/) {

				warn "warning: \"$File\" Invalid BSF specification - 'customizes' missing\n";

				delete $Plat{$BSF};

				close FILE;

			next;

            }

		my $root = $1;

		my $platname = '';

		my $CustomizedPlatName = '';		

		# In v1 mode, ARMV5 platform implies ARMV5_ABIV1 platform listed in the platlist		

		my $Armv5Flag = 0;

		if (!$variantABIV2Keyword && $root =~ /^ARMV5$/i) {

			$Armv5Flag = 1;

		}

		# Support for Hierarchy of Customizations (BSF file customization of another BSF file)

		# 1. Check whether the BSF file customizes another BSF file.

		# 2. If so, check whether the root BSF file has already been read.

		# 3. If not read, then defer the current BSF file reading until the root file is read.

		my $rootPlatFound = 0;

		if (defined %{$Plat{$root}} || $Armv5Flag) 

		{

			# BSF platform customizes another valid BSF platform

			if (defined $Plat{$root}{'CUSTOMIZES'}) 

			{

				$rootPlatFound = 1;

				$platname = $root;

				$CustomizedPlatName = $root;

				# Set the root platform name which is same as of customizes platform

				$Plat{$BSF}{'ROOTPLATNAME'} = $Plat{$root}{'ROOTPLATNAME'};

			}

			# BSF platform customizes to one of the existing ABI platforms

			else

			{

				# All BPABI platforms inherits from ABIV2 platform listed in the platlist

				if (grep /^$root$/i, @BPABIPlats) {

					$platname = "ABIV2";

				}

				elsif ($Armv5Flag) {

				# In v1 mode, ARMV5 platform implies ARMV5_ABIV1 platform listed in the platlist

					$platname = "ARMV5_ABIV1";	

				}

				else {

					$platname = $root;

				}

				$CustomizedPlatName=$root;

				# BSF File check Begins 

				# The following check is included to handle the existing BSF files which has to behave in different manner

				# in default v1 mode and v2 mode. The following code changes the BSF name and the custmoized platform name

				# to the implied names. This is done to support switching between v1 and v2 modes by enabling the keyword in

				# the variant configuration file.

				# In v1 mode, the ARMV6_ABIV1 => ARMV6 platform and ARMV6 => ARMV6_ABIV2 platform.

				if (!$variantABIV2Keyword) {

					if ($BSF =~ /^ARMV6_ABIV1$/i) {

						$BSF = "ARMV6";	

						$CustomizedPlatName = "ARMV5";	

					}

					elsif ($BSF =~ /^ARMV6$/i) {

						$BSF = "ARMV6_ABIV2";	

						$CustomizedPlatName = "ARMV5_ABIV2";

						$platname = "ABIV2";

					}

				}

				# BSF File check Ends

				# Set the root platform name

				$Plat{$BSF}{'ROOTPLATNAME'} = $CustomizedPlatName;

			}			

		}

		else

		{

			my $rootbsf = $Path.$root.".bsf";			

			if ( -e $rootbsf ) {

				# BSF file customizes another BSF file which has not been read yet.

				# So defer current BSF file reading until the root BSF file is read.				

				delete $Plat{$BSF};

				push(@BSFs, $BSF);

				next;		

			}

		}

		# If the customizes platform is not a valid BSF platform or BPABI platorm or ARMV5 or ARMV5_ABIV1,

		# then throw warning.

		unless ($rootPlatFound || $root =~ /^ARMV5(_ABIV1)?$/ || (grep /^$root$/i, @BPABIPlats)) {

			warn "warning: \"$File\" Invalid BSF specification - customization restricted to ARMV5, ABIv2 and valid BSF platforms\n";

			close FILE;

			delete $Plat{$BSF};

			next;

		}

		my ( $key, $value);

		while (($key, $value) = each %{$Plat{$platname}}) {

			$Plat{$BSF}{$key}=$value;

		}

		push @{$Plat{$CustomizedPlatName}{'CUSTOMIZATIONS'}}, $BSF;

		$Plat{$BSF}{'CUSTOMIZES'} = $CustomizedPlatName;