#

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

# All rights reserved.

# This component and the accompanying materials are made available

# under the terms of the License "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: 

# raptor_data module

# This module contains the classes that make up the Raptor Data Model.

#

import copy

import generic_path

import os

import hashlib

import raptor_utilities

import re

import types

import sys

import subprocess

from tempfile import gettempdir

from time import time, clock

# What host platforms we recognise

# This allows us to tie some variants to one host platform and some to another

class HostPlatform(object):

	""" List the host platforms on which we can build.  Allow configuration

 	    files to specify different information based on that.

	"""

	hostplatforms = ["win32", "win64", "linux2"]

	hostplatform = sys.platform

	@classmethod

	def IsKnown(cls, platformpattern):

		"Does the parameter match the name of a known platform "

		hpnre = re.compile(platformpattern, re.I)

		for hp in cls.hostplatforms:

			if hpnre.match(hp):

				return True

		return False

	@classmethod

	def IsHost(cls, platformpattern):

		""" Does the parameter match the name of the

		    platform that we're executing on? """

		ppre = re.compile(platformpattern, re.I)

		if ppre.match(cls.hostplatform):

			return True

		return False

# Make sure not to start up on an unsupported platform

if not HostPlatform.IsKnown(HostPlatform.hostplatform):

	raise Exception("raptor_data module loaded on an unrecognised platform '%s'. Expected one of %s" % (hostplatform, str(hostplatforms)))

# raptor_data module classes

class Model(object):

	"Base class for data-model objects"

	def __init__(self):

		self.owner = None	# Raptor object

		self.source = None	# XML file

		self.indent = " "	# for DebugPrint

		self.host = None

		self.cacheID = ""	# default set of cached objects

	def SetOwner(self, aRaptor):

		self.owner = aRaptor

	def SetSourceFile(self, filename):

		self.source = filename

	def SetProperty(self, name, value):

		raise InvalidPropertyError()

	def AddChild(self, child):

		raise InvalidChildError()

	def DebugPrint(self, prefix = ""):

		if self.owner:

			self.owner.Debug("%s", prefix)

	def Valid(self):

		return False

	def IsApplicable(self):

		"This variant may be caused to only apply when used on a particular host build platform"

		if self.host is None:

			return True

		if HostPlatform.IsHost(self.host):

			return True

		return False

class InvalidPropertyError(Exception):

	pass

class InvalidChildError(Exception):

	pass

class BadReferenceError(Exception):

	pass

class Reference(Model):

	"Base class for data-model reference objects"

	def __init__(self, ref = None):

		Model.__init__(self)

		self.ref = ref

		self.modifiers = []

	def SetProperty(self, name, value):

		if name == "ref":

			self.ref = value

		elif name == "mod":

			self.modifiers = value.split(".")

		else:

			raise InvalidPropertyError()

	def Resolve(self):

		raise BadReferenceError()

	def GetModifiers(self):

		cache = self.owner.cache

		return [ cache.FindNamedVariant(m) for m in self.modifiers ]

	def Valid(self):

		return self.ref

class VariantContainer(Model):

	def __init__(self):

		Model.__init__(self)	# base class constructor

		self.variants = []

	def SetOwner(self, aRaptor):

		Model.SetOwner(self, aRaptor)

		for v in self.variants:

			v.SetOwner(aRaptor)

	def DebugPrint(self, prefix = ""):

		for v in self.variants:

			v.DebugPrint(prefix)

	def AddVariant(self, variant):

		if type(variant) is types.StringTypes:

			variant = VariantRef(variant)

		# Only add the variant if it's not in the list

		# already

		if not variant in self.variants:

			self.variants.append(variant)

	def GetVariants(self):

		# resolve any VariantRef objects into Variant objects

		for i,var in enumerate(self.variants):

			if isinstance(var, Reference):

				try:

					self.variants[i] = var.Resolve()

				except BadReferenceError:

					self.owner.Error("Missing variant '%s'", var.ref)

		return self.variants

