diff engine/python/fife/extensions/fife_compat.py @ 378:64738befdf3b

bringing in the changes from the build_system_rework branch in preparation for the 0.3.0 release. This commit will require the Jan2010 devkit. Clients will also need to be modified to the new way to import fife.
author vtchill@33b003aa-7bff-0310-803a-e67f0ece8222
date Mon, 11 Jan 2010 23:34:52 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/engine/python/fife/extensions/fife_compat.py	Mon Jan 11 23:34:52 2010 +0000
@@ -0,0 +1,97 @@
+# -*- coding: utf-8 -*-
+
+# ####################################################################
+#  Copyright (C) 2005-2009 by the FIFE team
+#  http://www.fifengine.de
+#  This file is part of FIFE.
+#
+#  FIFE is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License, or (at your option) any later version.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the
+#  Free Software Foundation, Inc.,
+#  51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+# ####################################################################
+
+"""
+FIFE Backwards Combatibility Layer
+==================================
+
+This module can be imported if you want to
+run code that wasn't adapted to API changes in FIFE.
+
+2008.1
+------
+
+ - Animation.addFrame now expects a fife.ResourcePtr instead of an fife.Image
+ - Pool.getIndex is just an alias for Pool.addResourceFromFile.
+ - EventManager.setNonConsumableKeys is superseeded by EventManager.setKeyFilter
+
+"""
+
+from fife import fife
+
+# Utility functions
+
+def deprecated(revision,message):
+	print "fife_compat: Deprecation warning - See revision %d " % revision
+	print " - ",message
+
+def this_is_deprecated(func,revision=0,message=None):
+	if message is None:
+		message = repr(func) + " is deprecated."
+	def wrapped_func(*args,**kwargs):
+		deprecated(revision,message)
+		return func(*args,**kwargs)
+	return wrapped_func
+
+# 2008.1 compatibility functions
+
+def decorate_addFrame(f):
+	
+	def addFrame(self,image_ptr, delay):
+		if not isinstance(image_ptr,fife.ResourcePtr):
+			image_ptr = fife.ResourcePtr(image_ptr)
+			deprecated(2616,"Animation.addFrame doesn't accept Image* anymore ")
+		return f(self,image_ptr,delay)
+	return addFrame
+
+fife.Animation.addFrame = decorate_addFrame(fife.Animation.addFrame)
+fife.Pool.getIndex = this_is_deprecated(
+	fife.Pool.addResourceFromFile,
+	revision = 2617,
+	message  = "Use addResourceFromFile instead of getIndex"
+)
+
+def _compat_NonConsumableKeys():
+	class CompatKeyFilter(fife.IKeyFilter):
+		def __init__(self, keys):
+			fife.IKeyFilter.__init__(self)
+			self.keys = keys
+
+		def isFiltered(self, event):
+			return event.getKey().getValue() in self.keys
+
+	def _setNonConsumableKeys(self,keys):
+		deprecated(2636, "Write an IKeyFilter instead of using EventManager.setNonConsumableKeys.\n" +
+				 "You probably don't need it anyway")
+		self.compat_keyfilter = CompatKeyFilter(keys)
+		self.compat_keyfilter.__disown__()
+		self.setKeyFilter(self.compat_keyfilter)
+
+	def _getNonConsumableKeys(self,keys):
+		deprecated(2636, "Write an IKeyFilter instead of using EventManager.getNonConsumableKeys.")
+		return self.compat_keyfilter.keys
+
+	fife.EventManager.setNonConsumableKeys = _setNonConsumableKeys
+	fife.EventManager.getNonConsumableKeys = _getNonConsumableKeys
+
+_compat_NonConsumableKeys()