--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/sbsv2/raptor/python/raptor_api.py	Tue Apr 27 16:46:48 2010 +0100
@@ -0,0 +1,179 @@
+#
+# Copyright (c) 2010 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_api module
+#
+# Python API for Raptor. External code should interact with Raptor via this
+# module only, as it is the only programatic interface considered public. The
+# command line --query option is also implemented using this module.
+
+class Reply(object):
+	"""object to return values from API calls.
+	"""
+	def __init__(self, text=""):
+		self.reply_text = text
+	
+	def __str__(self):
+		name = type(self).__name__.lower()
+		
+		str = "<" + name
+		end = "/>\n"
+		
+		for attribute,value in self.__dict__.items():
+			if attribute != "reply_text":
+				str += " %s='%s'" % (attribute, value)
+		
+		if self.reply_text:
+			str += ">" + self.reply_text
+			end = "</%s>\n" % name
+			
+		str += end
+		
+		return str
+
+class Alias(Reply):
+	pass
+
+class Config(Reply):
+	pass
+
+class Product(Reply):
+	pass
+
+import generic_path
+import raptor
+import raptor_data
+import re
+
+class Context(object):
+	"""object to contain state information for API calls.
+	
+	For example,
+	
+	api = raptor_api.Context()
+	val = api.get(X)
+	"""
+	def __init__(self, initialiser=None):
+		# this object has a private Raptor object that can either be
+		# passed in or created internally.
+		
+		if initialiser == None:
+			self.__raptor = raptor.Raptor()
+		else:
+			self.__raptor = initialiser
+			
+	def StringQuery(self, query):
+		"""turn a string into an API call and execute it.
+		
+		This is a convenience method for "lazy" callers.
+		
+		The return value is also converted into a string.
+		"""
+		
+		if query == "aliases":
+			aliases = self.GetAliases()
+			return "".join(map(str, aliases)).strip()
+		
+		elif query == "products":
+			variants = self.GetProducts()
+			return "".join(map(str, variants)).strip()
+		
+		elif query.startswith("config"):
+			match = re.match("config\[(.*)\]", query)
+			if match:
+				config = self.GetConfig(match.group(1))
+				return str(config).strip()
+			else:
+				raise BadQuery("syntax error")
+		
+		raise BadQuery("unknown query")
+
+	def GetAliases(self, type=""):
+		"""extract all aliases of a given type.
+		
+		the default type is "".
+		to get all aliases pass type=None
+		"""
+		aliases = []
+		
+		for a in self.__raptor.cache.aliases.values():
+			if a.type == type or type == None:
+				r = Alias()
+				# copy the members we want to expose
+				r.name = a.name
+				r.meaning = a.meaning
+				aliases.append(r)
+			
+		return aliases
+	
+	def GetConfig(self, name):
+		"""extract the values for a given configuration.
+		
+		'name' should be an alias or variant followed optionally by a
+		dot-separated list of variants. For example "armv5_urel" or
+		"armv5_urel.savespace.vasco".
+		"""
+		
+		r = Config()
+		
+		names = name.split(".")
+		if names[0] in self.__raptor.cache.aliases:
+			x = self.__raptor.cache.FindNamedAlias(names[0])
+			
+			if len(names) > 1:
+				r.fullname = x.meaning + "." + ".".join(names[1:])
+			else:
+				r.fullname = x.meaning
+				
+		elif names[0] in self.__raptor.cache.variants:
+			r.fullname = name
+			
+		else:
+			raise BadQuery("'%s' is not an alias or a variant" % names[0])
+		
+		tmp = raptor_data.Alias("tmp")
+		tmp.SetProperty("meaning", r.fullname)
+		
+		units = tmp.GenerateBuildUnits(self.__raptor.cache)
+		evaluator = self.__raptor.GetEvaluator(None, units[0])
+		
+		releasepath = evaluator.Get("RELEASEPATH")
+		fullvariantpath = evaluator.Get("FULLVARIANTPATH")
+		
+		if releasepath and fullvariantpath:
+			r.outputpath = str(generic_path.Join(releasepath, fullvariantpath))
+		else:
+			raise BadQuery("could not get outputpath for config '%s'" % name)
+		
+		return r
+		
+	def GetProducts(self):
+		"""extract all product variants."""
+		
+		variants = []
+		
+		for v in self.__raptor.cache.variants.values():
+			if v.type == "product":
+				r = Product()
+				# copy the members we want to expose
+				r.name = v.name
+				variants.append(r)
+			
+		return variants
+	
+class BadQuery(Exception):
+	pass
+
+# end of the raptor_api module