class Interface(Model):

	def __init__(self, name = None):

		Model.__init__(self)	# base class constructor

		self.name = name

		self.flm = None

		self.abstract = False

		self.extends = None

		self.params = []

		self.paramgroups = []

	def DebugPrint(self, prefix = ""):

		self.owner.Debug("%s<interface name='%s'>", prefix, self.name)

		self.owner.Debug("%s...", prefix)

		self.owner.Debug("%s</interface>", prefix)

	def FindParent(self):

		try:

			return self.owner.cache.FindNamedInterface(self.extends, self.cacheID)

		except KeyError:

			raise BadReferenceError("Cannot extend interface because it cannot be found: "+str(self.extends))

	def GetParams(self):

		if self.extends != None:

			parent = self.FindParent()

			# what parameter names do we have already?

			names = set([x.name for x in self.params])

			# pick up ones we don't have that are in our parent

			pp = []

			for p in parent.GetParams():

				if not p.name in names:

					pp.append(p)

			# list parent parameters first then ours

			pp.extend(self.params)

			return pp

		return self.params

	def GetParamGroups(self):

		if self.extends != None:

			parent = self.FindParent()

			# what parameter names do we have already?

			patterns = set([x.pattern for x in self.paramgroups])

			# pick up ones we don't have that are in our parent

			for g in parent.GetParamGroups():

				if not g.pattern in patterns:

					self.paramgroups.append(g)

		return self.paramgroups

	def GetFLMIncludePath(self):

		"absolute path to the FLM"

		if self.flm == None:

			if self.extends != None:

				parent = self.FindParent()

				return parent.GetFLMIncludePath()

			else:

				raise InvalidPropertyError()

		if not os.path.isabs(self.flm):

			self.flm = os.path.join(os.path.dirname(self.source), self.flm)

		return generic_path.Path(self.flm)

	def SetProperty(self, name, value):

		if name == "name":

			self.name = value

		elif name == "flm":

			self.flm = value

		elif name == "abstract":

			self.abstract = (value == "true")

		elif name == "extends":

			self.extends = value

		else:

			raise InvalidPropertyError()

	def AddChild(self, child):

		if isinstance(child, Parameter):

			self.AddParameter(child)

		elif isinstance(child, ParameterGroup):

			self.AddParameterGroup(child)

		else:

			raise InvalidChildError()

	def AddParameter(self, parameter):

		self.params.append(parameter)

	def AddParameterGroup(self, parametergroup):

		self.paramgroups.append(parametergroup)

	def Valid(self):

		return (self.name != None)

class InterfaceRef(Reference):

	def DebugPrint(self, prefix = ""):

		self.owner.Debug("%s<interfaceRef ref='%s'/>", prefix, self.ref)

	def Resolve(self):

		try:

			return self.owner.cache.FindNamedInterface(self.ref, self.cacheID)

		except KeyError:

			raise BadReferenceError()

class Specification(VariantContainer):

	def __init__(self, name = "", type = ""):

		VariantContainer.__init__(self)	# base class constructor

		self.name = name

		self.type = type

		self.interface = None

		self.childSpecs = []

		self.parentSpec = None

	def DebugPrint(self, prefix = ""):

		self.owner.Debug("%s<spec name='%s'>", prefix, self.name)

		if self.interface:

			self.interface.DebugPrint(prefix + self.indent)

		VariantContainer.DebugPrint(self, prefix + self.indent)

		for c in self.childSpecs:

			c.DebugPrint(prefix + self.indent)

		self.owner.Debug("%s</spec>", prefix)

	def SetOwner(self, aRaptor):

		VariantContainer.SetOwner(self, aRaptor)

		if self.interface != None:

			self.interface.SetOwner(aRaptor)

		for s in self.childSpecs:

			s.SetOwner(aRaptor)

	def SetProperty(self, name, value):

		if name == "name":

			self.name = value

		else:

			raise InvalidPropertyError()

	def Configure(self, config):

		# configure all the children (some may be Filters or parents of)

		for spec in self.GetChildSpecs():

			spec.Configure(config)

	def HasInterface(self):

		return self.interface != None

	def SetInterface(self, interface):

		if isinstance(interface, Interface) \

		or isinstance(interface, InterfaceRef):

			self.interface = interface

		else:

			self.interface = InterfaceRef(interface)

	def GetInterface(self):

		"""return the Interface (fetching from the cache if it was a ref)

		may return None"""

		if self.interface == None \

		or isinstance(self.interface, Interface):

			return self.interface

		if isinstance(self.interface, InterfaceRef):

			try:

				self.interface = self.interface.Resolve()

				return self.interface

			except BadReferenceError:

				self.owner.Error("Missing interface %s", self.interface.ref)

				return None

	def AddChild(self, child):

		if isinstance(child, Specification):

			self.AddChildSpecification(child)

		elif isinstance(child, Interface) \

		  or isinstance(child, InterfaceRef):

			self.SetInterface(child)

		elif isinstance(child, Variant) \

		  or isinstance(child, VariantRef):

			self.AddVariant(child)

		else:

			raise InvalidChildError()

	def AddChildSpecification(self, child):

		child.SetParentSpec(self)

		self.childSpecs.append(child)

	def SetParentSpec(self, parent):

		self.parentSpec = parent

	def GetChildSpecs(self):

		return self.childSpecs

	def Valid(self):

		return True

	def GetAllVariantsRecursively(self):

		"""Returns all variants contained in this node and in its ancestors.

		The returned value is a list, the structure of which is [variants-in-parent,

		variants-in-self].

		Note that the function recurses through parent *Specifications*, not through

		the variants themselves.

		"""

		if self.parentSpec:

			variants = self.parentSpec.GetAllVariantsRecursively()

		else:

			variants = []

		variants.extend( self.GetVariants() )

		return variants

class Filter(Specification):

	"""A Filter is two Specification nodes and a True/False switch.

	Filter extends Specification to have two nodes, only one of

	which can be active at any time. Which node is active is determined

	when the Configure method is called after setting up a Condition.

	If several Conditions are set, the test is an OR of all of them."""

	def __init__(self, name = ""):

		Specification.__init__(self, name)	# base class constructor

		self.Else = Specification(name)     # same for Else part

		self.isTrue = True

		self.configNames = set()            #

		self.variableNames = set()          # TO DO: Condition class

		self.variableValues = {}            #

	def DebugPrint(self, prefix = ""):

		self.owner.Debug("%s<filter name='%s'>", prefix, self.name)

		self.owner.Debug("%s <if config='%s'>", prefix, " | ".join(self.configNames))

		Specification.DebugPrint(self, prefix + self.indent)

		self.owner.Debug("%s </if>", prefix)

		self.owner.Debug("%s <else>", prefix)

		self.Else.DebugPrint(prefix + self.indent)

		self.owner.Debug("%s </else>", prefix)

		self.owner.Debug("%s</filter>", prefix)

	def SetConfigCondition(self, configName):

		self.configNames = set([configName])

	def AddConfigCondition(self, configName):

		self.configNames.add(configName)

	def SetVariableCondition(self, variableName, variableValues):

		self.variableNames = set([variableName])

		if type(variableValues) == types.ListType:

			self.variableValues[variableName] = set(variableValues)

		else:

			self.variableValues[variableName] = set([variableValues])

	def AddVariableCondition(self, variableName, variableValues):

		self.variableNames.add(variableName)

		if type(variableValues) == types.ListType:

			self.variableValues[variableName] = set(variableValues)

		else:

			self.variableValues[variableName] = set([variableValues])

	def Configure(self, buildUnit):

		self.isTrue = False

		if buildUnit.name in self.configNames:

			self.isTrue = True

		elif self.variableNames:

			evaluator = self.owner.GetEvaluator(self.parentSpec, buildUnit)

			for variableName in self.variableNames:

				variableValue = evaluator.Get(variableName)

				if variableValue in self.variableValues[variableName]:

					self.isTrue = True

					break

		# configure all the children too

		for spec in self.GetChildSpecs():

			spec.Configure(buildUnit)

	def SetOwner(self, aRaptor):

		# base class method

		Specification.SetOwner(self, aRaptor)

		# same for Else part

		self.Else.SetOwner(aRaptor)

	def HasInterface(self):

		if self.isTrue:

			return Specification.HasInterface(self)

		else:

			return self.Else.HasInterface()

	def GetInterface(self):

		if self.isTrue:

			return Specification.GetInterface(self)

		else:

			return self.Else.GetInterface()

	def GetVariants(self):

		if self.isTrue:

			return Specification.GetVariants(self)

		else:

			return self.Else.GetVariants()